annotate doc/misc/org.texi @ 103855:6479d8a2ebcf

(describe-character-set): Don't show width.
author Kenichi Handa <handa@m17n.org>
date Sat, 11 Jul 2009 06:36:14 +0000
parents 66652dbd881c
children ac1a55cc2c38
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1 \input texinfo
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2 @c %**start of header
84329
3d431f1997d8 (setfilename): Go up one more level to ../../info.
Glenn Morris <rgm@gnu.org>
parents: 84308
diff changeset
3 @setfilename ../../info/org
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4 @settitle The Org Manual
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5
101758
64835454876e 2009-02-02 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101747
diff changeset
6 @set VERSION 6.21b
64835454876e 2009-02-02 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101747
diff changeset
7 @set DATE February 2009
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9 @c Version and Contact Info
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
10 @set MAINTAINERSITE @uref{http://orgmode.org,maintainers webpage}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11 @set AUTHOR Carsten Dominik
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12 @set MAINTAINER Carsten Dominik
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
13 @set MAINTAINEREMAIL @email{carsten at orgmode dot org}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
14 @set MAINTAINERCONTACT @uref{mailto:carsten at orgmode dot org,contact the maintainer}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15 @c %**end of header
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16 @finalout
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18 @c Macro definitions
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20 @c Subheadings inside a table.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21 @macro tsubheading{text}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22 @ifinfo
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
23 @subsubheading \text\
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
24 @end ifinfo
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
25 @ifnotinfo
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
26 @item @b{\text\}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
27 @end ifnotinfo
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
28 @end macro
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
29
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
30 @copying
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
31 This manual is for Org (version @value{VERSION}).
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
32
100974
cb5d2387102c Add 2009 to copyright years.
Glenn Morris <rgm@gnu.org>
parents: 100607
diff changeset
33 Copyright @copyright{} 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
34
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
35 @quotation
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
36 Permission is granted to copy, distribute and/or modify this document
99868
404f28130174 *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 99851
diff changeset
37 under the terms of the GNU Free Documentation License, Version 1.3 or
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
38 any later version published by the Free Software Foundation; with no
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
39 Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
97382
30b815491c74 Revert trivial license formatting changes from previous change.
Glenn Morris <rgm@gnu.org>
parents: 97028
diff changeset
40 and with the Back-Cover Texts as in (a) below. A copy of the license
30b815491c74 Revert trivial license formatting changes from previous change.
Glenn Morris <rgm@gnu.org>
parents: 97028
diff changeset
41 is included in the section entitled ``GNU Free Documentation License.''
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
42
95874
eafbd7a5c9be Update Back-Cover Text as per maintain.info.
Glenn Morris <rgm@gnu.org>
parents: 94550
diff changeset
43 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
eafbd7a5c9be Update Back-Cover Text as per maintain.info.
Glenn Morris <rgm@gnu.org>
parents: 94550
diff changeset
44 modify this GNU manual. Buying copies from the FSF supports it in
eafbd7a5c9be Update Back-Cover Text as per maintain.info.
Glenn Morris <rgm@gnu.org>
parents: 94550
diff changeset
45 developing GNU and promoting software freedom.''
95933
b5e79026c857 Change to GFDL 1.2. Refer to license in Emacs manual.
Glenn Morris <rgm@gnu.org>
parents: 95874
diff changeset
46
b5e79026c857 Change to GFDL 1.2. Refer to license in Emacs manual.
Glenn Morris <rgm@gnu.org>
parents: 95874
diff changeset
47 This document is part of a collection distributed under the GNU Free
b5e79026c857 Change to GFDL 1.2. Refer to license in Emacs manual.
Glenn Morris <rgm@gnu.org>
parents: 95874
diff changeset
48 Documentation License. If you want to distribute this document
b5e79026c857 Change to GFDL 1.2. Refer to license in Emacs manual.
Glenn Morris <rgm@gnu.org>
parents: 95874
diff changeset
49 separately from the collection, you can do so by adding a copy of the
b5e79026c857 Change to GFDL 1.2. Refer to license in Emacs manual.
Glenn Morris <rgm@gnu.org>
parents: 95874
diff changeset
50 license to the document, as described in section 6 of the license.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
51 @end quotation
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
52 @end copying
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
53
102059
9bcea07061a8 consistently use @insertcopying, @direntry, @contents
Karl Berry <karl@gnu.org>
parents: 102000
diff changeset
54 @dircategory Emacs
9bcea07061a8 consistently use @insertcopying, @direntry, @contents
Karl Berry <karl@gnu.org>
parents: 102000
diff changeset
55 @direntry
9bcea07061a8 consistently use @insertcopying, @direntry, @contents
Karl Berry <karl@gnu.org>
parents: 102000
diff changeset
56 * Org Mode: (org). Outline-based notes management and organizer
9bcea07061a8 consistently use @insertcopying, @direntry, @contents
Karl Berry <karl@gnu.org>
parents: 102000
diff changeset
57 @end direntry
9bcea07061a8 consistently use @insertcopying, @direntry, @contents
Karl Berry <karl@gnu.org>
parents: 102000
diff changeset
58
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
59 @titlepage
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
60 @title The Org Manual
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
61
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
62 @subtitle Release @value{VERSION}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
63 @author by Carsten Dominik
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
64
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
65 @c The following two commands start the copyright page.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
66 @page
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
67 @vskip 0pt plus 1filll
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
68 @insertcopying
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
69 @end titlepage
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
70
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
71 @c Output the table of contents at the beginning.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
72 @contents
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
73
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
74 @ifnottex
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
75 @node Top, Introduction, (dir), (dir)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
76 @top Org Mode Manual
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
77
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
78 @insertcopying
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
79 @end ifnottex
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
80
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
81 @menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
82 * Introduction:: Getting started
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
83 * Document Structure:: A tree works like your brain
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
84 * Tables:: Pure magic for quick formatting
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
85 * Hyperlinks:: Notes in context
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
86 * TODO Items:: Every tree branch can be a TODO item
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
87 * Tags:: Tagging headlines and matching sets of tags
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
88 * Properties and Columns:: Storing information about an entry
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
89 * Dates and Times:: Making items useful for planning
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
90 * Capture:: Creating tasks and attaching files
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
91 * Agenda Views:: Collecting information into views
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
92 * Embedded LaTeX:: LaTeX fragments and formulas
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
93 * Exporting:: Sharing and publishing of notes
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
94 * Publishing:: Create a web site of linked Org files
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
95 * Miscellaneous:: All the rest which did not fit elsewhere
96976
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
96 * Extensions:: Add-ons for Org mode
101147
a62da64665d1 Fix some more typos.
Glenn Morris <rgm@gnu.org>
parents: 101146
diff changeset
97 * Hacking:: How to hack your way around
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
98 * History and Acknowledgments:: How Org came into being
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
99 * Main Index:: An index of Org's concepts and features
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
100 * Key Index:: Key bindings and where they are described
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
101
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
102 @detailmenu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
103 --- The Detailed Node Listing ---
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
104
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
105 Introduction
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
106
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
107 * Summary:: Brief summary of what Org does
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
108 * Installation:: How to install a downloaded version of Org
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
109 * Activation:: How to activate Org for certain buffers
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
110 * Feedback:: Bug reports, ideas, patches etc.
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
111 * Conventions:: Type-setting conventions in the manual
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
112
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
113 Document Structure
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
114
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
115 * Outlines:: Org is based on Outline mode
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
116 * Headlines:: How to typeset Org tree headlines
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
117 * Visibility cycling:: Show and hide, much simplified
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
118 * Motion:: Jumping to other headlines
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
119 * Structure editing:: Changing sequence and level of headlines
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
120 * Archiving:: Move done task trees to a different place
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
121 * Sparse trees:: Matches embedded in context
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
122 * Plain lists:: Additional structure within an entry
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
123 * Drawers:: Tucking stuff away
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
124 * Footnotes:: How footnotes are defined in Org's syntax
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
125 * Orgstruct mode:: Structure editing outside Org
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
126
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
127 Archiving
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
128
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
129 * ARCHIVE tag:: Marking a tree as inactive
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
130 * Moving subtrees:: Moving a tree to an archive file
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
131
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
132 Tables
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
133
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
134 * Built-in table editor:: Simple tables
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
135 * Narrow columns:: Stop wasting space in tables
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
136 * Column groups:: Grouping to trigger vertical lines
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
137 * Orgtbl mode:: The table editor as minor mode
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
138 * The spreadsheet:: The table editor has spreadsheet capabilities
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
139 * Org Plot:: Plotting from org tables
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
140
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
141 The spreadsheet
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
142
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
143 * References:: How to refer to another field or range
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
144 * Formula syntax for Calc:: Using Calc to compute stuff
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
145 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
146 * Field formulas:: Formulas valid for a single field
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
147 * Column formulas:: Formulas valid for an entire column
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
148 * Editing and debugging formulas:: Fixing formulas
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
149 * Updating the table:: Recomputing all dependent fields
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
150 * Advanced features:: Field names, parameters and automatic recalc
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
151
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
152 Hyperlinks
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
153
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
154 * Link format:: How links in Org are formatted
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
155 * Internal links:: Links to other places in the current file
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
156 * External links:: URL-like links to the world
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
157 * Handling links:: Creating, inserting and following
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
158 * Using links outside Org:: Linking from my C source code?
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
159 * Link abbreviations:: Shortcuts for writing complex links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
160 * Search options:: Linking to a specific location
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
161 * Custom searches:: When the default search is not enough
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
162
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
163 Internal links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
164
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
165 * Radio targets:: Make targets trigger links in plain text
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
166
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
167 TODO Items
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
168
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
169 * TODO basics:: Marking and displaying TODO entries
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
170 * TODO extensions:: Workflow and assignments
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
171 * Progress logging:: Dates and notes for progress
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
172 * Priorities:: Some things are more important than others
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
173 * Breaking down tasks:: Splitting a task into manageable pieces
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
174 * Checkboxes:: Tick-off lists
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
175
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
176 Extended use of TODO keywords
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
177
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
178 * Workflow states:: From TODO to DONE in steps
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
179 * TODO types:: I do this, Fred does the rest
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
180 * Multiple sets in one file:: Mixing it all, and still finding your way
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
181 * Fast access to TODO states:: Single letter selection of a state
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
182 * Per-file keywords:: Different files, different requirements
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
183 * Faces for TODO keywords:: Highlighting states
101747
374ac7d3b3ac Fix typos.
Glenn Morris <rgm@gnu.org>
parents: 101703
diff changeset
184 * TODO dependencies:: When one task needs to wait for others
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
185
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
186 Progress logging
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
187
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
188 * Closing items:: When was this entry marked DONE?
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
189 * Tracking TODO state changes:: When did the status change?
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
190
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
191 Tags
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
192
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
193 * Tag inheritance:: Tags use the tree structure of the outline
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
194 * Setting tags:: How to assign tags to a headline
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
195 * Tag searches:: Searching for combinations of tags
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
196
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
197 Properties and Columns
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
198
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
199 * Property syntax:: How properties are spelled out
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
200 * Special properties:: Access to other Org mode features
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
201 * Property searches:: Matching property values
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
202 * Property inheritance:: Passing values down the tree
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
203 * Column view:: Tabular viewing and editing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
204 * Property API:: Properties for Lisp programmers
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
205
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
206 Column view
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
207
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
208 * Defining columns:: The COLUMNS format property
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
209 * Using column view:: How to create and use column view
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
210 * Capturing column view:: A dynamic block for column view
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
211
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
212 Defining columns
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
213
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
214 * Scope of column definitions:: Where defined, where valid?
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
215 * Column attributes:: Appearance and content of a column
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
216
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
217 Dates and Times
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
218
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
219 * Timestamps:: Assigning a time to a tree entry
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
220 * Creating timestamps:: Commands which insert timestamps
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
221 * Deadlines and scheduling:: Planning your work
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
222 * Clocking work time:: Tracking how long you spend on a task
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
223 * Effort estimates:: Planning work effort in advance
100271
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
224 * Relative timer:: Notes with a running timer
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
225
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
226 Creating timestamps
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
227
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
228 * The date/time prompt:: How Org mode helps you entering date and time
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
229 * Custom time format:: Making dates look different
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
230
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
231 Deadlines and scheduling
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
232
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
233 * Inserting deadline/schedule:: Planning items
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
234 * Repeated tasks:: Items that show up again and again
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
235
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
236 Capture
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
237
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
238 * Remember:: Capture new tasks/ideas with little interruption
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
239 * Attachments:: Add files to tasks.
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
240
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
241 Remember
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
242
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
243 * Setting up Remember:: Some code for .emacs to get things going
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
244 * Remember templates:: Define the outline of different note types
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
245 * Storing notes:: Directly get the note to where it belongs
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
246 * Refiling notes:: Moving a note or task to a project
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
247
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
248 Agenda Views
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
249
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
250 * Agenda files:: Files being searched for agenda information
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
251 * Agenda dispatcher:: Keyboard access to agenda views
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
252 * Built-in agenda views:: What is available out of the box?
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
253 * Presentation and sorting:: How agenda items are prepared for display
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
254 * Agenda commands:: Remote editing of Org trees
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
255 * Custom agenda views:: Defining special searches and views
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
256 * Agenda column view:: Using column view for collected entries
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
257
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
258 The built-in agenda views
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
259
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
260 * Weekly/daily agenda:: The calendar page with current tasks
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
261 * Global TODO list:: All unfinished action items
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
262 * Matching tags and properties:: Structured information with fine-tuned search
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
263 * Timeline:: Time-sorted view for single file
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
264 * Keyword search:: Finding entries by keyword
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
265 * Stuck projects:: Find projects you need to review
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
266
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
267 Presentation and sorting
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
268
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
269 * Categories:: Not all tasks are equal
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
270 * Time-of-day specifications:: How the agenda knows the time
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
271 * Sorting of agenda items:: The order of things
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
272
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
273 Custom agenda views
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
274
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
275 * Storing searches:: Type once, use often
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
276 * Block agenda:: All the stuff you need in a single buffer
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
277 * Setting Options:: Changing the rules
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
278 * Exporting Agenda Views:: Writing agendas to files
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
279 * Using the agenda elsewhere:: Using agenda information in other programs
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
280
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
281 Embedded LaTeX
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
282
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
283 * Math symbols:: TeX macros for symbols and Greek letters
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
284 * Subscripts and superscripts:: Simple syntax for raising/lowering text
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
285 * LaTeX fragments:: Complex formulas made easy
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
286 * Processing LaTeX fragments:: Previewing LaTeX processing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
287 * CDLaTeX mode:: Speed up entering of formulas
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
288
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
289 Exporting
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
290
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
291 * Markup rules:: Which structures are recognized?
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
292 * Selective export:: Using tags to select and exclude trees
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
293 * Export options:: Per-file export settings
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
294 * The export dispatcher:: How to access exporter commands
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
295 * ASCII export:: Exporting to plain ASCII
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
296 * HTML export:: Exporting to HTML
99139
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
297 * LaTeX and PDF export:: Exporting to LaTeX, and processing to PDF
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
298 * XOXO export:: Exporting to XOXO
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
299 * iCalendar export:: Exporting in iCalendar format
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
300
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
301 Markup rules
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
302
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
303 * Document title:: How the document title is determined
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
304 * Headings and sections:: The main structure of the exported document
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
305 * Table of contents:: If, where, how to create a table of contents
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
306 * Initial text:: Text before the first headline
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
307 * Lists:: Plain lists are exported
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
308 * Paragraphs:: What determines beginning and ending
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
309 * Literal examples:: Source code and other examples
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
310 * Include files:: Include the contents of a file during export
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
311 * Tables exported:: Tables are exported richly
100450
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
312 * Inlined images:: How to inline images during export
102151
328f4b370b74 Remove duplicate words.
Juanma Barranquero <lekktu@gmail.com>
parents: 102059
diff changeset
313 * Footnote markup::
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
314 * Emphasis and monospace:: To bold or not to bold
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
315 * TeX macros and LaTeX fragments:: Create special, rich export.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
316 * Horizontal rules:: A line across the page
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
317 * Comment lines:: Some lines will not be exported
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
318
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
319 HTML export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
320
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
321 * HTML Export commands:: How to invoke HTML export
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
322 * Quoting HTML tags:: Using direct HTML in Org mode
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
323 * Links:: Transformation of links for HTML
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
324 * Images in HTML export:: How to insert figures into HTML output
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
325 * Text areas in HTML export:: An alternative way to show an example
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
326 * CSS support:: Changing the appearance of the output
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
327 * Javascript support:: Info and Folding in a web browser
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
328
99139
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
329 LaTeX and PDF export
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
330
101147
a62da64665d1 Fix some more typos.
Glenn Morris <rgm@gnu.org>
parents: 101146
diff changeset
331 * LaTeX/PDF export commands:: Which key invokes which commands
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
332 * Quoting LaTeX code:: Incorporating literal LaTeX code
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
333 * Sectioning structure:: Changing sectioning in LaTeX output
100450
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
334 * Tables in LaTeX export:: Options for exporting tables to LaTeX
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
335 * Images in LaTeX export:: How to insert figures into LaTeX output
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
336
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
337 Publishing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
338
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
339 * Configuration:: Defining projects
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
340 * Sample configuration:: Example projects
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
341 * Triggering publication:: Publication commands
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
342
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
343 Configuration
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
344
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
345 * Project alist:: The central configuration variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
346 * Sources and destinations:: From here to there
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
347 * Selecting files:: What files are part of the project?
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
348 * Publishing action:: Setting the function doing the publishing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
349 * Publishing options:: Tweaking HTML export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
350 * Publishing links:: Which links keep working after publishing?
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
351 * Project page index:: Publishing a list of project files
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
352
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
353 Sample configuration
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
354
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
355 * Simple example:: One-component publishing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
356 * Complex example:: A multi-component publishing example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
357
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
358 Miscellaneous
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
359
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
360 * Completion:: M-TAB knows what you need
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
361 * Customization:: Adapting Org to your taste
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
362 * In-buffer settings:: Overview of the #+KEYWORDS
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
363 * The very busy C-c C-c key:: When in doubt, press C-c C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
364 * Clean view:: Getting rid of leading stars in the outline
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
365 * TTY keys:: Using Org on a tty
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
366 * Interaction:: Other Emacs packages
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
367 * Bugs:: Things which do not work perfectly
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
368
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
369 Interaction with other packages
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
370
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
371 * Cooperation:: Packages Org cooperates with
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
372 * Conflicts:: Packages that lead to conflicts
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
373
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
374 Extensions
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
375
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
376 * Extensions in the contrib directory:: These come with the Org distro
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
377 * Other extensions:: These you have to find on the web.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
378
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
379 Hacking
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
380
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
381 * Adding hyperlink types:: New custom link types
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
382 * Tables in arbitrary syntax:: Orgtbl for LaTeX and other programs
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
383 * Dynamic blocks:: Automatically filled blocks
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
384 * Special agenda views:: Customized views
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
385 * Using the property API:: Writing programs that use entry properties
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
386 * Using the mapping API:: Mapping over all or selected entries
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
387
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
388 Tables and lists in arbitrary syntax
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
389
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
390 * Radio tables:: Sending and receiving
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
391 * A LaTeX example:: Step by step, almost a tutorial
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
392 * Translator functions:: Copy and modify
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
393 * Radio lists:: Doing the same for lists
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
394
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
395 @end detailmenu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
396 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
397
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
398 @node Introduction, Document Structure, Top, Top
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
399 @chapter Introduction
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
400 @cindex introduction
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
401
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
402 @menu
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
403 * Summary:: Brief summary of what Org does
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
404 * Installation:: How to install a downloaded version of Org
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
405 * Activation:: How to activate Org for certain buffers
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
406 * Feedback:: Bug reports, ideas, patches etc.
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
407 * Conventions:: Type-setting conventions in the manual
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
408 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
409
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
410 @node Summary, Installation, Introduction, Introduction
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
411 @section Summary
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
412 @cindex summary
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
413
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
414 Org is a mode for keeping notes, maintaining TODO lists, and doing
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
415 project planning with a fast and effective plain-text system.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
416
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
417 Org develops organizational tasks around NOTES files that contain
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
418 lists or information about projects as plain text. Org is
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
419 implemented on top of Outline mode, which makes it possible to keep the
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
420 content of large files well structured. Visibility cycling and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
421 structure editing help to work with the tree. Tables are easily created
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
422 with a built-in table editor. Org supports TODO items, deadlines,
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
423 time stamps, and scheduling. It dynamically compiles entries into an
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
424 agenda that utilizes and smoothly integrates much of the Emacs calendar
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
425 and diary. Plain text URL-like links connect to websites, emails,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
426 Usenet messages, BBDB entries, and any files related to the projects.
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
427 For printing and sharing of notes, an Org file can be exported as a
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
428 structured ASCII file, as HTML, or (TODO and agenda items only) as an
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
429 iCalendar file. It can also serve as a publishing tool for a set of
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
430 linked web pages.
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
431
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
432 An important design aspect that distinguishes Org from for example
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
433 Planner/Muse is that it encourages to store every piece of information
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
434 only once. In Planner, you have project pages, day pages and possibly
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
435 other files, duplicating some information such as tasks. In Org,
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
436 you only have notes files. In your notes you mark entries as tasks,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
437 label them with tags and timestamps. All necessary lists like a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
438 schedule for the day, the agenda for a meeting, tasks lists selected by
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
439 tags etc are created dynamically when you need them.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
440
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
441 Org keeps simple things simple. When first fired up, it should
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
442 feel like a straightforward, easy to use outliner. Complexity is not
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
443 imposed, but a large amount of functionality is available when you need
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
444 it. Org is a toolbox and can be used in different ways, for
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
445 example as:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
446
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
447 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
448 @r{@bullet{} outline extension with visibility cycling and structure editing}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
449 @r{@bullet{} ASCII system and table editor for taking structured notes}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
450 @r{@bullet{} ASCII table editor with spreadsheet-like capabilities}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
451 @r{@bullet{} TODO list editor}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
452 @r{@bullet{} full agenda and planner with deadlines and work scheduling}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
453 @r{@bullet{} environment to implement David Allen's GTD system}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
454 @r{@bullet{} a basic database application}
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
455 @r{@bullet{} simple hypertext system, with HTML and LaTeX export}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
456 @r{@bullet{} publishing tool to create a set of interlinked webpages}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
457 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
458
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
459 Org's automatic, context sensitive table editor with spreadsheet
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
460 capabilities can be integrated into any major mode by activating the
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
461 minor Orgtbl mode. Using a translation step, it can be used to maintain
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
462 tables in arbitrary file types, for example in La@TeX{}. The structure
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
463 editing and list creation capabilities can be used outside Org with
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
464 the minor Orgstruct mode.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
465
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
466 @cindex FAQ
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
467 There is a website for Org which provides links to the newest
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
468 version of Org, as well as additional information, frequently asked
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
469 questions (FAQ), links to tutorials etc. This page is located at
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
470 @uref{http://orgmode.org}.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
471
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
472 @page
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
473
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
474
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
475 @node Installation, Activation, Summary, Introduction
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
476 @section Installation
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
477 @cindex installation
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
478 @cindex XEmacs
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
479
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
480 @b{Important:} @i{If Org is part of the Emacs distribution or an
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
481 XEmacs package, please skip this section and go directly to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
482 @ref{Activation}.}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
483
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
484 If you have downloaded Org from the Web, either as a distribution @file{.zip}
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
485 or @file{.tar} file, or as a GIT archive, you must take the following steps
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
486 to install it: Go into the unpacked Org distribution directory and edit the
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
487 top section of the file @file{Makefile}. You must set the name of the Emacs
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
488 binary (likely either @file{emacs} or @file{xemacs}), and the paths to the
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
489 directories where local Lisp and Info files are kept. If you don't have
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
490 access to the system-wide directories, you can simply run Org directly from
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
491 the distribution directory by adding the @file{lisp} subdirectory to the
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
492 Emacs load path. To do this, add the following line to @file{.emacs}:
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
493
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
494 @example
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
495 (setq load-path (cons "~/path/to/orgdir/lisp" load-path))
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
496 @end example
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
497
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
498 @noindent
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
499 If you plan to use code from the @file{contrib} subdirectory, do a similar
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
500 step for this directory:
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
501
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
502 @example
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
503 (setq load-path (cons "~/path/to/orgdir/contrib/lisp" load-path))
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
504 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
505
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
506 @b{XEmacs users now need to install the file @file{noutline.el} from
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
507 the @file{xemacs} sub-directory of the Org distribution. Use the
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
508 command:}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
509
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
510 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
511 @b{make install-noutline}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
512 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
513
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
514 @noindent Now byte-compile the Lisp files with the shell command:
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
515
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
516 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
517 make
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
518 @end example
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
519
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
520 @noindent If you are running Org from the distribution directory, this is
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
521 all. If you want to install into the system directories, use
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
522
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
523 @example
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
524 make install
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
525 make install-info
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
526 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
527
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
528 @noindent Then add to @file{.emacs}:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
529
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
530 @lisp
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
531 ;; This line only if Org is not part of the X/Emacs distribution.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
532 (require 'org-install)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
533 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
534
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
535 Do not forget to activate Org as described in the following section.
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
536
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
537 @node Activation, Feedback, Installation, Introduction
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
538 @section Activation
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
539 @cindex activation
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
540 @cindex autoload
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
541 @cindex global key bindings
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
542 @cindex key bindings, global
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
543
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
544 @iftex
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
545 @b{Important:} @i{If you use copy-and-paste to copy lisp code from the
96976
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
546 PDF documentation as viewed by some PDF viewers to your .emacs file, the
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
547 single quote character comes out incorrectly and the code will not work.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
548 You need to fix the single quotes by hand, or copy from Info
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
549 documentation.}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
550 @end iftex
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
551
99139
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
552 Add the following lines to your @file{.emacs} file. The last three lines
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
553 define @emph{global} keys for the commands @command{org-store-link},
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
554 @command{org-agenda}, and @command{org-iswitchb} - please choose suitable
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
555 keys yourself.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
556
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
557 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
558 ;; The following lines are always needed. Choose your own keys.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
559 (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
560 (global-set-key "\C-cl" 'org-store-link)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
561 (global-set-key "\C-ca" 'org-agenda)
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
562 (global-set-key "\C-cb" 'org-iswitchb)
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
563 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
564
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
565 Furthermore, you must activate @code{font-lock-mode} in Org
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
566 buffers, because significant functionality depends on font-locking being
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
567 active. You can do this with either one of the following two lines
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
568 (XEmacs user must use the second option):
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
569 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
570 (global-font-lock-mode 1) ; for all buffers
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
571 (add-hook 'org-mode-hook 'turn-on-font-lock) ; Org buffers only
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
572 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
573
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
574 @cindex Org mode, turning on
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
575 With this setup, all files with extension @samp{.org} will be put
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
576 into Org mode. As an alternative, make the first line of a file look
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
577 like this:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
578
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
579 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
580 MY PROJECTS -*- mode: org; -*-
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
581 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
582
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
583 @noindent which will select Org mode for this buffer no matter what
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
584 the file's name is. See also the variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
585 @code{org-insert-mode-line-in-empty-file}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
586
101574
9ef994c968b4 Restore a clobbered change.
Glenn Morris <rgm@gnu.org>
parents: 101570
diff changeset
587 Many commands in Org work on the region if the region is active. To make use
100607
87dcbbf4f5fa 2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100508
diff changeset
588 of this, you need to have @code{transient-mark-mode} (@code{zmacs-regions} in
87dcbbf4f5fa 2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100508
diff changeset
589 XEmacs) turned on. In Emacs 23 this is the default, in Emacs 22 you need to
87dcbbf4f5fa 2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100508
diff changeset
590 do this yourself with
87dcbbf4f5fa 2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100508
diff changeset
591
87dcbbf4f5fa 2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100508
diff changeset
592 @lisp
87dcbbf4f5fa 2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100508
diff changeset
593 (transient-mark-mode 1)
87dcbbf4f5fa 2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100508
diff changeset
594 @end lisp
87dcbbf4f5fa 2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100508
diff changeset
595
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
596 @node Feedback, Conventions, Activation, Introduction
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
597 @section Feedback
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
598 @cindex feedback
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
599 @cindex bug reports
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
600 @cindex maintainer
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
601 @cindex author
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
602
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
603 If you find problems with Org, or if you have questions, remarks, or ideas
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
604 about it, please mail to the Org mailing list @code{emacs-orgmode@@gnu.org}.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
605 If you are not a member of the mailing list, your mail will be reviewed by a
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
606 moderator and then passed through to the list.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
607
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
608 For bug reports, please provide as much information as possible,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
609 including the version information of Emacs (@kbd{C-h v emacs-version
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
610 @key{RET}}) and Org (@kbd{C-h v org-version @key{RET}}), as well as
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
611 the Org related setup in @file{.emacs}. If an error occurs, a
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
612 backtrace can be very useful (see below on how to create one). Often a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
613 small example file helps, along with clear information about:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
614
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
615 @enumerate
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
616 @item What exactly did you do?
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
617 @item What did you expect to happen?
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
618 @item What happened instead?
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
619 @end enumerate
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
620 @noindent Thank you for helping to improve this mode.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
621
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
622 @subsubheading How to create a useful backtrace
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
623
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
624 @cindex backtrace of an error
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
625 If working with Org produces an error with a message you don't
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
626 understand, you may have hit a bug. The best way to report this is by
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
627 providing, in addition to what was mentioned above, a @emph{Backtrace}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
628 This is information from the built-in debugger about where and how the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
629 error occurred. Here is how to produce a useful backtrace:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
630
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
631 @enumerate
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
632 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
633 Start a fresh Emacs or XEmacs, and make sure that it will load the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
634 original Lisp code in @file{org.el} instead of the compiled version in
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
635 @file{org.elc}. The backtrace contains much more information if it is
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
636 produced with uncompiled code. To do this, either rename @file{org.elc}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
637 to something else before starting Emacs, or ask Emacs explicitly to load
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
638 @file{org.el} by using the command line
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
639 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
640 emacs -l /path/to/org.el
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
641 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
642 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
643 Go to the @code{Options} menu and select @code{Enter Debugger on Error}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
644 (XEmacs has this option in the @code{Troubleshooting} sub-menu).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
645 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
646 Do whatever you have to do to hit the error. Don't forget to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
647 document the steps you take.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
648 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
649 When you hit the error, a @file{*Backtrace*} buffer will appear on the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
650 screen. Save this buffer to a file (for example using @kbd{C-x C-w}) and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
651 attach it to your bug report.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
652 @end enumerate
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
653
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
654 @node Conventions, , Feedback, Introduction
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
655 @section Typesetting conventions used in this manual
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
656
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
657 Org uses three types of keywords: TODO keywords, tags, and property
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
658 names. In this manual we use the following conventions:
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
659
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
660 @table @code
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
661 @item TODO
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
662 @itemx WAITING
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
663 TODO keywords are written with all capitals, even if they are
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
664 user-defined.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
665 @item boss
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
666 @itemx ARCHIVE
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
667 User-defined tags are written in lowercase; built-in tags with special
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
668 meaning are written with all capitals.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
669 @item Release
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
670 @itemx PRIORITY
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
671 User-defined properties are capitalized; built-in properties with
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
672 special meaning are written with all capitals.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
673 @end table
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
674
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
675 @node Document Structure, Tables, Introduction, Top
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
676 @chapter Document Structure
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
677 @cindex document structure
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
678 @cindex structure of document
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
679
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
680 Org is based on outline mode and provides flexible commands to
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
681 edit the structure of the document.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
682
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
683 @menu
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
684 * Outlines:: Org is based on Outline mode
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
685 * Headlines:: How to typeset Org tree headlines
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
686 * Visibility cycling:: Show and hide, much simplified
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
687 * Motion:: Jumping to other headlines
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
688 * Structure editing:: Changing sequence and level of headlines
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
689 * Archiving:: Move done task trees to a different place
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
690 * Sparse trees:: Matches embedded in context
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
691 * Plain lists:: Additional structure within an entry
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
692 * Drawers:: Tucking stuff away
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
693 * Footnotes:: How footnotes are defined in Org's syntax
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
694 * Orgstruct mode:: Structure editing outside Org
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
695 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
696
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
697 @node Outlines, Headlines, Document Structure, Document Structure
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
698 @section Outlines
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
699 @cindex outlines
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
700 @cindex Outline mode
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
701
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
702 Org is implemented on top of Outline mode. Outlines allow a
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
703 document to be organized in a hierarchical structure, which (at least
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
704 for me) is the best representation of notes and thoughts. An overview
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
705 of this structure is achieved by folding (hiding) large parts of the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
706 document to show only the general document structure and the parts
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
707 currently being worked on. Org greatly simplifies the use of
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
708 outlines by compressing the entire show/hide functionality into a single
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
709 command @command{org-cycle}, which is bound to the @key{TAB} key.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
710
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
711 @node Headlines, Visibility cycling, Outlines, Document Structure
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
712 @section Headlines
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
713 @cindex headlines
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
714 @cindex outline tree
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
715
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
716 Headlines define the structure of an outline tree. The headlines in
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
717 Org start with one or more stars, on the left margin@footnote{See
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
718 the variable @code{org-special-ctrl-a/e} to configure special behavior
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
719 of @kbd{C-a} and @kbd{C-e} in headlines.}. For example:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
720
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
721 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
722 * Top level headline
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
723 ** Second level
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
724 *** 3rd level
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
725 some text
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
726 *** 3rd level
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
727 more text
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
728
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
729 * Another top level headline
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
730 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
731
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
732 @noindent Some people find the many stars too noisy and would prefer an
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
733 outline that has whitespace followed by a single star as headline
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
734 starters. @ref{Clean view} describes a setup to realize this.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
735
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
736 An empty line after the end of a subtree is considered part of it and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
737 will be hidden when the subtree is folded. However, if you leave at
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
738 least two empty lines, one empty line will remain visible after folding
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
739 the subtree, in order to structure the collapsed view. See the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
740 variable @code{org-cycle-separator-lines} to modify this behavior.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
741
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
742 @node Visibility cycling, Motion, Headlines, Document Structure
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
743 @section Visibility cycling
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
744 @cindex cycling, visibility
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
745 @cindex visibility cycling
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
746 @cindex trees, visibility
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
747 @cindex show hidden text
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
748 @cindex hide text
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
749
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
750 Outlines make it possible to hide parts of the text in the buffer.
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
751 Org uses just two commands, bound to @key{TAB} and
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
752 @kbd{S-@key{TAB}} to change the visibility in the buffer.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
753
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
754 @cindex subtree visibility states
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
755 @cindex subtree cycling
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
756 @cindex folded, subtree visibility state
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
757 @cindex children, subtree visibility state
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
758 @cindex subtree, subtree visibility state
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
759 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
760 @kindex @key{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
761 @item @key{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
762 @emph{Subtree cycling}: Rotate current subtree among the states
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
763
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
764 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
765 ,-> FOLDED -> CHILDREN -> SUBTREE --.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
766 '-----------------------------------'
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
767 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
768
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
769 The cursor must be on a headline for this to work@footnote{see, however,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
770 the option @code{org-cycle-emulate-tab}.}. When the cursor is at the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
771 beginning of the buffer and the first line is not a headline, then
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
772 @key{TAB} actually runs global cycling (see below)@footnote{see the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
773 option @code{org-cycle-global-at-bob}.}. Also when called with a prefix
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
774 argument (@kbd{C-u @key{TAB}}), global cycling is invoked.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
775
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
776 @cindex global visibility states
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
777 @cindex global cycling
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
778 @cindex overview, global visibility state
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
779 @cindex contents, global visibility state
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
780 @cindex show all, global visibility state
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
781 @kindex S-@key{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
782 @item S-@key{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
783 @itemx C-u @key{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
784 @emph{Global cycling}: Rotate the entire buffer among the states
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
785
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
786 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
787 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
788 '--------------------------------------'
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
789 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
790
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
791 When @kbd{S-@key{TAB}} is called with a numeric prefix argument N, the
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
792 CONTENTS view up to headlines of level N will be shown. Note that inside
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
793 tables, @kbd{S-@key{TAB}} jumps to the previous field.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
794
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
795 @cindex show all, command
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
796 @kindex C-u C-u C-u @key{TAB}
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
797 @item C-u C-u C-u @key{TAB}
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
798 Show all, including drawers.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
799 @kindex C-c C-r
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
800 @item C-c C-r
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
801 Reveal context around point, showing the current entry, the following heading
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
802 and the hierarchy above. Useful for working near a location that has been
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
803 exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
804 (@pxref{Agenda commands}). With a prefix argument show, on each
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
805 level, all sibling headings.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
806 @kindex C-c C-x b
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
807 @item C-c C-x b
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
808 Show the current subtree in an indirect buffer@footnote{The indirect
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
809 buffer
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
810 @ifinfo
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
811 (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual})
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
812 @end ifinfo
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
813 @ifnotinfo
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
814 (see the Emacs manual for more information about indirect buffers)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
815 @end ifnotinfo
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
816 will contain the entire buffer, but will be narrowed to the current
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
817 tree. Editing the indirect buffer will also change the original buffer,
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
818 but without affecting visibility in that buffer.}. With a numeric
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
819 prefix argument N, go up to level N and then take that tree. If N is
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
820 negative then go up that many levels. With a @kbd{C-u} prefix, do not remove
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
821 the previously used indirect buffer.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
822 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
823
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
824 When Emacs first visits an Org file, the global state is set to
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
825 OVERVIEW, i.e. only the top level headlines are visible. This can be
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
826 configured through the variable @code{org-startup-folded}, or on a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
827 per-file basis by adding one of the following lines anywhere in the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
828 buffer:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
829
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
830 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
831 #+STARTUP: overview
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
832 #+STARTUP: content
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
833 #+STARTUP: showall
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
834 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
835
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
836 @noindent
101147
a62da64665d1 Fix some more typos.
Glenn Morris <rgm@gnu.org>
parents: 101146
diff changeset
837 Furthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
838 and Columns}) will get their visibility adapted accordingly. Allowed values
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
839 for this property are @code{folded}, @code{children}, @code{content}, and
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
840 @code{all}.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
841 @table @kbd
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
842 @kindex C-u C-u @key{TAB}
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
843 @item C-u C-u @key{TAB}
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
844 Switch back to the startup visibility of the buffer, i.e. whatever is
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
845 requested by startup options and @samp{VISIBILITY} properties in individual
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
846 entries.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
847 @end table
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
848
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
849 @node Motion, Structure editing, Visibility cycling, Document Structure
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
850 @section Motion
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
851 @cindex motion, between headlines
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
852 @cindex jumping, to headlines
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
853 @cindex headline navigation
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
854 The following commands jump to other headlines in the buffer.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
855
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
856 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
857 @kindex C-c C-n
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
858 @item C-c C-n
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
859 Next heading.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
860 @kindex C-c C-p
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
861 @item C-c C-p
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
862 Previous heading.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
863 @kindex C-c C-f
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
864 @item C-c C-f
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
865 Next heading same level.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
866 @kindex C-c C-b
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
867 @item C-c C-b
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
868 Previous heading same level.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
869 @kindex C-c C-u
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
870 @item C-c C-u
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
871 Backward to higher level heading.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
872 @kindex C-c C-j
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
873 @item C-c C-j
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
874 Jump to a different place without changing the current outline
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
875 visibility. Shows the document structure in a temporary buffer, where
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
876 you can use the following keys to find your destination:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
877 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
878 @key{TAB} @r{Cycle visibility.}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
879 @key{down} / @key{up} @r{Next/previous visible headline.}
99139
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
880 @key{RET} @r{Select this location.}
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
881 @kbd{/} @r{Do a Sparse-tree search}
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
882 @r{The following keys work if you turn off @code{org-goto-auto-isearch}}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
883 n / p @r{Next/previous visible headline.}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
884 f / b @r{Next/previous headline same level.}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
885 u @r{One level up.}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
886 0-9 @r{Digit argument.}
99139
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
887 q @r{Quit}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
888 @end example
99868
404f28130174 *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 99851
diff changeset
889 See also the variable@code{org-goto-interface}.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
890 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
891
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
892 @node Structure editing, Archiving, Motion, Document Structure
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
893 @section Structure editing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
894 @cindex structure editing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
895 @cindex headline, promotion and demotion
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
896 @cindex promotion, of subtrees
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
897 @cindex demotion, of subtrees
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
898 @cindex subtree, cut and paste
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
899 @cindex pasting, of subtrees
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
900 @cindex cutting, of subtrees
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
901 @cindex copying, of subtrees
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
902 @cindex subtrees, cut and paste
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
903
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
904 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
905 @kindex M-@key{RET}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
906 @item M-@key{RET}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
907 Insert new heading with same level as current. If the cursor is in a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
908 plain list item, a new item is created (@pxref{Plain lists}). To force
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
909 creation of a new headline, use a prefix argument, or first press @key{RET}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
910 to get to the beginning of the next line. When this command is used in
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
911 the middle of a line, the line is split and the rest of the line becomes
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
912 the new headline@footnote{If you do not want the line to be split,
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
913 customize the variable @code{org-M-RET-may-split-line}.}. If the
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
914 command is used at the beginning of a headline, the new headline is
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
915 created before the current line. If at the beginning of any other line,
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
916 the content of that line is made the new heading. If the command is
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
917 used at the end of a folded subtree (i.e. behind the ellipses at the end
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
918 of a headline), then a headline like the current one will be inserted
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
919 after the end of the subtree.
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
920 @kindex C-@key{RET}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
921 @item C-@key{RET}
99139
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
922 Just like @kbd{M-@key{RET}}, except when adding a new heading below the
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
923 current heading, the new heading is placed after the body instead of before
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
924 it. This command works from anywhere in the entry.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
925 @kindex M-S-@key{RET}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
926 @item M-S-@key{RET}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
927 Insert new TODO entry with same level as current heading.
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
928 @kindex C-S-@key{RET}
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
929 @item C-S-@key{RET}
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
930 Insert new TODO entry with same level as current heading. Like
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
931 @kbd{C-@key{RET}}, the new headline will be inserted after the current
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
932 subtree.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
933 @kindex M-@key{left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
934 @item M-@key{left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
935 Promote current heading by one level.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
936 @kindex M-@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
937 @item M-@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
938 Demote current heading by one level.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
939 @kindex M-S-@key{left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
940 @item M-S-@key{left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
941 Promote the current subtree by one level.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
942 @kindex M-S-@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
943 @item M-S-@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
944 Demote the current subtree by one level.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
945 @kindex M-S-@key{up}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
946 @item M-S-@key{up}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
947 Move subtree up (swap with previous subtree of same
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
948 level).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
949 @kindex M-S-@key{down}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
950 @item M-S-@key{down}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
951 Move subtree down (swap with next subtree of same level).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
952 @kindex C-c C-x C-w
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
953 @item C-c C-x C-w
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
954 Kill subtree, i.e. remove it from buffer but save in kill ring.
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
955 With a numeric prefix argument N, kill N sequential subtrees.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
956 @kindex C-c C-x M-w
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
957 @item C-c C-x M-w
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
958 Copy subtree to kill ring. With a numeric prefix argument N, copy the N
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
959 sequential subtrees.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
960 @kindex C-c C-x C-y
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
961 @item C-c C-x C-y
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
962 Yank subtree from kill ring. This does modify the level of the subtree to
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
963 make sure the tree fits in nicely at the yank position. The yank level can
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
964 also be specified with a numeric prefix argument, or by yanking after a
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
965 headline marker like @samp{****}.
100271
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
966 @kindex C-y
99503
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
967 @item C-y
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
968 Depending on the variables @code{org-yank-adjusted-subtrees} and
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
969 @code{org-yank-folded-subtrees}, Org's internal @code{yank} command will
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
970 paste subtrees folded and in a clever way, using the same command as @kbd{C-c
101758
64835454876e 2009-02-02 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101747
diff changeset
971 C-x C-y}. With the default settings, no level adjustment will take place,
64835454876e 2009-02-02 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101747
diff changeset
972 but the yanked tree will be folded unless doing so would swallow text
64835454876e 2009-02-02 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101747
diff changeset
973 previously visible. Any prefix argument to this command will force a normal
64835454876e 2009-02-02 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101747
diff changeset
974 @code{yank} to be executed, with the prefix passed along. A good way to
64835454876e 2009-02-02 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101747
diff changeset
975 force a normal yank is @kbd{C-u C-y}. If you use @code{yank-pop} after a
64835454876e 2009-02-02 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101747
diff changeset
976 yank, it will yank previous kill items plainly, without adjustment and
64835454876e 2009-02-02 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101747
diff changeset
977 folding.
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
978 @kindex C-c C-w
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
979 @item C-c C-w
99503
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
980 Refile entry or region to a different location. @xref{Refiling notes}.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
981 @kindex C-c ^
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
982 @item C-c ^
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
983 Sort same-level entries. When there is an active region, all entries in the
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
984 region will be sorted. Otherwise the children of the current headline are
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
985 sorted. The command prompts for the sorting method, which can be
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
986 alphabetically, numerically, by time (using the first time stamp in each
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
987 entry), by priority, or by TODO keyword (in the sequence the keywords have
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
988 been defined in the setup). Reverse sorting is possible as well. You can
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
989 also supply your own function to extract the sorting key. With a @kbd{C-u}
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
990 prefix, sorting will be case-sensitive. With two @kbd{C-u C-u} prefixes,
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
991 duplicate entries will also be removed.
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
992 @kindex C-x n s
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
993 @item C-x n s
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
994 Narrow buffer to current subtree.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
995 @kindex C-x n w
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
996 @item C-x n w
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
997 Widen buffer to remove a narrowing.
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
998 @kindex C-c *
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
999 @item C-c *
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1000 Turn a normal line or plain list item into a headline (so that it becomes a
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1001 subheading at its location). Also turn a headline into a normal line by
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1002 removing the stars. If there is an active region, turn all lines in the
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1003 region into headlines. If the first line in the region was an item, turn
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1004 only the item lines into headlines. Finally, if the first line is a
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
1005 headline, remove the stars from all headlines in the region.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1006 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1007
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1008 @cindex region, active
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1009 @cindex active region
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1010 @cindex Transient mark mode
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1011 When there is an active region (Transient mark mode), promotion and
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1012 demotion work on all headlines in the region. To select a region of
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1013 headlines, it is best to place both point and mark at the beginning of a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1014 line, mark at the beginning of the first headline, and point at the line
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1015 just after the last headline to change. Note that when the cursor is
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1016 inside a table (@pxref{Tables}), the Meta-Cursor keys have different
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1017 functionality.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1018
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1019 @node Archiving, Sparse trees, Structure editing, Document Structure
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1020 @section Archiving
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1021 @cindex archiving
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1022
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1023 When a project represented by a (sub)tree is finished, you may want
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1024 to move the tree out of the way and to stop it from contributing to the
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1025 agenda. Org mode knows two ways of archiving. You can mark a tree with
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1026 the ARCHIVE tag, or you can move an entire (sub)tree to a different
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1027 location.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1028
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1029 @menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1030 * ARCHIVE tag:: Marking a tree as inactive
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1031 * Moving subtrees:: Moving a tree to an archive file
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1032 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1033
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1034 @node ARCHIVE tag, Moving subtrees, Archiving, Archiving
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1035 @subsection The ARCHIVE tag
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1036 @cindex internal archiving
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1037
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1038 A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1039 its location in the outline tree, but behaves in the following way:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1040 @itemize @minus
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1041 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1042 It does not open when you attempt to do so with a visibility cycling
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1043 command (@pxref{Visibility cycling}). You can force cycling archived
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1044 subtrees with @kbd{C-@key{TAB}}, or by setting the option
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1045 @code{org-cycle-open-archived-trees}. Also normal outline commands like
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1046 @code{show-all} will open archived subtrees.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1047 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1048 During sparse tree construction (@pxref{Sparse trees}), matches in
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1049 archived subtrees are not exposed, unless you configure the option
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1050 @code{org-sparse-tree-open-archived-trees}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1051 @item
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1052 During agenda view construction (@pxref{Agenda Views}), the content of
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1053 archived trees is ignored unless you configure the option
96976
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
1054 @code{org-agenda-skip-archived-trees}, in which case these trees will always
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
1055 be included. In the agenda you can press the @kbd{v} key to get archives
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
1056 temporarily included.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1057 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1058 Archived trees are not exported (@pxref{Exporting}), only the headline
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1059 is. Configure the details using the variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1060 @code{org-export-with-archived-trees}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1061 @end itemize
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1062
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1063 The following commands help managing the ARCHIVE tag:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1064
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1065 @table @kbd
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1066 @kindex C-c C-x a
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1067 @item C-c C-x a
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1068 Toggle the ARCHIVE tag for the current headline. When the tag is set,
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1069 the headline changes to a shadowed face, and the subtree below it is
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1070 hidden.
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1071 @kindex C-u C-c C-x a
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1072 @item C-u C-c C-x a
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1073 Check if any direct children of the current headline should be archived.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1074 To do this, each subtree is checked for open TODO entries. If none are
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1075 found, the command offers to set the ARCHIVE tag for the child. If the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1076 cursor is @emph{not} on a headline when this command is invoked, the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1077 level 1 trees will be checked.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1078 @kindex C-@kbd{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1079 @item C-@kbd{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1080 Cycle a tree even if it is tagged with ARCHIVE.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1081 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1082
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1083 @node Moving subtrees, , ARCHIVE tag, Archiving
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1084 @subsection Moving subtrees
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1085 @cindex external archiving
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1086
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1087 Once an entire project is finished, you may want to move it to a different
96976
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
1088 location. Org can move it to an @emph{Archive Sibling} in the same tree, to a
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1089 different tree in the current file, or to a different file, the archive file.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1090
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1091 @table @kbd
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1092 @kindex C-c C-x A
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1093 @item C-c C-x A
96976
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
1094 Move the current entry to the @emph{Archive Sibling}. This is a sibling of
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
1095 the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE}
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1096 (@pxref{ARCHIVE tag}). The entry becomes a child of that sibling and in this
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1097 way retains a lot of its original context, including inherited tags and
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1098 approximate position in the outline.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1099 @kindex C-c C-x C-s
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1100 @item C-c C-x C-s
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1101 Archive the subtree starting at the cursor position to the location
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1102 given by @code{org-archive-location}. Context information that could be
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1103 lost like the file name, the category, inherited tags, and the TODO
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1104 state will be store as properties in the entry.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1105 @kindex C-u C-c C-x C-s
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1106 @item C-u C-c C-x C-s
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1107 Check if any direct children of the current headline could be moved to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1108 the archive. To do this, each subtree is checked for open TODO entries.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1109 If none are found, the command offers to move it to the archive
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1110 location. If the cursor is @emph{not} on a headline when this command
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1111 is invoked, the level 1 trees will be checked.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1112 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1113
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1114 @cindex archive locations
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1115 The default archive location is a file in the same directory as the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1116 current file, with the name derived by appending @file{_archive} to the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1117 current file name. For information and examples on how to change this,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1118 see the documentation string of the variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1119 @code{org-archive-location}. There is also an in-buffer option for
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1120 setting this variable, for example@footnote{For backward compatibility,
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1121 the following also works: If there are several such lines in a file,
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1122 each specifies the archive location for the text below it. The first
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1123 such line also applies to any text before its definition. However,
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1124 using this method is @emph{strongly} deprecated as it is incompatible
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1125 with the outline structure of the document. The correct method for
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1126 setting multiple archive locations in a buffer is using properties.}:
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1127
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1128 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1129 #+ARCHIVE: %s_done::
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1130 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1131
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1132 @noindent
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1133 If you would like to have a special ARCHIVE location for a single entry
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1134 or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1135 location as the value (@pxref{Properties and Columns}).
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1136
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
1137 When a subtree is moved, it receives a number of special properties that
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
1138 record context information like the file from where the entry came, it's
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
1139 outline path the archiving time etc. Configure the variable
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
1140 @code{org-archive-save-context-info} to adjust the amount of information
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
1141 added.
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
1142
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1143 @node Sparse trees, Plain lists, Archiving, Document Structure
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1144 @section Sparse trees
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1145 @cindex sparse trees
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1146 @cindex trees, sparse
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1147 @cindex folding, sparse trees
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1148 @cindex occur, command
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1149
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
1150 An important feature of Org mode is the ability to construct @emph{sparse
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
1151 trees} for selected information in an outline tree, so that the entire
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
1152 document is folded as much as possible, but the selected information is made
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
1153 visible along with the headline structure above it@footnote{See also the
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
1154 variables @code{org-show-hierarchy-above}, @code{org-show-following-heading},
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
1155 @code{org-show-siblings}, and @code{org-show-entry-below} for detailed
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
1156 control on how much context is shown around each match.}. Just try it out
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
1157 and you will see immediately how it works.
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1158
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1159 Org mode contains several commands creating such trees, all these
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1160 commands can be accessed through a dispatcher:
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1161
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1162 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1163 @kindex C-c /
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1164 @item C-c /
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1165 This prompts for an extra key to select a sparse-tree creating command.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1166 @kindex C-c / r
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1167 @item C-c / r
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
1168 Occur. Prompts for a regexp and shows a sparse tree with all matches. If
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
1169 the match is in a headline, the headline is made visible. If the match is in
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
1170 the body of an entry, headline and body are made visible. In order to
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
1171 provide minimal context, also the full hierarchy of headlines above the match
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
1172 is shown, as well as the headline following the match. Each match is also
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
1173 highlighted; the highlights disappear when the buffer is changed by an
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
1174 editing command@footnote{depending on the option
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
1175 @code{org-remove-highlights-with-change}}, or by pressing @kbd{C-c C-c}.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
1176 When called with a @kbd{C-u} prefix argument, previous highlights are kept,
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
1177 so several calls to this command can be stacked.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1178 @end table
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1179
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1180 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1181 For frequently used sparse trees of specific search strings, you can
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1182 use the variable @code{org-agenda-custom-commands} to define fast
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1183 keyboard access to specific sparse trees. These commands will then be
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1184 accessible through the agenda dispatcher (@pxref{Agenda dispatcher}).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1185 For example:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1186
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1187 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1188 (setq org-agenda-custom-commands
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1189 '(("f" occur-tree "FIXME")))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1190 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1191
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1192 @noindent will define the key @kbd{C-c a f} as a shortcut for creating
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1193 a sparse tree matching the string @samp{FIXME}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1194
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1195 The other sparse tree commands select headings based on TODO keywords,
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1196 tags, or properties and will be discussed later in this manual.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1197
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1198 @kindex C-c C-e v
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1199 @cindex printing sparse trees
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1200 @cindex visible text, printing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1201 To print a sparse tree, you can use the Emacs command
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1202 @code{ps-print-buffer-with-faces} which does not print invisible parts
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1203 of the document @footnote{This does not work under XEmacs, because
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1204 XEmacs uses selective display for outlining, not text properties.}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1205 Or you can use the command @kbd{C-c C-e v} to export only the visible
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1206 part of the document and print the resulting file.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1207
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1208 @node Plain lists, Drawers, Sparse trees, Document Structure
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1209 @section Plain lists
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1210 @cindex plain lists
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1211 @cindex lists, plain
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1212 @cindex lists, ordered
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1213 @cindex ordered lists
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1214
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1215 Within an entry of the outline tree, hand-formatted lists can provide
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1216 additional structure. They also provide a way to create lists of
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1217 checkboxes (@pxref{Checkboxes}). Org supports editing such lists,
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1218 and the HTML exporter (@pxref{Exporting}) parses and formats them.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1219
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
1220 Org knows ordered lists, unordered lists, and description lists.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
1221 @itemize @bullet
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
1222 @item
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
1223 @emph{Unordered} list items start with @samp{-}, @samp{+}, or
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
1224 @samp{*}@footnote{When using @samp{*} as a bullet, lines must be indented or
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
1225 they will be seen as top-level headlines. Also, when you are hiding leading
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
1226 stars to get a clean outline view, plain list items starting with a star are
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
1227 visually indistinguishable from true headlines. In short: even though
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
1228 @samp{*} is supported, it may be better to not use it for plain list items.}
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
1229 as bullets.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
1230 @item
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
1231 @emph{Ordered} list items start with a numeral followed by either a period or
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
1232 a right parenthesis, such as @samp{1.} or @samp{1)}.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
1233 @item
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
1234 @emph{Description} list items are like unordered list items, but contain the
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
1235 separator @samp{ :: } to separate the description @emph{term} from the
101147
a62da64665d1 Fix some more typos.
Glenn Morris <rgm@gnu.org>
parents: 101146
diff changeset
1236 description.
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
1237 @end itemize
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
1238
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
1239 Items belonging to the same list must have the same indentation on the first
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
1240 line. In particular, if an ordered list reaches number @samp{10.}, then the
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
1241 2--digit numbers must be written left-aligned with the other numbers in the
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
1242 list. Indentation also determines the end of a list item. It ends before
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
1243 the next line that is indented like the bullet/number, or less. Empty lines
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
1244 are part of the previous item, so you can have several paragraphs in one
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
1245 item. If you would like an empty line to terminate all currently open plain
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
1246 lists, configure the variable @code{org-empty-line-terminates-plain-lists}.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
1247 Here is an example:
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1248
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1249 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1250 @group
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1251 ** Lord of the Rings
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1252 My favorite scenes are (in this order)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1253 1. The attack of the Rohirrim
101147
a62da64665d1 Fix some more typos.
Glenn Morris <rgm@gnu.org>
parents: 101146
diff changeset
1254 2. Eowyn's fight with the witch king
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1255 + this was already my favorite scene in the book
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1256 + I really like Miranda Otto.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1257 3. Peter Jackson being shot by Legolas
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1258 - on DVD only
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1259 He makes a really funny face when it happens.
101147
a62da64665d1 Fix some more typos.
Glenn Morris <rgm@gnu.org>
parents: 101146
diff changeset
1260 But in the end, no individual scenes matter but the film as a whole.
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
1261 Important actors in this film are:
101147
a62da64665d1 Fix some more typos.
Glenn Morris <rgm@gnu.org>
parents: 101146
diff changeset
1262 - @b{Elijah Wood} :: He plays Frodo
101148
9a61f941d76d Fix another typo.
Glenn Morris <rgm@gnu.org>
parents: 101147
diff changeset
1263 - @b{Sean Austin} :: He plays Sam, Frodo's friend. I still remember
101147
a62da64665d1 Fix some more typos.
Glenn Morris <rgm@gnu.org>
parents: 101146
diff changeset
1264 him very well from his role as Mikey Walsh in the Goonies.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1265 @end group
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1266 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1267
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1268 Org supports these lists by tuning filling and wrapping commands to
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1269 deal with them correctly@footnote{Org only changes the filling
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1270 settings for Emacs. For XEmacs, you should use Kyle E. Jones'
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1271 @file{filladapt.el}. To turn this on, put into @file{.emacs}:
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
1272 @code{(require 'filladapt)}}, and by exporting them properly
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
1273 (@pxref{Exporting}).
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1274
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1275 The following commands act on items when the cursor is in the first line
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1276 of an item (the line with the bullet or number).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1277
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1278 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1279 @kindex @key{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1280 @item @key{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1281 Items can be folded just like headline levels if you set the variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1282 @code{org-cycle-include-plain-lists}. The level of an item is then
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1283 given by the indentation of the bullet/number. Items are always
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1284 subordinate to real headlines, however; the hierarchies remain
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1285 completely separated.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1286
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1287 If @code{org-cycle-include-plain-lists} has not been set, @key{TAB}
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1288 fixes the indentation of the current line in a heuristic way.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1289 @kindex M-@key{RET}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1290 @item M-@key{RET}
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1291 Insert new item at current level. With a prefix argument, force a new
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1292 heading (@pxref{Structure editing}). If this command is used in the middle
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1293 of a line, the line is @emph{split} and the rest of the line becomes the new
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1294 item@footnote{If you do not want the line to be split, customize the variable
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1295 @code{org-M-RET-may-split-line}.}. If this command is executed in the
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1296 @emph{whitespace before a bullet or number}, the new item is created
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1297 @emph{before} the current item. If the command is executed in the white
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1298 space before the text that is part of an item but does not contain the
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1299 bullet, a bullet is added to the current line.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1300 @kindex M-S-@key{RET}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1301 @item M-S-@key{RET}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1302 Insert a new item with a checkbox (@pxref{Checkboxes}).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1303 @kindex S-@key{up}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1304 @kindex S-@key{down}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1305 @item S-@key{up}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1306 @itemx S-@key{down}
101570
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
1307 @cindex shift-selection-mode
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
1308 Jump to the previous/next item in the current list, but only if
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
1309 @code{org-support-shift-select} is off. If not, you can still use paragraph
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
1310 jumping commands like @kbd{C-@key{up}} and @kbd{C-@key{down}} to quite
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
1311 similar effect.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1312 @kindex M-S-@key{up}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1313 @kindex M-S-@key{down}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1314 @item M-S-@key{up}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1315 @itemx M-S-@key{down}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1316 Move the item including subitems up/down (swap with previous/next item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1317 of same indentation). If the list is ordered, renumbering is
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1318 automatic.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1319 @kindex M-S-@key{left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1320 @kindex M-S-@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1321 @item M-S-@key{left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1322 @itemx M-S-@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1323 Decrease/increase the indentation of the item, including subitems.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1324 Initially, the item tree is selected based on current indentation.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1325 When these commands are executed several times in direct succession,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1326 the initially selected region is used, even if the new indentation
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1327 would imply a different hierarchy. To use the new hierarchy, break
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1328 the command chain with a cursor motion or so.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1329 @kindex C-c C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1330 @item C-c C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1331 If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1332 state of the checkbox. If not, this command makes sure that all the
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1333 items on this list level use the same bullet. Furthermore, if this is
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1334 an ordered list, make sure the numbering is OK.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1335 @kindex C-c -
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1336 @item C-c -
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1337 Cycle the entire list level through the different itemize/enumerate bullets
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1338 (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}). With a numeric prefix
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1339 argument N, select the Nth bullet from this list. If there is an active
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1340 region when calling this, all lines will be converted to list items. If the
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1341 first line already was a list item, any item markers will be removed from the
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1342 list. Finally, even without an active region, a normal line will be
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1343 converted into a list item.
99851
68981b04c1ac 2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99709
diff changeset
1344 @kindex S-@key{left}
68981b04c1ac 2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99709
diff changeset
1345 @kindex S-@key{right}
68981b04c1ac 2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99709
diff changeset
1346 @item S-@key{left}/@key{right}
101570
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
1347 This command also cycles bullet styles when the cursor in on the bullet or
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
1348 anywhere in an item line, details depending on
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
1349 @code{org-support-shift-select}.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1350 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1351
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1352 @node Drawers, Footnotes, Plain lists, Document Structure
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1353 @section Drawers
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1354 @cindex drawers
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1355 @cindex visibility cycling, drawers
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1356
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1357 Sometimes you want to keep information associated with an entry, but you
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1358 normally don't want to see it. For this, Org mode has @emph{drawers}.
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1359 Drawers need to be configured with the variable
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1360 @code{org-drawers}@footnote{You can define drawers on a per-file basis
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1361 with a line like @code{#+DRAWERS: HIDDEN PROPERTIES STATE}}. Drawers
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1362 look like this:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1363
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1364 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1365 ** This is a headline
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1366 Still outside the drawer
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1367 :DRAWERNAME:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1368 This is inside the drawer.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1369 :END:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1370 After the drawer.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1371 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1372
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1373 Visibility cycling (@pxref{Visibility cycling}) on the headline will
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1374 hide and show the entry, but keep the drawer collapsed to a single line.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1375 In order to look inside the drawer, you need to move the cursor to the
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1376 drawer line and press @key{TAB} there. Org mode uses a drawer for
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
1377 storing properties (@pxref{Properties and Columns}), and another one for
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
1378 storing clock times (@pxref{Clocking work time}).
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1379
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1380 @node Footnotes, Orgstruct mode, Drawers, Document Structure
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1381 @section Footnotes
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1382 @cindex footnotes
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1383
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1384 Org-mode supports the creation of footnotes. In contrast to the
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1385 @file{footnote.el} package, Org-mode's footnotes are designed for work on a
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1386 larger document, not only for one-off documents like emails. The basic
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1387 syntax is similar to the one used by @file{footnote.el}, i.e. a footnote is
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1388 defined in a paragraph that is started by a footnote marker in square
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1389 brackets in column 0, no indentation allowed. If you need a paragraph break
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1390 inside a footnote, use the LaTeX idiom @samp{\par}. The footnote reference
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1391 is simply the marker in square brackets, inside text. For example:
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1392
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1393 @example
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1394 The Org homepage[fn:1] now looks a lot better than it used to.
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1395 ...
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1396 [fn:1] The link is: http://orgmode.org
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1397 @end example
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1398
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1399 Org-mode extends the number-based syntax to @emph{named} footnotes and
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1400 optional inline definition. Using plain numbers as markers (as
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1401 @file{footnote.el} does) is supported for backward compatibility, but not
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1402 encouraged because of possible conflicts with LaTeX snippets @pxref{Embedded
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1403 LaTeX}. Here are the valid references:
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1404
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1405 @table @code
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1406 @item [1]
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1407 A plain numeric footnote marker.
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1408 @item [fn:name]
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1409 A named footnote reference, where @code{name} is a unique label word, or, for
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1410 simplicity of automatic creation, a number.
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1411 @item [fn:: This is the inline definition of this footnote]
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1412 A LaTeX-like anonymous footnote where the definition is given directly at the
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1413 reference point.
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1414 @item [fn:name: a definition]
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1415 An inline definition of a footnote, which also specifies a name for the note.
102151
328f4b370b74 Remove duplicate words.
Juanma Barranquero <lekktu@gmail.com>
parents: 102059
diff changeset
1416 Since Org allows multiple references to the same note, you can then use
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1417 @code{[fn:name]} to create additional references.
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1418 @end table
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1419
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1420 Footnote labels can be created automatically, or you create names yourself.
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1421 This is handled by the variable @code{org-footnote-auto-label} and its
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1422 corresponding @code{#+STARTUP} keywords, see the docstring of that variable
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1423 for details.
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1424
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1425 @noindent The following command handles footnotes:
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1426
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1427 @table @kbd
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1428 @kindex C-c C-x f
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1429 @item C-c C-x f
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1430 The footnote action command.
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1431
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1432 When the cursor is on a footnote reference, jump to the definition. When it
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1433 is at a definition, jump to the (first) reference.
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1434
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1435 Otherwise, create a new footnote. Depending on the variable
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1436 @code{org-footnote-define-inline}@footnote{The corresponding in-buffer
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1437 setting is: @code{#+STARTUP: fninline} or @code{#+STARTUP: nofninline}}, the
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1438 definition will be placed right into the text as part of the reference, or
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1439 separately into the location determined by the variable
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1440 @code{org-footnote-section}.
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1441
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1442 When this command is called with a prefix argument, a menu of additional
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1443 options is offered:
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1444 @example
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1445 s @r{Sort the footnote definitions by reference sequence. During editing,}
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1446 @r{Org makes no effort to sort footnote definitions into a particular}
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1447 @r{sequence. If you want them sorted, use this command, which will}
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1448 @r{also move entries according to @code{org-footnote-section}.}
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1449 n @r{Normalize the footnotes by collecting all definitions (including}
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1450 @r{inline definitions) into a special section, and then numbering them}
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1451 @r{in sequence. The references will then also be numbers. This is}
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1452 @r{meant to be the final step before finishing a document (e.g. sending}
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1453 @r{off an email). The exporters do this automatically, and so could}
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1454 @r{something like @code{message-send-hook}.}
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1455 d @r{Delete the footnote at point, and all definitions of and references}
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1456 @r{to it.}
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1457 @end example
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1458 @kindex C-c C-c
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1459 @item C-c C-c
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1460 If the cursor is on a footnote reference, jump to the definition. If it is a
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1461 the definition, jump back to the reference. When called at a footnote
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1462 location with a prefix argument, offer the same menu as @kbd{C-c C-x f}.
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1463 @kindex C-c C-o
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1464 @kindex mouse-1
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1465 @kindex mouse-2
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1466 @item C-c C-c @r{or} mouse-1/2
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1467 Footnote labels are also links to the corresponding definition/reference, and
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1468 you can use the usual commands to follow these links.
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1469 @end table
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1470
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1471 @node Orgstruct mode, , Footnotes, Document Structure
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1472 @section The Orgstruct minor mode
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1473 @cindex Orgstruct mode
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1474 @cindex minor mode for structure editing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1475
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1476 If you like the intuitive way the Org mode structure editing and list
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1477 formatting works, you might want to use these commands in other modes
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1478 like Text mode or Mail mode as well. The minor mode Orgstruct mode
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1479 makes this possible. You can always toggle the mode with @kbd{M-x
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1480 orgstruct-mode}. To turn it on by default, for example in Mail mode,
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1481 use
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1482
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1483 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1484 (add-hook 'mail-mode-hook 'turn-on-orgstruct)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1485 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1486
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1487 When this mode is active and the cursor is on a line that looks to
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1488 Org like a headline of the first line of a list item, most
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1489 structure editing commands will work, even if the same keys normally
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1490 have different functionality in the major mode you are using. If the
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1491 cursor is not in one of those special lines, Orgstruct mode lurks
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1492 silently in the shadow.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1493
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1494 @node Tables, Hyperlinks, Document Structure, Top
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1495 @chapter Tables
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1496 @cindex tables
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1497 @cindex editing tables
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1498
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1499 Org comes with a fast and intuitive table editor. Spreadsheet-like
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1500 calculations are supported in connection with the Emacs @file{calc}
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
1501 package
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1502 @ifinfo
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1503 (@pxref{Top,Calc,,Calc,Gnu Emacs Calculator Manual}).
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1504 @end ifinfo
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1505 @ifnotinfo
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1506 (see the Emacs Calculator manual for more information about the Emacs
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1507 calculator).
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1508 @end ifnotinfo
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1509
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1510 @menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1511 * Built-in table editor:: Simple tables
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
1512 * Narrow columns:: Stop wasting space in tables
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1513 * Column groups:: Grouping to trigger vertical lines
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1514 * Orgtbl mode:: The table editor as minor mode
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1515 * The spreadsheet:: The table editor has spreadsheet capabilities
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
1516 * Org Plot:: Plotting from org tables
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1517 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1518
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1519 @node Built-in table editor, Narrow columns, Tables, Tables
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1520 @section The built-in table editor
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1521 @cindex table editor, built-in
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1522
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1523 Org makes it easy to format tables in plain ASCII. Any line with
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1524 @samp{|} as the first non-whitespace character is considered part of a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1525 table. @samp{|} is also the column separator. A table might look like
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1526 this:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1527
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1528 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1529 | Name | Phone | Age |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1530 |-------+-------+-----|
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1531 | Peter | 1234 | 17 |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1532 | Anna | 4321 | 25 |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1533 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1534
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1535 A table is re-aligned automatically each time you press @key{TAB} or
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1536 @key{RET} or @kbd{C-c C-c} inside the table. @key{TAB} also moves to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1537 the next field (@key{RET} to the next row) and creates new table rows
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1538 at the end of the table or before horizontal lines. The indentation
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1539 of the table is set by the first line. Any line starting with
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1540 @samp{|-} is considered as a horizontal separator line and will be
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1541 expanded on the next re-align to span the whole table width. So, to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1542 create the above table, you would only type
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1543
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1544 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1545 |Name|Phone|Age|
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1546 |-
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1547 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1548
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1549 @noindent and then press @key{TAB} to align the table and start filling in
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1550 fields. Even faster would be to type @code{|Name|Phone|Age} followed by
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1551 @kbd{C-c @key{RET}}.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1552
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1553 When typing text into a field, Org treats @key{DEL},
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1554 @key{Backspace}, and all character keys in a special way, so that
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1555 inserting and deleting avoids shifting other fields. Also, when
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1556 typing @emph{immediately after the cursor was moved into a new field
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1557 with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1558 field is automatically made blank. If this behavior is too
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1559 unpredictable for you, configure the variables
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1560 @code{org-enable-table-editor} and @code{org-table-auto-blank-field}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1561
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1562 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1563 @tsubheading{Creation and conversion}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1564 @kindex C-c |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1565 @item C-c |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1566 Convert the active region to table. If every line contains at least one
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1567 TAB character, the function assumes that the material is tab separated.
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1568 If every line contains a comma, comma-separated values (CSV) are assumed.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1569 If not, lines are split at whitespace into fields. You can use a prefix
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1570 argument to force a specific separator: @kbd{C-u} forces CSV, @kbd{C-u
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1571 C-u} forces TAB, and a numeric argument N indicates that at least N
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1572 consecutive spaces, or alternatively a TAB will be the separator.
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
1573 @*
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1574 If there is no active region, this command creates an empty Org
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1575 table. But it's easier just to start typing, like
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1576 @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1577
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1578 @tsubheading{Re-aligning and field motion}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1579 @kindex C-c C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1580 @item C-c C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1581 Re-align the table without moving the cursor.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1582 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1583 @kindex @key{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1584 @item @key{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1585 Re-align the table, move to the next field. Creates a new row if
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1586 necessary.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1587 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1588 @kindex S-@key{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1589 @item S-@key{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1590 Re-align, move to previous field.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1591 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1592 @kindex @key{RET}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1593 @item @key{RET}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1594 Re-align the table and move down to next row. Creates a new row if
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1595 necessary. At the beginning or end of a line, @key{RET} still does
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1596 NEWLINE, so it can be used to split a table.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1597
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1598 @tsubheading{Column and row editing}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1599 @kindex M-@key{left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1600 @kindex M-@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1601 @item M-@key{left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1602 @itemx M-@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1603 Move the current column left/right.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1604 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1605 @kindex M-S-@key{left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1606 @item M-S-@key{left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1607 Kill the current column.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1608 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1609 @kindex M-S-@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1610 @item M-S-@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1611 Insert a new column to the left of the cursor position.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1612 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1613 @kindex M-@key{up}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1614 @kindex M-@key{down}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1615 @item M-@key{up}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1616 @itemx M-@key{down}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1617 Move the current row up/down.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1618 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1619 @kindex M-S-@key{up}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1620 @item M-S-@key{up}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1621 Kill the current row or horizontal line.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1622 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1623 @kindex M-S-@key{down}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1624 @item M-S-@key{down}
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1625 Insert a new row above the current row. With a prefix argument, the line is
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1626 created below the current one.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1627 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1628 @kindex C-c -
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1629 @item C-c -
101509
c915fbc219ff Fix typos.
Glenn Morris <rgm@gnu.org>
parents: 101460
diff changeset
1630 Insert a horizontal line below current row. With a prefix argument, the line
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1631 is created above the current line.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1632 @c
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1633 @kindex C-c @key{RET}
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1634 @item C-c @key{RET}
101509
c915fbc219ff Fix typos.
Glenn Morris <rgm@gnu.org>
parents: 101460
diff changeset
1635 Insert a horizontal line below current row, and move the cursor into the row
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1636 below that line.
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1637 @c
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1638 @kindex C-c ^
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1639 @item C-c ^
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1640 Sort the table lines in the region. The position of point indicates the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1641 column to be used for sorting, and the range of lines is the range
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1642 between the nearest horizontal separator lines, or the entire table. If
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1643 point is before the first column, you will be prompted for the sorting
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1644 column. If there is an active region, the mark specifies the first line
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1645 and the sorting column, while point should be in the last line to be
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1646 included into the sorting. The command prompts for the sorting type
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1647 (alphabetically, numerically, or by time). When called with a prefix
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1648 argument, alphabetic sorting will be case-sensitive.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1649
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1650 @tsubheading{Regions}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1651 @kindex C-c C-x M-w
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1652 @item C-c C-x M-w
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1653 Copy a rectangular region from a table to a special clipboard. Point
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1654 and mark determine edge fields of the rectangle. The process ignores
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1655 horizontal separator lines.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1656 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1657 @kindex C-c C-x C-w
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1658 @item C-c C-x C-w
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1659 Copy a rectangular region from a table to a special clipboard, and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1660 blank all fields in the rectangle. So this is the ``cut'' operation.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1661 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1662 @kindex C-c C-x C-y
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1663 @item C-c C-x C-y
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1664 Paste a rectangular region into a table.
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
1665 The upper left corner ends up in the current field. All involved fields
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1666 will be overwritten. If the rectangle does not fit into the present table,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1667 the table is enlarged as needed. The process ignores horizontal separator
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1668 lines.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1669 @c
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
1670 @kindex M-@key{RET}
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
1671 @itemx M-@kbd{RET}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1672 Wrap several fields in a column like a paragraph. If there is an active
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1673 region, and both point and mark are in the same column, the text in the
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1674 column is wrapped to minimum width for the given number of lines. A numeric
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1675 prefix argument may be used to change the number of desired lines. If there
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1676 is no region, the current field is split at the cursor position and the text
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1677 fragment to the right of the cursor is prepended to the field one line
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1678 down. If there is no region, but you specify a prefix argument, the current
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1679 field is made blank, and the content is appended to the field above.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1680
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1681 @tsubheading{Calculations}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1682 @cindex formula, in tables
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1683 @cindex calculations, in tables
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1684 @cindex region, active
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1685 @cindex active region
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1686 @cindex Transient mark mode
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1687 @kindex C-c +
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1688 @item C-c +
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1689 Sum the numbers in the current column, or in the rectangle defined by
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1690 the active region. The result is shown in the echo area and can
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1691 be inserted with @kbd{C-y}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1692 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1693 @kindex S-@key{RET}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1694 @item S-@key{RET}
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
1695 When current field is empty, copy from first non-empty field above. When not
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
1696 empty, copy current field down to next row and move cursor along with it.
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
1697 Depending on the variable @code{org-table-copy-increment}, integer field
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
1698 values will be incremented during copy. Integers that are too large will not
101147
a62da64665d1 Fix some more typos.
Glenn Morris <rgm@gnu.org>
parents: 101146
diff changeset
1699 be incremented. Also, a @code{0} prefix argument temporarily disables the
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
1700 increment. This key is also used by CUA mode (@pxref{Cooperation}).
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1701
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1702 @tsubheading{Miscellaneous}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1703 @kindex C-c `
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1704 @item C-c `
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1705 Edit the current field in a separate window. This is useful for fields
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1706 that are not fully visible (@pxref{Narrow columns}). When called with a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1707 @kbd{C-u} prefix, just make the full field visible, so that it can be
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1708 edited in place.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1709 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1710 @item M-x org-table-import
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1711 Import a file as a table. The table should be TAB- or whitespace
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1712 separated. Useful, for example, to import a spreadsheet table or data
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1713 from a database, because these programs generally can write
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1714 TAB-separated text files. This command works by inserting the file into
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1715 the buffer and then converting the region to a table. Any prefix
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1716 argument is passed on to the converter, which uses it to determine the
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1717 separator.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1718 @item C-c |
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1719 Tables can also be imported by pasting tabular text into the Org
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1720 buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
96976
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
1721 @kbd{C-c |} command (see above under @i{Creation and conversion}).
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1722 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1723 @item M-x org-table-export
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1724 Export the table, by default as a TAB-separated file. Useful for data
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1725 exchange with, for example, spreadsheet or database programs. The format
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1726 used to export the file can be configured in the variable
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1727 @code{org-table-export-default-format}. You may also use properties
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1728 @code{TABLE_EXPORT_FILE} and @code{TABLE_EXPORT_FORMAT} to specify the file
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
1729 name and the format for table export in a subtree. Org supports quite
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
1730 general formats for exported tables. The exporter format is the same as the
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
1731 format used by Orgtbl radio tables, see @ref{Translator functions} for a
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
1732 detailed description.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1733 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1734
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1735 If you don't like the automatic table editor because it gets in your
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1736 way on lines which you would like to start with @samp{|}, you can turn
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1737 it off with
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1738
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1739 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1740 (setq org-enable-table-editor nil)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1741 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1742
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1743 @noindent Then the only table command that still works is
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1744 @kbd{C-c C-c} to do a manual re-align.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1745
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1746 @node Narrow columns, Column groups, Built-in table editor, Tables
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1747 @section Narrow columns
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1748 @cindex narrow columns in tables
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1749
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1750 The width of columns is automatically determined by the table editor.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1751 Sometimes a single field or a few fields need to carry more text,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1752 leading to inconveniently wide columns. To limit@footnote{This feature
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1753 does not work on XEmacs.} the width of a column, one field anywhere in
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1754 the column may contain just the string @samp{<N>} where @samp{N} is an
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1755 integer specifying the width of the column in characters. The next
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1756 re-align will then set the width of this column to no more than this
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1757 value.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1758
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1759 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1760 @group
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1761 |---+------------------------------| |---+--------|
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1762 | | | | | <6> |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1763 | 1 | one | | 1 | one |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1764 | 2 | two | ----\ | 2 | two |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1765 | 3 | This is a long chunk of text | ----/ | 3 | This=> |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1766 | 4 | four | | 4 | four |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1767 |---+------------------------------| |---+--------|
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1768 @end group
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1769 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1770
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1771 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1772 Fields that are wider become clipped and end in the string @samp{=>}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1773 Note that the full text is still in the buffer, it is only invisible.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1774 To see the full text, hold the mouse over the field - a tool-tip window
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1775 will show the full content. To edit such a field, use the command
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1776 @kbd{C-c `} (that is @kbd{C-c} followed by the backquote). This will
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1777 open a new window with the full field. Edit it and finish with @kbd{C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1778 C-c}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1779
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1780 When visiting a file containing a table with narrowed columns, the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1781 necessary character hiding has not yet happened, and the table needs to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1782 be aligned before it looks nice. Setting the option
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1783 @code{org-startup-align-all-tables} will realign all tables in a file
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1784 upon visiting, but also slow down startup. You can also set this option
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1785 on a per-file basis with:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1786
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1787 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1788 #+STARTUP: align
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1789 #+STARTUP: noalign
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1790 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1791
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1792 @node Column groups, Orgtbl mode, Narrow columns, Tables
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1793 @section Column groups
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1794 @cindex grouping columns in tables
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1795
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1796 When Org exports tables, it does so by default without vertical
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1797 lines because that is visually more satisfying in general. Occasionally
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1798 however, vertical lines can be useful to structure a table into groups
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1799 of columns, much like horizontal lines can do for groups of rows. In
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1800 order to specify column groups, you can use a special row where the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1801 first field contains only @samp{/}. The further fields can either
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1802 contain @samp{<} to indicate that this column should start a group,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1803 @samp{>} to indicate the end of a column, or @samp{<>} to make a column
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1804 a group of its own. Boundaries between column groups will upon export be
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1805 marked with vertical lines. Here is an example:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1806
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1807 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1808 | | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1809 |---+----+-----+-----+-----+---------+------------|
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1810 | / | <> | < | | > | < | > |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1811 | # | 1 | 1 | 1 | 1 | 1 | 1 |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1812 | # | 2 | 4 | 8 | 16 | 1.4142 | 1.1892 |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1813 | # | 3 | 9 | 27 | 81 | 1.7321 | 1.3161 |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1814 |---+----+-----+-----+-----+---------+------------|
96976
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
1815 #+TBLFM: $3=$2^2::$4=$2^3::$5=$2^4::$6=sqrt($2)::$7=sqrt(sqrt(($2)))
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1816 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1817
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1818 It is also sufficient to just insert the column group starters after
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1819 every vertical line you'd like to have:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1820
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1821 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1822 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1823 |----+-----+-----+-----+---------+------------|
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1824 | / | < | | | < | |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1825 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1826
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1827 @node Orgtbl mode, The spreadsheet, Column groups, Tables
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1828 @section The Orgtbl minor mode
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1829 @cindex Orgtbl mode
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1830 @cindex minor mode for tables
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1831
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1832 If you like the intuitive way the Org table editor works, you
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1833 might also want to use it in other modes like Text mode or Mail mode.
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1834 The minor mode Orgtbl mode makes this possible. You can always toggle
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1835 the mode with @kbd{M-x orgtbl-mode}. To turn it on by default, for
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1836 example in mail mode, use
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1837
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1838 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1839 (add-hook 'mail-mode-hook 'turn-on-orgtbl)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1840 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1841
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1842 Furthermore, with some special setup, it is possible to maintain tables
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1843 in arbitrary syntax with Orgtbl mode. For example, it is possible to
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1844 construct La@TeX{} tables with the underlying ease and power of
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1845 Orgtbl mode, including spreadsheet capabilities. For details, see
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1846 @ref{Tables in arbitrary syntax}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1847
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
1848 @node The spreadsheet, Org Plot, Orgtbl mode, Tables
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1849 @section The spreadsheet
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1850 @cindex calculations, in tables
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1851 @cindex spreadsheet capabilities
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1852 @cindex @file{calc} package
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1853
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1854 The table editor makes use of the Emacs @file{calc} package to implement
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1855 spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1856 derive fields from other fields. While fully featured, Org's
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1857 implementation is not identical to other spreadsheets. For example,
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1858 Org knows the concept of a @emph{column formula} that will be
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1859 applied to all non-header fields in a column without having to copy the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1860 formula to each relevant field.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1861
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1862 @menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1863 * References:: How to refer to another field or range
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1864 * Formula syntax for Calc:: Using Calc to compute stuff
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1865 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1866 * Field formulas:: Formulas valid for a single field
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1867 * Column formulas:: Formulas valid for an entire column
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1868 * Editing and debugging formulas:: Fixing formulas
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1869 * Updating the table:: Recomputing all dependent fields
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1870 * Advanced features:: Field names, parameters and automatic recalc
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1871 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1872
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1873 @node References, Formula syntax for Calc, The spreadsheet, The spreadsheet
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1874 @subsection References
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1875 @cindex references
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1876
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1877 To compute fields in the table from other fields, formulas must
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1878 reference other fields or ranges. In Org, fields can be referenced
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1879 by name, by absolute coordinates, and by relative coordinates. To find
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1880 out what the coordinates of a field are, press @kbd{C-c ?} in that
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1881 field, or press @kbd{C-c @}} to toggle the display of a grid.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1882
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1883 @subsubheading Field references
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1884 @cindex field references
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1885 @cindex references, to fields
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1886
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1887 Formulas can reference the value of another field in two ways. Like in
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1888 any other spreadsheet, you may reference fields with a letter/number
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1889 combination like @code{B3}, meaning the 2nd field in the 3rd row.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1890 @c Such references are always fixed to that field, they don't change
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1891 @c when you copy and paste a formula to a different field. So
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1892 @c Org's @code{B3} behaves like @code{$B$3} in other spreadsheets.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1893
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1894 @noindent
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1895 Org also uses another, more general operator that looks like this:
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1896 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1897 @@row$column
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1898 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1899
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1900 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1901 Column references can be absolute like @samp{1}, @samp{2},...@samp{N},
100508
00c300ec74ba 2008-12-18 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100460
diff changeset
1902 or relative to the current column like @samp{+1} or @samp{-2}.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1903
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1904 The row specification only counts data lines and ignores horizontal
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1905 separator lines (hlines). You can use absolute row numbers
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1906 @samp{1}...@samp{N}, and row numbers relative to the current row like
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1907 @samp{+3} or @samp{-1}. Or specify the row relative to one of the
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1908 hlines: @samp{I} refers to the first hline@footnote{Note that only
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1909 hlines are counted that @emph{separate} table lines. If the table
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1910 starts with a hline above the header, it does not count.}, @samp{II} to
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1911 the second etc. @samp{-I} refers to the first such line above the
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1912 current line, @samp{+I} to the first such line below the current line.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1913 You can also write @samp{III+2} which is the second data line after the
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1914 third hline in the table. Relative row numbers like @samp{-3} will not
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1915 cross hlines if the current line is too close to the hline. Instead,
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1916 the value directly at the hline is used.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1917
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1918 @samp{0} refers to the current row and column. Also, if you omit
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1919 either the column or the row part of the reference, the current
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
1920 row/column is implied.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1921
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1922 Org's references with @emph{unsigned} numbers are fixed references
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1923 in the sense that if you use the same reference in the formula for two
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1924 different fields, the same field will be referenced each time.
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1925 Org's references with @emph{signed} numbers are floating
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1926 references because the same reference operator can reference different
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1927 fields depending on the field being calculated by the formula.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1928
100607
87dcbbf4f5fa 2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100508
diff changeset
1929 As a special case references like @samp{$LR5} and @samp{$LR12} can be used to
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1930 refer in a stable way to the 5th and 12th field in the last row of the
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
1931 table.
100607
87dcbbf4f5fa 2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100508
diff changeset
1932
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1933 Here are a few examples:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1934
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1935 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1936 @@2$3 @r{2nd row, 3rd column}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1937 C2 @r{same as previous}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1938 $5 @r{column 5 in the current row}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1939 E& @r{same as previous}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1940 @@2 @r{current column, row 2}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1941 @@-1$-3 @r{the field one row up, three columns to the left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1942 @@-I$2 @r{field just under hline above current row, column 2}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1943 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1944
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1945 @subsubheading Range references
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1946 @cindex range references
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1947 @cindex references, to ranges
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1948
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1949 You may reference a rectangular range of fields by specifying two field
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1950 references connected by two dots @samp{..}. If both fields are in the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1951 current row, you may simply use @samp{$2..$7}, but if at least one field
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1952 is in a different row, you need to use the general @code{@@row$column}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1953 format at least for the first field (i.e the reference must start with
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1954 @samp{@@} in order to be interpreted correctly). Examples:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1955
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1956 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1957 $1..$3 @r{First three fields in the current row.}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1958 $P..$Q @r{Range, using column names (see under Advanced)}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1959 @@2$1..@@4$3 @r{6 fields between these two fields.}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1960 A2..C4 @r{Same as above.}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1961 @@-1$-2..@@-1 @r{3 numbers from the column to the left, 2 up to current row}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1962 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1963
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1964 @noindent Range references return a vector of values that can be fed
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1965 into Calc vector functions. Empty fields in ranges are normally
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1966 suppressed, so that the vector contains only the non-empty fields (but
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1967 see the @samp{E} mode switch below). If there are no non-empty fields,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1968 @samp{[0]} is returned to avoid syntax errors in formulas.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1969
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1970 @subsubheading Named references
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1971 @cindex named references
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1972 @cindex references, named
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1973 @cindex name, of column or field
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1974 @cindex constants, in calculations
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1975
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1976 @samp{$name} is interpreted as the name of a column, parameter or
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1977 constant. Constants are defined globally through the variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1978 @code{org-table-formula-constants}, and locally (for the file) through a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1979 line like
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1980
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1981 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1982 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1983 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1984
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1985 @noindent
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
1986 Also properties (@pxref{Properties and Columns}) can be used as
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1987 constants in table formulas: For a property @samp{:Xyz:} use the name
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1988 @samp{$PROP_Xyz}, and the property will be searched in the current
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1989 outline entry and in the hierarchy above it. If you have the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1990 @file{constants.el} package, it will also be used to resolve constants,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1991 including natural constants like @samp{$h} for Planck's constant, and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1992 units like @samp{$km} for kilometers@footnote{@file{Constant.el} can
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1993 supply the values of constants in two different unit systems, @code{SI}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1994 and @code{cgs}. Which one is used depends on the value of the variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1995 @code{constants-unit-system}. You can use the @code{#+STARTUP} options
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1996 @code{constSI} and @code{constcgs} to set this value for the current
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1997 buffer.}. Column names and parameters can be specified in special table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1998 lines. These are described below, see @ref{Advanced features}. All
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1999 names must start with a letter, and further consist of letters and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2000 numbers.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2001
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
2002 @subsubheading Remote references
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
2003 @cindex remote references
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
2004 @cindex references, remote
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
2005 @cindex references, to a different table
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
2006 @cindex name, of column or field
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
2007 @cindex constants, in calculations
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
2008
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
2009 You may also reference constants, fields and ranges from a different table,
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
2010 either in the current file or even in a different file. The syntax is
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
2011
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
2012 @example
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
2013 remote(NAME-OR-ID,REF)
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
2014 @end example
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
2015
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
2016 @noindent
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
2017 where NAME can be the name of a table in the current file as set by a
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
2018 @code{#+TBLNAME: NAME} line before the table. It can also be the ID of an
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
2019 entry, even in a different file, and the reference then refers to the first
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
2020 table in that entry. REF is an absolute field or range reference as
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
2021 described above, valid in the referenced table.
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
2022
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2023 @node Formula syntax for Calc, Formula syntax for Lisp, References, The spreadsheet
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2024 @subsection Formula syntax for Calc
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2025 @cindex formula syntax, Calc
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2026 @cindex syntax, of formulas
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2027
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2028 A formula can be any algebraic expression understood by the Emacs
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2029 @file{Calc} package. @b{Note that @file{calc} has the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2030 non-standard convention that @samp{/} has lower precedence than
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2031 @samp{*}, so that @samp{a/b*c} is interpreted as @samp{a/(b*c)}.} Before
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2032 evaluation by @code{calc-eval} (@pxref{Calling Calc from
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2033 Your Programs,calc-eval,Calling Calc from Your Lisp Programs,Calc,GNU
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2034 Emacs Calc Manual}),
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2035 @c FIXME: The link to the Calc manual in HTML does not work.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2036 variable substitution takes place according to the rules described above.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2037 @cindex vectors, in table calculations
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2038 The range vectors can be directly fed into the Calc vector functions
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2039 like @samp{vmean} and @samp{vsum}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2040
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2041 @cindex format specifier
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2042 @cindex mode, for @file{calc}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2043 A formula can contain an optional mode string after a semicolon. This
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2044 string consists of flags to influence Calc and other modes during
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2045 execution. By default, Org uses the standard Calc modes (precision
96976
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
2046 12, angular units degrees, fraction and symbolic modes off). The display
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2047 format, however, has been changed to @code{(float 5)} to keep tables
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2048 compact. The default settings can be configured using the variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2049 @code{org-calc-default-modes}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2050
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2051 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2052 p20 @r{switch the internal precision to 20 digits}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2053 n3 s3 e2 f4 @r{normal, scientific, engineering, or fixed display format}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2054 D R @r{angle modes: degrees, radians}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2055 F S @r{fraction and symbolic modes}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2056 N @r{interpret all fields as numbers, use 0 for non-numbers}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2057 T @r{force text interpretation}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2058 E @r{keep empty fields in ranges}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2059 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2060
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2061 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2062 In addition, you may provide a @code{printf} format specifier to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2063 reformat the final result. A few examples:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2064
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2065 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2066 $1+$2 @r{Sum of first and second field}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2067 $1+$2;%.2f @r{Same, format result to two decimals}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2068 exp($2)+exp($1) @r{Math functions can be used}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2069 $0;%.1f @r{Reformat current cell to 1 decimal}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2070 ($3-32)*5/9 @r{Degrees F -> C conversion}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2071 $c/$1/$cm @r{Hz -> cm conversion, using @file{constants.el}}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2072 tan($1);Dp3s1 @r{Compute in degrees, precision 3, display SCI 1}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2073 sin($1);Dp3%.1e @r{Same, but use printf specifier for display}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2074 vmean($2..$7) @r{Compute column range mean, using vector function}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2075 vmean($2..$7);EN @r{Same, but treat empty fields as 0}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2076 taylor($3,x=7,2) @r{taylor series of $3, at x=7, second degree}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2077 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2078
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2079 Calc also contains a complete set of logical operations. For example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2080
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2081 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2082 if($1<20,teen,string("")) @r{``teen'' if age $1 less than 20, else empty}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2083 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2084
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2085 @node Formula syntax for Lisp, Field formulas, Formula syntax for Calc, The spreadsheet
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2086 @subsection Emacs Lisp forms as formulas
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2087 @cindex Lisp forms, as table formulas
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2088
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2089 It is also possible to write a formula in Emacs Lisp; this can be useful
101147
a62da64665d1 Fix some more typos.
Glenn Morris <rgm@gnu.org>
parents: 101146
diff changeset
2090 for string manipulation and control structures, if Calc's
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2091 functionality is not enough. If a formula starts with a single quote
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2092 followed by an opening parenthesis, then it is evaluated as a lisp form.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2093 The evaluation should return either a string or a number. Just as with
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2094 @file{calc} formulas, you can specify modes and a printf format after a
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2095 semicolon. With Emacs Lisp forms, you need to be conscious about the way
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2096 field references are interpolated into the form. By default, a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2097 reference will be interpolated as a Lisp string (in double quotes)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2098 containing the field. If you provide the @samp{N} mode switch, all
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2099 referenced elements will be numbers (non-number fields will be zero) and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2100 interpolated as Lisp numbers, without quotes. If you provide the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2101 @samp{L} flag, all fields will be interpolated literally, without quotes.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2102 I.e., if you want a reference to be interpreted as a string by the Lisp
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2103 form, enclose the reference operator itself in double quotes, like
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2104 @code{"$3"}. Ranges are inserted as space-separated fields, so you can
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2105 embed them in list or vector syntax. A few examples, note how the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2106 @samp{N} mode is used when we do computations in lisp.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2107
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2108 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2109 @r{Swap the first two characters of the content of column 1}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2110 '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
101509
c915fbc219ff Fix typos.
Glenn Morris <rgm@gnu.org>
parents: 101460
diff changeset
2111 @r{Add columns 1 and 2, equivalent to Calc's @code{$1+$2}}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2112 '(+ $1 $2);N
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2113 @r{Compute the sum of columns 1-4, like Calc's @code{vsum($1..$4)}}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2114 '(apply '+ '($1..$4));N
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2115 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2116
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2117 @node Field formulas, Column formulas, Formula syntax for Lisp, The spreadsheet
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2118 @subsection Field formulas
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2119 @cindex field formula
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2120 @cindex formula, for individual table field
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2121
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2122 To assign a formula to a particular field, type it directly into the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2123 field, preceded by @samp{:=}, for example @samp{:=$1+$2}. When you
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2124 press @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2125 the field, the formula will be stored as the formula for this field,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2126 evaluated, and the current field replaced with the result.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2127
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2128 Formulas are stored in a special line starting with @samp{#+TBLFM:}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2129 directly below the table. If you typed the equation in the 4th field of
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2130 the 3rd data line in the table, the formula will look like
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2131 @samp{@@3$4=$1+$2}. When inserting/deleting/swapping column and rows
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2132 with the appropriate commands, @i{absolute references} (but not relative
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2133 ones) in stored formulas are modified in order to still reference the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2134 same field. Of cause this is not true if you edit the table structure
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2135 with normal editing commands - then you must fix the equations yourself.
100607
87dcbbf4f5fa 2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100508
diff changeset
2136 The left hand side of a formula may also be a named field (@pxref{Advanced
87dcbbf4f5fa 2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100508
diff changeset
2137 features}), or a last-row reference like @samp{$LR3}.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2138
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2139 Instead of typing an equation into the field, you may also use the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2140 following command
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2141
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2142 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2143 @kindex C-u C-c =
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2144 @item C-u C-c =
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2145 Install a new formula for the current field. The command prompts for a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2146 formula, with default taken from the @samp{#+TBLFM:} line, applies
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2147 it to the current field and stores it.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2148 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2149
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2150 @node Column formulas, Editing and debugging formulas, Field formulas, The spreadsheet
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2151 @subsection Column formulas
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2152 @cindex column formula
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2153 @cindex formula, for table column
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2154
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2155 Often in a table, the same formula should be used for all fields in a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2156 particular column. Instead of having to copy the formula to all fields
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2157 in that column, Org allows to assign a single formula to an entire
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2158 column. If the table contains horizontal separator hlines, everything
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2159 before the first such line is considered part of the table @emph{header}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2160 and will not be modified by column formulas.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2161
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2162 To assign a formula to a column, type it directly into any field in the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2163 column, preceded by an equal sign, like @samp{=$1+$2}. When you press
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2164 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2165 field, the formula will be stored as the formula for the current column,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2166 evaluated and the current field replaced with the result. If the field
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2167 contains only @samp{=}, the previously stored formula for this column is
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2168 used. For each column, Org will only remember the most recently
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2169 used formula. In the @samp{TBLFM:} line, column formulas will look like
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2170 @samp{$4=$1+$2}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2171
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2172 Instead of typing an equation into the field, you may also use the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2173 following command:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2174
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2175 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2176 @kindex C-c =
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2177 @item C-c =
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2178 Install a new formula for the current column and replace current field with
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2179 the result of the formula. The command prompts for a formula, with default
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2180 taken from the @samp{#+TBLFM} line, applies it to the current field and
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2181 stores it. With a numeric prefix argument(e.g. @kbd{C-5 C-c =}) the command
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2182 will apply it to that many consecutive fields in the current column.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2183 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2184
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2185 @node Editing and debugging formulas, Updating the table, Column formulas, The spreadsheet
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2186 @subsection Editing and debugging formulas
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2187 @cindex formula editing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2188 @cindex editing, of table formulas
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2189
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2190 You can edit individual formulas in the minibuffer or directly in the
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2191 field. Org can also prepare a special buffer with all active
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2192 formulas of a table. When offering a formula for editing, Org
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2193 converts references to the standard format (like @code{B3} or @code{D&})
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2194 if possible. If you prefer to only work with the internal format (like
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2195 @code{@@3$2} or @code{$4}), configure the variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2196 @code{org-table-use-standard-references}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2197
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2198 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2199 @kindex C-c =
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2200 @kindex C-u C-c =
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2201 @item C-c =
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2202 @itemx C-u C-c =
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2203 Edit the formula associated with the current column/field in the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2204 minibuffer. See @ref{Column formulas} and @ref{Field formulas}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2205 @kindex C-u C-u C-c =
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2206 @item C-u C-u C-c =
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2207 Re-insert the active formula (either a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2208 field formula, or a column formula) into the current field, so that you
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2209 can edit it directly in the field. The advantage over editing in the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2210 minibuffer is that you can use the command @kbd{C-c ?}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2211 @kindex C-c ?
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2212 @item C-c ?
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2213 While editing a formula in a table field, highlight the field(s)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2214 referenced by the reference at the cursor position in the formula.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2215 @kindex C-c @}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2216 @item C-c @}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2217 Toggle the display of row and column numbers for a table, using
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2218 overlays. These are updated each time the table is aligned, you can
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2219 force it with @kbd{C-c C-c}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2220 @kindex C-c @{
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2221 @item C-c @{
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2222 Toggle the formula debugger on and off. See below.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2223 @kindex C-c '
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2224 @item C-c '
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2225 Edit all formulas for the current table in a special buffer, where the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2226 formulas will be displayed one per line. If the current field has an
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2227 active formula, the cursor in the formula editor will mark it.
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2228 While inside the special buffer, Org will automatically highlight
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2229 any field or range reference at the cursor position. You may edit,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2230 remove and add formulas, and use the following commands:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2231 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2232 @kindex C-c C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2233 @kindex C-x C-s
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2234 @item C-c C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2235 @itemx C-x C-s
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2236 Exit the formula editor and store the modified formulas. With @kbd{C-u}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2237 prefix, also apply the new formulas to the entire table.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2238 @kindex C-c C-q
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2239 @item C-c C-q
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2240 Exit the formula editor without installing changes.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2241 @kindex C-c C-r
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2242 @item C-c C-r
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2243 Toggle all references in the formula editor between standard (like
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2244 @code{B3}) and internal (like @code{@@3$2}).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2245 @kindex @key{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2246 @item @key{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2247 Pretty-print or indent lisp formula at point. When in a line containing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2248 a lisp formula, format the formula according to Emacs Lisp rules.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2249 Another @key{TAB} collapses the formula back again. In the open
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2250 formula, @key{TAB} re-indents just like in Emacs lisp mode.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2251 @kindex M-@key{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2252 @item M-@key{TAB}
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2253 Complete Lisp symbols, just like in Emacs lisp mode.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2254 @kindex S-@key{up}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2255 @kindex S-@key{down}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2256 @kindex S-@key{left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2257 @kindex S-@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2258 @item S-@key{up}/@key{down}/@key{left}/@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2259 Shift the reference at point. For example, if the reference is
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2260 @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2261 This also works for relative references, and for hline references.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2262 @kindex M-S-@key{up}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2263 @kindex M-S-@key{down}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2264 @item M-S-@key{up}/@key{down}
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2265 Move the test line for column formulas in the Org buffer up and
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2266 down.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2267 @kindex M-@key{up}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2268 @kindex M-@key{down}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2269 @item M-@key{up}/@key{down}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2270 Scroll the window displaying the table.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2271 @kindex C-c @}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2272 @item C-c @}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2273 Turn the coordinate grid in the table on and off.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2274 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2275 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2276
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2277 Making a table field blank does not remove the formula associated with
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2278 the field, because that is stored in a different line (the @samp{TBLFM}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2279 line) - during the next recalculation the field will be filled again.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2280 To remove a formula from a field, you have to give an empty reply when
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2281 prompted for the formula, or to edit the @samp{#+TBLFM} line.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2282
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2283 @kindex C-c C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2284 You may edit the @samp{#+TBLFM} directly and re-apply the changed
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2285 equations with @kbd{C-c C-c} in that line, or with the normal
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2286 recalculation commands in the table.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2287
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2288 @subsubheading Debugging formulas
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2289 @cindex formula debugging
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2290 @cindex debugging, of table formulas
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2291 When the evaluation of a formula leads to an error, the field content
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2292 becomes the string @samp{#ERROR}. If you would like see what is going
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2293 on during variable substitution and calculation in order to find a bug,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2294 turn on formula debugging in the @code{Tbl} menu and repeat the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2295 calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2296 field. Detailed information will be displayed.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2297
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2298 @node Updating the table, Advanced features, Editing and debugging formulas, The spreadsheet
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2299 @subsection Updating the table
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2300 @cindex recomputing table fields
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2301 @cindex updating, table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2302
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2303 Recalculation of a table is normally not automatic, but needs to be
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2304 triggered by a command. See @ref{Advanced features} for a way to make
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2305 recalculation at least semi-automatically.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2306
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2307 In order to recalculate a line of a table or the entire table, use the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2308 following commands:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2309
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2310 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2311 @kindex C-c *
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2312 @item C-c *
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2313 Recalculate the current row by first applying the stored column formulas
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2314 from left to right, and all field formulas in the current row.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2315 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2316 @kindex C-u C-c *
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2317 @item C-u C-c *
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2318 @kindex C-u C-c C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2319 @itemx C-u C-c C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2320 Recompute the entire table, line by line. Any lines before the first
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2321 hline are left alone, assuming that these are part of the table header.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2322 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2323 @kindex C-u C-u C-c *
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2324 @kindex C-u C-u C-c C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2325 @item C-u C-u C-c *
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2326 @itemx C-u C-u C-c C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2327 Iterate the table by recomputing it until no further changes occur.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2328 This may be necessary if some computed fields use the value of other
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2329 fields that are computed @i{later} in the calculation sequence.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2330 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2331
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2332 @node Advanced features, , Updating the table, The spreadsheet
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2333 @subsection Advanced features
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2334
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2335 If you want the recalculation of fields to happen automatically, or if
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2336 you want to be able to assign @i{names} to fields and columns, you need
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2337 to reserve the first column of the table for special marking characters.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2338 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2339 @kindex C-#
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2340 @item C-#
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2341 Rotate the calculation mark in first column through the states @samp{},
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2342 @samp{#}, @samp{*}, @samp{!}, @samp{$}. When there is an active region,
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2343 change all marks in the region.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2344 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2345
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2346 Here is an example of a table that collects exam results of students and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2347 makes use of these features:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2348
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2349 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2350 @group
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2351 |---+---------+--------+--------+--------+-------+------|
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2352 | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2353 |---+---------+--------+--------+--------+-------+------|
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2354 | ! | | P1 | P2 | P3 | Tot | |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2355 | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2356 | ^ | | m1 | m2 | m3 | mt | |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2357 |---+---------+--------+--------+--------+-------+------|
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2358 | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2359 | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2360 |---+---------+--------+--------+--------+-------+------|
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2361 | | Average | | | | 29.7 | |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2362 | ^ | | | | | at | |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2363 | $ | max=50 | | | | | |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2364 |---+---------+--------+--------+--------+-------+------|
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2365 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2366 @end group
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2367 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2368
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2369 @noindent @b{Important}: Please note that for these special tables,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2370 recalculating the table with @kbd{C-u C-c *} will only affect rows that
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2371 are marked @samp{#} or @samp{*}, and fields that have a formula assigned
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2372 to the field itself. The column formulas are not applied in rows with
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2373 empty first field.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2374
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2375 @cindex marking characters, tables
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2376 The marking characters have the following meaning:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2377 @table @samp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2378 @item !
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2379 The fields in this line define names for the columns, so that you may
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2380 refer to a column as @samp{$Tot} instead of @samp{$6}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2381 @item ^
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2382 This row defines names for the fields @emph{above} the row. With such
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2383 a definition, any formula in the table may use @samp{$m1} to refer to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2384 the value @samp{10}. Also, if you assign a formula to a names field, it
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2385 will be stored as @samp{$name=...}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2386 @item _
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2387 Similar to @samp{^}, but defines names for the fields in the row
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2388 @emph{below}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2389 @item $
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2390 Fields in this row can define @emph{parameters} for formulas. For
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2391 example, if a field in a @samp{$} row contains @samp{max=50}, then
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2392 formulas in this table can refer to the value 50 using @samp{$max}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2393 Parameters work exactly like constants, only that they can be defined on
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2394 a per-table basis.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2395 @item #
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2396 Fields in this row are automatically recalculated when pressing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2397 @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row. Also, this row
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2398 is selected for a global recalculation with @kbd{C-u C-c *}. Unmarked
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2399 lines will be left alone by this command.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2400 @item *
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2401 Selects this line for global recalculation with @kbd{C-u C-c *}, but
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2402 not for automatic recalculation. Use this when automatic
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2403 recalculation slows down editing too much.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2404 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2405 Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2406 All lines that should be recalculated should be marked with @samp{#}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2407 or @samp{*}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2408 @item /
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2409 Do not export this line. Useful for lines that contain the narrowing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2410 @samp{<N>} markers.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2411 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2412
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2413 Finally, just to whet your appetite on what can be done with the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2414 fantastic @file{calc} package, here is a table that computes the Taylor
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
2415 series of degree @code{n} at location @code{x} for a couple of
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
2416 functions.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2417
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2418 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2419 @group
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2420 |---+-------------+---+-----+--------------------------------------|
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2421 | | Func | n | x | Result |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2422 |---+-------------+---+-----+--------------------------------------|
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2423 | # | exp(x) | 1 | x | 1 + x |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2424 | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2425 | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2426 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2427 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2428 | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2429 |---+-------------+---+-----+--------------------------------------|
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2430 #+TBLFM: $5=taylor($2,$4,$3);n3
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2431 @end group
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2432 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2433
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2434 @page
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2435 @node Org Plot, , The spreadsheet, Tables
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2436 @section Org Plot
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2437 @cindex graph, in tables
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2438 @cindex plot tables using gnuplot
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2439
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2440 Org Plot can produce 2D and 3D graphs of information stored in org tables
99139
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
2441 using @file{Gnuplot} @uref{http://www.gnuplot.info/} and @file{gnuplot-mode}
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
2442 @uref{http://cars9.uchicago.edu/~ravel/software/gnuplot-mode.html}. To see
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
2443 this in action ensure that you have both Gnuplot and Gnuplot-mode installed
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
2444 on your system, then call @code{org-plot/gnuplot} on the following table.
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2445
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2446 @example
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2447 @group
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2448 #+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]"
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2449 | Sede | Max cites | H-index |
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2450 |-----------+-----------+---------|
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2451 | Chile | 257.72 | 21.39 |
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2452 | Leeds | 165.77 | 19.68 |
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2453 | Sao Paolo | 71.00 | 11.50 |
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2454 | Stockholm | 134.19 | 14.33 |
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2455 | Morelia | 257.56 | 17.67 |
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2456 @end group
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2457 @end example
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2458
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2459 Notice that Org Plot is smart enough to apply the tables headers as labels.
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2460 Further control over the labels, type, content, and appearance of plots can
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2461 be exercised through the @code{#+Plot:} lines preceding a table. See below
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2462 for a complete list of Org plot options. For more information and examples
99139
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
2463 see the org-plot tutorial at
102000
c61bbad9f3b7 2009-02-13 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101802
diff changeset
2464 @uref{http://orgmode.org/worg/org-tutorials/org-plot.php}.
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2465
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2466 @subsubheading Plot Options
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2467
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2468 @table @code
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2469 @item set
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2470 Specify any @file{gnuplot} option to be set when graphing.
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2471
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2472 @item title
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2473 Specify the title of the plot.
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2474
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2475 @item ind
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2476 Specify which column of the table to use as the @code{x} axis.
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2477
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2478 @item deps
99139
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
2479 Specify the columns to graph as a lisp style list, surrounded by parenthesis
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
2480 and separated by spaces for example @code{dep:(3 4)} to graph the third and
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
2481 fourth columns (defaults to graphing all other columns aside from the ind
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
2482 column).
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2483
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2484 @item type
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2485 Specify whether the plot will be @code{2d}, @code{3d}, or @code{grid}.
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2486
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2487 @item with
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2488 Specify a @code{with} option to be inserted for every col being plotted
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2489 (e.g. @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...).
103365
6a5d3ff46ec7 * org.texi (Org Plot): Fix tags (Bug#3507).
Chong Yidong <cyd@stupidchicken.com>
parents: 102151
diff changeset
2490 Defaults to @code{lines}.
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2491
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2492 @item file
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2493 If you want to plot to a file specify the @code{"path/to/desired/output-file"}.
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2494
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2495 @item labels
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2496 List of labels to be used for the deps (defaults to column headers if they
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2497 exist).
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2498
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2499 @item line
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2500 Specify an entire line to be inserted in the gnuplot script.
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2501
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2502 @item map
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2503 When plotting @code{3d} or @code{grid} types, set this to @code{t} to graph a
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2504 flat mapping rather than a @code{3d} slope.
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2505
99503
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
2506 @item timefmt
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
2507 Specify format of org-mode timestamps as they will be parsed by gnuplot.
103365
6a5d3ff46ec7 * org.texi (Org Plot): Fix tags (Bug#3507).
Chong Yidong <cyd@stupidchicken.com>
parents: 102151
diff changeset
2508 Defaults to @samp{%Y-%m-%d-%H:%M:%S}.
99503
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
2509
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2510 @item script
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2511 If you want total control you can specify a script file (place the file name
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2512 between double quotes) which will be used to plot. Before plotting, every
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2513 instance of @code{$datafile} in the specified script will be replaced with
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2514 the path to the generated data file. Note even if you set this option you
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2515 may still want to specify the plot type, as that can impact the content of
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2516 the data file.
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2517 @end table
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2518
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2519 @node Hyperlinks, TODO Items, Tables, Top
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2520 @chapter Hyperlinks
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2521 @cindex hyperlinks
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2522
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2523 Like HTML, Org provides links inside a file, external links to
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2524 other files, Usenet articles, emails, and much more.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2525
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2526 @menu
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2527 * Link format:: How links in Org are formatted
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2528 * Internal links:: Links to other places in the current file
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2529 * External links:: URL-like links to the world
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2530 * Handling links:: Creating, inserting and following
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2531 * Using links outside Org:: Linking from my C source code?
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2532 * Link abbreviations:: Shortcuts for writing complex links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2533 * Search options:: Linking to a specific location
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2534 * Custom searches:: When the default search is not enough
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2535 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2536
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2537 @node Link format, Internal links, Hyperlinks, Hyperlinks
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2538 @section Link format
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2539 @cindex link format
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2540 @cindex format, of links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2541
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2542 Org will recognize plain URL-like links and activate them as
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2543 clickable links. The general link format, however, looks like this:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2544
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2545 @example
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
2546 [[link][description]] @r{or alternatively} [[link]]
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2547 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2548
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2549 Once a link in the buffer is complete (all brackets present), Org
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2550 will change the display so that @samp{description} is displayed instead
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2551 of @samp{[[link][description]]} and @samp{link} is displayed instead of
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2552 @samp{[[link]]}. Links will be highlighted in the face @code{org-link},
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2553 which by default is an underlined face. You can directly edit the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2554 visible part of a link. Note that this can be either the @samp{link}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2555 part (if there is no description) or the @samp{description} part. To
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2556 edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2557 cursor on the link.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2558
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2559 If you place the cursor at the beginning or just behind the end of the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2560 displayed text and press @key{BACKSPACE}, you will remove the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2561 (invisible) bracket at that location. This makes the link incomplete
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2562 and the internals are again displayed as plain text. Inserting the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2563 missing bracket hides the link internals again. To show the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2564 internal structure of all links, use the menu entry
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2565 @code{Org->Hyperlinks->Literal links}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2566
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2567 @node Internal links, External links, Link format, Hyperlinks
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2568 @section Internal links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2569 @cindex internal links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2570 @cindex links, internal
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2571 @cindex targets, for links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2572
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2573 If the link does not look like a URL, it is considered to be internal in
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2574 the current file. Links such as @samp{[[My Target]]} or @samp{[[My
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2575 Target][Find my target]]} lead to a text search in the current file.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2576 The link can be followed with @kbd{C-c C-o} when the cursor is on the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2577 link, or with a mouse click (@pxref{Handling links}). The preferred
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2578 match for such a link is a dedicated target: the same string in double
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2579 angular brackets. Targets may be located anywhere; sometimes it is
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2580 convenient to put them into a comment line. For example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2581
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2582 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2583 # <<My Target>>
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2584 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2585
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2586 @noindent In HTML export (@pxref{HTML export}), such targets will become
99851
68981b04c1ac 2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99709
diff changeset
2587 named anchors for direct access through @samp{http} links@footnote{Note that
68981b04c1ac 2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99709
diff changeset
2588 text before the first headline is usually not exported, so the first such
68981b04c1ac 2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99709
diff changeset
2589 target should be after the first headline, or in the line directly before the
68981b04c1ac 2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99709
diff changeset
2590 first headline.}.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2591
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2592 If no dedicated target exists, Org will search for the words in the
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2593 link. In the above example the search would be for @samp{my target}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2594 Links starting with a star like @samp{*My Target} restrict the search to
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2595 headlines. When searching, Org mode will first try an exact match, but
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2596 then move on to more and more lenient searches. For example, the link
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2597 @samp{[[*My Targets]]} will find any of the following:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2598
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2599 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2600 ** My targets
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2601 ** TODO my targets are bright
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2602 ** my 20 targets are
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2603 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2604
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2605 To insert a link targeting a headline, in-buffer completion can be used.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2606 Just type a star followed by a few optional letters into the buffer and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2607 press @kbd{M-@key{TAB}}. All headlines in the current buffer will be
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2608 offered as completions. @xref{Handling links}, for more commands
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2609 creating links.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2610
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2611 Following a link pushes a mark onto Org's own mark ring. You can
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2612 return to the previous position with @kbd{C-c &}. Using this command
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2613 several times in direct succession goes back to positions recorded
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2614 earlier.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2615
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2616 @menu
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2617 * Radio targets:: Make targets trigger links in plain text
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2618 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2619
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2620 @node Radio targets, , Internal links, Internal links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2621 @subsection Radio targets
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2622 @cindex radio targets
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2623 @cindex targets, radio
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2624 @cindex links, radio targets
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2625
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2626 Org can automatically turn any occurrences of certain target names
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2627 in normal text into a link. So without explicitly creating a link, the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2628 text connects to the target radioing its position. Radio targets are
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2629 enclosed by triple angular brackets. For example, a target @samp{<<<My
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2630 Target>>>} causes each occurrence of @samp{my target} in normal text to
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2631 become activated as a link. The Org file is scanned automatically
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2632 for radio targets only when the file is first loaded into Emacs. To
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2633 update the target list during editing, press @kbd{C-c C-c} with the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2634 cursor on or at a target.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2635
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2636 @node External links, Handling links, Internal links, Hyperlinks
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2637 @section External links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2638 @cindex links, external
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2639 @cindex external links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2640 @cindex links, external
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2641 @cindex Gnus links
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2642 @cindex BBDB links
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
2643 @cindex IRC links
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2644 @cindex URL links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2645 @cindex file links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2646 @cindex VM links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2647 @cindex RMAIL links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2648 @cindex WANDERLUST links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2649 @cindex MH-E links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2650 @cindex USENET links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2651 @cindex SHELL links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2652 @cindex Info links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2653 @cindex elisp links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2654
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2655 Org supports links to files, websites, Usenet and email messages,
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
2656 BBDB database entries and links to both IRC conversations and their
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
2657 logs. External links are URL-like locators. They start with a short
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
2658 identifying string followed by a colon. There can be no space after
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
2659 the colon. The following list shows examples for each link type.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2660
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2661 @example
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2662 http://www.astro.uva.nl/~dominik @r{on the web}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2663 file:/home/dominik/images/jupiter.jpg @r{file, absolute path}
96976
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
2664 /home/dominik/images/jupiter.jpg @r{same as above}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2665 file:papers/last.pdf @r{file, relative path}
96976
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
2666 ./papers/last.pdf @r{same as above}
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
2667 file:projects.org @r{another org file}
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
2668 file:projects.org::some words @r{text search in org file}
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
2669 file:projects.org::*task title @r{heading search in org file}
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
2670 id:B7423F4D-2E8A-471B-8810-C40F074717E9 @r{Link to heading by ID}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2671 news:comp.emacs @r{Usenet link}
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
2672 mailto:adent@@galaxy.net @r{Mail link}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2673 vm:folder @r{VM folder link}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2674 vm:folder#id @r{VM message link}
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
2675 vm://myself@@some.where.org/folder#id @r{VM on remote machine}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2676 wl:folder @r{WANDERLUST folder link}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2677 wl:folder#id @r{WANDERLUST message link}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2678 mhe:folder @r{MH-E folder link}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2679 mhe:folder#id @r{MH-E message link}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2680 rmail:folder @r{RMAIL folder link}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2681 rmail:folder#id @r{RMAIL message link}
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2682 gnus:group @r{Gnus group link}
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2683 gnus:group#id @r{Gnus article link}
99851
68981b04c1ac 2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99709
diff changeset
2684 bbdb:R.*Stallman @r{BBDB link (with regexp)}
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
2685 irc:/irc.com/#emacs/bob @r{IRC link}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2686 shell:ls *.org @r{A shell command}
99851
68981b04c1ac 2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99709
diff changeset
2687 elisp:org-agenda @r{Interactive elisp command}
68981b04c1ac 2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99709
diff changeset
2688 elisp:(find-file-other-frame "Elisp.org") @r{Elisp form to evaluate}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2689 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2690
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2691 A link should be enclosed in double brackets and may contain a
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2692 descriptive text to be displayed instead of the URL (@pxref{Link
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2693 format}), for example:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2694
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2695 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2696 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2697 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2698
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2699 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2700 If the description is a file name or URL that points to an image, HTML
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2701 export (@pxref{HTML export}) will inline the image as a clickable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2702 button. If there is no description at all and the link points to an
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2703 image,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2704 that image will be inlined into the exported HTML file.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2705
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2706 @cindex angular brackets, around links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2707 @cindex plain text external links
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2708 Org also finds external links in the normal text and activates them
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2709 as links. If spaces must be part of the link (for example in
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2710 @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2711 about the end of the link, enclose them in angular brackets.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2712
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2713 @node Handling links, Using links outside Org, External links, Hyperlinks
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2714 @section Handling links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2715 @cindex links, handling
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2716
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2717 Org provides methods to create a link in the correct syntax, to
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2718 insert it into an Org file, and to follow the link.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2719
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2720 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2721 @kindex C-c l
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2722 @cindex storing links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2723 @item C-c l
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
2724 Store a link to the current location. This is a @emph{global} command (you
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
2725 must create the key binding yourself) which can be used in any buffer to
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
2726 create a link. The link will be stored for later insertion into an Org
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
2727 buffer (see below).
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
2728
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
2729 For Org files, if there is a @samp{<<target>>} at the cursor, the link points
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
2730 to the target. Otherwise it points to the current headline, either by text
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
2731 (unsafe), or, if @file{org-id.el} is loaded and @code{org-link-to-org-use-id}
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
2732 is set, by ID property.
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
2733
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
2734 For VM, Rmail, Wanderlust, MH-E, Gnus and BBDB buffers, the link will
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
2735 indicate the current article/entry. For W3 and W3M buffers, the link goes to
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
2736 the current URL. For IRC links, if you set the variable
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
2737 @code{org-irc-link-to-logs} to non-nil then @kbd{C-c l} will store a
100450
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
2738 @samp{file:/} style link to the relevant point in the logs for the current
101509
c915fbc219ff Fix typos.
Glenn Morris <rgm@gnu.org>
parents: 101460
diff changeset
2739 conversation. Otherwise an @samp{irc:/} style link to the user/channel/server
102151
328f4b370b74 Remove duplicate words.
Juanma Barranquero <lekktu@gmail.com>
parents: 102059
diff changeset
2740 under the point will be stored.
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
2741
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
2742 For any other files, the link will point to the file, with a search string
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
2743 (@pxref{Search options}) pointing to the contents of the current line. If
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
2744 there is an active region, the selected words will form the basis of the
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
2745 search string. If the automatically created link is not working correctly or
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
2746 accurately enough, you can write custom functions to select the search string
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
2747 and to do the search for particular file types - see @ref{Custom searches}.
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
2748 The key binding @kbd{C-c l} is only a suggestion - see @ref{Installation}.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2749 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2750 @kindex C-c C-l
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2751 @cindex link completion
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2752 @cindex completion, of links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2753 @cindex inserting links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2754 @item C-c C-l
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2755 Insert a link. This prompts for a link to be inserted into the buffer. You
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2756 can just type a link, using text for an internal link, or one of the link
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2757 type prefixes mentioned in the examples above. All links stored during the
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2758 current session are part of the history for this prompt, so you can access
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2759 them with @key{up} and @key{down} (or @kbd{M-p/n}). Completion, on the other
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2760 hand, will help you to insert valid link prefixes like @samp{http:} or
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2761 @samp{ftp:}, including the prefixes defined through link abbreviations
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2762 (@pxref{Link abbreviations}). The link will be inserted into the
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2763 buffer@footnote{After insertion of a stored link, the link will be removed
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2764 from the list of stored links. To keep it in the list later use, use a
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2765 triple @kbd{C-u} prefix argument to @kbd{C-c C-l}, or configure the option
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2766 @code{org-keep-stored-link-after-insertion}.}, along with a descriptive text.
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2767 If some text was selected when this command is called, the selected text
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2768 becomes the default description.@* Note that you don't have to use this
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2769 command to insert a link. Links in Org are plain text, and you can type
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2770 or paste them straight into the buffer. By using this command, the links are
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2771 automatically enclosed in double brackets, and you will be asked for the
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2772 optional descriptive text.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2773 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2774 @c If the link is a @samp{file:} link and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2775 @c the linked file is located in the same directory as the current file or
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2776 @c a subdirectory of it, the path of the file will be inserted relative to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2777 @c the current directory.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2778 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2779 @kindex C-u C-c C-l
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2780 @cindex file name completion
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2781 @cindex completion, of file names
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2782 @item C-u C-c C-l
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2783 When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2784 a file will be inserted and you may use file name completion to select
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2785 the name of the file. The path to the file is inserted relative to the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2786 directory of the current org file, if the linked file is in the current
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2787 directory or in a sub-directory of it, or if the path is written relative
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2788 to the current directory using @samp{../}. Otherwise an absolute path
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2789 is used, if possible with @samp{~/} for your home directory. You can
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2790 force an absolute path with two @kbd{C-u} prefixes.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2791 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2792 @item C-c C-l @r{(with cursor on existing link)}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2793 When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2794 link and description parts of the link.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2795 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2796 @cindex following links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2797 @kindex C-c C-o
101758
64835454876e 2009-02-02 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101747
diff changeset
2798 @kindex RET
101802
800be5321d24 2009-02-04 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101758
diff changeset
2799 @item C-c C-o
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2800 Open link at point. This will launch a web browser for URLs (using
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2801 @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2802 the corresponding links, and execute the command in a shell link. When the
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2803 cursor is on an internal link, this commands runs the corresponding search.
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2804 When the cursor is on a TAG list in a headline, it creates the corresponding
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2805 TAGS view. If the cursor is on a time stamp, it compiles the agenda for that
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2806 date. Furthermore, it will visit text and remote files in @samp{file:} links
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2807 with Emacs and select a suitable application for local non-text files.
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2808 Classification of files is based on file extension only. See option
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
2809 @code{org-file-apps}. If you want to override the default application and
99503
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
2810 visit the file with Emacs, use a @kbd{C-u} prefix. If you want to avoid
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
2811 opening in Emacs, use a @kbd{C-u C-u} prefix.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2812 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2813 @kindex mouse-2
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2814 @kindex mouse-1
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2815 @item mouse-2
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2816 @itemx mouse-1
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2817 On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2818 would. Under Emacs 22, also @kbd{mouse-1} will follow a link.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2819 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2820 @kindex mouse-3
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2821 @item mouse-3
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2822 Like @kbd{mouse-2}, but force file links to be opened with Emacs, and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2823 internal links to be displayed in another window@footnote{See the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2824 variable @code{org-display-internal-link-with-indirect-buffer}}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2825 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2826 @cindex mark ring
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2827 @kindex C-c %
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2828 @item C-c %
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2829 Push the current position onto the mark ring, to be able to return
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2830 easily. Commands following an internal link do this automatically.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2831 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2832 @cindex links, returning to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2833 @kindex C-c &
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2834 @item C-c &
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2835 Jump back to a recorded position. A position is recorded by the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2836 commands following internal links, and by @kbd{C-c %}. Using this
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2837 command several times in direct succession moves through a ring of
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2838 previously recorded positions.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2839 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2840 @kindex C-c C-x C-n
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2841 @kindex C-c C-x C-p
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2842 @cindex links, finding next/previous
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2843 @item C-c C-x C-n
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2844 @itemx C-c C-x C-p
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2845 Move forward/backward to the next link in the buffer. At the limit of
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2846 the buffer, the search fails once, and then wraps around. The key
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2847 bindings for this are really too long, you might want to bind this also
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2848 to @kbd{C-n} and @kbd{C-p}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2849 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2850 (add-hook 'org-load-hook
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2851 (lambda ()
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2852 (define-key 'org-mode-map "\C-n" 'org-next-link)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2853 (define-key 'org-mode-map "\C-p" 'org-previous-link)))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2854 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2855 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2856
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2857 @node Using links outside Org, Link abbreviations, Handling links, Hyperlinks
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2858 @section Using links outside Org
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2859
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2860 You can insert and follow links that have Org syntax not only in
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2861 Org, but in any Emacs buffer. For this, you should create two
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2862 global commands, like this (please select suitable global keys
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2863 yourself):
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2864
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2865 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2866 (global-set-key "\C-c L" 'org-insert-link-global)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2867 (global-set-key "\C-c o" 'org-open-at-point-global)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2868 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2869
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2870 @node Link abbreviations, Search options, Using links outside Org, Hyperlinks
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2871 @section Link abbreviations
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2872 @cindex link abbreviations
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2873 @cindex abbreviation, links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2874
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2875 Long URLs can be cumbersome to type, and often many similar links are
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2876 needed in a document. For this you can use link abbreviations. An
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2877 abbreviated link looks like this
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2878
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2879 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2880 [[linkword:tag][description]]
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2881 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2882
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2883 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2884 where the tag is optional. Such abbreviations are resolved according to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2885 the information in the variable @code{org-link-abbrev-alist} that
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2886 relates the linkwords to replacement text. Here is an example:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2887
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2888 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2889 @group
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2890 (setq org-link-abbrev-alist
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2891 '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2892 ("google" . "http://www.google.com/search?q=")
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2893 ("ads" . "http://adsabs.harvard.edu/cgi-bin/
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2894 nph-abs_connect?author=%s&db_key=AST")))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2895 @end group
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2896 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2897
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2898 If the replacement text contains the string @samp{%s}, it will be
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2899 replaced with the tag. Otherwise the tag will be appended to the string
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2900 in order to create the link. You may also specify a function that will
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2901 be called with the tag as the only argument to create the link.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2902
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2903 With the above setting, you could link to a specific bug with
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2904 @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2905 @code{[[google:OrgMode]]} and find out what the Org author is
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2906 doing besides Emacs hacking with @code{[[ads:Dominik,C]]}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2907
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2908 If you need special abbreviations just for a single Org buffer, you
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2909 can define them in the file with
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2910
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2911 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2912 #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id=
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2913 #+LINK: google http://www.google.com/search?q=%s
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2914 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2915
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2916 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2917 In-buffer completion @pxref{Completion} can be used after @samp{[} to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2918 complete link abbreviations.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2919
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2920 @node Search options, Custom searches, Link abbreviations, Hyperlinks
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2921 @section Search options in file links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2922 @cindex search option in file links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2923 @cindex file links, searching
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2924
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2925 File links can contain additional information to make Emacs jump to a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2926 particular location in the file when following a link. This can be a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2927 line number or a search option after a double@footnote{For backward
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2928 compatibility, line numbers can also follow a single colon.} colon. For
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2929 example, when the command @kbd{C-c l} creates a link (@pxref{Handling
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2930 links}) to a file, it encodes the words in the current line as a search
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2931 string that can be used to find this line back later when following the
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
2932 link with @kbd{C-c C-o}.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2933
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2934 Here is the syntax of the different ways to attach a search to a file
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2935 link, together with an explanation:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2936
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2937 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2938 [[file:~/code/main.c::255]]
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2939 [[file:~/xx.org::My Target]]
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2940 [[file:~/xx.org::*My Target]]
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2941 [[file:~/xx.org::/regexp/]]
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2942 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2943
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2944 @table @code
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2945 @item 255
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2946 Jump to line 255.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2947 @item My Target
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2948 Search for a link target @samp{<<My Target>>}, or do a text search for
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2949 @samp{my target}, similar to the search in internal links, see
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2950 @ref{Internal links}. In HTML export (@pxref{HTML export}), such a file
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2951 link will become an HTML reference to the corresponding named anchor in
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2952 the linked file.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2953 @item *My Target
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2954 In an Org file, restrict search to headlines.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2955 @item /regexp/
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2956 Do a regular expression search for @code{regexp}. This uses the Emacs
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2957 command @code{occur} to list all matches in a separate window. If the
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2958 target file is in Org mode, @code{org-occur} is used to create a
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2959 sparse tree with the matches.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2960 @c If the target file is a directory,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2961 @c @code{grep} will be used to search all files in the directory.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2962 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2963
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2964 As a degenerate case, a file link with an empty file name can be used
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2965 to search the current file. For example, @code{[[file:::find me]]} does
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2966 a search for @samp{find me} in the current file, just as
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2967 @samp{[[find me]]} would.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2968
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2969 @node Custom searches, , Search options, Hyperlinks
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2970 @section Custom Searches
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2971 @cindex custom search strings
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2972 @cindex search strings, custom
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2973
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2974 The default mechanism for creating search strings and for doing the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2975 actual search related to a file link may not work correctly in all
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2976 cases. For example, BibTeX database files have many entries like
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2977 @samp{year="1993"} which would not result in good search strings,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2978 because the only unique identification for a BibTeX entry is the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2979 citation key.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2980
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2981 If you come across such a problem, you can write custom functions to set
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2982 the right search string for a particular file type, and to do the search
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2983 for the string in the file. Using @code{add-hook}, these functions need
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2984 to be added to the hook variables
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2985 @code{org-create-file-search-functions} and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2986 @code{org-execute-file-search-functions}. See the docstring for these
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2987 variables for more information. Org actually uses this mechanism
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2988 for Bib@TeX{} database files, and you can use the corresponding code as
96976
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
2989 an implementation example. See the file @file{org-bibtex.el}.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2990
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2991 @node TODO Items, Tags, Hyperlinks, Top
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
2992 @chapter TODO Items
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2993 @cindex TODO items
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2994
96976
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
2995 Org mode does not maintain TODO lists as separate documents@footnote{Of
101147
a62da64665d1 Fix some more typos.
Glenn Morris <rgm@gnu.org>
parents: 101146
diff changeset
2996 course, you can make a document that contains only long lists of TODO items,
96976
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
2997 but this is not required.}. Instead, TODO items are an integral part of the
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
2998 notes file, because TODO items usually come up while taking notes! With Org
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
2999 mode, simply mark any entry in a tree as being a TODO item. In this way,
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
3000 information is not duplicated, and the entire context from which the TODO
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
3001 item emerged is always present.
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3002
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3003 Of course, this technique for managing TODO items scatters them
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3004 throughout your notes file. Org mode compensates for this by providing
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3005 methods to give you an overview of all the things that you have to do.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3006
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3007 @menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3008 * TODO basics:: Marking and displaying TODO entries
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3009 * TODO extensions:: Workflow and assignments
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3010 * Progress logging:: Dates and notes for progress
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3011 * Priorities:: Some things are more important than others
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3012 * Breaking down tasks:: Splitting a task into manageable pieces
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3013 * Checkboxes:: Tick-off lists
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3014 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3015
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3016 @node TODO basics, TODO extensions, TODO Items, TODO Items
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3017 @section Basic TODO functionality
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3018
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3019 Any headline becomes a TODO item when it starts with the word
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3020 @samp{TODO}, for example:
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3021
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3022 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3023 *** TODO Write letter to Sam Fortune
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3024 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3025
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3026 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3027 The most important commands to work with TODO entries are:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3028
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3029 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3030 @kindex C-c C-t
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3031 @cindex cycling, of TODO states
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3032 @item C-c C-t
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3033 Rotate the TODO state of the current item among
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3034
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3035 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3036 ,-> (unmarked) -> TODO -> DONE --.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3037 '--------------------------------'
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3038 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3039
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3040 The same rotation can also be done ``remotely'' from the timeline and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3041 agenda buffers with the @kbd{t} command key (@pxref{Agenda commands}).
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3042
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3043 @kindex C-u C-c C-t
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3044 @item C-u C-c C-t
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3045 Select a specific keyword using completion or (if it has been set up)
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3046 the fast selection interface. For the latter, you need to assign keys
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3047 to TODO states, see @ref{Per-file keywords} and @ref{Setting tags} for
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3048 more information.
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3049
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3050 @kindex S-@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3051 @kindex S-@key{left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3052 @item S-@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3053 @itemx S-@key{left}
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3054 Select the following/preceding TODO state, similar to cycling. Useful
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3055 mostly if more than two TODO states are possible (@pxref{TODO
101570
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
3056 extensions}). See also @ref{Conflicts} for a discussion of the interaction
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
3057 with @code{shift-selection-mode}.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3058 @kindex C-c C-v
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3059 @kindex C-c / t
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3060 @cindex sparse tree, for TODO
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3061 @item C-c C-v
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3062 @itemx C-c / t
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3063 View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3064 the entire buffer, but shows all TODO items and the headings hierarchy
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3065 above them. With a prefix argument, search for a specific TODO. You will be
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3066 prompted for the keyword, and you can also give a list of keywords like
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3067 @code{KWD1|KWD2|...}. With numeric prefix argument N, show the tree for the
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3068 Nth keyword in the variable @code{org-todo-keywords}. With two prefix
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3069 arguments, find all TODO and DONE entries.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3070 @kindex C-c a t
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3071 @item C-c a t
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3072 Show the global TODO list. Collects the TODO items from all agenda
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3073 files (@pxref{Agenda Views}) into a single buffer. The new buffer will
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3074 be in @code{agenda-mode}, which provides commands to examine and
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3075 manipulate the TODO entries from the new buffer (@pxref{Agenda
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3076 commands}). @xref{Global TODO list}, for more information.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3077 @kindex S-M-@key{RET}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3078 @item S-M-@key{RET}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3079 Insert a new TODO entry below the current one.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3080 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3081
99139
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
3082 @noindent
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
3083 Changing a TODO state can also trigger tag changes. See the docstring of the
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
3084 option @code{org-todo-state-tags-triggers} for details.
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
3085
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3086 @node TODO extensions, Progress logging, TODO basics, TODO Items
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3087 @section Extended use of TODO keywords
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3088 @cindex extended TODO keywords
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3089
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3090 By default, marked TODO entries have one of only two states: TODO and
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3091 DONE. Org mode allows you to classify TODO items in more complex ways
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3092 with @emph{TODO keywords} (stored in @code{org-todo-keywords}). With
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3093 special setup, the TODO keyword system can work differently in different
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3094 files.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3095
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3096 Note that @i{tags} are another way to classify headlines in general and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3097 TODO items in particular (@pxref{Tags}).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3098
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3099 @menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3100 * Workflow states:: From TODO to DONE in steps
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3101 * TODO types:: I do this, Fred does the rest
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3102 * Multiple sets in one file:: Mixing it all, and still finding your way
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3103 * Fast access to TODO states:: Single letter selection of a state
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3104 * Per-file keywords:: Different files, different requirements
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3105 * Faces for TODO keywords:: Highlighting states
101747
374ac7d3b3ac Fix typos.
Glenn Morris <rgm@gnu.org>
parents: 101703
diff changeset
3106 * TODO dependencies:: When one task needs to wait for others
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3107 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3108
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3109 @node Workflow states, TODO types, TODO extensions, TODO extensions
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3110 @subsection TODO keywords as workflow states
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3111 @cindex TODO workflow
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3112 @cindex workflow states as TODO keywords
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3113
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3114 You can use TODO keywords to indicate different @emph{sequential} states
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3115 in the process of working on an item, for example@footnote{Changing
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3116 this variable only becomes effective after restarting Org mode in a
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3117 buffer.}:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3118
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3119 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3120 (setq org-todo-keywords
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3121 '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3122 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3123
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3124 The vertical bar separates the TODO keywords (states that @emph{need
96976
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
3125 action}) from the DONE states (which need @emph{no further action}). If
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3126 you don't provide the separator bar, the last state is used as the DONE
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3127 state.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3128 @cindex completion, of TODO keywords
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3129 With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3130 to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED. You may
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3131 also use a numeric prefix argument to quickly select a specific state. For
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3132 example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY.
103366
66652dbd881c * org.texi (Workflow states, Agenda commands): Fix tags (Bug#3508).
Chong Yidong <cyd@stupidchicken.com>
parents: 103365
diff changeset
3133 Or you can use @kbd{S-@key{left}} to go backward through the sequence. If you
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3134 define many keywords, you can use in-buffer completion
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3135 (@pxref{Completion}) or even a special one-key selection scheme
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3136 (@pxref{Fast access to TODO states}) to insert these words into the
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3137 buffer. Changing a TODO state can be logged with a timestamp, see
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3138 @ref{Tracking TODO state changes} for more information.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3139
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3140 @node TODO types, Multiple sets in one file, Workflow states, TODO extensions
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3141 @subsection TODO keywords as types
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3142 @cindex TODO types
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3143 @cindex names as TODO keywords
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3144 @cindex types as TODO keywords
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3145
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3146 The second possibility is to use TODO keywords to indicate different
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3147 @emph{types} of action items. For example, you might want to indicate
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3148 that items are for ``work'' or ``home''. Or, when you work with several
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3149 people on a single project, you might want to assign action items
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3150 directly to persons, by using their names as TODO keywords. This would
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3151 be set up like this:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3152
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3153 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3154 (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3155 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3156
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3157 In this case, different keywords do not indicate a sequence, but rather
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3158 different types. So the normal work flow would be to assign a task to a
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3159 person, and later to mark it DONE. Org mode supports this style by adapting
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3160 the workings of the command @kbd{C-c C-t}@footnote{This is also true for the
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3161 @kbd{t} command in the timeline and agenda buffers.}. When used several
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3162 times in succession, it will still cycle through all names, in order to first
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3163 select the right type for a task. But when you return to the item after some
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3164 time and execute @kbd{C-c C-t} again, it will switch from any name directly
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3165 to DONE. Use prefix arguments or completion to quickly select a specific
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3166 name. You can also review the items of a specific TODO type in a sparse tree
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3167 by using a numeric prefix to @kbd{C-c C-v}. For example, to see all things
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3168 Lucy has to do, you would use @kbd{C-3 C-c C-v}. To collect Lucy's items
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3169 from all agenda files into a single buffer, you would use the numeric prefix
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3170 argument as well when creating the global TODO list: @kbd{C-3 C-c t}.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3171
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3172 @node Multiple sets in one file, Fast access to TODO states, TODO types, TODO extensions
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3173 @subsection Multiple keyword sets in one file
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3174 @cindex TODO keyword sets
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3175
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3176 Sometimes you may want to use different sets of TODO keywords in
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3177 parallel. For example, you may want to have the basic
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3178 @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3179 separate state indicating that an item has been canceled (so it is not
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3180 DONE, but also does not require action). Your setup would then look
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3181 like this:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3182
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3183 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3184 (setq org-todo-keywords
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3185 '((sequence "TODO" "|" "DONE")
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3186 (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3187 (sequence "|" "CANCELED")))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3188 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3189
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3190 The keywords should all be different, this helps Org mode to keep track
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3191 of which subsequence should be used for a given entry. In this setup,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3192 @kbd{C-c C-t} only operates within a subsequence, so it switches from
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3193 @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3194 (nothing) to @code{REPORT}. Therefore you need a mechanism to initially
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3195 select the correct sequence. Besides the obvious ways like typing a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3196 keyword or using completion, you may also apply the following commands:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3197
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3198 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3199 @kindex C-S-@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3200 @kindex C-S-@key{left}
101570
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
3201 @kindex C-u C-u C-c C-t
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
3202 @item C-u C-u C-c C-t
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
3203 @itemx C-S-@key{right}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3204 @itemx C-S-@key{left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3205 These keys jump from one TODO subset to the next. In the above example,
101570
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
3206 @kbd{C-u C-u C-c C-t} or @kbd{C-S-@key{right}} would jump from @code{TODO} or
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
3207 @code{DONE} to @code{REPORT}, and any of the words in the second row to
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
3208 @code{CANCELED}. Note that the @kbd{C-S-} key binding conflict with
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
3209 @code{shift-selection-mode} (@pxref{Conflicts}).
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3210 @kindex S-@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3211 @kindex S-@key{left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3212 @item S-@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3213 @itemx S-@key{left}
101570
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
3214 @kbd{S-@key{<left>}} and @kbd{S-@key{<right>}} and walk through @emph{all}
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
3215 keywords from all sets, so for example @kbd{S-@key{<right>}} would switch
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
3216 from @code{DONE} to @code{REPORT} in the example above. See also
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
3217 @ref{Conflicts} for a discussion of the interaction with
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
3218 @code{shift-selection-mode}.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3219 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3220
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3221 @node Fast access to TODO states, Per-file keywords, Multiple sets in one file, TODO extensions
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3222 @subsection Fast access to TODO states
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3223
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3224 If you would like to quickly change an entry to an arbitrary TODO state
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3225 instead of cycling through the states, you can set up keys for
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3226 single-letter access to the states. This is done by adding the section
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3227 key after each keyword, in parenthesis. For example:
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3228
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3229 @lisp
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3230 (setq org-todo-keywords
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3231 '((sequence "TODO(t)" "|" "DONE(d)")
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3232 (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3233 (sequence "|" "CANCELED(c)")))
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3234 @end lisp
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3235
101758
64835454876e 2009-02-02 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101747
diff changeset
3236 If you then press @code{C-c C-t} followed by the selection key, the entry
64835454876e 2009-02-02 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101747
diff changeset
3237 will be switched to this state. @key{SPC} can be used to remove any TODO
64835454876e 2009-02-02 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101747
diff changeset
3238 keyword from an entry.@footnote{Check also the variable
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3239 @code{org-fast-tag-selection-include-todo}, it allows to change the TODO
101758
64835454876e 2009-02-02 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101747
diff changeset
3240 state through the tags interface (@pxref{Setting tags}), in case you like to
64835454876e 2009-02-02 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101747
diff changeset
3241 mingle the two concepts. Note that this means you need to come up with
64835454876e 2009-02-02 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101747
diff changeset
3242 unique keys across both sets of keywords.}
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3243
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3244 @node Per-file keywords, Faces for TODO keywords, Fast access to TODO states, TODO extensions
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3245 @subsection Setting up keywords for individual files
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3246 @cindex keyword options
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3247 @cindex per-file keywords
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3248
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3249 It can be very useful to use different aspects of the TODO mechanism in
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3250 different files. For file-local settings, you need to add special lines
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3251 to the file which set the keywords and interpretation for that file
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3252 only. For example, to set one of the two examples discussed above, you
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3253 need one of the following lines, starting in column zero anywhere in the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3254 file:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3255
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3256 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3257 #+SEQ_TODO: TODO FEEDBACK VERIFY | DONE CANCELED
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3258 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3259 or
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3260 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3261 #+TYP_TODO: Fred Sara Lucy Mike | DONE
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3262 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3263
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3264 A setup for using several sets in parallel would be:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3265
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3266 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3267 #+SEQ_TODO: TODO | DONE
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3268 #+SEQ_TODO: REPORT BUG KNOWNCAUSE | FIXED
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3269 #+SEQ_TODO: | CANCELED
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3270 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3271
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3272 @cindex completion, of option keywords
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3273 @kindex M-@key{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3274 @noindent To make sure you are using the correct keyword, type
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3275 @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3276
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3277 @cindex DONE, final TODO keyword
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3278 Remember that the keywords after the vertical bar (or the last keyword
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3279 if no bar is there) must always mean that the item is DONE (although you
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3280 may use a different word). After changing one of these lines, use
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3281 @kbd{C-c C-c} with the cursor still in the line to make the changes
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3282 known to Org mode@footnote{Org mode parses these lines only when
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3283 Org mode is activated after visiting a file. @kbd{C-c C-c} with the
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3284 cursor in a line starting with @samp{#+} is simply restarting Org mode
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3285 for the current buffer.}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3286
101609
6be1e380a009 2009-01-28 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101574
diff changeset
3287 @node Faces for TODO keywords, TODO dependencies, Per-file keywords, TODO extensions
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3288 @subsection Faces for TODO keywords
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3289 @cindex faces, for TODO keywords
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3290
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3291 Org mode highlights TODO keywords with special faces: @code{org-todo}
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3292 for keywords indicating that an item still has to be acted upon, and
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3293 @code{org-done} for keywords indicating that an item is finished. If
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3294 you are using more than 2 different states, you might want to use
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3295 special faces for some of them. This can be done using the variable
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3296 @code{org-todo-keyword-faces}. For example:
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3297
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3298 @lisp
100271
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
3299 @group
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3300 (setq org-todo-keyword-faces
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3301 '(("TODO" . org-warning)
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3302 ("DEFERRED" . shadow)
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3303 ("CANCELED" . (:foreground "blue" :weight bold))))
100271
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
3304 @end group
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3305 @end lisp
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3306
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3307 While using a list with face properties as shown for CANCELED
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3308 @emph{should} work, this does not aways seem to be the case. If
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3309 necessary, define a special face and use that.
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3310
101609
6be1e380a009 2009-01-28 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101574
diff changeset
3311 @node TODO dependencies, , Faces for TODO keywords, TODO extensions
6be1e380a009 2009-01-28 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101574
diff changeset
3312 @subsection TODO dependencies
101703
1e9411498c8f 2009-01-31 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 101671
diff changeset
3313 @cindex TODO dependencies
1e9411498c8f 2009-01-31 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 101671
diff changeset
3314 @cindex dependencies, of TODO states
101609
6be1e380a009 2009-01-28 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101574
diff changeset
3315
6be1e380a009 2009-01-28 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101574
diff changeset
3316 The structure of Org files (hierarchy and lists) makes it easy to define TODO
6be1e380a009 2009-01-28 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101574
diff changeset
3317 dependencies. Usually, a parent TODO task should not be marked DONE until
6be1e380a009 2009-01-28 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101574
diff changeset
3318 all subtasks (defined as children tasks) are marked as DONE. And sometimes
6be1e380a009 2009-01-28 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101574
diff changeset
3319 there is a logical sequence to a number of (sub)tasks, so that one task
6be1e380a009 2009-01-28 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101574
diff changeset
3320 cannot be acted upon before all siblings above it are done. If you customize
6be1e380a009 2009-01-28 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101574
diff changeset
3321 the variable @code{org-enforce-todo-dependencies}, Org will block entries
101703
1e9411498c8f 2009-01-31 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 101671
diff changeset
3322 from changing state to DONE while they have children that are not DONE.
1e9411498c8f 2009-01-31 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 101671
diff changeset
3323 Furthermore, if an entry has a property @code{ORDERED}, each of its children
1e9411498c8f 2009-01-31 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 101671
diff changeset
3324 will be blocked until all earlier siblings are marked DONE. Here is an
1e9411498c8f 2009-01-31 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 101671
diff changeset
3325 example:
101609
6be1e380a009 2009-01-28 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101574
diff changeset
3326
6be1e380a009 2009-01-28 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101574
diff changeset
3327 @example
6be1e380a009 2009-01-28 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101574
diff changeset
3328 * TODO Blocked until (two) is done
6be1e380a009 2009-01-28 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101574
diff changeset
3329 ** DONE one
6be1e380a009 2009-01-28 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101574
diff changeset
3330 ** TODO two
6be1e380a009 2009-01-28 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101574
diff changeset
3331
6be1e380a009 2009-01-28 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101574
diff changeset
3332 * Parent
6be1e380a009 2009-01-28 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101574
diff changeset
3333 :PROPERTIES:
6be1e380a009 2009-01-28 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101574
diff changeset
3334 :ORDERED: t
6be1e380a009 2009-01-28 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101574
diff changeset
3335 :END:
6be1e380a009 2009-01-28 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101574
diff changeset
3336 ** TODO a
6be1e380a009 2009-01-28 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101574
diff changeset
3337 ** TODO b, needs to wait for (a)
6be1e380a009 2009-01-28 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101574
diff changeset
3338 ** TODO c, needs to wait for (a) and (b)
6be1e380a009 2009-01-28 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101574
diff changeset
3339 @end example
6be1e380a009 2009-01-28 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101574
diff changeset
3340
101671
4c26fea2986c 2009-01-30 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101609
diff changeset
3341 @table @kbd
4c26fea2986c 2009-01-30 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101609
diff changeset
3342 @kindex C-c C-x o
4c26fea2986c 2009-01-30 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101609
diff changeset
3343 @item C-c C-x o
4c26fea2986c 2009-01-30 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101609
diff changeset
3344 Toggle the @code{ORDERED} property of the current entry.
101703
1e9411498c8f 2009-01-31 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 101671
diff changeset
3345 @kindex C-u C-u C-u C-c C-t
1e9411498c8f 2009-01-31 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 101671
diff changeset
3346 @item C-u C-u C-u C-c C-t
1e9411498c8f 2009-01-31 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 101671
diff changeset
3347 Change TODO state, circumventin any state blocking.
101671
4c26fea2986c 2009-01-30 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101609
diff changeset
3348 @end table
4c26fea2986c 2009-01-30 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101609
diff changeset
3349
101609
6be1e380a009 2009-01-28 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101574
diff changeset
3350 If you set the variable @code{org-agenda-dim-blocked-tasks}, TODO entries
6be1e380a009 2009-01-28 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101574
diff changeset
3351 that cannot be closed because of such dependencies will be shown in a dimmed
6be1e380a009 2009-01-28 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101574
diff changeset
3352 font or even made invisible in agenda views (@pxref{Agenda Views}).
6be1e380a009 2009-01-28 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101574
diff changeset
3353
101703
1e9411498c8f 2009-01-31 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 101671
diff changeset
3354 @cindex checkboxes and TODO dependencies
1e9411498c8f 2009-01-31 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 101671
diff changeset
3355 You can also block changes of TODO states by looking at checkboxes
1e9411498c8f 2009-01-31 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 101671
diff changeset
3356 (@pxref{Checkboxes}). If you set the variable
1e9411498c8f 2009-01-31 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 101671
diff changeset
3357 @code{org-enforce-todo-checkbox-dependencies}, an entry that has unchecked
1e9411498c8f 2009-01-31 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 101671
diff changeset
3358 checkboxes will be blocked from switching to DONE.
1e9411498c8f 2009-01-31 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 101671
diff changeset
3359
101609
6be1e380a009 2009-01-28 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101574
diff changeset
3360 If you need more complex dependency structures, for example dependencies
6be1e380a009 2009-01-28 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101574
diff changeset
3361 between entries in different trees or files, check out the contributed
6be1e380a009 2009-01-28 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101574
diff changeset
3362 module @file{org-depend.el}.
6be1e380a009 2009-01-28 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101574
diff changeset
3363
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3364 @page
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3365 @node Progress logging, Priorities, TODO extensions, TODO Items
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3366 @section Progress logging
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3367 @cindex progress logging
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3368 @cindex logging, of progress
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3369
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3370 Org mode can automatically record a time stamp and possibly a note when
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3371 you mark a TODO item as DONE, or even each time you change the state of
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3372 a TODO item. This system is highly configurable, settings can be on a
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3373 per-keyword basis and can be localized to a file or even a subtree. For
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3374 information on how to clock working time for a task, see @ref{Clocking
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3375 work time}.
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3376
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3377 @menu
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3378 * Closing items:: When was this entry marked DONE?
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3379 * Tracking TODO state changes:: When did the status change?
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3380 @end menu
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3381
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3382 @node Closing items, Tracking TODO state changes, Progress logging, Progress logging
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3383 @subsection Closing items
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3384
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3385 The most basic logging is to keep track of @emph{when} a certain TODO
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3386 item was finished. This is achieved with@footnote{The corresponding
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3387 in-buffer setting is: @code{#+STARTUP: logdone}}.
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3388
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3389 @lisp
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3390 (setq org-log-done 'time)
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3391 @end lisp
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3392
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3393 @noindent
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3394 Then each time you turn an entry from a TODO (not-done) state into any
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3395 of the DONE states, a line @samp{CLOSED: [timestamp]} will be inserted
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3396 just after the headline. If you turn the entry back into a TODO item
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3397 through further state cycling, that line will be removed again. If you
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3398 want to record a note along with the timestamp, use@footnote{The
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3399 corresponding in-buffer setting is: @code{#+STARTUP: lognotedone}}
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3400
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3401 @lisp
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3402 (setq org-log-done 'note)
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3403 @end lisp
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3404
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3405 @noindent
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3406 You will then be prompted for a note, and that note will be stored below
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3407 the entry with a @samp{Closing Note} heading.
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3408
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3409 In the timeline (@pxref{Timeline}) and in the agenda
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3410 (@pxref{Weekly/daily agenda}), you can then use the @kbd{l} key to
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3411 display the TODO items with a @samp{CLOSED} timestamp on each day,
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3412 giving you an overview of what has been done.
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3413
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3414 @node Tracking TODO state changes, , Closing items, Progress logging
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3415 @subsection Tracking TODO state changes
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3416
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3417 When TODO keywords are used as workflow states (@pxref{Workflow
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3418 states}), you might want to keep track of when a state change occurred
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3419 and maybe take a note about this change. Since it is normally too much
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3420 to record a note for every state, Org mode expects configuration on a
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3421 per-keyword basis for this. This is achieved by adding special markers
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3422 @samp{!} (for a time stamp) and @samp{@@} (for a note) in parenthesis
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3423 after each keyword. For example, with the setting
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3424
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3425 @lisp
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3426 (setq org-todo-keywords
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3427 '((sequence "TODO(t)" "WAIT(w@@/!)" "|" "DONE(d!)" "CANCELED(c@@)")))
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3428 @end lisp
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3429
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3430 @noindent
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3431 you not only define global TODO keywords and fast access keys, but also
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3432 request that a time is recorded when the entry is turned into
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3433 DONE@footnote{It is possible that Org mode will record two time stamps
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3434 when you are using both @code{org-log-done} and state change logging.
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3435 However, it will never prompt for two notes - if you have configured
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3436 both, the state change recording note will take precedence and cancel
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3437 the @samp{Closing Note}.}, and that a note is recorded when switching to
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3438 WAIT or CANCELED. The setting for WAIT is even more special: The
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3439 @samp{!} after the slash means that in addition to the note taken when
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3440 entering the state, a time stamp should be recorded when @i{leaving} the
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3441 WAIT state, if and only if the @i{target} state does not configure
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3442 logging for entering it. So it has no effect when switching from WAIT
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3443 to DONE, because DONE is configured to record a timestamp only. But
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3444 when switching from WAIT back to TODO, the @samp{/!} in the WAIT
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3445 setting now triggers a timestamp even though TODO has no logging
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3446 configured.
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3447
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3448 You can use the exact same syntax for setting logging preferences local
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3449 to a buffer:
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3450 @example
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3451 #+SEQ_TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@)
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3452 @end example
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3453
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3454 In order to define logging settings that are local to a subtree or a
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3455 single item, define a LOGGING property in this entry. Any non-empty
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3456 LOGGING property resets all logging settings to nil. You may then turn
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3457 on logging for this specific tree using STARTUP keywords like
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3458 @code{lognotedone} or @code{logrepeat}, as well as adding state specific
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3459 settings like @code{TODO(!)}. For example
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3460
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3461 @example
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3462 * TODO Log each state with only a time
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3463 :PROPERTIES:
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3464 :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!)
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3465 :END:
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3466 * TODO Only log when switching to WAIT, and when repeating
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3467 :PROPERTIES:
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3468 :LOGGING: WAIT(@@) logrepeat
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3469 :END:
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3470 * TODO No logging at all
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3471 :PROPERTIES:
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3472 :LOGGING: nil
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3473 :END:
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3474 @end example
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3475
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3476 @node Priorities, Breaking down tasks, Progress logging, TODO Items
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3477 @section Priorities
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3478 @cindex priorities
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3479
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3480 If you use Org mode extensively, you may end up enough TODO items that
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3481 it starts to make sense to prioritize them. Prioritizing can be done by
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3482 placing a @emph{priority cookie} into the headline of a TODO item, like
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3483 this
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3484
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3485 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3486 *** TODO [#A] Write letter to Sam Fortune
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3487 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3488
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3489 @noindent
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3490 By default, Org mode supports three priorities: @samp{A}, @samp{B}, and
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3491 @samp{C}. @samp{A} is the highest priority. An entry without a cookie
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3492 is treated as priority @samp{B}. Priorities make a difference only in
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3493 the agenda (@pxref{Weekly/daily agenda}); outside the agenda, they have
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3494 no inherent meaning to Org mode.
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3495
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3496 Priorities can be attached to any outline tree entries; they do not need
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3497 to be TODO items.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3498
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3499 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3500 @kindex @kbd{C-c ,}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3501 @item @kbd{C-c ,}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3502 Set the priority of the current headline. The command prompts for a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3503 priority character @samp{A}, @samp{B} or @samp{C}. When you press
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3504 @key{SPC} instead, the priority cookie is removed from the headline.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3505 The priorities can also be changed ``remotely'' from the timeline and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3506 agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3507 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3508 @kindex S-@key{up}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3509 @kindex S-@key{down}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3510 @item S-@key{up}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3511 @itemx S-@key{down}
101570
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
3512 Increase/decrease priority of current headline@footnote{See also the option
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
3513 @code{org-priority-start-cycle-with-default'}.}. Note that these keys are
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
3514 also used to modify time stamps (@pxref{Creating timestamps}). See also
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
3515 @ref{Conflicts} for a discussion of the interaction with
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
3516 @code{shift-selection-mode}.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3517 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3518
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3519 You can change the range of allowed priorities by setting the variables
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3520 @code{org-highest-priority}, @code{org-lowest-priority}, and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3521 @code{org-default-priority}. For an individual buffer, you may set
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3522 these values (highest, lowest, default) like this (please make sure that
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3523 the highest priority is earlier in the alphabet than the lowest
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3524 priority):
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3525
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3526 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3527 #+PRIORITIES: A C B
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3528 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3529
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3530 @node Breaking down tasks, Checkboxes, Priorities, TODO Items
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3531 @section Breaking tasks down into subtasks
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3532 @cindex tasks, breaking down
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3533
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3534 It is often advisable to break down large tasks into smaller, manageable
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
3535 subtasks. You can do this by creating an outline tree below a TODO item,
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
3536 with detailed subtasks on the tree@footnote{To keep subtasks out of the
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
3537 global TODO list, see the @code{org-agenda-todo-list-sublevels}.}. To keep
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
3538 the overview over the fraction of subtasks that are already completed, insert
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
3539 either @samp{[/]} or @samp{[%]} anywhere in the headline. These cookies will
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
3540 be updates each time the todo status of a child changes. For example:
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
3541
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
3542 @example
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
3543 * Organize Party [33%]
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
3544 ** TODO Call people [1/2]
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
3545 *** TODO Peter
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
3546 *** DONE Sarah
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
3547 ** TODO Buy food
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
3548 ** DONE Talk to neighbor
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
3549 @end example
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
3550
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
3551 If you would like a TODO entry to automatically change to DONE when all
101147
a62da64665d1 Fix some more typos.
Glenn Morris <rgm@gnu.org>
parents: 101146
diff changeset
3552 children are done, you can use the following setup:
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
3553
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
3554 @example
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
3555 (defun org-summary-todo (n-done n-not-done)
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
3556 "Switch entry to DONE when all subentries are done, to TODO otherwise."
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
3557 (let (org-log-done org-log-states) ; turn off logging
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
3558 (org-todo (if (= n-not-done 0) "DONE" "TODO"))))
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
3559
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
3560 (add-hook 'org-after-todo-statistics-hook 'org-summary-todo)
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
3561 @end example
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
3562
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
3563
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
3564 Another possibility is the use of checkboxes to identify (a hierarchy of) a
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
3565 large number of subtasks (@pxref{Checkboxes}).
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3566
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3567
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3568 @node Checkboxes, , Breaking down tasks, TODO Items
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3569 @section Checkboxes
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3570 @cindex checkboxes
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3571
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3572 Every item in a plain list (@pxref{Plain lists}) can be made into a
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3573 checkbox by starting it with the string @samp{[ ]}. This feature is
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3574 similar to TODO items (@pxref{TODO Items}), but is more lightweight.
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3575 Checkboxes are not included into the global TODO list, so they are often
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3576 great to split a task into a number of simple steps. Or you can use
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3577 them in a shopping list. To toggle a checkbox, use @kbd{C-c C-c}, or
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3578 use the mouse (thanks to Piotr Zielinski's @file{org-mouse.el}).
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3579
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3580 Here is an example of a checkbox list.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3581
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3582 @example
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3583 * TODO Organize party [2/4]
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3584 - [-] call people [1/3]
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3585 - [ ] Peter
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3586 - [X] Sarah
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3587 - [ ] Sam
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3588 - [X] order food
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3589 - [ ] think about what music to play
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3590 - [X] talk to the neighbors
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3591 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3592
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3593 Checkboxes work hierarchically, so if a checkbox item has children that
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3594 are checkboxes, toggling one of the children checkboxes will make the
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3595 parent checkbox reflect if none, some, or all of the children are
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3596 checked.
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3597
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3598 @cindex statistics, for checkboxes
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3599 @cindex checkbox statistics
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3600 The @samp{[2/4]} and @samp{[1/3]} in the first and second line are
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3601 cookies indicating how many checkboxes present in this entry have been
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3602 checked off, and the total number of checkboxes are present. This can
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3603 give you an idea on how many checkboxes remain, even without opening a
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3604 folded entry. The cookies can be placed into a headline or into (the
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3605 first line of) a plain list item. Each cookie covers all checkboxes
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3606 structurally below the headline/item on which the cookie appear. You
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3607 have to insert the cookie yourself by typing either @samp{[/]} or
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3608 @samp{[%]}. With @samp{[/]} you get an @samp{n out of m} result, as in
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3609 the examples above. With @samp{[%]} you get information about the
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3610 percentage of checkboxes checked (in the above example, this would be
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3611 @samp{[50%]} and @samp{[33%]}, respectively).
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3612
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3613 @noindent The following commands work with checkboxes:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3614
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3615 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3616 @kindex C-c C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3617 @item C-c C-c
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3618 Toggle checkbox at point. With a prefix argument, set it to @samp{[-]},
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3619 which is considered to be an intermediate state.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3620 @kindex C-c C-x C-b
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3621 @item C-c C-x C-b
101609
6be1e380a009 2009-01-28 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101574
diff changeset
3622 Toggle checkbox status or (with prefix arg) checkbox presence at point.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3623 @itemize @minus
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3624 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3625 If there is an active region, toggle the first checkbox in the region
101609
6be1e380a009 2009-01-28 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101574
diff changeset
3626 and set all remaining boxes to the same status as the first. With a prefix
6be1e380a009 2009-01-28 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101574
diff changeset
3627 arg, add or remove the checkbox for all items in the region.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3628 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3629 If the cursor is in a headline, toggle checkboxes in the region between
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3630 this headline and the next (so @emph{not} the entire subtree).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3631 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3632 If there is no active region, just toggle the checkbox at point.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3633 @end itemize
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3634 @kindex M-S-@key{RET}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3635 @item M-S-@key{RET}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3636 Insert a new item with a checkbox.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3637 This works only if the cursor is already in a plain list item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3638 (@pxref{Plain lists}).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3639 @kindex C-c #
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3640 @item C-c #
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3641 Update the checkbox statistics in the current outline entry. When
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3642 called with a @kbd{C-u} prefix, update the entire file. Checkbox
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3643 statistic cookies are updated automatically if you toggle checkboxes
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3644 with @kbd{C-c C-c} and make new ones with @kbd{M-S-@key{RET}}. If you
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3645 delete boxes or add/change them by hand, use this command to get things
101147
a62da64665d1 Fix some more typos.
Glenn Morris <rgm@gnu.org>
parents: 101146
diff changeset
3646 back into sync. Or simply toggle any checkbox twice with @kbd{C-c C-c}.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3647 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3648
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3649 @node Tags, Properties and Columns, TODO Items, Top
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3650 @chapter Tags
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3651 @cindex tags
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3652 @cindex headline tagging
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3653 @cindex matching, tags
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3654 @cindex sparse tree, tag based
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3655
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3656 An excellent way to implement labels and contexts for cross-correlating
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3657 information is to assign @i{tags} to headlines. Org mode has extensive
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3658 support for tags.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3659
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3660 Every headline can contain a list of tags; they occur at the end of the
100271
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
3661 headline. Tags are normal words containing letters, numbers, @samp{_}, and
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
3662 @samp{@@}. Tags must be preceded and followed by a single colon, e.g.,
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
3663 @samp{:work:}. Several tags can be specified, as in @samp{:work:urgent:}.
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
3664 Tags will by default get a bold face with the same color as the headline.
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
3665 You may specify special faces for specific tags using the variable
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
3666 @code{org-tag-faces}, much in the same way as you can do for TODO keywords
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
3667 (@pxref{Faces for TODO keywords}).
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3668
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3669 @menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3670 * Tag inheritance:: Tags use the tree structure of the outline
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3671 * Setting tags:: How to assign tags to a headline
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3672 * Tag searches:: Searching for combinations of tags
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3673 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3674
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3675 @node Tag inheritance, Setting tags, Tags, Tags
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3676 @section Tag inheritance
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3677 @cindex tag inheritance
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3678 @cindex inheritance, of tags
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3679 @cindex sublevels, inclusion into tags match
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3680
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3681 @i{Tags} make use of the hierarchical structure of outline trees. If a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3682 heading has a certain tag, all subheadings will inherit the tag as
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3683 well. For example, in the list
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3684
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3685 @example
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3686 * Meeting with the French group :work:
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3687 ** Summary by Frank :boss:notes:
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3688 *** TODO Prepare slides for him :action:
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3689 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3690
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3691 @noindent
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3692 the final heading will have the tags @samp{:work:}, @samp{:boss:},
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3693 @samp{:notes:}, and @samp{:action:} even though the final heading is not
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
3694 explicitly marked with those tags. You can also set tags that all entries in
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
3695 a file should inherit as if these tags would be defined in a hypothetical
101147
a62da64665d1 Fix some more typos.
Glenn Morris <rgm@gnu.org>
parents: 101146
diff changeset
3696 level zero that surrounds the entire file.
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
3697
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
3698 @example
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
3699 #+FILETAGS: :Peter:Boss:Secret:
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
3700 @end example
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
3701
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
3702 @noindent
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
3703 To limit tag inheritance to specific tags, or to turn it off entirely, use
100271
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
3704 the variables @code{org-use-tag-inheritance} and
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
3705 @code{org-tags-exclude-from-inheritance}.
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
3706
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
3707 When a headline matches during a tags search while tag inheritance is turned
100271
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
3708 on, all the sublevels in the same tree will (for a simple match form) match
101146
04d0b710c360 Peter Tury <tury.peter at gmail.com> (tiny change)
Glenn Morris <rgm@gnu.org>
parents: 100974
diff changeset
3709 as well@footnote{This is only true if the search does not involve more
100271
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
3710 complex tests including properties (@pxref{Property searches}).}. The list
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
3711 of matches may then become very long. If you only want to see the first tags
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
3712 match in a subtree, configure the variable
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
3713 @code{org-tags-match-list-sublevels} (not recommended).
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3714
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3715 @node Setting tags, Tag searches, Tag inheritance, Tags
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3716 @section Setting tags
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3717 @cindex setting tags
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3718 @cindex tags, setting
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3719
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3720 @kindex M-@key{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3721 Tags can simply be typed into the buffer at the end of a headline.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3722 After a colon, @kbd{M-@key{TAB}} offers completion on tags. There is
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3723 also a special command for inserting tags:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3724
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3725 @table @kbd
99139
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
3726 @kindex C-c C-q
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
3727 @item C-c C-q
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3728 @cindex completion, of tags
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3729 Enter new tags for the current headline. Org mode will either offer
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3730 completion or a special single-key interface for setting tags, see
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3731 below. After pressing @key{RET}, the tags will be inserted and aligned
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3732 to @code{org-tags-column}. When called with a @kbd{C-u} prefix, all
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3733 tags in the current buffer will be aligned to that column, just to make
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3734 things look nice. TAGS are automatically realigned after promotion,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3735 demotion, and TODO state changes (@pxref{TODO basics}).
99139
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
3736 @kindex C-c C-c
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
3737 @item C-c C-c
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
3738 When the cursor is in a headline, this does the same as @kbd{C-c C-q}.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3739 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3740
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3741 Org will support tag insertion based on a @emph{list of tags}. By
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3742 default this list is constructed dynamically, containing all tags
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3743 currently used in the buffer. You may also globally specify a hard list
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3744 of tags with the variable @code{org-tag-alist}. Finally you can set
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3745 the default tags for a given file with lines like
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3746
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3747 @example
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3748 #+TAGS: @@work @@home @@tennisclub
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3749 #+TAGS: laptop car pc sailboat
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3750 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3751
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3752 If you have globally defined your preferred set of tags using the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3753 variable @code{org-tag-alist}, but would like to use a dynamic tag list
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3754 in a specific file, add an empty TAGS option line to that file:
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3755
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3756 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3757 #+TAGS:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3758 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3759
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3760 By default Org mode uses the standard minibuffer completion facilities for
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3761 entering tags. However, it also implements another, quicker, tag selection
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3762 method called @emph{fast tag selection}. This allows you to select and
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3763 deselect tags with just a single key press. For this to work well you should
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3764 assign unique letters to most of your commonly used tags. You can do this
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3765 globally by configuring the variable @code{org-tag-alist} in your
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3766 @file{.emacs} file. For example, you may find the need to tag many items in
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3767 different files with @samp{:@@home:}. In this case you can set something
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3768 like:
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3769
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3770 @lisp
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3771 (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l)))
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3772 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3773
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3774 @noindent If the tag is only relevant to the file you are working on then you
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3775 can, instead, set the TAGS option line as:
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3776
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3777 @example
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3778 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) laptop(l) pc(p)
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3779 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3780
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3781 @noindent
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3782 You can also group together tags that are mutually exclusive. By using
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3783 braces, as in:
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3784
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3785 @example
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3786 #+TAGS: @{ @@work(w) @@home(h) @@tennisclub(t) @} laptop(l) pc(p)
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3787 @end example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3788
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3789 @noindent you indicate that at most one of @samp{@@work}, @samp{@@home},
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3790 and @samp{@@tennisclub} should be selected. Multiple such groups are allowed.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3791
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3792 @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3793 these lines to activate any changes.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3794
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3795 @noindent
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3796 To set these mutually exclusive groups in the variable @code{org-mode-alist}
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3797 you must use the dummy tags @code{:startgroup} and @code{:endgroup} instead
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3798 of the braces. The previous example would be set globally by the following
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3799 configuration:
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3800
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3801 @lisp
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3802 (setq org-tag-alist '((:startgroup . nil)
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3803 ("@@work" . ?w) ("@@home" . ?h)
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3804 ("@@tennisclub" . ?t)
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3805 (:endgroup . nil)
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3806 ("laptop" . ?l) ("pc" . ?p)))
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3807 @end lisp
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3808
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3809 If at least one tag has a selection key then pressing @kbd{C-c C-c} will
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3810 automatically present you with a special interface, listing inherited tags,
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3811 the tags of the current headline, and a list of all valid tags with
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3812 corresponding keys@footnote{Keys will automatically be assigned to tags which
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3813 have no configured keys.}. In this interface, you can use the following
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3814 keys:
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3815
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3816 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3817 @item a-z...
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3818 Pressing keys assigned to tags will add or remove them from the list of
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3819 tags in the current line. Selecting a tag in a group of mutually
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3820 exclusive tags will turn off any other tags from that group.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3821 @kindex @key{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3822 @item @key{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3823 Enter a tag in the minibuffer, even if the tag is not in the predefined
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3824 list. You will be able to complete on all tags present in the buffer.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3825 @kindex @key{SPC}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3826 @item @key{SPC}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3827 Clear all tags for this line.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3828 @kindex @key{RET}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3829 @item @key{RET}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3830 Accept the modified set.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3831 @item C-g
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3832 Abort without installing changes.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3833 @item q
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3834 If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3835 @item !
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3836 Turn off groups of mutually exclusive tags. Use this to (as an
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3837 exception) assign several tags from such a group.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3838 @item C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3839 Toggle auto-exit after the next change (see below).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3840 If you are using expert mode, the first @kbd{C-c} will display the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3841 selection window.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3842 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3843
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3844 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3845 This method lets you assign tags to a headline with very few keys. With
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3846 the above setup, you could clear the current tags and set @samp{@@home},
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3847 @samp{laptop} and @samp{pc} tags with just the following keys: @kbd{C-c
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3848 C-c @key{SPC} h l p @key{RET}}. Switching from @samp{@@home} to
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3849 @samp{@@work} would be done with @kbd{C-c C-c w @key{RET}} or
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3850 alternatively with @kbd{C-c C-c C-c w}. Adding the non-predefined tag
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3851 @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3852 @key{RET} @key{RET}}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3853
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3854 If you find that most of the time, you need only a single key press to
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3855 modify your list of tags, set the variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3856 @code{org-fast-tag-selection-single-key}. Then you no longer have to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3857 press @key{RET} to exit fast tag selection - it will immediately exit
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3858 after the first change. If you then occasionally need more keys, press
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3859 @kbd{C-c} to turn off auto-exit for the current tag selection process
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3860 (in effect: start selection with @kbd{C-c C-c C-c} instead of @kbd{C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3861 C-c}). If you set the variable to the value @code{expert}, the special
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3862 window is not even shown for single-key tag selection, it comes up only
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3863 when you press an extra @kbd{C-c}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3864
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3865 @node Tag searches, , Setting tags, Tags
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3866 @section Tag searches
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3867 @cindex tag searches
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3868 @cindex searching for tags
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3869
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3870 Once a system of tags has been set up, it can be used to collect related
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3871 information into special lists.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3872
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3873 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3874 @kindex C-c \
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3875 @kindex C-c / T
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3876 @item C-c \
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3877 @itemx C-c / T
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3878 Create a sparse tree with all headlines matching a tags search. With a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3879 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3880 @kindex C-c a m
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3881 @item C-c a m
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3882 Create a global list of tag matches from all agenda files.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3883 @xref{Matching tags and properties}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3884 @kindex C-c a M
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3885 @item C-c a M
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3886 Create a global list of tag matches from all agenda files, but check
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3887 only TODO items and force checking subitems (see variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3888 @code{org-tags-match-list-sublevels}).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3889 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3890
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3891 @cindex Boolean logic, for tag searches
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3892 A @i{tags} search string can use Boolean operators @samp{&} for AND and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3893 @samp{|} for OR. @samp{&} binds more strongly than @samp{|}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3894 Parenthesis are currently not implemented. A tag may also be preceded
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3895 by @samp{-}, to select against it, and @samp{+} is syntactic sugar for
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3896 positive selection. The AND operator @samp{&} is optional when @samp{+}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3897 or @samp{-} is present. Examples:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3898
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3899 @table @samp
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3900 @item +work-boss
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3901 Select headlines tagged @samp{:work:}, but discard those also tagged
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3902 @samp{:boss:}.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3903 @item work|laptop
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3904 Selects lines tagged @samp{:work:} or @samp{:laptop:}.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3905 @item work|laptop&night
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3906 Like before, but require the @samp{:laptop:} lines to be tagged also
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3907 @samp{:night:}.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3908 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3909
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3910 @cindex TODO keyword matching, with tags search
99503
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
3911 You may also test for TODO keywords (@pxref{TODO extensions}) and properties
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
3912 (@pxref{Properties and Columns}) at the same time as matching tags. For a
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
3913 guide on how to match properties, see @ref{Property searches}. To match a
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
3914 specific TODO keyword, include an expression like @samp{+TODO="NEXT"} as one
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
3915 of the terms in a tags search.
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
3916
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
3917 There is also the possibility to end the tags part of the match (which may
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
3918 include several terms connected with @samp{|}) with a @samp{/} and then
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
3919 specify a Boolean expression just for TODO keywords. The syntax is then
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
3920 similar to the tag matches, but should be applied with consideration: For
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
3921 example, a positive selection on several TODO keywords can not meaningfully
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
3922 be combined with boolean AND. However, @emph{negative selection} combined
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
3923 with AND can be meaningful. To make sure that only lines are checked that
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
3924 actually have any TODO keyword (resulting in a speed-up), use @kbd{C-c a M},
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
3925 or equivalently start the TODO part after the slash with @samp{!}. Examples:
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3926
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3927 @table @samp
99503
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
3928 @item work+TODO="WAITING"
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3929 Select @samp{:work:}-tagged TODO lines with the specific TODO
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3930 keyword @samp{WAITING}.
99503
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
3931 @item work+TODO="WAITING"|home+TODO="WAITING"
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
3932 Waiting tasks both at work and at home.
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
3933 @item work/WAITING
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
3934 Same as the first example.
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3935 @item work/!-WAITING-NEXT
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3936 Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3937 nor @samp{NEXT}
99503
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
3938 @item work/!+WAITING|+NEXT
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3939 Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3940 @samp{NEXT}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3941 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3942
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3943 @cindex regular expressions, with tags search
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3944 Any element of the tag/todo match can be a regular expression - in this
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3945 case it must be enclosed in curly braces. For example,
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3946 @samp{work+@{^boss.*@}} matches headlines that contain the tag
99503
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
3947 @samp{:work:} and any tag @i{starting} with @samp{boss}. You may also use a
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
3948 regular expression in @samp{TODO=@{^W@}} which would match TODO keywords
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
3949 starting with the letter @samp{W}.
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3950
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3951 @cindex level, require for tags/property match
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3952 @cindex category, require for tags/property match
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3953 You can also require a headline to be of a certain level or category, by
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3954 writing instead of any TAG an expression like @samp{LEVEL=3} or
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3955 @samp{CATEGORY="work"}, respectively. For example, a search
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3956 @samp{+LEVEL=3+boss/-DONE} lists all level three headlines that have the
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3957 tag @samp{boss} and are @emph{not} marked with the TODO keyword DONE.
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3958
99503
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
3959 Accessing TODO, LEVEL, and CATEGORY during a search is fast. Accessing any
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
3960 other properties will slow down the search.
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
3961
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3962 @node Properties and Columns, Dates and Times, Tags, Top
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3963 @chapter Properties and Columns
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3964 @cindex properties
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3965
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3966 Properties are a set of key-value pairs associated with an entry. There
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3967 are two main applications for properties in Org mode. First, properties
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3968 are like tags, but with a value. Second, you can use properties to
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3969 implement (very basic) database capabilities in an Org buffer. For
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3970 an example of the first application, imagine maintaining a file where
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3971 you document bugs and plan releases of a piece of software. Instead of
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3972 using tags like @code{:release_1:}, @code{:release_2:}, one can use a
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3973 property, say @code{:Release:}, that in different subtrees has different
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3974 values, such as @code{1.0} or @code{2.0}. For an example of the second
101147
a62da64665d1 Fix some more typos.
Glenn Morris <rgm@gnu.org>
parents: 101146
diff changeset
3975 application of properties, imagine keeping track of your music CDs,
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3976 where properties could be things such as the album artist, date of
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3977 release, number of tracks, and so on.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3978
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3979 Properties can be conveniently edited and viewed in column view
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3980 (@pxref{Column view}).
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3981
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3982 @menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3983 * Property syntax:: How properties are spelled out
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3984 * Special properties:: Access to other Org mode features
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3985 * Property searches:: Matching property values
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3986 * Property inheritance:: Passing values down the tree
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3987 * Column view:: Tabular viewing and editing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3988 * Property API:: Properties for Lisp programmers
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3989 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3990
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3991 @node Property syntax, Special properties, Properties and Columns, Properties and Columns
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
3992 @section Property syntax
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3993 @cindex property syntax
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3994 @cindex drawer, for properties
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3995
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3996 Properties are key-value pairs. They need to be inserted into a special
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3997 drawer (@pxref{Drawers}) with the name @code{PROPERTIES}. Each property
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3998 is specified on a single line, with the key (surrounded by colons)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3999 first, and the value after it. Here is an example:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4000
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4001 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4002 * CD collection
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4003 ** Classic
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4004 *** Goldberg Variations
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4005 :PROPERTIES:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4006 :Title: Goldberg Variations
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4007 :Composer: J.S. Bach
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4008 :Artist: Glen Gould
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4009 :Publisher: Deutsche Grammphon
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4010 :NDisks: 1
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4011 :END:
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4012 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4013
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4014 You may define the allowed values for a particular property @samp{:Xyz:}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4015 by setting a property @samp{:Xyz_ALL:}. This special property is
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4016 @emph{inherited}, so if you set it in a level 1 entry, it will apply to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4017 the entire tree. When allowed values are defined, setting the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4018 corresponding property becomes easier and is less prone to typing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4019 errors. For the example with the CD collection, we can predefine
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4020 publishers and the number of disks in a box like this:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4021
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4022 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4023 * CD collection
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4024 :PROPERTIES:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4025 :NDisks_ALL: 1 2 3 4
99851
68981b04c1ac 2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99709
diff changeset
4026 :Publisher_ALL: "Deutsche Grammophon" Philips EMI
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4027 :END:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4028 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4029
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4030 If you want to set properties that can be inherited by any entry in a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4031 file, use a line like
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4032
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4033 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4034 #+PROPERTY: NDisks_ALL 1 2 3 4
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4035 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4036
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4037 Property values set with the global variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4038 @code{org-global-properties} can be inherited by all entries in all
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4039 Org files.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4040
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4041 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4042 The following commands help to work with properties:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4043
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4044 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4045 @kindex M-@key{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4046 @item M-@key{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4047 After an initial colon in a line, complete property keys. All keys used
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4048 in the current file will be offered as possible completions.
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4049 @kindex C-c C-x p
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4050 @item C-c C-x p
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4051 Set a property. This prompts for a property name and a value. If
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4052 necessary, the property drawer is created as well.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4053 @item M-x org-insert-property-drawer
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4054 Insert a property drawer into the current entry. The drawer will be
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4055 inserted early in the entry, but after the lines with planning
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4056 information like deadlines.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4057 @kindex C-c C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4058 @item C-c C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4059 With the cursor in a property drawer, this executes property commands.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4060 @item C-c C-c s
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4061 Set a property in the current entry. Both the property and the value
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4062 can be inserted using completion.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4063 @kindex S-@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4064 @kindex S-@key{left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4065 @item S-@key{left}/@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4066 Switch property at point to the next/previous allowed value.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4067 @item C-c C-c d
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4068 Remove a property from the current entry.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4069 @item C-c C-c D
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4070 Globally remove a property, from all entries in the current file.
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4071 @item C-c C-c c
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4072 Compute the property at point, using the operator and scope from the
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4073 nearest column format definition.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4074 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4075
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4076 @node Special properties, Property searches, Property syntax, Properties and Columns
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4077 @section Special properties
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4078 @cindex properties, special
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4079
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4080 Special properties provide alternative access method to Org mode
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4081 features discussed in the previous chapters, like the TODO state or the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4082 priority of an entry. This interface exists so that you can include
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4083 these states into columns view (@pxref{Column view}), or to use them in
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4084 queries. The following property names are special and should not be
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4085 used as keys in the properties drawer:
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4086
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4087 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4088 TODO @r{The TODO keyword of the entry.}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4089 TAGS @r{The tags defined directly in the headline.}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4090 ALLTAGS @r{All tags, including inherited ones.}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4091 PRIORITY @r{The priority of the entry, a string with a single letter.}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4092 DEADLINE @r{The deadline time string, without the angular brackets.}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4093 SCHEDULED @r{The scheduling time stamp, without the angular brackets.}
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4094 TIMESTAMP @r{The first keyword-less time stamp in the entry.}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4095 TIMESTAMP_IA @r{The first inactive time stamp in the entry.}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4096 CLOCKSUM @r{The sum of CLOCK intervals in the subtree. @code{org-clock-sum}}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4097 @r{must be run first to compute the values.}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4098 @end example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4099
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4100 @node Property searches, Property inheritance, Special properties, Properties and Columns
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4101 @section Property searches
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4102 @cindex properties, searching
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4103 @cindex searching, of properties
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4104
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4105 To create sparse trees and special lists with selection based on properties,
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4106 the same commands are used as for tag searches (@pxref{Tag searches}), and
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4107 the same logic applies. For example, here is a search string:
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4108
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4109 @example
96976
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
4110 +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2 \
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
4111 +With=@{Sarah\|Denny@}+SCHEDULED>="<2008-10-11>"
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4112 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4113
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4114 @noindent
96976
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
4115 The type of comparison will depend on how the comparison value is written:
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
4116 @itemize @minus
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
4117 @item
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4118 If the comparison value is a plain number, a numerical comparison is done,
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4119 and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=},
96976
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
4120 @samp{>=}, and @samp{<>}.
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
4121 @item
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
4122 If the comparison value is enclosed in double
100271
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
4123 quotes, a string comparison is done, and the same operators are allowed.
96976
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
4124 @item
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
4125 If the comparison value is enclosed in double quotes @emph{and} angular
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
4126 brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are
100271
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
4127 assumed to be date/time specifications in the standard Org way, and the
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
4128 comparison will be done accordingly. Special values that will be recognized
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
4129 are @code{"<now>"} for now (including time), and @code{"<today>"}, and
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
4130 @code{"<tomorrow>"} for these days at 0:00 hours, i.e. without a time
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
4131 specification. Also strings like @code{"<+5d>"} or @code{"<-2m>"} with units
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
4132 @code{d}, @code{w}, @code{m}, and @code{y} for day, week, month, and year,
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
4133 respectively, can be used.
96976
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
4134 @item
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
4135 If the comparison value is enclosed
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
4136 in curly braces, a regexp match is performed, with @samp{=} meaning that the
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
4137 regexp matches the property value, and @samp{<>} meaning that it does not
100271
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
4138 match.
96976
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
4139 @end itemize
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
4140
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
4141 So the search string in the example finds entries tagged @samp{:work:} but
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
4142 not @samp{:boss:}, which also have a priority value @samp{A}, a
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
4143 @samp{:Coffee:} property with the value @samp{unlimited}, an @samp{Effort}
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
4144 property that is numerically smaller than 2, a @samp{:With:} property that is
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
4145 matched by the regular expression @samp{Sarah\|Denny}, and that are scheduled
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
4146 on or after October 11, 2008.
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4147
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4148 You can configure Org mode to use property inheritance during a search, but
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4149 beware that this can slow down searches considerably. See @ref{Property
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4150 inheritance} for details.
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4151
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4152 There is also a special command for creating sparse trees based on a
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4153 single property:
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4154
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4155 @table @kbd
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4156 @kindex C-c / p
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4157 @item C-c / p
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4158 Create a sparse tree based on the value of a property. This first
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4159 prompts for the name of a property, and then for a value. A sparse tree
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4160 is created with all entries that define this property with the given
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4161 value. If you enclose the value into curly braces, it is interpreted as
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4162 a regular expression and matched against the property values.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4163 @end table
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4164
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4165 @node Property inheritance, Column view, Property searches, Properties and Columns
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4166 @section Property Inheritance
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4167 @cindex properties, inheritance
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4168 @cindex inheritance, of properties
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4169
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4170 The outline structure of Org mode documents lends itself for an
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4171 inheritance model of properties: If the parent in a tree has a certain
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4172 property, the children can inherit this property. Org mode does not
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4173 turn this on by default, because it can slow down property searches
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4174 significantly and is often not needed. However, if you find inheritance
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4175 useful, you can turn it on by setting the variable
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4176 @code{org-use-property-inheritance}. It may be set to @code{t}, to make
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4177 all properties inherited from the parent, to a list of properties
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4178 that should be inherited, or to a regular expression that matches
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4179 inherited properties.
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4180
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4181 Org mode has a few properties for which inheritance is hard-coded, at
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4182 least for the special applications for which they are used:
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4183
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4184 @table @code
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4185 @item COLUMNS
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4186 The @code{:COLUMNS:} property defines the format of column view
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4187 (@pxref{Column view}). It is inherited in the sense that the level
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4188 where a @code{:COLUMNS:} property is defined is used as the starting
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4189 point for a column view table, independently of the location in the
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4190 subtree from where columns view is turned on.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4191 @item CATEGORY
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4192 For agenda view, a category set through a @code{:CATEGORY:} property
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4193 applies to the entire subtree.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4194 @item ARCHIVE
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4195 For archiving, the @code{:ARCHIVE:} property may define the archive
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4196 location for the entire subtree (@pxref{Moving subtrees}).
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4197 @item LOGGING
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4198 The LOGGING property may define logging settings for an entry or a
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4199 subtree (@pxref{Tracking TODO state changes}).
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4200 @end table
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4201
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4202 @node Column view, Property API, Property inheritance, Properties and Columns
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4203 @section Column view
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4204
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4205 A great way to view and edit properties in an outline tree is
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4206 @emph{column view}. In column view, each outline item is turned into a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4207 table row. Columns in this table provide access to properties of the
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4208 entries. Org mode implements columns by overlaying a tabular structure
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4209 over the headline of each item. While the headlines have been turned
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4210 into a table row, you can still change the visibility of the outline
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4211 tree. For example, you get a compact table by switching to CONTENTS
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4212 view (@kbd{S-@key{TAB} S-@key{TAB}}, or simply @kbd{c} while column view
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4213 is active), but you can still open, read, and edit the entry below each
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4214 headline. Or, you can switch to column view after executing a sparse
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4215 tree command and in this way get a table only for the selected items.
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4216 Column view also works in agenda buffers (@pxref{Agenda Views}) where
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4217 queries have collected selected items, possibly from a number of files.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4218
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4219 @menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4220 * Defining columns:: The COLUMNS format property
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4221 * Using column view:: How to create and use column view
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4222 * Capturing column view:: A dynamic block for column view
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4223 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4224
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4225 @node Defining columns, Using column view, Column view, Column view
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4226 @subsection Defining columns
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4227 @cindex column view, for properties
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4228 @cindex properties, column view
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4229
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4230 Setting up a column view first requires defining the columns. This is
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4231 done by defining a column format line.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4232
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4233 @menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4234 * Scope of column definitions:: Where defined, where valid?
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4235 * Column attributes:: Appearance and content of a column
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4236 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4237
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4238 @node Scope of column definitions, Column attributes, Defining columns, Defining columns
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4239 @subsubsection Scope of column definitions
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4240
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4241 To define a column format for an entire file, use a line like
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4242
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4243 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4244 #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4245 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4246
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4247 To specify a format that only applies to a specific tree, add a
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4248 @code{:COLUMNS:} property to the top node of that tree, for example:
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4249
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4250 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4251 ** Top node for columns view
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4252 :PROPERTIES:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4253 :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4254 :END:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4255 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4256
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4257 If a @code{:COLUMNS:} property is present in an entry, it defines columns
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4258 for the entry itself, and for the entire subtree below it. Since the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4259 column definition is part of the hierarchical structure of the document,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4260 you can define columns on level 1 that are general enough for all
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4261 sublevels, and more specific columns further down, when you edit a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4262 deeper part of the tree.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4263
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4264 @node Column attributes, , Scope of column definitions, Defining columns
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4265 @subsubsection Column attributes
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4266 A column definition sets the attributes of a column. The general
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4267 definition looks like this:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4268
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4269 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4270 %[width]property[(title)][@{summary-type@}]
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4271 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4272
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4273 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4274 Except for the percent sign and the property name, all items are
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4275 optional. The individual parts have the following meaning:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4276
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4277 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4278 width @r{An integer specifying the width of the column in characters.}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4279 @r{If omitted, the width will be determined automatically.}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4280 property @r{The property that should be edited in this column.}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4281 (title) @r{The header text for the column. If omitted, the}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4282 @r{property name is used.}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4283 @{summary-type@} @r{The summary type. If specified, the column values for}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4284 @r{parent nodes are computed from the children.}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4285 @r{Supported summary types are:}
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4286 @{+@} @r{Sum numbers in this column.}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4287 @{+;%.1f@} @r{Like @samp{+}, but format result with @samp{%.1f}.}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4288 @{$@} @r{Currency, short for @samp{+;%.2f}.}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4289 @{:@} @r{Sum times, HH:MM:SS, plain numbers are hours.}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4290 @{X@} @r{Checkbox status, [X] if all children are [X].}
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4291 @{X/@} @r{Checkbox status, [n/m].}
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4292 @{X%@} @r{Checkbox status, [n%].}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4293 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4294
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4295 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4296 Here is an example for a complete columns definition, along with allowed
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4297 values.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4298
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4299 @example
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4300 :COLUMNS: %20ITEM %9Approved(Approved?)@{X@} %Owner %11Status \@footnote{Please note that the COLUMNS definition must be on a single line - it is wrapped here only because of formatting constraints.}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4301 %10Time_Estimate@{:@} %CLOCKSUM
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4302 :Owner_ALL: Tammy Mark Karl Lisa Don
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4303 :Status_ALL: "In progress" "Not started yet" "Finished" ""
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4304 :Approved_ALL: "[ ]" "[X]"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4305 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4306
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4307 The first column, @samp{%25ITEM}, means the first 25 characters of the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4308 item itself, i.e. of the headline. You probably always should start the
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4309 column definition with the @samp{ITEM} specifier. The other specifiers
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4310 create columns @samp{Owner} with a list of names as allowed values, for
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4311 @samp{Status} with four different possible values, and for a checkbox
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4312 field @samp{Approved}. When no width is given after the @samp{%}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4313 character, the column will be exactly as wide as it needs to be in order
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4314 to fully display all values. The @samp{Approved} column does have a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4315 modified title (@samp{Approved?}, with a question mark). Summaries will
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4316 be created for the @samp{Time_Estimate} column by adding time duration
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4317 expressions like HH:MM, and for the @samp{Approved} column, by providing
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4318 an @samp{[X]} status if all children have been checked. The
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4319 @samp{CLOCKSUM} column is special, it lists the sum of CLOCK intervals
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4320 in the subtree.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4321
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4322 @node Using column view, Capturing column view, Defining columns, Column view
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4323 @subsection Using column view
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4324
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4325 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4326 @tsubheading{Turning column view on and off}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4327 @kindex C-c C-x C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4328 @item C-c C-x C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4329 Create the column view for the local environment. This command searches
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4330 the hierarchy, up from point, for a @code{:COLUMNS:} property that defines
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4331 a format. When one is found, the column view table is established for
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4332 the entire tree, starting from the entry that contains the @code{:COLUMNS:}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4333 property. If none is found, the format is taken from the @code{#+COLUMNS}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4334 line or from the variable @code{org-columns-default-format}, and column
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4335 view is established for the current entry and its subtree.
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4336 @kindex r
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4337 @item r
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4338 Recreate the column view, to include recent changes made in the buffer.
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4339 @kindex g
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4340 @item g
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4341 Same as @kbd{r}.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4342 @kindex q
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4343 @item q
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4344 Exit column view.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4345 @tsubheading{Editing values}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4346 @item @key{left} @key{right} @key{up} @key{down}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4347 Move through the column view from field to field.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4348 @kindex S-@key{left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4349 @kindex S-@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4350 @item S-@key{left}/@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4351 Switch to the next/previous allowed value of the field. For this, you
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4352 have to have specified allowed values for a property.
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
4353 @item 1..9,0
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
4354 Directly select the nth allowed value, @kbd{0} selects the 10th value.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4355 @kindex n
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4356 @kindex p
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4357 @itemx n / p
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4358 Same as @kbd{S-@key{left}/@key{right}}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4359 @kindex e
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4360 @item e
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4361 Edit the property at point. For the special properties, this will
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4362 invoke the same interface that you normally use to change that
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4363 property. For example, when editing a TAGS property, the tag completion
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4364 or fast selection interface will pop up.
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4365 @kindex C-c C-c
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4366 @item C-c C-c
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4367 When there is a checkbox at point, toggle it.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4368 @kindex v
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4369 @item v
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4370 View the full value of this property. This is useful if the width of
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4371 the column is smaller than that of the value.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4372 @kindex a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4373 @item a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4374 Edit the list of allowed values for this property. If the list is found
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4375 in the hierarchy, the modified values is stored there. If no list is
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4376 found, the new value is stored in the first entry that is part of the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4377 current column view.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4378 @tsubheading{Modifying the table structure}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4379 @kindex <
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4380 @kindex >
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4381 @item < / >
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4382 Make the column narrower/wider by one character.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4383 @kindex S-M-@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4384 @item S-M-@key{right}
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
4385 Insert a new column, to the left of the current column.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4386 @kindex S-M-@key{left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4387 @item S-M-@key{left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4388 Delete the current column.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4389 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4390
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4391 @node Capturing column view, , Using column view, Column view
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4392 @subsection Capturing column view
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4393
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4394 Since column view is just an overlay over a buffer, it cannot be
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4395 exported or printed directly. If you want to capture a column view, use
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4396 this @code{columnview} dynamic block (@pxref{Dynamic blocks}). The frame
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4397 of this block looks like this:
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4398
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
4399 @cindex #+BEGIN: columnview
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4400 @example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4401 * The column view
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4402 #+BEGIN: columnview :hlines 1 :id "label"
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4403
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4404 #+END:
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4405 @end example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4406
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4407 @noindent This dynamic block has the following parameters:
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4408
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4409 @table @code
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4410 @item :id
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4411 This is most important parameter. Column view is a feature that is
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4412 often localized to a certain (sub)tree, and the capture block might be
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4413 in a different location in the file. To identify the tree whose view to
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4414 capture, you can use 3 values:
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4415 @example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4416 local @r{use the tree in which the capture block is located}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4417 global @r{make a global view, including all headings in the file}
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
4418 "file:path-to-file"
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
4419 @r{run column view at the top of this file}
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
4420 "ID" @r{call column view in the tree that has an @code{:ID:}}
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
4421 @r{property with the value @i{label}. You can use}
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
4422 @r{@kbd{M-x org-id-copy} to create a globally unique ID for}
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
4423 @r{the current entry and copy it to the kill-ring.}
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4424 @end example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4425 @item :hlines
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4426 When @code{t}, insert a hline after every line. When a number N, insert
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4427 a hline before each headline with level @code{<= N}.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4428 @item :vlines
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4429 When set to @code{t}, enforce column groups to get vertical lines.
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4430 @item :maxlevel
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4431 When set to a number, don't capture entries below this level.
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4432 @item :skip-empty-rows
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4433 When set to @code{t}, skip row where the only non-empty specifier of the
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4434 column view is @code{ITEM}.
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4435
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4436 @end table
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4437
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4438 @noindent
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4439 The following commands insert or update the dynamic block:
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4440
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4441 @table @kbd
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
4442 @kindex C-c C-x i
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
4443 @item C-c C-x i
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4444 Insert a dynamic block capturing a column view. You will be prompted
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4445 for the scope or id of the view.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4446 @kindex C-c C-c
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4447 @item C-c C-c
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4448 @kindex C-c C-x C-u
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4449 @itemx C-c C-x C-u
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4450 Update dynamical block at point. The cursor needs to be in the
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4451 @code{#+BEGIN} line of the dynamic block.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4452 @kindex C-u C-c C-x C-u
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4453 @item C-u C-c C-x C-u
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4454 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4455 you have several clock table blocks in a buffer.
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4456 @end table
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4457
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
4458 You can add formulas to the column view table and you may add plotting
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
4459 instructions in front of the table - these will survive an update of the
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
4460 block. If there is a @code{#+TBLFM:} after the table, the table will
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
4461 actually be recalculated automatically after an update.
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
4462
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4463 @node Property API, , Column view, Properties and Columns
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4464 @section The Property API
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4465 @cindex properties, API
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4466 @cindex API, for properties
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4467
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4468 There is a full API for accessing and changing properties. This API can
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4469 be used by Emacs Lisp programs to work with properties and to implement
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4470 features based on them. For more information see @ref{Using the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4471 property API}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4472
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
4473 @node Dates and Times, Capture, Properties and Columns, Top
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4474 @chapter Dates and Times
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4475 @cindex dates
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4476 @cindex times
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4477 @cindex time stamps
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4478 @cindex date stamps
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4479
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4480 To assist project planning, TODO items can be labeled with a date and/or
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4481 a time. The specially formatted string carrying the date and time
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4482 information is called a @emph{timestamp} in Org mode. This may be a
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4483 little confusing because timestamp is often used as indicating when
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4484 something was created or last changed. However, in Org mode this term
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4485 is used in a much wider sense.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4486
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4487 @menu
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4488 * Timestamps:: Assigning a time to a tree entry
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4489 * Creating timestamps:: Commands which insert timestamps
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4490 * Deadlines and scheduling:: Planning your work
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4491 * Clocking work time:: Tracking how long you spend on a task
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4492 * Effort estimates:: Planning work effort in advance
100271
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
4493 * Relative timer:: Notes with a running timer
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4494 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4495
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4496
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4497 @node Timestamps, Creating timestamps, Dates and Times, Dates and Times
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4498 @section Timestamps, deadlines and scheduling
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4499 @cindex time stamps
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4500 @cindex ranges, time
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4501 @cindex date stamps
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4502 @cindex deadlines
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4503 @cindex scheduling
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4504
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4505 A time stamp is a specification of a date (possibly with time or a range
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4506 of times) in a special format, either @samp{<2003-09-16 Tue>} or
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4507 @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16 Tue
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4508 12:00-12:30>}@footnote{This is the standard ISO date/time format. To
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4509 use an alternative format, see @ref{Custom time format}.}. A time stamp
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4510 can appear anywhere in the headline or body of an Org tree entry. Its
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4511 presence causes entries to be shown on specific dates in the agenda
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4512 (@pxref{Weekly/daily agenda}). We distinguish:
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4513
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4514 @table @var
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4515 @item Plain time stamp; Event; Appointment
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4516 @cindex timestamp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4517 A simple time stamp just assigns a date/time to an item. This is just
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4518 like writing down an appointment or event in a paper agenda. In the
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4519 timeline and agenda displays, the headline of an entry associated with a
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4520 plain time stamp will be shown exactly on that date.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4521
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4522 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4523 * Meet Peter at the movies <2006-11-01 Wed 19:15>
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4524 * Discussion on climate change <2006-11-02 Thu 20:00-22:00>
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4525 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4526
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4527 @item Time stamp with repeater interval
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4528 @cindex timestamp, with repeater interval
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4529 A time stamp may contain a @emph{repeater interval}, indicating that it
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4530 applies not only on the given date, but again and again after a certain
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4531 interval of N days (d), weeks (w), months(m), or years(y). The
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4532 following will show up in the agenda every Wednesday:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4533
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4534 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4535 * Pick up Sam at school <2007-05-16 Wed 12:30 +1w>
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4536 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4537
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4538 @item Diary-style sexp entries
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4539 For more complex date specifications, Org mode supports using the
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4540 special sexp diary entries implemented in the Emacs calendar/diary
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4541 package. For example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4542
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4543 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4544 * The nerd meeting on every 2nd Thursday of the month
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4545 <%%(diary-float t 4 2)>
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4546 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4547
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4548 @item Time/Date range
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4549 @cindex timerange
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4550 @cindex date range
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4551 Two time stamps connected by @samp{--} denote a range. The headline
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4552 will be shown on the first and last day of the range, and on any dates
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4553 that are displayed and fall in the range. Here is an example:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4554
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4555 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4556 ** Meeting in Amsterdam
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4557 <2004-08-23 Mon>--<2004-08-26 Thu>
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4558 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4559
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4560 @item Inactive time stamp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4561 @cindex timestamp, inactive
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4562 @cindex inactive timestamp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4563 Just like a plain time stamp, but with square brackets instead of
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4564 angular ones. These time stamps are inactive in the sense that they do
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4565 @emph{not} trigger an entry to show up in the agenda.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4566
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4567 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4568 * Gillian comes late for the fifth time [2006-11-01 Wed]
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4569 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4570
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4571 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4572
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4573 @node Creating timestamps, Deadlines and scheduling, Timestamps, Dates and Times
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4574 @section Creating timestamps
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4575 @cindex creating timestamps
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4576 @cindex timestamps, creating
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4577
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4578 For Org mode to recognize time stamps, they need to be in the specific
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4579 format. All commands listed below produce time stamps in the correct
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4580 format.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4581
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4582 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4583 @kindex C-c .
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4584 @item C-c .
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
4585 Prompt for a date and insert a corresponding time stamp. When the cursor is
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
4586 at an existing time stamp in the buffer, the command is used to modify this
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
4587 timestamp instead of inserting a new one. When this command is used twice in
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
4588 succession, a time range is inserted.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4589 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4590 @kindex C-u C-c .
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4591 @item C-u C-c .
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4592 Like @kbd{C-c .}, but use the alternative format which contains date
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4593 and time. The default time can be rounded to multiples of 5 minutes,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4594 see the option @code{org-time-stamp-rounding-minutes}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4595 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4596 @kindex C-c !
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4597 @item C-c !
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4598 Like @kbd{C-c .}, but insert an inactive time stamp that will not cause
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4599 an agenda entry.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4600 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4601 @kindex C-c <
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4602 @item C-c <
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4603 Insert a time stamp corresponding to the cursor date in the Calendar.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4604 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4605 @kindex C-c >
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4606 @item C-c >
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4607 Access the Emacs calendar for the current date. If there is a
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4608 timestamp in the current line, go to the corresponding date
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4609 instead.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4610 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4611 @kindex C-c C-o
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4612 @item C-c C-o
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4613 Access the agenda for the date given by the time stamp or -range at
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4614 point (@pxref{Weekly/daily agenda}).
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4615 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4616 @kindex S-@key{left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4617 @kindex S-@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4618 @item S-@key{left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4619 @itemx S-@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4620 Change date at cursor by one day. These key bindings conflict with
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4621 CUA mode (@pxref{Conflicts}).
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4622 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4623 @kindex S-@key{up}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4624 @kindex S-@key{down}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4625 @item S-@key{up}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4626 @itemx S-@key{down}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4627 Change the item under the cursor in a timestamp. The cursor can be on a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4628 year, month, day, hour or minute. Note that if the cursor is in a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4629 headline and not at a time stamp, these same keys modify the priority of
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4630 an item. (@pxref{Priorities}). The key bindings also conflict with
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4631 CUA mode (@pxref{Conflicts}).
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4632 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4633 @kindex C-c C-y
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4634 @cindex evaluate time range
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4635 @item C-c C-y
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4636 Evaluate a time range by computing the difference between start and end.
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4637 With a prefix argument, insert result after the time range (in a table: into
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4638 the following column).
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4639 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4640
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4641
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4642 @menu
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4643 * The date/time prompt:: How Org mode helps you entering date and time
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4644 * Custom time format:: Making dates look different
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4645 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4646
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4647 @node The date/time prompt, Custom time format, Creating timestamps, Creating timestamps
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4648 @subsection The date/time prompt
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4649 @cindex date, reading in minibuffer
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4650 @cindex time, reading in minibuffer
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4651
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4652 When Org mode prompts for a date/time, the default is shown as an ISO
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4653 date, and the prompt therefore seems to ask for an ISO date. But it
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4654 will in fact accept any string containing some date and/or time
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4655 information, and it is really smart about interpreting your input. You
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4656 can, for example, use @kbd{C-y} to paste a (possibly multi-line) string
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4657 copied from an email message. Org mode will find whatever information
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4658 is in there and derive anything you have not specified from the
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4659 @emph{default date and time}. The default is usually the current date
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4660 and time, but when modifying an existing time stamp, or when entering
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4661 the second stamp of a range, it is taken from the stamp in the buffer.
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4662 When filling in information, Org mode assumes that most of the time you
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4663 will want to enter a date in the future: If you omit the month/year and
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4664 the given day/month is @i{before} today, it will assume that you mean a
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4665 future date@footnote{See the variable
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4666 @code{org-read-date-prefer-future}.}.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4667
101146
04d0b710c360 Peter Tury <tury.peter at gmail.com> (tiny change)
Glenn Morris <rgm@gnu.org>
parents: 100974
diff changeset
4668 For example, let's assume that today is @b{June 13, 2006}. Here is how
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4669 various inputs will be interpreted, the items filled in by Org mode are
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4670 in @b{bold}.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4671
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4672 @example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4673 3-2-5 --> 2003-02-05
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4674 14 --> @b{2006}-@b{06}-14
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4675 12 --> @b{2006}-@b{07}-12
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4676 Fri --> nearest Friday (defaultdate or later)
101146
04d0b710c360 Peter Tury <tury.peter at gmail.com> (tiny change)
Glenn Morris <rgm@gnu.org>
parents: 100974
diff changeset
4677 sep 15 --> @b{2006}-09-15
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4678 feb 15 --> @b{2007}-02-15
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4679 sep 12 9 --> 2009-09-12
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4680 12:45 --> @b{2006}-@b{06}-@b{13} 12:45
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4681 22 sept 0:34 --> @b{2006}-09-22 0:34
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4682 w4 --> ISO week for of the current year @b{2006}
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4683 2012 w4 fri --> Friday of ISO week 4 in 2012
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4684 2012-w04-5 --> Same as above
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4685 @end example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4686
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4687 Furthermore you can specify a relative date by giving, as the
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4688 @emph{first} thing in the input: a plus/minus sign, a number and a
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4689 letter [dwmy] to indicate change in days weeks, months, years. With a
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4690 single plus or minus, the date is always relative to today. With a
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4691 double plus or minus, it is relative to the default date. If instead of
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4692 a single letter, you use the abbreviation of day name, the date will be
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4693 the nth such day. E.g.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4694
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4695 @example
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
4696 +0 --> today
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
4697 . --> today
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4698 +4d --> four days from today
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4699 +4 --> same as above
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4700 +2w --> two weeks from today
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4701 ++5 --> five days from default date
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4702 +2tue --> second tuesday from now.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4703 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4704
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4705 The function understands English month and weekday abbreviations. If
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4706 you want to use unabbreviated names and/or other languages, configure
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4707 the variables @code{parse-time-months} and @code{parse-time-weekdays}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4708
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4709 @cindex calendar, for selecting date
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4710 Parallel to the minibuffer prompt, a calendar is popped up@footnote{If
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4711 you don't need/want the calendar, configure the variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4712 @code{org-popup-calendar-for-date-prompt}.}. When you exit the date
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4713 prompt, either by clicking on a date in the calendar, or by pressing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4714 @key{RET}, the date selected in the calendar will be combined with the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4715 information entered at the prompt. You can control the calendar fully
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4716 from the minibuffer:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4717
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4718 @kindex <
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4719 @kindex >
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4720 @kindex mouse-1
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4721 @kindex S-@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4722 @kindex S-@key{left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4723 @kindex S-@key{down}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4724 @kindex S-@key{up}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4725 @kindex M-S-@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4726 @kindex M-S-@key{left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4727 @kindex @key{RET}
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4728 @example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4729 > / < @r{Scroll calendar forward/backward by one month.}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4730 mouse-1 @r{Select date by clicking on it.}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4731 S-@key{right}/@key{left} @r{One day forward/backward.}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4732 S-@key{down}/@key{up} @r{One week forward/backward.}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4733 M-S-@key{right}/@key{left} @r{One month forward/backward.}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4734 @key{RET} @r{Choose date in calendar.}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4735 @end example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4736
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4737 The actions of the date/time prompt may seem complex, but I assure you they
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4738 will grow on you, and you will start getting annoyed by pretty much any other
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4739 way of entering a date/time out there. To help you understand what is going
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4740 on, the current interpretation of your input will be displayed live in the
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4741 minibuffer@footnote{If you find this distracting, turn the display of with
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4742 @code{org-read-date-display-live}.}.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4743
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4744 @node Custom time format, , The date/time prompt, Creating timestamps
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4745 @subsection Custom time format
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4746 @cindex custom date/time format
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4747 @cindex time format, custom
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4748 @cindex date format, custom
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4749
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4750 Org mode uses the standard ISO notation for dates and times as it is
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4751 defined in ISO 8601. If you cannot get used to this and require another
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4752 representation of date and time to keep you happy, you can get it by
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4753 customizing the variables @code{org-display-custom-times} and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4754 @code{org-time-stamp-custom-formats}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4755
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4756 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4757 @kindex C-c C-x C-t
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4758 @item C-c C-x C-t
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4759 Toggle the display of custom formats for dates and times.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4760 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4761
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4762 @noindent
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4763 Org mode needs the default format for scanning, so the custom date/time
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4764 format does not @emph{replace} the default format - instead it is put
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4765 @emph{over} the default format using text properties. This has the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4766 following consequences:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4767 @itemize @bullet
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4768 @item
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4769 You cannot place the cursor onto a time stamp anymore, only before or
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4770 after.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4771 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4772 The @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjust
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4773 each component of a time stamp. If the cursor is at the beginning of
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4774 the stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4775 just like @kbd{S-@key{left}/@key{right}}. At the end of the stamp, the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4776 time will be changed by one minute.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4777 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4778 If the time stamp contains a range of clock times or a repeater, these
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4779 will not be overlayed, but remain in the buffer as they were.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4780 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4781 When you delete a time stamp character-by-character, it will only
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4782 disappear from the buffer after @emph{all} (invisible) characters
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4783 belonging to the ISO timestamp have been removed.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4784 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4785 If the custom time stamp format is longer than the default and you are
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4786 using dates in tables, table alignment will be messed up. If the custom
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4787 format is shorter, things do work as expected.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4788 @end itemize
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4789
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4790
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4791 @node Deadlines and scheduling, Clocking work time, Creating timestamps, Dates and Times
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4792 @section Deadlines and scheduling
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4793
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4794 A time stamp may be preceded by special keywords to facilitate planning:
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4795
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4796 @table @var
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4797 @item DEADLINE
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4798 @cindex DEADLINE keyword
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4799
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4800 Meaning: the task (most likely a TODO item, though not necessarily) is supposed
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4801 to be finished on that date.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4802
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4803 On the deadline date, the task will be listed in the agenda. In
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4804 addition, the agenda for @emph{today} will carry a warning about the
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4805 approaching or missed deadline, starting
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4806 @code{org-deadline-warning-days} before the due date, and continuing
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4807 until the entry is marked DONE. An example:
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4808
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4809 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4810 *** TODO write article about the Earth for the Guide
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4811 The editor in charge is [[bbdb:Ford Prefect]]
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4812 DEADLINE: <2004-02-29 Sun>
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4813 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4814
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4815 You can specify a different lead time for warnings for a specific
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4816 deadlines using the following syntax. Here is an example with a warning
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4817 period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4818
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4819 @item SCHEDULED
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4820 @cindex SCHEDULED keyword
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4821
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4822 Meaning: you are planning to start working on that task on the given
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4823 date.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4824
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4825 The headline will be listed under the given date@footnote{It will still
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4826 be listed on that date after it has been marked DONE. If you don't like
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4827 this, set the variable @code{org-agenda-skip-scheduled-if-done}.}. In
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4828 addition, a reminder that the scheduled date has passed will be present
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4829 in the compilation for @emph{today}, until the entry is marked DONE.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4830 I.e., the task will automatically be forwarded until completed.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4831
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4832 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4833 *** TODO Call Trillian for a date on New Years Eve.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4834 SCHEDULED: <2004-12-25 Sat>
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4835 @end example
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4837 @noindent
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4838 @b{Important:} Scheduling an item in Org mode should @i{not} be
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4839 understood in the same way that we understand @i{scheduling a meeting}.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4840 Setting a date for a meeting is just a simple appointment, you should
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4841 mark this entry with a simple plain time stamp, to get this item shown
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4842 on the date where it applies. This is a frequent mis-understanding from
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4843 Org-users. In Org mode, @i{scheduling} means setting a date when you
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4844 want to start working on an action item.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4845 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4846
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4847 You may use time stamps with repeaters in scheduling and deadline
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4848 entries. Org mode will issue early and late warnings based on the
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4849 assumption that the time stamp represents the @i{nearest instance} of
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4850 the repeater. However, the use of diary sexp entries like
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4851 @c
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4852 @code{<%%(diary-float t 42)>}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4853 @c
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4854 in scheduling and deadline timestamps is limited. Org mode does not
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4855 know enough about the internals of each sexp function to issue early and
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4856 late warnings. However, it will show the item on each day where the
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4857 sexp entry matches.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4858
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4859 @menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4860 * Inserting deadline/schedule:: Planning items
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4861 * Repeated tasks:: Items that show up again and again
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4862 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4863
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4864 @node Inserting deadline/schedule, Repeated tasks, Deadlines and scheduling, Deadlines and scheduling
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4865 @subsection Inserting deadlines or schedules
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4866
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4867 The following commands allow to quickly insert a deadline or to schedule
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4868 an item:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4869
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4870 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4871 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4872 @kindex C-c C-d
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4873 @item C-c C-d
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4874 Insert @samp{DEADLINE} keyword along with a stamp. The insertion will
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4875 happen in the line directly following the headline. When called with a
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4876 prefix arg, an existing deadline will be removed from the entry.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4877 @c FIXME Any CLOSED timestamp will be removed.????????
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4878 @c
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4879 @kindex C-c / d
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4880 @cindex sparse tree, for deadlines
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4881 @item C-c / d
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4882 Create a sparse tree with all deadlines that are either past-due, or
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4883 which will become due within @code{org-deadline-warning-days}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4884 With @kbd{C-u} prefix, show all deadlines in the file. With a numeric
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4885 prefix, check that many days. For example, @kbd{C-1 C-c / d} shows
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4886 all deadlines due tomorrow.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4887 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4888 @kindex C-c C-s
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4889 @item C-c C-s
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4890 Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4891 happen in the line directly following the headline. Any CLOSED
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4892 timestamp will be removed. When called with a prefix argument, remove
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4893 the scheduling date from the entry.
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
4894 @c
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
4895 @kindex C-c C-x C-k
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
4896 @kindex k a
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
4897 @kindex k s
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
4898 @item C-c C-x C-k
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
4899 Mark the current entry for agenda action. After you have marked the entry
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
4900 like this, you can open the agenda or the calendar to find an appropriate
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
4901 date. With the cursor on the selected date, press @kbd{k s} or @kbd{k d} to
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
4902 schedule the marked item.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4903 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4904
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4905 @node Repeated tasks, , Inserting deadline/schedule, Deadlines and scheduling
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4906 @subsection Repeated tasks
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4907
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4908 Some tasks need to be repeated again and again. Org mode helps to
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4909 organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED,
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4910 or plain time stamp. In the following example
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4911 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4912 ** TODO Pay the rent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4913 DEADLINE: <2005-10-01 Sat +1m>
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4914 @end example
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4915 the @code{+1m} is a repeater; the intended interpretation is that the
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4916 task has a deadline on <2005-10-01> and repeats itself every (one) month
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4917 starting from that time. If you need both a repeater and a special
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4918 warning period in a deadline entry, the repeater comes first and the
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4919 warning period last: @code{DEADLINE: <2005-10-01 Sat +1m -3d>}.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4920
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4921 Deadlines and scheduled items produce entries in the agenda when they
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4922 are over-due, so it is important to be able to mark such an entry as
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4923 completed once you have done so. When you mark a DEADLINE or a SCHEDULE
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4924 with the TODO keyword DONE, it will no longer produce entries in the
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4925 agenda. The problem with this is, however, that then also the
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4926 @emph{next} instance of the repeated entry will not be active. Org mode
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4927 deals with this in the following way: When you try to mark such an entry
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4928 DONE (using @kbd{C-c C-t}), it will shift the base date of the repeating
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4929 time stamp by the repeater interval, and immediately set the entry state
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4930 back to TODO. In the example above, setting the state to DONE would
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4931 actually switch the date like this:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4932
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4933 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4934 ** TODO Pay the rent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4935 DEADLINE: <2005-11-01 Tue +1m>
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4936 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4937
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4938 A timestamp@footnote{You can change this using the option
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4939 @code{org-log-repeat}, or the @code{#+STARTUP} options @code{logrepeat},
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4940 @code{lognoterepeat}, and @code{nologrepeat}. With @code{lognoterepeat}, you
101147
a62da64665d1 Fix some more typos.
Glenn Morris <rgm@gnu.org>
parents: 101146
diff changeset
4941 will also be prompted for a note.} will be added under the deadline, to keep
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4942 a record that you actually acted on the previous instance of this deadline.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4943
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4944 As a consequence of shifting the base date, this entry will no longer be
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4945 visible in the agenda when checking past dates, but all future instances
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4946 will be visible.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4947
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4948 With the @samp{+1m} cookie, the date shift will always be exactly one
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4949 month. So if you have not payed the rent for three months, marking this
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4950 entry DONE will still keep it as an overdue deadline. Depending on the
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4951 task, this may not be the best way to handle it. For example, if you
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4952 forgot to call you father for 3 weeks, it does not make sense to call
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4953 him 3 times in a single day to make up for it. Finally, there are tasks
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4954 like changing batteries which should always repeat a certain time
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4955 @i{after} the last time you did it. For these tasks, Org mode has
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4956 special repeaters markers with @samp{++} and @samp{.+}. For example:
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4957
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4958 @example
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4959 ** TODO Call Father
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4960 DEADLINE: <2008-02-10 Sun ++1w>
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4961 Marking this DONE will shift the date by at least one week,
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4962 but also by as many weeks as it takes to get this date into
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4963 the future. However, it stays on a Sunday, even if you called
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4964 and marked it done on Saturday.
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4965 ** TODO Check the batteries in the smoke detectors
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4966 DEADLINE: <2005-11-01 Tue .+1m>
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4967 Marking this DONE will shift the date to one month after
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4968 today.
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4969 @end example
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4970
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4971 You may have both scheduling and deadline information for a specific
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4972 task - just make sure that the repeater intervals on both are the same.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4973
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4974 @node Clocking work time, Effort estimates, Deadlines and scheduling, Dates and Times
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4975 @section Clocking work time
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4976
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4977 Org mode allows you to clock the time you spent on specific tasks in a
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4978 project. When you start working on an item, you can start the clock.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4979 When you stop working on that task, or when you mark the task done, the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4980 clock is stopped and the corresponding time interval is recorded. It
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4981 also computes the total time spent on each subtree of a project.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4982
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4983 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4984 @kindex C-c C-x C-i
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4985 @item C-c C-x C-i
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4986 Start the clock on the current item (clock-in). This inserts the CLOCK
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4987 keyword together with a timestamp. If this is not the first clocking of
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4988 this item, the multiple CLOCK lines will be wrapped into a
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4989 @code{:CLOCK:} drawer (see also the variable
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4990 @code{org-clock-into-drawer}). When called with a @kbd{C-u} prefix argument,
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4991 select the task from a list of recently clocked tasks. With two @kbd{C-u
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4992 C-u} prefixes, clock into the task at point and mark it as the default task.
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4993 The default task will always be available when selecting a clocking task,
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
4994 with letter @kbd{d}.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4995 @kindex C-c C-x C-o
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4996 @item C-c C-x C-o
101216
178b2fad42c1 * org.texi (Clocking work time): Fix typo.
Juanma Barranquero <lekktu@gmail.com>
parents: 101163
diff changeset
4997 Stop the clock (clock-out). This inserts another timestamp at the same
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4998 location where the clock was last started. It also directly computes
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4999 the resulting time in inserts it after the time range as @samp{=>
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5000 HH:MM}. See the variable @code{org-log-note-clock-out} for the
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5001 possibility to record an additional note together with the clock-out
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5002 time stamp@footnote{The corresponding in-buffer setting is:
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5003 @code{#+STARTUP: lognoteclock-out}}.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5004 @kindex C-c C-y
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5005 @item C-c C-y
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5006 Recompute the time interval after changing one of the time stamps. This
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5007 is only necessary if you edit the time stamps directly. If you change
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5008 them with @kbd{S-@key{cursor}} keys, the update is automatic.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5009 @kindex C-c C-t
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5010 @item C-c C-t
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5011 Changing the TODO state of an item to DONE automatically stops the clock
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5012 if it is running in this same item.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5013 @kindex C-c C-x C-x
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5014 @item C-c C-x C-x
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5015 Cancel the current clock. This is useful if a clock was started by
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5016 mistake, or if you ended up working on something else.
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5017 @kindex C-c C-x C-j
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5018 @item C-c C-x C-j
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5019 Jump to the entry that contains the currently running clock. With a
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5020 @kbd{C-u} prefix arg, select the target task from a list of recently clocked
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5021 tasks.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5022 @kindex C-c C-x C-d
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5023 @item C-c C-x C-d
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5024 Display time summaries for each subtree in the current buffer. This
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5025 puts overlays at the end of each headline, showing the total time
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5026 recorded under that heading, including the time of any subheadings. You
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5027 can use visibility cycling to study the tree, but the overlays disappear
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5028 when you change the buffer (see variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5029 @code{org-remove-highlights-with-change}) or press @kbd{C-c C-c}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5030 @kindex C-c C-x C-r
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5031 @item C-c C-x C-r
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5032 Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5033 report as an Org mode table into the current file. When the cursor is
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5034 at an existing clock table, just update it. When called with a prefix
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5035 argument, jump to the first clock report in the current document and
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5036 update it.
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
5037 @cindex #+BEGIN: clocktable
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5038 @example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5039 #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5040 #+END: clocktable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5041 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5042 @noindent
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5043 If such a block already exists at point, its content is replaced by the
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5044 new table. The @samp{BEGIN} line can specify options:
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5045 @example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5046 :maxlevel @r{Maximum level depth to which times are listed in the table.}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5047 :emphasize @r{When @code{t}, emphasize level one and level two items}
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5048 :scope @r{The scope to consider. This can be any of the following:}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5049 nil @r{the current buffer or narrowed region}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5050 file @r{the full current buffer}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5051 subtree @r{the subtree where the clocktable is located}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5052 treeN @r{the surrounding level N tree, for example @code{tree3}}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5053 tree @r{the surrounding level 1 tree}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5054 agenda @r{all agenda files}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5055 ("file"..) @r{scan these files}
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5056 file-with-archives @r{current file and its archives}
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5057 agenda-with-archives @r{all agenda files, including archives}
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5058 :block @r{The time block to consider. This block is specified either}
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5059 @r{absolute, or relative to the current time and may be any of}
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5060 @r{these formats:}
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5061 2007-12-31 @r{New year eve 2007}
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5062 2007-12 @r{December 2007}
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5063 2007-W50 @r{ISO-week 50 in 2007}
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5064 2007 @r{the year 2007}
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5065 today, yesterday, today-N @r{a relative day}
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5066 thisweek, lastweek, thisweek-N @r{a relative week}
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5067 thismonth, lastmonth, thismonth-N @r{a relative month}
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5068 thisyear, lastyear, thisyear-N @r{a relative year}
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5069 @r{Use @kbd{S-@key{left}/@key{right}} keys to shift the time interval.}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5070 :tstart @r{A time string specifying when to start considering times}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5071 :tend @r{A time string specifying when to stop considering times}
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5072 :step @r{@code{week} or @code{day}, to split the table into chunks.}
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5073 @r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.}
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5074 :link @r{Link the item headlines in the table to their origins}
99503
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
5075 :formula @r{Content of a @code{#+TBLFM} line to be added and evaluated.}
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
5076 @r{As a special case, @samp{:formula %} adds column with % time.}
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
5077 @r{If you do not specify a formula here, any existing formula}
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
5078 @r{below the clock table will survive updates and be evaluated.}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5079 @end example
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5080 So to get a clock summary of the current level 1 tree, for the current
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5081 day, you could write
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5082 @example
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5083 #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5084 #+END: clocktable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5085 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5086 and to use a specific time range you could write@footnote{Note that all
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5087 parameters must be specified in a single line - the line is broken here
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5088 only to fit it onto the manual.}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5089 @example
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5090 #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5091 :tend "<2006-08-10 Thu 12:00>"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5092 #+END: clocktable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5093 @end example
99503
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
5094 A summary of the current subtree with % times would be
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
5095 @example
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
5096 #+BEGIN: clocktable :scope subtree :link t :formula %
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
5097 #+END: clocktable
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
5098 @end example
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5099 @kindex C-c C-c
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5100 @item C-c C-c
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5101 @kindex C-c C-x C-u
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5102 @itemx C-c C-x C-u
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5103 Update dynamical block at point. The cursor needs to be in the
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5104 @code{#+BEGIN} line of the dynamic block.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5105 @kindex C-u C-c C-x C-u
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5106 @item C-u C-c C-x C-u
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5107 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5108 you have several clock table blocks in a buffer.
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5109 @kindex S-@key{left}
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5110 @kindex S-@key{right}
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5111 @item S-@key{left}
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5112 @itemx S-@key{right}
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5113 Shift the current @code{:block} interval and update the table. The cursor
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5114 needs to be in the @code{#+BEGIN: clocktable} line for this command. If
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5115 @code{:block} is @code{today}, it will be shifted to @code{today-1} etc.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5116 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5117
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5118 The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5119 the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5120 worked on or closed during a day.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5121
100271
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
5122 @node Effort estimates, Relative timer, Clocking work time, Dates and Times
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5123 @section Effort estimates
100271
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
5124 @cindex effort estimates
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5125
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5126 If you want to plan your work in a very detailed way, or if you need to
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5127 produce offers with quotations of the estimated work effort, you may want to
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5128 assign effort estimates to entries. If you are also clocking your work, you
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5129 may later want to compare the planned effort with the actual working time, a
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5130 great way to improve planning estimates. Effort estimates are stored in a
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5131 special property @samp{Effort}@footnote{You may change the property being
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5132 used with the variable @code{org-effort-property}.}. Clearly the best way to
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5133 work with effort estimates is through column view (@pxref{Column view}). You
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5134 should start by setting up discrete values for effort estimates, and a
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5135 @code{COLUMNS} format that displays these values together with clock sums (if
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5136 you want to clock your time). For a specific buffer you can use
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5137
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5138 @example
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5139 #+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00 8:00
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5140 #+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort)@{:@} %CLOCKSUM
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5141 @end example
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5142
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5143 @noindent
99139
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
5144 or, even better, you can set up these values globally by customizing the
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
5145 variables @code{org-global-properties} and @code{org-columns-default-format}.
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
5146 In particular if you want to use this setup also in the agenda, a global
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
5147 setup may be advised.
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5148
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5149 The way to assign estimates to individual items is then to switch to column
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5150 mode, and to use @kbd{S-@key{right}} and @kbd{S-@key{left}} to change the
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5151 value. The values you enter will immediately be summed up in the hierarchy.
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5152 In the column next to it, any clocked time will be displayed.
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5153
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5154 If you switch to column view in the daily/weekly agenda, the effort column
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5155 will summarize the estimated work effort for each day@footnote{Please note
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5156 the pitfalls of summing hierarchical data in a flat list (@pxref{Agenda
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
5157 column view}).}, and you can use this to find space in your schedule. To get
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5158 an overview of the entire part of the day that is committed, you can set the
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5159 option @code{org-agenda-columns-add-appointments-to-effort-sum}. The
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5160 appointments on a day that take place over a specified time interval will
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5161 then also be added to the load estimate of the day.
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5162
99139
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
5163 Effort estimates can be used in secondary agenda filtering that is triggered
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
5164 with the @kbd{/} key in the agenda (@pxref{Agenda commands}). If you have
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
5165 these estimates defined consistently, two or three key presses will narrow
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
5166 down the list to stuff that fits into an available time slot.
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5167
100271
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
5168 @node Relative timer, , Effort estimates, Dates and Times
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
5169 @section Taking notes with a relative timer
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
5170 @cindex relative timer
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
5171
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
5172 When taking notes during, for example, a meeting or a video viewing, it can
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
5173 be useful to have access to times relative to a starting time. Org provides
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
5174 such a relative timer and make it easy to create timed notes.
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
5175
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
5176 @table @kbd
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
5177 @kindex C-c C-x .
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
5178 @item C-c C-x .
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
5179 Insert a relative time into the buffer. The first time you use this, the
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
5180 timer will be started. When called with a prefix argument, the timer is
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
5181 restarted.
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
5182 @kindex C-c C-x -
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
5183 @item C-c C-x -
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
5184 Insert a description list item with the current relative time. With a prefix
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
5185 argument, first reset the timer to 0.
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
5186 @kindex M-@key{RET}
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
5187 @item M-@key{RET}
101273
497ab52cc072 Peter Tury <tury.peter at gmail.com> (tiny change)
Glenn Morris <rgm@gnu.org>
parents: 101216
diff changeset
5188 Once the timer list is started, you can also use @kbd{M-@key{RET}} to insert
100271
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
5189 new timer items.
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
5190 @kindex C-c C-x ,
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
5191 @item C-c C-x ,
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
5192 Pause the timer, or continue it if it is already paused. With prefix
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
5193 argument, stop it entirely.
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
5194 @kindex C-u C-c C-x ,
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
5195 @item C-u C-c C-x ,
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
5196 Stop the timer. After this, you can only start a new timer, not continue the
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
5197 old one. This command also removes the timer from the mode line.
100271
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
5198 @kindex C-c C-x 0
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
5199 @item C-c C-x 0
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
5200 Reset the timer without inserting anything into the buffer. By default, the
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
5201 timer is reset to 0. When called with a @kbd{C-u} prefix, reset the timer to
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
5202 specific starting offset. The user is prompted for the offset, with a
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
5203 default taken from a timer string at point, if any, So this can be used to
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
5204 restart taking notes after a break in the process. When called with a double
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
5205 prefix argument @kbd{C-c C-u}, change all timer strings in the active region
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
5206 by a certain amount. This can be used to fix timer strings if the timer was
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
5207 not started at exactly the right moment.
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
5208 @end table
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
5209
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5210 @node Capture, Agenda Views, Dates and Times, Top
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5211 @chapter Capture
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5212 @cindex capture
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5213
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5214 An important part of any organization system is the ability to quickly
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5215 capture new ideas and tasks, and to associate reference material with them.
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5216 Org uses the @file{remember} package to create tasks, and stores files
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5217 related to a task (@i{attachments}) in a special directory.
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5218
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5219 @menu
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5220 * Remember:: Capture new tasks/ideas with little interruption
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5221 * Attachments:: Add files to tasks.
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5222 @end menu
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5223
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5224 @node Remember, Attachments, Capture, Capture
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5225 @section Remember
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5226 @cindex @file{remember.el}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5227
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5228 The @i{Remember} package by John Wiegley lets you store quick notes with
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5229 little interruption of your work flow. See
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5230 @uref{http://www.emacswiki.org/cgi-bin/wiki/RememberMode} for more
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5231 information. It is an excellent way to add new notes and tasks to
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5232 Org files. Org significantly expands the possibilities of
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5233 @i{remember}: You may define templates for different note types, and
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5234 associate target files and headlines with specific templates. It also
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5235 allows you to select the location where a note should be stored
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5236 interactively, on the fly.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5237
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5238 @menu
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5239 * Setting up Remember:: Some code for .emacs to get things going
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5240 * Remember templates:: Define the outline of different note types
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5241 * Storing notes:: Directly get the note to where it belongs
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5242 * Refiling notes:: Moving a note or task to a project
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5243 @end menu
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5244
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5245 @node Setting up Remember, Remember templates, Remember, Remember
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5246 @subsection Setting up Remember
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5247
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5248 The following customization will tell @i{remember} to use org files as
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5249 target, and to create annotations compatible with Org links.
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5250
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5251 @example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5252 (org-remember-insinuate)
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5253 (setq org-directory "~/path/to/my/orgfiles/")
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5254 (setq org-default-notes-file (concat org-directory "/notes.org"))
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5255 (define-key global-map "\C-cr" 'org-remember)
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5256 @end example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5257
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5258 The last line binds the command @code{org-remember} to a global
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5259 key@footnote{Please select your own key, @kbd{C-c r} is only a
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5260 suggestion.}. @code{org-remember} basically just calls @code{remember},
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5261 but it makes a few things easier: If there is an active region, it will
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5262 automatically copy the region into the remember buffer. It also allows
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5263 to jump to the buffer and location where remember notes are being
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5264 stored: Just call @code{org-remember} with a prefix argument. If you
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5265 use two prefix arguments, Org jumps to the location where the last
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5266 remember note was stored.
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5267
99851
68981b04c1ac 2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99709
diff changeset
5268 The remember buffer will actually use @code{org-mode} as its major mode, so
68981b04c1ac 2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99709
diff changeset
5269 that all editing features of Org-mode are available. In addition to this, a
68981b04c1ac 2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99709
diff changeset
5270 minor mode @code{org-remember-mode} is turned on, for the single purpose that
68981b04c1ac 2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99709
diff changeset
5271 you can use its keymap @code{org-remember-mode-map} to overwrite some of
68981b04c1ac 2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99709
diff changeset
5272 Org-mode's key bindings.
68981b04c1ac 2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99709
diff changeset
5273
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
5274 You can also call @code{org-remember} in a special way from the agenda,
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
5275 using the @kbd{k r} key combination. With this access, any time stamps
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
5276 inserted by the selected remember template (see below) will default to
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
5277 the cursor date in the agenda, rather than to the current date.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
5278
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5279 @node Remember templates, Storing notes, Setting up Remember, Remember
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5280 @subsection Remember templates
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5281 @cindex templates, for remember
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5282
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5283 In combination with Org, you can use templates to generate
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5284 different types of @i{remember} notes. For example, if you would like
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5285 to use one template to create general TODO entries, another one for
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5286 journal entries, and a third one for collecting random ideas, you could
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5287 use:
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5288
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5289 @example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5290 (setq org-remember-templates
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5291 '(("Todo" ?t "* TODO %?\n %i\n %a" "~/org/TODO.org" "Tasks")
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5292 ("Journal" ?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org")
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5293 ("Idea" ?i "* %^@{Title@}\n %i\n %a" "~/org/JOURNAL.org" "New Ideas")))
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5294 @end example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5295
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5296 @noindent In these entries, the first string is just a name, and the
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5297 character specifies how to select the template. It is useful if the
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
5298 character is also the first letter of the name. The next string specifies
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
5299 the template. Two more (optional) strings give the file in which, and the
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
5300 headline under which the new note should be stored. The file (if not present
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
5301 or @code{nil}) defaults to @code{org-default-notes-file}, the heading to
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
5302 @code{org-remember-default-headline}. If the file name is not an absolute
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
5303 path, it will be interpreted relative to @code{org-directory}. The heading
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
5304 can also be the symbols @code{top} or @code{bottom} to send note as level 1
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
5305 entries to the beginning or end of the file, respectively.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
5306
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
5307 An optional sixth element specifies the contexts in which the user can select
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
5308 the template. This element can be a list of major modes or a function.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
5309 @code{org-remember} will first check whether the function returns @code{t} or
101147
a62da64665d1 Fix some more typos.
Glenn Morris <rgm@gnu.org>
parents: 101146
diff changeset
5310 if we are in any of the listed major mode, and exclude templates for which
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
5311 this condition is not fulfilled. Templates that do not specify this element
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
5312 at all, or that use @code{nil} or @code{t} as a value will always be
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
5313 selectable.
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5314
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5315 So for example:
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5316
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5317 @example
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5318 (setq org-remember-templates
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5319 '(("Bug" ?b "* BUG %?\n %i\n %a" "~/org/BUGS.org" "Bugs" (emacs-lisp-mode))
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
5320 ("Journal" ?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org" "X" my-check)
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5321 ("Idea" ?i "* %^@{Title@}\n %i\n %a" "~/org/JOURNAL.org" "New Ideas")))
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5322 @end example
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5323
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5324 The first template will only be available when invoking @code{org-remember}
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5325 from an buffer in @code{emacs-lisp-mode}. The second template will only be
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5326 available when the function @code{my-check} returns @code{t}. The third
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5327 template will be proposed in any context.
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5328
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
5329 When you call @kbd{M-x org-remember} (or @kbd{M-x remember}) to remember
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
5330 something, Org will prompt for a key to select the template (if you have
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5331 more than one template) and then prepare the buffer like
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5332 @example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5333 * TODO
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5334 [[file:link to where you called remember]]
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5335 @end example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5336
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5337 @noindent
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5338 During expansion of the template, special @kbd{%}-escapes allow dynamic
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5339 insertion of content:
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5340 @example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5341 %^@{prompt@} @r{prompt the user for a string and replace this sequence with it.}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5342 @r{You may specify a default value and a completion table with}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5343 @r{%^@{prompt|default|completion2|completion3...@}}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5344 @r{The arrow keys access a prompt-specific history.}
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
5345 %a @r{annotation, normally the link created with @code{org-store-link}}
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
5346 %A @r{like @code{%a}, but prompt for the description part}
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
5347 %i @r{initial content, the region when remember is called with C-u.}
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
5348 @r{The entire text will be indented like @code{%i} itself.}
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5349 %t @r{time stamp, date only}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5350 %T @r{time stamp with date and time}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5351 %u, %U @r{like the above, but inactive time stamps}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5352 %^t @r{like @code{%t}, but prompt for date. Similarly @code{%^T}, @code{%^u}, @code{%^U}}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5353 @r{You may define a prompt like @code{%^@{Birthday@}t}}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5354 %n @r{user name (taken from @code{user-full-name})}
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5355 %c @r{Current kill ring head.}
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5356 %x @r{Content of the X clipboard.}
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5357 %^C @r{Interactive selection of which kill or clip to use.}
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5358 %^L @r{Like @code{%^C}, but insert as link.}
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5359 %^g @r{prompt for tags, with completion on tags in target file.}
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5360 %k @r{title of currently clocked task}
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5361 %K @r{link to currently clocked task}
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5362 %^G @r{prompt for tags, with completion all tags in all agenda files.}
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5363 %^@{prop@}p @r{Prompt the user for a value for property @code{prop}}
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5364 %:keyword @r{specific information for certain link types, see below}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5365 %[pathname] @r{insert the contents of the file given by @code{pathname}}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5366 %(sexp) @r{evaluate elisp @code{(sexp)} and replace with the result}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5367 %! @r{immediately store note after completing the template}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5368 @r{(skipping the @kbd{C-c C-c} that normally triggers storing)}
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
5369 %& @r{jump to target location immediately after storing note}
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5370 @end example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5371
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5372 @noindent
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5373 For specific link types, the following keywords will be
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5374 defined@footnote{If you define your own link types (@pxref{Adding
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5375 hyperlink types}), any property you store with
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5376 @code{org-store-link-props} can be accessed in remember templates in a
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5377 similar way.}:
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5378
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5379 @example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5380 Link type | Available keywords
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5381 -------------------+----------------------------------------------
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5382 bbdb | %:name %:company
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5383 bbdb | %::server %:port %:nick
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5384 vm, wl, mh, rmail | %:type %:subject %:message-id
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5385 | %:from %:fromname %:fromaddress
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5386 | %:to %:toname %:toaddress
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5387 | %:fromto @r{(either "to NAME" or "from NAME")@footnote{This will always be the other, not the user. See the variable @code{org-from-is-user-regexp}.}}
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5388 gnus | %:group, @r{for messages also all email fields}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5389 w3, w3m | %:url
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5390 info | %:file %:node
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5391 calendar | %:date"
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5392 @end example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5393
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5394 @noindent
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5395 To place the cursor after template expansion use:
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5396
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5397 @example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5398 %? @r{After completing the template, position cursor here.}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5399 @end example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5400
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5401 @noindent
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5402 If you change your mind about which template to use, call
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5403 @code{org-remember} in the remember buffer. You may then select a new
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5404 template that will be filled with the previous context information.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5405
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5406 @node Storing notes, Refiling notes, Remember templates, Remember
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5407 @subsection Storing notes
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5408
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
5409 When you are finished preparing a note with @i{remember}, you have to press
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
5410 @kbd{C-c C-c} to file the note away. If you have started the clock in the
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
5411 remember buffer, you will first be asked if you want to clock out
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
5412 now@footnote{To avoid this query, configure the variable
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
5413 @code{org-remember-clock-out-on-exit}.}. If you answer @kbd{n}, the clock
96976
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
5414 will continue to run after the note was filed away.
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
5415
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
5416 The handler will then store the note in the file and under the headline
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
5417 specified in the template, or it will use the default file and headlines.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
5418 The window configuration will be restored, sending you back to the working
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
5419 context before the call to @code{remember}. To re-use the location found
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
5420 during the last call to @code{remember}, exit the remember buffer with
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5421 @kbd{C-0 C-c C-c}, i.e. specify a zero prefix argument to @kbd{C-c C-c}.
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5422 Another special case is @kbd{C-2 C-c C-c} which files the note as a child of
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5423 the currently clocked item.
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5424
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5425 If you want to store the note directly to a different place, use
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5426 @kbd{C-1 C-c C-c} instead to exit remember@footnote{Configure the
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5427 variable @code{org-remember-store-without-prompt} to make this behavior
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5428 the default.}. The handler will then first prompt for a target file -
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5429 if you press @key{RET}, the value specified for the template is used.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5430 Then the command offers the headings tree of the selected file, with the
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5431 cursor position at the default headline (if you had specified one in the
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5432 template). You can either immediately press @key{RET} to get the note
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5433 placed there. Or you can use the following keys to find a different
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5434 location:
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5435 @example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5436 @key{TAB} @r{Cycle visibility.}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5437 @key{down} / @key{up} @r{Next/previous visible headline.}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5438 n / p @r{Next/previous visible headline.}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5439 f / b @r{Next/previous headline same level.}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5440 u @r{One level up.}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5441 @c 0-9 @r{Digit argument.}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5442 @end example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5443 @noindent
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5444 Pressing @key{RET} or @key{left} or @key{right}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5445 then leads to the following result.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5446
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5447 @multitable @columnfractions 0.2 0.15 0.65
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5448 @item @b{Cursor position} @tab @b{Key} @tab @b{Note gets inserted}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5449 @item on headline @tab @key{RET} @tab as sublevel of the heading at cursor, first or last
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5450 @item @tab @tab depending on @code{org-reverse-note-order}.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5451 @item @tab @key{left}/@key{right} @tab as same level, before/after current heading
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5452 @item buffer-start @tab @key{RET} @tab as level 2 heading at end of file or level 1 at beginning
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5453 @item @tab @tab depending on @code{org-reverse-note-order}.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5454 @item not on headline @tab @key{RET}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5455 @tab at cursor position, level taken from context.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5456 @end multitable
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5457
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5458 Before inserting the text into a tree, the function ensures that the text has
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5459 a headline, i.e. a first line that starts with a @samp{*}. If not, a
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5460 headline is constructed from the current date. If you have indented the text
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5461 of the note below the headline, the indentation will be adapted if inserting
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5462 the note into the tree requires demotion from level 1.
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5463
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5464 @node Refiling notes, , Storing notes, Remember
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5465 @subsection Refiling notes
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5466 @cindex refiling notes
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5467
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5468 Remember is usually used to quickly capture notes and tasks into one or
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5469 a few capture lists. When reviewing the captured data, you may want to
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5470 refile some of the entries into a different list, for example into a
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5471 project. Cutting, finding the right location and then pasting the note
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5472 is cumbersome. To simplify this process, you can use the following
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5473 special command:
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5474
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5475 @table @kbd
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5476 @kindex C-c C-w
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5477 @item C-c C-w
99503
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
5478 Refile the entry or region at point. This command offers possible locations
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
5479 for refiling the entry and lets you select one with completion. The item (or
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
5480 all items in the region) is filed below the target heading as a subitem.
99868
404f28130174 *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 99851
diff changeset
5481 Depending on @code{org-reverse-note-order}, it will be either the first or
99503
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
5482 last subitem.@*
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
5483 By default, all level 1 headlines in the current buffer are considered to be
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
5484 targets, but you can have more complex definitions across a number of files.
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
5485 See the variable @code{org-refile-targets} for details. If you would like to
99868
404f28130174 *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 99851
diff changeset
5486 select a location via a file-path-like completion along the outline path, see
404f28130174 *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 99851
diff changeset
5487 the variables @code{org-refile-use-outline-path} and
404f28130174 *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 99851
diff changeset
5488 @code{org-outline-path-complete-in-steps}.
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5489 @kindex C-u C-c C-w
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5490 @item C-u C-c C-w
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5491 Use the refile interface to jump to a heading.
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5492 @kindex C-u C-u C-c C-w
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5493 @item C-u C-u C-c C-w
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5494 Jump to the location where @code{org-refile} last moved a tree to.
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5495 @end table
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5496
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5497 @node Attachments, , Remember, Capture
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5498 @section Attachments
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5499 @cindex attachments
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5500
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5501 It is often useful to associate reference material with an outline node/task.
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5502 Small chunks of plain text can simply be stored in the subtree of a project.
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5503 Hyperlinks (@pxref{Hyperlinks}) can be used to establish associations with
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5504 files that live elsewhere on your computer or in the cloud, like emails or
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5505 source code files belonging to a project. Another method is @i{attachments},
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5506 which are files located in a directory belonging to an outline node. Org
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5507 uses directories named by the unique ID of each entry. These directories are
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5508 located in the @file{data} directory which lives in the same directory where
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5509 your org-file lives@footnote{If you move entries or Org-files from one
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5510 directory to the next, you may want to configure @code{org-attach-directory}
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5511 to contain an absolute path.}. If you initialize this directory with
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5512 @code{git-init}, Org will automatically commit changes when it sees them.
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5513 The attachment system has been contributed to Org by John Wiegley.
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5514
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
5515 In cases where this seems better, you can also attach a directory of your
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
5516 choice to an entry. You can also make children inherit the attachment
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
5517 directory from a parent, so that an entire subtree uses the same attached
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
5518 directory.
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
5519
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5520 @noindent The following commands deal with attachments.
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5521
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5522 @table @kbd
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5523
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5524 @kindex C-c C-a
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5525 @item C-c C-a
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5526 The dispatcher for commands related to the attachment system. After these
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5527 keys, a list of commands is displayed and you need to press an additional key
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5528 to select a command:
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5529
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5530 @table @kbd
100271
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
5531 @kindex C-c C-a a
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
5532 @item a
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5533 Select a file and move it into the task's attachment directory. The file
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5534 will be copied, moved, or linked, depending on @code{org-attach-method}.
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5535 Note that hard links are not supported on all systems.
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5536
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5537 @kindex C-c C-a c
100271
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
5538 @kindex C-c C-a m
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
5539 @kindex C-c C-a l
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5540 @item c/m/l
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5541 Attach a file using the copy/move/link method.
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5542 Note that hard links are not supported on all systems.
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5543
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5544 @kindex C-c C-a n
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5545 @item n
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5546 Create a new attachment as an Emacs buffer.
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5547
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5548 @kindex C-c C-a z
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5549 @item z
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5550 Synchronize the current task with its attachment directory, in case you added
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5551 attachments yourself.
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5552
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5553 @kindex C-c C-a o
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5554 @item o
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5555 Open current task's attachment. If there are more than one, prompt for a
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5556 file name first. Opening will follow the rules set by @code{org-file-apps}.
101147
a62da64665d1 Fix some more typos.
Glenn Morris <rgm@gnu.org>
parents: 101146
diff changeset
5557 For more details, see the information on following hyperlinks
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5558 (@pxref{Handling links}).
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5559
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5560 @kindex C-c C-a O
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5561 @item O
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5562 Also open the attachment, but force opening the file in Emacs.
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5563
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5564 @kindex C-c C-a f
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5565 @item f
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5566 Open the current task's attachment directory.
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5567
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5568 @kindex C-c C-a F
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5569 @item F
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5570 Also open the directory, but force using @code{dired} in Emacs.
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5571
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5572 @kindex C-c C-a d
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5573 @item d
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5574 Select and delete a single attachment.
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5575
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5576 @kindex C-c C-a D
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5577 @item D
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5578 Delete all of a task's attachments. A safer way is to open the directory in
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5579 dired and delete from there.
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
5580
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
5581 @kindex C-c C-a s
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
5582 @item C-c C-a s
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
5583 Set a specific directory as the entry's attachment directory. This works by
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
5584 putting the directory path into the @code{ATTACH_DIR} property.
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
5585
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
5586 @kindex C-c C-a i
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
5587 @item C-c C-a i
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
5588 Set the @code{ATTACH_DIR_INHERIT} property, so that children will use the
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
5589 same directory for attachments as the parent.
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5590 @end table
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5591 @end table
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5592
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5593 @node Agenda Views, Embedded LaTeX, Capture, Top
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5594 @chapter Agenda Views
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5595 @cindex agenda views
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5596
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5597 Due to the way Org works, TODO items, time-stamped items, and
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5598 tagged headlines can be scattered throughout a file or even a number of
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5599 files. To get an overview of open action items, or of events that are
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5600 important for a particular date, this information must be collected,
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5601 sorted and displayed in an organized way.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5602
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5603 Org can select items based on various criteria, and display them
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5604 in a separate buffer. Seven different view types are provided:
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5605
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5606 @itemize @bullet
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5607 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5608 an @emph{agenda} that is like a calendar and shows information
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5609 for specific dates,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5610 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5611 a @emph{TODO list} that covers all unfinished
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5612 action items,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5613 @item
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5614 a @emph{match view}, showings headlines based on the tags, properties and
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5615 TODO state associated with them,
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5616 @item
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5617 a @emph{timeline view} that shows all events in a single Org file,
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5618 in time-sorted view,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5619 @item
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5620 a @emph{keyword search view} that shows all entries from multiple files
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5621 that contain specified keywords.
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5622 @item
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5623 a @emph{stuck projects view} showing projects that currently don't move
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5624 along, and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5625 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5626 @emph{custom views} that are special tag/keyword searches and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5627 combinations of different views.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5628 @end itemize
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5629
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5630 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5631 The extracted information is displayed in a special @emph{agenda
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5632 buffer}. This buffer is read-only, but provides commands to visit the
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5633 corresponding locations in the original Org files, and even to
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5634 edit these files remotely.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5635
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5636 Two variables control how the agenda buffer is displayed and whether the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5637 window configuration is restored when the agenda exits:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5638 @code{org-agenda-window-setup} and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5639 @code{org-agenda-restore-windows-after-quit}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5640
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5641 @menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5642 * Agenda files:: Files being searched for agenda information
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5643 * Agenda dispatcher:: Keyboard access to agenda views
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5644 * Built-in agenda views:: What is available out of the box?
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5645 * Presentation and sorting:: How agenda items are prepared for display
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5646 * Agenda commands:: Remote editing of Org trees
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5647 * Custom agenda views:: Defining special searches and views
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5648 * Agenda column view:: Using column view for collected entries
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5649 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5650
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5651 @node Agenda files, Agenda dispatcher, Agenda Views, Agenda Views
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5652 @section Agenda files
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5653 @cindex agenda files
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5654 @cindex files for agenda
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5655
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5656 The information to be shown is normally collected from all @emph{agenda
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5657 files}, the files listed in the variable
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5658 @code{org-agenda-files}@footnote{If the value of that variable is not a
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5659 list, but a single file name, then the list of agenda files will be
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5660 maintained in that external file.}. If a directory is part of this list,
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5661 all files with the extension @file{.org} in this directory will be part
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5662 of the list.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5663
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5664 Thus even if you only work with a single Org file, this file should
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5665 be put into that list@footnote{When using the dispatcher, pressing
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5666 @kbd{<} before selecting a command will actually limit the command to
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5667 the current file, and ignore @code{org-agenda-files} until the next
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5668 dispatcher command.}. You can customize @code{org-agenda-files}, but
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5669 the easiest way to maintain it is through the following commands
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5670
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5671 @cindex files, adding to agenda list
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5672 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5673 @kindex C-c [
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5674 @item C-c [
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5675 Add current file to the list of agenda files. The file is added to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5676 the front of the list. If it was already in the list, it is moved to
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5677 the front. With a prefix argument, file is added/moved to the end.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5678 @kindex C-c ]
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5679 @item C-c ]
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5680 Remove current file from the list of agenda files.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5681 @kindex C-,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5682 @kindex C-'
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5683 @item C-,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5684 @itemx C-'
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5685 Cycle through agenda file list, visiting one file after the other.
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5686 @kindex M-x org-iswitchb
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5687 @item M-x org-iswitchb
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5688 Command to use an @code{iswitchb}-like interface to switch to and between Org
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5689 buffers.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5690 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5691
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5692 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5693 The Org menu contains the current list of files and can be used
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5694 to visit any of them.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5695
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5696 If you would like to focus the agenda temporarily onto a file not in
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5697 this list, or onto just one file in the list or even only a subtree in a
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5698 file, this can be done in different ways. For a single agenda command,
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5699 you may press @kbd{<} once or several times in the dispatcher
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5700 (@pxref{Agenda dispatcher}). To restrict the agenda scope for an
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5701 extended period, use the following commands:
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5702
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5703 @table @kbd
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5704 @kindex C-c C-x <
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5705 @item C-c C-x <
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5706 Permanently restrict the agenda to the current subtree. When with a
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5707 prefix argument, or with the cursor before the first headline in a file,
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5708 the agenda scope is set to the entire file. This restriction remains in
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5709 effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5710 or @kbd{>} in the agenda dispatcher. If there is a window displaying an
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5711 agenda view, the new restriction takes effect immediately.
100450
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
5712 @kindex C-c C-x >
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
5713 @item C-c C-x >
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5714 Remove the permanent restriction created by @kbd{C-c C-x <}.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5715 @end table
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5716
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5717 @noindent
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5718 When working with @file{Speedbar}, you can use the following commands in
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5719 the Speedbar frame:
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5720 @table @kbd
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5721 @kindex <
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5722 @item < @r{in the speedbar frame}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5723 Permanently restrict the agenda to the item at the cursor in the
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5724 Speedbar frame, either an Org file or a subtree in such a file.
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5725 If there is a window displaying an agenda view, the new restriction takes
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5726 effect immediately.
100450
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
5727 @kindex >
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5728 @item > @r{in the speedbar frame}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5729 Lift the restriction again.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5730 @end table
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5731
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5732 @node Agenda dispatcher, Built-in agenda views, Agenda files, Agenda Views
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5733 @section The agenda dispatcher
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5734 @cindex agenda dispatcher
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5735 @cindex dispatching agenda commands
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5736 The views are created through a dispatcher that should be bound to a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5737 global key, for example @kbd{C-c a} (@pxref{Installation}). In the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5738 following we will assume that @kbd{C-c a} is indeed how the dispatcher
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5739 is accessed and list keyboard access to commands accordingly. After
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5740 pressing @kbd{C-c a}, an additional letter is required to execute a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5741 command. The dispatcher offers the following default commands:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5742 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5743 @item a
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5744 Create the calendar-like agenda (@pxref{Weekly/daily agenda}).
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5745 @item t @r{/} T
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5746 Create a list of all TODO items (@pxref{Global TODO list}).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5747 @item m @r{/} M
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5748 Create a list of headlines matching a TAGS expression (@pxref{Matching
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5749 tags and properties}).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5750 @item L
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5751 Create the timeline view for the current buffer (@pxref{Timeline}).
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5752 @item s
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5753 Create a list of entries selected by a boolean expression of keywords
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5754 and/or regular expressions that must or must not occur in the entry.
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5755 @item /
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5756 Search for a regular expression in all agenda files and additionally in
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5757 the files listed in @code{org-agenda-multi-occur-extra-files}. This
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5758 uses the Emacs command @code{multi-occur}. A prefix argument can be
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5759 used to specify the number of context lines for each match, default is
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5760 1.
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5761 @item # @r{/} !
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5762 Create a list of stuck projects (@pxref{Stuck projects}).
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5763 @item <
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5764 Restrict an agenda command to the current buffer@footnote{For backward
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5765 compatibility, you can also press @kbd{1} to restrict to the current
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5766 buffer.}. After pressing @kbd{<}, you still need to press the character
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5767 selecting the command.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5768 @item < <
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5769 If there is an active region, restrict the following agenda command to
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5770 the region. Otherwise, restrict it to the current subtree@footnote{For
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5771 backward compatibility, you can also press @kbd{0} to restrict to the
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5772 current buffer.}. After pressing @kbd{< <}, you still need to press the
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5773 character selecting the command.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5774 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5775
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5776 You can also define custom commands that will be accessible through the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5777 dispatcher, just like the default commands. This includes the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5778 possibility to create extended agenda buffers that contain several
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5779 blocks together, for example the weekly agenda, the global TODO list and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5780 a number of special tags matches. @xref{Custom agenda views}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5781
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5782 @node Built-in agenda views, Presentation and sorting, Agenda dispatcher, Agenda Views
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5783 @section The built-in agenda views
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5784
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5785 In this section we describe the built-in views.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5786
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5787 @menu
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5788 * Weekly/daily agenda:: The calendar page with current tasks
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5789 * Global TODO list:: All unfinished action items
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5790 * Matching tags and properties:: Structured information with fine-tuned search
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5791 * Timeline:: Time-sorted view for single file
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5792 * Keyword search:: Finding entries by keyword
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5793 * Stuck projects:: Find projects you need to review
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5794 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5795
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5796 @node Weekly/daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5797 @subsection The weekly/daily agenda
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5798 @cindex agenda
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5799 @cindex weekly agenda
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5800 @cindex daily agenda
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5801
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5802 The purpose of the weekly/daily @emph{agenda} is to act like a page of a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5803 paper agenda, showing all the tasks for the current week or day.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5804
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5805 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5806 @cindex org-agenda, command
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5807 @kindex C-c a a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5808 @item C-c a a
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5809 Compile an agenda for the current week from a list of org files. The agenda
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5810 shows the entries for each day. With a numeric prefix@footnote{For backward
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5811 compatibility, the universal prefix @kbd{C-u} causes all TODO entries to be
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5812 listed before the agenda. This feature is deprecated, use the dedicated TODO
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5813 list, or a block agenda instead (@pxref{Block agenda}).} (like @kbd{C-u 2 1
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5814 C-c a a}) you may set the number of days to be displayed (see also the
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5815 variable @code{org-agenda-ndays})
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5816 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5817
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5818 Remote editing from the agenda buffer means, for example, that you can
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5819 change the dates of deadlines and appointments from the agenda buffer.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5820 The commands available in the Agenda buffer are listed in @ref{Agenda
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5821 commands}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5822
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5823 @subsubheading Calendar/Diary integration
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5824 @cindex calendar integration
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5825 @cindex diary integration
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5826
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5827 Emacs contains the calendar and diary by Edward M. Reingold. The
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5828 calendar displays a three-month calendar with holidays from different
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5829 countries and cultures. The diary allows you to keep track of
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5830 anniversaries, lunar phases, sunrise/set, recurrent appointments
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5831 (weekly, monthly) and more. In this way, it is quite complementary to
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5832 Org. It can be very useful to combine output from Org with
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5833 the diary.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5834
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5835 In order to include entries from the Emacs diary into Org mode's
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5836 agenda, you only need to customize the variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5837
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5838 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5839 (setq org-agenda-include-diary t)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5840 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5841
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5842 @noindent After that, everything will happen automatically. All diary
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5843 entries including holidays, anniversaries etc will be included in the
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5844 agenda buffer created by Org mode. @key{SPC}, @key{TAB}, and
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5845 @key{RET} can be used from the agenda buffer to jump to the diary
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5846 file in order to edit existing diary entries. The @kbd{i} command to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5847 insert new entries for the current date works in the agenda buffer, as
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5848 well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5849 Sunrise/Sunset times, show lunar phases and to convert to other
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5850 calendars, respectively. @kbd{c} can be used to switch back and forth
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5851 between calendar and agenda.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5852
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5853 If you are using the diary only for sexp entries and holidays, it is
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5854 faster to not use the above setting, but instead to copy or even move
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5855 the entries into an Org file. Org mode evaluates diary-style sexp
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5856 entries, and does it faster because there is no overhead for first
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5857 creating the diary display. Note that the sexp entries must start at
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5858 the left margin, no white space is allowed before them. For example,
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5859 the following segment of an Org file will be processed and entries
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5860 will be made in the agenda:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5861
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5862 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5863 * Birthdays and similar stuff
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5864 #+CATEGORY: Holiday
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5865 %%(org-calendar-holiday) ; special function for holiday names
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5866 #+CATEGORY: Ann
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5867 %%(diary-anniversary 14 5 1956) Arthur Dent is %d years old
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5868 %%(diary-anniversary 2 10 1869) Mahatma Gandhi would be %d years old
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5869 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5870
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5871 @subsubheading Appointment reminders
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5872 @cindex @file{appt.el}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5873 @cindex appointment reminders
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5874
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5875 Org can interact with Emacs appointments notification facility.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5876
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5877 To add all the appointments of your agenda files, use the command
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5878 @code{org-agenda-to-appt}. This commands also lets you filter through
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5879 the list of your appointments and add only those belonging to a specific
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5880 category or matching a regular expression. See the docstring for
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5881 details.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5882
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5883 @node Global TODO list, Matching tags and properties, Weekly/daily agenda, Built-in agenda views
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5884 @subsection The global TODO list
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5885 @cindex global TODO list
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5886 @cindex TODO list, global
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5887
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5888 The global TODO list contains all unfinished TODO items, formatted and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5889 collected into a single place.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5890
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5891 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5892 @kindex C-c a t
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5893 @item C-c a t
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5894 Show the global TODO list. This collects the TODO items from all
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5895 agenda files (@pxref{Agenda Views}) into a single buffer. The buffer is in
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5896 @code{agenda-mode}, so there are commands to examine and manipulate
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5897 the TODO entries directly from that buffer (@pxref{Agenda commands}).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5898 @kindex C-c a T
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5899 @item C-c a T
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5900 @cindex TODO keyword matching
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5901 Like the above, but allows selection of a specific TODO keyword. You
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5902 can also do this by specifying a prefix argument to @kbd{C-c a t}. With
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5903 a @kbd{C-u} prefix you are prompted for a keyword, and you may also
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5904 specify several keywords by separating them with @samp{|} as boolean OR
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5905 operator. With a numeric prefix, the Nth keyword in
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5906 @code{org-todo-keywords} is selected.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5907 @kindex r
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5908 The @kbd{r} key in the agenda buffer regenerates it, and you can give
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5909 a prefix argument to this command to change the selected TODO keyword,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5910 for example @kbd{3 r}. If you often need a search for a specific
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5911 keyword, define a custom command for it (@pxref{Agenda dispatcher}).@*
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5912 Matching specific TODO keywords can also be done as part of a tags
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5913 search (@pxref{Tag searches}).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5914 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5915
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5916 Remote editing of TODO items means that you can change the state of a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5917 TODO entry with a single key press. The commands available in the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5918 TODO list are described in @ref{Agenda commands}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5919
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5920 @cindex sublevels, inclusion into TODO list
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5921 Normally the global TODO list simply shows all headlines with TODO
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5922 keywords. This list can become very long. There are two ways to keep
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5923 it more compact:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5924 @itemize @minus
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5925 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5926 Some people view a TODO item that has been @emph{scheduled} for
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5927 execution (@pxref{Timestamps}) as no longer @emph{open}. Configure the
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5928 variable @code{org-agenda-todo-ignore-scheduled} to exclude scheduled
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5929 items from the global TODO list.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5930 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5931 TODO items may have sublevels to break up the task into subtasks. In
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5932 such cases it may be enough to list only the highest level TODO headline
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5933 and omit the sublevels from the global list. Configure the variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5934 @code{org-agenda-todo-list-sublevels} to get this behavior.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5935 @end itemize
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5936
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5937 @node Matching tags and properties, Timeline, Global TODO list, Built-in agenda views
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5938 @subsection Matching tags and properties
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5939 @cindex matching, of tags
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5940 @cindex matching, of properties
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5941 @cindex tags view
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
5942 @cindex match view
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5943
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5944 If headlines in the agenda files are marked with @emph{tags}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5945 (@pxref{Tags}), you can select headlines based on the tags that apply
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5946 to them and collect them into an agenda buffer.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5947
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5948 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5949 @kindex C-c a m
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5950 @item C-c a m
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5951 Produce a list of all headlines that match a given set of tags. The
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5952 command prompts for a selection criterion, which is a boolean logic
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5953 expression with tags, like @samp{+work+urgent-withboss} or
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5954 @samp{work|home} (@pxref{Tags}). If you often need a specific search,
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5955 define a custom command for it (@pxref{Agenda dispatcher}).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5956 @kindex C-c a M
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5957 @item C-c a M
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5958 Like @kbd{C-c a m}, but only select headlines that are also TODO items
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5959 and force checking subitems (see variable
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5960 @code{org-tags-match-list-sublevels}). Matching specific TODO keywords
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5961 together with a tags match is also possible, see @ref{Tag searches}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5962 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5963
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5964 The commands available in the tags list are described in @ref{Agenda
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5965 commands}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5966
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5967 @node Timeline, Keyword search, Matching tags and properties, Built-in agenda views
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5968 @subsection Timeline for a single file
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5969 @cindex timeline, single file
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5970 @cindex time-sorted view
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5971
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5972 The timeline summarizes all time-stamped items from a single Org mode
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5973 file in a @emph{time-sorted view}. The main purpose of this command is
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5974 to give an overview over events in a project.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5975
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5976 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5977 @kindex C-c a L
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5978 @item C-c a L
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5979 Show a time-sorted view of the org file, with all time-stamped items.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5980 When called with a @kbd{C-u} prefix, all unfinished TODO entries
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5981 (scheduled or not) are also listed under the current date.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5982 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5983
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5984 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5985 The commands available in the timeline buffer are listed in
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5986 @ref{Agenda commands}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5987
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5988 @node Keyword search, Stuck projects, Timeline, Built-in agenda views
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5989 @subsection Keyword search
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5990 @cindex keyword search
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5991 @cindex searching, for keywords
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5992
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
5993 This agenda view is a general text search facility for Org mode entries.
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5994 It is particularly useful to find notes.
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5995
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5996 @table @kbd
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5997 @kindex C-c a s
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5998 @item C-c a s
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5999 This is a special search that lets you select entries by keywords or
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6000 regular expression, using a boolean logic. For example, the search
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6001 string
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6002
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6003 @example
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6004 +computer +wifi -ethernet -@{8\.11[bg]@}
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6005 @end example
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6006
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6007 @noindent
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6008 will search for note entries that contain the keywords @code{computer}
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6009 and @code{wifi}, but not the keyword @code{ethernet}, and which are also
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6010 not matched by the regular expression @code{8\.11[bg]}, meaning to
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6011 exclude both 8.11b and 8.11g.
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6012
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6013 Note that in addition to the agenda files, this command will also search
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6014 the files listed in @code{org-agenda-text-search-extra-files}.
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6015 @end table
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6016
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6017 @node Stuck projects, , Keyword search, Built-in agenda views
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6018 @subsection Stuck projects
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6019
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6020 If you are following a system like David Allen's GTD to organize your
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6021 work, one of the ``duties'' you have is a regular review to make sure
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6022 that all projects move along. A @emph{stuck} project is a project that
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6023 has no defined next actions, so it will never show up in the TODO lists
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6024 Org mode produces. During the review, you need to identify such
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6025 projects and define next actions for them.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6026
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6027 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6028 @kindex C-c a #
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6029 @item C-c a #
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6030 List projects that are stuck.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6031 @kindex C-c a !
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6032 @item C-c a !
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6033 Customize the variable @code{org-stuck-projects} to define what a stuck
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6034 project is and how to find it.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6035 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6036
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6037 You almost certainly will have to configure this view before it will
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6038 work for you. The built-in default assumes that all your projects are
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6039 level-2 headlines, and that a project is not stuck if it has at least
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6040 one entry marked with a TODO keyword TODO or NEXT or NEXTACTION.
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6041
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
6042 Let's assume that you, in your own way of using Org mode, identify
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6043 projects with a tag PROJECT, and that you use a TODO keyword MAYBE to
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
6044 indicate a project that should not be considered yet. Let's further
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6045 assume that the TODO keyword DONE marks finished projects, and that NEXT
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6046 and TODO indicate next actions. The tag @@SHOP indicates shopping and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6047 is a next action even without the NEXT tag. Finally, if the project
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6048 contains the special word IGNORE anywhere, it should not be listed
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6049 either. In this case you would start by identifying eligible projects
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6050 with a tags/todo match @samp{+PROJECT/-MAYBE-DONE}, and then check for
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6051 TODO, NEXT, @@SHOP, and IGNORE in the subtree to identify projects that
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6052 are not stuck. The correct customization for this is
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6053
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6054 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6055 (setq org-stuck-projects
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6056 '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP")
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6057 "\\<IGNORE\\>"))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6058 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6059
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6060
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6061 @node Presentation and sorting, Agenda commands, Built-in agenda views, Agenda Views
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6062 @section Presentation and sorting
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6063 @cindex presentation, of agenda items
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6064
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6065 Before displaying items in an agenda view, Org mode visually prepares
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6066 the items and sorts them. Each item occupies a single line. The line
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6067 starts with a @emph{prefix} that contains the @emph{category}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6068 (@pxref{Categories}) of the item and other important information. You can
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6069 customize the prefix using the option @code{org-agenda-prefix-format}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6070 The prefix is followed by a cleaned-up version of the outline headline
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6071 associated with the item.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6072
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6073 @menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6074 * Categories:: Not all tasks are equal
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6075 * Time-of-day specifications:: How the agenda knows the time
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6076 * Sorting of agenda items:: The order of things
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6077 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6078
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6079 @node Categories, Time-of-day specifications, Presentation and sorting, Presentation and sorting
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6080 @subsection Categories
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6081
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6082 @cindex category
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6083 The category is a broad label assigned to each agenda item. By default,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6084 the category is simply derived from the file name, but you can also
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6085 specify it with a special line in the buffer, like this@footnote{For
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6086 backward compatibility, the following also works: If there are several
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6087 such lines in a file, each specifies the category for the text below it.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6088 The first category also applies to any text before the first CATEGORY
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6089 line. However, using this method is @emph{strongly} deprecated as it is
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6090 incompatible with the outline structure of the document. The correct
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6091 method for setting multiple categories in a buffer is using a
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6092 property.}:
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6093
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6094 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6095 #+CATEGORY: Thesis
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6096 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6097
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6098 @noindent
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6099 If you would like to have a special CATEGORY for a single entry or a
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
6100 (sub)tree, give the entry a @code{:CATEGORY:} property with the
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
6101 special category you want to apply as the value.
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6102
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6103 @noindent
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6104 The display in the agenda buffer looks best if the category is not
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6105 longer than 10 characters.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6106
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6107 @node Time-of-day specifications, Sorting of agenda items, Categories, Presentation and sorting
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6108 @subsection Time-of-day specifications
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6109 @cindex time-of-day specification
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6110
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6111 Org mode checks each agenda item for a time-of-day specification. The
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6112 time can be part of the time stamp that triggered inclusion into the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6113 agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}. Time
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6114 ranges can be specified with two time stamps, like
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6115 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6116 @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6117
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6118 In the headline of the entry itself, a time(range) may also appear as
96976
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
6119 plain text (like @samp{12:45} or a @samp{8:30-1pm}). If the agenda
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6120 integrates the Emacs diary (@pxref{Weekly/daily agenda}), time
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6121 specifications in diary entries are recognized as well.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6122
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6123 For agenda display, Org mode extracts the time and displays it in a
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6124 standard 24 hour format as part of the prefix. The example times in
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6125 the previous paragraphs would end up in the agenda like this:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6126
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6127 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6128 8:30-13:00 Arthur Dent lies in front of the bulldozer
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6129 12:45...... Ford Prefect arrives and takes Arthur to the pub
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6130 19:00...... The Vogon reads his poem
101147
a62da64665d1 Fix some more typos.
Glenn Morris <rgm@gnu.org>
parents: 101146
diff changeset
6131 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6132 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6133
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6134 @cindex time grid
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6135 If the agenda is in single-day mode, or for the display of today, the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6136 timed entries are embedded in a time grid, like
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6137
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6138 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6139 8:00...... ------------------
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6140 8:30-13:00 Arthur Dent lies in front of the bulldozer
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6141 10:00...... ------------------
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6142 12:00...... ------------------
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6143 12:45...... Ford Prefect arrives and takes Arthur to the pub
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6144 14:00...... ------------------
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6145 16:00...... ------------------
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6146 18:00...... ------------------
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6147 19:00...... The Vogon reads his poem
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6148 20:00...... ------------------
101509
c915fbc219ff Fix typos.
Glenn Morris <rgm@gnu.org>
parents: 101460
diff changeset
6149 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6150 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6151
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6152 The time grid can be turned on and off with the variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6153 @code{org-agenda-use-time-grid}, and can be configured with
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6154 @code{org-agenda-time-grid}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6155
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6156 @node Sorting of agenda items, , Time-of-day specifications, Presentation and sorting
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6157 @subsection Sorting of agenda items
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6158 @cindex sorting, of agenda items
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6159 @cindex priorities, of agenda items
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6160 Before being inserted into a view, the items are sorted. How this is
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6161 done depends on the type of view.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6162 @itemize @bullet
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6163 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6164 For the daily/weekly agenda, the items for each day are sorted. The
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6165 default order is to first collect all items containing an explicit
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6166 time-of-day specification. These entries will be shown at the beginning
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6167 of the list, as a @emph{schedule} for the day. After that, items remain
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6168 grouped in categories, in the sequence given by @code{org-agenda-files}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6169 Within each category, items are sorted by priority (@pxref{Priorities}),
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6170 which is composed of the base priority (2000 for priority @samp{A}, 1000
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6171 for @samp{B}, and 0 for @samp{C}), plus additional increments for
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6172 overdue scheduled or deadline items.
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6173 @item
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6174 For the TODO list, items remain in the order of categories, but within
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6175 each category, sorting takes place according to priority
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6176 (@pxref{Priorities}).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6177 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6178 For tags matches, items are not sorted at all, but just appear in the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6179 sequence in which they are found in the agenda files.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6180 @end itemize
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6181
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6182 Sorting can be customized using the variable
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6183 @code{org-agenda-sorting-strategy}, and may also include criteria based on
99139
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
6184 the estimated effort of an entry (@pxref{Effort estimates}).
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6185
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6186 @node Agenda commands, Custom agenda views, Presentation and sorting, Agenda Views
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6187 @section Commands in the agenda buffer
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6188 @cindex commands, in agenda buffer
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6189
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6190 Entries in the agenda buffer are linked back to the org file or diary
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6191 file where they originate. You are not allowed to edit the agenda
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6192 buffer itself, but commands are provided to show and jump to the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6193 original entry location, and to edit the org-files ``remotely'' from
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6194 the agenda buffer. In this way, all information is stored only once,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6195 removing the risk that your agenda and note files may diverge.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6196
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6197 Some commands can be executed with mouse clicks on agenda lines. For
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6198 the other commands, the cursor needs to be in the desired line.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6199
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6200 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6201 @tsubheading{Motion}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6202 @cindex motion commands in agenda
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6203 @kindex n
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6204 @item n
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6205 Next line (same as @key{up} and @kbd{C-p}).
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6206 @kindex p
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6207 @item p
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6208 Previous line (same as @key{down} and @kbd{C-n}).
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6209 @tsubheading{View/Go to org file}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6210 @kindex mouse-3
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6211 @kindex @key{SPC}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6212 @item mouse-3
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6213 @itemx @key{SPC}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6214 Display the original location of the item in another window.
100607
87dcbbf4f5fa 2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100508
diff changeset
6215 With prefix arg, make sure that the entire entry is made visible in the
87dcbbf4f5fa 2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100508
diff changeset
6216 outline, not only the heading.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6217 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6218 @kindex L
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6219 @item L
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6220 Display original location and recenter that window.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6221 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6222 @kindex mouse-2
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6223 @kindex mouse-1
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6224 @kindex @key{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6225 @item mouse-2
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6226 @itemx mouse-1
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6227 @itemx @key{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6228 Go to the original location of the item in another window. Under Emacs
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6229 22, @kbd{mouse-1} will also works for this.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6230 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6231 @kindex @key{RET}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6232 @itemx @key{RET}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6233 Go to the original location of the item and delete other windows.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6234 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6235 @kindex f
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6236 @item f
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6237 Toggle Follow mode. In Follow mode, as you move the cursor through
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6238 the agenda buffer, the other window always shows the corresponding
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6239 location in the org file. The initial setting for this mode in new
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6240 agenda buffers can be set with the variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6241 @code{org-agenda-start-with-follow-mode}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6242 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6243 @kindex b
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6244 @item b
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6245 Display the entire subtree of the current item in an indirect buffer. With a
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6246 numeric prefix argument N, go up to level N and then take that tree. If N is
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6247 negative, go up that many levels. With a @kbd{C-u} prefix, do not remove the
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6248 previously used indirect buffer.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6249 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6250 @kindex l
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6251 @item l
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
6252 Toggle Logbook mode. In Logbook mode, entries that were marked DONE while
99503
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
6253 logging was on (variable @code{org-log-done}) are shown in the agenda, as are
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
6254 entries that have been clocked on that day. You can configure the entry
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
6255 types that should be included in log mode using the variable
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
6256 @code{org-agenda-log-mode-items}. When called with a @kbd{C-u} prefix, show
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
6257 all possible logbook entries, including state changes. When called with two
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
6258 prefix args @kbd{C-u C-u}, show only logging information, nothing else.
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6259 @c
96976
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
6260 @kindex v
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
6261 @item v
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
6262 Toggle Archives mode. In archives mode, trees that are marked
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
6263 @code{ARCHIVED} are also scanned when producing the agenda. When you call
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
6264 this command with a @kbd{C-u} prefix argument, even all archive files are
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
6265 included. To exit archives mode, press @kbd{v} again.
96976
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
6266 @c
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6267 @kindex R
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6268 @item R
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6269 Toggle Clockreport mode. In clockreport mode, the daily/weekly agenda will
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6270 always show a table with the clocked times for the timespan and file scope
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6271 covered by the current agenda view. The initial setting for this mode in new
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6272 agenda buffers can be set with the variable
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6273 @code{org-agenda-start-with-clockreport-mode}.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6274
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6275 @tsubheading{Change display}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6276 @cindex display changing, in agenda
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6277 @kindex o
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6278 @item o
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6279 Delete other windows.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6280 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6281 @kindex d
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6282 @kindex w
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6283 @kindex m
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6284 @kindex y
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6285 @item d w m y
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6286 Switch to day/week/month/year view. When switching to day or week view,
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6287 this setting becomes the default for subsequent agenda commands. Since
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6288 month and year views are slow to create, they do not become the default.
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6289 A numeric prefix argument may be used to jump directly to a specific day
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6290 of the year, ISO week, month, or year, respectively. For example,
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6291 @kbd{32 d} jumps to February 1st, @kbd{9 w} to ISO week number 9. When
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6292 setting day, week, or month view, a year may be encoded in the prefix
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6293 argument as well. For example, @kbd{200712 w} will jump to week 12 in
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6294 2007. If such a year specification has only one or two digits, it will
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6295 be mapped to the interval 1938-2037.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6296 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6297 @kindex D
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6298 @item D
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6299 Toggle the inclusion of diary entries. See @ref{Weekly/daily agenda}.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6300 @c
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6301 @kindex G
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6302 @item G
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6303 Toggle the time grid on and off. See also the variables
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6304 @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6305 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6306 @kindex r
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6307 @item r
103366
66652dbd881c * org.texi (Workflow states, Agenda commands): Fix tags (Bug#3508).
Chong Yidong <cyd@stupidchicken.com>
parents: 103365
diff changeset
6308 Recreate the agenda buffer, for example to reflect the changes after
66652dbd881c * org.texi (Workflow states, Agenda commands): Fix tags (Bug#3508).
Chong Yidong <cyd@stupidchicken.com>
parents: 103365
diff changeset
6309 modification of the time stamps of items with @kbd{S-@key{left}} and
66652dbd881c * org.texi (Workflow states, Agenda commands): Fix tags (Bug#3508).
Chong Yidong <cyd@stupidchicken.com>
parents: 103365
diff changeset
6310 @kbd{S-@key{right}}. When the buffer is the global TODO list, a prefix
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6311 argument is interpreted to create a selective list for a specific TODO
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6312 keyword.
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6313 @kindex g
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6314 @item g
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6315 Same as @kbd{r}.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6316 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6317 @kindex s
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6318 @kindex C-x C-s
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6319 @item s
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6320 @itemx C-x C-s
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6321 Save all Org buffers in the current Emacs session.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6322 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6323 @kindex @key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6324 @item @key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6325 Display the following @code{org-agenda-ndays} days. For example, if
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6326 the display covers a week, switch to the following week. With prefix
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6327 arg, go forward that many times @code{org-agenda-ndays} days.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6328 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6329 @kindex @key{left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6330 @item @key{left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6331 Display the previous dates.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6332 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6333 @kindex .
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6334 @item .
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6335 Go to today.
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6336 @c
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6337 @kindex C-c C-x C-c
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6338 @item C-c C-x C-c
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6339 Invoke column view (@pxref{Column view}) in the agenda buffer. The column
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6340 view format is taken from the entry at point, or (if there is no entry at
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6341 point), from the first entry in the agenda view. So whatever the format for
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6342 that entry would be in the original buffer (taken from a property, from a
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6343 @code{#+COLUMNS} line, or from the default variable
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6344 @code{org-columns-default-format}), will be used in the agenda.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6345
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
6346 @tsubheading{Secondary filtering and query editing}
99139
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
6347 @cindex filtering, by tag and effort, in agenda
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
6348 @cindex tag filtering, in agenda
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
6349 @cindex effort filtering, in agenda
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6350 @cindex query editing, in agenda
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6351
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
6352 @kindex /
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
6353 @item /
99139
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
6354 Filter the current agenda view with respect to a tag and/or effort estimates.
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
6355 The difference between this and a custom agenda commands is that filtering is
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
6356 very fast, so that you can switch quickly between different filters without
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
6357 having to recreate the agenda.
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
6358
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
6359 You will be prompted for a tag selection letter. Pressing @key{TAB} at that
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
6360 prompt will offer use completion to select a tag (including any tags that do
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
6361 not have a selection character). The command then hides all entries that do
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
6362 not contain or inherit this tag. When called with prefix arg, remove the
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
6363 entries that @emph{do} have the tag. A second @kbd{/} at the prompt will
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
6364 turn off the filter and unhide any hidden entries. If the first key you
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
6365 press is either @kbd{+} or @kbd{-}, the previous filter will be narrowed by
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
6366 requiring or forbidding the selected additional tag. Instead of pressing
99851
68981b04c1ac 2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99709
diff changeset
6367 @kbd{+} or @kbd{-} after @kbd{/}, you can also immediately use the @kbd{\}
68981b04c1ac 2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99709
diff changeset
6368 command.
99139
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
6369
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
6370 In order to filter for effort estimates, you should set-up allowed
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
6371 efforts globally, for example
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
6372 @lisp
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
6373 (setq org-global-properties
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
6374 '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00")))
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
6375 @end lisp
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
6376 You can then filter for an effort by first typing an operator, one of @kbd{<},
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
6377 @kbd{>}, and @kbd{=}, and then the one-digit index of an effort estimate in
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
6378 your array of allowed values, where @kbd{0} means the 10th value. The filter
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
6379 will then restrict to entries with effort smaller-or-equal, equal, or
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
6380 larger-or-equal than the selected value. If the digits 0-9 are not used as
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
6381 fast access keys to tags, you can also simply press the index digit directly
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
6382 without an operator. In this case, @kbd{<} will be assumed.
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
6383
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
6384 @kindex \
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
6385 @item \
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
6386 Narrow the current agenda filter by an additional condition. When called with
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
6387 prefix arg, remove the entries that @emph{do} have the tag, or that do match
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
6388 the effort criterion. You can achieve the same effect by pressing @kbd{+} or
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
6389 @kbd{-} as the first key after the @kbd{/} command.
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
6390
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6391 @kindex [
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6392 @kindex ]
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6393 @kindex @{
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6394 @kindex @}
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6395 @item [ ] @{ @}
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
6396 In the @i{search view} (@pxref{Keyword search}), these keys add new search
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
6397 words (@kbd{[} and @kbd{]}) or new regular expressions (@kbd{@{} and
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
6398 @kbd{@}}) to the query string. The opening bracket/brace will add a positive
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
6399 search term prefixed by @samp{+}, indicating that this search term @i{must}
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
6400 occur/match in the entry. The closing bracket/brace will add a negative
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
6401 search term which @i{must not} occur/match in the entry for it to be
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
6402 selected.
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6403
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6404
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6405 @tsubheading{Remote editing}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6406 @cindex remote editing, from agenda
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6407
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6408 @item 0-9
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6409 Digit argument.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6410 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6411 @cindex undoing remote-editing events
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6412 @cindex remote editing, undo
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6413 @kindex C-_
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6414 @item C-_
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6415 Undo a change due to a remote editing command. The change is undone
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6416 both in the agenda buffer and in the remote buffer.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6417 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6418 @kindex t
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6419 @item t
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6420 Change the TODO state of the item, both in the agenda and in the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6421 original org file.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6422 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6423 @kindex C-k
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6424 @item C-k
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6425 Delete the current agenda item along with the entire subtree belonging
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6426 to it in the original Org file. If the text to be deleted remotely
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6427 is longer than one line, the kill needs to be confirmed by the user. See
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6428 variable @code{org-agenda-confirm-kill}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6429 @c
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6430 @kindex a
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6431 @item a
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6432 Toggle the ARCHIVE tag for the current headline.
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6433 @c
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6434 @kindex A
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6435 @item A
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
6436 Move the subtree corresponding to the current entry to its @emph{Archive
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6437 Sibling}.
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6438 @c
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6439 @kindex $
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6440 @item $
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6441 Archive the subtree corresponding to the current headline. This means the
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
6442 entry will be moved to the configured archive location, most likely a
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6443 different file.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6444 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6445 @kindex T
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6446 @item T
100271
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
6447 Show all tags associated with the current item. This is useful if you have
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
6448 turned off @code{org-agenda-show-inherited-tags}, but still want to see all
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
6449 tags of a headline occasionally.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6450 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6451 @kindex :
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6452 @item :
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6453 Set tags for the current headline. If there is an active region in the
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6454 agenda, change a tag for all headings in the region.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6455 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6456 @kindex ,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6457 @item ,
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6458 Set the priority for the current item. Org mode prompts for the
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6459 priority character. If you reply with @key{SPC}, the priority cookie
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6460 is removed from the entry.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6461 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6462 @kindex P
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6463 @item P
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6464 Display weighted priority of current item.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6465 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6466 @kindex +
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6467 @kindex S-@key{up}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6468 @item +
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6469 @itemx S-@key{up}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6470 Increase the priority of the current item. The priority is changed in
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6471 the original buffer, but the agenda is not resorted. Use the @kbd{r}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6472 key for this.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6473 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6474 @kindex -
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6475 @kindex S-@key{down}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6476 @item -
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6477 @itemx S-@key{down}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6478 Decrease the priority of the current item.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6479 @c
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
6480 @kindex C-c C-a
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
6481 @item C-c C-a
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
6482 Dispatcher for all command related to attachments.
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
6483 @c
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6484 @kindex C-c C-s
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6485 @item C-c C-s
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6486 Schedule this item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6487 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6488 @kindex C-c C-d
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6489 @item C-c C-d
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6490 Set a deadline for this item.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6491 @c
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
6492 @kindex k
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
6493 @item k
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
6494 Agenda actions, to set dates for selected items to the cursor date.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
6495 This command also works in the calendar! The command prompts for an
101147
a62da64665d1 Fix some more typos.
Glenn Morris <rgm@gnu.org>
parents: 101146
diff changeset
6496 additional key:
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
6497 @example
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
6498 m @r{Mark the entry at point for action. You can also make entries}
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
6499 @r{in Org files with @kbd{C-c C-x C-k}.}
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
6500 d @r{Set the deadline of the marked entry to the date at point.}
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
6501 s @r{Schedule the marked entry at the date at point.}
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
6502 r @r{Call @code{org-remember} with the cursor date as default date.}
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
6503 @end example
101147
a62da64665d1 Fix some more typos.
Glenn Morris <rgm@gnu.org>
parents: 101146
diff changeset
6504 Press @kbd{r} afterward to refresh the agenda and see the effect of the
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
6505 command.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
6506 @c
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6507 @kindex S-@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6508 @item S-@key{right}
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6509 Change the time stamp associated with the current line by one day into the
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6510 future. With a numeric prefix argument, change it by that many days. For
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6511 example, @kbd{3 6 5 S-@key{right}} will change it by a year. The stamp is
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6512 changed in the original org file, but the change is not directly reflected in
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6513 the agenda buffer. Use the @kbd{r} key to update the buffer.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6514 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6515 @kindex S-@key{left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6516 @item S-@key{left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6517 Change the time stamp associated with the current line by one day
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6518 into the past.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6519 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6520 @kindex >
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6521 @item >
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6522 Change the time stamp associated with the current line to today.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6523 The key @kbd{>} has been chosen, because it is the same as @kbd{S-.}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6524 on my keyboard.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6525 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6526 @kindex I
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6527 @item I
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6528 Start the clock on the current item. If a clock is running already, it
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6529 is stopped first.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6530 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6531 @kindex O
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6532 @item O
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6533 Stop the previously started clock.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6534 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6535 @kindex X
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6536 @item X
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6537 Cancel the currently running clock.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6538
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6539 @kindex J
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6540 @item J
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6541 Jump to the running clock in another window.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6542
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6543 @tsubheading{Calendar commands}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6544 @cindex calendar commands, from agenda
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6545 @kindex c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6546 @item c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6547 Open the Emacs calendar and move to the date at the agenda cursor.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6548 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6549 @item c
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6550 When in the calendar, compute and show the Org mode agenda for the
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6551 date at the cursor.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6552 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6553 @cindex diary entries, creating from agenda
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6554 @kindex i
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6555 @item i
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6556 Insert a new entry into the diary. Prompts for the type of entry
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6557 (day, weekly, monthly, yearly, anniversary, cyclic) and creates a new
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6558 entry in the diary, just as @kbd{i d} etc. would do in the calendar.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6559 The date is taken from the cursor position.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6560 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6561 @kindex M
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6562 @item M
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6563 Show the phases of the moon for the three months around current date.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6564 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6565 @kindex S
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6566 @item S
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6567 Show sunrise and sunset times. The geographical location must be set
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6568 with calendar variables, see documentation of the Emacs calendar.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6569 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6570 @kindex C
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6571 @item C
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6572 Convert the date at cursor into many other cultural and historic
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6573 calendars.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6574 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6575 @kindex H
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6576 @item H
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6577 Show holidays for three month around the cursor date.
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6578
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6579 @item M-x org-export-icalendar-combine-agenda-files
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6580 Export a single iCalendar file containing entries from all agenda files.
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6581 This is a globally available command, and also available in the agenda menu.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6582
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6583 @tsubheading{Exporting to a file}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6584 @kindex C-x C-w
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6585 @item C-x C-w
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6586 @cindex exporting agenda views
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6587 @cindex agenda views, exporting
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6588 Write the agenda view to a file. Depending on the extension of the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6589 selected file name, the view will be exported as HTML (extension
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6590 @file{.html} or @file{.htm}), Postscript (extension @file{.ps}), or
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6591 plain text (any other extension). Use the variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6592 @code{org-agenda-exporter-settings} to set options for @file{ps-print}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6593 and for @file{htmlize} to be used during export.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6594
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6595 @tsubheading{Quit and Exit}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6596 @kindex q
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6597 @item q
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6598 Quit agenda, remove the agenda buffer.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6599 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6600 @kindex x
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6601 @cindex agenda files, removing buffers
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6602 @item x
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6603 Exit agenda, remove the agenda buffer and all buffers loaded by Emacs
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6604 for the compilation of the agenda. Buffers created by the user to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6605 visit org files will not be removed.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6606 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6607
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6608
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6609 @node Custom agenda views, Agenda column view, Agenda commands, Agenda Views
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6610 @section Custom agenda views
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6611 @cindex custom agenda views
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6612 @cindex agenda views, custom
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6613
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6614 Custom agenda commands serve two purposes: to store and quickly access
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6615 frequently used TODO and tags searches, and to create special composite
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6616 agenda buffers. Custom agenda commands will be accessible through the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6617 dispatcher (@pxref{Agenda dispatcher}), just like the default commands.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6618
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6619 @menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6620 * Storing searches:: Type once, use often
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6621 * Block agenda:: All the stuff you need in a single buffer
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6622 * Setting Options:: Changing the rules
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6623 * Exporting Agenda Views:: Writing agendas to files
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6624 * Using the agenda elsewhere:: Using agenda information in other programs
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6625 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6626
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6627 @node Storing searches, Block agenda, Custom agenda views, Custom agenda views
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6628 @subsection Storing searches
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6629
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6630 The first application of custom searches is the definition of keyboard
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6631 shortcuts for frequently used searches, either creating an agenda
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6632 buffer, or a sparse tree (the latter covering of course only the current
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6633 buffer).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6634 @kindex C-c a C
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6635 Custom commands are configured in the variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6636 @code{org-agenda-custom-commands}. You can customize this variable, for
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6637 example by pressing @kbd{C-c a C}. You can also directly set it with
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6638 Emacs Lisp in @file{.emacs}. The following example contains all valid
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6639 search types:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6640
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6641 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6642 @group
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6643 (setq org-agenda-custom-commands
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6644 '(("w" todo "WAITING")
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6645 ("W" todo-tree "WAITING")
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6646 ("u" tags "+boss-urgent")
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6647 ("v" tags-todo "+boss-urgent")
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6648 ("U" tags-tree "+boss-urgent")
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6649 ("f" occur-tree "\\<FIXME\\>")
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6650 ("h" . "HOME+Name tags searches") ; description for "h" prefix
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6651 ("hl" tags "+home+Lisa")
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6652 ("hp" tags "+home+Peter")
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6653 ("hk" tags "+home+Kim")))
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6654 @end group
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6655 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6656
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6657 @noindent
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6658 The initial string in each entry defines the keys you have to press
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6659 after the dispatcher command @kbd{C-c a} in order to access the command.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6660 Usually this will be just a single character, but if you have many
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6661 similar commands, you can also define two-letter combinations where the
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6662 first character is the same in several combinations and serves as a
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6663 prefix key@footnote{You can provide a description for a prefix key by
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6664 inserting a cons cell with the prefix and the description.}. The second
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6665 parameter is the search type, followed by the string or regular
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6666 expression to be used for the matching. The example above will
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6667 therefore define:
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6668
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6669 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6670 @item C-c a w
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6671 as a global search for TODO entries with @samp{WAITING} as the TODO
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6672 keyword
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6673 @item C-c a W
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6674 as the same search, but only in the current buffer and displaying the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6675 results as a sparse tree
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6676 @item C-c a u
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6677 as a global tags search for headlines marked @samp{:boss:} but not
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6678 @samp{:urgent:}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6679 @item C-c a v
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6680 as the same search as @kbd{C-c a u}, but limiting the search to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6681 headlines that are also TODO items
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6682 @item C-c a U
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6683 as the same search as @kbd{C-c a u}, but only in the current buffer and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6684 displaying the result as a sparse tree
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6685 @item C-c a f
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6686 to create a sparse tree (again: current buffer only) with all entries
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6687 containing the word @samp{FIXME}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6688 @item C-c a h
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6689 as a prefix command for a HOME tags search where you have to press an
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6690 additional key (@kbd{l}, @kbd{p} or @kbd{k}) to select a name (Lisa,
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6691 Peter, or Kim) as additional tag to match.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6692 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6693
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6694 @node Block agenda, Setting Options, Storing searches, Custom agenda views
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6695 @subsection Block agenda
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6696 @cindex block agenda
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6697 @cindex agenda, with block views
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6698
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6699 Another possibility is the construction of agenda views that comprise
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6700 the results of @emph{several} commands, each of which creates a block in
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6701 the agenda buffer. The available commands include @code{agenda} for the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6702 daily or weekly agenda (as created with @kbd{C-c a a}), @code{alltodo}
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6703 for the global TODO list (as constructed with @kbd{C-c a t}), and the
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6704 matching commands discussed above: @code{todo}, @code{tags}, and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6705 @code{tags-todo}. Here are two examples:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6706
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6707 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6708 @group
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6709 (setq org-agenda-custom-commands
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6710 '(("h" "Agenda and Home-related tasks"
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6711 ((agenda "")
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6712 (tags-todo "home")
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6713 (tags "garden")))
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6714 ("o" "Agenda and Office-related tasks"
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6715 ((agenda "")
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6716 (tags-todo "work")
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6717 (tags "office")))))
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6718 @end group
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6719 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6720
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6721 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6722 This will define @kbd{C-c a h} to create a multi-block view for stuff
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6723 you need to attend to at home. The resulting agenda buffer will contain
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6724 your agenda for the current week, all TODO items that carry the tag
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6725 @samp{home}, and also all lines tagged with @samp{garden}. Finally the
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6726 command @kbd{C-c a o} provides a similar view for office tasks.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6727
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6728 @node Setting Options, Exporting Agenda Views, Block agenda, Custom agenda views
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6729 @subsection Setting options for custom commands
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6730 @cindex options, for custom agenda views
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6731
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6732 Org mode contains a number of variables regulating agenda construction
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6733 and display. The global variables define the behavior for all agenda
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6734 commands, including the custom commands. However, if you want to change
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6735 some settings just for a single custom view, you can do so. Setting
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6736 options requires inserting a list of variable names and values at the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6737 right spot in @code{org-agenda-custom-commands}. For example:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6738
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6739 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6740 @group
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6741 (setq org-agenda-custom-commands
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6742 '(("w" todo "WAITING"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6743 ((org-agenda-sorting-strategy '(priority-down))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6744 (org-agenda-prefix-format " Mixed: ")))
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6745 ("U" tags-tree "+boss-urgent"
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6746 ((org-show-following-heading nil)
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6747 (org-show-hierarchy-above nil)))
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6748 ("N" search ""
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6749 ((org-agenda-files '("~org/notes.org"))
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6750 (org-agenda-text-search-extra-files nil)))))
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6751 @end group
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6752 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6753
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6754 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6755 Now the @kbd{C-c a w} command will sort the collected entries only by
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6756 priority, and the prefix format is modified to just say @samp{ Mixed: }
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6757 instead of giving the category of the entry. The sparse tags tree of
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6758 @kbd{C-c a U} will now turn out ultra-compact, because neither the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6759 headline hierarchy above the match, nor the headline following the match
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6760 will be shown. The command @kbd{C-c a N} will do a text search limited
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6761 to only a single file.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6762
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6763 For command sets creating a block agenda,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6764 @code{org-agenda-custom-commands} has two separate spots for setting
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6765 options. You can add options that should be valid for just a single
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6766 command in the set, and options that should be valid for all commands in
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6767 the set. The former are just added to the command entry, the latter
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6768 must come after the list of command entries. Going back to the block
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6769 agenda example (@pxref{Block agenda}), let's change the sorting strategy
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6770 for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6771 the results for GARDEN tags query in the opposite order,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6772 @code{priority-up}. This would look like this:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6773
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6774 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6775 @group
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6776 (setq org-agenda-custom-commands
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6777 '(("h" "Agenda and Home-related tasks"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6778 ((agenda)
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6779 (tags-todo "home")
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6780 (tags "garden"
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6781 ((org-agenda-sorting-strategy '(priority-up)))))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6782 ((org-agenda-sorting-strategy '(priority-down))))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6783 ("o" "Agenda and Office-related tasks"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6784 ((agenda)
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6785 (tags-todo "work")
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6786 (tags "office")))))
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6787 @end group
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6788 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6789
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6790 As you see, the values and parenthesis setting is a little complex.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6791 When in doubt, use the customize interface to set this variable - it
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6792 fully supports its structure. Just one caveat: When setting options in
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6793 this interface, the @emph{values} are just lisp expressions. So if the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6794 value is a string, you need to add the double quotes around the value
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6795 yourself.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6796
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6797
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6798 @node Exporting Agenda Views, Using the agenda elsewhere, Setting Options, Custom agenda views
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6799 @subsection Exporting Agenda Views
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6800 @cindex agenda views, exporting
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6801
101570
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
6802 If you are away from your computer, it can be very useful to have a printed
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
6803 version of some agenda views to carry around. Org mode can export custom
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
6804 agenda views as plain text, HTML@footnote{You need to install Hrvoje Niksic's
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
6805 @file{htmlize.el}.}, Postscript, and iCalendar files. If you want to do this
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
6806 only occasionally, use the command
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6807
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6808 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6809 @kindex C-x C-w
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6810 @item C-x C-w
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6811 @cindex exporting agenda views
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6812 @cindex agenda views, exporting
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6813 Write the agenda view to a file. Depending on the extension of the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6814 selected file name, the view will be exported as HTML (extension
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6815 @file{.html} or @file{.htm}), Postscript (extension @file{.ps}),
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6816 iCalendar (extension @file{.ics}), or plain text (any other extension).
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6817 Use the variable @code{org-agenda-exporter-settings} to
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6818 set options for @file{ps-print} and for @file{htmlize} to be used during
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6819 export, for example
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6820
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6821 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6822 (setq org-agenda-exporter-settings
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6823 '((ps-number-of-columns 2)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6824 (ps-landscape-mode t)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6825 (htmlize-output-type 'css)))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6826 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6827 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6828
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6829 If you need to export certain agenda views frequently, you can associate
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6830 any custom agenda command with a list of output file names
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6831 @footnote{If you want to store standard views like the weekly agenda
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6832 or the global TODO list as well, you need to define custom commands for
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6833 them in order to be able to specify file names.}. Here is an example
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6834 that first does define custom commands for the agenda and the global
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6835 todo list, together with a number of files to which to export them.
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6836 Then we define two block agenda commands and specify file names for them
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6837 as well. File names can be relative to the current working directory,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6838 or absolute.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6839
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6840 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6841 @group
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6842 (setq org-agenda-custom-commands
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6843 '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6844 ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6845 ("h" "Agenda and Home-related tasks"
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6846 ((agenda "")
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6847 (tags-todo "home")
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6848 (tags "garden"))
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6849 nil
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6850 ("~/views/home.html"))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6851 ("o" "Agenda and Office-related tasks"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6852 ((agenda)
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6853 (tags-todo "work")
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6854 (tags "office"))
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6855 nil
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6856 ("~/views/office.ps" "~/calendars/office.ics"))))
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6857 @end group
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6858 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6859
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6860 The extension of the file name determines the type of export. If it is
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6861 @file{.html}, Org mode will use the @file{htmlize.el} package to convert
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6862 the buffer to HTML and save it to this file name. If the extension is
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6863 @file{.ps}, @code{ps-print-buffer-with-faces} is used to produce
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6864 postscript output. If the extension is @file{.ics}, iCalendar export is
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6865 run export over all files that were used to construct the agenda, and
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6866 limit the export to entries listed in the agenda now. Any other
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6867 extension produces a plain ASCII file.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6868
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6869 The export files are @emph{not} created when you use one of those
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6870 commands interactively because this might use too much overhead.
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6871 Instead, there is a special command to produce @emph{all} specified
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6872 files in one step:
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6873
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6874 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6875 @kindex C-c a e
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6876 @item C-c a e
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6877 Export all agenda views that have export file names associated with
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6878 them.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6879 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6880
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6881 You can use the options section of the custom agenda commands to also
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6882 set options for the export commands. For example:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6883
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6884 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6885 (setq org-agenda-custom-commands
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6886 '(("X" agenda ""
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6887 ((ps-number-of-columns 2)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6888 (ps-landscape-mode t)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6889 (org-agenda-prefix-format " [ ] ")
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6890 (org-agenda-with-colors nil)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6891 (org-agenda-remove-tags t))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6892 ("theagenda.ps"))))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6893 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6894
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6895 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6896 This command sets two options for the postscript exporter, to make it
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6897 print in two columns in landscape format - the resulting page can be cut
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6898 in two and then used in a paper agenda. The remaining settings modify
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6899 the agenda prefix to omit category and scheduling information, and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6900 instead include a checkbox to check off items. We also remove the tags
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6901 to make the lines compact, and we don't want to use colors for the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6902 black-and-white printer. Settings specified in
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6903 @code{org-agenda-exporter-settings} will also apply, but the settings
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6904 in @code{org-agenda-custom-commands} take precedence.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6905
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6906 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6907 From the command line you may also use
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6908 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6909 emacs -f org-batch-store-agenda-views -kill
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6910 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6911 @noindent
99139
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
6912 or, if you need to modify some parameters@footnote{Quoting may depend on the
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
6913 system you use, please check th FAQ for examples.}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6914 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6915 emacs -eval '(org-batch-store-agenda-views \
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6916 org-agenda-ndays 30 \
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6917 org-agenda-start-day "2007-11-01" \
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6918 org-agenda-include-diary nil \
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6919 org-agenda-files (quote ("~/org/project.org")))' \
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6920 -kill
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6921 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6922 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6923 which will create the agenda views restricted to the file
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6924 @file{~/org/project.org}, without diary entries and with 30 days
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6925 extent.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6926
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6927 @node Using the agenda elsewhere, , Exporting Agenda Views, Custom agenda views
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6928 @subsection Using agenda information outside of Org
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6929 @cindex agenda, pipe
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6930 @cindex Scripts, for agenda processing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6931
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6932 Org provides commands to access agenda information for the command
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6933 line in emacs batch mode. This extracted information can be sent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6934 directly to a printer, or it can be read by a program that does further
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6935 processing of the data. The first of these commands is the function
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6936 @code{org-batch-agenda}, that produces an agenda view and sends it as
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6937 ASCII text to STDOUT. The command takes a single string as parameter.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6938 If the string has length 1, it is used as a key to one of the commands
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6939 you have configured in @code{org-agenda-custom-commands}, basically any
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6940 key you can use after @kbd{C-c a}. For example, to directly print the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6941 current TODO list, you could use
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6942
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6943 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6944 emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6945 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6946
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6947 If the parameter is a string with 2 or more characters, it is used as a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6948 tags/todo match string. For example, to print your local shopping list
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6949 (all items with the tag @samp{shop}, but excluding the tag
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6950 @samp{NewYork}), you could use
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6951
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6952 @example
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6953 emacs -batch -l ~/.emacs \
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6954 -eval '(org-batch-agenda "+shop-NewYork")' | lpr
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6955 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6956
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6957 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6958 You may also modify parameters on the fly like this:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6959
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6960 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6961 emacs -batch -l ~/.emacs \
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6962 -eval '(org-batch-agenda "a" \
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6963 org-agenda-ndays 30 \
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6964 org-agenda-include-diary nil \
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6965 org-agenda-files (quote ("~/org/project.org")))' \
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6966 | lpr
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6967 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6968
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6969 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6970 which will produce a 30 day agenda, fully restricted to the Org file
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6971 @file{~/org/projects.org}, not even including the diary.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6972
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6973 If you want to process the agenda data in more sophisticated ways, you
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6974 can use the command @code{org-batch-agenda-csv} to get a comma-separated
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6975 list of values for each agenda item. Each line in the output will
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6976 contain a number of fields separated by commas. The fields in a line
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6977 are:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6978
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6979 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6980 category @r{The category of the item}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6981 head @r{The headline, without TODO kwd, TAGS and PRIORITY}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6982 type @r{The type of the agenda entry, can be}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6983 todo @r{selected in TODO match}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6984 tagsmatch @r{selected in tags match}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6985 diary @r{imported from diary}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6986 deadline @r{a deadline}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6987 scheduled @r{scheduled}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6988 timestamp @r{appointment, selected by timestamp}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6989 closed @r{entry was closed on date}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6990 upcoming-deadline @r{warning about nearing deadline}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6991 past-scheduled @r{forwarded scheduled item}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6992 block @r{entry has date block including date}
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
6993 todo @r{The TODO keyword, if any}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6994 tags @r{All tags including inherited ones, separated by colons}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6995 date @r{The relevant date, like 2007-2-14}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6996 time @r{The time, like 15:00-16:50}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6997 extra @r{String with extra planning info}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6998 priority-l @r{The priority letter if any was given}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6999 priority-n @r{The computed numerical priority}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7000 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7001
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7002 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7003 Time and date will only be given if a timestamp (or deadline/scheduled)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7004 lead to the selection of the item.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7005
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7006 A CSV list like this is very easy to use in a post processing script.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7007 For example, here is a Perl program that gets the TODO list from
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7008 Emacs/Org and prints all the items, preceded by a checkbox:
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7009
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7010 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7011 @group
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7012 #!/usr/bin/perl
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7013
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7014 # define the Emacs command to run
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7015 $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7016
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7017 # run it and capture the output
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7018 $agenda = qx@{$cmd 2>/dev/null@};
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7019
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7020 # loop over all lines
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7021 foreach $line (split(/\n/,$agenda)) @{
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7022
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7023 # get the individual values
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7024 ($category,$head,$type,$todo,$tags,$date,$time,$extra,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7025 $priority_l,$priority_n) = split(/,/,$line);
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7026
101147
a62da64665d1 Fix some more typos.
Glenn Morris <rgm@gnu.org>
parents: 101146
diff changeset
7027 # process and print
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7028 print "[ ] $head\n";
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7029 @}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7030 @end group
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7031 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7032
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7033 @node Agenda column view, , Custom agenda views, Agenda Views
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7034 @section Using column view in the agenda
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7035 @cindex column view, in agenda
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7036 @cindex agenda, column view
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7037
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7038 Column view (@pxref{Column view}) is normally used to view and edit
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7039 properties embedded in the hierarchical structure of an Org file. It can be
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7040 quite useful to use column view also from the agenda, where entries are
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7041 collected by certain criteria.
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7042
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7043 @table @kbd
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7044 @kindex C-c C-x C-c
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7045 @item C-c C-x C-c
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7046 Turn on column view in the agenda.
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7047 @end table
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7048
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7049 To understand how to use this properly, it is important to realize that the
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7050 entries in the agenda are no longer in their proper outline environment.
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7051 This causes the following issues:
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7052
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7053 @enumerate
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7054 @item
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7055 Org needs to make a decision which @code{COLUMNS} format to use. Since the
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7056 entries in the agenda are collected from different files, and different files
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7057 may have different @code{COLUMNS} formats, this is a non-trivial problem.
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7058 Org first checks if the variable @code{org-overriding-columns-format} is
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7059 currently set, and if yes takes the format from there. Otherwise it takes
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7060 the format associated with the first item in the agenda, or, if that item
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7061 does not have a specific format (defined in a property, or in it's file), it
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7062 uses @code{org-columns-default-format}.
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7063 @item
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7064 If any of the columns has a summary type defined (@pxref{Column attributes}),
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7065 turning on column view in the agenda will visit all relevant agenda files and
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7066 make sure that the computations of this property are up to date. This is
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7067 also true for the special @code{CLOCKSUM} property. Org will then sum the
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7068 values displayed in the agenda. In the daily/weekly agenda, the sums will
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7069 cover a single day, in all other views they cover the entire block. It is
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7070 vital to realize that the agenda may show the same entry @emph{twice} (for
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7071 example as scheduled and as a deadline), and it may show two entries from the
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7072 same hierarchy (for example a @emph{parent} and it's @emph{child}). In these
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7073 cases, the summation in the agenda will lead to incorrect results because
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7074 some values will count double.
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7075 @item
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7076 When the column view in the agenda shows the @code{CLOCKSUM}, that is always
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7077 the entire clocked time for this item. So even in the daily/weekly agenda,
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7078 the clocksum listed in column view may originate from times outside the
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7079 current view. This has the advantage that you can compare these values with
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7080 a column listing the planned total effort for a task - one of the major
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7081 applications for column view in the agenda. If you want information about
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7082 clocked time in the displayed period use clock table mode (press @kbd{R} in
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7083 the agenda).
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7084 @end enumerate
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7085
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7086
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7087 @node Embedded LaTeX, Exporting, Agenda Views, Top
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7088 @chapter Embedded LaTeX
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7089 @cindex @TeX{} interpretation
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7090 @cindex La@TeX{} interpretation
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7091
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7092 Plain ASCII is normally sufficient for almost all note taking. One
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7093 exception, however, are scientific notes which need to be able to contain
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7094 mathematical symbols and the occasional formula. La@TeX{}@footnote{La@TeX{}
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7095 is a macro system based on Donald E. Knuth's @TeX{} system. Many of the
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7096 features described here as ``La@TeX{}'' are really from @TeX{}, but for
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7097 simplicity I am blurring this distinction.} is widely used to typeset
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7098 scientific documents. Org mode supports embedding La@TeX{} code into its
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7099 files, because many academics are used to reading La@TeX{} source code, and
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7100 because it can be readily processed into images for HTML production.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7101
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7102 It is not necessary to mark La@TeX{} macros and code in any special way.
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7103 If you observe a few conventions, Org mode knows how to find it and what
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7104 to do with it.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7105
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7106 @menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7107 * Math symbols:: TeX macros for symbols and Greek letters
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7108 * Subscripts and superscripts:: Simple syntax for raising/lowering text
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7109 * LaTeX fragments:: Complex formulas made easy
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7110 * Processing LaTeX fragments:: Previewing LaTeX processing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7111 * CDLaTeX mode:: Speed up entering of formulas
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7112 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7113
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7114 @node Math symbols, Subscripts and superscripts, Embedded LaTeX, Embedded LaTeX
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7115 @section Math symbols
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7116 @cindex math symbols
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7117 @cindex TeX macros
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7118
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7119 You can use La@TeX{} macros to insert special symbols like @samp{\alpha} to
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7120 indicate the Greek letter, or @samp{\to} to indicate an arrow. Completion
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7121 for these macros is available, just type @samp{\} and maybe a few letters,
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7122 and press @kbd{M-@key{TAB}} to see possible completions. Unlike La@TeX{}
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7123 code, Org mode allows these macros to be present without surrounding math
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7124 delimiters, for example:
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7125
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7126 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7127 Angles are written as Greek letters \alpha, \beta and \gamma.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7128 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7129
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7130 During HTML export (@pxref{HTML export}), these symbols are translated
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7131 into the proper syntax for HTML, for the above examples this is
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
7132 @samp{&alpha;} and @samp{&rarr;}, respectively. If you need such a symbol
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
7133 inside a word, terminate it like this: @samp{\Aacute@{@}stor}.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7134
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7135 @node Subscripts and superscripts, LaTeX fragments, Math symbols, Embedded LaTeX
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7136 @section Subscripts and superscripts
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7137 @cindex subscript
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7138 @cindex superscript
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7139
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7140 Just like in La@TeX{}, @samp{^} and @samp{_} are used to indicate super-
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7141 and subscripts. Again, these can be used without embedding them in
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7142 math-mode delimiters. To increase the readability of ASCII text, it is
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7143 not necessary (but OK) to surround multi-character sub- and superscripts
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7144 with curly braces. For example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7145
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7146 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7147 The mass if the sun is M_sun = 1.989 x 10^30 kg. The radius of
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7148 the sun is R_@{sun@} = 6.96 x 10^8 m.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7149 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7150
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7151 To avoid interpretation as raised or lowered text, you can quote
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7152 @samp{^} and @samp{_} with a backslash: @samp{\_} and @samp{\^}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7153
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7154 During HTML export (@pxref{HTML export}), subscript and superscripts
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7155 are surrounded with @code{<sub>} and @code{<sup>} tags, respectively.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7156
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7157 @node LaTeX fragments, Processing LaTeX fragments, Subscripts and superscripts, Embedded LaTeX
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7158 @section LaTeX fragments
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7159 @cindex LaTeX fragments
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7160
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7161 With symbols, sub- and superscripts, HTML is pretty much at its end when
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7162 it comes to representing mathematical formulas@footnote{Yes, there is
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7163 MathML, but that is not yet fully supported by many browsers, and there
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7164 is no decent converter for turning La@TeX{} or ASCII representations of
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7165 formulas into MathML. So for the time being, converting formulas into
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7166 images seems the way to go.}. More complex expressions need a dedicated
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7167 formula processor. To this end, Org mode can contain arbitrary La@TeX{}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7168 fragments. It provides commands to preview the typeset result of these
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7169 fragments, and upon export to HTML, all fragments will be converted to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7170 images and inlined into the HTML document@footnote{The La@TeX{} export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7171 will not use images for displaying La@TeX{} fragments but include these
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7172 fragments directly into the La@TeX{} code.}. For this to work you
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7173 need to be on a system with a working La@TeX{} installation. You also
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7174 need the @file{dvipng} program, available at
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7175 @url{http://sourceforge.net/projects/dvipng/}. The La@TeX{} header that
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7176 will be used when processing a fragment can be configured with the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7177 variable @code{org-format-latex-header}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7178
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7179 La@TeX{} fragments don't need any special marking at all. The following
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7180 snippets will be identified as La@TeX{} source code:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7181 @itemize @bullet
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7182 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7183 Environments of any kind. The only requirement is that the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7184 @code{\begin} statement appears on a new line, preceded by only
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7185 whitespace.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7186 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7187 Text within the usual La@TeX{} math delimiters. To avoid conflicts with
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7188 currency specifications, single @samp{$} characters are only recognized as
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7189 math delimiters if the enclosed text contains at most two line breaks, is
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7190 directly attached to the @samp{$} characters with no whitespace in between,
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7191 and if the closing @samp{$} is followed by whitespace, punctuation or a dash.
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7192 For the other delimiters, there is no such restriction, so when in doubt, use
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7193 @samp{\(...\)} as inline math delimiters.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7194 @end itemize
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7195
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7196 @noindent For example:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7197
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7198 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7199 \begin@{equation@} % arbitrary environments,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7200 x=\sqrt@{b@} % even tables, figures
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7201 \end@{equation@} % etc
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7202
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7203 If $a^2=b$ and \( b=2 \), then the solution must be
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7204 either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \].
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7205 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7206
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7207 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7208 If you need any of the delimiter ASCII sequences for other purposes, you
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7209 can configure the option @code{org-format-latex-options} to deselect the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7210 ones you do not wish to have interpreted by the La@TeX{} converter.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7211
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7212 @node Processing LaTeX fragments, CDLaTeX mode, LaTeX fragments, Embedded LaTeX
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7213 @section Processing LaTeX fragments
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7214 @cindex LaTeX fragments, preview
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7215
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7216 La@TeX{} fragments can be processed to produce a preview images of the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7217 typeset expressions:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7218
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7219 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7220 @kindex C-c C-x C-l
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7221 @item C-c C-x C-l
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7222 Produce a preview image of the La@TeX{} fragment at point and overlay it
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7223 over the source code. If there is no fragment at point, process all
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7224 fragments in the current entry (between two headlines). When called
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7225 with a prefix argument, process the entire subtree. When called with
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7226 two prefix arguments, or when the cursor is before the first headline,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7227 process the entire buffer.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7228 @kindex C-c C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7229 @item C-c C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7230 Remove the overlay preview images.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7231 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7232
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7233 During HTML export (@pxref{HTML export}), all La@TeX{} fragments are
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7234 converted into images and inlined into the document if the following
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7235 setting is active:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7236
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7237 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7238 (setq org-export-with-LaTeX-fragments t)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7239 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7240
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7241 @node CDLaTeX mode, , Processing LaTeX fragments, Embedded LaTeX
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7242 @section Using CDLaTeX to enter math
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7243 @cindex CDLaTeX
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7244
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7245 CDLaTeX mode is a minor mode that is normally used in combination with a
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7246 major La@TeX{} mode like AUCTeX in order to speed-up insertion of
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7247 environments and math templates. Inside Org mode, you can make use of
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7248 some of the features of CDLaTeX mode. You need to install
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7249 @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7250 AUCTeX) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}.
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7251 Don't use CDLaTeX mode itself under Org mode, but use the light
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7252 version @code{org-cdlatex-mode} that comes as part of Org mode. Turn it
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7253 on for the current buffer with @code{M-x org-cdlatex-mode}, or for all
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7254 Org files with
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7255
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7256 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7257 (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7258 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7259
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7260 When this mode is enabled, the following features are present (for more
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7261 details see the documentation of CDLaTeX mode):
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7262 @itemize @bullet
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7263 @kindex C-c @{
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7264 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7265 Environment templates can be inserted with @kbd{C-c @{}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7266 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7267 @kindex @key{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7268 The @key{TAB} key will do template expansion if the cursor is inside a
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7269 La@TeX{} fragment@footnote{Org mode has a method to test if the cursor is
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7270 inside such a fragment, see the documentation of the function
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7271 @code{org-inside-LaTeX-fragment-p}.}. For example, @key{TAB} will
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7272 expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7273 correctly inside the first brace. Another @key{TAB} will get you into
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7274 the second brace. Even outside fragments, @key{TAB} will expand
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7275 environment abbreviations at the beginning of a line. For example, if
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7276 you write @samp{equ} at the beginning of a line and press @key{TAB},
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7277 this abbreviation will be expanded to an @code{equation} environment.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7278 To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7279 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7280 @kindex _
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7281 @kindex ^
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7282 Pressing @kbd{_} and @kbd{^} inside a La@TeX{} fragment will insert these
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7283 characters together with a pair of braces. If you use @key{TAB} to move
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7284 out of the braces, and if the braces surround only a single character or
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7285 macro, they are removed again (depending on the variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7286 @code{cdlatex-simplify-sub-super-scripts}).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7287 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7288 @kindex `
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7289 Pressing the backquote @kbd{`} followed by a character inserts math
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7290 macros, also outside La@TeX{} fragments. If you wait more than 1.5 seconds
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7291 after the backquote, a help window will pop up.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7292 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7293 @kindex '
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7294 Pressing the normal quote @kbd{'} followed by another character modifies
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7295 the symbol before point with an accent or a font. If you wait more than
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7296 1.5 seconds after the backquote, a help window will pop up. Character
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7297 modification will work only inside La@TeX{} fragments, outside the quote
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7298 is normal.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7299 @end itemize
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7300
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7301 @node Exporting, Publishing, Embedded LaTeX, Top
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7302 @chapter Exporting
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7303 @cindex exporting
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7304
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7305 Org mode documents can be exported into a variety of other formats. For
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7306 printing and sharing of notes, ASCII export produces a readable and
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7307 simple version of an Org file. HTML export allows you to publish a
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7308 notes file on the web, while the XOXO format provides a solid base for
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7309 exchange with a broad range of other applications. La@TeX{} export lets
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7310 you use Org mode and its structured editing functions to easily create
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7311 La@TeX{} files. To incorporate entries with associated times like
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7312 deadlines or appointments into a desktop calendar program like iCal,
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7313 Org mode can also produce extracts in the iCalendar format. Currently
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7314 Org mode only supports export, not import of these different formats.
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7315
100607
87dcbbf4f5fa 2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100508
diff changeset
7316 Org supports export of selected regions when @code{transient-mark-mode} is
87dcbbf4f5fa 2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100508
diff changeset
7317 enabled (default in Emacs 23).
87dcbbf4f5fa 2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100508
diff changeset
7318
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7319 @menu
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7320 * Markup rules:: Which structures are recognized?
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
7321 * Selective export:: Using tags to select and exclude trees
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7322 * Export options:: Per-file export settings
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7323 * The export dispatcher:: How to access exporter commands
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7324 * ASCII export:: Exporting to plain ASCII
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7325 * HTML export:: Exporting to HTML
99139
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
7326 * LaTeX and PDF export:: Exporting to LaTeX, and processing to PDF
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7327 * XOXO export:: Exporting to XOXO
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7328 * iCalendar export:: Exporting in iCalendar format
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7329 @end menu
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7330
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
7331 @node Markup rules, Selective export, Exporting, Exporting
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7332 @section Markup rules
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7333
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7334 When exporting Org mode documents, the exporter tries to reflect the
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7335 structure of the document as accurately as possible in the back-end. Since
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7336 export targets like HTML or La@TeX{} allow much richer formatting, Org mode
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7337 has rules how to prepare text for rich export. This section summarizes the
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7338 markup rule used in an Org mode buffer.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7339
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7340 @menu
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7341 * Document title:: How the document title is determined
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7342 * Headings and sections:: The main structure of the exported document
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7343 * Table of contents:: If, where, how to create a table of contents
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7344 * Initial text:: Text before the first headline
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7345 * Lists:: Plain lists are exported
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7346 * Paragraphs:: What determines beginning and ending
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7347 * Literal examples:: Source code and other examples
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7348 * Include files:: Include the contents of a file during export
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7349 * Tables exported:: Tables are exported richly
100450
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
7350 * Inlined images:: How to inline images during export
102151
328f4b370b74 Remove duplicate words.
Juanma Barranquero <lekktu@gmail.com>
parents: 102059
diff changeset
7351 * Footnote markup::
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7352 * Emphasis and monospace:: To bold or not to bold
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7353 * TeX macros and LaTeX fragments:: Create special, rich export.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7354 * Horizontal rules:: A line across the page
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7355 * Comment lines:: Some lines will not be exported
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7356 @end menu
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7357
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7358 @node Document title, Headings and sections, Markup rules, Markup rules
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7359 @subheading Document title
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7360 @cindex document title, markup rules
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7361
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7362 @noindent
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7363 The title of the exported document is taken from the special line
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7364
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7365 @example
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7366 #+TITLE: This is the title of the document
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7367 @end example
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7368
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7369 @noindent
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7370 If this line does not exist, the title is derived from the first non-empty,
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7371 non-comment line in the buffer. If no such line exists, or if you have
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7372 turned off exporting of the text before the first headline (see below), the
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7373 title will be the file name without extension.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7374
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7375 If you are exporting only a subtree by marking is as the region, the heading
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7376 of the subtree will become the title of the document. If the subtree has a
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7377 property @code{EXPORT_TITLE}, that will take precedence.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7378
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7379 @node Headings and sections, Table of contents, Document title, Markup rules
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7380 @subheading Headings and sections
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7381 @cindex headings and sections, markup rules
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7382
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7383 The outline structure of the document as described in @ref{Document
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7384 Structure} forms the basis for defining sections of the exported document.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7385 However, since the outline structure is also used for (for example) lists of
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7386 tasks, only the first three outline levels will be used as headings. Deeper
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7387 levels will become itemized lists. You can change the location of this
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7388 switch, globally by setting the variable @code{org-headline-levels}, or on a
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7389 per file basis with a line
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7390
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7391 @example
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7392 #+OPTIONS: H:4
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7393 @end example
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7394
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7395 @node Table of contents, Initial text, Headings and sections, Markup rules
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7396 @subheading Table of contents
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7397 @cindex table of contents, markup rules
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7398
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7399 The table of contents is normally inserted directly before the first headline
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7400 of the file. If you would like to get it to a different location, insert the
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7401 string @code{[TABLE-OF-CONTENTS]} on a line by itself at the desired
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7402 location. The depth of the table of contents is by default the same as the
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7403 number of headline levels, but you can choose a smaller number or turn off
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7404 the table of contents entirely by configuring the variable
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7405 @code{org-export-with-toc}, or on a per-file basis with a line like
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7406
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7407 @example
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7408 #+OPTIONS: toc:2 (only to two levels in TOC)
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7409 #+OPTIONS: toc:nil (no TOC at all)
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7410 @end example
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7411
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7412 @node Initial text, Lists, Table of contents, Markup rules
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7413 @subheading Text before the first headline
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7414 @cindex text before first headline, markup rules
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7415 @cindex #+TEXT
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7416
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7417 Org mode normally exports the text before the first headline, and even uses
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7418 the first line as the document title. The text will be fully marked up. If
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7419 you need to include literal HTML or La@TeX{} code, use the special constructs
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7420 described below in the sections for the individual exporters.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7421
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7422 Some people like to use the space before the first headline for setup and
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7423 internal links and therefore would like to control the exported text before
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7424 the first headline in a different way. You can do so by setting the variable
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7425 @code{org-export-skip-text-before-1st-heading} to @code{t}. On a per-file
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7426 basis, you can get the same effect with @samp{#+OPTIONS: skip:t}.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7427
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7428 @noindent
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7429 If you still want to have some text before the first headline, use the
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7430 @code{#+TEXT} construct:
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7431
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7432 @example
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7433 #+OPTIONS: skip:t
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7434 #+TEXT: This text will go before the *first* headline.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7435 #+TEXT: [TABLE-OF-CONTENTS]
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7436 #+TEXT: This goes between the table of contents and the first headline
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7437 @end example
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7438
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7439 @node Lists, Paragraphs, Initial text, Markup rules
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7440 @subheading Lists
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7441 @cindex lists, markup rules
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7442
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7443 Plain lists as described in @ref{Plain lists} are translated to the back-ends
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7444 syntax for such lists. Most back-ends support unordered, ordered, and
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7445 description lists.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7446
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7447 @node Paragraphs, Literal examples, Lists, Markup rules
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7448 @subheading Paragraphs, line breaks, and quoting
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7449 @cindex paragraphs, markup rules
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7450
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7451 Paragraphs are separated by at least one empty line. If you need to enforce
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7452 a line break within a paragraph, use @samp{\\} at the end of a line.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7453
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7454 To keep the line breaks in a region, but otherwise use normal formatting, you
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7455 can use this construct, which can also be used to format poetry.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7456
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7457 @example
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7458 #+BEGIN_VERSE
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
7459 Great clouds overhead
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
7460 Tiny black birds rise and fall
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
7461 Snow covers Emacs
100271
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
7462
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
7463 -- AlexSchroeder
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7464 #+END_VERSE
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7465 @end example
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7466
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7467 When quoting a passage from another document, it is customary to format this
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7468 as a paragraph that is indented on both the left and the right margin. You
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7469 can include quotations in Org mode documents like this:
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7470
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7471 @example
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7472 #+BEGIN_QUOTE
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7473 Everything should be made as simple as possible,
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7474 but not any simpler -- Albert Einstein
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7475 #+END_QUOTE
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7476 @end example
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7477
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7478
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7479 @node Literal examples, Include files, Paragraphs, Markup rules
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7480 @subheading Literal examples
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7481 @cindex literal examples, markup rules
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7482 @cindex code line refenences, markup rules
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7483
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7484 You can include literal examples that should not be subjected to
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7485 markup. Such examples will be typeset in monospace, so this is well suited
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7486 for source code and similar examples.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7487 @cindex #+BEGIN_EXAMPLE
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7488
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7489 @example
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7490 #+BEGIN_EXAMPLE
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7491 Some example from a text file.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7492 #+END_EXAMPLE
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7493 @end example
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7494
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7495 For simplicity when using small examples, you can also start the example
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7496 lines with a colon followed by a space. There may also be additional
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7497 whitespace before the colon:
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7498
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7499 @example
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7500 Here is an example
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7501 : Some example from a text file.
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7502 @end example
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7503
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7504 @cindex formatting source code, markup rules
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7505 If the example is source code from a programming language, or any other text
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7506 that can be marked up by font-lock in Emacs, you can ask for the example to
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7507 look like the fontified Emacs buffer@footnote{Currently this works only for
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7508 the HTML back-end, and requires the @file{htmlize.el} package version 1.34 or
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7509 later.}. This is done with the @samp{src} block, where you also need to
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7510 specify the name of the major mode that should be used to fontify the
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7511 example:
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7512 @cindex #+BEGIN_SRC
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7513
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7514 @example
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7515 #+BEGIN_SRC emacs-lisp
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7516 (defun org-xor (a b)
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7517 "Exclusive or."
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7518 (if a (not b) b))
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7519 #+END_SRC
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7520 @end example
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7521
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7522 Both in @code{example} and in @code{src} snippets, you can add a @code{-n}
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7523 switch to the end of the @code{BEGIN} line, to get the lines of the example
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7524 numbered. If you use a @code{+n} switch, the numbering from the previous
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7525 numbered snippet will be continued in the current one. In literal examples,
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7526 Org will interpret strings like @samp{(ref:name)} as labels, and use them as
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7527 targets for special hyperlinks like @code{[[(name)]]} (i.e. the reference
101509
c915fbc219ff Fix typos.
Glenn Morris <rgm@gnu.org>
parents: 101460
diff changeset
7528 name enclosed in single parenthesis). In HTML, hovering the mouse over such
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7529 a link will remote-highlight the corresponding code line, which is kind of
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7530 cool. If the example/src snippet is numbered, you can also add a @code{-r}
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7531 switch. Then labels will be @i{removed} from the source code and the links
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7532 will be @i{replaced}@footnote{If you want to explain the use of such labels
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7533 themelves in org-mode example code, you can use the @code{-k} switch to make
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7534 sure they are not touched.} with line numbers from the code listing. Here is
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7535 an example:
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7536
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7537 @example
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7538 #+BEGIN_SRC emacs-lisp -n -r
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7539 (save-excursion (ref:sc)
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7540 (goto-char (point-min)) (ref:jump)
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7541 #+END SRC
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7542 In line [[(sc)]] we remember the current positon. [[(jump)][Line (jump)]]
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7543 jumps to point-min.
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7544 @end example
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7545
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7546 If the syntax for the label format conflicts with the language syntax, use a
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7547 @code{-l} switch to change the format, for example @samp{#+BEGIN_SRC pascal
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7548 -n -r -l "((%s))"}. See also the variable @code{org-coderef-label-format}.
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7549
101509
c915fbc219ff Fix typos.
Glenn Morris <rgm@gnu.org>
parents: 101460
diff changeset
7550 HTML export also allows examples to be published as text areas, @pxref{Text
c915fbc219ff Fix typos.
Glenn Morris <rgm@gnu.org>
parents: 101460
diff changeset
7551 areas in HTML export}.
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7552
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7553 @table @kbd
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7554 @kindex C-c '
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7555 @item C-c '
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7556 Edit the source code example at point in its native mode. This works by
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7557 switching to an indirect buffer, narrowing the buffer and switching to the
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
7558 other mode. You need to exit by pressing @kbd{C-c '} again@footnote{Upon
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
7559 exit, lines starting with @samp{*} or @samp{#} will get a comma prepended, to
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
7560 keep them from being interpreted by Org as outline nodes or special
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
7561 comments. These commas will be striped for editing with @kbd{C-c '}, and
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
7562 also for export.}. Fixed-width
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
7563 regions (where each line starts with a colon followed by a space) will be
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
7564 edited using @code{artist-mode}@footnote{You may select a different-mode with
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
7565 the variable @code{org-edit-fixed-width-region-mode}.} to allow creating
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
7566 ASCII drawings easily. Using this command in an empty line will create a new
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
7567 fixed-width region.
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7568 @kindex C-c l
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7569 @item C-c l
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7570 Calling @code{org-store-link} while editing a source code example in a
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7571 temporary buffer created with @kbd{C-c '} will prompt for a label, make sure
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7572 that it is unique in the current buffer, and insert it with the proper
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7573 formatting like @samp{(ref:label)} at the end of the current line. Then the
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7574 label is stored as a link @samp{(label)}, for retrieval with @kbd{C-c C-l}.
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7575 @end table
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7576
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7577
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7578 @node Include files, Tables exported, Literal examples, Markup rules
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7579 @subheading Include files
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7580 @cindex include files, markup rules
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7581
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7582 During export, you can include the content of another file. For example, to
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7583 include your .emacs file, you could use:
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7584 @cindex #+INCLUDE
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7585
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7586 @example
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7587 #+INCLUDE: "~/.emacs" src emacs-lisp
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7588 @end example
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7589
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7590 The optional second and third parameter are the markup (@samp{quote},
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7591 @samp{example}, or @samp{src}), and, if the markup is @samp{src}, the
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7592 language for formatting the contents. The markup is optional, if it is not
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7593 given, the text will be assumed to be in Org mode format and will be
96976
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
7594 processed normally. The include line will also allow additional keyword
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
7595 parameters @code{:prefix1} and @code{:prefix} to specify prefixes for the
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7596 first line and for each following line, as well as any options accepted by
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7597 the selected markup. For example, to include a file as an item, use
96976
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
7598
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
7599 @example
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
7600 #+INCLUDE: "~/snippets/xx" :prefix1 " + " :prefix " "
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
7601 @end example
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7602
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7603 @table @kbd
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7604 @kindex C-c '
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7605 @item C-c '
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7606 Visit the include file at point.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7607 @end table
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7608
100450
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
7609 @node Tables exported, Inlined images, Include files, Markup rules
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7610 @subheading Tables
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7611 @cindex tables, markup rules
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7612
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7613 Both the native Org mode tables (@pxref{Tables}) and tables formatted with
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7614 the @file{table.el} package will be exported properly. For Org mode tables,
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7615 the lines before the first horizontal separator line will become table header
101147
a62da64665d1 Fix some more typos.
Glenn Morris <rgm@gnu.org>
parents: 101146
diff changeset
7616 lines. You can use the following lines somewhere before the table to assign
100450
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
7617 a caption and a label for cross references:
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
7618
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
7619 @example
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
7620 #+CAPTION: This is the caption for the next table (or link)
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
7621 #+LABEL: tbl:basic-data
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
7622 @end example
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
7623
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7624 @node Inlined images, Footnote markup, Tables exported, Markup rules
100450
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
7625 @subheading Inlined Images
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
7626 @cindex inlined images, markup rules
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
7627
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
7628 Some backends (HTML and LaTeX) allow to directly include images into the
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
7629 exported document. Org does this, if a link to an image files does not have
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
7630 a description part, for example @code{[[./img/a.jpg]]}. If you wish to
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
7631 define a caption for the image and maybe a label for internal cross
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
7632 references, you can use (before, but close to the link)
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
7633
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
7634 @example
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
7635 #+CAPTION: This is the caption for the next figure link (or table)
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
7636 #+LABEL: fig:SED-HR4049
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
7637 @end example
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
7638
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
7639 You may also define additional attributes for the figure. As this is
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
7640 backend-specific, see the sections about the individual backends for more
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
7641 information.
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
7642
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7643 @node Footnote markup, Emphasis and monospace, Inlined images, Markup rules
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7644 @subheading Footnote markup
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7645 @cindex footnotes, markup rules
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7646 @cindex @file{footnote.el}
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7647
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7648 Footnotes defined in the way descriped in @ref{Footnotes} will be exported by
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7649 all backends. Org does allow multiple references to the same note, and
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7650 different backends support this to varying degree.
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7651
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7652 @node Emphasis and monospace, TeX macros and LaTeX fragments, Footnote markup, Markup rules
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7653 @subheading Emphasis and monospace
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7654
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7655 @cindex underlined text, markup rules
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7656 @cindex bold text, markup rules
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7657 @cindex italic text, markup rules
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7658 @cindex verbatim text, markup rules
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7659 @cindex code text, markup rules
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7660 @cindex strike-through text, markup rules
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7661 You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=code=}
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7662 and @code{~verbatim~}, and, if you must, @samp{+strike-through+}. Text
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7663 in the code and verbatim string is not processed for Org mode specific
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7664 syntax, it is exported verbatim.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7665
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7666 @node TeX macros and LaTeX fragments, Horizontal rules, Emphasis and monospace, Markup rules
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7667 @subheading @TeX{} macros and La@TeX{} fragments
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7668 @cindex LaTeX fragments, markup rules
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7669 @cindex TeX macros, markup rules
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7670 @cindex HTML entities
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7671 @cindex LaTeX entities
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7672
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7673 A @TeX{}-like syntax is used to specify special characters. Where possible,
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7674 these will be transformed into the native format of the exporter back-end.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7675 Strings like @code{\alpha} will be exported as @code{&alpha;} in the HTML
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7676 output, and as @code{$\alpha$} in the La@TeX{} output. Similarly,
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7677 @code{\nbsp} will become @code{&nbsp;} in HTML and @code{~} in La@TeX{}.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7678 This applies for a large number of entities, with names taken from both HTML
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7679 and La@TeX{}, see the variable @code{org-html-entities} for the complete
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7680 list. If you are unsure about a name, use @kbd{M-@key{TAB}} for completion
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7681 after having typed the backslash and maybe a few characters
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7682 (@pxref{Completion}).
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7683
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7684 La@TeX{} fragments are converted into images for HTML export, and they are
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7685 written literally into the La@TeX{} export. See also @ref{Embedded LaTeX}.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7686
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7687 Finally, @samp{\-} is treated as a shy hyphen, and @samp{--}, @samp{---}, and
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7688 @samp{...} are all converted into special commands creating hyphens of
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7689 different lengths or a compact set of dots.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7690
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7691 @node Horizontal rules, Comment lines, TeX macros and LaTeX fragments, Markup rules
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7692 @subheading Horizontal rules
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7693 @cindex horizontal rules, markup rules
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7694 A line consisting of only dashes, and at least 5 of them, will be
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7695 exported as a horizontal line (@samp{<hr/>} in HTML).
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7696
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7697 @node Comment lines, , Horizontal rules, Markup rules
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7698 @subheading Comment lines
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7699 @cindex comment lines
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7700 @cindex exporting, not
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7701
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7702 Lines starting with @samp{#} in column zero are treated as comments and will
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7703 never be exported. Also entire subtrees starting with the word
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7704 @samp{COMMENT} will never be exported. Finally, regions surrounded by
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7705 @samp{#+BEGIN_COMMENT} ... @samp{#+END_COMMENT} will not be exported.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7706
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7707 @table @kbd
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7708 @kindex C-c ;
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7709 @item C-c ;
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7710 Toggle the COMMENT keyword at the beginning of an entry.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7711 @end table
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7712
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
7713 @node Selective export, Export options, Markup rules, Exporting
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
7714 @section Selective export
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
7715 @cindex export, selective by tags
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
7716
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
7717 You may use tags to select the parts of a document that should be exported,
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
7718 or to exclude parts from export. This behavior is governed by two variables:
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
7719 @code{org-export-select-tags} and @code{org-export-exclude-tags}.
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
7720
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
7721 Org first checks if any of the @emph{select} tags is present in the buffer.
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
7722 If yes, all trees that do not carry one of these tags will be excluded. If a
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
7723 selected tree is a subtree, the heading hierarchy above it will also be
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
7724 selected for export, but not the text below those headings.
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
7725
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
7726 @noindent
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
7727 If none of the select tags is found, the whole buffer will be selected for
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
7728 export.
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
7729
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
7730 @noindent
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
7731 Finally, all subtrees that are marked by any of the @emph{exclude} tags will
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
7732 be removed from the export buffer.
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
7733
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
7734 @node Export options, The export dispatcher, Selective export, Exporting
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7735 @section Export options
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7736 @cindex options, for export
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7737
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7738 @cindex completion, of option keywords
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7739 The exporter recognizes special lines in the buffer which provide
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7740 additional information. These lines may be put anywhere in the file.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7741 The whole set of lines can be inserted into the buffer with @kbd{C-c
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7742 C-e t}. For individual lines, a good way to make sure the keyword is
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7743 correct is to type @samp{#+} and then use @kbd{M-@key{TAB}} completion
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7744 (@pxref{Completion}).
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7745
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7746 @table @kbd
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7747 @kindex C-c C-e t
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7748 @item C-c C-e t
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7749 Insert template with export options, see example below.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7750 @end table
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7751
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7752 @cindex #+TITLE:
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7753 @cindex #+AUTHOR:
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7754 @cindex #+DATE:
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7755 @cindex #+EMAIL:
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7756 @cindex #+LANGUAGE:
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7757 @cindex #+TEXT:
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7758 @cindex #+OPTIONS:
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7759 @cindex #+LINK_UP:
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7760 @cindex #+LINK_HOME:
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
7761 @cindex #+EXPORT_SELECT_TAGS:
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
7762 @cindex #+EXPORT_EXCLUDE_TAGS:
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7763 @example
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7764 #+TITLE: the title to be shown (default is the buffer name)
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7765 #+AUTHOR: the author (default taken from @code{user-full-name})
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7766 #+DATE: A date, fixed, of a format string for @code{format-time-string}
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7767 #+EMAIL: his/her email address (default from @code{user-mail-address})
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7768 #+LANGUAGE: language for HTML, e.g. @samp{en} (@code{org-export-default-language})
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7769 #+TEXT: Some descriptive text to be inserted at the beginning.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7770 #+TEXT: Several lines may be given.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7771 #+OPTIONS: H:2 num:t toc:t \n:nil @@:t ::t |:t ^:t f:t TeX:t ...
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7772 #+LINK_UP: the ``up'' link of an exported page
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7773 #+LINK_HOME: the ``home'' link of an exported page
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
7774 #+EXPORT_SELECT_TAGS: Tags that select a tree for export
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
7775 #+EXPORT_EXCLUDE_TAGS: Tags that exclude a tree from export
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7776 @end example
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7777
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7778 @noindent
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7779 The OPTIONS line is a compact@footnote{If you want to configure many options
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7780 this way, you can use several OPTIONS lines.} form to specify export settings. Here
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7781 you can:
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7782 @cindex headline levels
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7783 @cindex section-numbers
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7784 @cindex table of contents
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7785 @cindex line-break preservation
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7786 @cindex quoted HTML tags
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7787 @cindex fixed-width sections
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7788 @cindex tables
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7789 @cindex @TeX{}-like syntax for sub- and superscripts
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7790 @cindex footnotes
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7791 @cindex special strings
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7792 @cindex emphasized text
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7793 @cindex @TeX{} macros
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7794 @cindex La@TeX{} fragments
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7795 @cindex author info, in export
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7796 @cindex time info, in export
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7797 @example
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7798 H: @r{set the number of headline levels for export}
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7799 num: @r{turn on/off section-numbers}
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7800 toc: @r{turn on/off table of contents, or set level limit (integer)}
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7801 \n: @r{turn on/off line-break-preservation}
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7802 @@: @r{turn on/off quoted HTML tags}
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7803 :: @r{turn on/off fixed-width sections}
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7804 |: @r{turn on/off tables}
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7805 ^: @r{turn on/off @TeX{}-like syntax for sub- and superscripts. If}
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7806 @r{you write "^:@{@}", @code{a_@{b@}} will be interpreted, but}
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7807 @r{the simple @code{a_b} will be left as it is.}
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7808 -: @r{turn on/off conversion of special strings.}
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7809 f: @r{turn on/off footnotes like this[1].}
100271
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
7810 todo: @r{turn on/off inclusion of TODO keywords into exported text}
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
7811 pri: @r{turn on/off priority cookies}
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
7812 tags: @r{turn on/off inclusion of tags, may also be @code{not-in-toc}}
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
7813 <: @r{turn on/off inclusion of any time/date stamps like DEADLINES}
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7814 *: @r{turn on/off emphasized text (bold, italic, underlined)}
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7815 TeX: @r{turn on/off simple @TeX{} macros in plain text}
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7816 LaTeX: @r{turn on/off La@TeX{} fragments}
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7817 skip: @r{turn on/off skipping the text before the first heading}
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7818 author: @r{turn on/off inclusion of author name/email into exported file}
97028
70c4b1cbc9e3 2008-07-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 96976
diff changeset
7819 creator: @r{turn on/off inclusion of creator info into exported file}
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7820 timestamp: @r{turn on/off inclusion creation time into exported file}
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7821 d: @r{turn on/off inclusion of drawers}
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7822 @end example
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7823
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7824 These options take effect in both the HTML and La@TeX{} export, except
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7825 for @code{TeX} and @code{LaTeX}, which are respectively @code{t} and
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7826 @code{nil} for the La@TeX{} export.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7827
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7828 When exporting only a single subtree by selecting it with @kbd{C-c @@} before
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7829 calling an export command, the subtree can overrule some of the file's export
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7830 settings with properties @code{EXPORT_FILE_NAME}, @code{EXPORT_TITLE},
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7831 @code{EXPORT_TEXT}, and @code{EXPORT_OPTIONS}.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7832
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7833 @node The export dispatcher, ASCII export, Export options, Exporting
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7834 @section The export dispatcher
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7835 @cindex dispatcher, for export commands
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7836
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7837 All export commands can be reached using the export dispatcher, which is a
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7838 prefix key that prompts for an additional key specifying the command.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7839 Normally the entire file is exported, but if there is an active region that
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7840 contains one outline tree, the first heading is used as document title and
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7841 the subtrees are exported.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7842
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7843 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7844 @kindex C-c C-e
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7845 @item C-c C-e
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7846 Dispatcher for export and publishing commands. Displays a help-window
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7847 listing the additional key(s) needed to launch an export or publishing
99851
68981b04c1ac 2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99709
diff changeset
7848 command. The prefix arg is passed through to the exporter. A double prefix
68981b04c1ac 2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99709
diff changeset
7849 @kbd{C-u C-u} causes most commands to be executed in the background, in a
68981b04c1ac 2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99709
diff changeset
7850 separate emacs process@footnote{To make this behavior the default, customize
68981b04c1ac 2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99709
diff changeset
7851 the variable @code{org-export-run-in-background}.}.
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7852 @kindex C-c C-e v
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7853 @item C-c C-e v
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7854 Like @kbd{C-c C-e}, but only export the text that is currently visible
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7855 (i.e. not hidden by outline visibility).
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7856 @kindex C-u C-u C-c C-e
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7857 @item C-u C-u C-c C-e
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7858 Call an the exporter, but reverse the setting of
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7859 @code{org-export-run-in-background}, i.e. request background processing if
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7860 not set, or force processing in the current Emacs process if st.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7861 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7862
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7863 @node ASCII export, HTML export, The export dispatcher, Exporting
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7864 @section ASCII export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7865 @cindex ASCII export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7866
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7867 ASCII export produces a simple and very readable version of an Org mode
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7868 file.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7869
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7870 @cindex region, active
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7871 @cindex active region
100607
87dcbbf4f5fa 2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100508
diff changeset
7872 @cindex transient-mark-mode
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7873 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7874 @kindex C-c C-e a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7875 @item C-c C-e a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7876 Export as ASCII file. For an org file @file{myfile.org}, the ASCII file
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7877 will be @file{myfile.txt}. The file will be overwritten without
100607
87dcbbf4f5fa 2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100508
diff changeset
7878 warning. If there is an active region@footnote{this requires
87dcbbf4f5fa 2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100508
diff changeset
7879 @code{transient-mark-mode} to be turned on}, only the region will be
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7880 exported. If the selected region is a single tree@footnote{To select the
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7881 current subtree, use @kbd{C-c @@}.}, the tree head will
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7882 become the document title. If the tree head entry has or inherits an
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7883 @code{EXPORT_FILE_NAME} property, that name will be used for the
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
7884 export.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7885 @kindex C-c C-e v a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7886 @item C-c C-e v a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7887 Export only the visible part of the document.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7888 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7889
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7890 @cindex headline levels, for exporting
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7891 In the exported version, the first 3 outline levels will become
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7892 headlines, defining a general document structure. Additional levels
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7893 will be exported as itemized lists. If you want that transition to occur
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7894 at a different level, specify it with a prefix argument. For example,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7895
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7896 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7897 @kbd{C-1 C-c C-e a}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7898 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7899
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7900 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7901 creates only top level headlines and does the rest as items. When
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7902 headlines are converted to items, the indentation of the text following
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7903 the headline is changed to fit nicely under the item. This is done with
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7904 the assumption that the first body line indicates the base indentation of
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7905 the body text. Any indentation larger than this is adjusted to preserve
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7906 the layout relative to the first line. Should there be lines with less
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7907 indentation than the first, these are left alone.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7908
99139
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
7909 @node HTML export, LaTeX and PDF export, ASCII export, Exporting
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7910 @section HTML export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7911 @cindex HTML export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7912
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7913 Org mode contains an HTML (XHTML 1.0 strict) exporter with extensive
100607
87dcbbf4f5fa 2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100508
diff changeset
7914 HTML formatting, in ways similar to John Gruber's @emph{markdown}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7915 language, but with additional support for tables.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7916
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7917 @menu
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7918 * HTML Export commands:: How to invoke HTML export
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7919 * Quoting HTML tags:: Using direct HTML in Org mode
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7920 * Links:: Transformation of links for HTML
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7921 * Images in HTML export:: How to insert figures into HTML output
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
7922 * Text areas in HTML export:: An alternative way to show an example
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7923 * CSS support:: Changing the appearance of the output
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7924 * Javascript support:: Info and Folding in a web browser
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7925 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7926
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7927 @node HTML Export commands, Quoting HTML tags, HTML export, HTML export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7928 @subsection HTML export commands
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7929
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7930 @cindex region, active
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7931 @cindex active region
100607
87dcbbf4f5fa 2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100508
diff changeset
7932 @cindex transient-mark-mode
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7933 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7934 @kindex C-c C-e h
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7935 @item C-c C-e h
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7936 Export as HTML file @file{myfile.html}. For an org file @file{myfile.org},
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7937 the ASCII file will be @file{myfile.html}. The file will be overwritten
100607
87dcbbf4f5fa 2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100508
diff changeset
7938 without warning. If there is an active region@footnote{this requires
87dcbbf4f5fa 2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100508
diff changeset
7939 @code{transient-mark-mode} to be turned on}, only the region will be
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7940 exported. If the selected region is a single tree@footnote{To select the
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7941 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
100607
87dcbbf4f5fa 2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100508
diff changeset
7942 title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
7943 property, that name will be used for the export.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7944 @kindex C-c C-e b
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7945 @item C-c C-e b
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7946 Export as HTML file and immediately open it with a browser.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7947 @kindex C-c C-e H
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7948 @item C-c C-e H
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7949 Export to a temporary buffer, do not create a file.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7950 @kindex C-c C-e R
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
7951 @item C-c C-e R
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7952 Export the active region to a temporary buffer. With a prefix argument, do
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7953 not produce the file header and footer, but just the plain HTML section for
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7954 the region. This is good for cut-and-paste operations.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7955 @kindex C-c C-e v h
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7956 @kindex C-c C-e v b
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7957 @kindex C-c C-e v H
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7958 @kindex C-c C-e v R
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7959 @item C-c C-e v h
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7960 @item C-c C-e v b
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7961 @item C-c C-e v H
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7962 @item C-c C-e v R
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7963 Export only the visible part of the document.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7964 @item M-x org-export-region-as-html
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7965 Convert the region to HTML under the assumption that it was Org mode
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7966 syntax before. This is a global command that can be invoked in any
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7967 buffer.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7968 @item M-x org-replace-region-by-HTML
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7969 Replace the active region (assumed to be in Org mode syntax) by HTML
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7970 code.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7971 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7972
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7973 @cindex headline levels, for exporting
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7974 In the exported version, the first 3 outline levels will become headlines,
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7975 defining a general document structure. Additional levels will be exported as
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7976 itemized lists. If you want that transition to occur at a different level,
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
7977 specify it with a numeric prefix argument. For example,
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7978
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7979 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7980 @kbd{C-2 C-c C-e b}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7981 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7982
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7983 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7984 creates two levels of headings and does the rest as items.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7985
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7986 @node Quoting HTML tags, Links, HTML Export commands, HTML export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7987 @subsection Quoting HTML tags
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7988
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7989 Plain @samp{<} and @samp{>} are always transformed to @samp{&lt;} and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7990 @samp{&gt;} in HTML export. If you want to include simple HTML tags
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7991 which should be interpreted as such, mark them with @samp{@@} as in
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7992 @samp{@@<b>bold text@@</b>}. Note that this really works only for
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7993 simple tags. For more extensive HTML that should be copied verbatim to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7994 the exported file use either
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7995
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7996 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7997 #+HTML: Literal HTML code for export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7998 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7999
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8000 @noindent or
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
8001 @cindex #+BEGIN_HTML
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8002
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8003 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8004 #+BEGIN_HTML
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8005 All lines between these markers are exported literally
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8006 #+END_HTML
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8007 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8008
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8009
100450
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
8010 @node Links, Images in HTML export, Quoting HTML tags, HTML export
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8011 @subsection Links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8012
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8013 @cindex links, in HTML export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8014 @cindex internal links, in HTML export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8015 @cindex external links, in HTML export
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8016 Internal links (@pxref{Internal links}) will continue to work in HTML. This
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8017 does include automatic links created by radio targets (@pxref{Radio
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8018 targets}). Links to external files will still work if the target file is on
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8019 the same @i{relative} path as the published Org file. Links to other
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8020 @file{.org} files will be translated into HTML links under the assumption
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8021 that an HTML version also exists of the linked file, at the same relative
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8022 path. @samp{id:} links can then be used to jump to specific entries across
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8023 files. For information related to linking files while publishing them to a
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8024 publishing directory see @ref{Publishing links}.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8025
96976
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
8026 If you want to specify attributes for links, you can do so using a special
101147
a62da64665d1 Fix some more typos.
Glenn Morris <rgm@gnu.org>
parents: 101146
diff changeset
8027 @code{#+ATTR_HTML} line to define attributes that will be added to the
100450
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
8028 @code{<a>} or @code{<img>} tags. Here is an example that sets @code{alt} and
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
8029 @code{title} attributes for an inlined image:
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
8030
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
8031 @example
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
8032 #+ATTR_HTML: alt="This is image A" title="Image with no action"
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
8033 [[./img/a.jpg]]
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
8034 @end example
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
8035
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8036 @node Images in HTML export, Text areas in HTML export, Links, HTML export
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8037 @subsection Images
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8038
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8039 @cindex images, inline in HTML
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8040 @cindex inlining images in HTML
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8041 HTML export can inline images given as links in the Org file, and
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8042 it can make an image the clickable part of a link. By
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8043 default@footnote{but see the variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8044 @code{org-export-html-inline-images}}, images are inlined if a link does
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8045 not have a description. So @samp{[[file:myimg.jpg]]} will be inlined,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8046 while @samp{[[file:myimg.jpg][the image]]} will just produce a link
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8047 @samp{the image} that points to the image. If the description part
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8048 itself is a @code{file:} link or a @code{http:} URL pointing to an
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8049 image, this image will be inlined and activated so that clicking on the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8050 image will activate the link. For example, to include a thumbnail that
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8051 will link to a high resolution version of the image, you could use:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8052
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8053 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8054 [[file:highres.jpg][file:thumb.jpg]]
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8055 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8056
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8057 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8058 and you could use @code{http} addresses just as well.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8059
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8060 @node Text areas in HTML export, CSS support, Images in HTML export, HTML export
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8061 @subsection Text areas
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8062
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8063 @cindex text areas, in HTML
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8064 An alternative way to publish literal code examples in HTML is to use text
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8065 areas, where the example can even be edited before pasting it into an
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8066 application. It is triggered by a @code{-t} switch at an @code{example} or
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8067 @code{src} block. Using this switch disables any options for syntax and
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8068 label highlighting, and line numbering, which may be present. You may also
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8069 use @code{-h} and @code{-w} switches to specify the height and width of the
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8070 text area, which default to the number of lines in the example, and 80,
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8071 respectively. For example
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8072
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8073 @example
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8074 #+BEGIN_EXAMPLE -t -w 40
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8075 (defun org-xor (a b)
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8076 "Exclusive or."
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8077 (if a (not b) b))
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8078 #+END_EXAMPLE
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8079 @end example
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8080
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8081
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8082 @node CSS support, Javascript support, Text areas in HTML export, HTML export
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8083 @subsection CSS support
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8084 @cindex CSS, for HTML export
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8085 @cindex HTML export, CSS
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8086
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8087 You can also give style information for the exported file. The HTML exporter
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8088 assigns the following special CSS classes to appropriate parts of the
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8089 document - your style specifications may change these, in addition to any of
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8090 the standard classes like for headlines, tables etc.
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8091 @example
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8092 .todo @r{TODO keywords}
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8093 .done @r{the DONE keyword}
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8094 .timestamp @r{time stamp}
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8095 .timestamp-kwd @r{keyword associated with a time stamp, like SCHEDULED}
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8096 .tag @r{tag in a headline}
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8097 .target @r{target for links}
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8098 div.figure @r{how to format an inlined image}
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8099 .linenr @r{the line number in a code example}
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8100 .code-highlighted @r{for highlighting referenced code lines}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8101 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8102
96976
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
8103 Each exported files contains a compact default style that defines these
99503
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
8104 classes in a basic way@footnote{This style is defined in the constant
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
8105 @code{org-export-html-style-default}, which you should not modify. To turn
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
8106 inclusion of these defaults off, customize
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
8107 @code{org-export-html-style-include-default}}. You may overwrite these
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
8108 settings, or add to them by using the variables @code{org-export-html-style}
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
8109 (for Org-wide settings) and @code{org-export-html-style-extra} (for more
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
8110 granular settings, like file-local settings). To set the latter variable
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
8111 individually for each file, you can use
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
8112
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
8113 @example
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
8114 #+STYLE: <link rel="stylesheet" type="text/css" href="stylesheet.css" />
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
8115 @end example
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
8116
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
8117 @noindent
99503
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
8118 For longer style definitions, you can use several such lines. You could also
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
8119 directly write a @code{<style>} @code{</style>} section in this way, without
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
8120 referring to an external file.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8121
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8122 @c FIXME: More about header and footer styles
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8123 @c FIXME: Talk about links and targets.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8124
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8125 @node Javascript support, , CSS support, HTML export
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8126 @subsection Javascript supported display of web pages
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8127
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8128 @emph{Sebastian Rose} has written a JavaScript program especially designed to
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8129 enhance the web viewing experience of HTML files created with Org. This
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8130 program allows you to view large files in two different ways. The first one
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8131 is an @emph{Info}-like mode where each section is displayed separately and
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8132 navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8133 as well, press @kbd{?} for an overview of the available keys). The second
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8134 view type is a @emph{folding} view much like Org provides inside Emacs. The
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8135 script is available at @url{http://orgmode.org/org-info.js} and you can find
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8136 the documentation for it at @url{http://orgmode.org/worg/code/org-info-js/}.
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8137 We are serving the script from our site, but if you use it a lot, you might
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8138 not want to be dependent on @url{orgmode.org} and prefer to install a local
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8139 copy on your own web server.
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
8140
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
8141 To use the script, you need to make sure that the @file{org-jsinfo.el} module
100607
87dcbbf4f5fa 2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100508
diff changeset
8142 gets loaded. It should be loaded by default, but you can try @kbd{M-x
87dcbbf4f5fa 2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100508
diff changeset
8143 customize-variable @key{RET} org-modules @key{RET}} to convince yourself that
87dcbbf4f5fa 2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100508
diff changeset
8144 this is indeed the case. All it then takes to make use of the program is
87dcbbf4f5fa 2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100508
diff changeset
8145 adding a single line to the Org file:
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8146
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8147 @example
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
8148 #+INFOJS_OPT: view:info toc:nil
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8149 @end example
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8150
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8151 @noindent
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8152 If this line is found, the HTML header will automatically contain the code
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8153 needed to invoke the script. Using the line above, you can set the following
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8154 viewing options:
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8155
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8156 @example
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8157 path: @r{The path to the script. The default is to grab the script from}
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8158 @r{@url{http://orgmode.org/org-info.js}, but you might want to have}
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8159 @r{a local copy and use a path like @samp{../scripts/org-info.js}.}
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
8160 view: @r{Initial view when website is first shown. Possible values are:}
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8161 info @r{Info-like interface with one section per page.}
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8162 overview @r{Folding interface, initially showing only top-level.}
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8163 content @r{Folding interface, starting with all headlines visible.}
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8164 showall @r{Folding interface, all headlines and text visible.}
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8165 sdepth: @r{Maximum headline level that will still become an independent}
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8166 @r{section for info and folding modes. The default is taken from}
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8167 @r{@code{org-headline-levels} (= the @code{H} switch in @code{#+OPTIONS}).}
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8168 @r{If this is smaller than in @code{org-headline-levels}, each}
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8169 @r{info/folding section can still contain children headlines.}
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8170 toc: @r{Should the table of content @emph{initially} be visible?}
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8171 @r{Even when @code{nil}, you can always get to the toc with @kbd{i}.}
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8172 tdepth: @r{The depth of the table of contents. The defaults are taken from}
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8173 @r{the variables @code{org-headline-levels} and @code{org-export-with-toc}.}
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
8174 ftoc: @r{Does the css of the page specify a fixed position for the toc?}
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
8175 @r{If yes, the toc will never be displayed as a section.}
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8176 ltoc: @r{Should there be short contents (children) in each section?}
101758
64835454876e 2009-02-02 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101747
diff changeset
8177 @r{Make this @code{above} it the section should be above initial text.}
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8178 mouse: @r{Headings are highlighted when the mouse is over them. Should be}
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8179 @r{@samp{underline} (default) or a background color like @samp{#cccccc}.}
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8180 buttons: @r{Should view-toggle buttons be everywhere? When @code{nil} (the}
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8181 @r{default), only one such button will be present.}
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8182 @end example
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8183
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8184 You can choose default values for these options by customizing the variable
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8185 @code{org-infojs-options}. If you always want to apply the script to your
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8186 pages, configure the variable @code{org-export-html-use-infojs}.
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8187
99139
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
8188 @node LaTeX and PDF export, XOXO export, HTML export, Exporting
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
8189 @section LaTeX and PDF export
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8190 @cindex LaTeX export
99139
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
8191 @cindex PDF export
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
8192
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
8193 Org mode contains a La@TeX{} exporter written by Bastien Guerry. With
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
8194 further processing, this backend is also used to produce PDF output. Since
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
8195 the LaTeX output uses @file{hyperref} to implement links and cross
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
8196 references, the PDF output file will be fully linked.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8197
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8198 @menu
101147
a62da64665d1 Fix some more typos.
Glenn Morris <rgm@gnu.org>
parents: 101146
diff changeset
8199 * LaTeX/PDF export commands:: Which key invokes which commands
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8200 * Quoting LaTeX code:: Incorporating literal LaTeX code
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8201 * Sectioning structure:: Changing sectioning in LaTeX output
100450
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
8202 * Tables in LaTeX export:: Options for exporting tables to LaTeX
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
8203 * Images in LaTeX export:: How to insert figures into LaTeX output
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8204 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8205
99139
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
8206 @node LaTeX/PDF export commands, Quoting LaTeX code, LaTeX and PDF export, LaTeX and PDF export
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8207 @subsection LaTeX export commands
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8208
100607
87dcbbf4f5fa 2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100508
diff changeset
8209 @cindex region, active
87dcbbf4f5fa 2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100508
diff changeset
8210 @cindex active region
87dcbbf4f5fa 2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100508
diff changeset
8211 @cindex transient-mark-mode
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8212 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8213 @kindex C-c C-e l
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8214 @item C-c C-e l
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
8215 Export as La@TeX{} file @file{myfile.tex}. For an org file
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
8216 @file{myfile.org}, the ASCII file will be @file{myfile.tex}. The file will
100607
87dcbbf4f5fa 2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100508
diff changeset
8217 be overwritten without warning. If there is an active region@footnote{this
87dcbbf4f5fa 2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100508
diff changeset
8218 requires @code{transient-mark-mode} to be turned on}, only the region will be
87dcbbf4f5fa 2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100508
diff changeset
8219 exported. If the selected region is a single tree@footnote{To select the
87dcbbf4f5fa 2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100508
diff changeset
8220 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
87dcbbf4f5fa 2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100508
diff changeset
8221 title. If the tree head entry has or inherits an @code{EXPORT_FILE_NAME}
87dcbbf4f5fa 2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100508
diff changeset
8222 property, that name will be used for the export.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8223 @kindex C-c C-e L
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8224 @item C-c C-e L
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8225 Export to a temporary buffer, do not create a file.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8226 @kindex C-c C-e v l
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8227 @kindex C-c C-e v L
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8228 @item C-c C-e v l
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8229 @item C-c C-e v L
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8230 Export only the visible part of the document.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8231 @item M-x org-export-region-as-latex
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8232 Convert the region to La@TeX{} under the assumption that it was Org mode
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8233 syntax before. This is a global command that can be invoked in any
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8234 buffer.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8235 @item M-x org-replace-region-by-latex
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8236 Replace the active region (assumed to be in Org mode syntax) by La@TeX{}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8237 code.
99139
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
8238 @kindex C-c C-e p
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
8239 @item C-c C-e p
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
8240 Export as LaTeX and then process to PDF.
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
8241 @kindex C-c C-e d
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
8242 @item C-c C-e d
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
8243 Export as LaTeX and then process to PDF, then open the resulting PDF file.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8244 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8245
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8246 @cindex headline levels, for exporting
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8247 In the exported version, the first 3 outline levels will become
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8248 headlines, defining a general document structure. Additional levels
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8249 will be exported as description lists. The exporter can ignore them or
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8250 convert them to a custom string depending on
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8251 @code{org-latex-low-levels}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8252
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8253 If you want that transition to occur at a different level, specify it
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8254 with a numeric prefix argument. For example,
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8255
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8256 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8257 @kbd{C-2 C-c C-e l}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8258 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8259
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8260 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8261 creates two levels of headings and does the rest as items.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8262
99139
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
8263 @node Quoting LaTeX code, Sectioning structure, LaTeX/PDF export commands, LaTeX and PDF export
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8264 @subsection Quoting LaTeX code
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8265
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8266 Embedded La@TeX{} as described in @ref{Embedded LaTeX} will be correctly
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8267 inserted into the La@TeX{} file. This includes simple macros like
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8268 @samp{\ref@{LABEL@}} to create a cross reference to a figure. Furthermore,
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8269 you can add special code that should only be present in La@TeX{} export with
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8270 the following constructs:
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8271
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8272 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8273 #+LaTeX: Literal LaTeX code for export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8274 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8275
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8276 @noindent or
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
8277 @cindex #+BEGIN_LaTeX
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8278
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8279 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8280 #+BEGIN_LaTeX
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8281 All lines between these markers are exported literally
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8282 #+END_LaTeX
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8283 @end example
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8284
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8285 @node Sectioning structure, Tables in LaTeX export, Quoting LaTeX code, LaTeX and PDF export
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8286 @subsection Sectioning structure
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8287 @cindex LaTeX class
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8288 @cindex LaTeX sectioning structure
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8289
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8290 By default, the La@TeX{} output uses the class @code{article}.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8291
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8292 You can change this globally by setting a different value for
99139
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
8293 @code{org-export-latex-default-class} or locally by adding an option like
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8294 @code{#+LaTeX_CLASS: myclass} in your file, or with a @code{:LaTeX_CLASS:}
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8295 property that applies when exporting a region containing only this (sub)tree.
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8296 The class should be listed in @code{org-export-latex-classes}, where you can
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8297 also define the sectioning structure for each class, as well as defining
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8298 additional classes.
99139
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
8299
100450
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
8300 @node Tables in LaTeX export, Images in LaTeX export, Sectioning structure, LaTeX and PDF export
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
8301 @subsection Tables in LaTeX export
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
8302 @cindex tables, in LaTeX export
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
8303
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
8304 For LaTeX export of a table, you can specify a label and a caption
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8305 (@pxref{Markup rules}). You can also use the @code{ATTR_LaTeX} line to
100450
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
8306 request a longtable environment for the table, so that it may span several
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
8307 pages:
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
8308
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
8309 @example
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
8310 #+CAPTION: A long table
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
8311 #+LABEL: tbl:long
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
8312 #+ATTR_LaTeX: longtable
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
8313 | ..... | ..... |
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
8314 | ..... | ..... |
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
8315 @end example
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
8316
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
8317
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
8318 @node Images in LaTeX export, , Tables in LaTeX export, LaTeX and PDF export
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
8319 @subsection Images in LaTeX export
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
8320 @cindex images, inline in LaTeX
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
8321 @cindex inlining images in LaTeX
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
8322
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
8323 Images that are linked to without a description part in the link, like
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
8324 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]} will be inserted into the PDF
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
8325 output files resulting from LaTeX output. Org will use an
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
8326 @code{\includegraphics} macro to insert the image. If you have specified a
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
8327 caption and/or a label as described in @ref{Markup rules}, the figure will
101147
a62da64665d1 Fix some more typos.
Glenn Morris <rgm@gnu.org>
parents: 101146
diff changeset
8328 be wrapped into a @code{figure} environment and thus become a floating
100450
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
8329 element. Finally, you can use an @code{#+ATTR_LaTeX:} line to specify the
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
8330 options that can be used in the optional argument of the
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
8331 @code{\includegraphics} macro.
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
8332
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
8333 @example
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
8334 #+CAPTION: The black-body emission of the disk around HR 4049
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
8335 #+LABEL: fig:SED-HR4049
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
8336 #+ATTR_LaTeX: width=5cm,angle=90
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
8337 [[./img/sed-hr4049.pdf]]
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
8338 @end example
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
8339
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8340 If you need references to a label created in this way, write
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8341 @samp{\ref@{fig:SED-HR4049@}} just like in LaTeX. The default settings will
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8342 recognize files types that can be included as images during processing by
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8343 pdflatex (@file{png}, @file{jpg}, and @file{pdf} files). If you process your
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8344 files in a different way, you may need to customize the variable
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
8345 @code{org-export-latex-inline-image-extensions}.
100450
76e8764c5225 2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100271
diff changeset
8346
99139
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
8347 @node XOXO export, iCalendar export, LaTeX and PDF export, Exporting
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8348 @section XOXO export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8349 @cindex XOXO export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8350
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8351 Org mode contains an exporter that produces XOXO-style output.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8352 Currently, this exporter only handles the general outline structure and
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8353 does not interpret any additional Org mode features.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8354
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8355 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8356 @kindex C-c C-e x
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8357 @item C-c C-e x
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8358 Export as XOXO file @file{myfile.html}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8359 @kindex C-c C-e v
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8360 @item C-c C-e v x
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8361 Export only the visible part of the document.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8362 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8363
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
8364 @node iCalendar export, , XOXO export, Exporting
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8365 @section iCalendar export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8366 @cindex iCalendar export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8367
96976
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
8368 Some people like to use Org mode for keeping track of projects, but still
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
8369 prefer a standard calendar application for anniversaries and appointments.
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
8370 In this case it can be useful to have deadlines and other time-stamped items
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
8371 in Org files show up in the calendar application. Org mode can export
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
8372 calendar information in the standard iCalendar format. If you also want to
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
8373 have TODO entries included in the export, configure the variable
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
8374 @code{org-icalendar-include-todo}. iCalendar export will export plain time
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
8375 stamps as VEVENT, and TODO items as VTODO. It will also create events from
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
8376 deadlines that are in non-TODO items. Deadlines and scheduling dates in TODO
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
8377 items will be used to set the start and due dates for the todo
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
8378 entry@footnote{See the variables @code{org-icalendar-use-deadline} and
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
8379 @code{org-icalendar-use-scheduled}.}. As categories, it will use the tags
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
8380 locally defined in the heading, and the file/tree category@footnote{To add
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
8381 inherited tags or the TODO state, configure the variable
100271
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
8382 @code{org-icalendar-categories}.}.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8383
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
8384 The iCalendar standard requires each entry to have a globally unique
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
8385 identifier (UID). Org creates these identifiers during export. If you set
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
8386 the variable @code{org-icalendar-store-UID}, the UID will be stored in the
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
8387 @code{:ID:} property of the entry and re-used next time you report this
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
8388 entry. Since a single entry can give rise to multiple iCalendar entries (as
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
8389 a timestamp, a deadline, a scheduled item, and as a TODO item), Org adds
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
8390 prefixes to the UID, depending on what triggered the inclusion of the entry.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
8391 In this way the UID remains unique, but a synchronization program can still
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
8392 figure out from which entry all the different instances originate.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
8393
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8394 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8395 @kindex C-c C-e i
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8396 @item C-c C-e i
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8397 Create iCalendar entries for the current file and store them in the same
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8398 directory, using a file extension @file{.ics}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8399 @kindex C-c C-e I
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8400 @item C-c C-e I
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8401 Like @kbd{C-c C-e i}, but do this for all files in
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8402 @code{org-agenda-files}. For each of these files, a separate iCalendar
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8403 file will be written.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8404 @kindex C-c C-e c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8405 @item C-c C-e c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8406 Create a single large iCalendar file from all files in
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8407 @code{org-agenda-files} and write it to the file given by
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8408 @code{org-combined-agenda-icalendar-file}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8409 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8410
100271
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
8411 The export will honor SUMMARY, DESCRIPTION and LOCATION@footnote{The LOCATION
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
8412 property can be inherited from higher in the hierarchy if you configure
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
8413 @code{org-use-property-inheritance} accordingly.} properties if the selected
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
8414 entries have them. If not, the summary will be derived from the headline,
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
8415 and the description from the body (limited to
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
8416 @code{org-icalendar-include-body} characters).
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8417
96976
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
8418 How this calendar is best read and updated, that depends on the application
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8419 you are using. The FAQ covers this issue.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8420
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8421 @node Publishing, Miscellaneous, Exporting, Top
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8422 @chapter Publishing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8423 @cindex publishing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8424
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8425 Org includes@footnote{@file{org-publish.el} is not distributed with
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8426 Emacs 21, if you are still using Emacs 21, you need you need to download
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8427 this file separately.} a publishing management system that allows you to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8428 configure automatic HTML conversion of @emph{projects} composed of
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8429 interlinked org files. This system is called @emph{org-publish}. You can
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8430 also configure org-publish to automatically upload your exported HTML
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8431 pages and related attachments, such as images and source code files, to
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8432 a web server. Org-publish turns Org into a web-site authoring tool.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8433
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8434 You can also use Org-publish to convert files into La@TeX{}, or even
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8435 combine HTML and La@TeX{} conversion so that files are available in both
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8436 formats on the server@footnote{Since La@TeX{} files on a server are not
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8437 that helpful, you surely want to perform further conversion on them --
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8438 e.g. convert them to @code{PDF} format.}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8439
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8440 Org-publish has been contributed to Org by David O'Toole.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8441
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8442 @menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8443 * Configuration:: Defining projects
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8444 * Sample configuration:: Example projects
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8445 * Triggering publication:: Publication commands
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8446 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8447
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8448 @node Configuration, Sample configuration, Publishing, Publishing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8449 @section Configuration
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8450
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8451 Publishing needs significant configuration to specify files, destination
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8452 and many other properties of a project.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8453
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8454 @menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8455 * Project alist:: The central configuration variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8456 * Sources and destinations:: From here to there
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8457 * Selecting files:: What files are part of the project?
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8458 * Publishing action:: Setting the function doing the publishing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8459 * Publishing options:: Tweaking HTML export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8460 * Publishing links:: Which links keep working after publishing?
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8461 * Project page index:: Publishing a list of project files
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8462 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8463
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8464 @node Project alist, Sources and destinations, Configuration, Configuration
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8465 @subsection The variable @code{org-publish-project-alist}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8466 @cindex org-publish-project-alist
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8467 @cindex projects, for publishing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8468
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8469 Org-publish is configured almost entirely through setting the value of
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8470 one variable, called @code{org-publish-project-alist}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8471 Each element of the list configures one project, and may be in one of
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8472 the two following forms:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8473
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8474 @lisp
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8475 ("project-name" :property value :property value ...)
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8476
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
8477 @r{or}
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
8478
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8479 ("project-name" :components ("project-name" "project-name" ...))
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8480
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8481 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8482
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8483 In both cases, projects are configured by specifying property values.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8484 A project defines the set of files that will be published, as well as
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8485 the publishing configuration to use when publishing those files. When
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8486 a project takes the second form listed above, the individual members
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8487 of the ``components'' property are taken to be components of the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8488 project, which group together files requiring different publishing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8489 options. When you publish such a ``meta-project'' all the components
100271
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
8490 will also publish. The @code{:components} are published in the sequence
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
8491 provided.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8492
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8493 @node Sources and destinations, Selecting files, Project alist, Configuration
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8494 @subsection Sources and destinations for files
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8495 @cindex directories, for publishing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8496
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8497 Most properties are optional, but some should always be set. In
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8498 particular, org-publish needs to know where to look for source files,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8499 and where to put published files.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8500
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8501 @multitable @columnfractions 0.3 0.7
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8502 @item @code{:base-directory}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8503 @tab Directory containing publishing source files
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8504 @item @code{:publishing-directory}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8505 @tab Directory (possibly remote) where output files will be published.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8506 @item @code{:preparation-function}
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
8507 @tab Function called before starting the publishing process, for example to
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8508 run @code{make} for updating files to be published.
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
8509 @item @code{:completion-function}
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
8510 @tab Function called after finishing the publishing process, for example to
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
8511 change permissions of the resulting files.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8512 @end multitable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8513 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8514
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8515 @node Selecting files, Publishing action, Sources and destinations, Configuration
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8516 @subsection Selecting files
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8517 @cindex files, selecting for publishing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8518
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8519 By default, all files with extension @file{.org} in the base directory
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8520 are considered part of the project. This can be modified by setting the
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
8521 properties
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8522 @multitable @columnfractions 0.25 0.75
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8523 @item @code{:base-extension}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8524 @tab Extension (without the dot!) of source files. This actually is a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8525 regular expression.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8526
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
8527 @item @code{:exclude}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8528 @tab Regular expression to match file names that should not be
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8529 published, even though they have been selected on the basis of their
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8530 extension.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8531
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8532 @item @code{:include}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8533 @tab List of files to be included regardless of @code{:base-extension}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8534 and @code{:exclude}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8535 @end multitable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8536
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8537 @node Publishing action, Publishing options, Selecting files, Configuration
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8538 @subsection Publishing action
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8539 @cindex action, for publishing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8540
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8541 Publishing means that a file is copied to the destination directory and
99139
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
8542 possibly transformed in the process. The default transformation is to export
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
8543 Org files as HTML files, and this is done by the function
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
8544 @code{org-publish-org-to-html} which calls the HTML exporter (@pxref{HTML
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
8545 export}). But you also can publish your files in La@TeX{} by using the
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
8546 function @code{org-publish-org-to-latex} instead, or as PDF files using
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
8547 @code{org-publish-org-to-pdf}. Other files like images only need to be
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
8548 copied to the publishing destination. For non-Org files, you need to provide
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
8549 your own publishing function:
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8550
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8551 @multitable @columnfractions 0.3 0.7
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8552 @item @code{:publishing-function}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8553 @tab Function executing the publication of a file. This may also be a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8554 list of functions, which will all be called in turn.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8555 @end multitable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8556
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8557 The function must accept two arguments: a property list containing at
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8558 least a @code{:publishing-directory} property, and the name of the file
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8559 to be published. It should take the specified file, make the necessary
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8560 transformation (if any) and place the result into the destination folder.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8561 You can write your own publishing function, but @code{org-publish}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8562 provides one for attachments (files that only need to be copied):
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8563 @code{org-publish-attachment}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8564
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8565 @node Publishing options, Publishing links, Publishing action, Configuration
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8566 @subsection Options for the HTML/LaTeX exporters
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8567 @cindex options, for publishing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8568
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8569 The property list can be used to set many export options for the HTML
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8570 and La@TeX{} exporters. In most cases, these properties correspond to user
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8571 variables in Org. The table below lists these properties along
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8572 with the variable they belong to. See the documentation string for the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8573 respective variable for details.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8574
100271
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
8575 @multitable @columnfractions 0.32 0.68
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
8576 @item @code{:link-up} @tab @code{org-export-html-link-up}
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
8577 @item @code{:link-home} @tab @code{org-export-html-link-home}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8578 @item @code{:language} @tab @code{org-export-default-language}
100271
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
8579 @item @code{:customtime} @tab @code{org-display-custom-times}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8580 @item @code{:headline-levels} @tab @code{org-export-headline-levels}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8581 @item @code{:section-numbers} @tab @code{org-export-with-section-numbers}
100271
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
8582 @item @code{:section-number-format} @tab @code{org-export-section-number-format}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8583 @item @code{:table-of-contents} @tab @code{org-export-with-toc}
100271
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
8584 @item @code{:preserve-breaks} @tab @code{org-export-preserve-breaks}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8585 @item @code{:archived-trees} @tab @code{org-export-with-archived-trees}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8586 @item @code{:emphasize} @tab @code{org-export-with-emphasize}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8587 @item @code{:sub-superscript} @tab @code{org-export-with-sub-superscripts}
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8588 @item @code{:special-strings} @tab @code{org-export-with-special-strings}
100271
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
8589 @item @code{:footnotes} @tab @code{org-export-with-footnotes}
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
8590 @item @code{:drawers} @tab @code{org-export-with-drawers}
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
8591 @item @code{:tags} @tab @code{org-export-with-tags}
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
8592 @item @code{:todo-keywords} @tab @code{org-export-with-todo-keywords}
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
8593 @item @code{:priority} @tab @code{org-export-with-priority}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8594 @item @code{:TeX-macros} @tab @code{org-export-with-TeX-macros}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8595 @item @code{:LaTeX-fragments} @tab @code{org-export-with-LaTeX-fragments}
100271
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
8596 @item @code{:skip-before-1st-heading} @tab @code{org-export-skip-text-before-1st-heading}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8597 @item @code{:fixed-width} @tab @code{org-export-with-fixed-width}
96976
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
8598 @item @code{:timestamps} @tab @code{org-export-with-timestamps}
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
8599 @item @code{:author-info} @tab @code{org-export-author-info}
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
8600 @item @code{:creator-info} @tab @code{org-export-creator-info}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8601 @item @code{:tables} @tab @code{org-export-with-tables}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8602 @item @code{:table-auto-headline} @tab @code{org-export-highlight-first-table-line}
99503
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
8603 @item @code{:style-include-default} @tab @code{org-export-html-style-include-default}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8604 @item @code{:style} @tab @code{org-export-html-style}
96976
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
8605 @item @code{:style-extra} @tab @code{org-export-html-style-extra}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8606 @item @code{:convert-org-links} @tab @code{org-export-html-link-org-files-as-html}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8607 @item @code{:inline-images} @tab @code{org-export-html-inline-images}
100271
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
8608 @item @code{:html-extension} @tab @code{org-export-html-extension}
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
8609 @item @code{:html-table-tag} @tab @code{org-export-html-table-tag}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8610 @item @code{:expand-quoted-html} @tab @code{org-export-html-expand}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8611 @item @code{:timestamp} @tab @code{org-export-html-with-timestamp}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8612 @item @code{:publishing-directory} @tab @code{org-export-publishing-directory}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8613 @item @code{:preamble} @tab @code{org-export-html-preamble}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8614 @item @code{:postamble} @tab @code{org-export-html-postamble}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8615 @item @code{:auto-preamble} @tab @code{org-export-html-auto-preamble}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8616 @item @code{:auto-postamble} @tab @code{org-export-html-auto-postamble}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8617 @item @code{:author} @tab @code{user-full-name}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8618 @item @code{:email} @tab @code{user-mail-address}
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
8619 @item @code{:select-tags} @tab @code{org-export-select-tags}
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
8620 @item @code{:exclude-tags} @tab @code{org-export-exclude-tags}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8621 @end multitable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8622
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8623 If you use several email addresses, separate them by a semi-column.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8624
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8625 Most of the @code{org-export-with-*} variables have the same effect in
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8626 both HTML and La@TeX{} exporters, except for @code{:TeX-macros} and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8627 @code{:LaTeX-fragments}, respectively @code{nil} and @code{t} in the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8628 La@TeX{} export.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8629
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8630 When a property is given a value in @code{org-publish-project-alist},
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8631 its setting overrides the value of the corresponding user variable (if
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8632 any) during publishing. Options set within a file (@pxref{Export
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8633 options}), however, override everything.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8634
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8635 @node Publishing links, Project page index, Publishing options, Configuration
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8636 @subsection Links between published files
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8637 @cindex links, publishing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8638
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8639 To create a link from one Org file to another, you would use
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8640 something like @samp{[[file:foo.org][The foo]]} or simply
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8641 @samp{file:foo.org.} (@pxref{Hyperlinks}). Upon publishing this link
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8642 becomes a link to @file{foo.html}. In this way, you can interlink the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8643 pages of your "org web" project and the links will work as expected when
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8644 you publish them to HTML.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8645
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8646 You may also link to related files, such as images. Provided you are
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8647 careful with relative pathnames, and provided you have also configured
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8648 @code{org-publish} to upload the related files, these links will work
100607
87dcbbf4f5fa 2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 100508
diff changeset
8649 too. See @ref{Complex example} for an example of this usage.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8650
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8651 Sometime an Org file to be published may contain links that are
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8652 only valid in your production environment, but not in the publishing
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
8653 location. In this case, use the property
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8654
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8655 @multitable @columnfractions 0.4 0.6
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8656 @item @code{:link-validation-function}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8657 @tab Function to validate links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8658 @end multitable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8659
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8660 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8661 to define a function for checking link validity. This function must
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8662 accept two arguments, the file name and a directory relative to which
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8663 the file name is interpreted in the production environment. If this
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8664 function returns @code{nil}, then the HTML generator will only insert a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8665 description into the HTML file, but no link. One option for this
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8666 function is @code{org-publish-validate-link} which checks if the given
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8667 file is part of any project in @code{org-publish-project-alist}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8668
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8669 @node Project page index, , Publishing links, Configuration
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8670 @subsection Project page index
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8671 @cindex index, of published pages
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8672
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8673 The following properties may be used to control publishing of an
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8674 index of files or summary page for a given project.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8675
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8676 @multitable @columnfractions 0.25 0.75
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8677 @item @code{:auto-index}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8678 @tab When non-nil, publish an index during org-publish-current-project or
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8679 org-publish-all.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8680
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8681 @item @code{:index-filename}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8682 @tab Filename for output of index. Defaults to @file{index.org} (which
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8683 becomes @file{index.html}).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8684
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8685 @item @code{:index-title}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8686 @tab Title of index page. Defaults to name of file.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8687
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8688 @item @code{:index-function}
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8689 @tab Plug-in function to use for generation of index.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8690 Defaults to @code{org-publish-org-index}, which generates a plain list
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8691 of links to all files in the project.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8692 @end multitable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8693
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8694 @node Sample configuration, Triggering publication, Configuration, Publishing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8695 @section Sample configuration
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8696
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8697 Below we provide two example configurations. The first one is a simple
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8698 project publishing only a set of Org files. The second example is
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8699 more complex, with a multi-component project.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8700
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8701 @menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8702 * Simple example:: One-component publishing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8703 * Complex example:: A multi-component publishing example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8704 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8705
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8706 @node Simple example, Complex example, Sample configuration, Sample configuration
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8707 @subsection Example: simple publishing configuration
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8708
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8709 This example publishes a set of Org files to the @file{public_html}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8710 directory on the local machine.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8711
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8712 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8713 (setq org-publish-project-alist
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
8714 '(("org"
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8715 :base-directory "~/org/"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8716 :publishing-directory "~/public_html"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8717 :section-numbers nil
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8718 :table-of-contents nil
99503
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
8719 :style "<link rel=\"stylesheet\"
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8720 href=\"../other/mystyle.css\"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8721 type=\"text/css\">")))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8722 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8723
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8724 @node Complex example, , Simple example, Sample configuration
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8725 @subsection Example: complex publishing configuration
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8726
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8727 This more complicated example publishes an entire website, including
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8728 org files converted to HTML, image files, emacs lisp source code, and
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8729 style sheets. The publishing-directory is remote and private files are
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8730 excluded.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8731
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8732 To ensure that links are preserved, care should be taken to replicate
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8733 your directory structure on the web server, and to use relative file
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8734 paths. For example, if your org files are kept in @file{~/org} and your
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8735 publishable images in @file{~/images}, you'd link to an image with
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8736 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8737 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8738 file:../images/myimage.png
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8739 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8740 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8741 On the web server, the relative path to the image should be the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8742 same. You can accomplish this by setting up an "images" folder in the
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8743 right place on the web server, and publishing images to it.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8744
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8745 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8746 (setq org-publish-project-alist
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8747 '(("orgfiles"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8748 :base-directory "~/org/"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8749 :base-extension "org"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8750 :publishing-directory "/ssh:user@@host:~/html/notebook/"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8751 :publishing-function org-publish-org-to-html
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8752 :exclude "PrivatePage.org" ;; regexp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8753 :headline-levels 3
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8754 :section-numbers nil
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8755 :table-of-contents nil
99503
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
8756 :style "<link rel=\"stylesheet\"
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8757 href=\"../other/mystyle.css\" type=\"text/css\">"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8758 :auto-preamble t
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8759 :auto-postamble nil)
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
8760
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8761 ("images"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8762 :base-directory "~/images/"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8763 :base-extension "jpg\\|gif\\|png"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8764 :publishing-directory "/ssh:user@@host:~/html/images/"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8765 :publishing-function org-publish-attachment)
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
8766
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8767 ("other"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8768 :base-directory "~/other/"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8769 :base-extension "css\\|el"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8770 :publishing-directory "/ssh:user@@host:~/html/other/"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8771 :publishing-function org-publish-attachment)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8772 ("website" :components ("orgfiles" "images" "other"))))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8773 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8774
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8775 @node Triggering publication, , Sample configuration, Publishing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8776 @section Triggering publication
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8777
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8778 Once org-publish is properly configured, you can publish with the
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
8779 following functions:
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8780
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8781 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8782 @item C-c C-e C
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8783 Prompt for a specific project and publish all files that belong to it.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8784 @item C-c C-e P
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8785 Publish the project containing the current file.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8786 @item C-c C-e F
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8787 Publish only the current file.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8788 @item C-c C-e A
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8789 Publish all projects.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8790 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8791
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8792 Org uses timestamps to track when a file has changed. The above
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8793 functions normally only publish changed files. You can override this and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8794 force publishing of all files by giving a prefix argument.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8795
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
8796 @node Miscellaneous, Extensions, Publishing, Top
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8797 @chapter Miscellaneous
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8798
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8799 @menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8800 * Completion:: M-TAB knows what you need
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8801 * Customization:: Adapting Org to your taste
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8802 * In-buffer settings:: Overview of the #+KEYWORDS
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8803 * The very busy C-c C-c key:: When in doubt, press C-c C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8804 * Clean view:: Getting rid of leading stars in the outline
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8805 * TTY keys:: Using Org on a tty
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8806 * Interaction:: Other Emacs packages
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8807 * Bugs:: Things which do not work perfectly
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8808 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8809
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8810 @node Completion, Customization, Miscellaneous, Miscellaneous
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8811 @section Completion
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8812 @cindex completion, of @TeX{} symbols
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8813 @cindex completion, of TODO keywords
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8814 @cindex completion, of dictionary words
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8815 @cindex completion, of option keywords
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8816 @cindex completion, of tags
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8817 @cindex completion, of property keys
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8818 @cindex completion, of link abbreviations
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8819 @cindex @TeX{} symbol completion
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8820 @cindex TODO keywords completion
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8821 @cindex dictionary word completion
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8822 @cindex option keyword completion
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8823 @cindex tag completion
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8824 @cindex link abbreviations, completion of
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8825
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8826 Org supports in-buffer completion. This type of completion does
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8827 not make use of the minibuffer. You simply type a few letters into
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8828 the buffer and use the key to complete text right there.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8829
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8830 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8831 @kindex M-@key{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8832 @item M-@key{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8833 Complete word at point
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8834 @itemize @bullet
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8835 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8836 At the beginning of a headline, complete TODO keywords.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8837 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8838 After @samp{\}, complete @TeX{} symbols supported by the exporter.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8839 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8840 After @samp{*}, complete headlines in the current buffer so that they
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8841 can be used in search links like @samp{[[*find this headline]]}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8842 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8843 After @samp{:} in a headline, complete tags. The list of tags is taken
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8844 from the variable @code{org-tag-alist} (possibly set through the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8845 @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8846 dynamically from all tags used in the current buffer.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8847 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8848 After @samp{:} and not in a headline, complete property keys. The list
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8849 of keys is constructed dynamically from all keys used in the current
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8850 buffer.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8851 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8852 After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8853 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8854 After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8855 @samp{OPTIONS} which set file-specific options for Org mode. When the
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8856 option keyword is already complete, pressing @kbd{M-@key{TAB}} again
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8857 will insert example settings for this keyword.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8858 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8859 In the line after @samp{#+STARTUP: }, complete startup keywords,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8860 i.e. valid keys for this line.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8861 @item
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8862 Elsewhere, complete dictionary words using Ispell.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8863 @end itemize
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8864 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8865
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8866 @node Customization, In-buffer settings, Completion, Miscellaneous
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8867 @section Customization
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8868 @cindex customization
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8869 @cindex options, for customization
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8870 @cindex variables, for customization
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8871
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8872 There are more than 180 variables that can be used to customize
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8873 Org. For the sake of compactness of the manual, I am not
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8874 describing the variables here. A structured overview of customization
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8875 variables is available with @kbd{M-x org-customize}. Or select
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8876 @code{Browse Org Group} from the @code{Org->Customization} menu. Many
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8877 settings can also be activated on a per-file basis, by putting special
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8878 lines into the buffer (@pxref{In-buffer settings}).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8879
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8880 @node In-buffer settings, The very busy C-c C-c key, Customization, Miscellaneous
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8881 @section Summary of in-buffer settings
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8882 @cindex in-buffer settings
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8883 @cindex special keywords
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8884
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8885 Org mode uses special lines in the buffer to define settings on a
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8886 per-file basis. These lines start with a @samp{#+} followed by a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8887 keyword, a colon, and then individual words defining a setting. Several
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8888 setting words can be in the same line, but you can also have multiple
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8889 lines for the keyword. While these settings are described throughout
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8890 the manual, here is a summary. After changing any of those lines in the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8891 buffer, press @kbd{C-c C-c} with the cursor still in the line to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8892 activate the changes immediately. Otherwise they become effective only
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8893 when the file is visited again in a new Emacs session.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8894
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8895 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8896 @item #+ARCHIVE: %s_done::
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8897 This line sets the archive location for the agenda file. It applies for
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8898 all subsequent lines until the next @samp{#+ARCHIVE} line, or the end
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8899 of the file. The first such line also applies to any entries before it.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8900 The corresponding variable is @code{org-archive-location}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8901 @item #+CATEGORY:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8902 This line sets the category for the agenda file. The category applies
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8903 for all subsequent lines until the next @samp{#+CATEGORY} line, or the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8904 end of the file. The first such line also applies to any entries before it.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8905 @item #+COLUMNS: %25ITEM .....
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8906 Set the default format for columns view. This format applies when
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8907 columns view is invoked in location where no @code{COLUMNS} property
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8908 applies.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8909 @item #+CONSTANTS: name1=value1 ...
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8910 Set file-local values for constants to be used in table formulas. This
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8911 line set the local variable @code{org-table-formula-constants-local}.
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8912 The global version of this variable is
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8913 @code{org-table-formula-constants}.
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
8914 @item #+FILETAGS: :tag1:tag2:tag3:
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
8915 Set tags that can be inherited by any entry in the file, including the
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
8916 top-level entries.
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8917 @item #+DRAWERS: NAME1 .....
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8918 Set the file-local set of drawers. The corresponding global variable is
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8919 @code{org-drawers}.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8920 @item #+LINK: linkword replace
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8921 These lines (several are allowed) specify link abbreviations.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8922 @xref{Link abbreviations}. The corresponding variable is
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8923 @code{org-link-abbrev-alist}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8924 @item #+PRIORITIES: highest lowest default
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8925 This line sets the limits and the default for the priorities. All three
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8926 must be either letters A-Z or numbers 0-9. The highest priority must
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8927 have a lower ASCII number that the lowest priority.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8928 @item #+PROPERTY: Property_Name Value
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8929 This line sets a default inheritance value for entries in the current
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8930 buffer, most useful for specifying the allowed values of a property.
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
8931 @item #+SETUPFILE: file
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
8932 This line defines a file that holds more in-buffer setup. Normally this is
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
8933 entirely ignored. Only when the buffer is parsed for option-setting lines
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
8934 (i.e. when starting Org mode for a file, when pressing @kbd{C-c C-c} in a
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
8935 settings line, or when exporting), then the contents of this file are parsed
101147
a62da64665d1 Fix some more typos.
Glenn Morris <rgm@gnu.org>
parents: 101146
diff changeset
8936 as if they had been included in the buffer. In particular, the file can be
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
8937 any other Org mode file with internal setup. You can visit the file the
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
8938 cursor is in the line with @kbd{C-c '}.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8939 @item #+STARTUP:
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8940 This line sets options to be used at startup of Org mode, when an
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
8941 Org file is being visited. The first set of options deals with the
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8942 initial visibility of the outline tree. The corresponding variable for
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8943 global default settings is @code{org-startup-folded}, with a default
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8944 value @code{t}, which means @code{overview}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8945 @cindex @code{overview}, STARTUP keyword
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8946 @cindex @code{content}, STARTUP keyword
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8947 @cindex @code{showall}, STARTUP keyword
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8948 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8949 overview @r{top-level headlines only}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8950 content @r{all headlines}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8951 showall @r{no folding at all, show everything}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8952 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8953 Then there are options for aligning tables upon visiting a file. This
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8954 is useful in files containing narrowed table columns. The corresponding
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8955 variable is @code{org-startup-align-all-tables}, with a default value
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
8956 @code{nil}.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8957 @cindex @code{align}, STARTUP keyword
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8958 @cindex @code{noalign}, STARTUP keyword
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8959 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8960 align @r{align all tables}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8961 noalign @r{don't align tables on startup}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8962 @end example
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
8963 Logging closing and reinstating TODO items, and clock intervals
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
8964 (variables @code{org-log-done}, @code{org-log-note-clock-out}, and
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
8965 @code{org-log-repeat}) can be configured using these options.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8966 @cindex @code{logdone}, STARTUP keyword
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8967 @cindex @code{lognotedone}, STARTUP keyword
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
8968 @cindex @code{nologdone}, STARTUP keyword
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8969 @cindex @code{lognoteclock-out}, STARTUP keyword
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
8970 @cindex @code{nolognoteclock-out}, STARTUP keyword
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8971 @cindex @code{logrepeat}, STARTUP keyword
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
8972 @cindex @code{lognoterepeat}, STARTUP keyword
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8973 @cindex @code{nologrepeat}, STARTUP keyword
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8974 @example
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
8975 logdone @r{record a timestamp when an item is marked DONE}
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
8976 lognotedone @r{record timestamp and a note when DONE}
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
8977 nologdone @r{don't record when items are marked DONE}
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
8978 logrepeat @r{record a time when reinstating a repeating item}
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
8979 lognoterepeat @r{record a note when reinstating a repeating item}
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
8980 nologrepeat @r{do not record when reinstating repeating item}
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
8981 lognoteclock-out @r{record a note when clocking out}
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
8982 nolognoteclock-out @r{don't record a note when clocking out}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8983 @end example
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
8984 Here are the options for hiding leading stars in outline headings, and for
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
8985 indenting outlines. The corresponding variables are
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
8986 @code{org-hide-leading-stars} and @code{org-odd-levels-only}, both with a
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
8987 default setting @code{nil} (meaning @code{showstars} and @code{oddeven}).
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8988 @cindex @code{hidestars}, STARTUP keyword
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8989 @cindex @code{showstars}, STARTUP keyword
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8990 @cindex @code{odd}, STARTUP keyword
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8991 @cindex @code{even}, STARTUP keyword
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8992 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8993 hidestars @r{make all but one of the stars starting a headline invisible.}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8994 showstars @r{show all stars starting a headline}
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
8995 indent @r{virtual indentation according to outline level}
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
8996 noindent @r{no virtual indentation according to outline level}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8997 odd @r{allow only odd outline levels (1,3,...)}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8998 oddeven @r{allow all outline levels}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8999 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9000 To turn on custom format overlays over time stamps (variables
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9001 @code{org-put-time-stamp-overlays} and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9002 @code{org-time-stamp-overlay-formats}), use
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9003 @cindex @code{customtime}, STARTUP keyword
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9004 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9005 customtime @r{overlay custom time format}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9006 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9007 The following options influence the table spreadsheet (variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9008 @code{constants-unit-system}).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9009 @cindex @code{constcgs}, STARTUP keyword
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9010 @cindex @code{constSI}, STARTUP keyword
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9011 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9012 constcgs @r{@file{constants.el} should use the c-g-s unit system}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9013 constSI @r{@file{constants.el} should use the SI unit system}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9014 @end example
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9015 To influence footnote settings, use the following keywords. The
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9016 corresponding variables are @code{org-footnote-define-inline} and
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9017 @code{org-footnote-auto-label}.
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9018 @cindex @code{fninline}, STARTUP keyword
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9019 @cindex @code{fnnoinline}, STARTUP keyword
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9020 @cindex @code{fnlocal}, STARTUP keyword
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9021 @cindex @code{fnprompt}, STARTUP keyword
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9022 @cindex @code{fnauto}, STARTUP keyword
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9023 @cindex @code{fnconfirm}, STARTUP keyword
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9024 @cindex @code{fnplain}, STARTUP keyword
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9025 @example
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9026 fninline @r{define footnotes inline}
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9027 fnnoinline @r{define footnotes in separate section}
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9028 fnlocal @r{define footnotes near first reference, but not inline}
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9029 fnprompt @r{prompt for footnote labels}
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9030 fnauto @r{create [fn:1]-like labels automatically (default)}
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9031 fnconfirm @r{offer automatic label for editing or confirmation}
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9032 fnplain @r{create [1]-like labels automatically}
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9033 @end example
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9034 @item #+TAGS: TAG1(c1) TAG2(c2)
92148
f991f10f15ec Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 87836
diff changeset
9035 These lines (several such lines are allowed) specify the valid tags in
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9036 this file, and (potentially) the corresponding @emph{fast tag selection}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9037 keys. The corresponding variable is @code{org-tag-alist}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9038 @item #+TBLFM:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9039 This line contains the formulas for the table directly above the line.
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9040 @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+OPTIONS, #+DATE:
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9041 These lines provide settings for exporting files. For more details see
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9042 @ref{Export options}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9043 @item #+SEQ_TODO: #+TYP_TODO:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9044 These lines set the TODO keywords and their interpretation in the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9045 current file. The corresponding variables are @code{org-todo-keywords}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9046 and @code{org-todo-interpretation}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9047 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9048
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9049 @node The very busy C-c C-c key, Clean view, In-buffer settings, Miscellaneous
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9050 @section The very busy C-c C-c key
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9051 @kindex C-c C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9052 @cindex C-c C-c, overview
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9053
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9054 The key @kbd{C-c C-c} has many purposes in Org, which are all
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9055 mentioned scattered throughout this manual. One specific function of
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9056 this key is to add @emph{tags} to a headline (@pxref{Tags}). In many
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9057 other circumstances it means something like @emph{Hey Org, look
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9058 here and update according to what you see here}. Here is a summary of
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9059 what this means in different contexts.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9060
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9061 @itemize @minus
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9062 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9063 If there are highlights in the buffer from the creation of a sparse
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9064 tree, or from clock display, remove these highlights.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9065 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9066 If the cursor is in one of the special @code{#+KEYWORD} lines, this
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9067 triggers scanning the buffer for these lines and updating the
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
9068 information.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9069 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9070 If the cursor is inside a table, realign the table. This command
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9071 works even if the automatic table editor has been turned off.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9072 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9073 If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9074 the entire table.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9075 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9076 If the cursor is inside a table created by the @file{table.el} package,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9077 activate that table.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9078 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9079 If the current buffer is a remember buffer, close the note and file it.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9080 With a prefix argument, file it, without further interaction, to the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9081 default location.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9082 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9083 If the cursor is on a @code{<<<target>>>}, update radio targets and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9084 corresponding links in this buffer.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9085 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9086 If the cursor is in a property line or at the start or end of a property
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9087 drawer, offer property commands.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9088 @item
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9089 If the cursor is at a footnote reference, go to the corresponding
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9090 definition, and vice versa.
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9091 @item
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9092 If the cursor is in a plain list item with a checkbox, toggle the status
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9093 of the checkbox.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9094 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9095 If the cursor is on a numbered item in a plain list, renumber the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9096 ordered list.
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9097 @item
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9098 If the cursor is on the @code{#+BEGIN} line of a dynamical block, the
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9099 block is updated.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9100 @end itemize
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9101
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9102 @node Clean view, TTY keys, The very busy C-c C-c key, Miscellaneous
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9103 @section A cleaner outline view
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9104 @cindex hiding leading stars
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9105 @cindex dynamic indentation
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9106 @cindex odd-levels-only outlines
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9107 @cindex clean outline view
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9108
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9109 Some people find it noisy and distracting that the Org headlines are starting
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9110 with a potentially large number of stars, and that text below the headlines
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9111 is not indented. This is not really a problem when you are writing a book
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9112 where the outline headings are really section headlines. However, in a more
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9113 list-oriented outline, it is clear that an indented structure is a lot
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9114 cleaner, as can be seen by comparing the two columns in the following
100271
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
9115 example:
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9116
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9117 @example
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9118 @group
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9119 * Top level headline | * Top level headline
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9120 ** Second level | * Second level
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9121 *** 3rd level | * 3rd level
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9122 some text | some text
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9123 *** 3rd level | * 3rd level
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9124 more text | more text
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9125 * Another top level headline | * Another top level headline
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9126 @end group
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9127 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9128
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9129 @noindent
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9130 It is non-trivial to make such a look work in Emacs, but Org contains three
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9131 separate features that, combined, achieve just that.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9132
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9133 @enumerate
100271
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
9134 @item
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9135 @emph{Indentation of text below headlines}@*
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9136 You may indent text below each headline to make the left boundary line up
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9137 with the headline, like
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9138
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9139 @example
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9140 *** 3rd level
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9141 more text, now indented
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9142 @end example
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9143
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9144 A good way to get this indentation is by hand, and Org supports this with
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9145 paragraph filling, line wrapping, and structure editing@footnote{See also the
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9146 variable @code{org-adapt-indentation}.} preserving or adapting the
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9147 indentation appropriate. A different approach would be to have a way to
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9148 automatically indent lines according to outline structure by adding overlays
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9149 or text properties. But I have not yet found a robust and efficient way to
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9150 do this in large files.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9151
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9152 @item
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9153 @emph{Hiding leading stars}@* You can modify the display in such a way that
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9154 all leading stars become invisible. To do this in a global way, configure
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9155 the variable @code{org-hide-leading-stars} or change this on a per-file basis
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9156 with
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9157
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9158 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9159 #+STARTUP: hidestars
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9160 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9161
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
9162 @noindent
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
9163 Note that the opposite behavior is selected with @code{showstars}.
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
9164
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9165 With hidden stars, the tree becomes:
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9166
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9167 @example
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9168 @group
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9169 * Top level headline
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9170 * Second level
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9171 * 3rd level
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9172 ...
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9173 @end group
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9174 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9175
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9176 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9177 Note that the leading stars are not truly replaced by whitespace, they
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9178 are only fontified with the face @code{org-hide} that uses the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9179 background color as font color. If you are not using either white or
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9180 black background, you may have to customize this face to get the wanted
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9181 effect. Another possibility is to set this font such that the extra
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9182 stars are @i{almost} invisible, for example using the color
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9183 @code{grey90} on a white background.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9184
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9185 @item
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9186 Things become cleaner still if you skip all the even levels and use only odd
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9187 levels 1, 3, 5..., effectively adding two stars to go from one outline level
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9188 to the next. In this way we get the outline view shown at the beginning of
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9189 this section. In order to make the structure editing and export commands
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9190 handle this convention correctly, configure the variable
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9191 @code{org-odd-levels-only}, or set this on a per-file basis with one of the
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9192 following lines:
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9193
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9194 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9195 #+STARTUP: odd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9196 #+STARTUP: oddeven
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9197 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9198
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9199 You can convert an Org file from single-star-per-level to the
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9200 double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9201 RET} in that file. The reverse operation is @kbd{M-x
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9202 org-convert-to-oddeven-levels}.
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9203 @end enumerate
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9204
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9205 @node TTY keys, Interaction, Clean view, Miscellaneous
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9206 @section Using Org on a tty
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9207 @cindex tty key bindings
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9208
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9209 Because Org contains a large number of commands, by default much of
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9210 Org's core commands are bound to keys that are generally not
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9211 accessible on a tty, such as the cursor keys (@key{left}, @key{right},
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9212 @key{up}, @key{down}), @key{TAB} and @key{RET}, in particular when used
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9213 together with modifiers like @key{Meta} and/or @key{Shift}. To access
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9214 these commands on a tty when special keys are unavailable, the following
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9215 alternative bindings can be used. The tty bindings below will likely be
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9216 more cumbersome; you may find for some of the bindings below that a
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9217 customized work-around suits you better. For example, changing a time
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9218 stamp is really only fun with @kbd{S-@key{cursor}} keys, whereas on a
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9219 tty you would rather use @kbd{C-c .} to re-insert the timestamp.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9220
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9221 @multitable @columnfractions 0.15 0.2 0.2
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9222 @item @b{Default} @tab @b{Alternative 1} @tab @b{Alternative 2}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9223 @item @kbd{S-@key{TAB}} @tab @kbd{C-u @key{TAB}} @tab
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9224 @item @kbd{M-@key{left}} @tab @kbd{C-c C-x l} @tab @kbd{@key{Esc} @key{left}}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9225 @item @kbd{M-S-@key{left}} @tab @kbd{C-c C-x L} @tab
99139
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98649
diff changeset
9226 @item @kbd{M-@key{right}} @tab @kbd{C-c C-x i} @tab @kbd{@key{Esc} @key{right}}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9227 @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R} @tab
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9228 @item @kbd{M-@key{up}} @tab @kbd{C-c C-x u} @tab @kbd{@key{Esc} @key{up}}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9229 @item @kbd{M-S-@key{up}} @tab @kbd{C-c C-x U} @tab
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9230 @item @kbd{M-@key{down}} @tab @kbd{C-c C-x d} @tab @kbd{@key{Esc} @key{down}}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9231 @item @kbd{M-S-@key{down}} @tab @kbd{C-c C-x D} @tab
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9232 @item @kbd{S-@key{RET}} @tab @kbd{C-c C-x c} @tab
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9233 @item @kbd{M-@key{RET}} @tab @kbd{C-c C-x m} @tab @kbd{@key{Esc} @key{RET}}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9234 @item @kbd{M-S-@key{RET}} @tab @kbd{C-c C-x M} @tab
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9235 @item @kbd{S-@key{left}} @tab @kbd{C-c @key{left}} @tab
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9236 @item @kbd{S-@key{right}} @tab @kbd{C-c @key{right}} @tab
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9237 @item @kbd{S-@key{up}} @tab @kbd{C-c @key{up}} @tab
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9238 @item @kbd{S-@key{down}} @tab @kbd{C-c @key{down}} @tab
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9239 @item @kbd{C-S-@key{left}} @tab @kbd{C-c C-x @key{left}} @tab
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9240 @item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9241 @end multitable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9242
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9243 @node Interaction, Bugs, TTY keys, Miscellaneous
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9244 @section Interaction with other packages
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9245 @cindex packages, interaction with other
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9246 Org lives in the world of GNU Emacs and interacts in various ways
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9247 with other code out there.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9248
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9249 @menu
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9250 * Cooperation:: Packages Org cooperates with
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9251 * Conflicts:: Packages that lead to conflicts
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9252 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9253
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9254 @node Cooperation, Conflicts, Interaction, Interaction
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9255 @subsection Packages that Org cooperates with
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9256
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9257 @table @asis
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9258 @cindex @file{calc.el}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9259 @item @file{calc.el} by Dave Gillespie
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9260 Org uses the Calc package for implementing spreadsheet
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9261 functionality in its tables (@pxref{The spreadsheet}). Org
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9262 checks for the availability of Calc by looking for the function
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9263 @code{calc-eval} which should be autoloaded in your setup if Calc has
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9264 been installed properly. As of Emacs 22, Calc is part of the Emacs
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9265 distribution. Another possibility for interaction between the two
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9266 packages is using Calc for embedded calculations. @xref{Embedded Mode,
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9267 , Embedded Mode, Calc, GNU Emacs Calc Manual}.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9268 @cindex @file{constants.el}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9269 @item @file{constants.el} by Carsten Dominik
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9270 In a table formula (@pxref{The spreadsheet}), it is possible to use
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9271 names for natural constants or units. Instead of defining your own
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9272 constants in the variable @code{org-table-formula-constants}, install
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9273 the @file{constants} package which defines a large number of constants
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9274 and units, and lets you use unit prefixes like @samp{M} for
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9275 @samp{Mega} etc. You will need version 2.0 of this package, available
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9276 at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9277 the function @code{constants-get}, which has to be autoloaded in your
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9278 setup. See the installation instructions in the file
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9279 @file{constants.el}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9280 @item @file{cdlatex.el} by Carsten Dominik
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9281 @cindex @file{cdlatex.el}
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9282 Org mode can make use of the CDLaTeX package to efficiently enter
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9283 La@TeX{} fragments into Org files. See @ref{CDLaTeX mode}.
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9284 @item @file{imenu.el} by Ake Stenhoff and Lars Lindberg
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9285 @cindex @file{imenu.el}
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9286 Imenu allows menu access to an index of items in a file. Org mode
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9287 supports Imenu - all you need to do to get the index is the following:
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9288 @lisp
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
9289 (add-hook 'org-mode-hook
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9290 (lambda () (imenu-add-to-menubar "Imenu")))
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9291 @end lisp
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9292 By default the index is two levels deep - you can modify the depth using
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9293 the option @code{org-imenu-depth}.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9294 @item @file{remember.el} by John Wiegley
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9295 @cindex @file{remember.el}
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9296 Org cooperates with remember, see @ref{Remember}.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9297 @file{Remember.el} is not part of Emacs, find it on the web.
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9298 @item @file{speedbar.el} by Eric M. Ludlam
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9299 @cindex @file{speedbar.el}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9300 Speedbar is a package that creates a special frame displaying files and
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9301 index items in files. Org mode supports Speedbar and allows you to
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9302 drill into Org files directly from the Speedbar. It also allows to
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9303 restrict the scope of agenda commands to a file or a subtree by using
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9304 the command @kbd{<} in the Speedbar frame.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9305 @cindex @file{table.el}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9306 @item @file{table.el} by Takaaki Ota
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9307 @kindex C-c C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9308 @cindex table editor, @file{table.el}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9309 @cindex @file{table.el}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9310
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9311 Complex ASCII tables with automatic line wrapping, column- and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9312 row-spanning, and alignment can be created using the Emacs table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9313 package by Takaaki Ota (@uref{http://sourceforge.net/projects/table},
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9314 and also part of Emacs 22).
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9315 When @key{TAB} or @kbd{C-c C-c} is pressed in such a table, Org mode
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9316 will call @command{table-recognize-table} and move the cursor into the
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9317 table. Inside a table, the keymap of Org mode is inactive. In order
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9318 to execute Org mode-related commands, leave the table.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9319
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9320 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9321 @kindex C-c C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9322 @item C-c C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9323 Recognize @file{table.el} table. Works when the cursor is in a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9324 table.el table.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9325 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9326 @kindex C-c ~
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9327 @item C-c ~
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9328 Insert a table.el table. If there is already a table at point, this
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9329 command converts it between the table.el format and the Org mode
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9330 format. See the documentation string of the command
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9331 @code{org-convert-table} for the restrictions under which this is
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9332 possible.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9333 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9334 @file{table.el} is part of Emacs 22.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9335 @cindex @file{footnote.el}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9336 @item @file{footnote.el} by Steven L. Baur
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9337 Org mode recognizes numerical footnotes as provided by this package.
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9338 However, Org-mode also has its own footnote support (@pxref{Footnotes}),
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9339 which makes using @file{footnote.el} unnecessary.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9340 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9341
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9342 @node Conflicts, , Cooperation, Interaction
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9343 @subsection Packages that lead to conflicts with Org mode
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9344
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9345 @table @asis
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9346
101570
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
9347 @cindex @code{shift-selection-mode}
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
9348 In Emacs 23, @code{shift-selection-mode} is on by default, meaning that
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
9349 cursor motions combined with the shift key should start or enlarge regions.
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
9350 This conflicts with the use of @kbd{S-@key{cursor}} commands in Org to change
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
9351 timestamps, TODO keywords, priorities, and item bullet types if the cursor is
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
9352 at such a location. By default, @kbd{S-@key{cursor}} commands outside
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
9353 special contexts don't do anything, but you can customize the variable
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
9354 @code{org-support-shift-select}. Org-mode then tries to accommodate shift
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
9355 selection by (i) using it outside of the special contexts where special
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
9356 commands apply, and by (ii) extending an existing active region even if the
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
9357 cursor moves across a special context.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9358
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9359 @cindex @file{CUA.el}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9360 @item @file{CUA.el} by Kim. F. Storm
101570
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
9361 Key bindings in Org conflict with the @kbd{S-<cursor>} keys used by CUA mode
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
9362 (as well as pc-select-mode and s-region-mode) to select and extend the
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
9363 region. In fact, Emacs 23 has this built-in in the form of
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
9364 @code{shift-selection-mode}, see previous paragraph. If you are using Emacs
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
9365 23 you probably don't want to use another package for this purpose. However,
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
9366 if you prefer to leave these keys to a different package while working in
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
9367 Org-mode, configure the variable @code{org-replace-disputed-keys}. When set,
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
9368 Org will move the following key bindings in Org files, and in the agenda
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
9369 buffer (but not during date selection).
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
9370
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
9371 @example
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
9372 S-UP -> M-p S-DOWN -> M-n
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
9373 S-LEFT -> M-- S-RIGHT -> M-+
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
9374 C-S-LEFT -> M-S-- C-S-RIGHT -> M-S-+
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9375 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9376
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9377 Yes, these are unfortunately more difficult to remember. If you want
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9378 to have other replacement keys, look at the variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9379 @code{org-disputed-keys}.
101570
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
9380
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9381 @item @file{windmove.el} by Hovav Shacham
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9382 @cindex @file{windmove.el}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9383 Also this package uses the @kbd{S-<cursor>} keys, so everything written
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9384 in the paragraph above about CUA mode also applies here.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9385
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9386 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9387
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9388
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9389 @node Bugs, , Interaction, Miscellaneous
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9390 @section Bugs
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9391 @cindex bugs
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9392
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9393 Here is a list of things that should work differently, but which I
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9394 have found too hard to fix.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9395
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9396 @itemize @bullet
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9397 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9398 If a table field starts with a link, and if the corresponding table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9399 column is narrowed (@pxref{Narrow columns}) to a width too small to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9400 display the link, the field would look entirely empty even though it is
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9401 not. To prevent this, Org throws an error. The work-around is to
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9402 make the column wide enough to fit the link, or to add some text (at
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9403 least 2 characters) before the link in the same field.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9404 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9405 Narrowing table columns does not work on XEmacs, because the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9406 @code{format} function does not transport text properties.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9407 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9408 Text in an entry protected with the @samp{QUOTE} keyword should not
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9409 autowrap.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9410 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9411 When the application called by @kbd{C-c C-o} to open a file link fails
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9412 (for example because the application does not exist or refuses to open
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9413 the file), it does so silently. No error message is displayed.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9414 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9415 Recalculating a table line applies the formulas from left to right.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9416 If a formula uses @emph{calculated} fields further down the row,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9417 multiple recalculation may be needed to get all fields consistent. You
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9418 may use the command @code{org-table-iterate} (@kbd{C-u C-c *}) to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9419 recalculate until convergence.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9420 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9421 The exporters work well, but could be made more efficient.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9422 @end itemize
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9423
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9424
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9425 @node Extensions, Hacking, Miscellaneous, Top
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9426 @appendix Extensions
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9427
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9428 This appendix lists the extension modules that have been written for Org.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9429 Many of these extensions live in the @file{contrib} directory of the Org
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9430 distribution, others are available somewhere on the web.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9431
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9432 @menu
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9433 * Extensions in the contrib directory:: These come with the Org distro
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9434 * Other extensions:: These you have to find on the web.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9435 @end menu
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9436
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9437 @node Extensions in the contrib directory, Other extensions, Extensions, Extensions
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9438 @section Extensions in the @file{contrib} directory
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9439
99851
68981b04c1ac 2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99709
diff changeset
9440 A number of extension are distributed with Org when you download it from its
68981b04c1ac 2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99709
diff changeset
9441 homepage. Please note that these extensions are @emph{not} distributed as
68981b04c1ac 2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99709
diff changeset
9442 part of Emacs, so if you use Org as delivered with Emacs, you still need to
68981b04c1ac 2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99709
diff changeset
9443 go to @url{http://orgmode.org} to get access to these modules.
68981b04c1ac 2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99709
diff changeset
9444
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9445 @table @asis
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9446 @item @file{org-annotate-file.el} by @i{Philip Jackson}
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9447 Annotate a file with org syntax, in a separate file, with links back to the
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9448 annotated file.
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9449
100271
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
9450 @item @file{org-annotation-helper.el} by @i{Bastien Guerry and Daniel E. German}
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9451 Call @i{remember} directly from Firefox/Opera, or from Adobe Reader. When
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9452 activating a special link or bookmark, Emacs receives a trigger to create a
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9453 note with a link back to the website. Requires some setup, a detailed
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9454 description is in @file{contrib/packages/org-annotation-helper}.
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9455
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9456 @item @file{org-bookmark.el} by @i{Tokuya Kameshima}
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9457 Support for links to Emacs bookmarks.
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9458
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9459 @item @file{org-depend.el} by @i{Carsten Dominik}
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9460 TODO dependencies for Org-mode. Make TODO state changes in one entry trigger
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9461 changes in another, or be blocked by the state of another entry. Also,
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9462 easily create chains of TODO items with exactly one active item at any time.
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9463
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9464 @item @file{org-elisp-symbol.el} by @i{Bastien Guerry}
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9465 Org links to emacs-lisp symbols. This can create annotated links that
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9466 exactly point to the definition location of a variable of function.
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9467
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9468 @item @file{org-eval.el} by @i{Carsten Dominik}
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9469 The @code{<lisp>} tag, adapted from Emacs Wiki and Emacs Muse, allows text to
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9470 be included in a document that is the result of evaluating some code. Other
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9471 scripting languages like @code{perl} can be supported with this package as
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9472 well.
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9473
99851
68981b04c1ac 2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99709
diff changeset
9474 @item @file{org-eval-light.el} by @i{Eric Schulte}
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9475 User-controlled evaluation of code in an Org buffer.
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9476
99851
68981b04c1ac 2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99709
diff changeset
9477 @item @file{org-exp-blocks.el} by @i{Eric Schulte}
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9478 Preprocess user-defined blocks for export.
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9479
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9480 @item @file{org-expiry.el} by @i{Bastien Guerry}
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9481 Expiry mechanism for Org entries.
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9482
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9483 @item @file{org-indent.el} by @i{Carsten Dominik}
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9484 Dynamic indentation of Org outlines. The plan is to indent an outline
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9485 according to level, but so far this is too hard for a proper and stable
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9486 implementation. Still, it works somewhat.
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9487
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9488 @item @file{org-interactive-query.el} by @i{Christopher League}
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9489 Interactive modification of tags queries. After running a general query in
101570
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
9490 Org, this package allows you to narrow down the results by adding more tags
d5d2428a1b30 2009-01-27 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101509
diff changeset
9491 or keywords.
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9492
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9493 @item @file{org-mairix.el} by @i{Georg C. F. Greve}
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9494 Hook mairix search into Org for different MUAs.
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9495
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9496 @item @file{org-man.el} by @i{Carsten Dominik}
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9497 Support for links to manpages in Org-mode.
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9498
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9499 @item @file{org-mtags.el} by @i{Carsten Dominik}
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9500 Support for some Muse-like tags in Org-mode. This package allows you to
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9501 write @code{<example>} and @code{<src>} and other syntax copied from Emacs
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9502 Muse, right inside an Org file. The goal here is to make it easy to publish
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9503 the same file using either org-publish or Muse.
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9504
101147
a62da64665d1 Fix some more typos.
Glenn Morris <rgm@gnu.org>
parents: 101146
diff changeset
9505 @item @file{org-panel.el} by @i{Lennart Borgman}
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9506 Simplified and display-aided access to some Org commands.
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9507
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9508 @item @file{org-registry.el} by @i{Bastien Guerry}
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9509 A registry for Org links, to find out from where links point to a given file
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9510 or location.
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9511
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9512 @item @file{org2rem.el} by @i{Bastien Guerry}
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9513 Convert org appointments into reminders for the @file{remind} program.
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9514
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9515 @item @file{org-screen.el} by @i{Andrew Hyatt}
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9516 Visit screen sessions through Org-mode links.
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9517
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9518 @item @file{org-toc.el} by @i{Bastien Guerry}
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9519 Table of contents in a separate buffer, with fast access to sections and easy
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9520 visibility cycling.
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9521
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9522 @item @file{orgtbl-sqlinsert.el} by @i{Jason Riedy}
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9523 Convert Org-mode tables to SQL insertions. Documentation for this can be
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9524 found on the Worg pages.
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9525
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9526 @end table
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9527
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9528 @node Other extensions, , Extensions in the contrib directory, Extensions
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9529 @section Other extensions
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9530
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9531 @i{TO BE DONE}
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9532
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9533 @node Hacking, History and Acknowledgments, Extensions, Top
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9534 @appendix Hacking
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9535
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9536 This appendix covers some aspects where users can extend the functionality of
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9537 Org.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9538
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9539 @menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9540 * Adding hyperlink types:: New custom link types
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9541 * Tables in arbitrary syntax:: Orgtbl for LaTeX and other programs
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9542 * Dynamic blocks:: Automatically filled blocks
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9543 * Special agenda views:: Customized views
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9544 * Using the property API:: Writing programs that use entry properties
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9545 * Using the mapping API:: Mapping over all or selected entries
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9546 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9547
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9548 @node Adding hyperlink types, Tables in arbitrary syntax, Hacking, Hacking
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9549 @section Adding hyperlink types
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9550 @cindex hyperlinks, adding new types
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9551
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9552 Org has a large number of hyperlink types built-in
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9553 (@pxref{Hyperlinks}). If you would like to add new link types, it
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
9554 provides an interface for doing so. Let's look at an example file
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9555 @file{org-man.el} that will add support for creating links like
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9556 @samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9557 emacs:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9558
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9559 @lisp
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9560 ;;; org-man.el - Support for links to manpages in Org
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9561
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9562 (require 'org)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9563
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9564 (org-add-link-type "man" 'org-man-open)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9565 (add-hook 'org-store-link-functions 'org-man-store-link)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9566
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9567 (defcustom org-man-command 'man
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9568 "The Emacs command to be used to display a man page."
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9569 :group 'org-link
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9570 :type '(choice (const man) (const woman)))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9571
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9572 (defun org-man-open (path)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9573 "Visit the manpage on PATH.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9574 PATH should be a topic that can be thrown at the man command."
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9575 (funcall org-man-command path))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9576
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9577 (defun org-man-store-link ()
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9578 "Store a link to a manpage."
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9579 (when (memq major-mode '(Man-mode woman-mode))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9580 ;; This is a man page, we do make this link
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9581 (let* ((page (org-man-get-page-name))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9582 (link (concat "man:" page))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9583 (description (format "Manpage for %s" page)))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9584 (org-store-link-props
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9585 :type "man"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9586 :link link
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9587 :description description))))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9588
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9589 (defun org-man-get-page-name ()
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9590 "Extract the page name from the buffer name."
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9591 ;; This works for both `Man-mode' and `woman-mode'.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9592 (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9593 (match-string 1 (buffer-name))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9594 (error "Cannot create link to this man page")))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9595
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9596 (provide 'org-man)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9597
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9598 ;;; org-man.el ends here
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9599 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9600
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9601 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9602 You would activate this new link type in @file{.emacs} with
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9603
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9604 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9605 (require 'org-man)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9606 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9607
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9608 @noindent
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
9609 Let's go through the file and see what it does.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9610 @enumerate
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
9611 @item
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9612 It does @code{(require 'org)} to make sure that @file{org.el} has been
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9613 loaded.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9614 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9615 The next line calls @code{org-add-link-type} to define a new link type
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9616 with prefix @samp{man}. The call also contains the name of a function
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9617 that will be called to follow such a link.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9618 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9619 The next line adds a function to @code{org-store-link-functions}, in
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9620 order to allow the command @kbd{C-c l} to record a useful link in a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9621 buffer displaying a man page.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9622 @end enumerate
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9623
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9624 The rest of the file defines the necessary variables and functions.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9625 First there is a customization variable that determines which emacs
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9626 command should be used to display man pages. There are two options,
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9627 @code{man} and @code{woman}. Then the function to follow a link is
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9628 defined. It gets the link path as an argument - in this case the link
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9629 path is just a topic for the manual command. The function calls the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9630 value of @code{org-man-command} to display the man page.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9631
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9632 Finally the function @code{org-man-store-link} is defined. When you try
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9633 to store a link with @kbd{C-c l}, also this function will be called to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9634 try to make a link. The function must first decide if it is supposed to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9635 create the link for this buffer type, we do this by checking the value
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9636 of the variable @code{major-mode}. If not, the function must exit and
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9637 return the value @code{nil}. If yes, the link is created by getting the
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9638 manual topic from the buffer name and prefixing it with the string
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9639 @samp{man:}. Then it must call the command @code{org-store-link-props}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9640 and set the @code{:type} and @code{:link} properties. Optionally you
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9641 can also set the @code{:description} property to provide a default for
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9642 the link description when the link is later inserted into an Org
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9643 buffer with @kbd{C-c C-l}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9644
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9645 @node Tables in arbitrary syntax, Dynamic blocks, Adding hyperlink types, Hacking
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9646 @section Tables and lists in arbitrary syntax
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9647 @cindex tables, in other modes
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9648 @cindex lists, in other modes
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9649 @cindex Orgtbl mode
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9650
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9651 Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9652 frequent feature request has been to make it work with native tables in
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9653 specific languages, for example La@TeX{}. However, this is extremely
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9654 hard to do in a general way, would lead to a customization nightmare,
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9655 and would take away much of the simplicity of the Orgtbl mode table
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9656 editor.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9657
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9658
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9659 This appendix describes a different approach. We keep the Orgtbl mode
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9660 table in its native format (the @i{source table}), and use a custom
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9661 function to @i{translate} the table to the correct syntax, and to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9662 @i{install} it in the right location (the @i{target table}). This puts
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9663 the burden of writing conversion functions on the user, but it allows
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9664 for a very flexible system.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9665
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9666 Bastien added the ability to do the same with lists. You can use Org's
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9667 facilities to edit and structure lists by turning @code{orgstruct-mode}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9668 on, then locally exporting such lists in another format (HTML, La@TeX{}
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9669 or Texinfo.)
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9670
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9671
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9672 @menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9673 * Radio tables:: Sending and receiving
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9674 * A LaTeX example:: Step by step, almost a tutorial
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9675 * Translator functions:: Copy and modify
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9676 * Radio lists:: Doing the same for lists
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9677 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9678
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9679 @node Radio tables, A LaTeX example, Tables in arbitrary syntax, Tables in arbitrary syntax
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9680 @subsection Radio tables
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9681 @cindex radio tables
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9682
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9683 To define the location of the target table, you first need to create two
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9684 lines that are comments in the current mode, but contain magic words for
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9685 Orgtbl mode to find. Orgtbl mode will insert the translated table
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9686 between these lines, replacing whatever was there before. For example:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9687
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9688 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9689 /* BEGIN RECEIVE ORGTBL table_name */
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9690 /* END RECEIVE ORGTBL table_name */
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9691 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9692
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9693 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9694 Just above the source table, we put a special line that tells
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9695 Orgtbl mode how to translate this table and where to install it. For
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9696 example:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9697 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9698 #+ORGTBL: SEND table_name translation_function arguments....
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9699 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9700
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9701 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9702 @code{table_name} is the reference name for the table that is also used
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9703 in the receiver lines. @code{translation_function} is the Lisp function
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9704 that does the translation. Furthermore, the line can contain a list of
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9705 arguments (alternating key and value) at the end. The arguments will be
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9706 passed as a property list to the translation function for
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9707 interpretation. A few standard parameters are already recognized and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9708 acted upon before the translation function is called:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9709
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9710 @table @code
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9711 @item :skip N
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9712 Skip the first N lines of the table. Hlines do count as separate lines for
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9713 this parameter!
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9714
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9715 @item :skipcols (n1 n2 ...)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9716 List of columns that should be skipped. If the table has a column with
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9717 calculation marks, that column is automatically discarded as well.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9718 Please note that the translator function sees the table @emph{after} the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9719 removal of these columns, the function never knows that there have been
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9720 additional columns.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9721 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9722
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9723 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9724 The one problem remaining is how to keep the source table in the buffer
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9725 without disturbing the normal workings of the file, for example during
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9726 compilation of a C file or processing of a La@TeX{} file. There are a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9727 number of different solutions:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9728
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9729 @itemize @bullet
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9730 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9731 The table could be placed in a block comment if that is supported by the
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9732 language. For example, in C mode you could wrap the table between
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9733 @samp{/*} and @samp{*/} lines.
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
9734 @item
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9735 Sometimes it is possible to put the table after some kind of @i{END}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9736 statement, for example @samp{\bye} in TeX and @samp{\end@{document@}}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9737 in La@TeX{}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9738 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9739 You can just comment the table line by line whenever you want to process
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9740 the file, and uncomment it whenever you need to edit the table. This
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9741 only sounds tedious - the command @kbd{M-x orgtbl-toggle-comment} does
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9742 make this comment-toggling very easy, in particular if you bind it to a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9743 key.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9744 @end itemize
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9745
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9746 @node A LaTeX example, Translator functions, Radio tables, Tables in arbitrary syntax
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9747 @subsection A LaTeX example of radio tables
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9748 @cindex LaTeX, and Orgtbl mode
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9749
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9750 The best way to wrap the source table in La@TeX{} is to use the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9751 @code{comment} environment provided by @file{comment.sty}. It has to be
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9752 activated by placing @code{\usepackage@{comment@}} into the document
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9753 header. Orgtbl mode can insert a radio table skeleton@footnote{By
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9754 default this works only for La@TeX{}, HTML, and Texinfo. Configure the
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9755 variable @code{orgtbl-radio-tables} to install templates for other
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9756 modes.} with the command @kbd{M-x orgtbl-insert-radio-table}. You will
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9757 be prompted for a table name, let's say we use @samp{salesfigures}. You
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9758 will then get the following template:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9759
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9760 @cindex #+ORGTBL: SEND
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9761 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9762 % BEGIN RECEIVE ORGTBL salesfigures
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9763 % END RECEIVE ORGTBL salesfigures
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9764 \begin@{comment@}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9765 #+ORGTBL: SEND salesfigures orgtbl-to-latex
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9766 | | |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9767 \end@{comment@}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9768 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9769
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9770 @noindent
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9771 The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9772 @code{orgtbl-to-latex} to convert the table into La@TeX{} and to put it
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9773 into the receiver location with name @code{salesfigures}. You may now
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9774 fill in the table, feel free to use the spreadsheet features@footnote{If
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9775 the @samp{#+TBLFM} line contains an odd number of dollar characters,
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9776 this may cause problems with font-lock in LaTeX mode. As shown in the
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9777 example you can fix this by adding an extra line inside the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9778 @code{comment} environment that is used to balance the dollar
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9779 expressions. If you are using AUCTeX with the font-latex library, a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9780 much better solution is to add the @code{comment} environment to the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9781 variable @code{LaTeX-verbatim-environments}.}:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9782
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9783 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9784 % BEGIN RECEIVE ORGTBL salesfigures
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9785 % END RECEIVE ORGTBL salesfigures
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9786 \begin@{comment@}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9787 #+ORGTBL: SEND salesfigures orgtbl-to-latex
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9788 | Month | Days | Nr sold | per day |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9789 |-------+------+---------+---------|
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9790 | Jan | 23 | 55 | 2.4 |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9791 | Feb | 21 | 16 | 0.8 |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9792 | March | 22 | 278 | 12.6 |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9793 #+TBLFM: $4=$3/$2;%.1f
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9794 % $ (optional extra dollar to keep font-lock happy, see footnote)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9795 \end@{comment@}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9796 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9797
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9798 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9799 When you are done, press @kbd{C-c C-c} in the table to get the converted
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9800 table inserted between the two marker lines.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9801
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
9802 Now let's assume you want to make the table header by hand, because you
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9803 want to control how columns are aligned etc. In this case we make sure
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9804 that the table translator does skip the first 2 lines of the source
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9805 table, and tell the command to work as a @i{splice}, i.e. to not produce
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9806 header and footer commands of the target table:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9807
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9808 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9809 \begin@{tabular@}@{lrrr@}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9810 Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9811 % BEGIN RECEIVE ORGTBL salesfigures
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9812 % END RECEIVE ORGTBL salesfigures
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9813 \end@{tabular@}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9814 %
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9815 \begin@{comment@}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9816 #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9817 | Month | Days | Nr sold | per day |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9818 |-------+------+---------+---------|
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9819 | Jan | 23 | 55 | 2.4 |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9820 | Feb | 21 | 16 | 0.8 |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9821 | March | 22 | 278 | 12.6 |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9822 #+TBLFM: $4=$3/$2;%.1f
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9823 \end@{comment@}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9824 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9825
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9826 The La@TeX{} translator function @code{orgtbl-to-latex} is already part of
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9827 Orgtbl mode. It uses a @code{tabular} environment to typeset the table
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9828 and marks horizontal lines with @code{\hline}. Furthermore, it
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9829 interprets the following parameters (see also @ref{Translator functions}):
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9830
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9831 @table @code
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9832 @item :splice nil/t
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9833 When set to t, return only table body lines, don't wrap them into a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9834 tabular environment. Default is nil.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9835
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9836 @item :fmt fmt
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9837 A format to be used to wrap each field, should contain @code{%s} for the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9838 original field value. For example, to wrap each field value in dollars,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9839 you could use @code{:fmt "$%s$"}. This may also be a property list with
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9840 column numbers and formats. for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}.
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9841 A function of one argument can be used in place of the strings; the
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9842 function must return a formatted string.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9843
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9844 @item :efmt efmt
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9845 Use this format to print numbers with exponentials. The format should
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9846 have @code{%s} twice for inserting mantissa and exponent, for example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9847 @code{"%s\\times10^@{%s@}"}. The default is @code{"%s\\,(%s)"}. This
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9848 may also be a property list with column numbers and formats, for example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9849 @code{:efmt (2 "$%s\\times10^@{%s@}$" 4 "$%s\\cdot10^@{%s@}$")}. After
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9850 @code{efmt} has been applied to a value, @code{fmt} will also be
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9851 applied. Similar to @code{fmt}, functions of two arguments can be
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9852 supplied instead of strings.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9853 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9854
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9855 @node Translator functions, Radio lists, A LaTeX example, Tables in arbitrary syntax
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9856 @subsection Translator functions
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9857 @cindex HTML, and Orgtbl mode
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9858 @cindex translator function
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9859
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9860 Orgtbl mode has several translator functions built-in: @code{orgtbl-to-csv}
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9861 (comma-separated values), @code{orgtbl-to-tsv} (TAB-separated values)
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9862 @code{orgtbl-to-latex}, @code{orgtbl-to-html}, and @code{orgtbl-to-texinfo}.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9863 Except for @code{orgtbl-to-html}@footnote{The HTML translator uses the same
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9864 code that produces tables during HTML export.}, these all use a generic
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9865 translator, @code{orgtbl-to-generic}. For example, @code{orgtbl-to-latex}
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9866 itself is a very short function that computes the column definitions for the
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9867 @code{tabular} environment, defines a few field and line separators and then
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9868 hands over to the generic translator. Here is the entire code:
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9869
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9870 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9871 @group
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9872 (defun orgtbl-to-latex (table params)
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9873 "Convert the Orgtbl mode TABLE to LaTeX."
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9874 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9875 org-table-last-alignment ""))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9876 (params2
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9877 (list
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9878 :tstart (concat "\\begin@{tabular@}@{" alignment "@}")
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9879 :tend "\\end@{tabular@}"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9880 :lstart "" :lend " \\\\" :sep " & "
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9881 :efmt "%s\\,(%s)" :hline "\\hline")))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9882 (orgtbl-to-generic table (org-combine-plists params2 params))))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9883 @end group
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9884 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9885
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9886 As you can see, the properties passed into the function (variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9887 @var{PARAMS}) are combined with the ones newly defined in the function
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9888 (variable @var{PARAMS2}). The ones passed into the function (i.e. the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9889 ones set by the @samp{ORGTBL SEND} line) take precedence. So if you
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9890 would like to use the La@TeX{} translator, but wanted the line endings to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9891 be @samp{\\[2mm]} instead of the default @samp{\\}, you could just
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9892 overrule the default with
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9893
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9894 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9895 #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9896 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9897
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9898 For a new language, you can either write your own converter function in
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9899 analogy with the La@TeX{} translator, or you can use the generic function
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9900 directly. For example, if you have a language where a table is started
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9901 with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines are
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9902 started with @samp{!BL!}, ended with @samp{!EL!} and where the field
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9903 separator is a TAB, you could call the generic translator like this (on
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9904 a single line!):
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9905
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9906 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9907 #+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9908 :lstart "!BL! " :lend " !EL!" :sep "\t"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9909 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9910
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9911 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9912 Please check the documentation string of the function
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9913 @code{orgtbl-to-generic} for a full list of parameters understood by
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9914 that function and remember that you can pass each of them into
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9915 @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9916 using the generic function.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9917
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9918 Of course you can also write a completely new function doing complicated
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9919 things the generic translator cannot do. A translator function takes
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9920 two arguments. The first argument is the table, a list of lines, each
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9921 line either the symbol @code{hline} or a list of fields. The second
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9922 argument is the property list containing all parameters specified in the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9923 @samp{#+ORGTBL: SEND} line. The function must return a single string
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9924 containing the formatted table. If you write a generally useful
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9925 translator, please post it on @code{emacs-orgmode@@gnu.org} so that
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9926 others can benefit from your work.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9927
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9928 @node Radio lists, , Translator functions, Tables in arbitrary syntax
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9929 @subsection Radio lists
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9930 @cindex radio lists
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9931 @cindex org-list-insert-radio-list
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9932
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9933 Sending and receiving radio lists works exactly the same way than
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9934 sending and receiving radio tables (@pxref{Radio tables}) @footnote{You
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9935 need to load the @code{org-export-latex.el} package to use radio lists
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9936 since the relevant code is there for now.}. As for radio tables, you
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9937 can insert radio lists templates in HTML, La@TeX{} and Texinfo modes by
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9938 calling @code{org-list-insert-radio-list}.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9939
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9940 Here are the differences with radio tables:
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9941
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9942 @itemize @minus
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9943 @item
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9944 Use @code{ORGLST} instead of @code{ORGTBL}.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9945 @item
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9946 The available translation functions for radio lists don't take
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9947 parameters.
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
9948 @item
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9949 `C-c C-c' will work when pressed on the first item of the list.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9950 @end itemize
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9951
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9952 Here is a La@TeX{} example. Let's say that you have this in your
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9953 La@TeX{} file:
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9954
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9955 @example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9956 % BEGIN RECEIVE ORGLST to-buy
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9957 % END RECEIVE ORGLST to-buy
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9958 \begin@{comment@}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9959 #+ORGLIST: SEND to-buy orgtbl-to-latex
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9960 - a new house
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9961 - a new computer
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9962 + a new keyboard
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9963 + a new mouse
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9964 - a new life
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9965 \end@{comment@}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9966 @end example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9967
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9968 Pressing `C-c C-c' on @code{a new house} and will insert the converted
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9969 La@TeX{} list between the two marker lines.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
9970
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9971 @node Dynamic blocks, Special agenda views, Tables in arbitrary syntax, Hacking
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9972 @section Dynamic blocks
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9973 @cindex dynamic blocks
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9974
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
9975 Org documents can contain @emph{dynamic blocks}. These are
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9976 specially marked regions that are updated by some user-written function.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9977 A good example for such a block is the clock table inserted by the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9978 command @kbd{C-c C-x C-r} (@pxref{Clocking work time}).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9979
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9980 Dynamic block are enclosed by a BEGIN-END structure that assigns a name
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9981 to the block and can also specify parameters for the function producing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9982 the content of the block.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9983
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
9984 #+BEGIN:dynamic block
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9985 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9986 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9987
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9988 #+END:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9989 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9990
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9991 Dynamic blocks are updated with the following commands
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9992
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9993 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9994 @kindex C-c C-x C-u
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9995 @item C-c C-x C-u
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9996 Update dynamic block at point.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9997 @kindex C-u C-c C-x C-u
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9998 @item C-u C-c C-x C-u
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9999 Update all dynamic blocks in the current file.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10000 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10001
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10002 Updating a dynamic block means to remove all the text between BEGIN and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10003 END, parse the BEGIN line for parameters and then call the specific
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
10004 writer function for this block to insert the new content. If you want
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
10005 to use the original content in the writer function, you can use the
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
10006 extra parameter @code{:content}.
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
10007
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
10008 For a block with name @code{myblock}, the writer function is
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10009 @code{org-dblock-write:myblock} with as only parameter a property list
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10010 with the parameters given in the begin line. Here is a trivial example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10011 of a block that keeps track of when the block update function was last
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10012 run:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10013
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10014 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10015 #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10016
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10017 #+END:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10018 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10019
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10020 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10021 The corresponding block writer function could look like this:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10022
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10023 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10024 (defun org-dblock-write:block-update-time (params)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10025 (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10026 (insert "Last block update at: "
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10027 (format-time-string fmt (current-time)))))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10028 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10029
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10030 If you want to make sure that all dynamic blocks are always up-to-date,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10031 you could add the function @code{org-update-all-dblocks} to a hook, for
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10032 example @code{before-save-hook}. @code{org-update-all-dblocks} is
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10033 written in a way that is does nothing in buffers that are not in
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10034 @code{org-mode}.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10035
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10036 @node Special agenda views, Using the property API, Dynamic blocks, Hacking
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10037 @section Special agenda views
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10038 @cindex agenda views, user-defined
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10039
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10040 Org provides a special hook that can be used to narrow down the
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10041 selection made by any of the agenda views. You may specify a function
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10042 that is used at each match to verify if the match should indeed be part
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10043 of the agenda view, and if not, how much should be skipped.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10044
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10045 Let's say you want to produce a list of projects that contain a WAITING
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10046 tag anywhere in the project tree. Let's further assume that you have
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10047 marked all tree headings that define a project with the TODO keyword
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10048 PROJECT. In this case you would run a TODO search for the keyword
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10049 PROJECT, but skip the match unless there is a WAITING tag anywhere in
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10050 the subtree belonging to the project line.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10051
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10052 To achieve this, you must write a function that searches the subtree for
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10053 the tag. If the tag is found, the function must return @code{nil} to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10054 indicate that this match should not be skipped. If there is no such
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10055 tag, return the location of the end of the subtree, to indicate that
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10056 search should continue from there.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10057
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10058 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10059 (defun my-skip-unless-waiting ()
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10060 "Skip trees that are not waiting"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10061 (let ((subtree-end (save-excursion (org-end-of-subtree t))))
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
10062 (if (re-search-forward ":waiting:" subtree-end t)
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10063 nil ; tag found, do not skip
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10064 subtree-end))) ; tag not found, continue after end of subtree
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10065 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10066
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10067 Now you may use this function in an agenda custom command, for example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10068 like this:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10069
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10070 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10071 (org-add-agenda-custom-command
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10072 '("b" todo "PROJECT"
99503
9d16e131644e 2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99139
diff changeset
10073 ((org-agenda-skip-function 'my-skip-unless-waiting)
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10074 (org-agenda-overriding-header "Projects waiting for something: "))))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10075 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10076
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10077 Note that this also binds @code{org-agenda-overriding-header} to get a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10078 meaningful header in the agenda view.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10079
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10080 A general way to create custom searches is to base them on a search for
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10081 entries with a certain level limit. If you want to study all entries with
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10082 your custom search function, simply do a search for @samp{LEVEL>0}, and then
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10083 use @code{org-agenda-skip-function} to select the entries you really want to
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10084 have.
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10085
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10086 You may also put a Lisp form into @code{org-agenda-skip-function}. In
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10087 particular, you may use the functions @code{org-agenda-skip-entry-if}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10088 and @code{org-agenda-skip-subtree-if} in this form, for example:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10089
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10090 @table @code
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10091 @item '(org-agenda-skip-entry-if 'scheduled)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10092 Skip current entry if it has been scheduled.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10093 @item '(org-agenda-skip-entry-if 'notscheduled)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10094 Skip current entry if it has not been scheduled.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10095 @item '(org-agenda-skip-entry-if 'deadline)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10096 Skip current entry if it has a deadline.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10097 @item '(org-agenda-skip-entry-if 'scheduled 'deadline)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10098 Skip current entry if it has a deadline, or if it is scheduled.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10099 @item '(org-agenda-skip-entry 'regexp "regular expression")
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
10100 Skip current entry if the regular expression matches in the entry.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
10101 @item '(org-agenda-skip-entry 'notregexp "regular expression")
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
10102 Skip current entry unless the regular expression matches.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10103 @item '(org-agenda-skip-subtree-if 'regexp "regular expression")
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10104 Same as above, but check and skip the entire subtree.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10105 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10106
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10107 Therefore we could also have written the search for WAITING projects
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10108 like this, even without defining a special function:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10109
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10110 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10111 (org-add-agenda-custom-command
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10112 '("b" todo "PROJECT"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10113 ((org-agenda-skip-function '(org-agenda-skip-subtree-if
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
10114 'regexp ":waiting:"))
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10115 (org-agenda-overriding-header "Projects waiting for something: "))))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10116 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10117
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10118 @node Using the property API, Using the mapping API, Special agenda views, Hacking
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10119 @section Using the property API
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10120 @cindex API, for properties
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10121 @cindex properties, API
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10122
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10123 Here is a description of the functions that can be used to work with
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10124 properties.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10125
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10126 @defun org-entry-properties &optional pom which
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10127 Get all properties of the entry at point-or-marker POM.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10128 This includes the TODO keyword, the tags, time strings for deadline,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10129 scheduled, and clocking, and any additional properties defined in the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10130 entry. The return value is an alist, keys may occur multiple times
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10131 if the property key was used several times.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10132 POM may also be nil, in which case the current entry is used.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10133 If WHICH is nil or `all', get all properties. If WHICH is
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10134 `special' or `standard', only get that subclass.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10135 @end defun
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10136 @defun org-entry-get pom property &optional inherit
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10137 Get value of PROPERTY for entry at point-or-marker POM. By default,
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10138 this only looks at properties defined locally in the entry. If INHERIT
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10139 is non-nil and the entry does not have the property, then also check
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10140 higher levels of the hierarchy. If INHERIT is the symbol
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10141 @code{selective}, use inheritance if and only if the setting of
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10142 @code{org-use-property-inheritance} selects PROPERTY for inheritance.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10143 @end defun
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10144
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10145 @defun org-entry-delete pom property
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10146 Delete the property PROPERTY from entry at point-or-marker POM.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10147 @end defun
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10148
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10149 @defun org-entry-put pom property value
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10150 Set PROPERTY to VALUE for entry at point-or-marker POM.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10151 @end defun
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10152
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10153 @defun org-buffer-property-keys &optional include-specials
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10154 Get all property keys in the current buffer.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10155 @end defun
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10156
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10157 @defun org-insert-property-drawer
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10158 Insert a property drawer at point.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10159 @end defun
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10160
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
10161 @defun org-entry-put-multivalued-property pom property &rest values
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
10162 Set PROPERTY at point-or-marker POM to VALUES. VALUES should be a list of
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
10163 strings. They will be concatenated, with spaces as separators.
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
10164 @end defun
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
10165
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
10166 @defun org-entry-get-multivalued-property pom property
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
10167 Treat the value of the property PROPERTY as a whitespace-separated list of
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
10168 values and return the values as a list of strings.
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
10169 @end defun
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
10170
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10171 @defun org-entry-add-to-multivalued-property pom property value
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10172 Treat the value of the property PROPERTY as a whitespace-separated list of
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10173 values and make sure that VALUE is in this list.
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10174 @end defun
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10175
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10176 @defun org-entry-remove-from-multivalued-property pom property value
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10177 Treat the value of the property PROPERTY as a whitespace-separated list of
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10178 values and make sure that VALUE is @emph{not} in this list.
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10179 @end defun
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10180
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10181 @defun org-entry-member-in-multivalued-property pom property value
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10182 Treat the value of the property PROPERTY as a whitespace-separated list of
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10183 values and check if VALUE is in this list.
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10184 @end defun
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10185
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10186 @node Using the mapping API, , Using the property API, Hacking
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10187 @section Using the mapping API
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10188 @cindex API, for mapping
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10189 @cindex mapping entries, API
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10190
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10191 Org has sophisticated mapping capabilities to find all entries satisfying
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10192 certain criteria. Internally, this functionality is used to produce agenda
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10193 views, but there is also an API that can be used to execute arbitrary
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10194 functions for each or selected entries. The main entry point for this API
100271
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
10195 is:
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10196
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10197 @defun org-map-entries func &optional match scope &rest skip
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10198 Call FUNC at each headline selected by MATCH in SCOPE.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10199
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10200 FUNC is a function or a lisp form. The function will be called without
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10201 arguments, with the cursor positioned at the beginning of the headline.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10202 The return values of all calls to the function will be collected and
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10203 returned as a list.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10204
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
10205 MATCH is a tags/property/todo match as it is used in the agenda match view.
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10206 Only headlines that are matched by this query will be considered during
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10207 the iteration. When MATCH is nil or t, all headlines will be
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10208 visited by the iteration.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10209
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10210 SCOPE determines the scope of this command. It can be any of:
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10211
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10212 @example
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10213 nil @r{the current buffer, respecting the restriction if any}
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10214 tree @r{the subtree started with the entry at point}
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10215 file @r{the current buffer, without restriction}
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10216 file-with-archives
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10217 @r{the current buffer, and any archives associated with it}
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10218 agenda @r{all agenda files}
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10219 agenda-with-archives
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10220 @r{all agenda files with any archive files associated with them}
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10221 (file1 file2 ...)
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10222 @r{if this is a list, all files in the list will be scanned}
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10223 @end example
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10224
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10225 The remaining args are treated as settings for the skipping facilities of
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10226 the scanner. The following items can be given here:
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10227
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10228 @example
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10229 archive @r{skip trees with the archive tag}
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10230 comment @r{skip trees with the COMMENT keyword}
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10231 function or Lisp form
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10232 @r{will be used as value for @code{org-agenda-skip-function},}
102151
328f4b370b74 Remove duplicate words.
Juanma Barranquero <lekktu@gmail.com>
parents: 102059
diff changeset
10233 @r{so whenever the function returns t, FUNC}
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10234 @r{will not be called for that entry and search will}
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10235 @r{continue from the point where the function leaves it}
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10236 @end example
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10237 @end defun
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10238
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10239 The function given to that mapping routine can really do anything you like.
101147
a62da64665d1 Fix some more typos.
Glenn Morris <rgm@gnu.org>
parents: 101146
diff changeset
10240 It can use the property API (@pxref{Using the property API}) to gather more
a62da64665d1 Fix some more typos.
Glenn Morris <rgm@gnu.org>
parents: 101146
diff changeset
10241 information about the entry, or in order to change metadata in the entry.
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10242 Here are a couple of functions that might be handy:
100271
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
10243
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10244 @defun org-todo &optional arg
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10245 Change the TODO state of the entry, see the docstring of the functions for
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10246 the many possible values for the argument ARG.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10247 @end defun
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10248
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10249 @defun org-priority &optional action
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10250 Change the priority of the entry, see the docstring of this function for the
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10251 possible values for ACTION.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10252 @end defun
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10253
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10254 @defun org-toggle-tag tag &optional onoff
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10255 Toggle the tag TAG in the current entry. Setting ONOFF to either @code{on}
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10256 or @code{off} will not toggle tag, but ensure that it is either on or off.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10257 @end defun
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10258
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10259 @defun org-promote
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10260 Promote the current entry.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10261 @end defun
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10262
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10263 @defun org-demote
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10264 Demote the current entry.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10265 @end defun
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10266
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10267 Here is a simple example that will turn all entries in the current file with
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10268 a tag @code{TOMORROW} into TODO entries with the keyword @code{UPCOMING}.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10269 Entries in comment trees and in archive trees will be ignored.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10270
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10271 @lisp
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10272 (org-map-entries
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10273 '(org-todo "UPCOMING")
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10274 "+TOMORROW" 'file 'archive 'comment)
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10275 @end lisp
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10276
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10277 The following example counts the number of entries with TODO keyword
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10278 @code{WAITING}, in all agenda files.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10279
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10280 @lisp
100271
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
10281 (length (org-map-entries t "/+WAITING" 'agenda))
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10282 @end lisp
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10283
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10284 @node History and Acknowledgments, Main Index, Hacking, Top
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10285 @appendix History and Acknowledgments
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10286 @cindex acknowledgments
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10287 @cindex history
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10288 @cindex thanks
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10289
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10290 Org was borne in 2003, out of frustration over the user interface
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10291 of the Emacs Outline mode. I was trying to organize my notes and
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10292 projects, and using Emacs seemed to be the natural way to go. However,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10293 having to remember eleven different commands with two or three keys per
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10294 command, only to hide and show parts of the outline tree, that seemed
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10295 entirely unacceptable to me. Also, when using outlines to take notes, I
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10296 constantly want to restructure the tree, organizing it parallel to my
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10297 thoughts and plans. @emph{Visibility cycling} and @emph{structure
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10298 editing} were originally implemented in the package
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10299 @file{outline-magic.el}, but quickly moved to the more general
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10300 @file{org.el}. As this environment became comfortable for project
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10301 planning, the next step was adding @emph{TODO entries}, basic @emph{time
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10302 stamps}, and @emph{table support}. These areas highlight the two main
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10303 goals that Org still has today: To create a new, outline-based,
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10304 plain text mode with innovative and intuitive editing features, and to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10305 incorporate project planning functionality directly into a notes file.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10306
101147
a62da64665d1 Fix some more typos.
Glenn Morris <rgm@gnu.org>
parents: 101146
diff changeset
10307 A special thanks goes to @i{Bastien Guerry} who has not only written a large
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10308 number of extensions to Org (most of them integrated into the core by now),
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10309 but has also helped the development and maintenance of Org so much that he
101609
6be1e380a009 2009-01-28 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101574
diff changeset
10310 should be considered the main co-contributor to this package.
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10311
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10312 Since the first release, literally thousands of emails to me or on
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10313 @code{emacs-orgmode@@gnu.org} have provided a constant stream of bug
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10314 reports, feedback, new ideas, and sometimes patches and add-on code.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10315 Many thanks to everyone who has helped to improve this package. I am
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10316 trying to keep here a list of the people who had significant influence
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10317 in shaping one or more aspects of Org. The list may not be
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10318 complete, if I have forgotten someone, please accept my apologies and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10319 let me know.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10320
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10321 @itemize @bullet
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10322
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10323 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10324 @i{Russel Adams} came up with the idea for drawers.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10325 @item
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10326 @i{Thomas Baumann} wrote @file{org-bbdb.el} and @file{org-mhe.el}.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10327 @item
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10328 @i{Christophe Bataillon} created the great unicorn logo that we use on the
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10329 Org-mode website.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10330 @item
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10331 @i{Alex Bochannek} provided a patch for rounding time stamps.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10332 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10333 @i{Charles Cave}'s suggestion sparked the implementation of templates
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10334 for Remember.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10335 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10336 @i{Pavel Chalmoviansky} influenced the agenda treatment of items with
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10337 specified time.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10338 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10339 @i{Gregory Chernov} patched support for lisp forms into table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10340 calculations and improved XEmacs compatibility, in particular by porting
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10341 @file{nouline.el} to XEmacs.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10342 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10343 @i{Sacha Chua} suggested to copy some linking code from Planner.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10344 @item
101163
4081ddcf7d5f A previous typo fix was incorrect.
Glenn Morris <rgm@gnu.org>
parents: 101148
diff changeset
10345 @i{Eddward DeVilla} proposed and tested checkbox statistics. He also
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10346 came up with the idea of properties, and that there should be an API for
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10347 them.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10348 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10349 @i{Kees Dullemond} used to edit projects lists directly in HTML and so
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10350 inspired some of the early development, including HTML export. He also
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10351 asked for a way to narrow wide table columns.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10352 @item
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10353 @i{Christian Egli} converted the documentation into Texinfo format,
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10354 patched CSS formatting into the HTML exporter, and inspired the agenda.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10355 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10356 @i{David Emery} provided a patch for custom CSS support in exported
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10357 HTML agendas.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10358 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10359 @i{Nic Ferrier} contributed mailcap and XOXO support.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10360 @item
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
10361 @i{Miguel A. Figueroa-Villanueva} implemented hierarchical checkboxes.
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
10362 @item
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10363 @i{John Foerch} figured out how to make incremental search show context
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10364 around a match in a hidden outline tree.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10365 @item
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
10366 @i{Niels Giesen} had the idea to automatically archive DONE trees.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10367 @item
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10368 @i{Bastien Guerry} wrote the La@TeX{} exporter and @file{org-bibtex.el}, and
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10369 has been prolific with patches, ideas, and bug reports.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10370 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10371 @i{Kai Grossjohann} pointed out key-binding conflicts with other packages.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10372 @item
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10373 @i{Bernt Hansen} has driven much of the support for auto-repeating tasks,
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10374 task state change logging, and the clocktable. His clear explanations have
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10375 been critical when we started to adopt the GIT version control system.
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10376 @item
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
10377 @i{Manuel Hermenegildo} has contributed various ideas, small fixed and
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
10378 patches.
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
10379 @item
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10380 @i{Phil Jackson} wrote @file{org-irc.el}.
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10381 @item
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10382 @i{Scott Jaderholm} proposed footnotes, control over whitespace between
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10383 folded entries, and column view for properties.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10384 @item
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10385 @i{Tokuya Kameshima} wrote @file{org-wl.el} and @file{org-mew.el}.
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10386 @item
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10387 @i{Shidai Liu} ("Leo") asked for embedded La@TeX{} and tested it. He also
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10388 provided frequent feedback and some patches.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10389 @item
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
10390 @i{Matt Lundin} has proposed last-row references for table formulas and named
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
10391 invisible anchors. He has also worked a lot on the FAQ.
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
10392 @item
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10393 @i{Jason F. McBrayer} suggested agenda export to CSV format.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10394 @item
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
10395 @i{Max Mikhanosha} came up with the idea of refiling.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
10396 @item
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10397 @i{Dmitri Minaev} sent a patch to set priority limits on a per-file
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10398 basis.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10399 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10400 @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10401 happy.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10402 @item
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
10403 @i{Rick Moynihan} proposed to allow multiple TODO sequences in a file
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
10404 and to be able to quickly restrict the agenda to a subtree.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10405 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10406 @i{Todd Neal} provided patches for links to Info files and elisp forms.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10407 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10408 @i{Tim O'Callaghan} suggested in-file links, search options for general
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10409 file links, and TAGS.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10410 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10411 @i{Takeshi Okano} translated the manual and David O'Toole's tutorial
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10412 into Japanese.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10413 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10414 @i{Oliver Oppitz} suggested multi-state TODO items.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10415 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10416 @i{Scott Otterson} sparked the introduction of descriptive text for
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10417 links, among other things.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10418 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10419 @i{Pete Phillips} helped during the development of the TAGS feature, and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10420 provided frequent feedback.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10421 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10422 @i{T.V. Raman} reported bugs and suggested improvements.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10423 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10424 @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10425 control.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10426 @item
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
10427 @i{Paul Rivier} provided the basic implementation of named footnotes.
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
10428 @item
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10429 @i{Kevin Rogers} contributed code to access VM files on remote hosts.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10430 @item
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10431 @i{Sebastian Rose} wrote @file{org-info.js}, a Java script for displaying
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10432 webpages derived from Org using an Info-like, or a folding interface with
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10433 single key navigation.
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10434 @item
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10435 @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10436 conflict with @file{allout.el}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10437 @item
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10438 @i{Jason Riedy} generalized the send-receive mechanism for orgtbl tables with
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10439 extensive patches.
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10440 @item
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10441 @i{Philip Rooke} created the Org reference card, provided lots
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10442 of feedback, developed and applied standards to the Org documentation.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10443 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10444 @i{Christian Schlauer} proposed angular brackets around links, among
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10445 other things.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10446 @item
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
10447 @i{Eric Schulte} wrote @file{org-plot.el}.
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
10448 @item
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10449 Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10450 @file{organizer-mode.el}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10451 @item
101460
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
10452 @i{Ilya Shlyakhter} proposed the Archive Sibling, line numbering in literal
27ea311fecfa 2009-01-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101273
diff changeset
10453 examples, and remote highlighting for referenced code lines.
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10454 @item
99851
68981b04c1ac 2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99709
diff changeset
10455 @i{Stathis Sideris} wrote the @file{ditaa.jar} ASCII to PNG converter that is
68981b04c1ac 2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99709
diff changeset
10456 now packaged into Org's @file{contrib} directory.
68981b04c1ac 2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 99709
diff changeset
10457 @item
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10458 @i{Daniel Sinder} came up with the idea of internal archiving by locking
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10459 subtrees.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10460 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10461 @i{Dale Smith} proposed link abbreviations.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10462 @item
98649
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
10463 @i{James TD Smith} has contributed a large number of patches for useful
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
10464 tweaks and features.
5796ed317137 Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents: 97382
diff changeset
10465 @item
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10466 @i{Adam Spiers} asked for global linking commands, inspired the link
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10467 extension system, added support for mairix, and proposed the mapping API.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10468 @item
100271
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
10469 @i{Andy Stewart} contributed code to @file{org-w3m.el}, to copy HTML content
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
10470 with links transformation to Org syntax.
ba4358a5f1c6 2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99868
diff changeset
10471 @item
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10472 @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10473 chapter about publishing.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10474 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10475 @i{J@"urgen Vollmer} contributed code generating the table of contents
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10476 in HTML output.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10477 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10478 @i{Chris Wallace} provided a patch implementing the @samp{QUOTE}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10479 keyword.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10480 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10481 @i{David Wainberg} suggested archiving, and improvements to the linking
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10482 system.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10483 @item
96044
c1ef445563bb 2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 95933
diff changeset
10484 @i{John Wiegley} wrote @file{emacs-wiki.el}, @file{planner.el}, and
101609
6be1e380a009 2009-01-28 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101574
diff changeset
10485 @file{muse.el}, which have some overlap with Org. Initially the development
6be1e380a009 2009-01-28 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101574
diff changeset
10486 of Org was fully independent because I was not aware of the existence of
6be1e380a009 2009-01-28 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101574
diff changeset
10487 these packages. But with time I have occasionally looked at John's code and
6be1e380a009 2009-01-28 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101574
diff changeset
10488 learned a lot from it. John has also contributed a number of great ideas and
6be1e380a009 2009-01-28 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101574
diff changeset
10489 patches directly to Org, including the attachment system
6be1e380a009 2009-01-28 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101574
diff changeset
10490 (@file{org-attach.el}), integration with Apple Mail
6be1e380a009 2009-01-28 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 101574
diff changeset
10491 (@file{org-mac-message.el}), and hierarchical dependencies of TODO items.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10492 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10493 @i{Carsten Wimmer} suggested some changes and helped fix a bug in
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10494 linking to Gnus.
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10495 @item
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10496 @i{Roland Winkler} requested additional key bindings to make Org
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10497 work on a tty.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10498 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10499 @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10500 and contributed various ideas and code snippets.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10501 @end itemize
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10502
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10503
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
10504 @node Main Index, Key Index, History and Acknowledgments, Top
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
10505 @unnumbered The Main Index
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10506
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10507 @printindex cp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10508
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
10509 @node Key Index, , Main Index, Top
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10510 @unnumbered Key Index
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10511
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10512 @printindex ky
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10513
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10514 @bye
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10515
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10516 @ignore
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10517 arch-tag: 7893d1Fe-cc57-4d13-b5e5-f494a1CBC7ac
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10518 @end ignore
94409
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10519
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10520 @c Local variables:
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10521 @c ispell-local-dictionary: "en_US-w_accents"
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10522 @c ispell-local-pdict: "./.aspell.org.pws"
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10523 @c fill-column: 77
e0901c47caf2 Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents: 93759
diff changeset
10524 @c End:
96976
86e1b62bcc3e New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents: 96072
diff changeset
10525