450 lines
12 KiB
HTML
450 lines
12 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml"
|
|
lang="en" xml:lang="en">
|
|
<head>
|
|
<title>Org-mode Frequently Asked Questions</title>
|
|
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"/>
|
|
<meta name="generator" content="Org-mode"/>
|
|
<meta name="generated" content="2007/12/20 07:18:18"/>
|
|
<meta name="author" content="Carsten Dominik"/>
|
|
<link rel=stylesheet href="freeshell2.css" type="text/css">
|
|
</head><body>
|
|
<h1 class="title">Org-mode Frequently Asked Questions</h1>
|
|
<div id="table-of-contents">
|
|
<h2>Table of Contents</h2>
|
|
<ul>
|
|
<li><a href="#sec-1">1 General</a>
|
|
<ul>
|
|
<li><a href="#sec-2">1.1 Use features in other modes</a></li>
|
|
<li><a href="#sec-3">1.2 Visibility cycling in Outline-mode and Outline-minor-mode</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#sec-4">2 Errors</a>
|
|
<ul>
|
|
<li><a href="#sec-5">2.1 <code>(wrong-type-argument keymapp nil)</code></a></li>
|
|
<li><a href="#sec-6">2.2 CUA mode does not work with Org-mode</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#sec-7">3 Setup and Structure</a>
|
|
<ul>
|
|
<li><a href="#sec-8">3.1 Org-mode as default mode</a></li>
|
|
<li><a href="#sec-9">3.2 Get rid of extra stars in outline</a></li>
|
|
<li><a href="#sec-10">3.3 Two windows on same Org-mode file</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#sec-11">4 Hyperlinks</a>
|
|
<ul>
|
|
<li><a href="#sec-12">4.1 Broken links after Org-mode 4.20</a></li>
|
|
<li><a href="#sec-13">4.2 Converting links to double-bracket format</a></li>
|
|
<li><a href="#sec-14">4.3 Angular bracket links preference</a></li>
|
|
<li><a href="#sec-15">4.4 Confirmation for shell and elips links</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#sec-16">5 Export</a>
|
|
<ul>
|
|
<li><a href="#sec-17">5.1 Make TODO entries items, not headlines in HTML export</a></li>
|
|
<li><a href="#sec-18">5.2 Export only a subtree</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#sec-19">6 Tables</a>
|
|
<ul>
|
|
<li><a href="#sec-20">6.1 #ERROR fields in tables</a></li>
|
|
<li><a href="#sec-21">6.2 Unwanted new lines in table</a></li>
|
|
<li><a href="#sec-22">6.3 Change indentation of a table</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#sec-23">7 Agenda</a>
|
|
<ul>
|
|
<li><a href="#sec-24">7.1 Include Org-mode agenda into Emacs diary</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="outline-2">
|
|
<h2 id="sec-1">1 General</h2>
|
|
|
|
|
|
<div class="outline-3">
|
|
<h3 id="sec-2">1.1 Use features in other modes</h3>
|
|
|
|
<p><b>I would like to use editing features of org-mode in other modes, is this possible?</b>
|
|
</p>
|
|
<p>
|
|
Not really. For tables there is <code>orgtbl-mode</code> which implements the
|
|
table editor as a minor mode. For other features you need to switch to
|
|
Org-mode temporarily, or prepare text in a different buffer.
|
|
</p>
|
|
|
|
</div>
|
|
|
|
<div class="outline-3">
|
|
<h3 id="sec-3">1.2 Visibility cycling in Outline-mode and Outline-minor-mode</h3>
|
|
|
|
|
|
<p>
|
|
%Can I get the visibility-cycling features in outline-mode and
|
|
outline-minor-mode?%
|
|
</p>
|
|
<p>
|
|
Yes, these functions are written in a way that they are independent of
|
|
the outline setup. The following setup provides standard Org-mode
|
|
functionality in outline-mode on <code>TAB</code> and <code>S-TAB</code>. For
|
|
outline-minor-mode, we use <code>C-TAB</code> instead of <code>TAB</code>,
|
|
because <code>TAB</code> usually has mode-specific tasks.
|
|
</p>
|
|
<p>
|
|
<pre>
|
|
(add-hook 'outline-minor-mode-hook
|
|
(lambda ()
|
|
(define-key outline-minor-mode-map [(control tab)] 'org-cycle)
|
|
(define-key outline-minor-mode-map [(shift tab)] 'org-global-cycle)))
|
|
(add-hook 'outline-mode-hook
|
|
(lambda ()
|
|
(define-key outline-mode-map [(tab)] 'org-cycle)
|
|
(define-key outline-mode-map [(shift tab)] 'org-global-cycle)))
|
|
</pre>
|
|
</p>
|
|
<p>
|
|
Or check out <i>outline-magic.el</i>, which does this and also provides
|
|
promotion and demotion functionality. @file{outline-magic.el} is
|
|
available at <a href="http://www.astro.uva.nl/~dominik/Tools/OutlineMagic">Outline Magic</a>.
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="outline-2">
|
|
<h2 id="sec-4">2 Errors</h2>
|
|
|
|
|
|
<div class="outline-3">
|
|
<h3 id="sec-5">2.1 <code>(wrong-type-argument keymapp nil)</code></h3>
|
|
|
|
<p>When I try to use Org-mode, I always get the error message
|
|
@code{(wrong-type-argument keymapp nil)} This is a conflict with an
|
|
outdated version of the <i>allout.el</i>.
|
|
</p>
|
|
</div>
|
|
|
|
<div class="outline-3">
|
|
<h3 id="sec-6">2.2 CUA mode does not work with Org-mode</h3>
|
|
|
|
|
|
<p>
|
|
%Org-mode takes over the S-cursor keys. I also want to use CUA-mode,
|
|
is there a way to fix this conflict?%
|
|
</p>
|
|
<p>
|
|
Yes, see the <i>Conflicts</i> section of the manual.
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="outline-2">
|
|
<h2 id="sec-7">3 Setup and Structure</h2>
|
|
|
|
|
|
<div class="outline-3">
|
|
<h3 id="sec-8">3.1 Org-mode as default mode</h3>
|
|
|
|
|
|
<p>
|
|
%Org-mode seems to be a useful default mode for the various README
|
|
files I have scattered through my directories%. %How do I turn it on
|
|
for all README files?%
|
|
</p>
|
|
<p>
|
|
Add the following to your .emacs file:
|
|
</p>
|
|
<p>
|
|
<pre>
|
|
(add-to-list 'auto-mode-alist '("README$" . org-mode))
|
|
</pre>
|
|
</p>
|
|
|
|
</div>
|
|
|
|
<div class="outline-3">
|
|
<h3 id="sec-9">3.2 Get rid of extra stars in outline</h3>
|
|
|
|
|
|
<p>
|
|
%All these stars are driving me mad, I just find the Emacs outlines
|
|
unreadable. Can't you just put white space and a single star as a
|
|
starter for headlines?%
|
|
</p>
|
|
<p>
|
|
See the section <i>Clean outline view</i> in the manual.
|
|
</p>
|
|
</div>
|
|
|
|
<div class="outline-3">
|
|
<h3 id="sec-10">3.3 Two windows on same Org-mode file</h3>
|
|
|
|
<p>%I would like to have two windows on the same Org-mode file, but with
|
|
different outline visibility. Is that possible?%
|
|
</p>
|
|
<p>
|
|
In GNU Emacs, you may use <i>indirect buffers</i> which do exactly this.
|
|
See the documentation on the command <code>make-indirect-buffer</code>. In
|
|
XEmacs, this is currently not possible because of the different outline
|
|
implementation.
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="outline-2">
|
|
<h2 id="sec-11">4 Hyperlinks</h2>
|
|
|
|
|
|
<div class="outline-3">
|
|
<h3 id="sec-12">4.1 Broken links after Org-mode 4.20</h3>
|
|
|
|
|
|
<p>
|
|
%Some of my links stopped working after I upgraded to a version 4.20
|
|
or later. Why is this, and how can I fix it?%
|
|
</p>
|
|
<p>
|
|
These must be links in plain text, containing white space, such as
|
|
</p>
|
|
<p>
|
|
<pre>
|
|
bbdb:Richard Stallman
|
|
</pre>
|
|
</p>
|
|
<p>
|
|
You need to protect these links by putting double brackets around
|
|
them, like
|
|
</p>
|
|
<p>
|
|
<pre>
|
|
[[bbdb:Richard Stallman][bbdb:Richard Stallman]]
|
|
</pre>
|
|
</p>
|
|
</div>
|
|
|
|
<div class="outline-3">
|
|
<h3 id="sec-13">4.2 Converting links to double-bracket format</h3>
|
|
|
|
|
|
<p>
|
|
%I see that Org-mode now creates links using the double bracket
|
|
convention that hides the link part and the brackets, only showing the
|
|
description part. How can I convert my old links to this new format?%
|
|
</p>
|
|
<p>
|
|
Execute once in each Org-mode file: <code>M-x org-upgrade-old-links</code>
|
|
This replaces angular brackets with the new link format.
|
|
</p>
|
|
</div>
|
|
|
|
<div class="outline-3">
|
|
<h3 id="sec-14">4.3 Angular bracket links preference</h3>
|
|
|
|
|
|
<p>
|
|
%I don't care if you find the new bracket links great, I am attached
|
|
to the old style using angular brackets and no hiding of the link
|
|
text. Please give them back to me, don't tell me it is not possible!%
|
|
</p>
|
|
<p>
|
|
Would I let you down like that? If you must, you can do this
|
|
</p>
|
|
<p>
|
|
<pre>
|
|
(setq org-link-style 'plain
|
|
org-link-format "<%s>")
|
|
</pre>
|
|
</p>
|
|
</div>
|
|
|
|
<div class="outline-3">
|
|
<h3 id="sec-15">4.4 Confirmation for shell and elips links</h3>
|
|
|
|
<p>%When I am executing shell/elisp links I always get a confirmation
|
|
prompt and need to type <code>yes RET</code>, that's 4 key presses! Can I get
|
|
rid of this?%
|
|
</p>
|
|
<p>
|
|
The confirmation is there to protect you from unwantingly execute
|
|
potentially dangerous commands. For example, imagine a link
|
|
<pre>
|
|
[[shell:rm -rf ~/*][ Google Search]]
|
|
</pre>
|
|
</p>
|
|
<p>
|
|
In an Org-mode buffer, this command would look like <i>Google Search</i>,
|
|
but really it would remove your home directory. If you wish, you can
|
|
make it easier to respond to the query by setting
|
|
<code>org-confirm-shell-link-function</code> and/or
|
|
<code>org-confirm-elisp-link-function</code> to <code>y-or-n-p</code>. Then a single yc
|
|
keypress will be enough to confirm those links. It is also possible
|
|
to turn off this check entirely, but I do not recommend to do this.
|
|
Be warned.
|
|
</p>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="outline-2">
|
|
<h2 id="sec-16">5 Export</h2>
|
|
|
|
|
|
<div class="outline-3">
|
|
<h3 id="sec-17">5.1 Make TODO entries items, not headlines in HTML export</h3>
|
|
|
|
|
|
<p>
|
|
%When I export my TODO list, every TODO item becomes a separate
|
|
section. How do I enforce these items to be exported as an itemized
|
|
list?%
|
|
</p>
|
|
<p>
|
|
If you plan to use ASCII or HTML export, make sure things you want to
|
|
be exported as item lists are level 4 at least, even if that does mean
|
|
there is a level jump. For example:
|
|
</p>
|
|
<p>
|
|
<pre>
|
|
* Todays top priorities
|
|
**** TODO write a letter to xyz
|
|
**** TODO Finish the paper
|
|
**** Pick up kids at the school
|
|
</pre>
|
|
</p>
|
|
<p>
|
|
Alternatively, if you need a specific value for the heading/item
|
|
transition in a particular file, use the <code>#+OPTIONS</code> line to
|
|
configure the H switch.
|
|
</p>
|
|
<p>
|
|
<pre>
|
|
#+OPTIONS: H:2; ...
|
|
</pre>
|
|
</p>
|
|
</div>
|
|
|
|
<div class="outline-3">
|
|
<h3 id="sec-18">5.2 Export only a subtree</h3>
|
|
|
|
|
|
<p>
|
|
%I would like to export only a subtree of my file to HTML. How?%
|
|
</p>
|
|
<p>
|
|
If you want to export a subtree, mark the subtree as region and then
|
|
export. Marking can be done with <code>C-c @@ C-x C-x</code>, for example.
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="outline-2">
|
|
<h2 id="sec-19">6 Tables</h2>
|
|
|
|
|
|
<div class="outline-3">
|
|
<h3 id="sec-20">6.1 #ERROR fields in tables</h3>
|
|
|
|
|
|
<p>
|
|
%One of my table columns has started to fill up with <code>#ERROR</code>. What
|
|
is going on?%
|
|
</p>
|
|
<p>
|
|
Org-mode tried to compute the column from other fields using a
|
|
formula stored in the <code>#+TBLFM:</code> line just below the table, and
|
|
the evaluation of the formula fails. Fix the fields used in the
|
|
formula, or fix the formula, or remove it!
|
|
</p>
|
|
</div>
|
|
|
|
<div class="outline-3">
|
|
<h3 id="sec-21">6.2 Unwanted new lines in table</h3>
|
|
|
|
|
|
<p>
|
|
%When I am in the last column of a table and just above a horizontal
|
|
line in the table, pressing TAB creates a new table line before the
|
|
horizontal line%. %How can I quickly move to the line below the
|
|
horizontal line instead?%
|
|
</p>
|
|
<p>
|
|
Press <code>down</code> (to get on the separator line) and then <code>TAB</code>
|
|
Or configure the variable <code>org-table-tab-jumps-over-hlines</code>.
|
|
</p>
|
|
</div>
|
|
|
|
<div class="outline-3">
|
|
<h3 id="sec-22">6.3 Change indentation of a table</h3>
|
|
|
|
<p>%How can I change the indentation of an entire table without fixing
|
|
every line by hand?%
|
|
</p>
|
|
<p>
|
|
The indentation of a table is set by the first line. So just fix the
|
|
indentation of the first line and realign with <code>TAB</code>.
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="outline-2">
|
|
<h2 id="sec-23">7 Agenda</h2>
|
|
|
|
|
|
<div class="outline-3">
|
|
<h3 id="sec-24">7.1 Include Org-mode agenda into Emacs diary</h3>
|
|
|
|
<p>%Is it possible to include entries from org-mode files into my emacs
|
|
diary?%
|
|
</p>
|
|
<p>
|
|
Since the org-mode agenda is much more powerful and can contain the
|
|
diary, you should think twice
|
|
before deciding to do this. Integrating Org-mode information into the
|
|
diary is, however, possible. You need to turn on <i>fancy diary display</i> by setting in .emacs:
|
|
</p>
|
|
<p>
|
|
<pre>
|
|
(add-hook 'diary-display-hook 'fancy-diary-display)
|
|
</pre>
|
|
</p>
|
|
<p>
|
|
Then include the following line into your ~/diary file, in
|
|
order to get the entries from all files listed in the variable
|
|
<code>org-agenda-files</code>
|
|
</p>
|
|
<p>
|
|
<pre>
|
|
&%%(org-diary)
|
|
</pre>
|
|
You may also select specific files with
|
|
</p>
|
|
<p>
|
|
<pre>
|
|
&%%(org-diary) ~/path/to/some/org-file.org
|
|
&%%(org-diary) ~/path/to/another/org-file.org
|
|
</pre>
|
|
</p>
|
|
<p>
|
|
If you now launch the calendar and press d to display a diary, the
|
|
headlines of entries containing a timestamp, date range, schedule, or
|
|
deadline referring to the selected date will be listed. Just like
|
|
Org-mode's agenda view, the diary for @emph{today} contains additional
|
|
entries for overdue deadlines and scheduled items. See also the
|
|
documentation of the @command{org-diary} function. Under XEmacs, it is
|
|
not possible to jump back from the diary to the org, this works only in
|
|
the agenda buffer.
|
|
</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div id="postamble"><p class="author"> Author: Carsten Dominik
|
|
<a href="mailto:carsten.dominik@gmail.com"><carsten.dominik@gmail.com></a>
|
|
</p>
|
|
<p class="date"> Date: 2007/12/20 07:18:18</p>
|
|
</div></body>
|
|
</html>
|