1 <!DOCTYPE html PUBLIC
"-//W3C//DTD XHTML 1.0 Strict//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3 <html xmlns=
"http://www.w3.org/1999/xhtml"
4 lang=
"en" xml:
lang=
"en">
6 <title>Org-mode Frequently Asked Questions
</title>
7 <meta http-equiv=
"Content-Type" content=
"text/html;charset=iso-8859-1"/>
8 <meta name=
"generator" content=
"Org-mode"/>
9 <meta name=
"generated" content=
"2007/12/20 07:18:18"/>
10 <meta name=
"author" content=
"Carsten Dominik"/>
11 <link rel=stylesheet
href=
"freeshell2.css" type=
"text/css">
13 <h1 class=
"title">Org-mode Frequently Asked Questions
</h1>
14 <div id=
"table-of-contents">
15 <h2>Table of Contents
</h2>
17 <li><a href=
"#sec-1">1 General
</a>
19 <li><a href=
"#sec-2">1.1 Use features in other modes
</a></li>
20 <li><a href=
"#sec-3">1.2 Visibility cycling in Outline-mode and Outline-minor-mode
</a></li>
23 <li><a href=
"#sec-4">2 Errors
</a>
25 <li><a href=
"#sec-5">2.1 <code>(wrong-type-argument keymapp nil)
</code></a></li>
26 <li><a href=
"#sec-6">2.2 CUA mode does not work with Org-mode
</a></li>
29 <li><a href=
"#sec-7">3 Setup and Structure
</a>
31 <li><a href=
"#sec-8">3.1 Org-mode as default mode
</a></li>
32 <li><a href=
"#sec-9">3.2 Get rid of extra stars in outline
</a></li>
33 <li><a href=
"#sec-10">3.3 Two windows on same Org-mode file
</a></li>
36 <li><a href=
"#sec-11">4 Hyperlinks
</a>
38 <li><a href=
"#sec-12">4.1 Broken links after Org-mode
4.20</a></li>
39 <li><a href=
"#sec-13">4.2 Converting links to double-bracket format
</a></li>
40 <li><a href=
"#sec-14">4.3 Angular bracket links preference
</a></li>
41 <li><a href=
"#sec-15">4.4 Confirmation for shell and elips links
</a></li>
44 <li><a href=
"#sec-16">5 Export
</a>
46 <li><a href=
"#sec-17">5.1 Make TODO entries items, not headlines in HTML export
</a></li>
47 <li><a href=
"#sec-18">5.2 Export only a subtree
</a></li>
50 <li><a href=
"#sec-19">6 Tables
</a>
52 <li><a href=
"#sec-20">6.1 #ERROR fields in tables
</a></li>
53 <li><a href=
"#sec-21">6.2 Unwanted new lines in table
</a></li>
54 <li><a href=
"#sec-22">6.3 Change indentation of a table
</a></li>
57 <li><a href=
"#sec-23">7 Agenda
</a>
59 <li><a href=
"#sec-24">7.1 Include Org-mode agenda into Emacs diary
</a></li>
65 <div class=
"outline-2">
66 <h2 id=
"sec-1">1 General
</h2>
69 <div class=
"outline-3">
70 <h3 id=
"sec-2">1.1 Use features in other modes
</h3>
72 <p><b>I would like to use editing features of org-mode in other modes, is this possible?
</b>
75 Not really. For tables there is
<code>orgtbl-mode
</code> which implements the
76 table editor as a minor mode. For other features you need to switch to
77 Org-mode temporarily, or prepare text in a different buffer.
82 <div class=
"outline-3">
83 <h3 id=
"sec-3">1.2 Visibility cycling in Outline-mode and Outline-minor-mode
</h3>
87 %Can I get the visibility-cycling features in outline-mode and
91 Yes, these functions are written in a way that they are independent of
92 the outline setup. The following setup provides standard Org-mode
93 functionality in outline-mode on
<code>TAB
</code> and
<code>S-TAB
</code>. For
94 outline-minor-mode, we use
<code>C-TAB
</code> instead of
<code>TAB
</code>,
95 because
<code>TAB
</code> usually has mode-specific tasks.
99 (add-hook 'outline-minor-mode-hook
101 (define-key outline-minor-mode-map [(control tab)] 'org-cycle)
102 (define-key outline-minor-mode-map [(shift tab)] 'org-global-cycle)))
103 (add-hook 'outline-mode-hook
105 (define-key outline-mode-map [(tab)] 'org-cycle)
106 (define-key outline-mode-map [(shift tab)] 'org-global-cycle)))
110 Or check out
<i>outline-magic.el
</i>, which does this and also provides
111 promotion and demotion functionality. @file{outline-magic.el} is
112 available at
<a href=
"http://www.astro.uva.nl/~dominik/Tools/OutlineMagic">Outline Magic
</a>.
117 <div class=
"outline-2">
118 <h2 id=
"sec-4">2 Errors
</h2>
121 <div class=
"outline-3">
122 <h3 id=
"sec-5">2.1 <code>(wrong-type-argument keymapp nil)
</code></h3>
124 <p>When I try to use Org-mode, I always get the error message
125 @code{(wrong-type-argument keymapp nil)} This is a conflict with an
126 outdated version of the
<i>allout.el
</i>.
130 <div class=
"outline-3">
131 <h3 id=
"sec-6">2.2 CUA mode does not work with Org-mode
</h3>
135 %Org-mode takes over the S-cursor keys. I also want to use CUA-mode,
136 is there a way to fix this conflict?%
139 Yes, see the
<i>Conflicts
</i> section of the manual.
144 <div class=
"outline-2">
145 <h2 id=
"sec-7">3 Setup and Structure
</h2>
148 <div class=
"outline-3">
149 <h3 id=
"sec-8">3.1 Org-mode as default mode
</h3>
153 %Org-mode seems to be a useful default mode for the various README
154 files I have scattered through my directories%. %How do I turn it on
155 for all README files?%
158 Add the following to your .emacs file:
162 (add-to-list 'auto-mode-alist '(
"README$" . org-mode))
168 <div class=
"outline-3">
169 <h3 id=
"sec-9">3.2 Get rid of extra stars in outline
</h3>
173 %All these stars are driving me mad, I just find the Emacs outlines
174 unreadable. Can't you just put white space and a single star as a
175 starter for headlines?%
178 See the section
<i>Clean outline view
</i> in the manual.
182 <div class=
"outline-3">
183 <h3 id=
"sec-10">3.3 Two windows on same Org-mode file
</h3>
185 <p>%I would like to have two windows on the same Org-mode file, but with
186 different outline visibility. Is that possible?%
189 In GNU Emacs, you may use
<i>indirect buffers
</i> which do exactly this.
190 See the documentation on the command
<code>make-indirect-buffer
</code>. In
191 XEmacs, this is currently not possible because of the different outline
197 <div class=
"outline-2">
198 <h2 id=
"sec-11">4 Hyperlinks
</h2>
201 <div class=
"outline-3">
202 <h3 id=
"sec-12">4.1 Broken links after Org-mode
4.20</h3>
206 %Some of my links stopped working after I upgraded to a version
4.20
207 or later. Why is this, and how can I fix it?%
210 These must be links in plain text, containing white space, such as
214 bbdb:Richard Stallman
218 You need to protect these links by putting double brackets around
223 [[bbdb:Richard Stallman][bbdb:Richard Stallman]]
228 <div class=
"outline-3">
229 <h3 id=
"sec-13">4.2 Converting links to double-bracket format
</h3>
233 %I see that Org-mode now creates links using the double bracket
234 convention that hides the link part and the brackets, only showing the
235 description part. How can I convert my old links to this new format?%
238 Execute once in each Org-mode file:
<code>M-x org-upgrade-old-links
</code>
239 This replaces angular brackets with the new link format.
243 <div class=
"outline-3">
244 <h3 id=
"sec-14">4.3 Angular bracket links preference
</h3>
248 %I don't care if you find the new bracket links great, I am attached
249 to the old style using angular brackets and no hiding of the link
250 text. Please give them back to me, don't tell me it is not possible!%
253 Would I let you down like that? If you must, you can do this
257 (setq org-link-style 'plain
258 org-link-format
"<%s>")
263 <div class=
"outline-3">
264 <h3 id=
"sec-15">4.4 Confirmation for shell and elips links
</h3>
266 <p>%When I am executing shell/elisp links I always get a confirmation
267 prompt and need to type
<code>yes RET
</code>, that's
4 key presses! Can I get
271 The confirmation is there to protect you from unwantingly execute
272 potentially dangerous commands. For example, imagine a link
274 [[shell:rm -rf ~/*][ Google Search]]
278 In an Org-mode buffer, this command would look like
<i>Google Search
</i>,
279 but really it would remove your home directory. If you wish, you can
280 make it easier to respond to the query by setting
281 <code>org-confirm-shell-link-function
</code> and/or
282 <code>org-confirm-elisp-link-function
</code> to
<code>y-or-n-p
</code>. Then a single yc
283 keypress will be enough to confirm those links. It is also possible
284 to turn off this check entirely, but I do not recommend to do this.
292 <div class=
"outline-2">
293 <h2 id=
"sec-16">5 Export
</h2>
296 <div class=
"outline-3">
297 <h3 id=
"sec-17">5.1 Make TODO entries items, not headlines in HTML export
</h3>
301 %When I export my TODO list, every TODO item becomes a separate
302 section. How do I enforce these items to be exported as an itemized
306 If you plan to use ASCII or HTML export, make sure things you want to
307 be exported as item lists are level
4 at least, even if that does mean
308 there is a level jump. For example:
312 * Todays top priorities
313 **** TODO write a letter to xyz
314 **** TODO Finish the paper
315 **** Pick up kids at the school
319 Alternatively, if you need a specific value for the heading/item
320 transition in a particular file, use the
<code>#+OPTIONS
</code> line to
321 configure the H switch.
330 <div class=
"outline-3">
331 <h3 id=
"sec-18">5.2 Export only a subtree
</h3>
335 %I would like to export only a subtree of my file to HTML. How?%
338 If you want to export a subtree, mark the subtree as region and then
339 export. Marking can be done with
<code>C-c @@ C-x C-x
</code>, for example.
344 <div class=
"outline-2">
345 <h2 id=
"sec-19">6 Tables
</h2>
348 <div class=
"outline-3">
349 <h3 id=
"sec-20">6.1 #ERROR fields in tables
</h3>
353 %One of my table columns has started to fill up with
<code>#ERROR
</code>. What
357 Org-mode tried to compute the column from other fields using a
358 formula stored in the
<code>#+TBLFM:
</code> line just below the table, and
359 the evaluation of the formula fails. Fix the fields used in the
360 formula, or fix the formula, or remove it!
364 <div class=
"outline-3">
365 <h3 id=
"sec-21">6.2 Unwanted new lines in table
</h3>
369 %When I am in the last column of a table and just above a horizontal
370 line in the table, pressing TAB creates a new table line before the
371 horizontal line%. %How can I quickly move to the line below the
372 horizontal line instead?%
375 Press
<code>down
</code> (to get on the separator line) and then
<code>TAB
</code>
376 Or configure the variable
<code>org-table-tab-jumps-over-hlines
</code>.
380 <div class=
"outline-3">
381 <h3 id=
"sec-22">6.3 Change indentation of a table
</h3>
383 <p>%How can I change the indentation of an entire table without fixing
387 The indentation of a table is set by the first line. So just fix the
388 indentation of the first line and realign with
<code>TAB
</code>.
393 <div class=
"outline-2">
394 <h2 id=
"sec-23">7 Agenda
</h2>
397 <div class=
"outline-3">
398 <h3 id=
"sec-24">7.1 Include Org-mode agenda into Emacs diary
</h3>
400 <p>%Is it possible to include entries from org-mode files into my emacs
404 Since the org-mode agenda is much more powerful and can contain the
405 diary, you should think twice
406 before deciding to do this. Integrating Org-mode information into the
407 diary is, however, possible. You need to turn on
<i>fancy diary display
</i> by setting in .emacs:
411 (add-hook 'diary-display-hook 'fancy-diary-display)
415 Then include the following line into your ~/diary file, in
416 order to get the entries from all files listed in the variable
417 <code>org-agenda-files
</code>
423 You may also select specific files with
427 &%%(org-diary) ~/path/to/some/org-file.org
428 &%%(org-diary) ~/path/to/another/org-file.org
432 If you now launch the calendar and press d to display a diary, the
433 headlines of entries containing a timestamp, date range, schedule, or
434 deadline referring to the selected date will be listed. Just like
435 Org-mode's agenda view, the diary for @emph{today} contains additional
436 entries for overdue deadlines and scheduled items. See also the
437 documentation of the @command{org-diary} function. Under XEmacs, it is
438 not possible to jump back from the diary to the org, this works only in
444 <div id=
"postamble"><p class=
"author"> Author: Carsten Dominik
445 <a href=
"mailto:carsten.dominik@gmail.com"><carsten.dominik@gmail.com
></a>
447 <p class=
"date"> Date:
2007/
12/
20 07:
18:
18</p>