annotate doc/misc/org.texi @ 92998:98176f05203c

*** empty log message ***
author Kenichi Handa <handa@m17n.org>
date Sun, 16 Mar 2008 01:53:42 +0000
parents 8fc0a6fd114c
children 4e76a03232e5
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
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4 @settitle Org Mode Manual
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6 @set VERSION 5.23
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
7 @set DATE March 2008
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 @dircategory Emacs
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10 @direntry
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11 * Org Mode: (org). Outline-based notes management and organizer
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12 @end direntry
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14 @c Version and Contact Info
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
15 @set MAINTAINERSITE @uref{http://orgmode.org,maintainers webpage}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16 @set AUTHOR Carsten Dominik
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17 @set MAINTAINER Carsten Dominik
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
18 @set MAINTAINEREMAIL @email{carsten at orgmode dot org}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
19 @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
20 @c %**end of header
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21 @finalout
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
23 @c Macro definitions
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
24
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
25 @c Subheadings inside a table.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
26 @macro tsubheading{text}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
27 @ifinfo
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
28 @subsubheading \text\
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
29 @end ifinfo
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
30 @ifnotinfo
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
31 @item @b{\text\}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
32 @end ifnotinfo
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
33 @end macro
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 @copying
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
36 This manual is for Org-mode (version @value{VERSION}).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
37
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
38 Copyright @copyright{} 2004, 2005, 2006, 2007, 2008 Free Software Foundation
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
39
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
40 @quotation
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
41 Permission is granted to copy, distribute and/or modify this document
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
42 under the terms of the GNU Free Documentation License, Version 1.1 or
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
43 any later version published by the Free Software Foundation; with no
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
44 Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
45 and with the Back-Cover Texts as in (a) below. A copy of the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
46 license is included in the section entitled ``GNU Free Documentation
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
47 License.''
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
48
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
49 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
50 this GNU Manual, like GNU software. Copies published by the Free
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
51 Software Foundation raise funds for GNU development.''
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
52 @end quotation
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
53 @end copying
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
54
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
55 @titlepage
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
56 @title Org Mode Manual
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
57
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
58 @subtitle Release @value{VERSION}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
59 @author by Carsten Dominik
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
60
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
61 @c The following two commands start the copyright page.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
62 @page
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
63 @vskip 0pt plus 1filll
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
64 @insertcopying
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
65 @end titlepage
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
66
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
67 @c Output the table of contents at the beginning.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
68 @contents
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
69
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
70 @ifnottex
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
71 @node Top, Introduction, (dir), (dir)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
72 @top Org Mode Manual
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 @insertcopying
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
75 @end ifnottex
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
76
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
77 @menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
78 * Introduction:: Getting started
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
79 * Document structure:: A tree works like your brain
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
80 * Tables:: Pure magic for quick formatting
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
81 * Hyperlinks:: Notes in context
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
82 * TODO items:: Every tree branch can be a TODO item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
83 * Tags:: Tagging headlines and matching sets of tags
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
84 * Properties and columns:: Storing information about an entry
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
85 * Dates and times:: Making items useful for planning
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
86 * Remember:: Quickly adding nodes to the outline tree
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
87 * Agenda views:: Collecting information into views
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
88 * Embedded LaTeX:: LaTeX fragments and formulas
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
89 * Exporting:: Sharing and publishing of notes
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
90 * Publishing:: Create a web site of linked Org-mode files
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
91 * Miscellaneous:: All the rest which did not fit elsewhere
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
92 * Extensions and Hacking:: It is possible to write add-on code
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
93 * History and Acknowledgments:: How Org-mode came into being
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
94 * Main Index::
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
95 * Key Index:: Key bindings and where they are described
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
96
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
97 @detailmenu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
98 --- The Detailed Node Listing ---
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
99
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
100 Introduction
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 * Summary:: Brief summary of what Org-mode does
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
103 * Installation:: How to install a downloaded version of Org-mode
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
104 * Activation:: How to activate Org-mode for certain buffers.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
105 * Feedback:: Bug reports, ideas, patches etc.
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
106 * Conventions:: Type-setting conventions in the manual
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
107
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
108 Document Structure
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
109
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
110 * Outlines:: Org-mode is based on outline-mode
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
111 * Headlines:: How to typeset org-tree headlines
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
112 * Visibility cycling:: Show and hide, much simplified
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
113 * Motion:: Jumping to other headlines
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
114 * Structure editing:: Changing sequence and level of headlines
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
115 * Archiving:: Move done task trees to a different place
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
116 * Sparse trees:: Matches embedded in context
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
117 * Plain lists:: Additional structure within an entry
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
118 * Drawers:: Tucking stuff away
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
119 * orgstruct-mode:: Structure editing outside Org-mode
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
120
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
121 Archiving
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
122
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
123 * ARCHIVE tag:: Marking a tree as inactive
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
124 * Moving subtrees:: Moving a tree to an archive file
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
125
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
126 Tables
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
127
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
128 * 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
129 * Narrow columns:: Stop wasting space in tables
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
130 * Column groups:: Grouping to trigger vertical lines
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
131 * orgtbl-mode:: The table editor as minor mode
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
132 * The spreadsheet:: The table editor has spreadsheet capabilities.
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 The spreadsheet
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
135
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
136 * References:: How to refer to another field or range
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
137 * Formula syntax for Calc:: Using Calc to compute stuff
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
138 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
139 * Field formulas:: Formulas valid for a single field
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
140 * Column formulas:: Formulas valid for an entire column
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
141 * Editing and debugging formulas:: Fixing formulas
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
142 * Updating the table:: Recomputing all dependent fields
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
143 * Advanced features:: Field names, parameters and automatic recalc
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
144
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
145 Hyperlinks
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
146
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
147 * Link format:: How links in Org-mode are formatted
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
148 * Internal links:: Links to other places in the current file
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
149 * External links:: URL-like links to the world
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
150 * Handling links:: Creating, inserting and following
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
151 * Using links outside Org-mode:: Linking from my C source code?
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
152 * Link abbreviations:: Shortcuts for writing complex links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
153 * Search options:: Linking to a specific location
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
154 * Custom searches:: When the default search is not enough
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
155
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
156 Internal links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
157
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
158 * Radio targets:: Make targets trigger links in plain text.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
159
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
160 TODO items
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
161
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
162 * TODO basics:: Marking and displaying TODO entries
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
163 * TODO extensions:: Workflow and assignments
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
164 * Progress logging:: Dates and notes for progress
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
165 * Priorities:: Some things are more important than others
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
166 * Breaking down tasks:: Splitting a task into manageable pieces
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
167 * Checkboxes:: Tick-off lists
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 Extended use of TODO keywords
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
170
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
171 * Workflow states:: From TODO to DONE in steps
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
172 * TODO types:: I do this, Fred does the rest
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
173 * 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
174 * 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
175 * Per-file keywords:: Different files, different requirements
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
176 * Faces for TODO keywords:: Highlighting states
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
177
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
178 Progress Logging
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
179
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
180 * Closing items:: When was this entry marked DONE?
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
181 * Tracking TODO state changes:: When did the status change?
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
182
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
183 Tags
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
184
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
185 * Tag inheritance:: Tags use the tree structure of the outline
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
186 * Setting tags:: How to assign tags to a headline
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
187 * Tag searches:: Searching for combinations of tags
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
188
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
189 Properties and Columns
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 * Property syntax:: How properties are spelled out
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
192 * Special properties:: Access to other Org-mode features
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
193 * Property searches:: Matching property values
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
194 * Property inheritance:: Passing values down the tree
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
195 * Column view:: Tabular viewing and editing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
196 * Property API:: Properties for Lisp programmers
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
197
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
198 Column View
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
199
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
200 * Defining columns:: The COLUMNS format property
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
201 * Using column view:: How to create and use column view
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
202 * Capturing Column View:: A dynamic block for column view
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
203
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
204 Defining Columns
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
205
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
206 * Scope of column definitions:: Where defined, where valid?
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
207 * Column attributes:: Appearance and content of a column
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
208
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
209 Dates and Times
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
210
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
211 * Time stamps:: Assigning a time to a tree entry
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
212 * Creating timestamps:: Commands which insert timestamps
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
213 * Deadlines and scheduling:: Planning your work
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
214 * Clocking work time::
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
215
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
216 Creating timestamps
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
217
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
218 * The date/time prompt:: How org-mode helps you entering date and time
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
219 * Custom time format:: Making dates look differently
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
220
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
221 Deadlines and Scheduling
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
222
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
223 * Inserting deadline/schedule:: Planning items
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
224 * Repeated tasks:: Items that show up again and again
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
225
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
226 Remember
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
227
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
228 * Setting up remember:: Some code for .emacs to get things going
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
229 * Remember templates:: Define the outline of different note types
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
230 * 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
231 * Refiling notes:: Moving a note or task to a project
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 Agenda Views
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
234
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
235 * Agenda files:: Files being searched for agenda information
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
236 * Agenda dispatcher:: Keyboard access to agenda views
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
237 * Built-in agenda views:: What is available out of the box?
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
238 * Presentation and sorting:: How agenda items are prepared for display
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
239 * Agenda commands:: Remote editing of org trees
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
240 * Custom agenda views:: Defining special searches and views
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
241
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
242 The built-in agenda views
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
243
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
244 * Weekly/Daily agenda:: The calendar page with current tasks
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
245 * Global TODO list:: All unfinished action items
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
246 * Matching tags and properties:: Structured information with fine-tuned search
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
247 * 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
248 * Keyword search:: Finding entries by keyword
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
249 * Stuck projects:: Find projects you need to review
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
250
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
251 Presentation and sorting
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
252
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
253 * Categories:: Not all tasks are equal
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
254 * Time-of-day specifications:: How the agenda knows the time
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
255 * Sorting of agenda items:: The order of things
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
256
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
257 Custom agenda views
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
258
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
259 * Storing searches:: Type once, use often
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
260 * Block agenda:: All the stuff you need in a single buffer
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
261 * Setting Options:: Changing the rules
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
262 * Exporting Agenda Views:: Writing agendas to files.
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
263 * Extracting Agenda Information for other programs::
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
264
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
265 Embedded LaTeX
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 * Math symbols:: TeX macros for symbols and Greek letters
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
268 * Subscripts and Superscripts:: Simple syntax for raising/lowering text
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
269 * LaTeX fragments:: Complex formulas made easy
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
270 * Processing LaTeX fragments:: Previewing LaTeX processing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
271 * CDLaTeX mode:: Speed up entering of formulas
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 Exporting
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 * ASCII export:: Exporting to plain ASCII
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
276 * HTML export:: Exporting to HTML
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
277 * LaTeX export:: Exporting to LaTeX
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
278 * XOXO export:: Exporting to XOXO
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
279 * iCalendar export:: Exporting in iCalendar format
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
280 * Text interpretation:: How the exporter looks at the file
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
281
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
282 HTML export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
283
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
284 * HTML Export commands:: How to invoke LaTeX export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
285 * Quoting HTML tags:: Using direct HTML in Org-mode
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
286 * Links:: Transformation of links for HTML
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
287 * Images:: How to include images
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
288 * CSS support:: Changing the appearence of the output
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
289
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
290 LaTeX export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
291
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
292 * LaTeX export commands:: How to invoke LaTeX export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
293 * Quoting LaTeX code:: Incorporating literal LaTeX code
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
294 * Sectioning structure::
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
295
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
296 Text interpretation by the exporter
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
297
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
298 * Comment lines:: Some lines will not be exported
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
299 * Initial text:: Text before the first headline
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
300 * Footnotes:: Numbers like [1]
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
301 * Quoted examples:: Inserting quoted chnuks of text
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
302 * Enhancing text:: Subscripts, symbols and more
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
303 * Export options:: How to influence the export settings
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
304
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
305 Publishing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
306
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
307 * Configuration:: Defining projects
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
308 * Sample configuration:: Example projects
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
309 * Triggering publication:: Publication commands
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
310
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
311 Configuration
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
312
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
313 * Project alist:: The central configuration variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
314 * Sources and destinations:: From here to there
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
315 * Selecting files:: What files are part of the project?
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
316 * Publishing action:: Setting the function doing the publishing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
317 * Publishing options:: Tweaking HTML export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
318 * Publishing links:: Which links keep working after publishing?
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
319 * Project page index:: Publishing a list of project files
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
320
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
321 Sample configuration
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
322
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
323 * Simple example:: One-component publishing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
324 * Complex example:: A multi-component publishing example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
325
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
326 Miscellaneous
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
327
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
328 * Completion:: M-TAB knows what you need
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
329 * Customization:: Adapting Org-mode to your taste
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
330 * In-buffer settings:: Overview of the #+KEYWORDS
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
331 * 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
332 * Clean view:: Getting rid of leading stars in the outline
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
333 * TTY keys:: Using Org-mode on a tty
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
334 * Interaction:: Other Emacs packages
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
335 * Bugs:: Things which do not work perfectly
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 Interaction with other packages
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 * Cooperation:: Packages Org-mode cooperates with
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
340 * Conflicts:: Packages that lead to conflicts
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
341
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
342 Extensions, Hooks and Hacking
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
343
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
344 * Extensions:: Existing 3rd-part extensions
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
345 * Adding hyperlink types:: New custom link types
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
346 * Tables in arbitrary syntax:: Orgtbl for LaTeX and other programs
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
347 * Dynamic blocks:: Automatically filled blocks
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
348 * Special agenda views:: Customized views
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
349 * Using the property API:: Writing programs that use entry properties
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
350
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
351 Tables and Lists in arbitrary syntax
84308
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 * Radio tables:: Sending and receiving
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
354 * A LaTeX example:: Step by step, almost a tutorial
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
355 * Translator functions:: Copy and modify
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
356 * Radio lists:: Doing the same for lists.
84308
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 @end detailmenu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
359 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
360
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
361 @node Introduction, Document structure, Top, Top
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
362 @chapter Introduction
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
363 @cindex introduction
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
364
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
365 @menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
366 * Summary:: Brief summary of what Org-mode does
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
367 * Installation:: How to install a downloaded version of Org-mode
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
368 * Activation:: How to activate Org-mode for certain buffers.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
369 * Feedback:: Bug reports, ideas, patches etc.
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
370 * Conventions:: Type-setting conventions in the manual
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
371 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
372
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
373 @node Summary, Installation, Introduction, Introduction
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
374 @section Summary
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
375 @cindex summary
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
376
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
377 Org-mode is a mode for keeping notes, maintaining TODO lists, and doing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
378 project planning with a fast and effective plain-text system.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
379
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
380 Org-mode develops organizational tasks around NOTES files that contain
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
381 lists or information about projects as plain text. Org-mode is
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
382 implemented on top of outline-mode, which makes it possible to keep the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
383 content of large files well structured. Visibility cycling and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
384 structure editing help to work with the tree. Tables are easily created
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
385 with a built-in table editor. Org-mode supports TODO items, deadlines,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
386 time stamps, and scheduling. It dynamically compiles entries into an
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
387 agenda that utilizes and smoothly integrates much of the Emacs calendar
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
388 and diary. Plain text URL-like links connect to websites, emails,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
389 Usenet messages, BBDB entries, and any files related to the projects.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
390 For printing and sharing of notes, an Org-mode file can be exported as a
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
391 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
392 iCalendar file. It can also serve as a publishing tool for a set of
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
393 linked webpages.
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 An important design aspect that distinguishes Org-mode from for example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
396 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
397 only once. In Planner, you have project pages, day pages and possibly
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
398 other files, duplicating some information such as tasks. In Org-mode,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
399 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
400 label them with tags and timestamps. All necessary lists like a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
401 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
402 tags etc are created dynamically when you need them.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
403
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
404 Org-mode keeps simple things simple. When first fired up, it should
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
405 feel like a straightforward, easy to use outliner. Complexity is not
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
406 imposed, but a large amount of functionality is available when you need
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
407 it. Org-mode is a toolbox and can be used in different ways, for
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
408 example as:
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 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
411 @r{@bullet{} outline extension with visibility cycling and structure editing}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
412 @r{@bullet{} ASCII system and table editor for taking structured notes}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
413 @r{@bullet{} ASCII table editor with spreadsheet-like capabilities}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
414 @r{@bullet{} TODO list editor}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
415 @r{@bullet{} full agenda and planner with deadlines and work scheduling}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
416 @r{@bullet{} environment to implement David Allen's GTD system}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
417 @r{@bullet{} a basic database application}
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
418 @r{@bullet{} simple hypertext system, with HTML and LaTeX export}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
419 @r{@bullet{} publishing tool to create a set of interlinked webpages}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
420 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
421
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
422 Org-mode's automatic, context sensitive table editor with spreadsheet
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
423 capabilities can be integrated into any major mode by activating the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
424 minor Orgtbl-mode. Using a translation step, it can be used to maintain
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
425 tables in arbitrary file types, for example in La@TeX{}. The structure
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
426 editing and list creation capabilities can be used outside Org-mode with
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
427 the minor Orgstruct-mode.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
428
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
429 @cindex FAQ
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
430 There is a website for Org-mode which provides links to the newest
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
431 version of Org-mode, as well as additional information, frequently asked
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
432 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
433 @uref{http://orgmode.org}.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
434
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
435 @page
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
436
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
437
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
438 @node Installation, Activation, Summary, Introduction
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
439 @section Installation
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
440 @cindex installation
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
441 @cindex XEmacs
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
442
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
443 @b{Important:} @i{If Org-mode is part of the Emacs distribution or an
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
444 XEmacs package, please skip this section and go directly to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
445 @ref{Activation}.}
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 If you have downloaded Org-mode from the Web, you must take the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
448 following steps to install it: Go into the Org-mode distribution
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
449 directory and edit the top section of the file @file{Makefile}. You
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
450 must set the name of the Emacs binary (likely either @file{emacs} or
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
451 @file{xemacs}), and the paths to the directories where local Lisp and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
452 Info files are kept. If you don't have access to the system-wide
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
453 directories, create your own two directories for these files, enter them
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
454 into the Makefile, and make sure Emacs finds the Lisp files by adding
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
455 the following line to @file{.emacs}:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
456
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
457 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
458 (setq load-path (cons "~/path/to/lispdir" load-path))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
459 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
460
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
461 @b{XEmacs users now need to install the file @file{noutline.el} from
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
462 the @file{xemacs} subdirectory of the Org-mode distribution. Use the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
463 command:}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
464
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
465 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
466 @b{make install-noutline}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
467 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
468
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
469 @noindent Now byte-compile and install the Lisp files with the shell
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
470 commands:
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 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
473 make
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
474 make install
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
475 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
476
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
477 @noindent If you want to install the info documentation, use this command:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
478
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
479 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
480 make install-info
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
481 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
482
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
483 @noindent Then add to @file{.emacs}:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
484
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
485 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
486 ;; This line only if org-mode is not part of the X/Emacs distribution.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
487 (require 'org-install)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
488 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
489
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
490 @node Activation, Feedback, Installation, Introduction
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
491 @section Activation
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
492 @cindex activation
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
493 @cindex autoload
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
494 @cindex global keybindings
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
495 @cindex keybindings, global
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
496
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
497 @iftex
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
498 @b{Important:} @i{If you use copy-and-paste to copy lisp code from the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
499 PDF documentation as viewed by Acrobat reader to your .emacs file, the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
500 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
501 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
502 documentation.}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
503 @end iftex
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
504
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
505 Add the following lines to your @file{.emacs} file. The last two lines
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
506 define @emph{global} keys for the commands @command{org-store-link} and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
507 @command{org-agenda} - please choose suitable keys yourself.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
508
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
509 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
510 ;; The following lines are always needed. Choose your own keys.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
511 (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
512 (global-set-key "\C-cl" 'org-store-link)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
513 (global-set-key "\C-ca" 'org-agenda)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
514 @end lisp
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 Furthermore, you must activate @code{font-lock-mode} in org-mode
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
517 buffers, because significant functionality depends on font-locking being
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
518 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
519 (XEmacs user must use the second option):
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
520 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
521 (global-font-lock-mode 1) ; for all buffers
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
522 (add-hook 'org-mode-hook 'turn-on-font-lock) ; org-mode buffers only
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
523 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
524
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
525 @cindex org-mode, turning on
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
526 With this setup, all files with extension @samp{.org} will be put
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
527 into Org-mode. As an alternative, make the first line of a file look
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
528 like this:
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 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
531 MY PROJECTS -*- mode: org; -*-
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
532 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
533
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
534 @noindent which will select Org-mode for this buffer no matter what
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
535 the file's name is. See also the variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
536 @code{org-insert-mode-line-in-empty-file}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
537
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
538 @node Feedback, Conventions, Activation, Introduction
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
539 @section Feedback
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
540 @cindex feedback
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
541 @cindex bug reports
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
542 @cindex maintainer
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
543 @cindex author
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
544
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
545 If you find problems with Org-mode, or if you have questions, remarks,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
546 or ideas about it, please contact the maintainer @value{MAINTAINER} at
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
547 @value{MAINTAINEREMAIL}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
548
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
549 For bug reports, please provide as much information as possible,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
550 including the version information of Emacs (@kbd{C-h v emacs-version
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
551 @key{RET}}) and Org-mode (@kbd{C-h v org-version @key{RET}}), as well as
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
552 the Org-mode related setup in @file{.emacs}. If an error occurs, a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
553 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
554 small example file helps, along with clear information about:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
555
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
556 @enumerate
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
557 @item What exactly did you do?
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
558 @item What did you expect to happen?
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
559 @item What happened instead?
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
560 @end enumerate
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
561 @noindent Thank you for helping to improve this mode.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
562
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
563 @subsubheading How to create a useful backtrace
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
564
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
565 @cindex backtrace of an error
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
566 If working with Org-mode produces an error with a message you don't
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
567 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
568 providing, in addition to what was mentioned above, a @emph{Backtrace}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
569 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
570 error occurred. Here is how to produce a useful backtrace:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
571
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
572 @enumerate
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
573 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
574 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
575 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
576 @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
577 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
578 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
579 @file{org.el} by using the command line
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
580 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
581 emacs -l /path/to/org.el
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
582 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
583 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
584 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
585 (XEmacs has this option in the @code{Troubleshooting} sub-menu).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
586 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
587 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
588 document the steps you take.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
589 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
590 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
591 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
592 attach it to your bug report.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
593 @end enumerate
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
594
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
595 @node Conventions, , Feedback, Introduction
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
596 @section Typesetting conventions used in this manual
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
597
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
598 Org-mode uses three types of keywords: TODO keywords, tags, and property
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
599 names. In this manual we use the following conventions:
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
600
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
601 @table @code
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
602 @item TODO
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
603 @itemx WAITING
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
604 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
605 user-defined.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
606 @item boss
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
607 @itemx ARCHIVE
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
608 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
609 meaning are written with all capitals.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
610 @item Release
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
611 @itemx PRIORITY
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
612 User-defined properties are capitalized; built-in properties with
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
613 special meaning are written with all capitals.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
614 @end table
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
615
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
616 @node Document structure, Tables, Introduction, Top
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
617 @chapter Document Structure
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
618 @cindex document structure
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
619 @cindex structure of document
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
620
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
621 Org-mode is based on outline mode and provides flexible commands to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
622 edit the structure of the document.
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 @menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
625 * Outlines:: Org-mode is based on outline-mode
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
626 * Headlines:: How to typeset org-tree headlines
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
627 * Visibility cycling:: Show and hide, much simplified
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
628 * Motion:: Jumping to other headlines
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
629 * Structure editing:: Changing sequence and level of headlines
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
630 * Archiving:: Move done task trees to a different place
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
631 * Sparse trees:: Matches embedded in context
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
632 * Plain lists:: Additional structure within an entry
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
633 * Drawers:: Tucking stuff away
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
634 * orgstruct-mode:: Structure editing outside Org-mode
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
635 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
636
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
637 @node Outlines, Headlines, Document structure, Document structure
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
638 @section Outlines
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
639 @cindex outlines
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
640 @cindex outline-mode
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
641
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
642 Org-mode is implemented on top of outline-mode. Outlines allow a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
643 document to be organized in a hierarchical structure, which (at least
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
644 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
645 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
646 document to show only the general document structure and the parts
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
647 currently being worked on. Org-mode greatly simplifies the use of
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
648 outlines by compressing the entire show/hide functionality into a single
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
649 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
650
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
651 @node Headlines, Visibility cycling, Outlines, Document structure
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
652 @section Headlines
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
653 @cindex headlines
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
654 @cindex outline tree
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
655
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
656 Headlines define the structure of an outline tree. The headlines in
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
657 Org-mode start with one or more stars, on the left margin@footnote{See
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
658 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
659 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
660
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
661 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
662 * Top level headline
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
663 ** Second level
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
664 *** 3rd level
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
665 some text
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
666 *** 3rd level
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
667 more text
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
668
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
669 * Another top level headline
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
670 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
671
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
672 @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
673 outline that has whitespace followed by a single star as headline
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
674 starters. @ref{Clean view} describes a setup to realize this.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
675
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
676 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
677 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
678 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
679 the subtree, in order to structure the collapsed view. See the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
680 variable @code{org-cycle-separator-lines} to modify this behavior.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
681
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
682 @node Visibility cycling, Motion, Headlines, Document structure
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
683 @section Visibility cycling
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
684 @cindex cycling, visibility
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
685 @cindex visibility cycling
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
686 @cindex trees, visibility
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
687 @cindex show hidden text
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
688 @cindex hide text
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
689
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
690 Outlines make it possible to hide parts of the text in the buffer.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
691 Org-mode uses just two commands, bound to @key{TAB} and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
692 @kbd{S-@key{TAB}} to change the visibility in the buffer.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
693
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
694 @cindex subtree visibility states
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
695 @cindex subtree cycling
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
696 @cindex folded, subtree visibility state
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
697 @cindex children, subtree visibility state
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
698 @cindex subtree, subtree visibility state
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
699 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
700 @kindex @key{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
701 @item @key{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
702 @emph{Subtree cycling}: Rotate current subtree among the states
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
703
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
704 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
705 ,-> FOLDED -> CHILDREN -> SUBTREE --.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
706 '-----------------------------------'
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
707 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
708
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
709 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
710 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
711 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
712 @key{TAB} actually runs global cycling (see below)@footnote{see the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
713 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
714 argument (@kbd{C-u @key{TAB}}), global cycling is invoked.
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 @cindex global visibility states
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
717 @cindex global cycling
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
718 @cindex overview, global visibility state
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
719 @cindex contents, global visibility state
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
720 @cindex show all, global visibility state
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
721 @kindex S-@key{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
722 @item S-@key{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
723 @itemx C-u @key{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
724 @emph{Global cycling}: Rotate the entire buffer among the states
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
725
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
726 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
727 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
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 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
730
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
731 When @kbd{S-@key{TAB}} is called with a numerical prefix N, the CONTENTS
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
732 view up to headlines of level N will be shown.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
733 Note that inside tables, @kbd{S-@key{TAB}} jumps to the previous field.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
734
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
735 @cindex show all, command
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
736 @kindex C-c C-a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
737 @item C-c C-a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
738 Show all.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
739 @kindex C-c C-r
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
740 @item C-c C-r
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
741 Reveal context around point, showing the current entry, the following
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
742 heading and the hierarchy above. Useful for working near a location
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
743 that has been exposed by a sparse tree command (@pxref{Sparse trees}) or
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
744 an agenda command (@pxref{Agenda commands}). With prefix arg show, on
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
745 each
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
746
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
747 level, all sibling headings.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
748 @kindex C-c C-x b
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
749 @item C-c C-x b
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
750 Show the current subtree in an indirect buffer@footnote{The indirect
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
751 buffer
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
752 @ifinfo
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
753 (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual})
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
754 @end ifinfo
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
755 @ifnotinfo
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
756 (see the Emacs manual for more information about indirect buffers)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
757 @end ifnotinfo
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
758 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
759 tree. Editing the indirect buffer will also change the original buffer,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
760 but without affecting visibility in that buffer.}. With numerical
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
761 prefix ARG, go up to this level and then take that tree. If ARG is
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
762 negative, go up that many levels. With @kbd{C-u} prefix, do not remove
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
763 the previously used indirect buffer.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
764 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
765
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
766 When Emacs first visits an Org-mode file, the global state is set to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
767 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
768 configured through the variable @code{org-startup-folded}, or on a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
769 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
770 buffer:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
771
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
772 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
773 #+STARTUP: overview
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
774 #+STARTUP: content
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
775 #+STARTUP: showall
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
776 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
777
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
778 @node Motion, Structure editing, Visibility cycling, Document structure
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
779 @section Motion
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
780 @cindex motion, between headlines
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
781 @cindex jumping, to headlines
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
782 @cindex headline navigation
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
783 The following commands jump to other headlines in the buffer.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
784
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
785 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
786 @kindex C-c C-n
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
787 @item C-c C-n
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
788 Next heading.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
789 @kindex C-c C-p
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
790 @item C-c C-p
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
791 Previous heading.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
792 @kindex C-c C-f
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
793 @item C-c C-f
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
794 Next heading same level.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
795 @kindex C-c C-b
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
796 @item C-c C-b
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
797 Previous heading same level.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
798 @kindex C-c C-u
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
799 @item C-c C-u
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
800 Backward to higher level heading.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
801 @kindex C-c C-j
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
802 @item C-c C-j
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
803 Jump to a different place without changing the current outline
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
804 visibility. Shows the document structure in a temporary buffer, where
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
805 you can use the following keys to find your destination:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
806 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
807 @key{TAB} @r{Cycle visibility.}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
808 @key{down} / @key{up} @r{Next/previous visible headline.}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
809 n / p @r{Next/previous visible headline.}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
810 f / b @r{Next/previous headline same level.}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
811 u @r{One level up.}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
812 0-9 @r{Digit argument.}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
813 @key{RET} @r{Select this location.}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
814 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
815 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
816
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
817 @node Structure editing, Archiving, Motion, Document structure
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
818 @section Structure editing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
819 @cindex structure editing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
820 @cindex headline, promotion and demotion
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
821 @cindex promotion, of subtrees
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
822 @cindex demotion, of subtrees
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
823 @cindex subtree, cut and paste
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
824 @cindex pasting, of subtrees
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
825 @cindex cutting, of subtrees
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
826 @cindex copying, of subtrees
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
827 @cindex subtrees, cut and paste
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
828
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
829 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
830 @kindex M-@key{RET}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
831 @item M-@key{RET}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
832 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
833 plain list item, a new item is created (@pxref{Plain lists}). To force
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
834 creation of a new headline, use a prefix arg, or first press @key{RET}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
835 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
836 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
837 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
838 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
839 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
840 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
841 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
842 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
843 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
844 after the end of the subtree.
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
845 @kindex C-@key{RET}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
846 @item C-@key{RET}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
847 Insert a new heading after the current subtree, same level as the
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
848 current headline. This command works from anywhere in the entry.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
849 @kindex M-S-@key{RET}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
850 @item M-S-@key{RET}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
851 Insert new TODO entry with same level as current heading.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
852 @kindex M-@key{left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
853 @item M-@key{left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
854 Promote current heading by one level.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
855 @kindex M-@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
856 @item M-@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
857 Demote current heading by one level.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
858 @kindex M-S-@key{left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
859 @item M-S-@key{left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
860 Promote the current subtree by one level.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
861 @kindex M-S-@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
862 @item M-S-@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
863 Demote the current subtree by one level.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
864 @kindex M-S-@key{up}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
865 @item M-S-@key{up}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
866 Move subtree up (swap with previous subtree of same
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
867 level).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
868 @kindex M-S-@key{down}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
869 @item M-S-@key{down}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
870 Move subtree down (swap with next subtree of same level).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
871 @kindex C-c C-x C-w
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
872 @kindex C-c C-x C-k
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
873 @item C-c C-x C-w
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
874 @itemx C-c C-x C-k
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
875 Kill subtree, i.e. remove it from buffer but save in kill ring.
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
876 With prefix arg, kill N sequential subtrees.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
877 @kindex C-c C-x M-w
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
878 @item C-c C-x M-w
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
879 Copy subtree to kill ring. With prefix arg, copy N sequential subtrees.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
880 @kindex C-c C-x C-y
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
881 @item C-c C-x C-y
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
882 Yank subtree from kill ring. This does modify the level of the subtree to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
883 make sure the tree fits in nicely at the yank position. The yank
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
884 level can also be specified with a prefix arg, or by yanking after a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
885 headline marker like @samp{****}.
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
886 @kindex C-c C-w
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
887 @item C-c C-w
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
888 Refile entry to a different location. @xref{Refiling notes}.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
889 @kindex C-c ^
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
890 @item C-c ^
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
891 Sort same-level entries. When there is an active region, all entries in
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
892 the region will be sorted. Otherwise the children of the current
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
893 headline are sorted. The command prompts for the sorting method, which
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
894 can be alphabetically, numerically, by time (using the first time stamp
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
895 in each entry), by priority, and each of these in reverse order. You
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
896 can also supply your own function to extract the sorting key. With a
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
897 @kbd{C-u} prefix, sorting will be case-sensitive. With two @kbd{C-u
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
898 C-u} prefixes, duplicate entries will also be removed.
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
899 @kindex C-c *
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
900 @item C-c *
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
901 Turn a normal line or plain list item into a headline (so that it
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
902 becomes a subheading at its location). Also turn a headline into a
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
903 normal line by removing the stars. If there is an active region, turn
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
904 all lines in the region into headlines. Or, if the first line is a
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
905 headline, remove the stars from all headlines in the region.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
906 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
907
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
908 @cindex region, active
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
909 @cindex active region
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
910 @cindex transient-mark-mode
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
911 When there is an active region (transient-mark-mode), promotion and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
912 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
913 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
914 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
915 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
916 inside a table (@pxref{Tables}), the Meta-Cursor keys have different
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
917 functionality.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
918
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
919 @node Archiving, Sparse trees, Structure editing, Document structure
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
920 @section Archiving
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
921 @cindex archiving
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
922
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
923 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
924 to move the tree out of the way and to stop it from contributing to the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
925 agenda. Org-mode knows two ways of archiving. You can mark a tree with
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
926 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
927 location.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
928
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
929 @menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
930 * ARCHIVE tag:: Marking a tree as inactive
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
931 * Moving subtrees:: Moving a tree to an archive file
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
932 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
933
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
934 @node ARCHIVE tag, Moving subtrees, Archiving, Archiving
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
935 @subsection The ARCHIVE tag
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
936 @cindex internal archiving
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
937
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
938 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
939 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
940 @itemize @minus
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
941 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
942 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
943 command (@pxref{Visibility cycling}). You can force cycling archived
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
944 subtrees with @kbd{C-@key{TAB}}, or by setting the option
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
945 @code{org-cycle-open-archived-trees}. Also normal outline commands like
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
946 @code{show-all} will open archived subtrees.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
947 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
948 During sparse tree construction (@pxref{Sparse trees}), matches in
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
949 archived subtrees are not exposed, unless you configure the option
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
950 @code{org-sparse-tree-open-archived-trees}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
951 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
952 During agenda view construction (@pxref{Agenda views}), the content of
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
953 archived trees is ignored unless you configure the option
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
954 @code{org-agenda-skip-archived-trees}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
955 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
956 Archived trees are not exported (@pxref{Exporting}), only the headline
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
957 is. Configure the details using the variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
958 @code{org-export-with-archived-trees}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
959 @end itemize
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
960
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
961 The following commands help managing the ARCHIVE tag:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
962
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
963 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
964 @kindex C-c C-x C-a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
965 @item C-c C-x C-a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
966 Toggle the ARCHIVE tag for the current headline. When the tag is set,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
967 the headline changes to a shadowish face, and the subtree below it is
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
968 hidden.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
969 @kindex C-u C-c C-x C-a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
970 @item C-u C-c C-x C-a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
971 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
972 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
973 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
974 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
975 level 1 trees will be checked.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
976 @kindex C-@kbd{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
977 @item C-@kbd{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
978 Cycle a tree even if it is tagged with ARCHIVE.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
979 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
980
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
981 @node Moving subtrees, , ARCHIVE tag, Archiving
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
982 @subsection Moving subtrees
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
983 @cindex external archiving
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
984
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
985 Once an entire project is finished, you may want to move it to a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
986 different location, either in the current file, or even in a different
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
987 file, the archive file.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
988
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
989 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
990 @kindex C-c C-x C-s
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
991 @item C-c C-x C-s
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
992 Archive the subtree starting at the cursor position to the location
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
993 given by @code{org-archive-location}. Context information that could be
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
994 lost like the file name, the category, inherited tags, and the todo
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
995 state will be store as properties in the entry.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
996 @kindex C-u C-c C-x C-s
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
997 @item C-u C-c C-x C-s
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
998 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
999 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
1000 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
1001 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
1002 is invoked, the level 1 trees will be checked.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1003 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1004
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1005 @cindex archive locations
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1006 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
1007 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
1008 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
1009 see the documentation string of the variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1010 @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
1011 setting this variable, for example@footnote{For backward compatibility,
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1012 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
1013 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
1014 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
1015 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
1016 with the outline structure of the document. The correct method for
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1017 setting multiple archive locations in a buffer is using a property.}:
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1018
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1019 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1020 #+ARCHIVE: %s_done::
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1021 @end example
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 @noindent
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1024 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
1025 or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1026 location as the value (@pxref{Properties and columns}).
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1027
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
1028 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
1029 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
1030 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
1031 @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
1032 added.
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
1033
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1034 @node Sparse trees, Plain lists, Archiving, Document structure
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1035 @section Sparse trees
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1036 @cindex sparse trees
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1037 @cindex trees, sparse
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1038 @cindex folding, sparse trees
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1039 @cindex occur, command
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1040
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1041 An important feature of Org-mode is the ability to construct
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1042 @emph{sparse trees} for selected information in an outline tree, so that
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1043 the entire document is folded as much as possible, but the selected
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1044 information is made visible along with the headline structure above
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1045 it@footnote{See also the variables @code{org-show-hierarchy-above},
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1046 @code{org-show-following-heading}, and @code{org-show-siblings} for
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1047 detailed control on how much context is shown around each match.}. Just
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1048 try it out and you will see immediately how it works.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1049
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1050 Org-mode contains several commands creating such trees, all these
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1051 commands can be accessed through a dispatcher:
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1052
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1053 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1054 @kindex C-c /
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1055 @item C-c /
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1056 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
1057 @kindex C-c / r
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1058 @item C-c / r
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1059 Occur. Prompts for a regexp and shows a sparse tree with all matches.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1060 If the match is in a headline, the headline is made visible. If the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1061 match is in the body of an entry, headline and body are made visible.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1062 In order to provide minimal context, also the full hierarchy of
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1063 headlines above the match is shown, as well as the headline following
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1064 the match. Each match is also highlighted; the highlights disappear
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1065 when the buffer is changed by an editing command, or by pressing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1066 @kbd{C-c C-c}. When called with a @kbd{C-u} prefix argument, previous
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1067 highlights are kept, so several calls to this command can be stacked.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1068 @end table
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1069
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1070 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1071 For frequently used sparse trees of specific search strings, you can
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1072 use the variable @code{org-agenda-custom-commands} to define fast
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1073 keyboard access to specific sparse trees. These commands will then be
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1074 accessible through the agenda dispatcher (@pxref{Agenda dispatcher}).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1075 For example:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1076
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1077 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1078 (setq org-agenda-custom-commands
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1079 '(("f" occur-tree "FIXME")))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1080 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1081
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1082 @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
1083 a sparse tree matching the string @samp{FIXME}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1084
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1085 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
1086 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
1087
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1088 @kindex C-c C-e v
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1089 @cindex printing sparse trees
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1090 @cindex visible text, printing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1091 To print a sparse tree, you can use the Emacs command
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1092 @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
1093 of the document @footnote{This does not work under XEmacs, because
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1094 XEmacs uses selective display for outlining, not text properties.}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1095 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
1096 part of the document and print the resulting file.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1097
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1098 @node Plain lists, Drawers, Sparse trees, Document structure
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1099 @section Plain lists
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1100 @cindex plain lists
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1101 @cindex lists, plain
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1102 @cindex lists, ordered
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1103 @cindex ordered lists
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1104
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1105 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
1106 additional structure. They also provide a way to create lists of
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1107 checkboxes (@pxref{Checkboxes}). Org-mode supports editing such lists,
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1108 and the HTML exporter (@pxref{Exporting}) parses and formats them.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1109
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1110 Org-mode knows ordered and unordered lists. Unordered list items start
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1111 with @samp{-}, @samp{+}, or @samp{*}@footnote{When using @samp{*} as a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1112 bullet, lines must be indented or they will be seen as top-level
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1113 headlines. Also, when you are hiding leading stars to get a clean
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1114 outline view, plain list items starting with a star are visually
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1115 indistinguishable from true headlines. In short: even though @samp{*}
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1116 is supported, it may be better to not use it for plain list items.} as
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1117 bullets. Ordered list items start with a numeral followed by either a
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1118 period or a right parenthesis, such as @samp{1.} or @samp{1)}. Items
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1119 belonging to the same list must have the same indentation on the first
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1120 line. In particular, if an ordered list reaches number @samp{10.}, then
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1121 the 2--digit numbers must be written left-aligned with the other numbers
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1122 in the list. Indentation also determines the end of a list item. It
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1123 ends before the next line that is indented like the bullet/number, or
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1124 less. Empty lines are part of the previous item, so you can have
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1125 several paragraphs in one item. If you would like an empty line to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1126 terminate all currently open plain lists, configure the variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1127 @code{org-empty-line-terminates-plain-lists}. Here is an example:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1128
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1129 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1130 @group
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1131 ** Lord of the Rings
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1132 My favorite scenes are (in this order)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1133 1. The attack of the Rohirrim
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1134 2. Eowyns fight with the witch king
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1135 + this was already my favorite scene in the book
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1136 + I really like Miranda Otto.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1137 3. Peter Jackson being shot by Legolas
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1138 - on DVD only
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1139 He makes a really funny face when it happens.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1140 But in the end, not individual scenes matter but the film as a whole.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1141 @end group
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1142 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1143
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1144 Org-mode supports these lists by tuning filling and wrapping commands to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1145 deal with them correctly@footnote{Org-mode only changes the filling
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1146 settings for Emacs. For XEmacs, you should use Kyle E. Jones'
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1147 @file{filladapt.el}. To turn this on, put into @file{.emacs}:
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
1148 @code{(require 'filladapt)}}.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1149
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1150 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
1151 of an item (the line with the bullet or number).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1152
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1153 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1154 @kindex @key{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1155 @item @key{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1156 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
1157 @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
1158 given by the indentation of the bullet/number. Items are always
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1159 subordinate to real headlines, however; the hierarchies remain
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1160 completely separated.
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 If @code{org-cycle-include-plain-lists} has not been set, @key{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1163 fixes the indentation of the curent line in a heuristic way.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1164 @kindex M-@key{RET}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1165 @item M-@key{RET}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1166 Insert new item at current level. With prefix arg, force a new heading
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1167 (@pxref{Structure editing}). If this command is used in the middle of a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1168 line, the line is @emph{split} and the rest of the line becomes the new
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
1169 item@footnote{If you do not want the line to be split, customize the
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
1170 variable @code{org-M-RET-may-split-line}.}. If this command is executed
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
1171 in the @emph{whitespace before a bullet or number}, the new item is
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
1172 created @emph{before} the current item. If the command is executed in
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
1173 the white space before the text that is part of an item but does not
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
1174 contain the bullet, a bullet is added to the current line.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1175 @kindex M-S-@key{RET}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1176 @item M-S-@key{RET}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1177 Insert a new item with a checkbox (@pxref{Checkboxes}).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1178 @kindex S-@key{up}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1179 @kindex S-@key{down}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1180 @item S-@key{up}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1181 @itemx S-@key{down}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1182 Jump to the previous/next item in the current list.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1183 @kindex M-S-@key{up}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1184 @kindex M-S-@key{down}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1185 @item M-S-@key{up}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1186 @itemx M-S-@key{down}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1187 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
1188 of same indentation). If the list is ordered, renumbering is
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1189 automatic.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1190 @kindex M-S-@key{left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1191 @kindex M-S-@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1192 @item M-S-@key{left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1193 @itemx M-S-@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1194 Decrease/increase the indentation of the item, including subitems.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1195 Initially, the item tree is selected based on current indentation.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1196 When these commands are executed several times in direct succession,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1197 the initially selected region is used, even if the new indentation
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1198 would imply a different hierarchy. To use the new hierarchy, break
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1199 the command chain with a cursor motion or so.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1200 @kindex C-c C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1201 @item C-c C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1202 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
1203 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
1204 items on this list level use the same bullet. Furthermore, if this is
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1205 an ordered list, make sure the numbering is ok.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1206 @kindex C-c -
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1207 @item C-c -
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1208 Cycle the entire list level through the different itemize/enumerate
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1209 bullets (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1210 With prefix arg, select the nth bullet from this list.
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
1211 If there is an active region when calling this, all lines will be
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
1212 converted to list items. If the first line already was a list item, any
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
1213 item markers will be removed from the list. Finally, even without an
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
1214 active region, a normal line will be converted into a list item.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1215 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1216
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1217 @node Drawers, orgstruct-mode, Plain lists, Document structure
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1218 @section Drawers
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1219 @cindex drawers
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1220 @cindex visibility cycling, drawers
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1221
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1222 Sometimes you want to keep information associated with an entry, but you
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1223 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
1224 Drawers need to be configured with the variable
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1225 @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
1226 with a line like @code{#+DRAWERS: HIDDEN PROPERTIES STATE}}. Drawers
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1227 look like this:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1228
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1229 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1230 ** This is a headline
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1231 Still outside the drawer
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1232 :DRAWERNAME:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1233 This is inside the drawer.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1234 :END:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1235 After the drawer.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1236 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1237
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1238 Visibility cycling (@pxref{Visibility cycling}) on the headline will
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1239 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
1240 In order to look inside the drawer, you need to move the cursor to the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1241 drawer line and press @key{TAB} there. Org-mode uses a drawer for
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1242 storing properties (@pxref{Properties and columns}).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1243
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1244 @node orgstruct-mode, , Drawers, Document structure
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1245 @section The Orgstruct minor mode
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1246 @cindex orgstruct-mode
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1247 @cindex minor mode for structure editing
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 If you like the intuitive way the Org-mode structure editing and list
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1250 formatting works, you might want to use these commands in other modes
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1251 like text-mode or mail-mode as well. The minor mode Orgstruct-mode
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1252 makes this possible. You can always toggle the mode with @kbd{M-x
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1253 orgstruct-mode}. To turn it on by default, for example in mail mode,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1254 use
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1255
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1256 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1257 (add-hook 'mail-mode-hook 'turn-on-orgstruct)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1258 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1259
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1260 When this mode is active and the cursor is on a line that looks to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1261 Org-mode like a headline of the first line of a list item, most
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1262 structure editing commands will work, even if the same keys normally
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1263 have different functionality in the major mode you are using. If the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1264 cursor is not in one of those special lines, Orgstruct-mode lurks
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1265 silently in the shadow.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1266
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1267 @node Tables, Hyperlinks, Document structure, Top
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1268 @chapter Tables
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1269 @cindex tables
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1270 @cindex editing tables
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1271
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1272 Org-mode comes with a fast and intuitive table editor. Spreadsheet-like
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1273 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
1274 package
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1275 @ifinfo
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
1276 (@pxref{Top,Calc,,calc,Gnu Emacs Calculator Manual}).
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1277 @end ifinfo
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1278 @ifnotinfo
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1279 (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
1280 calculator).
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1281 @end ifnotinfo
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1282
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1283 @menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1284 * 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
1285 * Narrow columns:: Stop wasting space in tables
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1286 * Column groups:: Grouping to trigger vertical lines
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1287 * orgtbl-mode:: The table editor as minor mode
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1288 * The spreadsheet:: The table editor has spreadsheet capabilities.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1289 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1290
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1291 @node Built-in table editor, Narrow columns, Tables, Tables
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1292 @section The built-in table editor
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1293 @cindex table editor, built-in
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1294
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1295 Org-mode makes it easy to format tables in plain ASCII. Any line with
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1296 @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
1297 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
1298 this:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1299
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1300 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1301 | Name | Phone | Age |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1302 |-------+-------+-----|
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1303 | Peter | 1234 | 17 |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1304 | Anna | 4321 | 25 |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1305 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1306
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1307 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
1308 @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
1309 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
1310 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
1311 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
1312 @samp{|-} is considered as a horizontal separator line and will be
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1313 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
1314 create the above table, you would only type
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1315
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1316 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1317 |Name|Phone|Age|
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1318 |-
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1319 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1320
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1321 @noindent and then press @key{TAB} to align the table and start filling in
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1322 fields.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1323
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1324 When typing text into a field, Org-mode treats @key{DEL},
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1325 @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
1326 inserting and deleting avoids shifting other fields. Also, when
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1327 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
1328 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
1329 field is automatically made blank. If this behavior is too
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1330 unpredictable for you, configure the variables
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1331 @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
1332
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1333 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1334 @tsubheading{Creation and conversion}
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 |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1337 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
1338 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
1339 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
1340 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
1341 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
1342 C-u} forces TAB, and a numeric argument N indicates that at least N
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1343 consequtive 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
1344 @*
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1345 If there is no active region, this command creates an empty Org-mode
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1346 table. But it's easier just to start typing, like
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1347 @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1348
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1349 @tsubheading{Re-aligning and field motion}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1350 @kindex C-c C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1351 @item C-c C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1352 Re-align the table without moving the cursor.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1353 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1354 @kindex @key{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1355 @item @key{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1356 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
1357 necessary.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1358 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1359 @kindex S-@key{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1360 @item S-@key{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1361 Re-align, move to previous field.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1362 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1363 @kindex @key{RET}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1364 @item @key{RET}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1365 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
1366 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
1367 NEWLINE, so it can be used to split a table.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1368
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1369 @tsubheading{Column and row editing}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1370 @kindex M-@key{left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1371 @kindex M-@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1372 @item M-@key{left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1373 @itemx M-@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1374 Move the current column left/right.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1375 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1376 @kindex M-S-@key{left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1377 @item M-S-@key{left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1378 Kill the current column.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1379 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1380 @kindex M-S-@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1381 @item M-S-@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1382 Insert a new column to the left of the cursor position.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1383 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1384 @kindex M-@key{up}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1385 @kindex M-@key{down}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1386 @item M-@key{up}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1387 @itemx M-@key{down}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1388 Move the current row up/down.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1389 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1390 @kindex M-S-@key{up}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1391 @item M-S-@key{up}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1392 Kill the current row or horizontal line.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1393 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1394 @kindex M-S-@key{down}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1395 @item M-S-@key{down}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1396 Insert a new row above (with arg: below) the current row.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1397 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1398 @kindex C-c -
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1399 @item C-c -
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1400 Insert a horizontal line below current row. With prefix arg, the line
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1401 is created above the current line.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1402 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1403 @kindex C-c ^
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1404 @item C-c ^
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1405 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
1406 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
1407 between the nearest horizontal separator lines, or the entire table. If
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1408 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
1409 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
1410 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
1411 included into the sorting. The command prompts for the sorting type
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1412 (alphabetically, numerically, or by time). When called with a prefix
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1413 argument, alphabetic sorting will be case-sensitive.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1414
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1415 @tsubheading{Regions}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1416 @kindex C-c C-x M-w
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1417 @item C-c C-x M-w
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1418 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
1419 and mark determine edge fields of the rectangle. The process ignores
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1420 horizontal separator lines.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1421 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1422 @kindex C-c C-x C-w
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1423 @item C-c C-x C-w
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1424 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
1425 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
1426 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1427 @kindex C-c C-x C-y
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1428 @item C-c C-x C-y
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1429 Paste a rectangular region into a table.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1430 The upper right corner ends up in the current field. All involved fields
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1431 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
1432 the table is enlarged as needed. The process ignores horizontal separator
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1433 lines.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1434 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1435 @kindex C-c C-q
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
1436 @kindex M-@key{RET}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1437 @item C-c C-q
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
1438 @itemx M-@kbd{RET}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1439 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
1440 region, and both point and mark are in the same column, the text in the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1441 column is wrapped to minimum width for the given number of lines. A
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1442 prefix ARG may be used to change the number of desired lines. If there
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1443 is no region, the current field is split at the cursor position and the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1444 text fragment to the right of the cursor is prepended to the field one
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1445 line down. If there is no region, but you specify a prefix ARG, the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1446 current field is made blank, and the content is appended to the field
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1447 above.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1448
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1449 @tsubheading{Calculations}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1450 @cindex formula, in tables
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1451 @cindex calculations, in tables
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1452 @cindex region, active
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1453 @cindex active region
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1454 @cindex transient-mark-mode
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1455 @kindex C-c +
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1456 @item C-c +
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1457 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
1458 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
1459 be inserted with @kbd{C-y}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1460 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1461 @kindex S-@key{RET}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1462 @item S-@key{RET}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1463 When current field is empty, copy from first non-empty field above.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1464 When not empty, copy current field down to next row and move cursor
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1465 along with it. Depending on the variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1466 @code{org-table-copy-increment}, integer field values will be
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1467 incremented during copy. This key is also used by CUA-mode
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1468 (@pxref{Cooperation}).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1469
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1470 @tsubheading{Miscellaneous}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1471 @kindex C-c `
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1472 @item C-c `
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1473 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
1474 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
1475 @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
1476 edited in place.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1477 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1478 @item M-x org-table-import
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1479 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
1480 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
1481 from a database, because these programs generally can write
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1482 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
1483 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
1484 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
1485 separator.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1486 @item C-c |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1487 Tables can also be imported by pasting tabular text into the org-mode
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1488 buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1489 @kbd{C-c |} command (see above under @i{Creation and conversion}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1490 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1491 @item M-x org-table-export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1492 Export the table as a TAB-separated file. Useful for data exchange with,
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
1493 for example, spreadsheet or database programs.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1494 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1495
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1496 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
1497 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
1498 it off with
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1499
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1500 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1501 (setq org-enable-table-editor nil)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1502 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1503
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1504 @noindent Then the only table command that still works is
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1505 @kbd{C-c C-c} to do a manual re-align.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1506
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1507 @node Narrow columns, Column groups, Built-in table editor, Tables
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1508 @section Narrow columns
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1509 @cindex narrow columns in tables
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1510
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1511 The width of columns is automatically determined by the table editor.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1512 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
1513 leading to inconveniently wide columns. To limit@footnote{This feature
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1514 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
1515 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
1516 integer specifying the width of the column in characters. The next
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1517 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
1518 value.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1519
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1520 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1521 @group
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1522 |---+------------------------------| |---+--------|
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1523 | | | | | <6> |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1524 | 1 | one | | 1 | one |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1525 | 2 | two | ----\ | 2 | two |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1526 | 3 | This is a long chunk of text | ----/ | 3 | This=> |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1527 | 4 | four | | 4 | four |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1528 |---+------------------------------| |---+--------|
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1529 @end group
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1530 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1531
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1532 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1533 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
1534 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
1535 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
1536 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
1537 @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
1538 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
1539 C-c}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1540
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1541 When visiting a file containing a table with narrowed columns, the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1542 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
1543 be aligned before it looks nice. Setting the option
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1544 @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
1545 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
1546 on a per-file basis with:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1547
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1548 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1549 #+STARTUP: align
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1550 #+STARTUP: noalign
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1551 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1552
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1553 @node Column groups, orgtbl-mode, Narrow columns, Tables
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1554 @section Column groups
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1555 @cindex grouping columns in tables
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1556
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1557 When Org-mode exports tables, it does so by default without vertical
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1558 lines because that is visually more satisfying in general. Occasionally
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1559 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
1560 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
1561 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
1562 first field contains only @samp{/}. The further fields can either
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1563 contain @samp{<} to indicate that this column should start a group,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1564 @samp{>} to indicate the end of a column, or @samp{<>} to make a column
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1565 a group of its own. Boundaries between colum groups will upon export be
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1566 marked with vertical lines. Here is an example:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1567
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1568 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1569 | | 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
1570 |---+----+-----+-----+-----+---------+------------|
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1571 | / | <> | < | | > | < | > |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1572 | # | 1 | 1 | 1 | 1 | 1 | 1 |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1573 | # | 2 | 4 | 8 | 16 | 1.4142 | 1.1892 |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1574 | # | 3 | 9 | 27 | 81 | 1.7321 | 1.3161 |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1575 |---+----+-----+-----+-----+---------+------------|
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1576 #+TBLFM: $3=$2^2::$4=$2^3::$5=$2^4::$6=sqrt($2)::$7=sqrt(sqrt(($2))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1577 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1578
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1579 It is also sufficient to just insert the colum group starters after
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1580 every vertical line you'd like to have:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1581
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1582 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1583 | 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
1584 |----+-----+-----+-----+---------+------------|
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1585 | / | < | | | < | |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1586 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1587
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1588 @node orgtbl-mode, The spreadsheet, Column groups, Tables
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1589 @section The Orgtbl minor mode
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1590 @cindex orgtbl-mode
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1591 @cindex minor mode for tables
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1592
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1593 If you like the intuitive way the Org-mode table editor works, you
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1594 might also want to use it in other modes like text-mode or mail-mode.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1595 The minor mode Orgtbl-mode makes this possible. You can always toggle
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1596 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
1597 example in mail mode, use
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1598
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1599 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1600 (add-hook 'mail-mode-hook 'turn-on-orgtbl)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1601 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1602
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1603 Furthermore, with some special setup, it is possible to maintain tables
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1604 in arbitrary syntax with Orgtbl-mode. For example, it is possible to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1605 construct La@TeX{} tables with the underlying ease and power of
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1606 Orgtbl-mode, including spreadsheet capabilities. For details, see
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1607 @ref{Tables in arbitrary syntax}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1608
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1609 @node The spreadsheet, , orgtbl-mode, Tables
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1610 @section The spreadsheet
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1611 @cindex calculations, in tables
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1612 @cindex spreadsheet capabilities
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1613 @cindex @file{calc} package
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1614
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1615 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
1616 spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1617 derive fields from other fields. While fully featured, Org-mode's
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1618 implementation is not identical to other spreadsheets. For example,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1619 Org-mode knows the concept of a @emph{column formula} that will be
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1620 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
1621 formula to each relevant field.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1622
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1623 @menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1624 * References:: How to refer to another field or range
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1625 * Formula syntax for Calc:: Using Calc to compute stuff
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1626 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1627 * Field formulas:: Formulas valid for a single field
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1628 * Column formulas:: Formulas valid for an entire column
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1629 * Editing and debugging formulas:: Fixing formulas
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1630 * Updating the table:: Recomputing all dependent fields
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1631 * Advanced features:: Field names, parameters and automatic recalc
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1632 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1633
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1634 @node References, Formula syntax for Calc, The spreadsheet, The spreadsheet
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1635 @subsection References
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1636 @cindex references
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1637
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1638 To compute fields in the table from other fields, formulas must
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1639 reference other fields or ranges. In Org-mode, fields can be referenced
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1640 by name, by absolute coordinates, and by relative coordinates. To find
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1641 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
1642 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
1643
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1644 @subsubheading Field references
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1645 @cindex field references
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1646 @cindex references, to fields
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1647
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1648 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
1649 any other spreadsheet, you may reference fields with a letter/number
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1650 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
1651 @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
1652 @c when you copy and paste a formula to a different field. So
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1653 @c Org-mode's @code{B3} behaves like @code{$B$3} in other spreadsheets.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1654
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1655 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1656 Org-mode also uses another, more general operator that looks like this:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1657 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1658 @@row$column
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1659 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1660
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1661 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1662 Column references can be absolute like @samp{1}, @samp{2},...@samp{N},
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1663 or relative to the current column like @samp{+1} or @samp{-2}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1664
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1665 The row specification only counts data lines and ignores horizontal
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1666 separator lines (hlines). You can use absolute row numbers
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1667 @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
1668 @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
1669 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
1670 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
1671 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
1672 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
1673 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
1674 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
1675 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
1676 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
1677 the value directly at the hline is used.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1678
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1679 @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
1680 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
1681 row/column is implied.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1682
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1683 Org-mode's references with @emph{unsigned} numbers are fixed references
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1684 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
1685 different fields, the same field will be referenced each time.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1686 Org-mode's references with @emph{signed} numbers are floating
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1687 references because the same reference operator can reference different
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1688 fields depending on the field being calculated by the formula.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1689
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1690 Here are a few examples:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1691
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1692 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1693 @@2$3 @r{2nd row, 3rd column}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1694 C2 @r{same as previous}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1695 $5 @r{column 5 in the current row}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1696 E& @r{same as previous}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1697 @@2 @r{current column, row 2}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1698 @@-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
1699 @@-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
1700 @end example
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 @subsubheading Range references
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1703 @cindex range references
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1704 @cindex references, to ranges
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1705
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1706 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
1707 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
1708 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
1709 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
1710 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
1711 @samp{@@} in order to be interpreted correctly). Examples:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1712
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1713 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1714 $1..$3 @r{First three fields in the current row.}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1715 $P..$Q @r{Range, using column names (see under Advanced)}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1716 @@2$1..@@4$3 @r{6 fields between these two fields.}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1717 A2..C4 @r{Same as above.}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1718 @@-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
1719 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1720
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1721 @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
1722 into Calc vector functions. Empty fields in ranges are normally
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1723 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
1724 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
1725 @samp{[0]} is returned to avoid syntax errors in formulas.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1726
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1727 @subsubheading Named references
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1728 @cindex named references
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1729 @cindex references, named
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1730 @cindex name, of column or field
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1731 @cindex constants, in calculations
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1732
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1733 @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
1734 constant. Constants are defined globally through the variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1735 @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
1736 line like
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1737
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1738 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1739 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1740 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1741
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1742 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1743 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
1744 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
1745 @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
1746 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
1747 @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
1748 including natural constants like @samp{$h} for Planck's constant, and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1749 units like @samp{$km} for kilometers@footnote{@file{Constant.el} can
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1750 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
1751 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
1752 @code{constants-unit-system}. You can use the @code{#+STARTUP} options
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1753 @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
1754 buffer.}. Column names and parameters can be specified in special table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1755 lines. These are described below, see @ref{Advanced features}. All
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1756 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
1757 numbers.
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 @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
1760 @subsection Formula syntax for Calc
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1761 @cindex formula syntax, Calc
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1762 @cindex syntax, of formulas
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1763
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1764 A formula can be any algebraic expression understood by the Emacs
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1765 @file{Calc} package. @b{Note that @file{calc} has the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1766 non-standard convention that @samp{/} has lower precedence than
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1767 @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
1768 evaluation by @code{calc-eval} (@pxref{Calling Calc from
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1769 Your Programs,calc-eval,Calling calc from Your Lisp Programs,calc,GNU
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1770 Emacs Calc Manual}),
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1771 @c FIXME: The link to the calc manual in HTML does not work.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1772 variable substitution takes place according to the rules described above.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1773 @cindex vectors, in table calculations
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1774 The range vectors can be directly fed into the calc vector functions
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1775 like @samp{vmean} and @samp{vsum}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1776
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1777 @cindex format specifier
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1778 @cindex mode, for @file{calc}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1779 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
1780 string consists of flags to influence Calc and other modes during
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1781 execution. By default, Org-mode uses the standard calc modes (precision
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1782 12, angular units degrees, fraction and symbolic modes off. The display
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1783 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
1784 compact. The default settings can be configured using the variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1785 @code{org-calc-default-modes}.
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 p20 @r{switch the internal precision to 20 digits}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1789 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
1790 D R @r{angle modes: degrees, radians}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1791 F S @r{fraction and symbolic modes}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1792 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
1793 T @r{force text interpretation}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1794 E @r{keep empty fields in ranges}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1795 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1796
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1797 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1798 In addition, you may provide a @code{printf} format specifier to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1799 reformat the final result. A few examples:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1800
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1801 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1802 $1+$2 @r{Sum of first and second field}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1803 $1+$2;%.2f @r{Same, format result to two decimals}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1804 exp($2)+exp($1) @r{Math functions can be used}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1805 $0;%.1f @r{Reformat current cell to 1 decimal}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1806 ($3-32)*5/9 @r{Degrees F -> C conversion}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1807 $c/$1/$cm @r{Hz -> cm conversion, using @file{constants.el}}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1808 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
1809 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
1810 vmean($2..$7) @r{Compute column range mean, using vector function}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1811 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
1812 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
1813 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1814
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1815 Calc also contains a complete set of logical operations. For example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1816
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1817 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1818 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
1819 @end example
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 @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
1822 @subsection Emacs Lisp forms as formulas
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1823 @cindex Lisp forms, as table formulas
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 It is also possible to write a formula in Emacs Lisp; this can be useful
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1826 for string manipulation and control structures, if the Calc's
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1827 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
1828 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
1829 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
1830 @file{calc} formulas, you can specify modes and a printf format after a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1831 semicolon. With Emacs Lisp forms, you need to be concious about the way
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1832 field references are interpolated into the form. By default, a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1833 reference will be interpolated as a Lisp string (in double quotes)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1834 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
1835 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
1836 interpolated as Lisp numbers, without quotes. If you provide the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1837 @samp{L} flag, all fields will be interpolated literally, without quotes.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1838 I.e., if you want a reference to be interpreted as a string by the Lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1839 form, enclode the reference operator itself in double quotes, like
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1840 @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
1841 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
1842 @samp{N} mode is used when we do computations in lisp.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1843
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1844 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1845 @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
1846 '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1847 @r{Add columns 1 and 2, equivalent to the Calc's @code{$1+$2}}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1848 '(+ $1 $2);N
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1849 @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
1850 '(apply '+ '($1..$4));N
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1851 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1852
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1853 @node Field formulas, Column formulas, Formula syntax for Lisp, The spreadsheet
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1854 @subsection Field formulas
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1855 @cindex field formula
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1856 @cindex formula, for individual table field
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1857
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1858 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
1859 field, preceded by @samp{:=}, for example @samp{:=$1+$2}. When you
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1860 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
1861 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
1862 evaluated, and the current field replaced with the result.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1863
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1864 Formulas are stored in a special line starting with @samp{#+TBLFM:}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1865 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
1866 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
1867 @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
1868 with the appropriate commands, @i{absolute references} (but not relative
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1869 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
1870 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
1871 with normal editing commands - then you must fix the equations yourself.
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 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
1874 following command
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1875
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1876 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1877 @kindex C-u C-c =
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1878 @item C-u C-c =
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1879 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
1880 formula, with default taken from the @samp{#+TBLFM:} line, applies
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1881 it to the current field and stores it.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1882 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1883
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1884 @node Column formulas, Editing and debugging formulas, Field formulas, The spreadsheet
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1885 @subsection Column formulas
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1886 @cindex column formula
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1887 @cindex formula, for table column
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1888
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1889 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
1890 particular column. Instead of having to copy the formula to all fields
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1891 in that column, org-mode allows to assign a single formula to an entire
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1892 column. If the table contains horizontal separator hlines, everything
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1893 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
1894 and will not be modified by column formulas.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1895
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1896 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
1897 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
1898 @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
1899 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
1900 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
1901 contains only @samp{=}, the previously stored formula for this column is
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1902 used. For each column, Org-mode will only remember the most recently
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1903 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
1904 @samp{$4=$1+$2}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1905
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1906 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
1907 following command:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1908
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1909 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1910 @kindex C-c =
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1911 @item C-c =
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1912 Install a new formula for the current column and replace current field
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1913 with the result of the formula. The command prompts for a formula, with
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1914 default taken from the @samp{#+TBLFM} line, applies it to the current
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1915 field and stores it. With a numerical prefix (e.g. @kbd{C-5 C-c =})
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1916 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
1917 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1918
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1919
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1920 @node Editing and debugging formulas, Updating the table, Column formulas, The spreadsheet
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1921 @subsection Editing and Debugging formulas
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1922 @cindex formula editing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1923 @cindex editing, of table formulas
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1924
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1925 You can edit individual formulas in the minibuffer or directly in the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1926 field. Org-mode can also prepare a special buffer with all active
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1927 formulas of a table. When offering a formula for editing, Org-mode
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1928 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
1929 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
1930 @code{@@3$2} or @code{$4}), configure the variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1931 @code{org-table-use-standard-references}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1932
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1933 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1934 @kindex C-c =
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1935 @kindex C-u C-c =
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1936 @item C-c =
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1937 @itemx C-u C-c =
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1938 Edit the formula associated with the current column/field in the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1939 minibuffer. See @ref{Column formulas} and @ref{Field formulas}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1940 @kindex C-u C-u C-c =
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1941 @item C-u C-u C-c =
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1942 Re-insert the active formula (either a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1943 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
1944 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
1945 minibuffer is that you can use the command @kbd{C-c ?}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1946 @kindex C-c ?
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1947 @item C-c ?
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1948 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
1949 referenced by the reference at the cursor position in the formula.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1950 @kindex C-c @}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1951 @item C-c @}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1952 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
1953 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
1954 force it with @kbd{C-c C-c}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1955 @kindex C-c @{
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1956 @item C-c @{
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1957 Toggle the formula debugger on and off. See below.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1958 @kindex C-c '
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1959 @item C-c '
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1960 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
1961 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
1962 active formula, the cursor in the formula editor will mark it.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1963 While inside the special buffer, Org-mode will automatically highlight
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1964 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
1965 remove and add formulas, and use the following commands:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1966 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1967 @kindex C-c C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1968 @kindex C-x C-s
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1969 @item C-c C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1970 @itemx C-x C-s
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1971 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
1972 prefix, also apply the new formulas to the entire table.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1973 @kindex C-c C-q
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1974 @item C-c C-q
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1975 Exit the formula editor without installing changes.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1976 @kindex C-c C-r
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1977 @item C-c C-r
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1978 Toggle all references in the formula editor between standard (like
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1979 @code{B3}) and internal (like @code{@@3$2}).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1980 @kindex @key{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1981 @item @key{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1982 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
1983 a lisp formula, format the formula according to Emacs Lisp rules.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1984 Another @key{TAB} collapses the formula back again. In the open
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1985 formula, @key{TAB} re-indents just like in Emacs-lisp-mode.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1986 @kindex M-@key{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1987 @item M-@key{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1988 Complete Lisp symbols, just like in Emacs-lisp-mode.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1989 @kindex S-@key{up}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1990 @kindex S-@key{down}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1991 @kindex S-@key{left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1992 @kindex S-@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1993 @item S-@key{up}/@key{down}/@key{left}/@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1994 Shift the reference at point. For example, if the reference is
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1995 @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
1996 This also works for relative references, and for hline references.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1997 @kindex M-S-@key{up}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1998 @kindex M-S-@key{down}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1999 @item M-S-@key{up}/@key{down}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2000 Move the test line for column formulas in the Org-mode buffer up and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2001 down.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2002 @kindex M-@key{up}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2003 @kindex M-@key{down}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2004 @item M-@key{up}/@key{down}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2005 Scroll the window displaying the table.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2006 @kindex C-c @}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2007 @item C-c @}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2008 Turn the coordinate grid in the table on and off.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2009 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2010 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2011
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2012 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
2013 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
2014 line) - during the next recalculation the field will be filled again.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2015 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
2016 prompted for the formula, or to edit the @samp{#+TBLFM} line.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2017
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2018 @kindex C-c C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2019 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
2020 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
2021 recalculation commands in the table.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2022
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2023 @subsubheading Debugging formulas
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2024 @cindex formula debugging
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2025 @cindex debugging, of table formulas
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2026 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
2027 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
2028 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
2029 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
2030 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
2031 field. Detailed information will be displayed.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2032
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2033 @node Updating the table, Advanced features, Editing and debugging formulas, The spreadsheet
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2034 @subsection Updating the Table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2035 @cindex recomputing table fields
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2036 @cindex updating, table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2037
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2038 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
2039 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
2040 recalculation at least semi-automatically.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2041
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2042 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
2043 following commands:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2044
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2045 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2046 @kindex C-c *
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2047 @item C-c *
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2048 Recalculate the current row by first applying the stored column formulas
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2049 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
2050 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2051 @kindex C-u C-c *
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2052 @item C-u C-c *
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2053 @kindex C-u C-c C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2054 @itemx C-u C-c C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2055 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
2056 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
2057 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2058 @kindex C-u C-u C-c *
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2059 @kindex C-u C-u C-c C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2060 @item C-u C-u C-c *
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2061 @itemx C-u C-u C-c C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2062 Iterate the table by recomputing it until no further changes occur.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2063 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
2064 fields that are computed @i{later} in the calculation sequence.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2065 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2066
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2067 @node Advanced features, , Updating the table, The spreadsheet
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2068 @subsection Advanced features
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2069
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2070 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
2071 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
2072 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
2073 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2074 @kindex C-#
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2075 @item C-#
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2076 Rotate the calculation mark in first column through the states @samp{},
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2077 @samp{#}, @samp{*}, @samp{!}, @samp{$}. The meaning of these characters
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2078 is discussed below. When there is an active region, change all marks in
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2079 the region.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2080 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2081
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2082 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
2083 makes use of these features:
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 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2086 @group
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2087 |---+---------+--------+--------+--------+-------+------|
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2088 | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2089 |---+---------+--------+--------+--------+-------+------|
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2090 | ! | | P1 | P2 | P3 | Tot | |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2091 | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2092 | ^ | | m1 | m2 | m3 | mt | |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2093 |---+---------+--------+--------+--------+-------+------|
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2094 | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2095 | # | Sara | 6 | 14 | 19 | 39 | 7.8 |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2096 | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2097 |---+---------+--------+--------+--------+-------+------|
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2098 | | Average | | | | 29.7 | |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2099 | ^ | | | | | at | |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2100 | $ | max=50 | | | | | |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2101 |---+---------+--------+--------+--------+-------+------|
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2102 #+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
2103 @end group
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2104 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2105
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2106 @noindent @b{Important}: Please note that for these special tables,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2107 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
2108 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
2109 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
2110 empty first field.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2111
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2112 @cindex marking characters, tables
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2113 The marking characters have the following meaning:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2114 @table @samp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2115 @item !
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2116 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
2117 refer to a column as @samp{$Tot} instead of @samp{$6}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2118 @item ^
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2119 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
2120 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
2121 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
2122 will be stored as @samp{$name=...}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2123 @item _
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2124 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
2125 @emph{below}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2126 @item $
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2127 Fields in this row can define @emph{parameters} for formulas. For
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2128 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
2129 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
2130 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
2131 a per-table basis.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2132 @item #
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2133 Fields in this row are automatically recalculated when pressing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2134 @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
2135 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
2136 lines will be left alone by this command.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2137 @item *
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2138 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
2139 not for automatic recalculation. Use this when automatic
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2140 recalculation slows down editing too much.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2141 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2142 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
2143 All lines that should be recalculated should be marked with @samp{#}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2144 or @samp{*}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2145 @item /
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2146 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
2147 @samp{<N>} markers.
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 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
2151 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
2152 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
2153 functions.
84308
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 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2156 @group
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2157 |---+-------------+---+-----+--------------------------------------|
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2158 | | Func | n | x | Result |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2159 |---+-------------+---+-----+--------------------------------------|
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2160 | # | exp(x) | 1 | x | 1 + x |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2161 | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2162 | # | 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
2163 | # | 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
2164 | # | 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
2165 | * | 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
2166 |---+-------------+---+-----+--------------------------------------|
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2167 #+TBLFM: $5=taylor($2,$4,$3);n3
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2168 @end group
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2169 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2170
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2171 @node Hyperlinks, TODO items, Tables, Top
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2172 @chapter Hyperlinks
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2173 @cindex hyperlinks
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2174
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2175 Like HTML, Org-mode provides links inside a file, external links to
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2176 other files, Usenet articles, emails, and much more.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2177
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2178 @menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2179 * Link format:: How links in Org-mode are formatted
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2180 * Internal links:: Links to other places in the current file
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2181 * External links:: URL-like links to the world
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2182 * Handling links:: Creating, inserting and following
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2183 * Using links outside Org-mode:: Linking from my C source code?
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2184 * Link abbreviations:: Shortcuts for writing complex links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2185 * Search options:: Linking to a specific location
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2186 * Custom searches:: When the default search is not enough
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2187 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2188
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2189 @node Link format, Internal links, Hyperlinks, Hyperlinks
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2190 @section Link format
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2191 @cindex link format
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2192 @cindex format, of links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2193
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2194 Org-mode will recognize plain URL-like links and activate them as
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2195 clickable links. The general link format, however, looks like this:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2196
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2197 @example
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
2198 [[link][description]] @r{or alternatively} [[link]]
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2199 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2200
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2201 Once a link in the buffer is complete (all brackets present), Org-mode
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2202 will change the display so that @samp{description} is displayed instead
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2203 of @samp{[[link][description]]} and @samp{link} is displayed instead of
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2204 @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
2205 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
2206 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
2207 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
2208 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
2209 cursor on the link.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2210
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2211 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
2212 displayed text and press @key{BACKSPACE}, you will remove the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2213 (invisible) bracket at that location. This makes the link incomplete
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2214 and the internals are again displayed as plain text. Inserting the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2215 missing bracket hides the link internals again. To show the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2216 internal structure of all links, use the menu entry
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2217 @code{Org->Hyperlinks->Literal links}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2218
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2219 @node Internal links, External links, Link format, Hyperlinks
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2220 @section Internal links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2221 @cindex internal links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2222 @cindex links, internal
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2223 @cindex targets, for links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2224
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2225 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
2226 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
2227 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
2228 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
2229 link, or with a mouse click (@pxref{Handling links}). The preferred
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2230 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
2231 angular brackets. Targets may be located anywhere; sometimes it is
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2232 convenient to put them into a comment line. For example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2233
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2234 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2235 # <<My Target>>
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2236 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2237
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2238 @noindent In HTML export (@pxref{HTML export}), such targets will become
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2239 named anchors for direct access through @samp{http} links@footnote{Note
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2240 that text before the first headline is usually not exported, so the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2241 first such target should be after the first headline.}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2242
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2243 If no dedicated target exists, Org-mode will search for the words in the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2244 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
2245 Links starting with a star like @samp{*My Target} restrict the search to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2246 headlines. When searching, Org-mode will first try an exact match, but
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2247 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
2248 @samp{[[*My Targets]]} will find any of the following:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2249
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2250 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2251 ** My targets
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2252 ** TODO my targets are bright
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2253 ** my 20 targets are
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2254 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2255
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2256 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
2257 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
2258 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
2259 offered as completions. @xref{Handling links}, for more commands
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2260 creating links.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2261
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2262 Following a link pushes a mark onto Org-mode's own mark ring. You can
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2263 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
2264 several times in direct succession goes back to positions recorded
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2265 earlier.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2266
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2267 @menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2268 * Radio targets:: Make targets trigger links in plain text.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2269 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2270
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2271 @node Radio targets, , Internal links, Internal links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2272 @subsection Radio targets
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2273 @cindex radio targets
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2274 @cindex targets, radio
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2275 @cindex links, radio targets
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 Org-mode can automatically turn any occurrences of certain target names
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2278 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
2279 text connects to the target radioing its position. Radio targets are
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2280 enclosed by triple angular brackets. For example, a target @samp{<<<My
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2281 Target>>>} causes each occurrence of @samp{my target} in normal text to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2282 become activated as a link. The Org-mode file is scanned automatically
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2283 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
2284 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
2285 cursor on or at a target.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2286
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2287 @node External links, Handling links, Internal links, Hyperlinks
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2288 @section External links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2289 @cindex links, external
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2290 @cindex external links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2291 @cindex links, external
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2292 @cindex GNUS links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2293 @cindex BBDB links
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
2294 @cindex IRC links
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2295 @cindex URL links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2296 @cindex file links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2297 @cindex VM links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2298 @cindex RMAIL links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2299 @cindex WANDERLUST links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2300 @cindex MH-E links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2301 @cindex USENET links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2302 @cindex SHELL links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2303 @cindex Info links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2304 @cindex elisp links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2305
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2306 Org-mode 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
2307 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
2308 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
2309 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
2310 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
2311
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2312 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2313 http://www.astro.uva.nl/~dominik @r{on the web}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2314 file:/home/dominik/images/jupiter.jpg @r{file, absolute path}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2315 file:papers/last.pdf @r{file, relative path}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2316 news:comp.emacs @r{Usenet link}
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
2317 mailto:adent@@galaxy.net @r{Mail link}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2318 vm:folder @r{VM folder link}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2319 vm:folder#id @r{VM message link}
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
2320 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
2321 wl:folder @r{WANDERLUST folder link}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2322 wl:folder#id @r{WANDERLUST message link}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2323 mhe:folder @r{MH-E folder link}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2324 mhe:folder#id @r{MH-E message link}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2325 rmail:folder @r{RMAIL folder link}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2326 rmail:folder#id @r{RMAIL message link}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2327 gnus:group @r{GNUS group link}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2328 gnus:group#id @r{GNUS article link}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2329 bbdb:Richard Stallman @r{BBDB link}
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
2330 irc:/irc.com/#emacs/bob @r{IRC link}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2331 shell:ls *.org @r{A shell command}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2332 elisp:(find-file-other-frame "Elisp.org") @r{An elisp form to evaluate}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2333 @end example
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 A link should be enclosed in double brackets and may contain a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2336 descriptive text to be displayed instead of the url (@pxref{Link
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2337 format}), for example:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2338
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2339 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2340 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2341 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2342
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2343 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2344 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
2345 export (@pxref{HTML export}) will inline the image as a clickable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2346 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
2347 image,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2348 that image will be inlined into the exported HTML file.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2349
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2350 @cindex angular brackets, around links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2351 @cindex plain text external links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2352 Org-mode also finds external links in the normal text and activates them
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2353 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
2354 @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2355 about the end of the link, enclose them in angular brackets.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2356
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2357 @node Handling links, Using links outside Org-mode, External links, Hyperlinks
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2358 @section Handling links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2359 @cindex links, handling
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 Org-mode provides methods to create a link in the correct syntax, to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2362 insert it into an org-mode file, and to follow the link.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2363
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2364 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2365 @kindex C-c l
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2366 @cindex storing links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2367 @item C-c l
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2368 Store a link to the current location. This is a @emph{global} command
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2369 which can be used in any buffer to create a link. The link will be
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2370 stored for later insertion into an Org-mode buffer (see below). For
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
2371 Org-mode files, if there is a @samp{<<target>>} at the cursor, the
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
2372 link points to the target. Otherwise it points to the current
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
2373 headline. For VM, RMAIL, WANDERLUST, MH-E, GNUS and BBDB buffers, the
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
2374 link will indicate the current article/entry. For W3 and W3M buffers,
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
2375 the link goes to the current URL. For IRC links, if you set the
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
2376 variable @code{org-irc-link-to-logs} to non-nil then @kbd{C-c l} will
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
2377 store a @samp{file:/} style link to the relevant point in the logs for
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
2378 the current conversation. Otherwise an @samp{irc:/} style link to the
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
2379 user/channel/server under the point will be stored. For any other
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
2380 files, the link will point to the file, with a search string
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
2381 (@pxref{Search options}) pointing to the contents of the current line.
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
2382 If there is an active region, the selected words will form the basis
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
2383 of the search string. If the automatically created link is not
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
2384 working correctly or accurately enough, you can write custom functions
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
2385 to select the search string and to do the search for particular file
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
2386 types - see @ref{Custom searches}. The key binding @kbd{C-c l} is
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
2387 only a suggestion - see @ref{Installation}.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2388 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2389 @kindex C-c C-l
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2390 @cindex link completion
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2391 @cindex completion, of links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2392 @cindex inserting links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2393 @item C-c C-l
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2394 Insert a link. This prompts for a link to be inserted into the buffer.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2395 You can just type a link, using text for an internal link, or one of the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2396 link type prefixes mentioned in the examples above. All links stored
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2397 during the current session are part of the history for this prompt, so
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2398 you can access them with @key{up} and @key{down} (or @kbd{M-p/n}).
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2399 Completion, on the other hand, will help you to insert valid link
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2400 prefixes like @samp{http:} or @samp{ftp:}, including the prefixes
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2401 defined through link abbreviations (@pxref{Link abbreviations}). The
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2402 link will be inserted into the buffer@footnote{After insertion of a
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2403 stored link, the link will be removed from the list of stored links. To
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2404 keep it in the list later use, use a triple @kbd{C-u} prefix to @kbd{C-c
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2405 C-l}, or configure the option
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2406 @code{org-keep-stored-link-after-insertion}.}, along with a descriptive
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2407 text. If some text was selected when this command is called, the
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2408 selected text becomes the default description.@* Note that you don't
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2409 have to use this command to insert a link. Links in Org-mode are plain
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2410 text, and you can type or paste them straight into the buffer. By using
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2411 this command, the links are automatically enclosed in double brackets,
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2412 and you will be asked for the optional descriptive text.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2413 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2414 @c If the link is a @samp{file:} link and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2415 @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
2416 @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
2417 @c the current directory.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2418 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2419 @kindex C-u C-c C-l
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2420 @cindex file name completion
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2421 @cindex completion, of file names
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2422 @item C-u C-c C-l
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2423 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
2424 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
2425 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
2426 directory of the current org file, if the linked file is in the current
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2427 directory or in a subdirectory of it, or if the path is written relative
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2428 to the current directory using @samp{../}. Otherwise an absolute path
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2429 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
2430 force an absolute path with two @kbd{C-u} prefixes.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2431 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2432 @item C-c C-l @r{(with cursor on existing link)}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2433 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
2434 link and description parts of the link.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2435 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2436 @cindex following links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2437 @kindex C-c C-o
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2438 @item C-c C-o
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2439 Open link at point. This will launch a web browser for URLs (using
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2440 @command{browse-url-at-point}), run vm/mh-e/wanderlust/rmail/gnus/bbdb
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2441 for the corresponding links, and execute the command in a shell link.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2442 When the cursor is on an internal link, this commands runs the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2443 corresponding search. When the cursor is on a TAG list in a headline,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2444 it creates the corresponding TAGS view. If the cursor is on a time
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2445 stamp, it compiles the agenda for that date. Furthermore, it will visit
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2446 text and remote files in @samp{file:} links with Emacs and select a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2447 suitable application for local non-text files. Classification of files
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2448 is based on file extension only. See option @code{org-file-apps}. If
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2449 you want to override the default application and visit the file with
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2450 Emacs, use a @kbd{C-u} prefix.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2451 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2452 @kindex mouse-2
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2453 @kindex mouse-1
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2454 @item mouse-2
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2455 @itemx mouse-1
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2456 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
2457 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
2458 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2459 @kindex mouse-3
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2460 @item mouse-3
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2461 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
2462 internal links to be displayed in another window@footnote{See the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2463 variable @code{org-display-internal-link-with-indirect-buffer}}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2464 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2465 @cindex mark ring
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2466 @kindex C-c %
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2467 @item C-c %
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2468 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
2469 easily. Commands following an internal link do this automatically.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2470 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2471 @cindex links, returning to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2472 @kindex C-c &
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2473 @item C-c &
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2474 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
2475 commands following internal links, and by @kbd{C-c %}. Using this
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2476 command several times in direct succession moves through a ring of
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2477 previously recorded positions.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2478 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2479 @kindex C-c C-x C-n
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2480 @kindex C-c C-x C-p
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2481 @cindex links, finding next/previous
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2482 @item C-c C-x C-n
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2483 @itemx C-c C-x C-p
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2484 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
2485 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
2486 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
2487 to @kbd{C-n} and @kbd{C-p}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2488 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2489 (add-hook 'org-load-hook
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2490 (lambda ()
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2491 (define-key 'org-mode-map "\C-n" 'org-next-link)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2492 (define-key 'org-mode-map "\C-p" 'org-previous-link)))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2493 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2494 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2495
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2496 @node Using links outside Org-mode, Link abbreviations, Handling links, Hyperlinks
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2497 @section Using links outside Org-mode
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2498
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2499 You can insert and follow links that have Org-mode syntax not only in
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2500 Org-mode, but in any Emacs buffer. For this, you should create two
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2501 global commands, like this (please select suitable global keys
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2502 yourself):
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2503
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2504 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2505 (global-set-key "\C-c L" 'org-insert-link-global)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2506 (global-set-key "\C-c o" 'org-open-at-point-global)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2507 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2508
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2509 @node Link abbreviations, Search options, Using links outside Org-mode, Hyperlinks
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2510 @section Link abbreviations
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2511 @cindex link abbreviations
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2512 @cindex abbreviation, links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2513
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2514 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
2515 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
2516 abbreviated link looks like this
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2517
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2518 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2519 [[linkword:tag][description]]
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2520 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2521
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2522 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2523 where the tag is optional. Such abbreviations are resolved according to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2524 the information in the variable @code{org-link-abbrev-alist} that
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2525 relates the linkwords to replacement text. Here is an example:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2526
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2527 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2528 @group
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2529 (setq org-link-abbrev-alist
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2530 '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2531 ("google" . "http://www.google.com/search?q=")
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2532 ("ads" . "http://adsabs.harvard.edu/cgi-bin/
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2533 nph-abs_connect?author=%s&db_key=AST")))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2534 @end group
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2535 @end lisp
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 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
2538 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
2539 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
2540 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
2541
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2542 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
2543 @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2544 @code{[[google:OrgMode]]} and find out what the Org-mode author is
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2545 doing besides Emacs hacking with @code{[[ads:Dominik,C]]}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2546
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2547 If you need special abbreviations just for a single Org-mode buffer, you
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2548 can define them in the file with
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2549
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2550 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2551 #+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
2552 #+LINK: google http://www.google.com/search?q=%s
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2553 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2554
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2555 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2556 In-buffer completion @pxref{Completion} can be used after @samp{[} to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2557 complete link abbreviations.
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 @node Search options, Custom searches, Link abbreviations, Hyperlinks
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2560 @section Search options in file links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2561 @cindex search option in file links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2562 @cindex file links, searching
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2563
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2564 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
2565 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
2566 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
2567 compatibility, line numbers can also follow a single colon.} colon. For
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2568 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
2569 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
2570 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
2571 link with @kbd{C-c C-o}.
84308
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 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
2574 link, together with an explanation:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2575
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2576 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2577 [[file:~/code/main.c::255]]
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2578 [[file:~/xx.org::My Target]]
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2579 [[file:~/xx.org::*My Target]]
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2580 [[file:~/xx.org::/regexp/]]
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2581 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2582
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2583 @table @code
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2584 @item 255
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2585 Jump to line 255.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2586 @item My Target
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2587 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
2588 @samp{my target}, similar to the search in internal links, see
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2589 @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
2590 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
2591 the linked file.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2592 @item *My Target
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2593 In an Org-mode file, restrict search to headlines.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2594 @item /regexp/
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2595 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
2596 command @code{occur} to list all matches in a separate window. If the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2597 target file is in Org-mode, @code{org-occur} is used to create a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2598 sparse tree with the matches.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2599 @c If the target file is a directory,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2600 @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
2601 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2602
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2603 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
2604 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
2605 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
2606 @samp{[[find me]]} would.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2607
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2608 @node Custom searches, , Search options, Hyperlinks
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2609 @section Custom Searches
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2610 @cindex custom search strings
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2611 @cindex search strings, custom
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2612
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2613 The default mechanism for creating search strings and for doing the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2614 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
2615 cases. For example, BibTeX database files have many entries like
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2616 @samp{year="1993"} which would not result in good search strings,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2617 because the only unique identification for a BibTeX entry is the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2618 citation key.
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 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
2621 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
2622 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
2623 to be added to the hook variables
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2624 @code{org-create-file-search-functions} and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2625 @code{org-execute-file-search-functions}. See the docstring for these
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2626 variables for more information. Org-mode actually uses this mechanism
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2627 for Bib@TeX{} database files, and you can use the corresponding code as
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2628 an implementation example. Search for @samp{BibTeX links} in the source
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2629 file.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2630
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2631
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2632
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2633 @node TODO items, Tags, Hyperlinks, Top
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2634 @chapter TODO items
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2635 @cindex TODO items
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2636
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2637 Org-mode does not maintain TODO lists as separate documents. Instead,
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2638 TODO items are an integral part of the notes file, because TODO items
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2639 usually come up while taking notes! With Org-mode, simply mark any
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2640 entry in a tree as being a TODO item. In this way, information is not
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2641 duplicated, and the entire context from which the TODO item emerged is
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2642 always present.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2643
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2644 Of course, this technique for managing TODO items scatters them
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2645 throughout your notes file. Org-mode compensates for this by providing
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2646 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
2647
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2648 @menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2649 * TODO basics:: Marking and displaying TODO entries
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2650 * TODO extensions:: Workflow and assignments
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2651 * Progress logging:: Dates and notes for progress
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2652 * Priorities:: Some things are more important than others
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2653 * Breaking down tasks:: Splitting a task into manageable pieces
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2654 * Checkboxes:: Tick-off lists
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2655 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2656
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2657 @node TODO basics, TODO extensions, TODO items, TODO items
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2658 @section Basic TODO functionality
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2659
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2660 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
2661 @samp{TODO}, for example:
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2662
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2663 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2664 *** TODO Write letter to Sam Fortune
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2665 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2666
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2667 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2668 The most important commands to work with TODO entries are:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2669
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2670 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2671 @kindex C-c C-t
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2672 @cindex cycling, of TODO states
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2673 @item C-c C-t
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2674 Rotate the TODO state of the current item among
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2675
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2676 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2677 ,-> (unmarked) -> TODO -> DONE --.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2678 '--------------------------------'
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2679 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2680
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2681 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
2682 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
2683
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2684 @kindex C-u C-c C-t
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2685 @item C-u C-c C-t
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2686 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
2687 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
2688 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
2689 more information.
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2690
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2691 @kindex S-@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2692 @kindex S-@key{left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2693 @item S-@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2694 @itemx S-@key{left}
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2695 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
2696 mostly if more than two TODO states are possible (@pxref{TODO
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2697 extensions}).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2698 @kindex C-c C-v
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2699 @kindex C-c / t
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2700 @cindex sparse tree, for TODO
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2701 @item C-c C-v
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2702 @itemx C-c / t
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2703 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
2704 the entire buffer, but shows all TODO items and the headings hierarchy
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2705 above them. With prefix arg, search for a specific TODO. You will be
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2706 prompted for the keyword, and you can also give a list of keywords like
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2707 @code{KWD1|KWD2|...}. With numerical prefix N, show the tree for the
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2708 Nth keyword in the variable @code{org-todo-keywords}. With two prefix
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2709 args, find all TODO and DONE entries.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2710 @kindex C-c a t
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2711 @item C-c a t
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2712 Show the global TODO list. Collects the TODO items from all agenda
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2713 files (@pxref{Agenda views}) into a single buffer. The new buffer will
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2714 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
2715 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
2716 commands}). @xref{Global TODO list}, for more information.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2717 @kindex S-M-@key{RET}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2718 @item S-M-@key{RET}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2719 Insert a new TODO entry below the current one.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2720 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2721
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2722 @node TODO extensions, Progress logging, TODO basics, TODO items
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2723 @section Extended use of TODO keywords
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2724 @cindex extended TODO keywords
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2725
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2726 By default, marked TODO entries have one of only two states: TODO and
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2727 DONE. Org-mode allows you to classify TODO items in more complex ways
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2728 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
2729 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
2730 files.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2731
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2732 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
2733 TODO items in particular (@pxref{Tags}).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2734
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2735 @menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2736 * Workflow states:: From TODO to DONE in steps
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2737 * TODO types:: I do this, Fred does the rest
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2738 * 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
2739 * 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
2740 * Per-file keywords:: Different files, different requirements
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2741 * Faces for TODO keywords:: Highlighting states
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2742 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2743
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2744 @node Workflow states, TODO types, TODO extensions, TODO extensions
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2745 @subsection TODO keywords as workflow states
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2746 @cindex TODO workflow
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2747 @cindex workflow states as TODO keywords
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2748
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2749 You can use TODO keywords to indicate different @emph{sequential} states
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2750 in the process of working on an item, for example@footnote{Changing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2751 this variable only becomes effective after restarting Org-mode in a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2752 buffer.}:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2753
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2754 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2755 (setq org-todo-keywords
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2756 '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2757 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2758
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2759 The vertical bar separates the TODO keywords (states that @emph{need
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2760 action}) from the DONE states (which need @emph{no further action}. If
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2761 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
2762 state.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2763 @cindex completion, of TODO keywords
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2764 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
2765 to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED. You may
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2766 also use a prefix argument to quickly select a specific state. For
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2767 example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY.
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
2768 Or you can use @kbd{S-left} to go backward through the sequence. If you
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
2769 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
2770 (@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
2771 (@pxref{Fast access to TODO states}) to insert these words into the
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
2772 buffer. Changing a todo state can be logged with a timestamp, see
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
2773 @ref{Tracking TODO state changes} for more information.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2774
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2775 @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
2776 @subsection TODO keywords as types
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2777 @cindex TODO types
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2778 @cindex names as TODO keywords
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2779 @cindex types as TODO keywords
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2780
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2781 The second possibility is to use TODO keywords to indicate different
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2782 @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
2783 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
2784 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
2785 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
2786 be set up like this:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2787
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2788 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2789 (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2790 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2791
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2792 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
2793 different types. So the normal work flow would be to assign a task to a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2794 person, and later to mark it DONE. Org-mode supports this style by
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2795 adapting the workings of the command @kbd{C-c C-t}@footnote{This is also
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2796 true for the @kbd{t} command in the timeline and agenda buffers.}. When
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2797 used several times in succession, it will still cycle through all names,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2798 in order to first select the right type for a task. But when you return
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2799 to the item after some time and execute @kbd{C-c C-t} again, it will
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2800 switch from any name directly to DONE. Use prefix arguments or
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2801 completion to quickly select a specific name. You can also review the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2802 items of a specific TODO type in a sparse tree by using a numeric prefix
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2803 to @kbd{C-c C-v}. For example, to see all things Lucy has to do, you
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2804 would use @kbd{C-3 C-c C-v}. To collect Lucy's items from all agenda
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2805 files into a single buffer, you would use the prefix arg as well when
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2806 creating the global todo list: @kbd{C-3 C-c t}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2807
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2808 @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
2809 @subsection Multiple keyword sets in one file
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2810 @cindex todo keyword sets
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2811
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2812 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
2813 parallel. For example, you may want to have the basic
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2814 @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
2815 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
2816 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
2817 like this:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2818
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2819 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2820 (setq org-todo-keywords
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2821 '((sequence "TODO" "|" "DONE")
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2822 (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2823 (sequence "|" "CANCELED")))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2824 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2825
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2826 The keywords should all be different, this helps Org-mode to keep track
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2827 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
2828 @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
2829 @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
2830 (nothing) to @code{REPORT}. Therefore you need a mechanism to initially
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2831 select the correct sequence. Besides the obvious ways like typing a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2832 keyword or using completion, you may also apply the following commands:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2833
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2834 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2835 @kindex C-S-@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2836 @kindex C-S-@key{left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2837 @item C-S-@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2838 @itemx C-S-@key{left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2839 These keys jump from one TODO subset to the next. In the above example,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2840 @kbd{C-S-@key{right}} would jump from @code{TODO} or @code{DONE} to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2841 @code{REPORT}, and any of the words in the second row to @code{CANCELED}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2842 @kindex S-@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2843 @kindex S-@key{left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2844 @item S-@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2845 @itemx S-@key{left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2846 @kbd{S-@key{<left>}} and @kbd{S-@key{<right>}} and walk through
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2847 @emph{all} keywords from all sets, so for example @kbd{S-@key{<right>}}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2848 would switch from @code{DONE} to @code{REPORT} in the example above.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2849 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2850
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2851 @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
2852 @subsection Fast access to TODO states
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2853
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2854 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
2855 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
2856 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
2857 key after each keyword, in parenthesis. For example:
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2858
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2859 @lisp
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2860 (setq org-todo-keywords
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2861 '((sequence "TODO(t)" "|" "DONE(d)")
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2862 (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2863 (sequence "|" "CANCELED(c)")))
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2864 @end lisp
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2865
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2866 If you then press @code{C-u C-c C-t} followed by the selection key, the
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2867 entry will be switched to this state. @key{SPC} can be used to remove
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2868 any TODO keyword from an entry. Should you like this way of selecting
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2869 TODO states a lot, you might want to set the variable
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2870 @code{org-use-fast-todo-selection} to @code{t} and make this behavior
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2871 the default. Check also the variable
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2872 @code{org-fast-tag-selection-include-todo}, it allows to change the TODO
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
2873 state through the tags interface (@pxref{Setting tags}), in case you
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
2874 like to mingle the two concepts.
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2875
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2876 @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
2877 @subsection Setting up keywords for individual files
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2878 @cindex keyword options
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2879 @cindex per-file keywords
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2880
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2881 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
2882 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
2883 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
2884 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
2885 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
2886 file:
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 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2889 #+SEQ_TODO: TODO FEEDBACK VERIFY | DONE CANCELED
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2890 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2891 or
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2892 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2893 #+TYP_TODO: Fred Sara Lucy Mike | DONE
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2894 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2895
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2896 A setup for using several sets in parallel would be:
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 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2899 #+SEQ_TODO: TODO | DONE
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2900 #+SEQ_TODO: REPORT BUG KNOWNCAUSE | FIXED
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2901 #+SEQ_TODO: | CANCELED
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2902 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2903
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2904 @cindex completion, of option keywords
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2905 @kindex M-@key{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2906 @noindent To make sure you are using the correct keyword, type
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2907 @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
2908
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2909 @cindex DONE, final TODO keyword
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2910 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
2911 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
2912 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
2913 @kbd{C-c C-c} with the cursor still in the line to make the changes
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2914 known to Org-mode@footnote{Org-mode parses these lines only when
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2915 Org-mode is activated after visiting a file. @kbd{C-c C-c} with the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2916 cursor in a line starting with @samp{#+} is simply restarting Org-mode
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2917 for the current buffer.}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2918
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2919 @node Faces for TODO keywords, , Per-file keywords, TODO extensions
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2920 @subsection Faces for TODO keywords
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2921 @cindex faces, for TODO keywords
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2922
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2923 Org-mode highlights TODO keywords with special faces: @code{org-todo}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2924 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
2925 @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
2926 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
2927 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
2928 @code{org-todo-keyword-faces}. For example:
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2929
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2930 @lisp
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2931 (setq org-todo-keyword-faces
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2932 '(("TODO" . org-warning)
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2933 ("DEFERRED" . shadow)
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2934 ("CANCELED" . (:foreground "blue" :weight bold))))
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2935 @end lisp
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2936
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
2937 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
2938 @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
2939 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
2940
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2941 @page
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2942 @node Progress logging, Priorities, TODO extensions, TODO items
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2943 @section Progress Logging
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2944 @cindex progress logging
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2945 @cindex logging, of progress
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2946
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
2947 Org-mode can automatically record a time stamp and possibly a note when
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
2948 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
2949 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
2950 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
2951 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
2952 work time}.
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2953
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2954 @menu
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2955 * Closing items:: When was this entry marked DONE?
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2956 * Tracking TODO state changes:: When did the status change?
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2957 @end menu
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2958
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2959 @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
2960 @subsection Closing items
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2961
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
2962 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
2963 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
2964 in-buffer setting is: @code{#+STARTUP: logdone}}.
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2965
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2966 @lisp
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
2967 (setq org-log-done 'time)
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2968 @end lisp
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2969
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2970 @noindent
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
2971 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
2972 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
2973 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
2974 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
2975 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
2976 corresponding in-buffer setting is: @code{#+STARTUP: lognotedone}}
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2977
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2978 @lisp
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
2979 (setq org-log-done 'note)
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2980 @end lisp
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2981
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
2982 @noindent
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
2983 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
2984 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
2985
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
2986 In the timeline (@pxref{Timeline}) and in the agenda
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
2987 (@pxref{Weekly/Daily agenda}), you can then use the @kbd{l} key to
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
2988 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
2989 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
2990
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2991 @node Tracking TODO state changes, , Closing items, Progress logging
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2992 @subsection Tracking TODO state changes
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2993
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
2994 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
2995 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
2996 and maybe take a note about this change. Since it is normally too much
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
2997 to record a note for every state, Org-mode expects configuration on a
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
2998 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
2999 @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
3000 after each keyword. For example, with the setting
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3001
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3002 @lisp
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3003 (setq org-todo-keywords
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3004 '((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
3005 @end lisp
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3006
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3007 @noindent
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3008 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
3009 request that a time is recorded when the entry is turned into
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3010 DONE@footnote{It is possible that Org-mode will record two time stamps
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3011 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
3012 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
3013 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
3014 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
3015 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
3016 @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
3017 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
3018 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
3019 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
3020 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
3021 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
3022 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
3023 configured.
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3024
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3025 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
3026 to a buffer:
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3027 @example
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3028 #+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
3029 @end example
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3030
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3031 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
3032 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
3033 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
3034 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
3035 @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
3036 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
3037
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3038 @example
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3039 * 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
3040 :PROPERTIES:
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3041 :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
3042 :END:
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3043 * 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
3044 :PROPERTIES:
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3045 :LOGGING: WAIT(@@) logrepeat
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3046 :END:
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3047 * 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
3048 :PROPERTIES:
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3049 :LOGGING: nil
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3050 :END:
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3051 @end example
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3052
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3053
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3054 @node Priorities, Breaking down tasks, Progress logging, TODO items
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3055 @section Priorities
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3056 @cindex priorities
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3057
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3058 If you use Org-mode extensively, you may end up enough TODO items that
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3059 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
3060 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
3061 this
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3062
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3063 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3064 *** TODO [#A] Write letter to Sam Fortune
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3065 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3066
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3067 @noindent
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3068 By default, Org-mode supports three priorities: @samp{A}, @samp{B}, and
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3069 @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
3070 is treated as priority @samp{B}. Priorities make a difference only in
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3071 the agenda (@pxref{Weekly/Daily agenda}); outside the agenda, they have
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3072 no inherent meaning to Org-mode.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3073
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3074 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
3075 to be TODO items.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3076
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3077 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3078 @kindex @kbd{C-c ,}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3079 @item @kbd{C-c ,}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3080 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
3081 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
3082 @key{SPC} instead, the priority cookie is removed from the headline.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3083 The priorities can also be changed ``remotely'' from the timeline and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3084 agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3085 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3086 @kindex S-@key{up}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3087 @kindex S-@key{down}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3088 @item S-@key{up}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3089 @itemx S-@key{down}
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3090 Increase/decrease priority of current headline@footnote{See also the
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3091 option @code{org-priority-start-cycle-with-default'}.}. Note that these
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3092 keys are also used to modify time stamps (@pxref{Creating timestamps}).
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3093 Furthermore, these keys are also used by CUA-mode (@pxref{Conflicts}).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3094 @end table
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 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
3097 @code{org-highest-priority}, @code{org-lowest-priority}, and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3098 @code{org-default-priority}. For an individual buffer, you may set
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3099 these values (highest, lowest, default) like this (please make sure that
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3100 the highest priority is earlier in the alphabet than the lowest
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3101 priority):
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3102
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3103 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3104 #+PRIORITIES: A C B
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3105 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3106
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3107 @node Breaking down tasks, Checkboxes, Priorities, TODO items
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3108 @section Breaking tasks down into subtasks
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3109 @cindex tasks, breaking down
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3110
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3111 It is often advisable to break down large tasks into smaller, manageable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3112 subtasks. You can do this by creating an outline tree below a TODO
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3113 item, with detailed subtasks on the tree@footnote{To keep subtasks out
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3114 of the global TODO list, see the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3115 @code{org-agenda-todo-list-sublevels}.}. Another possibility is the use
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3116 of checkboxes to identify (a hierarchy of) a large number of subtasks
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3117 (@pxref{Checkboxes}).
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
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3120 @node Checkboxes, , Breaking down tasks, TODO items
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3121 @section Checkboxes
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3122 @cindex checkboxes
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3123
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3124 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
3125 checkbox by starting it with the string @samp{[ ]}. This feature is
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3126 similar to TODO items (@pxref{TODO items}), but is more lightweight.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3127 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
3128 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
3129 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
3130 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
3131
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3132 Here is an example of a checkbox list.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3133
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3134 @example
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3135 * 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
3136 - [-] call people [1/3]
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3137 - [ ] Peter
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3138 - [X] Sarah
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3139 - [ ] Sam
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3140 - [X] order food
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3141 - [ ] think about what music to play
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3142 - [X] talk to the neighbors
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3143 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3144
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3145 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
3146 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
3147 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
3148 checked.
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3149
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3150 @cindex statistics, for checkboxes
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3151 @cindex checkbox statistics
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3152 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
3153 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
3154 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
3155 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
3156 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
3157 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
3158 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
3159 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
3160 @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
3161 the examples above. With @samp{[%]} you get information about the
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3162 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
3163 @samp{[50%]} and @samp{[33%]}, respectively).
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3164
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3165 @noindent The following commands work with checkboxes:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3166
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3167 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3168 @kindex C-c C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3169 @item C-c C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3170 Toggle checkbox at point. With prefix argument, set it to @samp{[-]},
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3171 which is considered to be an intermediate state.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3172 @kindex C-c C-x C-b
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3173 @item C-c C-x C-b
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3174 Toggle checkbox at point.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3175 @itemize @minus
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3176 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3177 If there is an active region, toggle the first checkbox in the region
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3178 and set all remaining boxes to the same status as the first. If you
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3179 want to toggle all boxes in the region independently, use a prefix
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3180 argument.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3181 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3182 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
3183 this headline and the next (so @emph{not} the entire subtree).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3184 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3185 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
3186 @end itemize
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3187 @kindex M-S-@key{RET}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3188 @item M-S-@key{RET}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3189 Insert a new item with a checkbox.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3190 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
3191 (@pxref{Plain lists}).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3192 @kindex C-c #
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3193 @item C-c #
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3194 Update the checkbox statistics in the current outline entry. When
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3195 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
3196 statistic cookies are updated automatically if you toggle checkboxes
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3197 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
3198 delete boxes or add/change them by hand, use this command to get things
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3199 back into synch. Or simply toggle any checkbox twice with @kbd{C-c C-c}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3200 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3201
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3202 @node Tags, Properties and columns, TODO items, Top
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3203 @chapter Tags
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3204 @cindex tags
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3205 @cindex headline tagging
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3206 @cindex matching, tags
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3207 @cindex sparse tree, tag based
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3208
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3209 An excellent way to implement labels and contexts for cross-correlating
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3210 information is to assign @i{tags} to headlines. Org-mode has extensive
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3211 support for tags.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3212
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3213 Every headline can contain a list of tags; they occur at the end of the
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3214 headline. Tags are normal words containing letters, numbers, @samp{_},
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3215 and @samp{@@}. Tags must be preceded and followed by a single colon,
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3216 e.g., @samp{:WORK:}. Several tags can be specified, as in
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3217 @samp{:work:URGENT:}.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3218
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3219 @menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3220 * Tag inheritance:: Tags use the tree structure of the outline
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3221 * Setting tags:: How to assign tags to a headline
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3222 * Tag searches:: Searching for combinations of tags
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3223 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3224
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3225 @node Tag inheritance, Setting tags, Tags, Tags
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3226 @section Tag inheritance
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3227 @cindex tag inheritance
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3228 @cindex inheritance, of tags
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3229 @cindex sublevels, inclusion into tags match
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3230
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3231 @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
3232 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
3233 well. For example, in the list
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3234
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3235 @example
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3236 * Meeting with the French group :work:
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3237 ** Summary by Frank :boss:notes:
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3238 *** TODO Prepare slides for him :action:
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3239 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3240
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3241 @noindent
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3242 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
3243 @samp{:notes:}, and @samp{:action:} even though the final heading is not
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3244 explicitly marked with those tags. When executing tag searches and
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3245 Org-mode finds that a certain headline matches the search criterion, it
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3246 will not check any sublevel headline, assuming that these also match and
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3247 that the list of matches could become very long because of that. If you
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3248 do want the subevels be tested and listed as well, you may set the
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3249 variable @code{org-tags-match-list-sublevels}. To turn off tag
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3250 inheritance entirely, use the variable @code{org-use-tag-inheritance}.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3251
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3252 @node Setting tags, Tag searches, Tag inheritance, Tags
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3253 @section Setting tags
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3254 @cindex setting tags
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3255 @cindex tags, setting
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3256
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3257 @kindex M-@key{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3258 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
3259 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
3260 also a special command for inserting tags:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3261
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3262 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3263 @kindex C-c C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3264 @item C-c C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3265 @cindex completion, of tags
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3266 Enter new tags for the current headline. Org-mode will either offer
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3267 completion or a special single-key interface for setting tags, see
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3268 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
3269 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
3270 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
3271 things look nice. TAGS are automatically realigned after promotion,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3272 demotion, and TODO state changes (@pxref{TODO basics}).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3273 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3274
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3275 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
3276 default this list is constructed dynamically, containing all tags
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3277 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
3278 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
3279 the default tags for a given file with lines like
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3280
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3281 @example
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3282 #+TAGS: @@work @@home @@tennisclub
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3283 #+TAGS: laptop car pc sailboat
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3284 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3285
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3286 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
3287 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
3288 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
3289
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3290 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3291 #+TAGS:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3292 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3293
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3294 The default support method for entering tags is minibuffer completion.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3295 However, Org-mode also implements a much better method: @emph{fast tag
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3296 selection}. This method allows to select and deselect tags with a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3297 single key per tag. To function efficiently, you should assign unique
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3298 keys to most tags. This can be done globally with
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3299
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3300 @lisp
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3301 (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l)))
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3302 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3303
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3304 @noindent or on a per-file basis with
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3305
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3306 @example
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3307 #+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
3308 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3309
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3310 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3311 You can also group together tags that are mutually exclusive. With
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3312 curly braces@footnote{In @code{org-mode-alist} use
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3313 @code{'(:startgroup)} and @code{'(:endgroup)}, respectively. Several
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3314 groups are allowed.}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3315
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3316 @example
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3317 #+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
3318 @end example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3319
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3320 @noindent you indicate that at most one of @samp{@@work}, @samp{@@home},
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3321 and @samp{@@tennisclub} should be selected.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3322
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3323 @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
3324 these lines to activate any changes.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3325
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3326 If at least one tag has a selection key, pressing @kbd{C-c C-c} will
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3327 automatically present you with a special interface, listing inherited
92148
f991f10f15ec Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 87836
diff changeset
3328 tags, the tags of the current headline, and a list of all valid tags
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3329 with corresponding keys@footnote{Keys will automatically be assigned to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3330 tags which have no configured keys.}. In this interface, you can use
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3331 the following keys:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3332
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3333 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3334 @item a-z...
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3335 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
3336 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
3337 exclusive tags will turn off any other tags from that group.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3338 @kindex @key{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3339 @item @key{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3340 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
3341 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
3342 @kindex @key{SPC}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3343 @item @key{SPC}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3344 Clear all tags for this line.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3345 @kindex @key{RET}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3346 @item @key{RET}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3347 Accept the modified set.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3348 @item C-g
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3349 Abort without installing changes.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3350 @item q
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3351 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
3352 @item !
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3353 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
3354 exception) assign several tags from such a group.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3355 @item C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3356 Toggle auto-exit after the next change (see below).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3357 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
3358 selection window.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3359 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3360
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3361 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3362 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
3363 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
3364 @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
3365 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
3366 @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
3367 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
3368 @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
3369 @key{RET} @key{RET}}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3370
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3371 If you find that most of the time, you need only a single keypress to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3372 modify your list of tags, set the variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3373 @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
3374 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
3375 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
3376 @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
3377 (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
3378 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
3379 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
3380 when you press an extra @kbd{C-c}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3381
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3382 @node Tag searches, , Setting tags, Tags
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3383 @section Tag searches
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3384 @cindex tag searches
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3385 @cindex searching for tags
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3386
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3387 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
3388 information into special lists.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3389
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3390 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3391 @kindex C-c \
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3392 @kindex C-c / T
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3393 @item C-c \
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3394 @itemx C-c / T
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3395 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
3396 @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
3397 @kindex C-c a m
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3398 @item C-c a m
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3399 Create a global list of tag matches from all agenda files.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3400 @xref{Matching tags and properties}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3401 @kindex C-c a M
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3402 @item C-c a M
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3403 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
3404 only TODO items and force checking subitems (see variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3405 @code{org-tags-match-list-sublevels}).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3406 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3407
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3408 @cindex Boolean logic, for tag searches
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3409 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
3410 @samp{|} for OR. @samp{&} binds more strongly than @samp{|}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3411 Parenthesis are currently not implemented. A tag may also be preceded
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3412 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
3413 positive selection. The AND operator @samp{&} is optional when @samp{+}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3414 or @samp{-} is present. Examples:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3415
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3416 @table @samp
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3417 @item +work-boss
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3418 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
3419 @samp{:boss:}.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3420 @item work|laptop
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3421 Selects lines tagged @samp{:work:} or @samp{:laptop:}.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3422 @item work|laptop&night
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3423 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
3424 @samp{:night:}.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3425 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3426
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3427 @cindex TODO keyword matching, with tags search
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3428 If you are using multi-state TODO keywords (@pxref{TODO extensions}), it
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3429 can be useful to also match on the TODO keyword. This can be done by
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3430 adding a condition after a slash to a tags match. The syntax is similar
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3431 to the tag matches, but should be applied with consideration: For
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3432 example, a positive selection on several TODO keywords can not
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3433 meaningfully be combined with boolean AND. However, @emph{negative
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3434 selection} combined with AND can be meaningful. To make sure that only
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3435 lines are checked that actually have any TODO keyword, use @kbd{C-c a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3436 M}, or equivalently start the todo part after the slash with @samp{!}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3437 Examples:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3438
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3439 @table @samp
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3440 @item work/WAITING
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3441 Select @samp{:work:}-tagged TODO lines with the specific TODO
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3442 keyword @samp{WAITING}.
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3443 @item work/!-WAITING-NEXT
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3444 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
3445 nor @samp{NEXT}
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3446 @item work/+WAITING|+NEXT
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3447 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
3448 @samp{NEXT}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3449 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3450
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3451 @cindex regular expressions, with tags search
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3452 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
3453 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
3454 @samp{work+@{^boss.*@}} matches headlines that contain the tag
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3455 @samp{:work:} and any tag @i{starting} with @samp{boss}.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3456
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3457 @cindex level, require for tags/property match
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3458 @cindex category, require for tags/property match
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3459 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
3460 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
3461 @samp{CATEGORY="work"}, respectively. For example, a search
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3462 @samp{+LEVEL=3+boss/-DONE} lists all level three headlines that have the
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3463 tag @samp{boss} and are @emph{not} marked with the todo keyword DONE.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3464
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3465 @node Properties and columns, Dates and times, Tags, Top
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3466 @chapter Properties and Columns
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3467 @cindex properties
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3468
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3469 Properties are a set of key-value pairs associated with an entry. There
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3470 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
3471 are like tags, but with a value. Second, you can use properties to
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3472 implement (very basic) database capabilities in an Org-mode buffer. For
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3473 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
3474 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
3475 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
3476 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
3477 values, such as @code{1.0} or @code{2.0}. For an example of the second
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3478 application of properties, imagine keeping track of one's music CD's,
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3479 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
3480 release, number of tracks, and so on.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3481
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3482 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
3483 (@pxref{Column view}).
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3484
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3485 Properties are like tags, but with a value. For example, in a file
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3486 where you document bugs and plan releases of a piece of software,
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3487 instead of using tags like @code{:release_1:}, @code{:release_2:}, it
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3488 can be more efficient to use a property @code{:Release:} with a value
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3489 @code{1.0} or @code{2.0}. Second, you can use properties to implement
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3490 (very basic) database capabilities in an Org-mode buffer, for example to
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3491 create a list of Music CD's you own. You can edit and view properties
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3492 conveniently in column view (@pxref{Column view}).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3493
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3494 @menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3495 * Property syntax:: How properties are spelled out
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3496 * Special properties:: Access to other Org-mode features
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3497 * Property searches:: Matching property values
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3498 * Property inheritance:: Passing values down the tree
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3499 * Column view:: Tabular viewing and editing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3500 * Property API:: Properties for Lisp programmers
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3501 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3502
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3503 @node Property syntax, Special properties, Properties and columns, Properties and columns
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3504 @section Property Syntax
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3505 @cindex property syntax
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3506 @cindex drawer, for properties
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3507
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3508 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
3509 drawer (@pxref{Drawers}) with the name @code{PROPERTIES}. Each property
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3510 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
3511 first, and the value after it. Here is an example:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3512
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3513 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3514 * CD collection
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3515 ** Classic
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3516 *** Goldberg Variations
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3517 :PROPERTIES:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3518 :Title: Goldberg Variations
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3519 :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
3520 :Artist: Glen Gould
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3521 :Publisher: Deutsche Grammphon
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3522 :NDisks: 1
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3523 :END:
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3524 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3525
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3526 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
3527 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
3528 @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
3529 the entire tree. When allowed values are defined, setting the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3530 corresponding property becomes easier and is less prone to typing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3531 errors. For the example with the CD collection, we can predefine
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3532 publishers and the number of disks in a box like this:
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 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3535 * CD collection
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3536 :PROPERTIES:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3537 :NDisks_ALL: 1 2 3 4
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3538 :Publisher_ALL: "Deutsche Grammophon" Phillips EMI
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3539 :END:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3540 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3541
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3542 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
3543 file, use a line like
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3544
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3545 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3546 #+PROPERTY: NDisks_ALL 1 2 3 4
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3547 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3548
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3549 Property values set with the global variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3550 @code{org-global-properties} can be inherited by all entries in all
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3551 Org-mode files.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3552
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3553 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3554 The following commands help to work with properties:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3555
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3556 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3557 @kindex M-@key{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3558 @item M-@key{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3559 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
3560 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
3561 @kindex C-c C-x p
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3562 @item C-c C-x p
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3563 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
3564 necessary, the property drawer is created as well.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3565 @item M-x org-insert-property-drawer
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3566 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
3567 inserted early in the entry, but after the lines with planning
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3568 information like deadlines.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3569 @kindex C-c C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3570 @item C-c C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3571 With the cursor in a property drawer, this executes property commands.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3572 @item C-c C-c s
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3573 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
3574 can be inserted using completion.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3575 @kindex S-@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3576 @kindex S-@key{left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3577 @item S-@key{left}/@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3578 Switch property at point to the next/previous allowed value.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3579 @item C-c C-c d
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3580 Remove a property from the current entry.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3581 @item C-c C-c D
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3582 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
3583 @item C-c C-c c
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3584 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
3585 nearest column format definition.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3586 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3587
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3588 @node Special properties, Property searches, Property syntax, Properties and columns
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3589 @section Special Properties
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3590 @cindex properties, special
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3591
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3592 Special properties provide alternative access method to Org-mode
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3593 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
3594 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
3595 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
3596 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
3597 used as keys in the properties drawer:
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3598
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3599 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3600 TODO @r{The TODO keyword of the entry.}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3601 TAGS @r{The tags defined directly in the headline.}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3602 ALLTAGS @r{All tags, including inherited ones.}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3603 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
3604 DEADLINE @r{The deadline time string, without the angular brackets.}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3605 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
3606 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
3607 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
3608 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
3609 @r{must be run first to compute the values.}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3610 @end example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3611
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3612 @node Property searches, Property inheritance, Special properties, Properties and columns
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3613 @section Property searches
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3614 @cindex properties, searching
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3615 @cindex properties, inheritance
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3616 @cindex searching, of properties
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3617 @cindex inheritance, of properties
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3618
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3619 To create sparse trees and special lists with selection based on
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3620 properties, the same commands are used as for tag searches (@pxref{Tag
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3621 searches}), and the same logic applies. For example, a search string
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3622
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3623 @example
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3624 +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort=""+With=@{Sarah\|Denny@}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3625 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3626
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3627 @noindent
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3628 finds entries tagged @samp{:work:} but not @samp{:boss:}, which
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3629 also have a priority value @samp{A}, a @samp{:Coffee:} property with the
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3630 value @samp{unlimited}, an @samp{Effort} property that is undefined or
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3631 empty, and a @samp{:With:} property that is matched by
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3632 the regular expression @samp{Sarah\|Denny}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3633
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3634 You can configure Org-mode to use property inheritance during a search,
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3635 see @ref{Property inheritance} for details.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3636
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3637 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
3638 single property:
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3639
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3640 @table @kbd
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3641 @kindex C-c / p
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3642 @item C-c / p
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3643 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
3644 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
3645 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
3646 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
3647 a regular expression and matched against the property values.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3648 @end table
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3649
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3650 @node Property inheritance, Column view, Property searches, Properties and columns
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3651 @section Property Inheritance
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3652
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3653 The outline structure of Org-mode documents lends itself for an
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3654 inheritance model of properties: If the parent in a tree has a certain
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3655 property, the children can inherit this property. Org-mode does not
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3656 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
3657 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
3658 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
3659 @code{org-use-property-inheritance}. It may be set to @code{t}, to make
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3660 all properties inherited from the parent, or to a list of properties
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3661 that should be inherited.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3662
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3663 Org-mode has a few properties for which inheritance is hard-coded, at
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3664 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
3665
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3666 @table @code
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3667 @item COLUMNS
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3668 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
3669 (@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
3670 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
3671 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
3672 subtree from where columns view is turned on.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3673 @item CATEGORY
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3674 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
3675 applies to the entire subtree.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3676 @item ARCHIVE
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3677 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
3678 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
3679 @item LOGGING
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3680 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
3681 subtree (@pxref{Tracking TODO state changes}).
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3682 @end table
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3683
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3684 @node Column view, Property API, Property inheritance, Properties and columns
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3685 @section Column View
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3686
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3687 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
3688 @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
3689 table row. Columns in this table provide access to properties of the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3690 entries. Org-mode implements columns by overlaying a tabular structure
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3691 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
3692 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
3693 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
3694 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
3695 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
3696 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
3697 tree command and in this way get a table only for the selected items.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3698 Column view also works in agenda buffers (@pxref{Agenda views}) where
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3699 queries have collected selected items, possibly from a number of files.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3700
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3701 @menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3702 * Defining columns:: The COLUMNS format property
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3703 * Using column view:: How to create and use column view
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3704 * Capturing Column View:: A dynamic block for column view
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3705 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3706
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3707 @node Defining columns, Using column view, Column view, Column view
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3708 @subsection Defining Columns
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3709 @cindex column view, for properties
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3710 @cindex properties, column view
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3711
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3712 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
3713 done by defining a column format line.
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 @menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3716 * Scope of column definitions:: Where defined, where valid?
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3717 * Column attributes:: Appearance and content of a column
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3718 @end menu
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 @node Scope of column definitions, Column attributes, Defining columns, Defining columns
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3721 @subsubsection Scope of column definitions
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3722
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3723 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
3724
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3725 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3726 #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3727 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3728
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3729 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
3730 @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
3731
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3732 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3733 ** Top node for columns view
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3734 :PROPERTIES:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3735 :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3736 :END:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3737 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3738
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3739 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
3740 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
3741 column definition is part of the hierarchical structure of the document,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3742 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
3743 sublevels, and more specific columns further down, when you edit a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3744 deeper part of the tree.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3745
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3746 @node Column attributes, , Scope of column definitions, Defining columns
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3747 @subsubsection Column attributes
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3748 A column definition sets the attributes of a column. The general
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3749 definition looks like this:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3750
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3751 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3752 %[width]property[(title)][@{summary-type@}]
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3753 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3754
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3755 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3756 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
3757 optional. The individual parts have the following meaning:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3758
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3759 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3760 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
3761 @r{If omitted, the width will be determined automatically.}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3762 property @r{The property that should be edited in this column.}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3763 (title) @r{The header text for the column. If omitted, the}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3764 @r{property name is used.}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3765 @{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
3766 @r{parent nodes are computed from the children.}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3767 @r{Supported summary types are:}
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3768 @{+@} @r{Sum numbers in this column.}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3769 @{+;%.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
3770 @{$@} @r{Currency, short for @samp{+;%.2f}.}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3771 @{:@} @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
3772 @{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
3773 @{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
3774 @{X%@} @r{Checkbox status, [n%].}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3775 @end example
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 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3778 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
3779 values.
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 @example
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3782 :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
3783 %10Time_Estimate@{:@} %CLOCKSUM
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3784 :Owner_ALL: Tammy Mark Karl Lisa Don
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3785 :Status_ALL: "In progress" "Not started yet" "Finished" ""
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3786 :Approved_ALL: "[ ]" "[X]"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3787 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3788
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3789 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
3790 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
3791 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
3792 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
3793 @samp{Status} with four different possible values, and for a checkbox
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3794 field @samp{Approved}. When no width is given after the @samp{%}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3795 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
3796 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
3797 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
3798 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
3799 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
3800 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
3801 @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
3802 in the subtree.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3803
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3804 @node Using column view, Capturing Column View, Defining columns, Column view
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3805 @subsection Using Column View
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3806
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3807 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3808 @tsubheading{Turning column view on and off}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3809 @kindex C-c C-x C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3810 @item C-c C-x C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3811 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
3812 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
3813 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
3814 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
3815 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
3816 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
3817 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
3818 @kindex r
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3819 @item r
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3820 Recreate the column view, to included hanges happening in the buffer.
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3821 @kindex g
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3822 @item g
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3823 Same as @kbd{r}.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3824 @kindex q
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3825 @item q
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3826 Exit column view.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3827 @tsubheading{Editing values}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3828 @item @key{left} @key{right} @key{up} @key{down}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3829 Move through the column view from field to field.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3830 @kindex S-@key{left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3831 @kindex S-@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3832 @item S-@key{left}/@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3833 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
3834 have to have specified allowed values for a property.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3835 @kindex n
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3836 @kindex p
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3837 @itemx n / p
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3838 Same as @kbd{S-@key{left}/@key{right}}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3839 @kindex e
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3840 @item e
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3841 Edit the property at point. For the special properties, this will
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3842 invoke the same interface that you normally use to change that
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3843 property. For example, when editing a TAGS property, the tag completion
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3844 or fast selection interface will pop up.
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3845 @kindex C-c C-c
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3846 @item C-c C-c
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3847 When there is a checkbox at point, toggle it.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3848 @kindex v
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3849 @item v
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3850 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
3851 the column is smaller than that of the value.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3852 @kindex a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3853 @item a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3854 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
3855 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
3856 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
3857 current column view.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3858 @tsubheading{Modifying the table structure}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3859 @kindex <
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3860 @kindex >
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3861 @item < / >
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3862 Make the column narrower/wider by one character.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3863 @kindex S-M-@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3864 @item S-M-@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3865 Insert a new column, to the right of the current column.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3866 @kindex S-M-@key{left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3867 @item S-M-@key{left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3868 Delete the current column.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3869 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3870
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3871 @node Capturing Column View, , Using column view, Column view
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3872 @subsection Capturing Column View
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3873
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3874 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
3875 exported or printed directly. If you want to capture a column view, use
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3876 ths @code{columnview} dynamic block (@pxref{Dynamic blocks}). The frame
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3877 of this block looks like this:
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3878
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3879 @example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3880 * The column view
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3881 #+BEGIN: columnview :hlines 1 :id "label"
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3882
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3883 #+END:
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3884 @end example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3885
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3886 @noindent This dynamic block has the following parameters:
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3887
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3888 @table @code
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3889 @item :id
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3890 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
3891 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
3892 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
3893 capture, you can use 3 values:
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3894 @example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3895 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
3896 global @r{make a global view, including all headings in the file}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3897 "label" @r{call column view in the tree that has and @code{:ID:}}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3898 @r{property with the value @i{label}}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3899 @end example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3900 @item :hlines
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3901 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
3902 a hline before each headline with level @code{<= N}.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3903 @item :vlines
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3904 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
3905 @item :maxlevel
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3906 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
3907 @item :skip-empty-rows
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3908 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
3909 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
3910
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3911 @end table
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3912
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3913 @noindent
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3914 The following commands insert or update the dynamic block:
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3915
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3916 @table @kbd
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3917 @kindex C-c C-x r
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3918 @item C-c C-x r
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3919 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
3920 for the scope or id of the view.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3921 @kindex C-c C-c
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3922 @item C-c C-c
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3923 @kindex C-c C-x C-u
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3924 @itemx C-c C-x C-u
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3925 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
3926 @code{#+BEGIN} line of the dynamic block.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3927 @kindex C-u C-c C-x C-u
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3928 @item C-u C-c C-x C-u
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3929 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3930 you have several clocktable blocks in a buffer.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3931 @end table
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3932
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3933 @node Property API, , Column view, Properties and columns
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3934 @section The Property API
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3935 @cindex properties, API
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3936 @cindex API, for properties
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3937
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3938 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
3939 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
3940 features based on them. For more information see @ref{Using the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3941 property API}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3942
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3943 @node Dates and times, Remember, Properties and columns, Top
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3944 @chapter Dates and Times
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3945 @cindex dates
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3946 @cindex times
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3947 @cindex time stamps
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3948 @cindex date stamps
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3949
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3950 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
3951 a time. The specially formatted string carrying the date and time
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3952 information is called a @emph{timestamp} in Org-mode. This may be a
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3953 little confusing because timestamp is often used as indicating when
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3954 something was created or last changed. However, in Org-mode this term
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3955 is used in a much wider sense.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3956
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3957 @menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3958 * Time stamps:: Assigning a time to a tree entry
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3959 * Creating timestamps:: Commands which insert timestamps
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3960 * Deadlines and scheduling:: Planning your work
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
3961 * Clocking work time::
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3962 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3963
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3964
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3965 @node Time stamps, Creating timestamps, Dates and times, Dates and times
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3966 @section Time stamps, deadlines and scheduling
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3967 @cindex time stamps
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3968 @cindex ranges, time
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3969 @cindex date stamps
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3970 @cindex deadlines
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3971 @cindex scheduling
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3972
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3973 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
3974 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
3975 @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
3976 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
3977 use an alternative format, see @ref{Custom time format}.}. A time stamp
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3978 can appear anywhere in the headline or body of an org-tree entry. Its
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3979 presence causes entries to be shown on specific dates in the agenda
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3980 (@pxref{Weekly/Daily agenda}). We distinguish:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3981
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3982 @table @var
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
3983 @item Plain time stamp; Event; Appointment
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3984 @cindex timestamp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3985 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
3986 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
3987 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
3988 plain time stamp will be shown exactly on that date.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3989
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3990 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3991 * Meet Peter at the movies <2006-11-01 Wed 19:15>
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3992 * 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
3993 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3994
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3995 @item Time stamp with repeater interval
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3996 @cindex timestamp, with repeater interval
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3997 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
3998 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
3999 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
4000 following will show up in the agenda every Wednesday:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4001
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4002 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4003 * 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
4004 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4005
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4006 @item Diary-style sexp entries
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4007 For more complex date specifications, Org-mode supports using the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4008 special sexp diary entries implemented in the Emacs calendar/diary
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4009 package. For example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4010
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4011 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4012 * The nerd meeting on every 2nd Thursday of the month
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4013 <%%(diary-float t 4 2)>
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4014 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4015
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4016 @item Time/Date range
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4017 @cindex timerange
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4018 @cindex date range
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4019 Two time stamps connected by @samp{--} denote a range. The headline
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4020 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
4021 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
4022
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4023 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4024 ** Meeting in Amsterdam
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4025 <2004-08-23 Mon>--<2004-08-26 Thu>
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4026 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4027
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4028 @item Inactive time stamp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4029 @cindex timestamp, inactive
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4030 @cindex inactive timestamp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4031 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
4032 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
4033 @emph{not} trigger an entry to show up in the agenda.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4034
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4035 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4036 * Gillian comes late for the fifth time [2006-11-01 Wed]
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4037 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4038
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4039 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4040
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4041 @node Creating timestamps, Deadlines and scheduling, Time stamps, Dates and times
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4042 @section Creating timestamps
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4043 @cindex creating timestamps
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4044 @cindex timestamps, creating
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4045
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4046 For Org-mode to recognize time stamps, they need to be in the specific
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4047 format. All commands listed below produce time stamps in the correct
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4048 format.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4049
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4050 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4051 @kindex C-c .
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4052 @item C-c .
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4053 Prompt for a date and insert a corresponding time stamp. When the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4054 cursor is at a previously used time stamp, it is updated to NOW. When
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4055 this command is used twice in succession, a time range is inserted.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4056 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4057 @kindex C-u C-c .
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4058 @item C-u C-c .
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4059 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
4060 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
4061 see the option @code{org-time-stamp-rounding-minutes}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4062 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4063 @kindex C-c !
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4064 @item C-c !
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4065 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
4066 an agenda entry.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4067 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4068 @kindex C-c <
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4069 @item C-c <
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4070 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
4071 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4072 @kindex C-c >
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4073 @item C-c >
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4074 Access the Emacs calendar for the current date. If there is a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4075 timestamp in the current line, goto the corresponding date
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4076 instead.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4077 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4078 @kindex C-c C-o
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4079 @item C-c C-o
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4080 Access the agenda for the date given by the time stamp or -range at
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4081 point (@pxref{Weekly/Daily agenda}).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4082 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4083 @kindex S-@key{left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4084 @kindex S-@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4085 @item S-@key{left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4086 @itemx S-@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4087 Change date at cursor by one day. These key bindings conflict with
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4088 CUA-mode (@pxref{Conflicts}).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4089 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4090 @kindex S-@key{up}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4091 @kindex S-@key{down}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4092 @item S-@key{up}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4093 @itemx S-@key{down}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4094 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
4095 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
4096 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
4097 an item. (@pxref{Priorities}). The key bindings also conflict with
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4098 CUA-mode (@pxref{Conflicts}).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4099 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4100 @kindex C-c C-y
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4101 @cindex evaluate time range
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4102 @item C-c C-y
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4103 Evaluate a time range by computing the difference between start and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4104 end. With prefix arg, insert result after the time range (in a table:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4105 into the following column).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4106 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4107
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4108
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4109 @menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4110 * The date/time prompt:: How org-mode helps you entering date and time
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4111 * Custom time format:: Making dates look differently
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4112 @end menu
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 @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
4115 @subsection The date/time prompt
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4116 @cindex date, reading in minibuffer
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4117 @cindex time, reading in minibuffer
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4118
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4119 When Org-mode prompts for a date/time, the default is shown as an ISO
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4120 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
4121 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
4122 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
4123 can, for example, use @kbd{C-y} to paste a (possibly multi-line) string
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4124 copied from an email message. Org-mode will find whatever information
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4125 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
4126 @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
4127 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
4128 the second stamp of a range, it is taken from the stamp in the buffer.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4129 When filling in information, Org-mode assumes that most of the time you
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4130 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
4131 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
4132 future date@footnote{See the variable
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4133 @code{org-read-date-prefer-future}.}.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4134
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4135 For example, lets assume that today is @b{June 13, 2006}. Here is how
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4136 various inputs will be interpreted, the items filled in by Org-mode are
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4137 in @b{bold}.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4138
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4139 @example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4140 3-2-5 --> 2003-02-05
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4141 14 --> @b{2006}-@b{06}-14
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4142 12 --> @b{2006}-@b{07}-12
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4143 Fri --> nearest Friday (defaultdate or later)
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4144 sep 15 --> @b{2006}-11-15
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4145 feb 15 --> @b{2007}-02-15
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4146 sep 12 9 --> 2009-09-12
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4147 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
4148 22 sept 0:34 --> @b{2006}-09-22 0:34
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4149 @end example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4150
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4151 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
4152 @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
4153 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
4154 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
4155 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
4156 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
4157 the nth such day. E.g.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4158
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4159 @example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4160 +4d --> four days from today
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4161 +4 --> same as above
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4162 +2w --> two weeks from today
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4163 ++5 --> five days from default date
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4164 +2tue --> second tuesday from now.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4165 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4166
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4167 The function understands English month and weekday abbreviations. If
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4168 you want to use unabbreviated names and/or other languages, configure
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4169 the variables @code{parse-time-months} and @code{parse-time-weekdays}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4170
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4171 @cindex calendar, for selecting date
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4172 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
4173 you don't need/want the calendar, configure the variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4174 @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
4175 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
4176 @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
4177 information entered at the prompt. You can control the calendar fully
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4178 from the minibuffer:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4179
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4180 @kindex <
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4181 @kindex >
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4182 @kindex mouse-1
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4183 @kindex S-@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4184 @kindex S-@key{left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4185 @kindex S-@key{down}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4186 @kindex S-@key{up}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4187 @kindex M-S-@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4188 @kindex M-S-@key{left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4189 @kindex @key{RET}
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4190 @example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4191 > / < @r{Scroll calendar forward/backward by one month.}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4192 mouse-1 @r{Select date by clicking on it.}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4193 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
4194 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
4195 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
4196 @key{RET} @r{Choose date in calendar.}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4197 @end example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4198
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4199 The actions of the date/time prompt may seem complex, but I asure you
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4200 they will grow on you. To help you understand what is going on, the
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4201 current interpretation of your input will be displayed live in the
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4202 minibuffer@footnote{If you find this distracting, turn the display of
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4203 with @code{org-read-date-display-live}.}.
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 @node Custom time format, , The date/time prompt, Creating timestamps
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4206 @subsection Custom time format
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4207 @cindex custom date/time format
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4208 @cindex time format, custom
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4209 @cindex date format, custom
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4210
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4211 Org-mode uses the standard ISO notation for dates and times as it is
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4212 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
4213 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
4214 customizing the variables @code{org-display-custom-times} and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4215 @code{org-time-stamp-custom-formats}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4216
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4217 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4218 @kindex C-c C-x C-t
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4219 @item C-c C-x C-t
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4220 Toggle the display of custom formats for dates and times.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4221 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4222
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4223 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4224 Org-mode needs the default format for scanning, so the custom date/time
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4225 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
4226 @emph{over} the default format using text properties. This has the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4227 following consequences:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4228 @itemize @bullet
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4229 @item
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4230 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
4231 after.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4232 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4233 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
4234 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
4235 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
4236 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
4237 time will be changed by one minute.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4238 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4239 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
4240 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
4241 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4242 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
4243 disappear from the buffer after @emph{all} (invisible) characters
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4244 belonging to the ISO timestamp have been removed.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4245 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4246 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
4247 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
4248 format is shorter, things do work as expected.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4249 @end itemize
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4250
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4251
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4252 @node Deadlines and scheduling, Clocking work time, Creating timestamps, Dates and times
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4253 @section Deadlines and Scheduling
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4254
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4255 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
4256
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4257 @table @var
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4258 @item DEADLINE
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4259 @cindex DEADLINE keyword
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4260
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4261 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
4262 to be finished on that date.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4263
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4264 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
4265 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
4266 approaching or missed deadline, starting
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4267 @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
4268 until the entry is marked DONE. An example:
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4269
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4270 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4271 *** TODO write article about the Earth for the Guide
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4272 The editor in charge is [[bbdb:Ford Prefect]]
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4273 DEADLINE: <2004-02-29 Sun>
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4274 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4275
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4276 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
4277 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
4278 period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4279
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4280 @item SCHEDULED
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4281 @cindex SCHEDULED keyword
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4282
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4283 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
4284 date.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4285
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4286 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
4287 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
4288 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
4289 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
4290 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
4291 I.e., the task will automatically be forwarded until completed.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4292
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4293 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4294 *** TODO Call Trillian for a date on New Years Eve.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4295 SCHEDULED: <2004-12-25 Sat>
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4296 @end example
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4297
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4298 @noindent
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4299 @b{Important:} Scheduling an item in Org-mode should @i{not} be
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4300 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
4301 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
4302 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
4303 on the date where it applies. This is a frequent mis-understanding from
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4304 Org-users. In Org-mode, @i{scheduling} means setting a date when you
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4305 want to start working on an action item.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4306 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4307
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4308 You may use time stamps with repeaters in scheduling and deadline
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4309 entries. Org-mode will issue early and late warnings based on the
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4310 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
4311 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
4312 @c
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4313 @code{<%%(diary-float t 42)>}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4314 @c
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4315 in scheduling and deadline timestamps is limited. Org-mode does not
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4316 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
4317 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
4318 sexp entry matches.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4319
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4320 @menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4321 * Inserting deadline/schedule:: Planning items
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4322 * Repeated tasks:: Items that show up again and again
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4323 @end menu
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 @node Inserting deadline/schedule, Repeated tasks, Deadlines and scheduling, Deadlines and scheduling
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4326 @subsection Inserting deadline/schedule
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4327
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4328 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
4329 an item:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4330
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4331 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4332 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4333 @kindex C-c C-d
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4334 @item C-c C-d
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4335 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
4336 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
4337 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
4338 @c FIXME Any CLOSED timestamp will be removed.????????
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4339 @c
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4340 @kindex C-c / d
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4341 @cindex sparse tree, for deadlines
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4342 @item C-c / d
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4343 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
4344 which will become due within @code{org-deadline-warning-days}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4345 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
4346 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
4347 all deadlines due tomorrow.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4348 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4349 @kindex C-c C-s
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4350 @item C-c C-s
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4351 Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4352 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
4353 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
4354 the scheduling date from the entry.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4355 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4356
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4357 @node Repeated tasks, , Inserting deadline/schedule, Deadlines and scheduling
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4358 @subsection Repeated Tasks
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4359
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4360 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
4361 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
4362 or plain time stamp. In the following example
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4363 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4364 ** TODO Pay the rent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4365 DEADLINE: <2005-10-01 Sat +1m>
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4366 @end example
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4367 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
4368 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
4369 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
4370 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
4371 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
4372
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4373 Deadlines and scheduled items produce entries in the agenda when they
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4374 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
4375 completed once you have done so. When you mark a DEADLINE or a SCHEDULE
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4376 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
4377 agenda. The problem with this is, however, that then also the
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4378 @emph{next} instance of the repeated entry will not be active. Org-mode
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4379 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
4380 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
4381 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
4382 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
4383 actually switch the date like this:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4384
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4385 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4386 ** TODO Pay the rent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4387 DEADLINE: <2005-11-01 Tue +1m>
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4388 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4389
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4390 You will also be prompted for a note@footnote{You can change this using
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4391 the option @code{org-log-repeat}, or the @code{#+STARTUP} options
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4392 @code{logrepeat}, @code{lognoterepeat}, and @code{nologrepeat}.} that
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4393 will be put under the DEADLINE line to keep a record that you actually
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4394 acted on the previous instance of this deadline.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4395
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4396 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
4397 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
4398 will be visible.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4399
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4400 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
4401 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
4402 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
4403 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
4404 forgot to call you father for 3 weeks, it does not make sense to call
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4405 her 3 times in a single day to make up for it. Finally, there are tasks
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4406 like changing batteries which should always repeat a certain time
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4407 @i{after} the last time you did it. For these tasks, Org-mode has
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4408 special repeaters markes with @samp{++} and @samp{.+}. For example:
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4409
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4410 @example
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4411 ** TODO Call Father
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4412 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
4413 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
4414 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
4415 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
4416 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
4417 ** 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
4418 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
4419 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
4420 today.
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4421 @end example
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4422
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4423 You may have both scheduling and deadline information for a specific
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4424 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
4425
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4426 @node Clocking work time, , Deadlines and scheduling, Dates and times
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4427 @section Clocking work time
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4428
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4429 Org-mode allows you to clock the time you spent on specific tasks in a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4430 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
4431 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
4432 clock is stopped and the corresponding time interval is recorded. It
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4433 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
4434
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4435 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4436 @kindex C-c C-x C-i
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4437 @item C-c C-x C-i
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4438 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
4439 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
4440 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
4441 @code{:CLOCK:} drawer (see also the variable
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4442 @code{org-clock-into-drawer}).
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4443 @kindex C-c C-x C-o
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4444 @item C-c C-x C-o
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4445 Stop the clock (clock-out). The inserts another timestamp at the same
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4446 location where the clock was last started. It also directly computes
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4447 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
4448 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
4449 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
4450 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
4451 @code{#+STARTUP: lognoteclock-out}}.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4452 @kindex C-c C-y
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4453 @item C-c C-y
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4454 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
4455 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
4456 them with @kbd{S-@key{cursor}} keys, the update is automatic.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4457 @kindex C-c C-t
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4458 @item C-c C-t
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4459 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
4460 if it is running in this same item.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4461 @kindex C-c C-x C-x
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4462 @item C-c C-x C-x
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4463 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
4464 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
4465 @kindex C-c C-x C-j
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4466 @item C-c C-x C-j
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4467 Jump to the entry that contains the currently running clock, an another
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4468 window.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4469 @kindex C-c C-x C-d
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4470 @item C-c C-x C-d
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4471 Display time summaries for each subtree in the current buffer. This
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4472 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
4473 recorded under that heading, including the time of any subheadings. You
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4474 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
4475 when you change the buffer (see variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4476 @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
4477 @kindex C-c C-x C-r
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4478 @item C-c C-x C-r
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4479 Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4480 report as an org-mode table into the current file. When the cursor is
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4481 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
4482 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
4483 update it.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4484 @example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4485 #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
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 #+END: clocktable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4488 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4489 @noindent
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4490 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
4491 new table. The @samp{BEGIN} line can specify options:
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4492 @example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4493 :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
4494 :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
4495 :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
4496 nil @r{the current buffer or narrowed region}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4497 file @r{the full current buffer}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4498 subtree @r{the subtree where the clocktable is located}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4499 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
4500 tree @r{the surrounding level 1 tree}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4501 agenda @r{all agenda files}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4502 ("file"..) @r{scan these files}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4503 :block @r{The time block to consider. This block is specified relative}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4504 @r{to the current time and may be any of these keywords:}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4505 @r{@code{today}, @code{yesterday}, @code{thisweek}, @code{lastweek},}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4506 @r{@code{thismonth}, @code{lastmonth}, @code{thisyear}, or @code{lastyear}}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4507 :tstart @r{A time string specifying when to start considering times}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4508 :tend @r{A time string specifying when to stop considering times}
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4509 :step @r{@code{week} or @code{day}, to split the table into chunks}
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4510 :link @r{Link the item headlines in the table to their origins}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4511 @end example
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4512 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
4513 day, you could write
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4514 @example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4515 #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4516
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4517 #+END: clocktable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4518 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4519 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
4520 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
4521 only to fit it onto the manual.}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4522 @example
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4523 #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4524 :tend "<2006-08-10 Thu 12:00>"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4525
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4526 #+END: clocktable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4527 @end example
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4528 @kindex C-c C-c
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4529 @item C-c C-c
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4530 @kindex C-c C-x C-u
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4531 @itemx C-c C-x C-u
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4532 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
4533 @code{#+BEGIN} line of the dynamic block.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4534 @kindex C-u C-c C-x C-u
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4535 @item C-u C-c C-x C-u
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4536 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4537 you have several clocktable blocks in a buffer.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4538 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4539
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4540 The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4541 the agenda (@pxref{Weekly/Daily agenda}) to show which tasks have been
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4542 worked on or closed during a day.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4543
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4544 @node Remember, Agenda views, Dates and times, Top
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4545 @chapter Remember
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4546 @cindex @file{remember.el}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4547
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4548 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
4549 little interruption of your work flow. See
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4550 @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
4551 information. It is an excellent way to add new notes and tasks to
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4552 Org-mode files. Org-mode significantly expands the possibilities of
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4553 @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
4554 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
4555 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
4556 interactively, on the fly.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4557
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4558 @menu
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4559 * Setting up remember:: Some code for .emacs to get things going
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4560 * Remember templates:: Define the outline of different note types
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4561 * 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
4562 * 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
4563 @end menu
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4564
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4565 @node Setting up remember, Remember templates, Remember, Remember
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4566 @section Setting up remember
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4567
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4568 The following customization will tell @i{remember} to use org files as
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4569 target, and to create annotations compatible with Org-mode links.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4570
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4571 @example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4572 (org-remember-insinuate)
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4573 (setq org-directory "~/path/to/my/orgfiles/")
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4574 (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
4575 (define-key global-map "\C-cr" 'org-remember)
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4576 @end example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4577
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4578 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
4579 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
4580 suggestion.}. @code{org-remember} basically just calls @code{remember},
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4581 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
4582 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
4583 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
4584 stored: Just call @code{org-remember} with a prefix argument. If you
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4585 use two prefix arguments, Org-mode jumps to the location where the last
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4586 remember note was stored.
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4587
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4588 @node Remember templates, Storing notes, Setting up remember, Remember
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4589 @section Remember templates
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4590 @cindex templates, for remember
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4591
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4592 In combination with Org-mode, you can use templates to generate
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4593 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
4594 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
4595 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
4596 use:
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4597
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4598 @example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4599 (setq org-remember-templates
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4600 '(("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
4601 ("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
4602 ("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
4603 @end example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4604
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4605 @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
4606 character specifies how to select the template. It is useful if the
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4607 character is also the first letter of the name. The next string
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4608 specifies the template. Two more (optional) strings give the file in
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4609 which, and the headline under which the new note should be stored. The
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4610 file (if not present or @code{nil}) defaults to
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4611 @code{org-default-notes-file}, the heading to
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4612 @code{org-remember-default-headline}.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4613
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4614 An optional sixth element specifies the contexts in which the user can
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4615 select the template. This element can be either a list of major modes
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4616 or a function. @code{org-remember} will first check whether the function
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4617 returns @code{t} or if we are in any of the listed major mode, and select
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4618 the template accordingly.
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4619
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4620 So for example:
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4621
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4622 @example
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4623 (setq org-remember-templates
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4624 '(("Bug" ?b "* BUG %?\n %i\n %a" "~/org/BUGS.org" "Bugs" (emacs-lisp-mode))
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4625 ("Journal" ?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org" my-check)
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4626 ("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
4627 @end example
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4628
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4629 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
4630 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
4631 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
4632 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
4633
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4634 When you call @kbd{M-x remember} (or @kbd{M-x org-remember}) to remember
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4635 something, org will prompt for a key to select the template (if you have
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4636 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
4637 @example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4638 * TODO
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4639 [[file:link to where you called remember]]
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4640 @end example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4641
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4642 @noindent
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4643 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
4644 insertion of content:
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4645 @example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4646 %^@{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
4647 @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
4648 @r{%^@{prompt|default|completion2|completion3...@}}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4649 @r{The arrow keys access a prompt-specific history.}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4650 %t @r{time stamp, date only}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4651 %T @r{time stamp with date and time}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4652 %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
4653 %^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
4654 @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
4655 %n @r{user name (taken from @code{user-full-name})}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4656 %a @r{annotation, normally the link created with @code{org-store-link}}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4657 %A @r{like @code{%a}, but prompt for the description part}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4658 %i @r{initial content, the region when remember is called with C-u.}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4659 @r{The entire text will be indented like @code{%i} itself.}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4660 %c @r{Content of the clipboard, or current kill ring head.}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4661 %^g @r{prompt for tags, with completion on tags in target file.}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4662 %^G @r{prompt for tags, with completion all tags in all agenda files.}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4663 %: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
4664 %[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
4665 %(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
4666 %! @r{immediately store note after completing the template}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4667 @r{(skipping the @kbd{C-c C-c} that normally triggers storing)}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4668 @end example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4669
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4670 @noindent
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4671 For specific link types, the following keywords will be
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4672 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
4673 hyperlink types}), any property you store with
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4674 @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
4675 similar way.}:
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4676
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4677 @example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4678 Link type | Available keywords
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4679 -------------------+----------------------------------------------
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4680 bbdb | %:name %:company
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4681 bbdb | %::server %:port %:nick
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4682 vm, wl, mh, rmail | %:type %:subject %:message-id
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4683 | %:from %:fromname %:fromaddress
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4684 | %:to %:toname %:toaddress
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4685 | %: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
4686 gnus | %:group, @r{for messages also all email fields}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4687 w3, w3m | %:url
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4688 info | %:file %:node
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4689 calendar | %:date"
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4690 @end example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4691
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4692 @noindent
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4693 To place the cursor after template expansion use:
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
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4696 %? @r{After completing the template, position cursor here.}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4697 @end example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4698
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4699 @noindent
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4700 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
4701 @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
4702 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
4703
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4704 @node Storing notes, Refiling notes, Remember templates, Remember
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4705 @section Storing notes
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4706
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4707 When you are finished preparing a note with @i{remember}, you have to
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4708 press @kbd{C-c C-c} to file the note away. The handler will store the
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4709 note in the file and under the headline specified in the template, or it
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4710 will use the default file and headlines. The window configuration will
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4711 be restored, sending you back to the working context before the call to
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4712 @code{remember}. To re-use the location found during the last call to
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4713 @code{remember}, exit the remember buffer with @kbd{C-u C-u C-c C-c},
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4714 i.e. specify a double prefix argument to @kbd{C-c C-c}.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4715
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4716 If you want to store the note directly to a different place, use
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4717 @kbd{C-u C-c C-c} instead to exit remember@footnote{Configure the
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4718 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
4719 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
4720 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
4721 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
4722 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
4723 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
4724 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
4725 location:
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4726 @example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4727 @key{TAB} @r{Cycle visibility.}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4728 @key{down} / @key{up} @r{Next/previous visible headline.}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4729 n / p @r{Next/previous visible headline.}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4730 f / b @r{Next/previous headline same level.}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4731 u @r{One level up.}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4732 @c 0-9 @r{Digit argument.}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4733 @end example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4734 @noindent
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4735 Pressing @key{RET} or @key{left} or @key{right}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4736 then leads to the following result.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4737
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4738 @multitable @columnfractions 0.2 0.15 0.65
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4739 @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
4740 @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
4741 @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
4742 @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
4743 @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
4744 @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
4745 @item not on headline @tab @key{RET}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4746 @tab at cursor position, level taken from context.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4747 @end multitable
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4748
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4749 Before inserting the text into a tree, the function ensures that the
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4750 text has a headline, i.e. a first line that starts with a @samp{*}. If
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4751 not, a headline is constructed from the current date and some additional
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4752 data. If you have indented the text of the note below the headline, the
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4753 indentation will be adapted if inserting the note into the tree requires
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4754 demotion from level 1.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4755
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4756 @node Refiling notes, , Storing notes, Remember
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4757 @section Refiling notes
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4758 @cindex refiling notes
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4759
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4760 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
4761 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
4762 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
4763 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
4764 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
4765 special command:
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4766
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4767 @table @kbd
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4768 @kindex C-c C-w
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4769 @item C-c C-w
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4770 Refile the entry at point. This command offers possible locations for
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4771 refiling the entry and lets you select one with completion. The item is
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4772 filed below the target heading as a subitem. Depending on
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4773 @code{org-reverse-note-order}, it will be either the first of last
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4774 subitem.@* By default, all level 1 headlines in the current buffer are
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4775 considered to be targets, but you can have more complex definitions
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4776 across a number of files. See the variable @code{org-refile-targets}
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4777 for details.
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4778 @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
4779 @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
4780 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
4781 @kindex C-u 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
4782 @item C- 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
4783 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
4784 @end table
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4785
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4786 @node Agenda views, Embedded LaTeX, Remember, Top
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4787 @chapter Agenda Views
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4788 @cindex agenda views
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 Due to the way Org-mode works, TODO items, time-stamped items, and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4791 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
4792 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
4793 important for a particular date, this information must be collected,
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4794 sorted and displayed in an organized way.
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 Org-mode 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
4797 in a separate buffer. Seven different view types are provided:
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4798
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4799 @itemize @bullet
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4800 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4801 an @emph{agenda} that is like a calendar and shows information
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4802 for specific dates,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4803 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4804 a @emph{TODO list} that covers all unfinished
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4805 action items,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4806 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4807 a @emph{tags view}, showings headlines based on
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4808 the tags associated with them,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4809 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4810 a @emph{timeline view} that shows all events in a single Org-mode file,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4811 in time-sorted view,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4812 @item
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4813 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
4814 that contain specified keywords.
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4815 @item
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4816 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
4817 along, and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4818 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4819 @emph{custom views} that are special tag/keyword searches and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4820 combinations of different views.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4821 @end itemize
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4822
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4823 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4824 The extracted information is displayed in a special @emph{agenda
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4825 buffer}. This buffer is read-only, but provides commands to visit the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4826 corresponding locations in the original Org-mode 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
4827 edit these files remotely.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4828
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4829 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
4830 window configuration is restored when the agenda exits:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4831 @code{org-agenda-window-setup} and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4832 @code{org-agenda-restore-windows-after-quit}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4833
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4834 @menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4835 * Agenda files:: Files being searched for agenda information
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4836 * Agenda dispatcher:: Keyboard access to agenda views
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4837 * Built-in agenda views:: What is available out of the box?
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4838 * Presentation and sorting:: How agenda items are prepared for display
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4839 * Agenda commands:: Remote editing of org trees
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4840 * Custom agenda views:: Defining special searches and views
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4841 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4842
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4843 @node Agenda files, Agenda dispatcher, Agenda views, Agenda views
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4844 @section Agenda files
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4845 @cindex agenda files
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4846 @cindex files for agenda
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4847
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4848 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
4849 files}, the files listed in the variable
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4850 @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
4851 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
4852 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
4853 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
4854 of the list.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4855
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4856 Thus even if you only work with a single Org-mode file, this file should
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4857 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
4858 @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
4859 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
4860 dispatcher command.}. You can customize @code{org-agenda-files}, but
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4861 the easiest way to maintain it is through the following commands
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4862
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4863 @cindex files, adding to agenda list
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4864 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4865 @kindex C-c [
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4866 @item C-c [
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4867 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
4868 the front of the list. If it was already in the list, it is moved to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4869 the front. With prefix arg, file is added/moved to the end.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4870 @kindex C-c ]
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4871 @item C-c ]
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4872 Remove current file from the list of agenda files.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4873 @kindex C-,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4874 @kindex C-'
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4875 @item C-,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4876 @itemx C-'
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4877 Cycle through agenda file list, visiting one file after the other.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4878 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4879
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4880 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4881 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
4882 to visit any of them.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4883
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4884 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
4885 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
4886 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
4887 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
4888 (@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
4889 extended period, use the following commands:
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4890
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4891 @table @kbd
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4892 @kindex C-c C-x <
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4893 @item C-c C-x <
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4894 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
4895 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
4896 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
4897 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
4898 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
4899 agenda view, the new restriction takes effect immediately.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4900 @kindex C-c C-x <
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4901 @item C-c C-x <
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4902 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
4903 @end table
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4904
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4905 @noindent
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4906 When working with @file{Speedbar}, you can use the following commands in
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4907 the speedbar frame:
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4908 @table @kbd
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4909 @kindex <
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4910 @item < @r{in the speedbar frame}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4911 Permanently restrict the agenda to the item at the cursor in the
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4912 speedbar frame, either an Org-mode file or a subtree in such a file.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4913 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
4914 effect immediately.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4915 @kindex <
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4916 @item > @r{in the speedbar frame}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4917 Lift the restriction again.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4918 @end table
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4919
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4920 @node Agenda dispatcher, Built-in agenda views, Agenda files, Agenda views
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4921 @section The agenda dispatcher
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4922 @cindex agenda dispatcher
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4923 @cindex dispatching agenda commands
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4924 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
4925 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
4926 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
4927 is accessed and list keyboard access to commands accordingly. After
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4928 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
4929 command. The dispatcher offers the following default commands:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4930 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4931 @item a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4932 Create the calendar-like agenda (@pxref{Weekly/Daily agenda}).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4933 @item t @r{/} T
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4934 Create a list of all TODO items (@pxref{Global TODO list}).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4935 @item m @r{/} M
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4936 Create a list of headlines matching a TAGS expression (@pxref{Matching
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4937 tags and properties}).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4938 @item L
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4939 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
4940 @item s
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4941 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
4942 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
4943 @item /
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4944 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
4945 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
4946 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
4947 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
4948 1.
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4949 @item # @r{/} !
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
4950 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
4951 @item <
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4952 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
4953 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
4954 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
4955 selecting the command.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4956 @item < <
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4957 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
4958 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
4959 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
4960 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
4961 character selecting the command.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4962 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4963
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4964 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
4965 dispatcher, just like the default commands. This includes the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4966 possibility to create extended agenda buffers that contain several
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4967 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
4968 a number of special tags matches. @xref{Custom agenda views}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4969
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4970 @node Built-in agenda views, Presentation and sorting, Agenda dispatcher, Agenda views
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4971 @section The built-in agenda views
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4972
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4973 In this section we describe the built-in views.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4974
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4975 @menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4976 * Weekly/Daily agenda:: The calendar page with current tasks
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4977 * Global TODO list:: All unfinished action items
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4978 * Matching tags and properties:: Structured information with fine-tuned search
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4979 * 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
4980 * Keyword search:: Finding entries by keyword
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4981 * Stuck projects:: Find projects you need to review
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4982 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4983
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4984 @node Weekly/Daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4985 @subsection The weekly/daily agenda
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4986 @cindex agenda
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4987 @cindex weekly agenda
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4988 @cindex daily agenda
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4989
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4990 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
4991 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
4992
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4993 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4994 @cindex org-agenda, command
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4995 @kindex C-c a a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4996 @item C-c a a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4997 Compile an agenda for the current week from a list of org files. The
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4998 agenda shows the entries for each day. With a numeric
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
4999 prefix@footnote{For backward compatibility, the universal prefix
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5000 @kbd{C-u} causes all TODO entries to be listed before the agenda. This
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5001 feature is deprecated, use the dedicated TODO list, or a block agenda
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5002 instead.} (like @kbd{C-u 2 1 C-c a a}) you may set the number of days
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5003 to be displayed (see also the variable @code{org-agenda-ndays})
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5004 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5005
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5006 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
5007 change the dates of deadlines and appointments from the agenda buffer.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5008 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
5009 commands}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5010
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5011 @subsubheading Calendar/Diary integration
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5012 @cindex calendar integration
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5013 @cindex diary integration
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5014
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5015 Emacs contains the calendar and diary by Edward M. Reingold. The
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5016 calendar displays a three-month calendar with holidays from different
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5017 countries and cultures. The diary allows you to keep track of
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5018 anniversaries, lunar phases, sunrise/set, recurrent appointments
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5019 (weekly, monthly) and more. In this way, it is quite complementary to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5020 Org-mode. It can be very useful to combine output from Org-mode with
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5021 the diary.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5022
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5023 In order to include entries from the Emacs diary into Org-mode's
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5024 agenda, you only need to customize the variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5025
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5026 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5027 (setq org-agenda-include-diary t)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5028 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5029
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5030 @noindent After that, everything will happen automatically. All diary
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5031 entries including holidays, anniversaries etc will be included in the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5032 agenda buffer created by Org-mode. @key{SPC}, @key{TAB}, and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5033 @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
5034 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
5035 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
5036 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
5037 Sunrise/Sunset times, show lunar phases and to convert to other
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5038 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
5039 between calendar and agenda.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5040
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5041 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
5042 faster to not use the above setting, but instead to copy or even move
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5043 the entries into an Org-mode file. Org-mode evaluates diary-style sexp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5044 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
5045 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
5046 the left margin, no white space is allowed before them. For example,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5047 the following segment of an Org-mode file will be processed and entries
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5048 will be made in the agenda:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5049
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5050 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5051 * Birthdays and similar stuff
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5052 #+CATEGORY: Holiday
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5053 %%(org-calendar-holiday) ; special function for holiday names
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5054 #+CATEGORY: Ann
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5055 %%(diary-anniversary 14 5 1956) Arthur Dent is %d years old
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5056 %%(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
5057 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5058
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5059 @subsubheading Appointment reminders
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5060 @cindex @file{appt.el}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5061 @cindex appointment reminders
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5062
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5063 Org can interact with Emacs appointments notification facility.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5064
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5065 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
5066 @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
5067 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
5068 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
5069 details.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5070
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5071 @node Global TODO list, Matching tags and properties, Weekly/Daily agenda, Built-in agenda views
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5072 @subsection The global TODO list
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5073 @cindex global TODO list
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5074 @cindex TODO list, global
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5075
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5076 The global TODO list contains all unfinished TODO items, formatted and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5077 collected into a single place.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5078
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5079 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5080 @kindex C-c a t
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5081 @item C-c a t
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5082 Show the global TODO list. This collects the TODO items from all
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5083 agenda files (@pxref{Agenda views}) into a single buffer. The buffer is in
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5084 @code{agenda-mode}, so there are commands to examine and manipulate
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5085 the TODO entries directly from that buffer (@pxref{Agenda commands}).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5086 @kindex C-c a T
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5087 @item C-c a T
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5088 @cindex TODO keyword matching
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5089 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
5090 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
5091 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
5092 specify several keywords by separating them with @samp{|} as boolean OR
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5093 operator. With a numeric prefix, the Nth keyword in
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5094 @code{org-todo-keywords} is selected.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5095 @kindex r
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5096 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
5097 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
5098 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
5099 keyword, define a custom command for it (@pxref{Agenda dispatcher}).@*
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5100 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
5101 search (@pxref{Tag searches}).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5102 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5103
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5104 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
5105 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
5106 TODO list are described in @ref{Agenda commands}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5107
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5108 @cindex sublevels, inclusion into todo list
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5109 Normally the global todo list simply shows all headlines with TODO
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5110 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
5111 it more compact:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5112 @itemize @minus
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5113 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5114 Some people view a TODO item that has been @emph{scheduled} for
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5115 execution (@pxref{Time stamps}) as no longer @emph{open}. Configure the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5116 variable @code{org-agenda-todo-ignore-scheduled} to exclude scheduled
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5117 items from the global TODO list.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5118 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5119 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
5120 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
5121 and omit the sublevels from the global list. Configure the variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5122 @code{org-agenda-todo-list-sublevels} to get this behavior.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5123 @end itemize
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5124
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5125 @node Matching tags and properties, Timeline, Global TODO list, Built-in agenda views
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5126 @subsection Matching Tags and Properties
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5127 @cindex matching, of tags
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5128 @cindex matching, of properties
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5129 @cindex tags view
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5130
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5131 If headlines in the agenda files are marked with @emph{tags}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5132 (@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
5133 to them and collect them into an agenda buffer.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5134
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5135 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5136 @kindex C-c a m
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5137 @item C-c a m
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5138 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
5139 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
5140 expression with tags, like @samp{+work+urgent-withboss} or
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5141 @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
5142 define a custom command for it (@pxref{Agenda dispatcher}).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5143 @kindex C-c a M
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5144 @item C-c a M
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5145 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
5146 and force checking subitems (see variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5147 @code{org-tags-match-list-sublevels}). Matching specific todo keywords
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5148 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
5149 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5150
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5151 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
5152 commands}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5153
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5154 @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
5155 @subsection Timeline for a single file
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5156 @cindex timeline, single file
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5157 @cindex time-sorted view
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5158
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5159 The timeline summarizes all time-stamped items from a single Org-mode
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5160 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
5161 to give an overview over events in a project.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5162
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5163 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5164 @kindex C-c a L
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5165 @item C-c a L
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5166 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
5167 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
5168 (scheduled or not) are also listed under the current date.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5169 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5170
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5171 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5172 The commands available in the timeline buffer are listed in
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5173 @ref{Agenda commands}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5174
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5175 @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
5176 @subsection Keyword search
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5177 @cindex keyword search
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5178 @cindex searching, for keywords
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5179
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5180 This agenda view is a general text search facility for Org-mode entries.
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5181 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
5182
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5183 @table @kbd
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5184 @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
5185 @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
5186 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
5187 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
5188 string
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5189
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5190 @example
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5191 +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
5192 @end example
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5193
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5194 @noindent
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5195 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
5196 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
5197 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
5198 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
5199
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5200 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
5201 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
5202 @end table
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5203
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5204 @node Stuck projects, , Keyword search, Built-in agenda views
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5205 @subsection Stuck projects
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5206
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5207 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
5208 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
5209 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
5210 has no defined next actions, so it will never show up in the TODO lists
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5211 Org-mode produces. During the review, you need to identify such
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5212 projects and define next actions for them.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5213
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5214 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5215 @kindex C-c a #
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5216 @item C-c a #
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5217 List projects that are stuck.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5218 @kindex C-c a !
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5219 @item C-c a !
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5220 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
5221 project is and how to find it.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5222 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5223
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5224 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
5225 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
5226 level-2 headlines, and that a project is not stuck if it has at least
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5227 one entry marked with a todo keyword TODO or NEXT or NEXTACTION.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5228
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5229 Lets assume that you, in your own way of using Org-mode, identify
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5230 projects with a tag PROJECT, and that you use a todo keyword MAYBE to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5231 indicate a project that should not be considered yet. Lets further
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5232 assume that the todo keyword DONE marks finished projects, and that NEXT
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5233 and TODO indicate next actions. The tag @@SHOP indicates shopping and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5234 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
5235 contains the special word IGNORE anywhere, it should not be listed
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5236 either. In this case you would start by identifying eligible projects
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5237 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
5238 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
5239 are not stuck. The correct customization for this is
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5240
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5241 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5242 (setq org-stuck-projects
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5243 '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP")
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5244 "\\<IGNORE\\>"))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5245 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5246
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5247
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5248 @node Presentation and sorting, Agenda commands, Built-in agenda views, Agenda views
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5249 @section Presentation and sorting
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5250 @cindex presentation, of agenda items
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5251
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5252 Before displaying items in an agenda view, Org-mode visually prepares
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5253 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
5254 starts with a @emph{prefix} that contains the @emph{category}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5255 (@pxref{Categories}) of the item and other important information. You can
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5256 customize the prefix using the option @code{org-agenda-prefix-format}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5257 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
5258 associated with the item.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5259
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5260 @menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5261 * Categories:: Not all tasks are equal
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5262 * Time-of-day specifications:: How the agenda knows the time
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5263 * Sorting of agenda items:: The order of things
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5264 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5265
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5266 @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
5267 @subsection Categories
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5268
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5269 @cindex category
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5270 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
5271 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
5272 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
5273 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
5274 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
5275 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
5276 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
5277 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
5278 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
5279 property.}:
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5280
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5281 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5282 #+CATEGORY: Thesis
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5283 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5284
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5285 @noindent
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5286 If you would like to have a special CATEGORY for a single entry or a
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5287 (sub)tree, give the entry a @code{:CATEGORY:} property with the location
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5288 as the value (@pxref{Properties and columns}).
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5289
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5290 @noindent
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5291 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
5292 longer than 10 characters.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5293
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5294 @node Time-of-day specifications, Sorting of agenda items, Categories, Presentation and sorting
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5295 @subsection Time-of-Day Specifications
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5296 @cindex time-of-day specification
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5297
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5298 Org-mode checks each agenda item for a time-of-day specification. The
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5299 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
5300 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
5301 ranges can be specified with two time stamps, like
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5302 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5303 @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
5304
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5305 In the headline of the entry itself, a time(range) may also appear as
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5306 plain text (like @samp{12:45} or a @samp{8:30-1pm}. If the agenda
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5307 integrates the Emacs diary (@pxref{Weekly/Daily agenda}), time
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5308 specifications in diary entries are recognized as well.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5309
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5310 For agenda display, Org-mode extracts the time and displays it in a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5311 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
5312 the previous paragraphs would end up in the agenda like this:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5313
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5314 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5315 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
5316 12:45...... Ford Prefect arrives and takes Arthur to the pub
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5317 19:00...... The Vogon reads his poem
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5318 20:30-22:15 Marwin escorts the Hitchhikers to the bridge
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5319 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5320
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5321 @cindex time grid
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5322 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
5323 timed entries are embedded in a time grid, like
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5324
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5325 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5326 8:00...... ------------------
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5327 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
5328 10:00...... ------------------
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5329 12:00...... ------------------
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5330 12:45...... Ford Prefect arrives and takes Arthur to the pub
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5331 14:00...... ------------------
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5332 16:00...... ------------------
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5333 18:00...... ------------------
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5334 19:00...... The Vogon reads his poem
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5335 20:00...... ------------------
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5336 20:30-22:15 Marwin escorts the Hitchhikers to the bridge
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5337 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5338
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5339 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
5340 @code{org-agenda-use-time-grid}, and can be configured with
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5341 @code{org-agenda-time-grid}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5342
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5343 @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
5344 @subsection Sorting of agenda items
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5345 @cindex sorting, of agenda items
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5346 @cindex priorities, of agenda items
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5347 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
5348 done depends on the type of view.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5349 @itemize @bullet
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5350 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5351 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
5352 default order is to first collect all items containing an explicit
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5353 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
5354 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
5355 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
5356 Within each category, items are sorted by priority (@pxref{Priorities}),
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5357 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
5358 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
5359 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
5360 @item
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5361 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
5362 each category, sorting takes place according to priority
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5363 (@pxref{Priorities}).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5364 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5365 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
5366 sequence in which they are found in the agenda files.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5367 @end itemize
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5368
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5369 Sorting can be customized using the variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5370 @code{org-agenda-sorting-strategy}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5371
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5372
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5373 @node Agenda commands, Custom agenda views, Presentation and sorting, Agenda views
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5374 @section Commands in the agenda buffer
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5375 @cindex commands, in agenda buffer
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5376
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5377 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
5378 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
5379 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
5380 original entry location, and to edit the org-files ``remotely'' from
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5381 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
5382 removing the risk that your agenda and note files may diverge.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5383
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5384 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
5385 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
5386
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5387 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5388 @tsubheading{Motion}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5389 @cindex motion commands in agenda
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5390 @kindex n
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5391 @item n
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5392 Next line (same as @key{up} and @kbd{C-p}).
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5393 @kindex p
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5394 @item p
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5395 Previous line (same as @key{down} and @kbd{C-n}).
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5396 @tsubheading{View/GoTo org file}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5397 @kindex mouse-3
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5398 @kindex @key{SPC}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5399 @item mouse-3
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5400 @itemx @key{SPC}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5401 Display the original location of the item in another window.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5402 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5403 @kindex L
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5404 @item L
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5405 Display original location and recenter that window.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5406 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5407 @kindex mouse-2
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5408 @kindex mouse-1
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5409 @kindex @key{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5410 @item mouse-2
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5411 @itemx mouse-1
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5412 @itemx @key{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5413 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
5414 22, @kbd{mouse-1} will also works for this.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5415 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5416 @kindex @key{RET}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5417 @itemx @key{RET}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5418 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
5419 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5420 @kindex f
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5421 @item f
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5422 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
5423 the agenda buffer, the other window always shows the corresponding
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5424 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
5425 agenda buffers can be set with the variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5426 @code{org-agenda-start-with-follow-mode}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5427 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5428 @kindex b
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5429 @item b
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5430 Display the entire subtree of the current item in an indirect buffer.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5431 With numerical prefix ARG, go up to this level and then take that tree.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5432 If ARG is negative, go up that many levels. With @kbd{C-u} prefix, do
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5433 not remove the previously used indirect buffer.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5434 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5435 @kindex l
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5436 @item l
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5437 Toggle Logbook mode. In Logbook mode, entries that where marked DONE while
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5438 logging was on (variable @code{org-log-done}) are shown in the agenda,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5439 as are entries that have been clocked on that day.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5440
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5441 @tsubheading{Change display}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5442 @cindex display changing, in agenda
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5443 @kindex o
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5444 @item o
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5445 Delete other windows.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5446 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5447 @kindex d
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5448 @kindex w
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5449 @kindex m
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5450 @kindex y
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5451 @item d w m y
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5452 Switch to day/week/month/year view. When switching to day or week view,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5453 this setting becomes the default for subseqent agenda commands. Since
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5454 month and year views are slow to create, the do not become the default.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5455 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5456 @kindex D
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5457 @item D
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5458 Toggle the inclusion of diary entries. See @ref{Weekly/Daily agenda}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5459 @c
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5460 @kindex G
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5461 @item G
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5462 Toggle the time grid on and off. See also the variables
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5463 @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
5464 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5465 @kindex r
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5466 @item r
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5467 Recreate the agenda buffer, for example to reflect the changes
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5468 after modification of the time stamps of items with S-@key{left} and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5469 S-@key{right}. When the buffer is the global todo list, a prefix
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5470 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
5471 keyword.
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5472 @kindex g
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5473 @item g
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5474 Same as @kbd{r}.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5475 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5476 @kindex s
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5477 @kindex C-x C-s
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5478 @item s
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5479 @itemx C-x C-s
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5480 Save all Org-mode buffers in the current Emacs session.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5481 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5482 @kindex @key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5483 @item @key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5484 Display the following @code{org-agenda-ndays} days. For example, if
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5485 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
5486 arg, go forward that many times @code{org-agenda-ndays} days.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5487 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5488 @kindex @key{left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5489 @item @key{left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5490 Display the previous dates.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5491 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5492 @kindex .
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5493 @item .
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5494 Goto today.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5495
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5496 @tsubheading{Query editing}
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5497 @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
5498
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5499 @kindex [
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5500 @kindex ]
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5501 @kindex @{
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5502 @kindex @}
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5503 @item [ ] @{ @}
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5504 In the @i{search view} (@pxref{Keyword search}), these keys add new
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5505 search words (@kbd{[} and @kbd{]}) or new regular expressions (@kbd{@{}
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5506 and @kbd{@}}) to the query string. The opening bracket/brace will add a
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5507 positive search term prefixed by @samp{+}, indicating that this search
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5508 term @i{must} occur/match in the entry. Closing bracket/brace add a
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5509 negative search term which @i{must not} occur/match in the entry for it
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5510 to be selected.
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5511
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5512
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5513 @tsubheading{Remote editing}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5514 @cindex remote editing, from agenda
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5515
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5516 @item 0-9
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5517 Digit argument.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5518 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5519 @cindex undoing remote-editing events
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5520 @cindex remote editing, undo
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5521 @kindex C-_
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5522 @item C-_
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5523 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
5524 both in the agenda buffer and in the remote buffer.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5525 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5526 @kindex t
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5527 @item t
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5528 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
5529 original org file.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5530 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5531 @kindex C-k
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5532 @item C-k
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5533 Delete the current agenda item along with the entire subtree belonging
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5534 to it in the original Org-mode file. If the text to be deleted remotely
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5535 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
5536 variable @code{org-agenda-confirm-kill}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5537 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5538 @kindex $
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5539 @item $
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5540 Archive the subtree corresponding to the current headline.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5541 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5542 @kindex T
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5543 @item T
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5544 Show all tags associated with the current item. Because of
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5545 inheritance, this may be more than the tags listed in the line itself.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5546 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5547 @kindex :
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5548 @item :
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5549 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
5550 agenda, change a tag for all headings in the region.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5551 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5552 @kindex a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5553 @item a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5554 Toggle the ARCHIVE tag for the current headline.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5555 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5556 @kindex ,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5557 @item ,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5558 Set the priority for the current item. Org-mode prompts for the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5559 priority character. If you reply with @key{SPC}, the priority cookie
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5560 is removed from the entry.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5561 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5562 @kindex P
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5563 @item P
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5564 Display weighted priority of current item.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5565 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5566 @kindex +
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5567 @kindex S-@key{up}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5568 @item +
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5569 @itemx S-@key{up}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5570 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
5571 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
5572 key for this.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5573 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5574 @kindex -
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5575 @kindex S-@key{down}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5576 @item -
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5577 @itemx S-@key{down}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5578 Decrease the priority of the current item.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5579 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5580 @kindex C-c C-s
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5581 @item C-c C-s
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5582 Schedule this item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5583 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5584 @kindex C-c C-d
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5585 @item C-c C-d
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5586 Set a deadline for this item.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5587 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5588 @kindex S-@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5589 @item S-@key{right}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5590 Change the time stamp associated with the current line by one day into
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5591 the future. With prefix argument, change it by that many days. For
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5592 example, @kbd{3 6 5 S-@key{right}} will change it by a year. The
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5593 stamp is changed in the original org file, but the change is not
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5594 directly reflected in the agenda buffer. Use the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5595 @kbd{r} key to update the buffer.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5596 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5597 @kindex S-@key{left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5598 @item S-@key{left}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5599 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
5600 into the past.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5601 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5602 @kindex >
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5603 @item >
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5604 Change the time stamp associated with the current line to today.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5605 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
5606 on my keyboard.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5607 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5608 @kindex I
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5609 @item I
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5610 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
5611 is stopped first.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5612 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5613 @kindex O
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5614 @item O
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5615 Stop the previously started clock.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5616 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5617 @kindex X
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5618 @item X
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5619 Cancel the currently running clock.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5620
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5621 @kindex J
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5622 @item J
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5623 Jump to the running clock in another window.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5624
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5625 @tsubheading{Calendar commands}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5626 @cindex calendar commands, from agenda
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5627 @kindex c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5628 @item c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5629 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
5630 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5631 @item c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5632 When in the calendar, compute and show the Org-mode agenda for the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5633 date at the cursor.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5634 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5635 @cindex diary entries, creating from agenda
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5636 @kindex i
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5637 @item i
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5638 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
5639 (day, weekly, monthly, yearly, anniversary, cyclic) and creates a new
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5640 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
5641 The date is taken from the cursor position.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5642 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5643 @kindex M
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5644 @item M
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5645 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
5646 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5647 @kindex S
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5648 @item S
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5649 Show sunrise and sunset times. The geographical location must be set
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5650 with calendar variables, see documentation of the Emacs calendar.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5651 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5652 @kindex C
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5653 @item C
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5654 Convert the date at cursor into many other cultural and historic
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5655 calendars.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5656 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5657 @kindex H
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5658 @item H
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5659 Show holidays for three month around the cursor date.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5660 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5661 @c FIXME: This should be a different key.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5662 @kindex C-c C-x C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5663 @item C-c C-x C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5664 Export a single iCalendar file containing entries from all agenda files.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5665
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5666 @tsubheading{Exporting to a file}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5667 @kindex C-x C-w
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5668 @item C-x C-w
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5669 @cindex exporting agenda views
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5670 @cindex agenda views, exporting
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5671 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
5672 selected file name, the view will be exported as HTML (extension
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5673 @file{.html} or @file{.htm}), Postscript (extension @file{.ps}), or
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5674 plain text (any other extension). Use the variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5675 @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
5676 and for @file{htmlize} to be used during export.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5677
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5678 @tsubheading{Quit and Exit}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5679 @kindex q
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5680 @item q
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5681 Quit agenda, remove the agenda buffer.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5682 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5683 @kindex x
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5684 @cindex agenda files, removing buffers
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5685 @item x
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5686 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
5687 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
5688 visit org files will not be removed.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5689 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5690
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 @node Custom agenda views, , Agenda commands, Agenda views
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5693 @section Custom agenda views
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5694 @cindex custom agenda views
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5695 @cindex agenda views, custom
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5696
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5697 Custom agenda commands serve two purposes: to store and quickly access
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5698 frequently used TODO and tags searches, and to create special composite
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5699 agenda buffers. Custom agenda commands will be accessible through the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5700 dispatcher (@pxref{Agenda dispatcher}), just like the default commands.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5701
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5702 @menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5703 * Storing searches:: Type once, use often
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5704 * Block agenda:: All the stuff you need in a single buffer
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5705 * Setting Options:: Changing the rules
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5706 * Exporting Agenda Views:: Writing agendas to files.
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5707 * Extracting Agenda Information for other programs::
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5708 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5709
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5710 @node Storing searches, Block agenda, Custom agenda views, Custom agenda views
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5711 @subsection Storing searches
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5712
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5713 The first application of custom searches is the definition of keyboard
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5714 shortcuts for frequently used searches, either creating an agenda
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5715 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
5716 buffer).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5717 @kindex C-c a C
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5718 Custom commands are configured in the variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5719 @code{org-agenda-custom-commands}. You can customize this variable, for
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5720 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
5721 Emacs Lisp in @file{.emacs}. The following example contains all valid
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5722 search types:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5723
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5724 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5725 @group
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5726 (setq org-agenda-custom-commands
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5727 '(("w" todo "WAITING")
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5728 ("W" todo-tree "WAITING")
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5729 ("u" tags "+boss-urgent")
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5730 ("v" tags-todo "+boss-urgent")
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5731 ("U" tags-tree "+boss-urgent")
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5732 ("f" occur-tree "\\<FIXME\\>")
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5733 ("h" . "HOME+Name tags searches") ; description for "h" prefix
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5734 ("hl" tags "+home+Lisa")
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5735 ("hp" tags "+home+Peter")
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5736 ("hk" tags "+home+Kim")))
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5737 @end group
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5738 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5739
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5740 @noindent
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5741 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
5742 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
5743 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
5744 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
5745 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
5746 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
5747 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
5748 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
5749 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
5750 therefore define:
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5751
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5752 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5753 @item C-c a w
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5754 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
5755 keyword
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5756 @item C-c a W
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5757 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
5758 results as a sparse tree
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5759 @item C-c a u
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5760 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
5761 @samp{:urgent:}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5762 @item C-c a v
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5763 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
5764 headlines that are also TODO items
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5765 @item C-c a U
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5766 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
5767 displaying the result as a sparse tree
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5768 @item C-c a f
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5769 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
5770 containing the word @samp{FIXME}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5771 @item C-c a h
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5772 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
5773 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
5774 Peter, or Kim) as additional tag to match.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5775 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5776
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5777 @node Block agenda, Setting Options, Storing searches, Custom agenda views
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5778 @subsection Block agenda
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5779 @cindex block agenda
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5780 @cindex agenda, with block views
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5781
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5782 Another possibility is the construction of agenda views that comprise
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5783 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
5784 the agenda buffer. The available commands include @code{agenda} for the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5785 daily or weekly agenda (as created with @kbd{C-c a a}), @code{alltodo}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5786 for the global todo list (as constructed with @kbd{C-c a t}), and the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5787 matching commands discussed above: @code{todo}, @code{tags}, and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5788 @code{tags-todo}. Here are two examples:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5789
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5790 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5791 @group
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5792 (setq org-agenda-custom-commands
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5793 '(("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
5794 ((agenda "")
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5795 (tags-todo "home")
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5796 (tags "garden")))
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5797 ("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
5798 ((agenda "")
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5799 (tags-todo "work")
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5800 (tags "office")))))
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5801 @end group
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5802 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5803
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5804 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5805 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
5806 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
5807 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
5808 @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
5809 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
5810
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5811 @node Setting Options, Exporting Agenda Views, Block agenda, Custom agenda views
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5812 @subsection Setting Options for custom commands
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5813 @cindex options, for custom agenda views
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5814
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5815 Org-mode contains a number of variables regulating agenda construction
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5816 and display. The global variables define the behavior for all agenda
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5817 commands, including the custom commands. However, if you want to change
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5818 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
5819 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
5820 right spot in @code{org-agenda-custom-commands}. For example:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5821
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5822 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5823 @group
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5824 (setq org-agenda-custom-commands
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5825 '(("w" todo "WAITING"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5826 ((org-agenda-sorting-strategy '(priority-down))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5827 (org-agenda-prefix-format " Mixed: ")))
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5828 ("U" tags-tree "+boss-urgent"
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5829 ((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
5830 (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
5831 ("N" search ""
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5832 ((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
5833 (org-agenda-text-search-extra-files nil)))))
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5834 @end group
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5835 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5836
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5837 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5838 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
5839 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
5840 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
5841 @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
5842 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
5843 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
5844 to only a single file.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5845
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5846 For command sets creating a block agenda,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5847 @code{org-agenda-custom-commands} has two separate spots for setting
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5848 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
5849 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
5850 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
5851 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
5852 agenda example (@pxref{Block agenda}), let's change the sorting strategy
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5853 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
5854 the results for GARDEN tags query in the opposite order,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5855 @code{priority-up}. This would look like this:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5856
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5857 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5858 @group
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5859 (setq org-agenda-custom-commands
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5860 '(("h" "Agenda and Home-related tasks"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5861 ((agenda)
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5862 (tags-todo "home")
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5863 (tags "garden"
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5864 ((org-agenda-sorting-strategy '(priority-up)))))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5865 ((org-agenda-sorting-strategy '(priority-down))))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5866 ("o" "Agenda and Office-related tasks"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5867 ((agenda)
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5868 (tags-todo "work")
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5869 (tags "office")))))
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5870 @end group
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5871 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5872
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5873 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
5874 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
5875 fully supports its structure. Just one caveat: When setting options in
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5876 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
5877 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
5878 yourself.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5879
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5880
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5881 @node Exporting Agenda Views, Extracting Agenda Information for other programs, Setting Options, Custom agenda views
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5882 @subsection Exporting Agenda Views
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5883 @cindex agenda views, exporting
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5884
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5885 If you are away from your computer, it can be very useful to have a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5886 printed version of some agenda views to carry around. Org-mode can
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5887 export custom agenda views as plain text, HTML@footnote{You need to
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5888 install Hrvoje Niksic' @file{htmlize.el}.} postscript, and iCalendar
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5889 files. If you want to do this only occasionally, use the command
84308
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-x C-w
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5893 @item C-x C-w
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5894 @cindex exporting agenda views
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5895 @cindex agenda views, exporting
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5896 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
5897 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
5898 @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
5899 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
5900 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
5901 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
5902 export, for example
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5903
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5904 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5905 (setq org-agenda-exporter-settings
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5906 '((ps-number-of-columns 2)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5907 (ps-landscape-mode t)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5908 (htmlize-output-type 'css)))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5909 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5910 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5911
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5912 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
5913 any custom agenda command with a list of output file names
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5914 @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
5915 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
5916 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
5917 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
5918 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
5919 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
5920 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
5921 or absolute.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5922
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5923 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5924 @group
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5925 (setq org-agenda-custom-commands
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5926 '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5927 ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5928 ("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
5929 ((agenda "")
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5930 (tags-todo "home")
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5931 (tags "garden"))
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5932 nil
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5933 ("~/views/home.html"))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5934 ("o" "Agenda and Office-related tasks"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5935 ((agenda)
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5936 (tags-todo "work")
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5937 (tags "office"))
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5938 nil
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
5939 ("~/views/office.ps" "~/calendars/office.ics"))))
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5940 @end group
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5941 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5942
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5943 The extension of the file name determines the type of export. If it is
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5944 @file{.html}, Org-mode will use the @file{htmlize.el} package to convert
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5945 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
5946 @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
5947 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
5948 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
5949 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
5950 extension produces a plain ASCII file.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5951
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5952 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
5953 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
5954 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
5955 files in one step:
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5956
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5957 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5958 @kindex C-c a e
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5959 @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
5960 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
5961 them.
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 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
5965 set options for the export commands. For example:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5966
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5967 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5968 (setq org-agenda-custom-commands
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5969 '(("X" agenda ""
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5970 ((ps-number-of-columns 2)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5971 (ps-landscape-mode t)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5972 (org-agenda-prefix-format " [ ] ")
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5973 (org-agenda-with-colors nil)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5974 (org-agenda-remove-tags t))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5975 ("theagenda.ps"))))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5976 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5977
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5978 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5979 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
5980 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
5981 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
5982 the agenda prefix to omit category and scheduling information, and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5983 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
5984 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
5985 black-and-white printer. Settings specified in
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5986 @code{org-agenda-exporter-settings} will also apply, but the settings
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5987 in @code{org-agenda-custom-commands} take precedence.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5988
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5989 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5990 From the command line you may also use
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5991 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5992 emacs -f org-batch-store-agenda-views -kill
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5993 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5994 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5995 or, if you need to modify some parameters
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5996 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5997 emacs -eval '(org-batch-store-agenda-views \
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5998 org-agenda-ndays 30 \
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
5999 org-agenda-start-day "2007-11-01" \
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6000 org-agenda-include-diary nil \
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6001 org-agenda-files (quote ("~/org/project.org")))' \
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6002 -kill
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6003 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6004 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6005 which will create the agenda views restricted to the file
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6006 @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
6007 extent.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6008
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6009 @node Extracting Agenda Information for other programs, , Exporting Agenda Views, Custom agenda views
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6010 @subsection Extracting Agenda Information for other programs
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6011 @cindex agenda, pipe
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6012 @cindex Scripts, for agenda processing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6013
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6014 Org-mode provides commands to access agenda information for the command
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6015 line in emacs batch mode. This extracted information can be sent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6016 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
6017 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
6018 @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
6019 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
6020 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
6021 you have configured in @code{org-agenda-custom-commands}, basically any
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6022 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
6023 current TODO list, you could use
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6024
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6025 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6026 emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6027 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6028
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6029 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
6030 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
6031 (all items with the tag @samp{shop}, but excluding the tag
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6032 @samp{NewYork}), you could use
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6033
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6034 @example
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6035 emacs -batch -l ~/.emacs \
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6036 -eval '(org-batch-agenda "+shop-NewYork")' | lpr
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6037 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6038
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6039 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6040 You may also modify parameters on the fly like this:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6041
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6042 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6043 emacs -batch -l ~/.emacs \
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6044 -eval '(org-batch-agenda "a" \
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6045 org-agenda-ndays 30 \
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6046 org-agenda-include-diary nil \
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6047 org-agenda-files (quote ("~/org/project.org")))' \
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6048 | lpr
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6049 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6050
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6051 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6052 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
6053 @file{~/org/projects.org}, not even including the diary.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6054
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6055 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
6056 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
6057 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
6058 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
6059 are:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6060
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6061 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6062 category @r{The category of the item}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6063 head @r{The headline, without TODO kwd, TAGS and PRIORITY}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6064 type @r{The type of the agenda entry, can be}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6065 todo @r{selected in TODO match}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6066 tagsmatch @r{selected in tags match}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6067 diary @r{imported from diary}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6068 deadline @r{a deadline}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6069 scheduled @r{scheduled}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6070 timestamp @r{appointment, selected by timestamp}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6071 closed @r{entry was closed on date}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6072 upcoming-deadline @r{warning about nearing deadline}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6073 past-scheduled @r{forwarded scheduled item}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6074 block @r{entry has date block including date}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6075 todo @r{The todo keyword, if any}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6076 tags @r{All tags including inherited ones, separated by colons}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6077 date @r{The relevant date, like 2007-2-14}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6078 time @r{The time, like 15:00-16:50}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6079 extra @r{String with extra planning info}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6080 priority-l @r{The priority letter if any was given}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6081 priority-n @r{The computed numerical priority}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6082 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6083
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6084 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6085 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
6086 lead to the selection of the item.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6087
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6088 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
6089 For example, here is a Perl program that gets the TODO list from
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6090 Emacs/org-mode and prints all the items, preceded by a checkbox:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6091
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6092 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6093 @group
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6094 #!/usr/bin/perl
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6095
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6096 # define the Emacs command to run
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6097 $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6098
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6099 # run it and capture the output
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6100 $agenda = qx@{$cmd 2>/dev/null@};
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6101
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6102 # loop over all lines
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6103 foreach $line (split(/\n/,$agenda)) @{
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6104
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6105 # get the individual values
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6106 ($category,$head,$type,$todo,$tags,$date,$time,$extra,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6107 $priority_l,$priority_n) = split(/,/,$line);
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6108
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6109 # proccess and print
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6110 print "[ ] $head\n";
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6111 @}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6112 @end group
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6113 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6114
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6115 @node Embedded LaTeX, Exporting, Agenda views, Top
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6116 @chapter Embedded LaTeX
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6117 @cindex @TeX{} interpretation
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6118 @cindex La@TeX{} interpretation
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6119
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6120 Plain ASCII is normally sufficient for almost all note taking. One
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6121 exception, however, are scientific notes which need to be able to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6122 contain mathematical symbols and the occasional formula.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6123 La@TeX{}@footnote{La@TeX{} is a macro system based on Donald E. Knuth's
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6124 @TeX{} system. Many of the features described here as ``La@TeX{}'' are
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6125 really from @TeX{}, but for simplicity I am blurring this distinction.}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6126 is widely used to typeset scientific documents. Org-mode supports
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6127 embedding La@TeX{} code into its files, because many academics are used
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6128 to read La@TeX{} source code, and because it can be readily processed
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6129 into images for HTML production.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6130
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6131 It is not necessary to mark La@TeX{} macros and code in any special way.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6132 If you observe a few conventions, Org-mode knows how to find it and what
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6133 to do with it.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6134
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6135 @menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6136 * Math symbols:: TeX macros for symbols and Greek letters
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6137 * Subscripts and Superscripts:: Simple syntax for raising/lowering text
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6138 * LaTeX fragments:: Complex formulas made easy
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6139 * Processing LaTeX fragments:: Previewing LaTeX processing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6140 * CDLaTeX mode:: Speed up entering of formulas
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6141 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6142
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6143 @node Math symbols, Subscripts and Superscripts, Embedded LaTeX, Embedded LaTeX
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6144 @section Math symbols
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6145 @cindex math symbols
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6146 @cindex TeX macros
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6147
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6148 You can use La@TeX{} macros to insert special symbols like @samp{\alpha}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6149 to indicate the Greek letter, or @samp{\to} to indicate an arrow.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6150 Completion for these macros is available, just type @samp{\} and maybe a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6151 few letters, and press @kbd{M-@key{TAB}} to see possible completions.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6152 Unlike La@TeX{} code, Org-mode allows these macros to be present
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6153 without surrounding math delimiters, for example:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6154
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6155 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6156 Angles are written as Greek letters \alpha, \beta and \gamma.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6157 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6158
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6159 During HTML export (@pxref{HTML export}), these symbols are translated
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6160 into the proper syntax for HTML, for the above examples this is
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6161 @samp{&alpha;} and @samp{&rarr;}, respectively.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6162
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6163 @node Subscripts and Superscripts, LaTeX fragments, Math symbols, Embedded LaTeX
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6164 @section Subscripts and Superscripts
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6165 @cindex subscript
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6166 @cindex superscript
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6167
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6168 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
6169 and subscripts. Again, these can be used without embedding them in
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6170 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
6171 not necessary (but OK) to surround multi-character sub- and superscripts
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6172 with curly braces. For example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6173
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6174 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6175 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
6176 the sun is R_@{sun@} = 6.96 x 10^8 m.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6177 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6178
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6179 To avoid interpretation as raised or lowered text, you can quote
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6180 @samp{^} and @samp{_} with a backslash: @samp{\_} and @samp{\^}.
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 During HTML export (@pxref{HTML export}), subscript and superscripts
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6183 are surrounded with @code{<sub>} and @code{<sup>} tags, respectively.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6184
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6185 @node LaTeX fragments, Processing LaTeX fragments, Subscripts and Superscripts, Embedded LaTeX
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6186 @section LaTeX fragments
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6187 @cindex LaTeX fragments
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6188
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6189 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
6190 it comes to representing mathematical formulas@footnote{Yes, there is
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6191 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
6192 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
6193 formulas into MathML. So for the time being, converting formulas into
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6194 images seems the way to go.}. More complex expressions need a dedicated
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6195 formula processor. To this end, Org-mode can contain arbitrary La@TeX{}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6196 fragments. It provides commands to preview the typeset result of these
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6197 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
6198 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
6199 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
6200 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
6201 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
6202 need the @file{dvipng} program, available at
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6203 @url{http://sourceforge.net/projects/dvipng/}. The La@TeX{} header that
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6204 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
6205 variable @code{org-format-latex-header}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6206
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6207 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
6208 snippets will be identified as La@TeX{} source code:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6209 @itemize @bullet
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6210 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6211 Environments of any kind. The only requirement is that the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6212 @code{\begin} statement appears on a new line, preceded by only
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6213 whitespace.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6214 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6215 Text within the usual La@TeX{} math delimiters. To avoid conflicts with
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6216 currency specifications, single @samp{$} characters are only recognized
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6217 as math delimiters if the enclosed text contains at most two line breaks,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6218 is directly attached to the @samp{$} characters with no whitespace in
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6219 between, and if the closing @samp{$} is followed by whitespace or
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6220 punctuation. For the other delimiters, there is no such restriction, so
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6221 when in doubt, use @samp{\(...\)} as inline math delimiters.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6222 @end itemize
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6223
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6224 @noindent For example:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6225
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6226 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6227 \begin@{equation@} % arbitrary environments,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6228 x=\sqrt@{b@} % even tables, figures
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6229 \end@{equation@} % etc
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6230
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6231 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
6232 either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \].
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6233 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6234
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6235 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6236 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
6237 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
6238 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
6239
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6240 @node Processing LaTeX fragments, CDLaTeX mode, LaTeX fragments, Embedded LaTeX
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6241 @section Processing LaTeX fragments
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6242 @cindex LaTeX fragments, preview
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6243
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6244 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
6245 typeset expressions:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6246
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6247 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6248 @kindex C-c C-x C-l
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6249 @item C-c C-x C-l
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6250 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
6251 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
6252 fragments in the current entry (between two headlines). When called
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6253 with a prefix argument, process the entire subtree. When called with
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6254 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
6255 process the entire buffer.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6256 @kindex C-c C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6257 @item C-c C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6258 Remove the overlay preview images.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6259 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6260
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6261 During HTML export (@pxref{HTML export}), all La@TeX{} fragments are
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6262 converted into images and inlined into the document if the following
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6263 setting is active:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6264
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6265 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6266 (setq org-export-with-LaTeX-fragments t)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6267 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6268
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6269 @node CDLaTeX mode, , Processing LaTeX fragments, Embedded LaTeX
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6270 @section Using CDLaTeX to enter math
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6271 @cindex CDLaTeX
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6272
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6273 CDLaTeX-mode is a minor mode that is normally used in combination with a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6274 major La@TeX{} mode like AUCTeX in order to speed-up insertion of
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6275 environments and math templates. Inside Org-mode, you can make use of
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6276 some of the features of cdlatex-mode. You need to install
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6277 @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
6278 AUCTeX) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6279 Don't turn cdlatex-mode itself under Org-mode, but use the light
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6280 version @code{org-cdlatex-mode} that comes as part of Org-mode. Turn it
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6281 on for the current buffer with @code{M-x org-cdlatex-mode}, or for all
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6282 Org-mode files with
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6283
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6284 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6285 (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6286 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6287
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6288 When this mode is enabled, the following features are present (for more
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6289 details see the documentation of cdlatex-mode):
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6290 @itemize @bullet
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6291 @kindex C-c @{
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6292 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6293 Environment templates can be inserted with @kbd{C-c @{}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6294 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6295 @kindex @key{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6296 The @key{TAB} key will do template expansion if the cursor is inside a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6297 La@TeX{} fragment@footnote{Org-mode has a method to test if the cursor is
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6298 inside such a fragment, see the documentation of the function
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6299 @code{org-inside-LaTeX-fragment-p}.}. For example, @key{TAB} will
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6300 expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6301 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
6302 the second brace. Even outside fragments, @key{TAB} will expand
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6303 environment abbreviations at the beginning of a line. For example, if
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6304 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
6305 this abbreviation will be expanded to an @code{equation} environment.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6306 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
6307 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6308 @kindex _
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6309 @kindex ^
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6310 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
6311 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
6312 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
6313 macro, they are removed again (depending on the variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6314 @code{cdlatex-simplify-sub-super-scripts}).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6315 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6316 @kindex `
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6317 Pressing the backquote @kbd{`} followed by a character inserts math
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6318 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
6319 after the backquote, a help window will pop up.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6320 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6321 @kindex '
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6322 Pressing the normal quote @kbd{'} followed by another character modifies
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6323 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
6324 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
6325 modification will work only inside La@TeX{} fragments, outside the quote
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6326 is normal.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6327 @end itemize
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6328
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6329 @node Exporting, Publishing, Embedded LaTeX, Top
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6330 @chapter Exporting
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6331 @cindex exporting
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6332
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6333 Org-mode documents can be exported into a variety of other formats. For
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6334 printing and sharing of notes, ASCII export produces a readable and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6335 simple version of an Org-mode file. HTML export allows you to publish a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6336 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
6337 exchange with a broad range of other applications. La@TeX{} export lets
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6338 you use Org-mode and its structured editing functions to easily create
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6339 La@TeX{} files. To incorporate entries with associated times like
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6340 deadlines or appointments into a desktop calendar program like iCal,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6341 Org-mode can also produce extracts in the iCalendar format. Currently
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6342 Org-mode only supports export, not import of these different formats.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6343
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6344 When exporting, Org-mode uses special conventions to enrich the output
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6345 produced. @xref{Text interpretation}, for more details.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6346
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6347 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6348 @kindex C-c C-e
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6349 @item C-c C-e
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6350 Dispatcher for export and publishing commands. Displays a help-window
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6351 listing the additional key(s) needed to launch an export or publishing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6352 command.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6353 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6354
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6355 @menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6356 * ASCII export:: Exporting to plain ASCII
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6357 * HTML export:: Exporting to HTML
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6358 * LaTeX export:: Exporting to LaTeX
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6359 * XOXO export:: Exporting to XOXO
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6360 * iCalendar export:: Exporting in iCalendar format
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6361 * Text interpretation:: How the exporter looks at the file
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6362 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6363
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6364 @node ASCII export, HTML export, Exporting, Exporting
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6365 @section ASCII export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6366 @cindex ASCII export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6367
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6368 ASCII export produces a simple and very readable version of an Org-mode
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6369 file.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6370
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6371 @cindex region, active
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6372 @cindex active region
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6373 @cindex transient-mark-mode
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6374 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6375 @kindex C-c C-e a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6376 @item C-c C-e a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6377 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
6378 will be @file{myfile.txt}. The file will be overwritten without
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6379 warning. If there is an active region, only the region will be
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6380 exported. If the selected region is a single tree, the tree head will
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6381 become the document title. If the tree head entry has or inherits an
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6382 @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
6383 export.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6384 @kindex C-c C-e v a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6385 @item C-c C-e v a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6386 Export only the visible part of the document.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6387 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6388
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6389 @cindex headline levels, for exporting
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6390 In the exported version, the first 3 outline levels will become
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6391 headlines, defining a general document structure. Additional levels
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6392 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
6393 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
6394
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6395 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6396 @kbd{C-1 C-c C-e a}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6397 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6398
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6399 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6400 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
6401 headlines are converted to items, the indentation of the text following
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6402 the headline is changed to fit nicely under the item. This is done with
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6403 the assumption that the first bodyline indicates the base indentation of
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6404 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
6405 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
6406 indentation than the first, these are left alone.
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 @node HTML export, LaTeX export, ASCII export, Exporting
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6409 @section HTML export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6410 @cindex HTML export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6411
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6412 Org-mode contains an HTML (XHTML 1.0 strict) exporter with extensive
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6413 HTML formatting, in ways similar to John Grubers @emph{markdown}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6414 language, but with additional support for tables.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6415
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6416 @menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6417 * HTML Export commands:: How to invoke LaTeX export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6418 * Quoting HTML tags:: Using direct HTML in Org-mode
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6419 * Links:: Transformation of links for HTML
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6420 * Images:: How to include images
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6421 * CSS support:: Changing the appearence of the output
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6422 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6423
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6424 @node HTML Export commands, Quoting HTML tags, HTML export, HTML export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6425 @subsection HTML export commands
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6426
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6427 @cindex region, active
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6428 @cindex active region
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6429 @cindex transient-mark-mode
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6430 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6431 @kindex C-c C-e h
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6432 @item C-c C-e h
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6433 Export as HTML file @file{myfile.html}. For an org file
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6434 @file{myfile.org}, the ASCII file will be @file{myfile.html}. The file
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6435 will be overwritten without warning. If there is an active region, only
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6436 the region will be exported. If the selected region is a single tree,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6437 the tree head will become the document title. If the tree head entry
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6438 has or inherits an @code{:EXPORT_FILE_NAME:} property, that name will be
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6439 used for the export.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6440 @kindex C-c C-e b
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6441 @item C-c C-e b
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6442 Export as HTML file and immediately open it with a browser.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6443 @kindex C-c C-e H
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6444 @item C-c C-e H
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6445 Export to a temporary buffer, do not create a file.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6446 @kindex C-c C-e R
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6447 @item C-c C-e R
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6448 Export the active region to a temporary buffer. With prefix arg, do not
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6449 produce file header and foot, but just the plain HTML section for the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6450 region. This is good for cut-and-paste operations.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6451 @kindex C-c C-e v h
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6452 @kindex C-c C-e v b
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6453 @kindex C-c C-e v H
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6454 @kindex C-c C-e v R
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6455 @item C-c C-e v h
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6456 @item C-c C-e v b
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6457 @item C-c C-e v H
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6458 @item C-c C-e v R
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6459 Export only the visible part of the document.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6460 @item M-x org-export-region-as-html
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6461 Convert the region to HTML under the assumption that it was org-mode
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6462 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
6463 buffer.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6464 @item M-x org-replace-region-by-HTML
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6465 Replace the active region (assumed to be in Org-mode syntax) by HTML
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6466 code.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6467 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6468
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6469 @cindex headline levels, for exporting
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6470 In the exported version, the first 3 outline levels will become
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6471 headlines, defining a general document structure. Additional levels
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6472 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
6473 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
6474
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6475 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6476 @kbd{C-2 C-c C-e b}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6477 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6478
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6479 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6480 creates two levels of headings and does the rest as items.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6481
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6482 @node Quoting HTML tags, Links, HTML Export commands, HTML export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6483 @subsection Quoting HTML tags
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6484
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6485 Plain @samp{<} and @samp{>} are always transformed to @samp{&lt;} and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6486 @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
6487 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
6488 @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
6489 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
6490 the exported file use either
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6491
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6492 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6493 #+HTML: Literal HTML code for export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6494 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6495
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6496 @noindent or
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6497
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6498 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6499 #+BEGIN_HTML
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6500 All lines between these markers are exported literally
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6501 #+END_HTML
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6502 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6503
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6504
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6505 @node Links, Images, Quoting HTML tags, HTML export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6506 @subsection Links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6507
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6508 @cindex links, in HTML export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6509 @cindex internal links, in HTML export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6510 @cindex external links, in HTML export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6511 Internal links (@pxref{Internal links}) will continue to work in HTML
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6512 files only if they match a dedicated @samp{<<target>>}. Automatic links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6513 created by radio targets (@pxref{Radio targets}) will also work in the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6514 HTML file. Links to external files will still work if the HTML file is
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6515 in the same directory as the Org-mode file. Links to other @file{.org}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6516 files will be translated into HTML links under the assumption that an
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6517 HTML version also exists of the linked file. For information related to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6518 linking files while publishing them to a publishing directory see
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6519 @ref{Publishing links}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6520
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6521 @node Images, CSS support, Links, HTML export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6522 @subsection Images
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6523
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6524 @cindex images, inline in HTML
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6525 @cindex inlining images in HTML
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6526 HTML export can inline images given as links in the Org-mode file, and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6527 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
6528 default@footnote{but see the variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6529 @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
6530 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
6531 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
6532 @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
6533 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
6534 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
6535 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
6536 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
6537
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6538 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6539 [[file:highres.jpg][file:thumb.jpg]]
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6540 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6541
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6542 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6543 and you could use @code{http} addresses just as well.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6544
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6545 @node CSS support, , Images, HTML export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6546 @subsection CSS support
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6547
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6548 You can also give style information for the exported file. The HTML
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6549 exporter assigns the following CSS classes to appropriate parts of the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6550 document - your style specifications may change these:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6551 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6552 .todo @r{TODO keywords}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6553 .done @r{the DONE keyword}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6554 .timestamp @r{time stamp}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6555 .timestamp-kwd @r{keyword associated with a time stamp, like SCHEDULED}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6556 .tag @r{tag in a headline}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6557 .target @r{target for links}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6558 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6559
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6560 The default style specification can be configured through the option
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6561 @code{org-export-html-style}. If you want to use a file-local style,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6562 you may use file variables, best wrapped into a COMMENT section at the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6563 end of the outline tree. For example@footnote{Under Emacs 21, the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6564 continuation lines for a variable value should have no @samp{#} at the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6565 start of the line.}:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6566
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6567 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6568 * COMMENT html style specifications
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6569
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6570 # Local Variables:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6571 # org-export-html-style: " <style type=\"text/css\">
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6572 # p @{font-weight: normal; color: gray; @}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6573 # h1 @{color: black; @}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6574 # </style>"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6575 # End:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6576 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6577
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6578 Remember to execute @kbd{M-x normal-mode} after changing this to make
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6579 the new style visible to Emacs. This command restarts org-mode for the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6580 current buffer and forces Emacs to re-evaluate the local variables
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6581 section in the buffer.
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 @c FIXME: More about header and footer styles
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6584 @c FIXME: Talk about links and targets.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6585
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6586 @node LaTeX export, XOXO export, HTML export, Exporting
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6587 @section LaTeX export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6588 @cindex LaTeX export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6589
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6590 Org-mode contains a La@TeX{} exporter written by Bastien Guerry.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6591
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6592 @menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6593 * LaTeX export commands:: How to invoke LaTeX export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6594 * Quoting LaTeX code:: Incorporating literal LaTeX code
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6595 * Sectioning structure::
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6596 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6597
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6598 @node LaTeX export commands, Quoting LaTeX code, LaTeX export, LaTeX export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6599 @subsection LaTeX export commands
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6600
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6601 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6602 @kindex C-c C-e l
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6603 @item C-c C-e l
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6604 Export as La@TeX{} file @file{myfile.tex}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6605 @kindex C-c C-e L
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6606 @item C-c C-e L
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6607 Export to a temporary buffer, do not create a file.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6608 @kindex C-c C-e v l
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6609 @kindex C-c C-e v L
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6610 @item C-c C-e v l
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6611 @item C-c C-e v L
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6612 Export only the visible part of the document.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6613 @item M-x org-export-region-as-latex
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6614 Convert the region to La@TeX{} under the assumption that it was org-mode
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6615 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
6616 buffer.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6617 @item M-x org-replace-region-by-latex
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6618 Replace the active region (assumed to be in Org-mode syntax) by La@TeX{}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6619 code.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6620 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6621
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6622 @cindex headline levels, for exporting
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6623 In the exported version, the first 3 outline levels will become
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6624 headlines, defining a general document structure. Additional levels
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6625 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
6626 convert them to a custom string depending on
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6627 @code{org-latex-low-levels}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6628
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6629 If you want that transition to occur at a different level, specify it
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6630 with a prefix argument. For example,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6631
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6632 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6633 @kbd{C-2 C-c C-e l}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6634 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6635
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6636 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6637 creates two levels of headings and does the rest as items.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6638
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6639 @node Quoting LaTeX code, Sectioning structure, LaTeX export commands, LaTeX export
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6640 @subsection Quoting LaTeX code
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6641
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6642 Embedded La@TeX{} as described in @ref{Embedded LaTeX} will be correctly
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6643 inserted into the La@TeX{} file. Forthermore, you can add special code
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6644 that should only be present in La@TeX{} export with the following
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6645 constructs:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6646
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6647 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6648 #+LaTeX: Literal LaTeX code for export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6649 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6650
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6651 @noindent or
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6652
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6653 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6654 #+BEGIN_LaTeX
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6655 All lines between these markers are exported literally
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6656 #+END_LaTeX
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6657 @end example
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6658
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6659
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6660
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6661 @node Sectioning structure, , Quoting LaTeX code, LaTeX export
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6662 @subsection Sectioning structure
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6663 @cindex LaTeX class
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6664 @cindex LaTeX sectioning structure
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6665
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6666 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
6667
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6668 You can change this globally by setting a different value for
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6669 @code{org-export-latex-default-class} or locally by adding an option
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6670 like @code{#+LaTeX_CLASS: myclass} in your file. The class should be
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6671 listed in @code{org-export-latex-classes}, where you can also define the
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6672 sectioning structure for each class.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6673
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6674
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6675 @node XOXO export, iCalendar export, LaTeX export, Exporting
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6676 @section XOXO export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6677 @cindex XOXO export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6678
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6679 Org-mode contains an exporter that produces XOXO-style output.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6680 Currently, this exporter only handles the general outline structure and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6681 does not interpret any additional Org-mode features.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6682
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6683 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6684 @kindex C-c C-e x
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6685 @item C-c C-e x
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6686 Export as XOXO file @file{myfile.html}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6687 @kindex C-c C-e v
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6688 @item C-c C-e v x
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6689 Export only the visible part of the document.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6690 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6691
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6692 @node iCalendar export, Text interpretation, XOXO export, Exporting
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6693 @section iCalendar export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6694 @cindex iCalendar export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6695
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6696 Some people like to use Org-mode for keeping track of projects, but
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6697 still prefer a standard calendar application for anniversaries and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6698 appointments. In this case it can be useful to have deadlines and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6699 other time-stamped items in Org-mode files show up in the calendar
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6700 application. Org-mode can export calendar information in the standard
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6701 iCalendar format. If you also want to have TODO entries included in the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6702 export, configure the variable @code{org-icalendar-include-todo}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6703
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6704 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6705 @kindex C-c C-e i
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6706 @item C-c C-e i
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6707 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
6708 directory, using a file extension @file{.ics}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6709 @kindex C-c C-e I
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6710 @item C-c C-e I
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6711 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
6712 @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
6713 file will be written.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6714 @kindex C-c C-e c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6715 @item C-c C-e c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6716 Create a single large iCalendar file from all files in
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6717 @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
6718 @code{org-combined-agenda-icalendar-file}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6719 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6720
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6721 The export will honor SUMMARY, DESCRIPTION and LOCATION properties if
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6722 the selected entries have them. If not, the summary will be derived
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6723 from the headline, 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
6724 @code{org-icalendar-include-body} characters).
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6725
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6726 How this calendar is best read and updated, depends on the application
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6727 you are using. The FAQ covers this issue.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6728
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6729
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6730 @node Text interpretation, , iCalendar export, Exporting
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6731 @section Text interpretation by the exporter
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6732
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6733 The exporter backends interpret additional structure in the Org-mode file
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6734 in order to produce better output.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6735
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6736 @menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6737 * Comment lines:: Some lines will not be exported
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6738 * Initial text:: Text before the first headline
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6739 * Footnotes:: Numbers like [1]
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6740 * Quoted examples:: Inserting quoted chnuks of text
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6741 * Enhancing text:: Subscripts, symbols and more
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6742 * Export options:: How to influence the export settings
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6743 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6744
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6745 @node Comment lines, Initial text, Text interpretation, Text interpretation
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6746 @subsection Comment lines
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6747 @cindex comment lines
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6748 @cindex exporting, not
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6749
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6750 Lines starting with @samp{#} in column zero are treated as comments
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6751 and will never be exported. Also entire subtrees starting with the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6752 word @samp{COMMENT} will never be exported.
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 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6755 @kindex C-c ;
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6756 @item C-c ;
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6757 Toggle the COMMENT keyword at the beginning of an entry.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6758 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6759
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6760 @node Initial text, Footnotes, Comment lines, Text interpretation
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6761 @subsection Text before the first headline
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 Org-mode normally ignores any text before the first headline when
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6764 exporting, leaving this region for internal links to speed up navigation
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6765 etc. However, in publishing-oriented files, you might want to have some
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6766 text before the first headline, like a small introduction, special HTML
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6767 code with a navigation bar, etc. You can ask to have this part of the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6768 file exported as well by setting the variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6769 @code{org-export-skip-text-before-1st-heading} to @code{nil}. On a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6770 per-file basis, you can get the same effect with
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6771
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6772 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6773 #+OPTIONS: skip:nil
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6774 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6775
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6776 The text before the first headline will be fully processed
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6777 (@pxref{Enhancing text}), and the first non-comment line becomes the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6778 title of the exported document. If you need to include literal HTML,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6779 use the special constructs described in @ref{Quoting HTML tags}. The
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6780 table of contents is normally inserted directly before the first
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6781 headline of the file. If you would like to get it to a different
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6782 location, insert the string @code{[TABLE-OF-CONTENTS]} on a line by
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6783 itself at the desired location.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6784
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6785 Finally, if you want to use the space before the first headline for
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6786 internal purposes, but @emph{still} want to place something before the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6787 first headline when exporting the file, you can use the @code{#+TEXT}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6788 construct:
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 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6791 #+OPTIONS: skip:t
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6792 #+TEXT: This text will go before the *first* headline.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6793 #+TEXT: We place the table of contents here:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6794 #+TEXT: [TABLE-OF-CONTENTS]
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6795 #+TEXT: This goes between the table of contents and the first headline
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6796 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6797
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6798 @node Footnotes, Quoted examples, Initial text, Text interpretation
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6799 @subsection Footnotes
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6800 @cindex footnotes
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6801 @cindex @file{footnote.el}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6802
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6803 Numbers in square brackets are treated as footnotes, so that you can use
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6804 the Emacs package @file{footnote.el} to create footnotes. For example:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6805
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6806 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6807 The org-mode homepage[1] clearly needs help from
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6808 a good web designer.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6809
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6810 [1] The link is: http://orgmode.org
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6811 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6812
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6813 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6814 @kindex C-c !
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6815 Note that the @file{footnote} package uses @kbd{C-c !} to invoke its
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6816 commands. This binding conflicts with the org-mode command for
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6817 inserting inactive time stamps. You could use the variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6818 @code{footnote-prefix} to switch footnotes commands to another key. Or,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6819 if you are too used to this binding, you could use
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6820 @code{org-replace-disputed-keys} and @code{org-disputed-keys} to change
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6821 the settings in Org-mode.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6822
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6823 @node Quoted examples, Enhancing text, Footnotes, Text interpretation
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6824 @subsection Quoted examples
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6825 @cindex quoted examples
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6826 @cindex examples, quoted
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6827 @cindex text, fixed width
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6828 @cindex fixed width text
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6829
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6830 When writing technical documents, you often need to insert examples that
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6831 are not further interpreted by Org-mode. For historical reasons, there
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6832 are several ways to do this:
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6833
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6834 @itemize @bullet
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6835 @item
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6836 If a headline starts with the word @samp{QUOTE}, the text below the
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6837 headline will be typeset as fixed-width, to allow quoting of computer
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6838 codes etc.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6839 @item
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6840 Lines starting with @samp{:} are also typeset in fixed-width font.
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6841 @table @kbd
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6842 @kindex C-c :
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6843 @item C-c :
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6844 Toggle fixed-width for entry (QUOTE) or region, see below.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6845 @end table
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6846 @item
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6847 Finally, text between
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6848 @example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6849 #+BEGIN_EXAMPLE
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6850 quoted text
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6851 #+END_EXAMPLE
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6852 @end example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6853 will also be exported in this way.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6854 @end itemize
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6855
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6856
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6857 @node Enhancing text, Export options, Quoted examples, Text interpretation
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6858 @subsection Enhancing text for export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6859 @cindex enhancing text
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6860 @cindex richer text
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6861
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6862 Some of the export backends of Org-mode allow for sophisticated text
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6863 formatting, this is true in particular for the HTML and La@TeX{}
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6864 backends. Org-mode has a number of typing conventions that allow to
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6865 produce a richly formatted output.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6866
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6867 @itemize @bullet
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 @cindex hand-formatted lists
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6870 @cindex lists, hand-formatted
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6871 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6872 Plain lists @samp{-}, @samp{*} or @samp{+} as bullet, or with @samp{1.}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6873 or @samp{2)} as enumerator will be recognized and transformed if the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6874 backend supports lists. See @xref{Plain lists}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6875
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6876 @cindex underlined text
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6877 @cindex bold text
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6878 @cindex italic text
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6879 @cindex verbatim text
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6880 @item
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6881 You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=code=}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6882 and @code{~verbatim~}, and, if you must, @samp{+strikethrough+}. Text
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6883 in the code and verbatim string is not processed for org-mode specific
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6884 syntax, it is exported verbatim.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6885
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6886 @cindex horizontal rules, in exported files
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6887 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6888 A line consisting of only dashes, and at least 5 of them, will be
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6889 exported as a horizontal line (@samp{<hr/>} in HTML).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6890
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6891 @cindex LaTeX fragments, export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6892 @cindex TeX macros, export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6893 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6894 Many @TeX{} macros and entire La@TeX{} fragments are converted into HTML
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6895 entities or images (@pxref{Embedded LaTeX}).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6896
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6897 @cindex tables, export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6898 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6899 Tables are transformed into native tables under the exporter, if the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6900 export backend supports this. Data fields before the first horizontal
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6901 separator line will be formatted as table header fields.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6902
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6903 @cindex fixed width
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6904 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6905 If a headline starts with the word @samp{QUOTE}, the text below the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6906 headline will be typeset as fixed-width, to allow quoting of computer
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6907 codes etc. Lines starting with @samp{:} are also typeset in fixed-width
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6908 font.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6909 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6910 @kindex C-c :
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6911 @item C-c :
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6912 Toggle fixed-width for entry (QUOTE) or region, see below.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6913 @end table
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6914 Finally, text between
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6915 @example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6916 #+BEGIN_EXAMPLE
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6917 quoted text
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6918 #+END_EXAMPLE
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6919 @end example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6920 will also be exported in this way.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6921
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6922 @cindex linebreak, forced
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
6923 @item
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6924 A double backslash @emph{at the end of a line} enforces a line break at
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6925 this position.
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6926
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6927 @cindex HTML entities, LaTeX entities
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6928 @item
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6929 Strings like @code{\alpha} will be exported as @code{&alpha;}, in the
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6930 HTML output. These strings are exported as @code{$\alpha$} in the
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6931 La@TeX{} output. Similarly, @code{\nbsp} will become @code{&nbsp;} in
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6932 HTML and in La@TeX{}. This applies for a long list of entities, see
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6933 the variable @code{org-html-entities} for the complete list.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6934 @c FIXME
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6935 @end itemize
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6936
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6937 If these conversions conflict with your habits of typing ASCII text,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6938 they can all be turned off with corresponding variables. See the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6939 customization group @code{org-export-general}, and the following section
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6940 which explains how to set export options with special lines in a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6941 buffer.
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
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6944 @node Export options, , Enhancing text, Text interpretation
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6945 @subsection Export options
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6946 @cindex options, for export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6947
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6948 @cindex completion, of option keywords
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6949 The exporter recognizes special lines in the buffer which provide
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6950 additional information. These lines may be put anywhere in the file.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6951 The whole set of lines can be inserted into the buffer with @kbd{C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6952 C-e t}. For individual lines, a good way to make sure the keyword is
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6953 correct is to type @samp{#+} and then use @kbd{M-@key{TAB}} completion
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6954 (@pxref{Completion}).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6955
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6956 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6957 @kindex C-c C-e t
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6958 @item C-c C-e t
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6959 Insert template with export options, see example below.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6960 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6961
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6962 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6963 #+TITLE: the title to be shown (default is the buffer name)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6964 #+AUTHOR: the author (default taken from @code{user-full-name})
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6965 #+DATE: A date, fixed, of a format string for @code{format-time-string}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6966 #+EMAIL: his/her email address (default from @code{user-mail-address})
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6967 #+LANGUAGE: language for HTML, e.g. @samp{en} (@code{org-export-default-language})
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6968 #+TEXT: Some descriptive text to be inserted at the beginning.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6969 #+TEXT: Several lines may be given.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6970 #+OPTIONS: H:2 num:t toc:t \n:nil @@:t ::t |:t ^:t f:t TeX:t ...
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6971 @end example
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 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6974 The OPTIONS line is a compact form to specify export settings. Here
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6975 you can:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6976 @cindex headline levels
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6977 @cindex section-numbers
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6978 @cindex table of contents
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6979 @cindex linebreak preservation
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6980 @cindex quoted HTML tags
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6981 @cindex fixed-width sections
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6982 @cindex tables
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6983 @cindex @TeX{}-like syntax for sub- and superscripts
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6984 @cindex footnotes
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
6985 @cindex special strings
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6986 @cindex emphasized text
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6987 @cindex @TeX{} macros
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6988 @cindex La@TeX{} fragments
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6989 @cindex author info, in export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6990 @cindex time info, in export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6991 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6992 H: @r{set the number of headline levels for export}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6993 num: @r{turn on/off section-numbers}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6994 toc: @r{turn on/off table of contents, or set level limit (integer)}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6995 \n: @r{turn on/off linebreak-preservation}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6996 @@: @r{turn on/off quoted HTML tags}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6997 :: @r{turn on/off fixed-width sections}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6998 |: @r{turn on/off tables}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6999 ^: @r{turn on/off @TeX{}-like syntax for sub- and superscripts. If}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7000 @r{you write "^:@{@}", @code{a_@{b@}} will be interpreted, but}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7001 @r{the simple @code{a_b} will be left as it is.}
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
7002 -: @r{turn on/off conversion of special strings.}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7003 f: @r{turn on/off foototes like this[1].}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7004 *: @r{turn on/off emphasized text (bold, italic, underlined)}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7005 TeX: @r{turn on/off simple @TeX{} macros in plain text}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7006 LaTeX: @r{turn on/off La@TeX{} fragments}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7007 skip: @r{turn on/off skipping the text before the first heading}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7008 author: @r{turn on/off inclusion of author name/email into exported file}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7009 timestamp: @r{turn on/off inclusion creation time into exported file}
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
7010 d: @r{turn on/off inclusion of drawers}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7011 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7012
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7013 These options take effect in both the HTML and La@TeX{} export, except
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7014 for @code{TeX} and @code{LaTeX}, which are respectively @code{t} and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7015 @code{nil} for the La@TeX{} export.
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 @node Publishing, Miscellaneous, Exporting, Top
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7018 @chapter Publishing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7019 @cindex publishing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7020
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7021 Org-mode includes@footnote{@file{org-publish.el} is not distributed with
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7022 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
7023 this file separately.} a publishing management system that allows you to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7024 configure automatic HTML conversion of @emph{projects} composed of
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7025 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
7026 also configure org-publish to automatically upload your exported HTML
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7027 pages and related attachments, such as images and source code files, to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7028 a web server. Org-publish turns org-mode into a web-site authoring tool.
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 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
7031 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
7032 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
7033 that helpful, you surely want to perform further conversion on them --
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7034 e.g. convert them to @code{PDF} format.}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7035
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7036 Org-publish has been contributed to Org-mode by David O'Toole.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7037
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7038 @menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7039 * Configuration:: Defining projects
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7040 * Sample configuration:: Example projects
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7041 * Triggering publication:: Publication commands
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7042 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7043
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7044 @node Configuration, Sample configuration, Publishing, Publishing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7045 @section Configuration
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7046
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7047 Publishing needs significant configuration to specify files, destination
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7048 and many other properties of a project.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7049
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7050 @menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7051 * Project alist:: The central configuration variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7052 * Sources and destinations:: From here to there
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7053 * Selecting files:: What files are part of the project?
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7054 * Publishing action:: Setting the function doing the publishing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7055 * Publishing options:: Tweaking HTML export
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7056 * Publishing links:: Which links keep working after publishing?
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7057 * Project page index:: Publishing a list of project files
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7058 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7059
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7060 @node Project alist, Sources and destinations, Configuration, Configuration
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7061 @subsection The variable @code{org-publish-project-alist}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7062 @cindex org-publish-project-alist
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7063 @cindex projects, for publishing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7064
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7065 Org-publish is configured almost entirely through setting the value of
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7066 one variable, called @code{org-publish-project-alist}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7067 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
7068 the two following forms:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7069
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7070 @lisp
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
7071 ("project-name" :property value :property value ...)
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7072
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
7073 @r{or}
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
7074
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
7075 ("project-name" :components ("project-name" "project-name" ...))
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7076
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7077 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7078
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7079 In both cases, projects are configured by specifying property values.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7080 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
7081 the publishing configuration to use when publishing those files. When
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7082 a project takes the second form listed above, the individual members
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7083 of the ``components'' property are taken to be components of the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7084 project, which group together files requiring different publishing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7085 options. When you publish such a ``meta-project'' all the components
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7086 will also publish.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7087
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7088 @node Sources and destinations, Selecting files, Project alist, Configuration
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7089 @subsection Sources and destinations for files
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7090 @cindex directories, for publishing
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 Most properties are optional, but some should always be set. In
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7093 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
7094 and where to put published files.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7095
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7096 @multitable @columnfractions 0.3 0.7
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7097 @item @code{:base-directory}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7098 @tab Directory containing publishing source files
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7099 @item @code{:publishing-directory}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7100 @tab Directory (possibly remote) where output files will be published.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7101 @item @code{:preparation-function}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7102 @tab Function called before starting publishing process, for example to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7103 run @code{make} for updating files to be published.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7104 @end multitable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7105 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7106
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7107 @node Selecting files, Publishing action, Sources and destinations, Configuration
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7108 @subsection Selecting files
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7109 @cindex files, selecting for publishing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7110
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7111 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
7112 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
7113 properties
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7114 @multitable @columnfractions 0.25 0.75
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7115 @item @code{:base-extension}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7116 @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
7117 regular expression.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7118
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
7119 @item @code{:exclude}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7120 @tab Regular expression to match file names that should not be
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7121 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
7122 extension.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7123
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7124 @item @code{:include}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7125 @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
7126 and @code{:exclude}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7127 @end multitable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7128
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7129 @node Publishing action, Publishing options, Selecting files, Configuration
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7130 @subsection Publishing Action
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7131 @cindex action, for publishing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7132
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7133 Publishing means that a file is copied to the destination directory and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7134 possibly transformed in the process. The default transformation is to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7135 export Org-mode files as HTML files, and this is done by the function
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7136 @code{org-publish-org-to-html} which calls the HTML exporter
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7137 (@pxref{HTML export}). But you also can publish your files in La@TeX{} by
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7138 using the function @code{org-publish-org-to-latex} instead. Other files
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7139 like images only need to be copied to the publishing destination. For
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7140 non-Org-mode files, you need to specify the publishing function.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7141
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7142
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7143 @multitable @columnfractions 0.3 0.7
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7144 @item @code{:publishing-function}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7145 @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
7146 list of functions, which will all be called in turn.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7147 @end multitable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7148
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7149 The function must accept two arguments: a property list containing at
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7150 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
7151 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
7152 transformation (if any) and place the result into the destination folder.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7153 You can write your own publishing function, but @code{org-publish}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7154 provides one for attachments (files that only need to be copied):
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7155 @code{org-publish-attachment}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7156
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7157 @node Publishing options, Publishing links, Publishing action, Configuration
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7158 @subsection Options for the HTML/LaTeX exporters
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7159 @cindex options, for publishing
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 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
7162 and La@TeX{} exporters. In most cases, these properties correspond to user
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7163 variables in Org-mode. The table below lists these properties along
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7164 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
7165 respective variable for details.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7166
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7167 @multitable @columnfractions 0.3 0.7
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7168 @item @code{:language} @tab @code{org-export-default-language}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7169 @item @code{:headline-levels} @tab @code{org-export-headline-levels}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7170 @item @code{:section-numbers} @tab @code{org-export-with-section-numbers}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7171 @item @code{:table-of-contents} @tab @code{org-export-with-toc}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7172 @item @code{:archived-trees} @tab @code{org-export-with-archived-trees}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7173 @item @code{:emphasize} @tab @code{org-export-with-emphasize}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7174 @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
7175 @item @code{:special-strings} @tab @code{org-export-with-special-strings}
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7176 @item @code{:TeX-macros} @tab @code{org-export-with-TeX-macros}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7177 @item @code{:LaTeX-fragments} @tab @code{org-export-with-LaTeX-fragments}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7178 @item @code{:fixed-width} @tab @code{org-export-with-fixed-width}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7179 @item @code{:timestamps} .@tab @code{org-export-with-timestamps}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7180 @item @code{:tags} .@tab @code{org-export-with-tags}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7181 @item @code{:tables} @tab @code{org-export-with-tables}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7182 @item @code{:table-auto-headline} @tab @code{org-export-highlight-first-table-line}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7183 @item @code{:style} @tab @code{org-export-html-style}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7184 @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
7185 @item @code{:inline-images} @tab @code{org-export-html-inline-images}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7186 @item @code{:expand-quoted-html} @tab @code{org-export-html-expand}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7187 @item @code{:timestamp} @tab @code{org-export-html-with-timestamp}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7188 @item @code{:publishing-directory} @tab @code{org-export-publishing-directory}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7189 @item @code{:preamble} @tab @code{org-export-html-preamble}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7190 @item @code{:postamble} @tab @code{org-export-html-postamble}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7191 @item @code{:auto-preamble} @tab @code{org-export-html-auto-preamble}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7192 @item @code{:auto-postamble} @tab @code{org-export-html-auto-postamble}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7193 @item @code{:author} @tab @code{user-full-name}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7194 @item @code{:email} @tab @code{user-mail-address}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7195 @end multitable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7196
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
7197 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
7198
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7199 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
7200 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
7201 @code{:LaTeX-fragments}, respectively @code{nil} and @code{t} in the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7202 La@TeX{} export.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7203
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
7204 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
7205 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
7206 any) during publishing. Options set within a file (@pxref{Export
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7207 options}), however, override everything.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7208
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7209 @node Publishing links, Project page index, Publishing options, Configuration
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7210 @subsection Links between published files
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7211 @cindex links, publishing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7212
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7213 To create a link from one Org-mode file to another, you would use
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7214 something like @samp{[[file:foo.org][The foo]]} or simply
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7215 @samp{file:foo.org.} (@pxref{Hyperlinks}). Upon publishing this link
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7216 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
7217 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
7218 you publish them to HTML.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7219
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7220 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
7221 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
7222 @code{org-publish} to upload the related files, these links will work
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7223 too. @ref{Complex example} for an example of this usage.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7224
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7225 Sometime an Org-mode file to be published may contain links that are
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7226 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
7227 location. In this case, use the property
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7228
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7229 @multitable @columnfractions 0.4 0.6
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7230 @item @code{:link-validation-function}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7231 @tab Function to validate links
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7232 @end multitable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7233
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7234 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7235 to define a function for checking link validity. This function must
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7236 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
7237 the file name is interpreted in the production environment. If this
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7238 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
7239 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
7240 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
7241 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
7242
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7243 @node Project page index, , Publishing links, Configuration
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7244 @subsection Project page index
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7245 @cindex index, of published pages
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7246
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7247 The following properties may be used to control publishing of an
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7248 index of files or summary page for a given project.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7249
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7250 @multitable @columnfractions 0.25 0.75
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7251 @item @code{:auto-index}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7252 @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
7253 org-publish-all.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7254
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7255 @item @code{:index-filename}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7256 @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
7257 becomes @file{index.html}).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7258
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7259 @item @code{:index-title}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7260 @tab Title of index page. Defaults to name of file.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7261
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7262 @item @code{:index-function}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7263 @tab Plugin function to use for generation of index.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7264 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
7265 of links to all files in the project.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7266 @end multitable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7267
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7268 @node Sample configuration, Triggering publication, Configuration, Publishing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7269 @section Sample configuration
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7270
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7271 Below we provide two example configurations. The first one is a simple
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7272 project publishing only a set of Org-mode files. The second example is
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7273 more complex, with a multi-component project.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7274
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7275 @menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7276 * Simple example:: One-component publishing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7277 * Complex example:: A multi-component publishing example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7278 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7279
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7280 @node Simple example, Complex example, Sample configuration, Sample configuration
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7281 @subsection Example: simple publishing configuration
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7282
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7283 This example publishes a set of Org-mode files to the @file{public_html}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7284 directory on the local machine.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7285
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7286 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7287 (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
7288 '(("org"
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7289 :base-directory "~/org/"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7290 :publishing-directory "~/public_html"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7291 :section-numbers nil
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7292 :table-of-contents nil
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
7293 :style "<link rel=stylesheet
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7294 href=\"../other/mystyle.css\"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7295 type=\"text/css\">")))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7296 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7297
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7298 @node Complex example, , Simple example, Sample configuration
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7299 @subsection Example: complex publishing configuration
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 This more complicated example publishes an entire website, including
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7302 org files converted to HTML, image files, emacs lisp source code, and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7303 stylesheets. The publishing-directory is remote and private files are
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7304 excluded.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7305
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7306 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
7307 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
7308 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
7309 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
7310 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7311 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7312 file:../images/myimage.png
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7313 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7314 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7315 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
7316 same. You can accomplish this by setting up an "images" folder in the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7317 right place on the webserver, and publishing images to it.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7318
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7319 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7320 (setq org-publish-project-alist
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7321 '(("orgfiles"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7322 :base-directory "~/org/"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7323 :base-extension "org"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7324 :publishing-directory "/ssh:user@@host:~/html/notebook/"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7325 :publishing-function org-publish-org-to-html
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7326 :exclude "PrivatePage.org" ;; regexp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7327 :headline-levels 3
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7328 :section-numbers nil
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7329 :table-of-contents nil
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
7330 :style "<link rel=stylesheet
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7331 href=\"../other/mystyle.css\" type=\"text/css\">"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7332 :auto-preamble t
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7333 :auto-postamble nil)
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
7334
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7335 ("images"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7336 :base-directory "~/images/"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7337 :base-extension "jpg\\|gif\\|png"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7338 :publishing-directory "/ssh:user@@host:~/html/images/"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7339 :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
7340
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7341 ("other"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7342 :base-directory "~/other/"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7343 :base-extension "css\\|el"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7344 :publishing-directory "/ssh:user@@host:~/html/other/"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7345 :publishing-function org-publish-attachment)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7346 ("website" :components ("orgfiles" "images" "other"))))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7347 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7348
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7349 @node Triggering publication, , Sample configuration, Publishing
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7350 @section Triggering publication
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7351
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7352 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
7353 following functions:
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7354
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7355 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7356 @item C-c C-e C
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7357 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
7358 @item C-c C-e P
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7359 Publish the project containing the current file.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7360 @item C-c C-e F
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7361 Publish only the current file.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7362 @item C-c C-e A
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7363 Publish all projects.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7364 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7365
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7366 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
7367 functions normally only publish changed files. You can override this and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7368 force publishing of all files by giving a prefix argument.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7369
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7370 @node Miscellaneous, Extensions and Hacking, Publishing, Top
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7371 @chapter Miscellaneous
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7372
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7373 @menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7374 * Completion:: M-TAB knows what you need
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7375 * Customization:: Adapting Org-mode to your taste
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7376 * In-buffer settings:: Overview of the #+KEYWORDS
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7377 * 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
7378 * Clean view:: Getting rid of leading stars in the outline
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7379 * TTY keys:: Using Org-mode on a tty
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7380 * Interaction:: Other Emacs packages
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7381 * Bugs:: Things which do not work perfectly
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7382 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7383
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7384 @node Completion, Customization, Miscellaneous, Miscellaneous
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7385 @section Completion
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7386 @cindex completion, of @TeX{} symbols
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7387 @cindex completion, of TODO keywords
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7388 @cindex completion, of dictionary words
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7389 @cindex completion, of option keywords
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7390 @cindex completion, of tags
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7391 @cindex completion, of property keys
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7392 @cindex completion, of link abbreviations
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7393 @cindex @TeX{} symbol completion
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7394 @cindex TODO keywords completion
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7395 @cindex dictionary word completion
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7396 @cindex option keyword completion
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7397 @cindex tag completion
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7398 @cindex link abbreviations, completion of
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7399
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7400 Org-mode supports in-buffer completion. This type of completion does
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7401 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
7402 the buffer and use the key to complete text right there.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7403
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7404 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7405 @kindex M-@key{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7406 @item M-@key{TAB}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7407 Complete word at point
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7408 @itemize @bullet
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7409 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7410 At the beginning of a headline, complete TODO keywords.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7411 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7412 After @samp{\}, complete @TeX{} symbols supported by the exporter.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7413 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7414 After @samp{*}, complete headlines in the current buffer so that they
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7415 can be used in search links like @samp{[[*find this headline]]}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7416 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7417 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
7418 from the variable @code{org-tag-alist} (possibly set through the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7419 @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
7420 dynamically from all tags used in the current buffer.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7421 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7422 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
7423 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
7424 buffer.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7425 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7426 After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7427 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7428 After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7429 @samp{OPTIONS} which set file-specific options for Org-mode. When the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7430 option keyword is already complete, pressing @kbd{M-@key{TAB}} again
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7431 will insert example settings for this keyword.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7432 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7433 In the line after @samp{#+STARTUP: }, complete startup keywords,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7434 i.e. valid keys for this line.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7435 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7436 Elsewhere, complete dictionary words using ispell.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7437 @end itemize
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7438 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7439
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7440 @node Customization, In-buffer settings, Completion, Miscellaneous
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7441 @section Customization
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7442 @cindex customization
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7443 @cindex options, for customization
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7444 @cindex variables, for customization
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7445
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7446 There are more than 180 variables that can be used to customize
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7447 Org-mode. For the sake of compactness of the manual, I am not
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7448 describing the variables here. A structured overview of customization
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7449 variables is available with @kbd{M-x org-customize}. Or select
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7450 @code{Browse Org Group} from the @code{Org->Customization} menu. Many
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7451 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
7452 lines into the buffer (@pxref{In-buffer settings}).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7453
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7454 @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
7455 @section Summary of in-buffer settings
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7456 @cindex in-buffer settings
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7457 @cindex special keywords
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7458
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7459 Org-mode uses special lines in the buffer to define settings on a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7460 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
7461 keyword, a colon, and then individual words defining a setting. Several
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7462 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
7463 lines for the keyword. While these settings are described throughout
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7464 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
7465 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
7466 activate the changes immediately. Otherwise they become effective only
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7467 when the file is visited again in a new Emacs session.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7468
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7469 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7470 @item #+ARCHIVE: %s_done::
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7471 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
7472 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
7473 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
7474 The corresponding variable is @code{org-archive-location}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7475 @item #+CATEGORY:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7476 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
7477 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
7478 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
7479 @item #+COLUMNS: %25ITEM .....
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7480 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
7481 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
7482 applies.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7483 @item #+CONSTANTS: name1=value1 ...
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7484 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
7485 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
7486 The global version of this variable is
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7487 @code{org-table-formula-constants}.
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
7488 @item #+DRAWERS: NAME1 .....
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
7489 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
7490 @code{org-drawers}.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7491 @item #+LINK: linkword replace
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7492 These lines (several are allowed) specify link abbreviations.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7493 @xref{Link abbreviations}. The corresponding variable is
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7494 @code{org-link-abbrev-alist}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7495 @item #+PRIORITIES: highest lowest default
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7496 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
7497 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
7498 have a lower ASCII number that the lowest priority.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7499 @item #+PROPERTY: Property_Name Value
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7500 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
7501 buffer, most useful for specifying the allowed values of a property.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7502 @item #+STARTUP:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7503 This line sets options to be used at startup of Org-mode, when an
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7504 Org-mode file is being visited. The first set of options deals with the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7505 initial visibility of the outline tree. The corresponding variable for
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7506 global default settings is @code{org-startup-folded}, with a default
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7507 value @code{t}, which means @code{overview}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7508 @cindex @code{overview}, STARTUP keyword
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7509 @cindex @code{content}, STARTUP keyword
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7510 @cindex @code{showall}, STARTUP keyword
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7511 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7512 overview @r{top-level headlines only}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7513 content @r{all headlines}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7514 showall @r{no folding at all, show everything}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7515 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7516 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
7517 is useful in files containing narrowed table columns. The corresponding
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7518 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
7519 @code{nil}.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7520 @cindex @code{align}, STARTUP keyword
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7521 @cindex @code{noalign}, STARTUP keyword
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7522 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7523 align @r{align all tables}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7524 noalign @r{don't align tables on startup}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7525 @end example
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
7526 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
7527 (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
7528 @code{org-log-repeat}) can be configured using these options.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7529 @cindex @code{logdone}, STARTUP keyword
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7530 @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
7531 @cindex @code{nologdone}, STARTUP keyword
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7532 @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
7533 @cindex @code{nolognoteclock-out}, STARTUP keyword
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7534 @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
7535 @cindex @code{lognoterepeat}, STARTUP keyword
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7536 @cindex @code{nologrepeat}, STARTUP keyword
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7537 @example
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
7538 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
7539 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
7540 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
7541 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
7542 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
7543 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
7544 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
7545 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
7546 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7547 Here are the options for hiding leading stars in outline headings. The
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7548 corresponding variables are @code{org-hide-leading-stars} and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7549 @code{org-odd-levels-only}, both with a default setting @code{nil}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7550 (meaning @code{showstars} and @code{oddeven}).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7551 @cindex @code{hidestars}, STARTUP keyword
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7552 @cindex @code{showstars}, STARTUP keyword
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7553 @cindex @code{odd}, STARTUP keyword
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7554 @cindex @code{even}, STARTUP keyword
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7555 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7556 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
7557 showstars @r{show all stars starting a headline}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7558 odd @r{allow only odd outline levels (1,3,...)}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7559 oddeven @r{allow all outline levels}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7560 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7561 To turn on custom format overlays over time stamps (variables
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7562 @code{org-put-time-stamp-overlays} and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7563 @code{org-time-stamp-overlay-formats}), use
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7564 @cindex @code{customtime}, STARTUP keyword
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7565 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7566 customtime @r{overlay custom time format}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7567 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7568 The following options influence the table spreadsheet (variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7569 @code{constants-unit-system}).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7570 @cindex @code{constcgs}, STARTUP keyword
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7571 @cindex @code{constSI}, STARTUP keyword
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7572 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7573 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
7574 constSI @r{@file{constants.el} should use the SI unit system}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7575 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7576 @item #+TAGS: TAG1(c1) TAG2(c2)
92148
f991f10f15ec Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 87836
diff changeset
7577 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
7578 this file, and (potentially) the corresponding @emph{fast tag selection}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7579 keys. The corresponding variable is @code{org-tag-alist}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7580 @item #+TBLFM:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7581 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
7582 @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+OPTIONS, #+DATE:
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7583 These lines provide settings for exporting files. For more details see
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7584 @ref{Export options}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7585 @item #+SEQ_TODO: #+TYP_TODO:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7586 These lines set the TODO keywords and their interpretation in the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7587 current file. The corresponding variables are @code{org-todo-keywords}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7588 and @code{org-todo-interpretation}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7589 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7590
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7591 @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
7592 @section The very busy C-c C-c key
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7593 @kindex C-c C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7594 @cindex C-c C-c, overview
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7595
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7596 The key @kbd{C-c C-c} has many purposes in org-mode, which are all
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7597 mentioned scattered throughout this manual. One specific function of
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7598 this key is to add @emph{tags} to a headline (@pxref{Tags}). In many
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7599 other circumstances it means something like @emph{Hey Org-mode, look
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7600 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
7601 what this means in different contexts.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7602
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7603 @itemize @minus
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7604 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7605 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
7606 tree, or from clock display, remove these highlights.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7607 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7608 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
7609 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
7610 information.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7611 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7612 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
7613 works even if the automatic table editor has been turned off.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7614 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7615 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
7616 the entire table.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7617 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7618 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
7619 activate that table.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7620 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7621 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
7622 With a prefix argument, file it, without further interaction, to the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7623 default location.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7624 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7625 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
7626 corresponding links in this buffer.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7627 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7628 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
7629 drawer, offer property commands.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7630 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7631 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
7632 of the checkbox.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7633 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7634 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
7635 ordered list.
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
7636 @item
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
7637 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
7638 block is updated.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7639 @end itemize
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7640
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7641 @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
7642 @section A cleaner outline view
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7643 @cindex hiding leading stars
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7644 @cindex clean outline view
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7645
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7646 Some people find it noisy and distracting that the Org-mode headlines
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7647 are starting with a potentially large number of stars. For example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7648 the tree from @ref{Headlines}:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7649
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7650 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7651 * Top level headline
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7652 ** Second level
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7653 *** 3rd level
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7654 some text
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7655 *** 3rd level
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7656 more text
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7657 * Another top level headline
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7658 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7659
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7660 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7661 Unfortunately this is deeply ingrained into the code of Org-mode and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7662 cannot be easily changed. You can, however, modify the display in such
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7663 a way that all leading stars become invisible and the outline more easy
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7664 to read. To do this, customize the variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7665 @code{org-hide-leading-stars} like this:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7666
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7667 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7668 (setq org-hide-leading-stars t)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7669 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7670
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7671 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7672 or change this on a per-file basis with one of the lines (anywhere in
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7673 the buffer)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7674
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7675 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7676 #+STARTUP: showstars
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7677 #+STARTUP: hidestars
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7678 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7679
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7680 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7681 Press @kbd{C-c C-c} with the cursor in a @samp{STARTUP} line to activate
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7682 the modifications.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7683
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7684 With stars hidden, the tree becomes:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7685
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7686 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7687 * Top level headline
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7688 * Second level
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7689 * 3rd level
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7690 some text
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7691 * 3rd level
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7692 more text
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7693 * Another top level headline
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7694 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7695
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7696 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7697 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
7698 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
7699 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
7700 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
7701 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
7702 stars are @i{almost} invisible, for example using the color
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7703 @code{grey90} on a white background.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7704
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7705 Things become cleaner still if you skip all the even levels and use only
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7706 odd levels 1, 3, 5..., effectively adding two stars to go from one
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7707 outline level to the next:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7708
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7709 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7710 * Top level headline
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7711 * Second level
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7712 * 3rd level
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7713 some text
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7714 * 3rd level
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7715 more text
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7716 * Another top level headline
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7717 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7718
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7719 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7720 In order to make the structure editing and export commands handle this
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7721 convention correctly, use
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7722
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7723 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7724 (setq org-odd-levels-only t)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7725 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7726
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7727 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7728 or set this on a per-file basis with one of the following lines (don't
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7729 forget to press @kbd{C-c C-c} with the cursor in the startup line to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7730 activate changes immediately).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7731
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7732 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7733 #+STARTUP: odd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7734 #+STARTUP: oddeven
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7735 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7736
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7737 You can convert an Org-mode file from single-star-per-level to the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7738 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
7739 RET} in that file. The reverse operation is @kbd{M-x
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7740 org-convert-to-oddeven-levels}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7741
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7742 @node TTY keys, Interaction, Clean view, Miscellaneous
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7743 @section Using org-mode on a tty
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7744 @cindex tty keybindings
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7745
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
7746 Because Org-mode contains a large number of commands, by default much of
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
7747 Org-mode's core commands are bound to keys that are generally not
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
7748 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
7749 @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
7750 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
7751 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
7752 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
7753 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
7754 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
7755 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
7756 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
7757
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7758 @multitable @columnfractions 0.15 0.2 0.2
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7759 @item @b{Default} @tab @b{Alternative 1} @tab @b{Alternative 2}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7760 @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
7761 @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
7762 @item @kbd{M-S-@key{left}} @tab @kbd{C-c C-x L} @tab
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7763 @item @kbd{M-@key{right}} @tab @kbd{C-c C-x r} @tab @kbd{@key{Esc} @key{right}}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7764 @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
7765 @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
7766 @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
7767 @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
7768 @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
7769 @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
7770 @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
7771 @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
7772 @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
7773 @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
7774 @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
7775 @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
7776 @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
7777 @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
7778 @end multitable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7779
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7780 @node Interaction, Bugs, TTY keys, Miscellaneous
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7781 @section Interaction with other packages
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7782 @cindex packages, interaction with other
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7783 Org-mode lives in the world of GNU Emacs and interacts in various ways
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7784 with other code out there.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7785
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7786 @menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7787 * Cooperation:: Packages Org-mode cooperates with
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7788 * Conflicts:: Packages that lead to conflicts
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7789 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7790
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7791 @node Cooperation, Conflicts, Interaction, Interaction
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7792 @subsection Packages that Org-mode cooperates with
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7793
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7794 @table @asis
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7795 @cindex @file{calc.el}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7796 @item @file{calc.el} by Dave Gillespie
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7797 Org-mode uses the calc package for implementing spreadsheet
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7798 functionality in its tables (@pxref{The spreadsheet}). Org-mode
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7799 checks for the availability of calc by looking for the function
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7800 @code{calc-eval} which should be autoloaded in your setup if calc has
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7801 been installed properly. As of Emacs 22, calc is part of the Emacs
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7802 distribution. Another possibility for interaction between the two
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7803 packages is using calc for embedded calculations. @xref{Embedded Mode,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7804 , Embedded Mode, calc, GNU Emacs Calc Manual}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7805 @cindex @file{constants.el}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7806 @item @file{constants.el} by Carsten Dominik
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7807 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
7808 names for natural constants or units. Instead of defining your own
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7809 constants in the variable @code{org-table-formula-constants}, install
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7810 the @file{constants} package which defines a large number of constants
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7811 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
7812 @samp{Mega} etc. You will need version 2.0 of this package, available
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7813 at @url{http://www.astro.uva.nl/~dominik/Tools}. Org-mode checks for
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7814 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
7815 setup. See the installation instructions in the file
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7816 @file{constants.el}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7817 @item @file{cdlatex.el} by Carsten Dominik
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7818 @cindex @file{cdlatex.el}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7819 Org-mode can make use of the cdlatex package to efficiently enter
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7820 La@TeX{} fragments into Org-mode files. See @ref{CDLaTeX mode}.
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
7821 @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
7822 @cindex @file{imenu.el}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
7823 Imenu allows menu access to an index of items in a file. Org-mode
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
7824 supports imenu - all you need to do to get the index is the following:
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
7825 @lisp
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
7826 (add-hook 'org-mode-hook
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
7827 (lambda () 'imenu-add-to-menubar "Imenu"))
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
7828 @end lisp
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
7829 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
7830 the option @code{org-imenu-depth}.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7831 @item @file{remember.el} by John Wiegley
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7832 @cindex @file{remember.el}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7833 Org mode cooperates with remember, see @ref{Remember}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7834 @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
7835 @item @file{speedbar.el} by Eric M. Ludlam
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
7836 @cindex @file{speedbar.el}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
7837 Speedbar is a package that creates a special frame displaying files and
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
7838 index items in files. Org-mode supports speedbar and allows you to
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
7839 drill into Org-mode files directly from the speedbar. It also allows to
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
7840 restrict the scope of agenda commands to a file or a subtree by using
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
7841 the command @kbd{<} in the speedbar frame.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7842 @cindex @file{table.el}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7843 @item @file{table.el} by Takaaki Ota
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7844 @kindex C-c C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7845 @cindex table editor, @file{table.el}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7846 @cindex @file{table.el}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7847
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7848 Complex ASCII tables with automatic line wrapping, column- and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7849 row-spanning, and alignment can be created using the Emacs table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7850 package by Takaaki Ota (@uref{http://sourceforge.net/projects/table},
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7851 and also part of Emacs 22).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7852 When @key{TAB} or @kbd{C-c C-c} is pressed in such a table, Org-mode
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7853 will call @command{table-recognize-table} and move the cursor into the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7854 table. Inside a table, the keymap of Org-mode is inactive. In order
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7855 to execute Org-mode-related commands, leave the table.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7856
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7857 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7858 @kindex C-c C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7859 @item C-c C-c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7860 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
7861 table.el table.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7862 @c
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7863 @kindex C-c ~
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7864 @item C-c ~
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7865 Insert a table.el table. If there is already a table at point, this
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7866 command converts it between the table.el format and the Org-mode
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7867 format. See the documentation string of the command
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7868 @code{org-convert-table} for the restrictions under which this is
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7869 possible.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7870 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7871 @file{table.el} is part of Emacs 22.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7872 @cindex @file{footnote.el}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7873 @item @file{footnote.el} by Steven L. Baur
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7874 Org-mode recognizes numerical footnotes as provided by this package
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7875 (@pxref{Footnotes}).
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7876 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7877
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7878 @node Conflicts, , Cooperation, Interaction
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7879 @subsection Packages that lead to conflicts with Org-mode
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7880
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7881 @table @asis
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7882
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7883 @cindex @file{allout.el}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7884 @item @file{allout.el} by Ken Manheimer
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7885 Startup of Org-mode may fail with the error message
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7886 @code{(wrong-type-argument keymapp nil)} when there is an outdated
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7887 version @file{allout.el} on the load path, for example the version
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7888 distributed with Emacs 21.x. Upgrade to Emacs 22 and this problem will
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7889 disappear. If for some reason you cannot do this, make sure that org.el
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7890 is loaded @emph{before} @file{allout.el}, for example by putting
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7891 @code{(require 'org)} early enough into your @file{.emacs} file.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7892
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7893 @cindex @file{CUA.el}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7894 @item @file{CUA.el} by Kim. F. Storm
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
7895 Keybindings in Org-mode conflict with the @kbd{S-<cursor>} keys used by
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
7896 CUA-mode (as well as pc-select-mode and s-region-mode) to select and
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
7897 extend the region. If you want to use one of these packages along with
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
7898 Org-mode, configure the variable @code{org-replace-disputed-keys}. When
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
7899 set, Org-mode will move the following keybindings in Org-mode files, and
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
7900 in the agenda buffer (but not during date selection).
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7901
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7902 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7903 S-UP -> M-p S-DOWN -> M-n
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7904 S-LEFT -> M-- S-RIGHT -> M-+
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7905 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7906
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7907 Yes, these are unfortunately more difficult to remember. If you want
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7908 to have other replacement keys, look at the variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7909 @code{org-disputed-keys}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7910 @item @file{windmove.el} by Hovav Shacham
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7911 @cindex @file{windmove.el}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7912 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
7913 in the paragraph above about CUA mode also applies here.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7914
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7915 @cindex @file{footnote.el}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7916 @item @file{footnote.el} by Steven L. Baur
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7917 Org-mode supports the syntax of the footnote package, but only the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7918 numerical footnote markers. Also, the default key for footnote
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7919 commands, @kbd{C-c !} is already used by Org-mode. You could use the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7920 variable @code{footnote-prefix} to switch footnotes commands to another
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7921 key. Or, you could use @code{org-replace-disputed-keys} and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7922 @code{org-disputed-keys} to change the settings in Org-mode.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7923
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7924 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7925
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 Bugs, , Interaction, Miscellaneous
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7928 @section Bugs
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7929 @cindex bugs
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7930
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7931 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
7932 have found too hard to fix.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7933
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7934 @itemize @bullet
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7935 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7936 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
7937 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
7938 display the link, the field would look entirely empty even though it is
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7939 not. To prevent this, Org-mode throws an error. The work-around is to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7940 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
7941 least 2 characters) before the link in the same field.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7942 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7943 Narrowing table columns does not work on XEmacs, because the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7944 @code{format} function does not transport text properties.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7945 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7946 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
7947 autowrap.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7948 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7949 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
7950 (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
7951 the file), it does so silently. No error message is displayed.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7952 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7953 Recalculating a table line applies the formulas from left to right.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7954 If a formula uses @emph{calculated} fields further down the row,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7955 multiple recalculation may be needed to get all fields consistent. You
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7956 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
7957 recalculate until convergence.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7958 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7959 A single letter cannot be made bold, for example @samp{*a*}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7960 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7961 The exporters work well, but could be made more efficient.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7962 @end itemize
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7963
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7964
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7965 @node Extensions and Hacking, History and Acknowledgments, Miscellaneous, Top
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7966 @appendix Extensions, Hooks and Hacking
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7967
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7968 This appendix lists extensions for Org-mode written by other authors.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7969 It also covers some aspects where users can extend the functionality of
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7970 Org-mode.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7971
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7972 @menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7973 * Extensions:: Existing 3rd-part extensions
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7974 * Adding hyperlink types:: New custom link types
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7975 * Tables in arbitrary syntax:: Orgtbl for LaTeX and other programs
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7976 * Dynamic blocks:: Automatically filled blocks
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7977 * Special agenda views:: Customized views
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7978 * Using the property API:: Writing programs that use entry properties
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7979 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7980
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7981 @node Extensions, Adding hyperlink types, Extensions and Hacking, Extensions and Hacking
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7982 @section Third-party extensions for Org-mode
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7983 @cindex extension, third-party
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7984
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7985 The following extensions for Org-mode have been written by other people:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7986
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7987 @table @asis
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7988 @cindex @file{org-publish.el}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7989 @item @file{org-publish.el} by David O'Toole
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7990 This package provides facilities for publishing related sets of Org-mode
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7991 files together with linked files like images as webpages. It is
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7992 highly configurable and can be used for other publishing purposes as
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7993 well. As of Org-mode version 4.30, @file{org-publish.el} is part of the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7994 Org-mode distribution. It is not yet part of Emacs, however, a delay
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7995 caused by the preparations for the 22.1 release. In the mean time,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7996 @file{org-publish.el} can be downloaded from David's site:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7997 @url{http://dto.freeshell.org/e/org-publish.el}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7998 @cindex @file{org-mouse.el}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7999 @item @file{org-mouse.el} by Piotr Zielinski
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8000 This package implements extended mouse functionality for Org-mode. It
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8001 allows you to cycle visibility and to edit the document structure with
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8002 the mouse. Best of all, it provides a context-sensitive menu on
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8003 @key{mouse-3} that changes depending on the context of a mouse-click.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8004 As of Org-mode version 4.53, @file{org-mouse.el} is part of the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8005 Org-mode distribution. It is not yet part of Emacs, however, a delay
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8006 caused by the preparations for the 22.1 release. In the mean time,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8007 @file{org-mouse.el} can be downloaded from Piotr's site:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8008 @url{http://www.cl.cam.ac.uk/~pz215/files/org-mouse.el}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8009 @cindex @file{org-blog.el}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8010 @item @file{org-blog.el} by David O'Toole
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8011 A blogging plug-in for @file{org-publish.el}.@*
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8012 @url{http://dto.freeshell.org/notebook/OrgMode.html}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8013 @cindex @file{blorg.el}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8014 @item @file{blorg.el} by Bastien Guerry
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8015 Publish Org-mode files as
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8016 blogs. @url{http://www.cognition.ens.fr/~guerry/blorg.html}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8017 @cindex @file{org2rem.el}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8018 @item @file{org2rem.el} by Bastien Guerry
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8019 Translates Org-mode files into something readable by
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8020 Remind. @url{http://www.cognition.ens.fr/~guerry/u/org2rem.el}.
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8021 @item @file{org-toc.el} by Bastien Guerry
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8022 Produces a simple table of contents of an Org-mode file, for easy
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8023 navigation. @url{http://www.cognition.ens.fr/~guerry/u/org-registry.el}.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8024 @item @file{org-registry.el} by Bastien Guerry
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8025 Find which Org-file link to a certain document.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8026 @url{http://www.cognition.ens.fr/~guerry/u/org2rem.el}.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8027 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8028
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8029 @page
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8030
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8031 @node Adding hyperlink types, Tables in arbitrary syntax, Extensions, Extensions and Hacking
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8032 @section Adding hyperlink types
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8033 @cindex hyperlinks, adding new types
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8034
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8035 Org-mode has a large number of hyperlink types built-in
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8036 (@pxref{Hyperlinks}). If you would like to add new link types, it
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8037 provides an interface for doing so. Lets look at an example file
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8038 @file{org-man.el} that will add support for creating links like
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8039 @samp{[[man:printf][The printf manpage]]} to show unix manual pages inside
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8040 emacs:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8041
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8042 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8043 ;;; org-man.el - Support for links to manpages in Org-mode
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8044
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8045 (require 'org)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8046
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8047 (org-add-link-type "man" 'org-man-open)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8048 (add-hook 'org-store-link-functions 'org-man-store-link)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8049
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8050 (defcustom org-man-command 'man
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8051 "The Emacs command to be used to display a man page."
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8052 :group 'org-link
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8053 :type '(choice (const man) (const woman)))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8054
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8055 (defun org-man-open (path)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8056 "Visit the manpage on PATH.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8057 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
8058 (funcall org-man-command path))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8059
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8060 (defun org-man-store-link ()
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8061 "Store a link to a manpage."
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8062 (when (memq major-mode '(Man-mode woman-mode))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8063 ;; This is a man page, we do make this link
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8064 (let* ((page (org-man-get-page-name))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8065 (link (concat "man:" page))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8066 (description (format "Manpage for %s" page)))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8067 (org-store-link-props
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8068 :type "man"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8069 :link link
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8070 :description description))))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8071
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8072 (defun org-man-get-page-name ()
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8073 "Extract the page name from the buffer name."
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8074 ;; This works for both `Man-mode' and `woman-mode'.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8075 (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8076 (match-string 1 (buffer-name))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8077 (error "Cannot create link to this man page")))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8078
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8079 (provide 'org-man)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8080
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8081 ;;; org-man.el ends here
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8082 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8083
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8084 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8085 You would activate this new link type in @file{.emacs} with
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8086
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8087 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8088 (require 'org-man)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8089 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8090
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8091 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8092 Lets go through the file and see what it does.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8093 @enumerate
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
8094 @item
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8095 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
8096 loaded.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8097 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8098 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
8099 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
8100 that will be called to follow such a link.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8101 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8102 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
8103 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
8104 buffer displaying a man page.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8105 @end enumerate
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8106
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8107 The rest of the file defines the necessary variables and functions.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8108 First there is a customization variable that determines which emacs
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8109 command should be used to display manpages. There are two options,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8110 @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
8111 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
8112 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
8113 value of @code{org-man-command} to display the man page.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8114
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8115 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
8116 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
8117 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
8118 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
8119 of the variable @code{major-mode}. If not, the function must exit and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8120 retunr the value @code{nil}. If yes, the link is created by getting the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8121 manual tpoic from the buffer name and prefixing it with the string
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8122 @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
8123 and set the @code{:type} and @code{:link} properties. Optionally you
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8124 can also set the @code{:description} property to provide a default for
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8125 the link description when the link is later inserted into tan Org-mode
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8126 buffer with @kbd{C-c C-l}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8127
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8128 @node Tables in arbitrary syntax, Dynamic blocks, Adding hyperlink types, Extensions and Hacking
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8129 @section Tables and Lists in arbitrary syntax
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8130 @cindex tables, in other modes
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8131 @cindex lists, in other modes
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8132 @cindex orgtbl-mode
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8133
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8134 Since Orgtbl-mode can be used as a minor mode in arbitrary buffers, a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8135 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
8136 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
8137 hard to do in a general way, would lead to a customization nightmare,
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8138 and would take away much of the simplicity of the Orgtbl-mode table
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8139 editor.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8140
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8141
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8142 This appendix describes a different approach. We keep the Orgtbl-mode
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8143 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
8144 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
8145 @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
8146 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
8147 for a very flexible system.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8148
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8149 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
8150 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
8151 on, then locally exporting such lists in another format (HTML, La@TeX{}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8152 or TeXInfo.)
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8153
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8154
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8155 @menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8156 * Radio tables:: Sending and receiving
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8157 * A LaTeX example:: Step by step, almost a tutorial
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8158 * Translator functions:: Copy and modify
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8159 * Radio lists:: Doing the same for lists.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8160 @end menu
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8161
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8162 @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
8163 @subsection Radio tables
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8164 @cindex radio tables
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8165
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8166 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
8167 lines that are comments in the current mode, but contain magic words for
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8168 Orgtbl-mode to find. Orgtbl-mode will insert the translated table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8169 between these lines, replacing whatever was there before. For example:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8170
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8171 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8172 /* BEGIN RECEIVE ORGTBL table_name */
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8173 /* END RECEIVE ORGTBL table_name */
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8174 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8175
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8176 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8177 Just above the source table, we put a special line that tells
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8178 Orgtbl-mode how to translate this table and where to install it. For
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8179 example:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8180 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8181 #+ORGTBL: SEND table_name translation_function arguments....
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8182 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8183
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8184 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8185 @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
8186 in the receiver lines. @code{translation_function} is the Lisp function
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8187 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
8188 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
8189 passed as a property list to the translation function for
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8190 interpretation. A few standard parameters are already recognized and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8191 acted upon before the translation function is called:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8192
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8193 @table @code
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8194 @item :skip N
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8195 Skip the first N lines of the table. Hlines do count!
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8196 @item :skipcols (n1 n2 ...)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8197 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
8198 calculation marks, that column is automatically discarded as well.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8199 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
8200 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
8201 additional columns.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8202 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8203
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8204 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8205 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
8206 without disturbing the normal workings of the file, for example during
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8207 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
8208 number of different solutions:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8209
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8210 @itemize @bullet
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8211 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8212 The table could be placed in a block comment if that is supported by the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8213 language. For example, in C-mode you could wrap the table between
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8214 @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
8215 @item
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8216 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
8217 statement, for example @samp{\bye} in TeX and @samp{\end@{document@}}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8218 in La@TeX{}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8219 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8220 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
8221 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
8222 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
8223 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
8224 key.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8225 @end itemize
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8226
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8227 @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
8228 @subsection A LaTeX example of radio tables
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8229 @cindex LaTeX, and orgtbl-mode
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8230
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8231 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
8232 @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
8233 activated by placing @code{\usepackage@{comment@}} into the document
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8234 header. Orgtbl-mode can insert a radio table skeleton@footnote{By
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8235 default this works only for La@TeX{}, HTML, and TeXInfo. Configure the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8236 variable @code{orgtbl-radio-tables} to install templates for other
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8237 modes.} with the command @kbd{M-x orgtbl-insert-radio-table}. You will
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8238 be prompted for a table name, lets say we use @samp{salesfigures}. You
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8239 will then get the following template:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8240
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8241 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8242 % BEGIN RECEIVE ORGTBL salesfigures
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8243 % END RECEIVE ORGTBL salesfigures
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8244 \begin@{comment@}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8245 #+ORGTBL: SEND salesfigures orgtbl-to-latex
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8246 | | |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8247 \end@{comment@}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8248 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8249
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8250 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8251 The @code{#+ORGTBL: SEND} line tells orgtbl-mode to use the function
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8252 @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
8253 into the receiver location with name @code{salesfigures}. You may now
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8254 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
8255 the @samp{#+TBLFM} line contains an odd number of dollar characters,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8256 this may cause problems with font-lock in latex-mode. As shown in the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8257 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
8258 @code{comment} environment that is used to balance the dollar
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8259 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
8260 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
8261 variable @code{LaTeX-verbatim-environments}.}:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8262
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8263 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8264 % BEGIN RECEIVE ORGTBL salesfigures
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8265 % END RECEIVE ORGTBL salesfigures
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8266 \begin@{comment@}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8267 #+ORGTBL: SEND salesfigures orgtbl-to-latex
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8268 | Month | Days | Nr sold | per day |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8269 |-------+------+---------+---------|
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8270 | Jan | 23 | 55 | 2.4 |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8271 | Feb | 21 | 16 | 0.8 |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8272 | March | 22 | 278 | 12.6 |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8273 #+TBLFM: $4=$3/$2;%.1f
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8274 % $ (optional extra dollar to keep font-lock happy, see footnote)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8275 \end@{comment@}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8276 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8277
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8278 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8279 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
8280 table inserted between the two marker lines.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8281
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8282 Now lets assume you want to make the table header by hand, because you
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8283 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
8284 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
8285 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
8286 header and footer commands of the target table:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8287
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8288 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8289 \begin@{tabular@}@{lrrr@}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8290 Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8291 % BEGIN RECEIVE ORGTBL salesfigures
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8292 % END RECEIVE ORGTBL salesfigures
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8293 \end@{tabular@}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8294 %
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8295 \begin@{comment@}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8296 #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8297 | Month | Days | Nr sold | per day |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8298 |-------+------+---------+---------|
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8299 | Jan | 23 | 55 | 2.4 |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8300 | Feb | 21 | 16 | 0.8 |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8301 | March | 22 | 278 | 12.6 |
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8302 #+TBLFM: $4=$3/$2;%.1f
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8303 \end@{comment@}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8304 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8305
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8306 The La@TeX{} translator function @code{orgtbl-to-latex} is already part of
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8307 Orgtbl-mode. It uses a @code{tabular} environment to typeset the table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8308 and marks horizontal lines with @code{\hline}. Furthermore, it
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8309 interprets the following parameters:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8310
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8311 @table @code
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8312 @item :splice nil/t
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8313 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
8314 tabular environment. Default is nil.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8315
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8316 @item :fmt fmt
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8317 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
8318 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
8319 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
8320 column numbers and formats. for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8321
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8322 @item :efmt efmt
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8323 Use this format to print numbers with exponentials. The format should
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8324 have @code{%s} twice for inserting mantissa and exponent, for example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8325 @code{"%s\\times10^@{%s@}"}. The default is @code{"%s\\,(%s)"}. This
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8326 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
8327 @code{:efmt (2 "$%s\\times10^@{%s@}$" 4 "$%s\\cdot10^@{%s@}$")}. After
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8328 @code{efmt} has been applied to a value, @code{fmt} will also be
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8329 applied.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8330 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8331
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8332 @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
8333 @subsection Translator functions
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8334 @cindex HTML, and orgtbl-mode
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8335 @cindex translator function
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8336
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8337 Orgtbl-mode has several translator functions built-in:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8338 @code{orgtbl-to-latex}, @code{orgtbl-to-html}, and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8339 @code{orgtbl-to-texinfo}. Except for @code{orgtbl-to-html}@footnote{The
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8340 HTML translator uses the same code that produces tables during HTML
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8341 export.}, these all use a generic translator, @code{orgtbl-to-generic}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8342 For example, @code{orgtbl-to-latex} itself is a very short function that
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8343 computes the column definitions for the @code{tabular} environment,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8344 defines a few field and line separators and then hands over to the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8345 generic translator. Here is the entire code:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8346
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8347 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8348 @group
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8349 (defun orgtbl-to-latex (table params)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8350 "Convert the orgtbl-mode TABLE to LaTeX."
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8351 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8352 org-table-last-alignment ""))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8353 (params2
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8354 (list
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8355 :tstart (concat "\\begin@{tabular@}@{" alignment "@}")
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8356 :tend "\\end@{tabular@}"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8357 :lstart "" :lend " \\\\" :sep " & "
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8358 :efmt "%s\\,(%s)" :hline "\\hline")))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8359 (orgtbl-to-generic table (org-combine-plists params2 params))))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8360 @end group
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8361 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8362
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8363 As you can see, the properties passed into the function (variable
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8364 @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
8365 (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
8366 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
8367 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
8368 be @samp{\\[2mm]} instead of the default @samp{\\}, you could just
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8369 overrule the default with
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8370
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8371 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8372 #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8373 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8374
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8375 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
8376 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
8377 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
8378 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
8379 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
8380 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
8381 a single line!):
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8382
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8383 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8384 #+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8385 :lstart "!BL! " :lend " !EL!" :sep "\t"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8386 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8387
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8388 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8389 Please check the documentation string of the function
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8390 @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
8391 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
8392 @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
8393 using the generic function.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8394
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8395 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
8396 things the generic translator cannot do. A translator function takes
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8397 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
8398 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
8399 argument is the property list containing all parameters specified in the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8400 @samp{#+ORGTBL: SEND} line. The function must return a single string
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8401 containing the formatted table. If you write a generally useful
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8402 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
8403 others can benefit from your work.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8404
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8405 @node Radio lists, , Translator functions, Tables in arbitrary syntax
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8406 @subsection Radio lists
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8407 @cindex radio lists
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8408 @cindex org-list-insert-radio-list
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8409
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8410 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
8411 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
8412 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
8413 since the relevant code is there for now.}. As for radio tables, you
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8414 can insert radio lists templates in HTML, La@TeX{} and TeXInfo modes by
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8415 calling @code{org-list-insert-radio-list}.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8416
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8417 Here are the differences with radio tables:
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8418
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8419 @itemize @minus
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8420 @item
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8421 Use @code{ORGLST} instead of @code{ORGTBL}.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8422 @item
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8423 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
8424 parameters.
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
8425 @item
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8426 `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
8427 @end itemize
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8428
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8429 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
8430 La@TeX{} file:
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8431
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8432 @example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8433 % BEGIN RECEIVE ORGLST to-buy
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8434 % END RECEIVE ORGLST to-buy
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8435 \begin@{comment@}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8436 #+ORGLIST: SEND to-buy orgtbl-to-latex
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8437 - a new house
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8438 - a new computer
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8439 + a new keyboard
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8440 + a new mouse
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8441 - a new life
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8442 \end@{comment@}
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8443 @end example
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8444
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8445 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
8446 La@TeX{} list between the two marker lines.
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8447
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8448 @node Dynamic blocks, Special agenda views, Tables in arbitrary syntax, Extensions and Hacking
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8449 @section Dynamic blocks
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8450 @cindex dynamic blocks
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8451
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8452 Org-mode documents can contain @emph{dynamic blocks}. These are
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8453 specially marked regions that are updated by some user-written function.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8454 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
8455 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
8456
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8457 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
8458 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
8459 the content of the block.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8460
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8461 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8462 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
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 #+END:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8465 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8466
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8467 Dynamic blocks are updated with the following commands
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 @table @kbd
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8470 @kindex C-c C-x C-u
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8471 @item C-c C-x C-u
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8472 Update dynamic block at point.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8473 @kindex C-u C-c C-x C-u
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8474 @item C-u C-c C-x C-u
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8475 Update all dynamic blocks in the current file.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8476 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8477
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8478 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
8479 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
8480 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
8481 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
8482 extra parameter @code{:content}.
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
8483
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
8484 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
8485 @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
8486 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
8487 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
8488 run:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8489
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8490 @example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8491 #+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
8492
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8493 #+END:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8494 @end example
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8495
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8496 @noindent
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8497 The corresponding block writer function could look like this:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8498
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8499 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8500 (defun org-dblock-write:block-update-time (params)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8501 (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8502 (insert "Last block update at: "
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8503 (format-time-string fmt (current-time)))))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8504 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8505
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8506 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
8507 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
8508 example @code{before-save-hook}. @code{org-update-all-dblocks} is
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8509 written in a way that is does nothing in buffers that are not in Org-mode.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8510
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8511 @node Special agenda views, Using the property API, Dynamic blocks, Extensions and Hacking
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8512 @section Special Agenda Views
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8513 @cindex agenda views, user-defined
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 Org-mode provides a special hook that can be used to narrow down the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8516 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
8517 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
8518 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
8519
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8520 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
8521 tag anywhere in the project tree. Let's further assume that you have
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8522 marked all tree headings that define a project with the todo keyword
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8523 PROJECT. In this case you would run a todo search for the keyword
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8524 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
8525 the subtree belonging to the project line.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8526
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8527 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
8528 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
8529 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
8530 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
8531 search should continue from there.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8532
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8533 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8534 (defun my-skip-unless-waiting ()
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8535 "Skip trees that are not waiting"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8536 (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
8537 (if (re-search-forward ":waiting:" subtree-end t)
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8538 nil ; tag found, do not skip
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8539 subtree-end))) ; tag not found, continue after end of subtree
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8540 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8541
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8542 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
8543 like this:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8544
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8545 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8546 (org-add-agenda-custom-command
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8547 '("b" todo "PROJECT"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8548 ((org-agenda-skip-function 'my-org-waiting-projects)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8549 (org-agenda-overriding-header "Projects waiting for something: "))))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8550 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8551
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8552 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
8553 meaningful header in the agenda view.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8554
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8555 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
8556 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
8557 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
8558
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8559 @table @code
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8560 @item '(org-agenda-skip-entry-if 'scheduled)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8561 Skip current entry if it has been scheduled.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8562 @item '(org-agenda-skip-entry-if 'notscheduled)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8563 Skip current entry if it has not been scheduled.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8564 @item '(org-agenda-skip-entry-if 'deadline)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8565 Skip current entry if it has a deadline.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8566 @item '(org-agenda-skip-entry-if 'scheduled 'deadline)
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8567 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
8568 @item '(org-agenda-skip-entry 'regexp "regular expression")
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8569 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
8570 @item '(org-agenda-skip-entry 'notregexp "regular expression")
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8571 Skip current entry unless the regular expression matches.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8572 @item '(org-agenda-skip-subtree-if 'regexp "regular expression")
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8573 Same as above, but check and skip the entire subtree.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8574 @end table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8575
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8576 Therefore we could also have written the search for WAITING projects
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8577 like this, even without defining a special function:
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8578
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8579 @lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8580 (org-add-agenda-custom-command
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8581 '("b" todo "PROJECT"
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8582 ((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
8583 'regexp ":waiting:"))
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8584 (org-agenda-overriding-header "Projects waiting for something: "))))
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8585 @end lisp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8586
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8587
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8588 @node Using the property API, , Special agenda views, Extensions and Hacking
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8589 @section Using the property API
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8590 @cindex API, for properties
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8591 @cindex properties, API
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8592
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8593 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
8594 properties.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8595
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8596 @defun org-entry-properties &optional pom which
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8597 Get all properties of the entry at point-or-marker POM.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8598 This includes the TODO keyword, the tags, time strings for deadline,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8599 scheduled, and clocking, and any additional properties defined in the
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8600 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
8601 if the property key was used several times.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8602 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
8603 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
8604 `special' or `standard', only get that subclass.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8605 @end defun
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8606 @defun org-entry-get pom property &optional inherit
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8607 Get value of PROPERTY for entry at point-or-marker POM.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8608 If INHERIT is non-nil and the entry does not have the property,
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8609 then also check higher levels of the hierarchy. This function ignores
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8610 the value of @code{org-use-property-inheritance} and requires the
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8611 explicit INHERIT flag.
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8612 @end defun
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8613
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8614 @defun org-entry-delete pom property
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8615 Delete the property PROPERTY from entry at point-or-marker POM.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8616 @end defun
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8617
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8618 @defun org-entry-put pom property value
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8619 Set PROPERTY to VALUE for entry at point-or-marker POM.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8620 @end defun
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8621
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8622 @defun org-buffer-property-keys &optional include-specials
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8623 Get all property keys in the current buffer.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8624 @end defun
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8625
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8626 @defun org-insert-property-drawer
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8627 Insert a property drawer at point.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8628 @end defun
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 @node History and Acknowledgments, Main Index, Extensions and Hacking, Top
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8631 @appendix History and Acknowledgments
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8632 @cindex acknowledgments
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8633 @cindex history
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8634 @cindex thanks
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8635
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8636 Org-mode was borne in 2003, out of frustration over the user interface
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8637 of the Emacs outline-mode. I was trying to organize my notes and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8638 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
8639 having to remember eleven different commands with two or three keys per
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8640 command, only to hide and unhide parts of the outline tree, that seemed
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8641 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
8642 constantly want to restructure the tree, organizing it parallel to my
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8643 thoughts and plans. @emph{Visibility cycling} and @emph{structure
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8644 editing} were originally implemented in the package
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8645 @file{outline-magic.el}, but quickly moved to the more general
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8646 @file{org.el}. As this environment became comfortable for project
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8647 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
8648 stamps}, and @emph{table support}. These areas highlight the two main
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8649 goals that Org-mode still has today: To create a new, outline-based,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8650 plain text mode with innovative and intuitive editing features, and to
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8651 incorporate project planning functionality directly into a notes file.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8652
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8653 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
8654 @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
8655 reports, feedback, new ideas, and sometimes patches and add-on code.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8656 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
8657 trying to keep here a list of the people who had significant influence
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8658 in shaping one or more aspects of Org-mode. The list may not be
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8659 complete, if I have forgotten someone, please accept my apologies and
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8660 let me know.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8661
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8662 @itemize @bullet
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8663
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8664 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8665 @i{Russel Adams} came up with the idea for drawers.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8666 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8667 @i{Thomas Baumann} contributed the code for links to the MH-E email
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8668 system.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8669 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8670 @i{Alex Bochannek} provided a patch for rounding time stamps.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8671 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8672 @i{Charles Cave}'s suggestion sparked the implementation of templates
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8673 for Remember.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8674 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8675 @i{Pavel Chalmoviansky} influenced the agenda treatment of items with
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8676 specified time.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8677 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8678 @i{Gregory Chernov} patched support for lisp forms into table
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8679 calculations and improved XEmacs compatibility, in particular by porting
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8680 @file{nouline.el} to XEmacs.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8681 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8682 @i{Sacha Chua} suggested to copy some linking code from Planner.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8683 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8684 @i{Eddward DeVilla} proposed and tested checkbox statistics. He also
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8685 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
8686 them.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8687 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8688 @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
8689 inspired some of the early development, including HTML export. He also
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8690 asked for a way to narrow wide table columns.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8691 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8692 @i{Christian Egli} converted the documentation into TeXInfo format,
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8693 patched CSS formatting into the HTML exporter, and inspired the agenda.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8694 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8695 @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
8696 HTML agendas.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8697 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8698 @i{Nic Ferrier} contributed mailcap and XOXO support.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8699 @item
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
8700 @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
8701 @item
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8702 @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
8703 around a match in a hidden outline tree.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8704 @item
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8705 @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
8706 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8707 @i{Bastien Guerry} wrote the La@TeX{} exporter and has been prolific
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8708 with patches, ideas, and bug reports.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8709 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8710 @i{Kai Grossjohann} pointed out key-binding conflicts with other packages.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8711 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8712 @i{Scott Jaderholm} proposed footnotes, control over whitespace between
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8713 folded entries, and column view for properties.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8714 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8715 @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
8716 provided frequent feedback and some patches.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8717 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8718 @i{Jason F. McBrayer} suggested agenda export to CSV format.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8719 @item
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8720 @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
8721 @item
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8722 @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
8723 basis.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8724 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8725 @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
8726 happy.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8727 @item
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8728 @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
8729 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
8730 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8731 @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
8732 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8733 @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
8734 file links, and TAGS.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8735 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8736 @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
8737 into Japanese.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8738 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8739 @i{Oliver Oppitz} suggested multi-state TODO items.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8740 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8741 @i{Scott Otterson} sparked the introduction of descriptive text for
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8742 links, among other things.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8743 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8744 @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
8745 provided frequent feedback.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8746 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8747 @i{T.V. Raman} reported bugs and suggested improvements.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8748 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8749 @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8750 control.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8751 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8752 @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
8753 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8754 @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
8755 conflict with @file{allout.el}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8756 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8757 @i{Jason Riedy} sent a patch to fix a bug with export of TODO keywords.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8758 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8759 @i{Philip Rooke} created the Org-mode reference card and provided lots
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8760 of feedback.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8761 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8762 @i{Christian Schlauer} proposed angular brackets around links, among
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8763 other things.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8764 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8765 Linking to VM/BBDB/GNUS was inspired by @i{Tom Shannon}'s
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8766 @file{organizer-mode.el}.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8767 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8768 @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
8769 subtrees.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8770 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8771 @i{Dale Smith} proposed link abbreviations.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8772 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8773 @i{Adam Spiers} asked for global linking commands and inspired the link
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8774 extension system. support mairix.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8775 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8776 @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
8777 chapter about publishing.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8778 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8779 @i{J@"urgen Vollmer} contributed code generating the table of contents
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8780 in HTML output.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8781 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8782 @i{Chris Wallace} provided a patch implementing the @samp{QUOTE}
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8783 keyword.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8784 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8785 @i{David Wainberg} suggested archiving, and improvements to the linking
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8786 system.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8787 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8788 @i{John Wiegley} wrote @file{emacs-wiki.el} and @file{planner.el}. The
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8789 development of Org-mode was fully independent, and both systems are
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8790 really different beasts in their basic ideas and implementation details.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8791 I later looked at John's code, however, and learned from his
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8792 implementation of (i) links where the link itself is hidden and only a
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8793 description is shown, and (ii) popping up a calendar to select a date.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8794 John has also contributed a number of great ideas directly to Org-mode.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8795 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8796 @i{Carsten Wimmer} suggested some changes and helped fix a bug in
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8797 linking to GNUS.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8798 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8799 @i{Roland Winkler} requested additional keybindings to make Org-mode
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8800 work on a tty.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8801 @item
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8802 @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8803 and contributed various ideas and code snippets.
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8804 @end itemize
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8805
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8806
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8807 @node Main Index, Key Index, History and Acknowledgments, Top
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8808 @unnumbered The Main Index
84308
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 @printindex cp
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8811
87836
22ad67b23797 (Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents: 84329
diff changeset
8812 @node Key Index, , Main Index, Top
84308
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8813 @unnumbered Key Index
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8814
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8815 @printindex ky
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8816
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8817 @bye
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8818
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8819 @ignore
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8820 arch-tag: 7893d1fe-cc57-4d13-b5e5-f494a1bcc7ac
c2eb0b4307ea Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8821 @end ignore
92864
8fc0a6fd114c * org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents: 92148
diff changeset
8822 )