Quick notes on switching to the new exporter
[worg.git] / org-faq.org
1 #+EMAIL:     mdl AT imapmail DOT org
2 #+AUTHOR:    Worg people
3 #+LANGUAGE:  en
4 #+TITLE:     Org-mode Frequently Asked Questions
5 #+OPTIONS:   toc:t H:2
6 #+SETUPFILE: macros.setupfile
7
8 [[file:index.org][{Back to Worg's index}]]
9
10 * Latest questions on StackOverflow
11
12 #+index: StackOverflow
13
14 #+begin_html
15 <script language="JavaScript" src="http://feed2js.org//feed2js.php?src=http%3A%2F%2Fstackoverflow.com%2Ffeeds%2Ftag%3Ftagnames%3Dorg-mode%26sort%3Dnewest&chan=title&num=5&utf=y"  charset="UTF-8" type="text/javascript"></script>
16
17 <noscript>
18 <a href="http://feed2js.org//feed2js.php?src=http%3A%2F%2Fstackoverflow.com%2Ffeeds%2Ftag%3Ftagnames%3Dorg-mode%26sort%3Dnewest&chan=title&num=5&utf=y&html=y">View RSS feed</a>
19 </noscript>
20 #+end_html
21
22 * What is org-mode?
23   :PROPERTIES:
24   :CUSTOM_ID: What-is-org-mode
25   :END:
26 ** Can Org-mode do "x"? Does org have "x" feature?
27    :PROPERTIES:
28    :CUSTOM_ID: can-org-do-x
29    :END:
30
31 In its default setup, Org-mode offers a simple outlining and task
32 management environment. But it also has a huge number of features and
33 settings "under the hood." Advanced users have configured Org-mode for
34 almost every conceivable use scenario.
35
36 Org-mode has a very active community and rich and extensive
37 documentation. Before emailing the mailing list to ask whether
38 Org-mode has a particular feature or setting, please consult the
39 following:
40
41  - Read/search the manual.
42
43    - http://orgmode.org/manual/index.html
44
45      - Make sure to check out the following indexes:
46
47        - [[http://orgmode.org/manual/Main-Index.html#Main-Index][Main Index]]
48        - [[http://orgmode.org/manual/Key-Index.html#Key-Index][Key Index]]
49        - [[http://orgmode.org/manual/Variable-Index.html#Variable-Index][Variable Index]]
50
51    - The manual is also easily available from within emacs.
52
53      To read the manual within emacs, you can evaluate =(info
54      "(org)")= within emacs---i.e., type =C-x C-e= after the closing
55      paragraph of the info expression above.
56
57      You can also type =M-x info= and navigate to "Org Mode".
58
59      You can search the entire manual by typing ~C-s term~. Keep
60      pressing ~C-s~ to cycle through the results
61
62  - Search the [[http://dir.gmane.org/gmane.emacs.orgmode][mailing list archives]].
63
64    There is a good chance that the feature you are looking for has
65    already been discussed (most likely several times).
66
67  - Check for features from within emacs.
68
69    - Emacs has a wonderful built-in help system.
70
71    - You can browse (and change) most customization options by typing
72      =M-x org-customize=.
73
74    - You can check for a feature by typing =M-x apropos [RET] [word]= or
75      =C-h a word=. This will search for all functions and variables
76      matching the term (or regexp) you enter.
77
78    - You can browse (and search for) org functions, variables, and
79      faces by using =M-x describe-variable= (=C-h v=), =M-x
80      describe-function= (=C-h f=), or =M-x describe-face=.
81
82      After invoking one of these commands, simply type =org-[TAB]= to
83      see a full list of relevant functions or variables or faces. You
84      can then drill down further: e.g., =org-export-[TAB]= for export
85      features.
86
87  - Checkout the [[file:org-tutorials/index.org][tutorials on Worg]].
88
89    Several of these tutorials discuss advanced features (e.g.,
90    searching, custom agenda commands, tables, publishing) of Org-mode
91    in depth.
92
93    There are many other resources on Worg as well:
94
95    - [[http://orgmode.org/worg/org-configs/index.html][Org Customization]] :: Includes a guide for beginners.
96
97    - [[http://orgmode.org/worg/org-hacks.html][Org Hacks]] :: User-generated modifications and add-ons.
98
99    - [[http://orgmode.org/worg/org-glossary.html][Org Glossary]] :: An explanation of basic Org-mode terms and
100                      concepts.
101
102 ** Can I implement a GTD workflow with Org-mode?
103    :PROPERTIES:
104    :CUSTOM_ID: GTD-workflow-with-Org-mode
105    :END:
106    
107 #+index: GTD!Workflow
108
109    Yes, you can.  Check for discussions and pointers [[http://orgmode.org/worg/org-gtd-etc.html][here]].
110
111 ** What is the difference between Org and TaskPaper?
112    :PROPERTIES:
113    :CUSTOM_ID: Org-and-TaskPaper
114    :END:
115
116 #+index: TaskPaper
117
118   There is really no difference.  Org is as /simple/ as [[http://hogbaysoftware.com/products/taskpaper][TaskPaper]].  It
119   is just that, when using Org within Emacs, it lets you do many things
120   that you wouldn't be able to do with TaskPaper.  Yes, TaskPaper is
121   fiddle-proof and people using Emacs tends to like fiddling (which is
122   orthogonal to the idea of using todo-lists efficiently), but this is
123   just a matter of discipline and common sense, not one of Org's design.
124
125   Read [[http://article.gmane.org/gmane.emacs.orgmode/6224][Carsten's enlightening statement]] on this.
126 ** What is the meaning of the Unicorn on Org's website?
127    :PROPERTIES:
128    :CUSTOM_ID: unicorn
129    :END:
130
131 #+index: Unicorn
132
133 The Unicorn is the logo of Org-mode because:
134
135 - Org-mode is the UNICs of ORgaNizers.
136
137 - Org-mode is an Emacs mode, so it makes sense to use an animal
138   similar or related to the gnu used for GNU Emacs.
139
140 - Org-mode is meant to show you the way, and an animal with two horns
141   can not do this very well, can it?
142
143 - Unicorn tears are said to reverse petrification, and wasn't this how
144   we all felt before getting to some degree of time and task
145   management?
146
147 - It will take forever to learn everything there is to know about a
148   unicorn.
149
150 - A unicorn is a fabulous creature.  Org-mode wants to be a fabulous
151   creation.
152
153 Using a unicorn was originally /Bastien Guerry's/ idea.  His friend,
154 the french artist [[http://intemperies.over-blog.com/][Christophe Bataillon]], designed the logo for us, and
155 /Greg Newman/ gave it a refresh some time later.  Bastien writes why
156 he chose a unicorn:
157
158 #+BEGIN_QUOTE
159 The first reason is not linked to the animal, but to the sounding of the
160 word "Unicorn" - because Org gives you a /uni/que way of producing files
161 in several format (HTML, LaTeX, etc.).
162
163 The second reason is that a Unicorn doesn't really exist, it is just
164 something you can dream about, and make others believe it does exist.
165 Just like the perfect organizer.
166 #+END_QUOTE
167
168 There was a [[http://thread.gmane.org/gmane.emacs.orgmode/11641/focus%3D11641][thread about unicorns]] on the mailing list.  [[http://thread.gmane.org/gmane.emacs.orgmode/11641/focus%3D11641][Christopher
169 Suckling]] posted a link showing how to make a simple foldable unicorn
170 (very appropriate for an outlining program!).
171
172 [[http://article.gmane.org/gmane.emacs.orgmode/11735][Tim Burt]] made a very complicated one which is now a treasured
173 possession of the Org-mode author.
174
175 - Official logo: [[http://orgmode.org/img/org-mode-unicorn.png]]
176   This logo is available in a number of different formats including
177   Photoshop /.psd/ and scaleable vector graphics /.svg/ [[http://orgmode.org/img/][here]].
178
179 - An [[http://orgmode.org/img/nrocinu4.jpg][alternative version]] from Christophe Bataillon (c):
180
181 - [[http://article.gmane.org/gmane.emacs.orgmode/14293][Chris Randle]] made a [[http://orgmode.org/img/nrocinu.txt][text version]] using the logo and [[http://glassgiant.com][glassgiant.com]]:
182
183 - [[http://article.gmane.org/gmane.emacs.orgmode/14362][Stefan Vollmar]] made a [[http://orgmode.org/img/nrocinu.pdf][pdf version]] (here in [[http://orgmode.org/img/nrocinu_pdf.png][png]]) using "a simple
184   threshold technique".
185
186 - [[http://article.gmane.org/gmane.emacs.orgmode/11735/match%3D][Tim Burt]] made a folded Unicorn to match the spirit of Org - see the
187   whole set of pictures [[http://www.flickr.com/photos/tcburt/sets/72157614543357071/][on his flickr page]].
188
189 - Are unicorns real?  Answer [[http://article.gmane.org/gmane.emacs.orgmode/11687/match%3Drosslaird%2Bunicorn][here]] by Ross Laird.
190
191 ** Is Org's documentation written in Org?
192
193 No.  Org's documentation is written in TeXinfo, which is the standard
194 format for Emacs documentation.  There is no export mechanism from Org
195 to TeXinfo (yet).
196
197 ** Is there a bibtex entry for the Org manual?
198
199 Yes.  Please evaluate this function and run =M-x
200 org-insert-manual-bibtex-citation-at-point RET=.
201
202 #+begin_src emacs-lisp
203 (defun org-insert-manual-bibtex-citation-at-point ()
204   "Insert a BibTeX citation of the Org manual at point."
205   (interactive)
206   (insert
207   "@book{dominik10:_org_mode_refer_manual,
208   author =       {Carsten Dominik},
209   title =        {The Org-Mode 7 Reference Manual: Organize
210                   Your Life with GNU Emacs},
211   publisher =    {Network Theory},
212   year =         2010,
213   address =      {UK},
214   note =         {with contributions by David O'Toole, Bastien Guerry,
215                   Philip Rooke, Dan Davison, Eric Schulte, and Thomas
216                   Dye}
217 }"
218   (message "Thanks for quoting the Org manual!")))
219 #+end_src
220
221 Please check [[file:org-papers.org][the Org papers page]] for more references related to Org.
222
223 * Mailing list
224 ** I think my Org-mode is broken! How do I report a bug?
225    :PROPERTIES:
226    :CUSTOM_ID: bug-reporting
227    :END:
228
229 #+index: Bug!Report
230
231  1. Make sure you are running [[#updating-org][the latest version of Org-mode]].
232
233  2. Read [[http://orgmode.org/manual/Feedback.html][this section]] of the manual.
234
235  3. Provide a minimal example that duplicates the bug.
236
237     - Create a minimal .emacs file and start emacs with that file as
238       detailed in [[#minimal-emacs][these instructions]].
239
240     - Create a sample, minimal .org file that reliably reproduces the
241       problem and post it to the mailing list.
242
243       - Some users call this an "[[#ecm][ECM]]", a French acronym that means a
244         "minimal complete example".
245
246 ** What is an "ECM"?
247    :PROPERTIES:
248    :CUSTOM_ID: ecm
249    :END:
250
251 #+index: ECM
252
253 This is a French acronym used by some mailing list members; it stands
254 for "Exemple Complet Minimal", or "Complete Minimal Example". The term
255 refers to test files that can reliably reproduce a bug with the
256 minimal amount of code. When you report a bug to the mailing list, you
257 should provide a minimal .org file (with no more text than necessary)
258 that demonstrates the bug. See [[http://permalink.gmane.org/gmane.emacs.orgmode/41281][this post]] for more information.
259
260 ** What should I do before contacting the mailing list?
261    :PROPERTIES:
262    :CUSTOM_ID: when-to-contact-mailing-list
263    :END:
264
265    The Org-mode mailing list is a high volume list, in which community
266    members discuss use cases, configuration, bugs, and developments.
267
268    If you are new to Org-mode, please read/search the excellent [[http://orgmode.org/manual/index.html][manual]]
269    (and pay special attention to the indexes) before asking your
270    question.
271
272    You should also [[http://dir.gmane.org/gmane.emacs.orgmode][search the mailing list]] to see if your issue has
273    already been discussed.
274
275    See [[#can-org-do-x][this faq]] for more details.
276
277 ** Why hasn't my email to the mailing list shown up yet?
278    :PROPERTIES:
279    :CUSTOM_ID: ml-post-delay
280    :END:
281
282 The org-mode mailing list is moderated. Thus, if you are not
283 subscribed to the mailing list, your mail will only appear on the list
284 after it has been approved by a moderator. To ensure that your mail
285 appears quickly, please [[http://lists.gnu.org/mailman/listinfo/emacs-orgmode][subscribe to the list]].
286
287 ** I read the mailing list through gmane. Should I subscribe?
288    :PROPERTIES:
289    :CUSTOM_ID: ml-subscription-and-gmane
290    :END:
291
292 #+index: Gmane
293
294 The org-mode mailing list is available via nntp at [[http://dir.gmane.org/gmane.emacs.orgmode][Gmane]]. Many
295 participants in the list prefer read the list in a newsreader, such as
296 Gnus, instead of receiving emails. If you choose to read the list via
297 nntp, you can still [[http://lists.gnu.org/mailman/listinfo/emacs-orgmode][subscribe]] to the list and then opt not to receive
298 any emails on the mailman settings page (see the "Mail Delivery"
299 setting).
300
301 This will ensure that your messages to the list get through quickly,
302 reduce the work load of the mailing list moderators (who need to clear
303 every mail from non-members), and provide more accurate information
304 about the number of list readers.
305
306 * Keeping current
307   :PROPERTIES:
308   :CUSTOM_ID: Keeping-current
309   :END:
310 ** Switching to the new export engine
311    :PROPERTIES:
312    :CUSTOM_ID: new-exporter-switch
313    :END:
314
315 #+index: Upgrade
316
317 Some quick notes on how to switch to the new exporter.
318
319 1. Export engine renamed: org-export → ox
320 2. Backend requires renamed: org-e-* → ox-*
321 3. All backend specific variables and functions renamed:
322    - org-export-* → org-* (e.g. org-html-xml-declaration, ..)
323    - org-e-* → org-* (e.g. org-latex-classes, org-ascii-bullets, ..)
324 4. Generic export variables retain the name org-export-*
325    (e.g. org-export-dispatch-use-expert-ui,
326    org-export-filter-headline-functions, ..)
327 5. org-latex-to-pdf-process has been renamed to org-latex-pdf-process
328 7. This is a guess, export snippets and backend symbols renamed:
329    - e-<backend> → <backend>
330
331 Please also read [[http://mid.gmane.org/876229nrxf.fsf@gmail.com][Nicolas' announcement]] about the merge.
332
333 ** My Emacs ships with an older version Org-mode! How do I upgrade?
334    :PROPERTIES:
335    :CUSTOM_ID: updating-org
336    :END:
337
338 #+index: Upgrade
339
340 Org-mode develops quickly, which means that versions of Org-mode
341 shipped with Emacs are more or less out-of-date. If you'd like to
342 upgrade to the most recent version of org-mode, you have a number of
343 options.
344
345  1. Download the [[http://orgmode.org/index.html#sec-3][most recent release]] of org-mode as zip or tarball and
346     follow the [[http://orgmode.org/manual/Installation.html#Installation][installation instructions]] in the manual.
347  2. Clone and install the development git repository as [[#keeping-current-with-Org-mode-development][explained
348     here]]. If you don't want to run the bleeding edge, you can still
349     use git [[#using-stable-releases-only][to track the most recent stable releases]].
350  3. Install and updated org-mode automatically through the Emacs
351     Package Manager as [[#installing-via-elpa][explained in this FAQ]].
352
353 /Note/: Please also see [[#mixed-install][Is my Orgmode installation mixed?]] for a common
354 issue with mixed installations.
355
356 ** How do I keep current with bleeding edge development?
357    :PROPERTIES:
358    :CUSTOM_ID: keeping-current-with-Org-mode-development
359    :END:
360
361 #+index: Bleeding Edge
362
363    Org-mode is developed in [[http://en.wikipedia.org/wiki/Git_(software)][Git]]. You can keep up-to-date with Org-mode
364    developement by cloning the Org-mode repository and refreshing your
365    copy with latest changes whenever you wish. You only need to use
366    two Git commands (clone and pull.) Here are the steps in brief
367    (assuming a POSIX compatible shell and please customize locations
368    to suit your setup):
369
370    1. Select a location to house the Org-mode repository (approx. 40
371       MB; includes documentation, compiled elisp files and history
372       going all the way back to v4.12a)
373
374       : $ mkdir $HOME/elisp && cd $HOME/elisp
375
376    2. Clone the Org-mode Git repository.
377
378       Recommended approach:
379
380       : $ git clone git://orgmode.org/org-mode.git
381
382       You can also clone from this mirror (lagging one hour behind
383       orgmode.org repo):
384
385       : $ git clone git://repo.or.cz/org-mode.git
386
387       For those of you behind a firewall that allows only HTTP, you can
388       clone like this (can be somewhat slow), either from orgmode.org or
389       from repo.or.cz:
390
391       : $ git clone http://orgmode.org/org-mode.git
392       : $ git clone http://repo.or.cz/r/org-mode.git
393
394    3. Compile and install Org-mode and build documentation.
395
396       : $ cd $HOME/elisp/org-mode && make
397
398       Please note that you can choose to /not/ compile at all and run
399       using source =.el= files only (compiled files speed things up),
400       but you will still need to generate the autoload files.
401
402       : $ cd $HOME/elisp/org-mode && make uncompiled
403
404       If you'd like to install org-mode someplace outside the source
405       tree (private or system-wide), you should edit =local.mk= to
406       point to the appropriate install location.  You may need
407       administrator rights to do a system-wide installation.
408
409       : $ cd $HOME/elisp/org-mode && make install
410
411    4. This is where you configure Org-mode with Emacs.  Please refer
412       to [[./org-tutorials/index.org][Org tutorials]].
413
414    5. Keeping up-to-date.
415
416       Cloning the repository is a one time activity.  From this point
417       onwards you only need to /pull/ the latest changes, which the
418       Makefile is set up to do automatically for certain make targets.
419
420       : $ cd $HOME/elisp/org-mode && make update
421
422       or if you immediately want to install as well
423
424       : $ cd $HOME/elisp/org-mode && make update2
425
426       Actually in this case it is recommended to run the test suite
427       before installation so that you don't install a version that
428       fails testing.
429
430       : $ cd $HOME/elisp/org-mode && make up2
431
432    6. You should reload Org-mode to have the changes take effect (if
433       you are not restarting Emacs, which is recommended).  Also since
434       the intention is to "keep up" with Org-mode, you should visit
435       updated sections of documentation for latest updates (use =git
436       log=.)
437
438    7. As you use your repository over time it will accumulate loose objects.
439       You can reduce the total size of your git repository with
440
441       : $ git gc
442
443       which will consolidate loose git objects into pack files.  This
444       reduces the size of the repository and speeds up data access to
445       the objects.
446
447 ** How do I update the info manual pages to the latest org-mode version?
448    :PROPERTIES:
449    :CUSTOM_ID: update-info-manual-to-latest
450    :END:
451
452    *This is not a problem if org-mode is installed system-wide, which
453    automatically takes care of this issue!* Since org-mode already
454    ships with Emacs, a rather common problem among users is "How do I
455    update the info documentation to the latest version of org-mode?".
456    There are three ways to achieve this if for whatever reason you
457    can't install into the standard, system-wide info directory:
458
459    1. You can set the =INFOPATH= environment variable in your login
460       script like this:
461
462       #+begin_src shell-script :eval no
463         # ~/.bash_profile
464         export INFOPATH=/path/to/org-mode/info:$INFOPATH
465         ...
466       #+end_src
467
468       =/path/to/org-mode/info= is wherever you install org-mode.
469
470    2. You can achieve the same with elisp like this:
471
472       #+begin_src emacs-lisp :eval no
473         ;; Info directory
474         (add-to-list 'Info-additional-directory-list
475                      (expand-file-name "/path/to/org-mode/info"))
476       #+end_src
477
478    3. You should specify the same location in the Makefile while
479       installing org-mode like this:
480
481       #+begin_src makefile-gmake :eval no
482         # Where local software is found
483         prefix=/path/to/emacs-root
484         ...
485         # Where info files go.
486         infodir = $(prefix)/share/info
487       #+end_src
488
489 ** How can I keep local changes and still track Org-mode development?
490    :PROPERTIES:
491    :CUSTOM_ID: keeping-local-changes-current-with-Org-mode-development
492    :END:
493
494   There is no need to do this anymore for the purpose of adapting the
495   build system to the local environment, since this can now be
496   specified in =local.mk=.  However, there may be a need to make other
497   local changes to Org.
498
499   Say you want to make minor changes to the =org.el= or any other
500   version controlled file from Org and you want to keep these changes
501   on top of the =master= branch from Org.  Create a local branch for
502   your changes on top of origin/master as follows:
503
504   : $ git checkout -b local origin/master
505   : $ git config branch.local.rebase true
506   : # Make your changes to the sources and create a new commit
507   : $ git commit -am 'My local changes to Org'
508   : # Update to a newer version
509   : $ git pull
510
511   Now each time you pull new commits from the distribution repository
512   your local commits will be rewound and replayed on top of the new
513   origin/master.  You would normally work on your =local= branch which
514   includes your custom commits; there's no need to switch back to the
515   =master= branch.
516
517   If you get a conflict during a =git pull= (a change in Org and one
518   of your local changes try to alter the same line of code) you will
519   need to edit the file with the conflict to fix up the conflicting
520   lines and then tell git that you have resolved the conflict:
521
522   1. =git pull= fails with a conflict
523   2. edit the file: look for the conflict markers =>>>>>>>= and
524      =<<<<<<<= and either keep one version or create a new one and
525      remove all conflict markers while doing this.
526   3. =git add= the file to the index to mark the conflict resolved
527   4. =git rebase --continue=
528   5. lather, rinse, and repeat 2-4 as needed
529
530   Note that it is possible to have silent conflicts when a change in
531   Org and one of your local changes do not edit the same line of code,
532   but are logically incompatible — for example Org might have changed
533   to assume /roses are red/ while you've made a local change that
534   defines /my roses are yellow/ in some other place.  Git will not
535   warn you about such conflicts (it doesn't understand what the code
536   _does_, of course).
537
538   At anytime during the rebase conflict resolution you can say "oops
539   this is all wrong - put it back the way it was before I did a pull"
540   using
541 : $ git rebase --abort
542
543 ** How can I use a stable release version instead of the bleeding edge master?
544    :PROPERTIES:
545    :CUSTOM_ID: using-stable-releases-only
546    :END:
547
548 The =master= branch of the git repository always contains the bleeding
549 edge development code.  This is important for Org's fast development,
550 because code on master gets checked out by many people daily and we
551 quickly receive bug reports if something is wrong.  On rare occasions,
552 this code may not function perfectly for a limited time while we are
553 trying to fix things.  It is therefore recommended to keep a
554 known-good version of org-mode installed outside the source tree and
555 always run the full test suite before using a new version from master.
556
557 Not everyone like to use this bleeding-edge code and face the danger
558 to hit a surprising bug.  The branch =maint= is specifically for
559 collecting only fixes for known bugs between releases.  If you don't
560 want to wait for a new release, but don't want to live on the bleeding
561 edge, consider using =maint=.
562
563 From time to time, we make a release by merging all the new features
564 from =master= into =maint=.  This typically happens when the
565 maintainers feel that
566
567 1. they have reached a good point in the development
568 2. the code has a feature set that should stay and be supported in the
569    future
570
571 Stable releases are used as the basis for [[http://orgmode.org/index.html#sec-3_3][alternative distributions]] of
572 Org, and they are also the code that gets merged into the Emacs
573 distribution. If you want to work only with stable releases, you can
574 always download [[http://orgmode.org/index.html#sec-3][them here]], but you can also also use the git
575 repository to keep automatically up-to-date with the most recent
576 stable releases (and save bandwidth!). Here's how to do so:
577
578 *** Run a specific stable release
579
580 In the repository, do
581
582 : $ git fetch --tags
583 : $ git tag
584
585 To see which release tags are available.  Let's say you decide to use
586 =release_7.01f=.
587
588 : $ git checkout release_7.01f
589
590 This set the working tree of the repository to the state of Org at the
591 moment of release 7.01f.  You can then run Org from the repository be
592 sure to use the stable release while development continues on the
593 master branch.
594
595 Later, when we release 7.02, you can switch to that using
596
597 : $ git fetch --tags                   # to get all the new stuff
598 : $ git tag
599 : $ git checkout release_7.02
600
601 *** Always run the most recent stable release
602
603 Alternatively, if you just want to always run whatever the latest
604 stable release is, you can do
605
606 : $ git checkout -b stable origin/maint
607
608 and then regularly update this branch by doing
609
610 : $ git pull
611
612 ** How can I install an up-to-date version of org-mode without "make" tools?
613    :PROPERTIES:
614    :CUSTOM_ID: installing-org-without-make-tools
615    :END:
616
617 If you are using org-mode on a computer that lacks developer tools for
618 compiling software, such as [[http://www.gnu.org/software/make/][GNU Make]], you will have to use a
619 *different* installation method than [[http://orgmode.org/manual/Installation.html#Installation][the one outlined in the manual]].
620 Please see this description for [[http://orgmode.org/worg/org-hacks.html#compiling-org-without-make][compiling org-mode without make]] so you
621 can install a recent version of org-mode without using the full build
622 system.
623
624 ** I don't use git. Can I download bleeding edge .zip and .tar.gz archives?
625
626    Yes. You can download [[http://orgmode.org/org-latest.zip][org-latest.zip]] or [[http://orgmode.org/org-latest.tar.gz][org-latest.tar.gz]] of Org-mode --
627    these archives are udpated every day at midnight.
628
629    Alternatively, you can download a [[http://orgmode.org/w/org-mode.git/snapshot][tar.gz snapshot from orgmode.org]].
630
631 ** How do I install Org-mode through Emacs' Package Manager?
632    :PROPERTIES:
633    :CUSTOM_ID: installing-via-elpa
634    :END:
635
636    Daily builds of Org-mode are distributed as an ELPA package from both
637    [[http://elpa.gnu.org/packages/][GNU Emacs Lisp Package Archive]] as well as from the [[http://orgmode.org/elpa/][Org-mode Emacs Lisp
638    Archive]].
639
640    Steps for installing Org with package manager:
641    1) Do =M-x list-packages= to browse available packages.
642    2) If the above command is unavailable you need to [[#installing-elpa][install the package
643       manager]] before proceeding ahead.
644    3) If you see =org= as an available package, skip to step 5.
645    4) If you are here it means that org is unavailable in the GNU's
646       archives.  Report this discrepancy to [[mailto:emacs-orgmode@gnu.org][Orgmode mailing list.]]
647
648       In the meanwhile, you can manually download the tarball and
649       install it. Refer [[Installing%20from%20ELPA-tar][this FAQ entry]] for further information.
650    5) Press =i= to mark the package for installation
651    6) Press =x= to install
652    7) Reload Emacs
653    8) Use =M-x locate-library RET org=. If your installation is
654       successful you would something like the following:
655
656       =Library is file ~/.emacs.d/elpa/org-20110403/org.elc=
657
658 #   7) If you get the following error "*Failed to download `Org-mode'
659 #      archive.*" in step 2, you can manually download the tarball and
660 #      install it. Refer [[Installing from ELPA-tar][this FAQ entry]] for more information.
661 #
662 #   8) Add Orgmode as a package archive. This can be done in two ways:
663 #   9) Use =M-x customize-variable RET package-archives=
664 #   10) Add the following line to your =.emacs= and reload Emacs.
665 #       #+begin_src emacs-lisp
666 #         (add-to-list 'package-archives '("Org-mode" . "http://orgmode.org/elpa/"))
667 #       #+end_src
668 #
669
670 ** How do I install Emacs package manager?
671    :PROPERTIES:
672    :CUSTOM_ID: installing-elpa
673    :END:
674
675    If you are running Emacs 24 or find the command =M-x list-packages=
676    available you already have the package manager installed.
677
678    Steps for installing package manager on emacs-23:
679    1. Download the package manager [[http://repo.or.cz/w/emacs.git/blob_plain/1a0a666f941c99882093d7bd08ced15033bc3f0c:/lisp/emacs-lisp/package.el][package.el]]
680
681    2. Add the following to your =.emacs= and reload Emacs.
682       #+begin_src emacs-lisp
683         ;; change "~/elisp/" as appropiate
684         (setq load-path (cons "~/elisp" load-path))
685         
686         ;; Add the below lines *at the beginning* of your .emacs.
687         (require 'package)
688         (package-initialize)
689       #+end_src
690
691 ** I don't see Org-mode as an installation option in Package Manager Menu?
692    :PROPERTIES:
693    :CUSTOM_ID: why-no-org-in-elpa
694    :END:
695
696    Emacs Package Manager is a very recent addition to Emacs. Work is
697    under way to have have Org-mode seamlessly integrate with Emacs'
698    Package Manager. As a result, it will be some time before the
699    Org-mode packages are available and usable from either GNU or
700    Org-mode package archives.
701
702    In the meanwhile, you can install Org-mode via package manager
703    through ELPA-compatible tar. Refer [[Installing from ELPA-tar][this FAQ entry]] for more information.
704
705 ** How do I install Org-mode from a ELPA-compatible tarball?
706    :PROPERTIES:
707    :CUSTOM_ID: installing-from-elpa-tarball
708    :END:
709 # <<Installing from ELPA-tar>>
710
711 #+index: ELPA
712
713    Org-mode is distributed as an ELPA-compatible tar which can be used
714    in conjunction with Emacs' package manager.
715
716    1. If you are already running Org-mode, note the current version
717       reported by M-x org-version.
718    2. Download the latest tarball from [[http://orgmode.org/elpa/][Org-mode repo]].
719    3. Do =M-x package-install-file=. When prompted for =Package file
720       name=, point it to .tar file downloaded in step 2.
721
722       You will now see Package Manager compiling the files and
723       installing it.
724    4. Reload emacs. This step is very important.
725    5. Note the version of the new installation using M-x
726       org-version. If the new and old versions are different, the
727       installation is done and you are all set to enjoy the updated
728       Org-mode. Otherwise skip to step 6.
729    6. Review you load-path using =C-h v load-path=. Most likely that
730       your old installation path takes precedence over the path chosen
731       by package manager (which is typically
732       =~/.emacs.d/elpa/...=). Fix this anamoly by moving
733       =(package-initialize)= line in .emacs to a more appropriate
734       location.
735
736 ** Why would I use ELPA tarballs instead of the snapshot tarballs?
737    :PROPERTIES:
738    :CUSTOM_ID: why-elpa
739    :END:
740
741 #+index: ELPA
742
743    ELPA-tarballs automate much the process of upgrading org-mode. Much
744    of the following grunt work is done automatically by the Package
745    Manager:
746
747    1. Downloading, compiling, and activating of org-mode (including
748       setting org-mode's =load-path= and autoloads).
749    2. Updating info files.
750
751 * Setup
752   :PROPERTIES:
753   :CUSTOM_ID: Setup
754   :END:
755
756 #+index: Setup
757
758 ** How can I quickly browse all Org options?
759
760 #+index: Options
761
762 =M-x org-customize RET=
763
764 See also [[file:org-tutorials/org-customize.org][Carsten's Org customize tutorial]] and [[file:org-configs/org-customization-guide.org][this customization guide]]
765 for details.
766
767 ** Can I use the editing features of org-mode in other modes?
768    :PROPERTIES:
769    :CUSTOM_ID: use-editing-features-in-other-modes
770    :END:
771
772    Not really---but there are a few editing features you can use in
773    other modes.
774
775    - For tables there is =orgtbl-mode= which implements the table
776      editor as a minor mode. (To enable, type =M-x orgtbl-mode=)
777    - For ordered lists there is =orgstruct-mode= which allows for easy
778      list editing as a minor mode. (To enable, type =M-x
779      orgstruct-mode=)
780
781    You can activate these modes automatically by using hooks:
782
783    : (add-hook 'mail-mode-hook 'turn-on-orgtbl)
784    : (add-hook 'mail-mode-hook 'turn-on-orgstruct)
785
786    For footnotes, there is the function =org-footnote-action=, which
787    works in non-org buffers. This function is a powerful tool for
788    creating and sorting footnotes. To use it globally, you can add the
789    following keybinding to your =.emacs= file (requires Org 6.17 or
790    greater):
791
792    : (global-set-key (kbd "C-c f") 'org-footnote-action)
793
794    For other features you need to switch to Org-mode temporarily, or
795    prepare text in a different buffer.
796
797 ** Why isn't feature "X" working the way it is described in the manual?
798    :PROPERTIES:
799    :CUSTOM_ID: making-sure-org-mode-is-up-to-date
800    :END:
801
802 Org-mode develops very quickly. If you are using a version of Org-mode
803 that shipped with emacs, there is a good chance that it is somewhat
804 out of date.
805
806 Many of the users on the Org-mode mailing list are using either a
807 recent release of Org-mode or the
808 [[http://orgmode.org/index.html#sec-3.2][development version of
809 org-mode from the git repository]].
810
811 If some settings and features aren't working the way you expect, make
812 sure that the version of the manual you are consulting matches the
813 version of Org-mode you are using.
814
815    - You can check which version of Org-mode you are using by
816      selection =Org --> Documentation --> Show Version= in the Emacs
817      menu.
818
819    - The [[http://orgmode.org/manual/index.html][online manual]] at [[http://orgmode.org][orgmode.org]] corresponds to the most recent
820      release.
821
822    - The [[http://www.gnu.org/software/emacs/manual/html_node/org/index.html][manual]] at [[http://www.gnu.org][www.gnu.org]] corresponds to the version of Org-mode
823      released with the latest official Gnu Emacs release. Compared
824      with the manual at the orgmode.org, the manual at www.gnu.org is
825      somewhat out of date.
826
827 For instructions on how to stay current with Org-mode, consult [[keeping-current-with-Org-mode-development][this
828 FAQ]] or follow the instructions on [[http://orgmode.org][the official Org-mode site]].
829
830 ** Can I get the visibility-cycling features in emacs-lisp-mode?
831
832 Yes.  This snippet in your =.emacs= will bind =C-M-]= and =M-]= to global
833 and local cycling:
834
835 #+BEGIN_SRC emacs-lisp
836 (global-set-key (kbd "C-M-]") (lambda () (interactive) (org-cycle t)))
837 (global-set-key (kbd "M-]") (lambda ()
838                               (interactive)
839                               (ignore-errors
840                                 (end-of-defun)
841                                 (beginning-of-defun))
842                               (org-cycle)))
843 #+END_SRC
844
845 ** Can I get the visibility-cycling features in outline-mode and outline-minor-mode?
846    :PROPERTIES:
847    :CUSTOM_ID: use-visibility-cycling-in-outline-mode
848    :END:
849
850 #+index: Visibility!Cycling
851
852    Yes, these functions are written in a way that they are independent of
853    the outline setup.  The following setup provides standard Org-mode
854    functionality in outline-mode on =TAB= and =S-TAB=.  For
855    outline-minor-mode, we use =C-TAB= instead of =TAB=,
856    because =TAB= usually has mode-specific tasks.
857
858 #+BEGIN_SRC emacs-lisp
859 (add-hook 'outline-minor-mode-hook
860   (lambda ()
861     (define-key outline-minor-mode-map [(control tab)] 'org-cycle)
862     (define-key outline-minor-mode-map [(shift tab)] 'org-global-cycle)))
863 (add-hook 'outline-mode-hook
864   (lambda ()
865     (define-key outline-mode-map [(tab)] 'org-cycle)
866     (define-key outline-mode-map [(shift tab)] 'org-global-cycle)))
867 #+END_SRC
868
869 Or check out /outline-magic.el/, which does this and also provides
870 promotion and demotion functionality.  /outline-magic.el/ is
871 available at [[http://www.astro.uva.nl/~dominik/Tools/outline-magic.el][Outline Magic]].
872
873 ** Can I save/restore the visibility state of an org-mode buffer?
874    :PROPERTIES:
875    :CUSTOM_ID: saving-visibility-state
876    :END:
877
878 #+index: Visibility!Restore
879
880 Well, no---at least not automatically. You can, however, control the
881 visibility of an org-file or of individual trees by adding
882 instructions to your org file. See [[http://orgmode.org/manual/Visibility-cycling.html#Visibility-cycling][this section of the manual]] for more
883 information.
884
885 ** How can I keep track of changes in my Org files?
886    :PROPERTIES:
887    :CUSTOM_ID: track-of-changes-in-Org-files
888    :END:
889
890   Use git to track the history of the files, use a cronjob to check in
891   changes regularly.  Such a setup is described by Bernt Hansen in [[http://article.gmane.org/gmane.emacs.orgmode/6233][this
892   message]] on [[http://dir.gmane.org/gmane.emacs.orgmode][emacs-orgmode]].
893
894 ** Can I use Org-mode as the default mode for all README files?
895    :PROPERTIES:
896    :CUSTOM_ID: Org-mode-as-default-mode
897    :END:
898
899 #+index: default-major-mode
900
901 Add the following to your .emacs file:
902
903 : (add-to-list 'auto-mode-alist '("README$" . org-mode))
904
905 You can even make it the default mode for any files with unspecified
906 mode using
907
908 : (setq default-major-mode 'org-mode)
909
910 ** Can I use ido.el for completing stuff in Org?
911    :PROPERTIES:
912    :CUSTOM_ID: ido-complete
913    :END:
914
915 #+index: Ido
916
917    Yes, you can.  If you are an ido user and ido-mode is active, the
918    following setting will make Org use =ido-completing-read= for most
919    of its completing prompts.
920
921 : (setq org-completion-use-ido t)
922
923 ** Should I use one big org file or multiple files?
924    :PROPERTIES:
925    :CUSTOM_ID: how-to-organize-org-mode-files
926    :END:
927
928 Org-mode is flexible enough to accomodate a variety of organizational and
929 time management schemes.  Org's [[http://orgmode.org/manual/Document-Structure.html#Document-Structure][outline cycling and convenient editing and
930 navigation commands]] make it possible to maintain all of your projects and
931 notes in a single file.  But org-mode's [[http://orgmode.org/manual/Hyperlinks.html#Hyperlinks][quick and easy hyperlinks]], along
932 with [[http://orgmode.org/manual/Refiling-notes.html#Refiling-notes][easy refiling of notes and todos]], also make it a delight to maintain a
933 private "wiki" consisting of multiple files.
934
935 No matter how you organize your org files, org-mode's agenda commands
936 make it easy to search all your notes and gather together crucial data
937 in a single view.
938
939 Moreover, several org-mode settings can be configured either globally in
940 your =.emacs= file or locally (per file or per outline tree).  See the
941 [[http://orgmode.org/manual/index.html#Top][manual]] for more details.  For an example of local customizations see [[limit-agenda-with-category-match][this
942 FAQ]].
943
944 Here are a few ideas for organizing org-mode files:
945
946 - A single file for all your projects and notes.
947 - One file per project.
948 - One file per client.
949 - One file per area of responsibility or type of work (e.g.,
950   household, health, work, etc.).
951 - One file for projects, one for appointments, one for reference
952   material, one for someday/maybe items, etc.
953 - A wiki of hyperlinked files that grows and adapts to meet your
954   needs.
955
956 For more ideas, see some of the links on the [[file:org-tutorials/index.org][org-tutorial index]] or
957 [[file:org-gtd-etc.org][this page on org-mode and GTD]].
958
959 ** Why doesn't C-c a call the agenda? Why don't some org keybindings work?
960    :PROPERTIES:
961    :CUSTOM_ID: setting-global-keybindings
962    :END:
963
964 Org-mode has a few global keybindings that the user must set explicitly in
965 an =.emacs= file.  These keybindings include the customary shortcut for
966 calling the agenda (=C-c a=).  If nothing happens when you type =C-c a=,
967 then make sure that the following lines are in your =.emacs= file:
968
969 #+BEGIN_SRC emacs-lisp
970   ;; The following lines are always needed.  Choose your own keys.
971   (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
972   (global-set-key "\C-cl" 'org-store-link)
973   (global-set-key "\C-ca" 'org-agenda)
974   (global-set-key "\C-cb" 'org-iswitchb)
975 #+END_SRC emacs-lisp
976
977 You may, of course, choose whatever keybindings work best for you
978 and do not conflict with other modes.
979
980 Please see [[http://orgmode.org/manual/Activation.html][this section of the manual]] if you have additional
981 questions.
982
983 ** Why aren't some of the variables I've customized having an effect?
984    :PROPERTIES:
985    :CUSTOM_ID: load-org-after-setting-variables
986    :END:
987
988 Some org variables have to be set before org.el is loaded or else they
989 will not work. (An example is the new variable
990 =org-enforce-todo-dependencies=.)
991
992 To make sure all your variables work you should not use =(require
993 'org)=. Instead use the following setting:
994
995 : (require 'org-install)
996
997 You should also make sure that you do not require any other =org-...=
998 files in your =.emacs= file before you have set your org variables,
999 since these will also cause org.el to be loaded. To be safe, load org
1000 files *after* you have set your variables.
1001
1002 ** How can I make sure that timestamps appear in English?
1003    :PROPERTIES:
1004    :CUSTOM_ID: timestamps-and-system-time-locale
1005    :END:
1006
1007 If your system's locale is not set to English, but you would like the
1008 timestamps in your org-mode files to appear in English, you can set
1009 the following variable:
1010
1011 #+begin_src emacs-lisp
1012   (setq system-time-locale "C")
1013 #+end_src
1014
1015 ** What does a minimal .emacs look like?
1016    :PROPERTIES:
1017    :CUSTOM_ID: minimal-emacs
1018    :END:
1019
1020 Using a stripped down minimal .emacs files removes broken custom
1021 settings as the cause of an issue and makes it easy to reproduce for
1022 other people.  The example below has system-specific paths that you'll
1023 need to change for your own use.
1024
1025 #+begin_src emacs-lisp
1026   (add-to-list 'load-path (expand-file-name "~/git/org-mode/lisp"))
1027   (add-to-list 'auto-mode-alist '("\\.\\(org\\  |org_archive\\|txt\\)$" . org-mode))
1028   (setq org-agenda-files '("/tmp/test.org"))
1029   (require 'org-install)
1030   (require 'org-habit)
1031
1032   (global-set-key "\C-cl" 'org-store-link)
1033   (global-set-key "\C-ca" 'org-agenda)
1034   (global-set-key "\C-cb" 'org-iswitchb)
1035 #+end_src
1036
1037 You can save the minimal .emacs file to ~/minimal.emacs, add suspect
1038 configuration code to it, then start emacs something like this:
1039
1040 #+begin_src sh
1041   emacs -Q -l ~/minimal.emacs
1042 #+end_src
1043
1044 On OS X, starting emacs with minimal configuration might look
1045 something like this:
1046
1047 #+begin_src sh
1048   /Applications/emacs.app/Contents/MacOS/Emacs -Q -l ~/minimal.emacs
1049 #+end_src sh
1050
1051 ** Can I migrate from Planner?
1052
1053    Yes.  This [[http://www.c0t0d0s0.de/plan2org/plan2org.pl][perl script]] or [[http://gitorious.org/bkuhn-small-hacks/org-mode/blobs/master/planner2org.plx
1054 ][this Perl script]] can help.
1055
1056 * Errors and general problems
1057   :PROPERTIES:
1058   :CUSTOM_ID: Errors
1059   :END:
1060 ** Is my Orgmode installation mixed?
1061    :PROPERTIES:
1062    :CUSTOM_ID: mixed-install
1063    :END:
1064    Emacs is distributed with a version of Orgmode bundled with it.  A
1065    common problem among users who install a [[#updating-org][newer version]] of Orgmode
1066    separately is a mixed install where Emacs loads some files from the
1067    bundled and the rest from the latest version.  This can lead to
1068    /unending/ troubles in the future.  With a recent installation of
1069    Org mode =M-x org-version= will indicate if the installation is mixed.
1070
1071    With somewhat older Org mode installations, the procedure is more
1072    involved and indeterminate. An easy first step is to look
1073    at the output of =M-x org-version=.
1074    - Good :: ~Org-mode version 7.8.11 (release_7.8.11-448-g1737d3 @
1075              /path/to/org-mode/lisp/)~
1076    - Bad :: ~Org-mode version 6.33x (release_7.8.11.409.ga3778)~
1077
1078    A second step is to go through the output of =list-load-path-shadows=
1079    line-by-line to get hints to what in your configuration is causing
1080    the issue.  Among the most common reasons is Orgmode gets loaded
1081    before the =load-path= variable is updated to include the
1082    installation directory of the latest Orgmode.  To avoid issues like
1083    this, it is recommended that the load path is updated very early on
1084    in your init file.
1085
1086    /Note:/ The formatting of the version information, as shown in the
1087    examples above, will be different for older Org mode releases,
1088    e.g. ~Org-mode version 7.8.02~.
1089
1090 ** Opening Org files in Emacs leads to a crash
1091    :PROPERTIES:
1092    :CUSTOM_ID: Emacs-crashes-with-org-indent-mode
1093    :END:
1094    The only known case where Org-mode can crash Emacs is when you are
1095    using =org-indent-mode= with Emacs 23.1 (in fact, any version of
1096    Emacs before version 23.1.50.3).  Upgrade to Emacs 23.2 and the
1097    problem should go away.
1098
1099 ** When I try to use Org-mode, I always get the error message =(wrong-type-argument keymapp nil)=
1100    :PROPERTIES:
1101    :CUSTOM_ID: wrong-type-argument-keymapp
1102    :END:
1103
1104    This is a conflict with an outdated version of the /allout.el/, see
1105    the [[http://orgmode.org/manual/Conflicts.html#Conflicts][Conflicts]] section in the manual
1106
1107 ** How can I control the application launched by Org-mode to open a certain file type like pdf, html...?
1108    :PROPERTIES:
1109    :CUSTOM_ID: external-application-launched-to-open-file-link
1110    :END:
1111
1112 If you want special control about how Org-mode opens files, see the
1113 variables =org-file-apps=, =org-file-apps-defaults-gnu=,
1114 =org-file-apps-defaults-macosx=, =org-file-apps-defaults-windowsnt=.
1115
1116 *However*, normally it is best to just use the mechanism the
1117 operating-system provides:
1118
1119 *** GNU/Linux systems
1120     You you have to check your mailcap settings, find the files:
1121
1122     : /etc/mailcap
1123     :
1124     : or
1125     :
1126     : $HOME/.mailcap
1127
1128 and modify them accordingly. Please read their manual entry.
1129
1130 *** Windows systems
1131     + for html pages you may configure the =browse-url-= variables through
1132       the Customize interface,
1133     + the pdf files are automatically opened with Acrobat Reader (if it is
1134       installed)
1135
1136 *** Mac OSX
1137     Change the application responsible for this file type by selecting
1138     such a file in the Finder, select =File->Get Info= from the menu
1139     and select the application to open this file with.  Then, to
1140     propagate the change to all files with the same extension, select
1141     the =Change all= button.
1142
1143 ** Org-mode takes over the TAB key.  I also want to use YASnippet, is there a way to fix this conflict?
1144    :PROPERTIES:
1145    :CUSTOM_ID: YASnippet
1146    :END:
1147
1148 [[http://code.google.com/p/yasnippet/][yasnippet]] is yet another snippet expansion system for Emacs.  It is
1149 inspired by TextMate's templating syntax.
1150 - watch the [[http://www.youtube.com/watch?v=vOj7btx3ATg][video on YouTube]]
1151 - see the [[http://yasnippet.googlecode.com/svn/trunk/doc/index.html][intro and tutorial]]
1152
1153 *Note*: yasnippet is not compatible with =org-indent-mode= currently
1154 there is no known way to use both successfully with =yas/trigger-key=
1155 set to =TAB= (or =[tab]= etc...)
1156
1157 The way Org-mode binds the =TAB= key (binding to =[tab]= instead of
1158 =\t=) overrules yasnippets' access to this key.  The following code
1159 fixes this problem:
1160
1161 #+begin_src emacs-lisp
1162 (add-hook 'org-mode-hook
1163           (lambda ()
1164             (org-set-local 'yas/trigger-key [tab])
1165             (define-key yas/keymap [tab] 'yas/next-field-group)))
1166 #+end_src
1167
1168 If the above code doesn't work (which it may not with later versions
1169 of yasnippet).  Then try the following
1170
1171 #+begin_src emacs-lisp
1172   (defun yas/org-very-safe-expand ()
1173     (let ((yas/fallback-behavior 'return-nil)) (yas/expand)))
1174
1175   (add-hook 'org-mode-hook
1176             (lambda ()
1177               ;; yasnippet (using the new org-cycle hooks)
1178               (make-variable-buffer-local 'yas/trigger-key)
1179               (setq yas/trigger-key [tab])
1180               (add-to-list 'org-tab-first-hook 'yas/org-very-safe-expand)
1181               (define-key yas/keymap [tab] 'yas/next-field)))
1182 #+end_src
1183
1184 Rick Moynihan maintains a [[http://github.com/RickMoynihan/yasnippet-org-mode][git repository]] (or [[http://github.com/eschulte/yasnippet-org-mode][Eric's fork of the same]])
1185 with YASnippets for Org-mode.
1186
1187 ** Org-mode takes over the S-cursor keys.  I also want to use CUA-mode, is there a way to fix this conflict?
1188    :PROPERTIES:
1189    :CUSTOM_ID: CUA-mode
1190    :END:
1191
1192 Yes, see the  [[http://orgmode.org/manual/Conflicts.html#Conflicts][Conflicts]] section of the manual.
1193
1194 ** Org-mode takes over the S-cursor keys.  I also want to use windmove.el, is there a way to fix this conflict?
1195    :PROPERTIES:
1196    :CUSTOM_ID: windmove.el
1197    :END:
1198
1199 Yes, see the [[http://orgmode.org/manual/Conflicts.html#Conflicts][Conflicts]] section of the manual.
1200
1201 ** Org behaves strangely: some keys don't work, some features are missing, my settings have no effect, ...
1202    :PROPERTIES:
1203    :CUSTOM_ID: loaded-old-org
1204    :END:
1205
1206 When this sort of things happen, it probably is because Emacs is
1207 loading an old version of Org-mode instead of the one you expected.
1208 Check it with =M-x org-version=.
1209
1210 This happens because Emacs loads first the system org-mode (the one
1211 included with Emacs) before the one in your directory. Check the
1212 =load-path= variable; you might see that your org-mode appears /after/
1213 the system-wide path; this is bad.
1214
1215 You should add your directories to the =load-path= at the beginning:
1216
1217 :  (add-to-list 'load-path "~/.emacs.d/org-mode/lisp") (require 'org-install)
1218
1219 Function =add-to-list= adds at the beginning. Don't use =append=
1220 because it appends at the end. Also be sure to use =(require
1221 'org-install)= and not =(require 'org)=.
1222
1223 This wrong version loading may also happen if you have a byte-compiled
1224 =org.elc= from an old version together with a new =org.el=. Since
1225 Emacs prefers loading byte-compiled files (even if the =.el= is
1226 newer), it will load the old Org-mode.
1227
1228 ** Why doesn't org-batch-agenda work under Win32?
1229    :PROPERTIES:
1230    :CUSTOM_ID: org-batch-agenda-under-win32
1231    :END:
1232
1233 When I run the example batch files to print my agenda to the console
1234 under Win32 I get the failure:
1235
1236 : End of file during parsing
1237
1238 and no agenda is printed.
1239
1240 The problem is the use of single quotes surrounding the eval in the
1241 emacs command-line. This gets confused under Win32. All string
1242 parameters with spaces must be surrounded in double quotes. This means
1243 that double quotes being passed to the eval must be escaped.
1244
1245 Therefore, instead of the following:
1246
1247 : <path to emacs>\emacs.exe -batch -l ~/_emacs_org \
1248 :     -eval '(org-batch-agenda "a")'
1249
1250 you need to use the following:
1251
1252 :  <path to emacs>\emacs.exe -batch -l ~/_emacs_org \
1253 :     -eval "(org-batch-agenda \"a\")"
1254
1255 (all on one line, of course).
1256
1257 ** Org agenda seems very slow
1258    :PROPERTIES:
1259    :CUSTOM_ID: slow-agenda
1260    :END:
1261
1262 If it takes a long time to generate or refresh the agenda, you might
1263 want first check which version of org-mode you are using. There have
1264 been major optimizations of org-agenda since 6.21b, which was the
1265 version of org-mode released with Emacs 23. If you are using 6.21b or
1266 earlier (you can check with =M-x org-version=), then you might want to
1267 consider upgrading to a more recent version of org-mode.
1268
1269 Here are some other ideas for speeding up the agenda:
1270
1271 1. Use a one day agenda view (rather than a seven day view).
1272
1273    =(setq org-agenda-ndays 1)=
1274
1275 2. Archive inactive items to separate files.
1276
1277    =C-c C-x C-s= (org-archive-subtree)
1278
1279 3. Do not include the global todo list in your agenda view.
1280
1281    (setq org-agenda-include-all-todo nil)
1282
1283 4. Make sure that your org files are byte-compiled.
1284
1285    I.e., make sure there are files ending in =.elc= in your org
1286    installation directory.
1287
1288 5. Limit your agenda files (=org-agenda-files=) to files that have
1289    active todos and or projects.
1290
1291    If you have a number of older reference files---i.e., files you
1292    search only occasionally---in your agenda files list, consider
1293    removing them from your agenda files and adding them to
1294    =org-agenda-text-search-extra-files= instead. Similarly, you might
1295    consider searching some of your older reference files with =M-x
1296    grep= so that Org-mode does not have to load them into memory when
1297    the agenda is called.
1298
1299 ** Visual-line-mode doesn't work well with Org-mode
1300    :PROPERTIES:
1301    :CUSTOM_ID: visual-line-mode
1302    :END:
1303
1304 Visual-line-mode "soft wraps" lines so that the visual edge of the
1305 buffer is considered a line break for purposes of navigation, even
1306 though there is no line break in reality.
1307
1308 In older versions of org-mode, org-beginning-of-line and
1309 org-end-of-line do not work well with visual line mode. (The two
1310 commands disregard soft line breaks and move to the beginning and end
1311 of the hard line break.) A patch was introduces to fix this behavior
1312 in July of 2009.
1313
1314 If you are using an older version of Org-mode, you can:
1315
1316 1. Add a hook to turn off visual line mode.
1317
1318 2. Add the following to your =.emacs=:
1319
1320 #+begin_src emacs-lisp
1321
1322 (add-hook 'org-mode-hook
1323   (lambda ()
1324     (define-key org-mode-map "\C-a" 'move-beginning-of-line)
1325     (define-key org-mode-map "\C-e" 'move-end-of-line)))
1326
1327 #+end_src
1328 ** Can I hide blocks at startup?
1329
1330 Yes:
1331
1332 #+begin_src emacs-lisp
1333 (setq org-hide-block-startup t)
1334 #+end_src
1335
1336 Or use
1337
1338 #+begin_src org
1339 ,#+STARTUP: hideblocks
1340 #+end_src
1341
1342 on a per-file basis.
1343
1344 ** After updating Org I get an error about an =invalid function=
1345    :PROPERTIES:
1346    :CUSTOM_ID: invalid-function-error
1347    :END:
1348
1349 In almost all cases an =invalid function= error is caused by an
1350 unclean Org-mode source directory. Cleaning it up and recompiling
1351 should fix the problem
1352
1353 : cd /path/to/orgmode
1354 : make clean
1355 : make
1356
1357 In some cases, bits and pieces of org are loaded from various places (previous
1358 installs, the built-in install of org that came with whatever emacs version you have)
1359 and things get very confused. In all cases, cleaning up every last bit of org installation
1360 from everywhere and reinstalling org from git should restore sanity. See also the [[id:facac2a6-3526-450d-ac42-8d36b16c6bab][next question]].
1361
1362 ** I use starter-kit and I get an error =(void-function org-pop-to-buffer-same-window)=
1363    :PROPERTIES:
1364    :ID:       facac2a6-3526-450d-ac42-8d36b16c6bab
1365    :END:
1366 This is a particular instance of the [[#invalid-function-error][previous question]] but with some twists and turns,
1367 and a solution culled from various postings on the mailing list.
1368
1369 starter-kit loads the site-file version of org (the one that came with
1370 your emacs install).  Then when you load your init file, the local
1371 version is added to the front of load-path, so it looks as if things
1372 are originating there, but the damage is already done: you have a
1373 "frankenstein" org.
1374
1375 One possible solution is to add (package-initialize) to the primary init.el
1376 before starter-kit gets going. This will pick up the local install so
1377 that the built-in version never enters to muddy the picture.
1378
1379 ** (Filling a paragraph|Indenting a list|...) behaves strangely
1380 Many filling/indenting problems have been reported on the mailing
1381 list: many of those were bugs (that have been fixed), but quite a lot
1382 are caused by people using the filladapt package, which is fundamentally
1383 incompatible with Org, which has its own facilities for these tasks. If you see
1384 strange behavior in this area, first check if you are using filladapt: visit an org
1385 file and check the modeline for "Filladapt".
1386
1387 If filladapt is on, you want to turn it off before investigating
1388 further. Anthony Lander suggested on the mailing list the following
1389 method to turn off filladapt mode when you visit org files:
1390
1391 #+BEGIN_SRC emacs-lisp
1392 (add-hook 'org-mode-hook 'turn-off-filladapt-mode)
1393 #+END_SRC
1394
1395 This should be placed in your .emacs (or other initialization file) after org
1396 is loaded.
1397
1398 * Faces and highlighting
1399   :PROPERTIES:
1400   :CUSTOM_ID: Faces
1401   :END:
1402 ** Org-mode has a lot of colors?  How can I change them?
1403    :PROPERTIES:
1404    :CUSTOM_ID: customizing-org-faces
1405    :END:
1406
1407 #+index: Faces
1408
1409 This is a question that applies to Emacs as a whole, but it comes up
1410 quite frequently on the org-mode mailing list, so it is appropriate to
1411 discuss it here.
1412
1413 If you would like to change the style of a face in org-mode (or any
1414 other Emacs mode), simply type =M-x customize-face [RET]= while the
1415 cursor is on the color/style you are interested in modifying. You will
1416 be given the opportunity to customize all the faces located at that
1417 point.
1418
1419 If you would like an overview of all the faces in org-mode, you can
1420 type =C-u M-x list-faces-display [RET] org= and you will be shown all
1421 the faces defined by org-mode along with an illustration of their
1422 current settings.
1423
1424 If you would like to customize org-faces and other aspects of
1425 org-appearance, type =M-x customize-group org-font-lock [RET]=.
1426
1427 Finally, if you would like verbose information about the properties of
1428 the text under the cursor, you can type =C-u C-x ==.
1429
1430 See the Worg page on [[file:org-tutorials/org-appearance.org][customizing Org appearance]] for further information.
1431 ** Why do I get a tiny font in column view when using emacs daemon?
1432    :PROPERTIES:
1433    :CUSTOM_ID: column-view-tiny-font
1434    :END:
1435
1436 #+index: Column view
1437
1438 When using emacs in daemon mode (=emacs --daemon=), client frames
1439 sometimes override the column view face settings, resulting in very
1440 small fonts. Here is a fix:
1441
1442 #+begin_src emacs-lisp
1443   (defun org-column-view-uses-fixed-width-face ()
1444   ;; copy from org-faces.el
1445   (when (fboundp 'set-face-attribute)
1446       ;; Make sure that a fixed-width face is used when we have a column
1447       ;; table.
1448       (set-face-attribute 'org-column nil
1449                           :height (face-attribute 'default :height)
1450                           :family (face-attribute 'default :family))))
1451
1452    (when (and (fboundp 'daemonp) (daemonp))
1453     (add-hook 'org-mode-hook 'org-column-view-uses-fixed-width-face))
1454 #+end_src
1455
1456 This fix was provided in the following mailing list post:
1457
1458 http://article.gmane.org/gmane.emacs.orgmode/27560
1459 ** How can I stop the mouse cursor from highlighting lines in the agenda?
1460    :PROPERTIES:
1461    :CUSTOM_ID: ratpoison-for-agenda-highlighting
1462    :END:
1463
1464 #+index: Highlighting
1465
1466 You can add the following to your =.emacs=:
1467
1468 #+begin_src emacs-lisp
1469 (add-hook 'org-finalize-agenda-hook
1470     (lambda () (remove-text-properties
1471                (point-min) (point-max) '(mouse-face t))))
1472 #+end_src
1473
1474 * Outline
1475   :PROPERTIES:
1476   :CUSTOM_ID: Outline
1477   :END:
1478 ** Can I close an outline section without starting a new section?
1479    :PROPERTIES:
1480    :CUSTOM_ID: closing-outline-sections
1481    :END:
1482
1483 #+index: Outline
1484
1485 Can I have nested, closed outline sections, similar to xml? This
1486 question comes up quite frequently on the mailing list.
1487
1488 See the following threads:
1489
1490   - http://permalink.gmane.org/gmane.emacs.orgmode/40182
1491   - http://permalink.gmane.org/gmane.emacs.orgmode/36719
1492   - http://permalink.gmane.org/gmane.emacs.orgmode/24092
1493   - http://permalink.gmane.org/gmane.emacs.orgmode/12425
1494
1495 The desired behavior looks something like this:
1496
1497 #+begin_src org
1498   ,* Section one
1499
1500   ,Some text
1501
1502   ,** Subsection one
1503
1504   ,Some text
1505
1506   ,** Subsection two
1507
1508   ,Some text
1509
1510   ,# end Subsection Two
1511
1512   ,Continue text in section one.
1513 #+end_src
1514
1515 The short answer to the question is no. Org-mode adheres to the
1516 cascading logic of outlines, in which a section is closed only by
1517 another section that occupies an equal or greater level.
1518
1519 Here are some workarounds:
1520
1521 1. You can use inline tasks to create non-folding subsections. See the
1522    documentation in org-inlinetask.el, which is part of the org-mode
1523    distribution.
1524 2. You can create a temporary heading, such as "** Continue main
1525    section" and then remove it when you are ready to export.
1526 3. You can create a separate outline heading (e.g., * ACTIONS),
1527    creating TODOs there with links to the relevant sections of your
1528    main text.
1529
1530 ** Can I add a TODO to a list item?
1531    :PROPERTIES:
1532    :CUSTOM_ID: list-item-as-todo
1533    :END:
1534
1535 No.  When generating agenda views, org-mode treats only headlines as TODO
1536 items.
1537
1538 You can, however, use a status cookie together with checkboxes to
1539 monitor your progress on a series of subtasks:
1540
1541 #+begin_src org
1542   ,** TODO Big task [1/3]
1543
1544   ,   - [X] Subtask 1
1545   ,   - [ ] Subtask 2
1546   ,   - [ ] Subtask 3
1547 #+end_src
1548
1549 If you would like to embed a TODO within text without treating it as
1550 an outline heading, you can use inline tasks. Simply add...
1551
1552 : (require 'org-inlinetask)
1553
1554 ...to your =.emacs= and then type =C-c C-x t= to insert an inline task.
1555
1556 ** Can I have two windows on the same Org-mode file, with different outline visibilities?
1557    :PROPERTIES:
1558    :CUSTOM_ID: indirect-buffers
1559    :END:
1560
1561    You may use /indirect buffers/ which do exactly this.  See the
1562    documentation on the command =make-indirect-buffer=.
1563
1564    Org-mode has built-in commands that allow you create an indirect
1565    buffer from a subtree of an outline. To open a subtree in new
1566    window, type =C-c C-x b=. Any changes you make in the new window
1567    will be saved to the original file, but the visibility of both
1568    buffers will remain independent of one another.
1569
1570    For multiple indirect buffers from the same file, you must use the
1571    prefix =C-u= when creating the second (or third) buffer. Otherwise
1572    the new indirect buffer will replace the old.
1573
1574    You can also create an independent view of an outline subtree by
1575    typing =b= on an item in the agenda.
1576
1577 ** Emacs outlines are unreadable.  Can I get rid of all those stars?
1578    :PROPERTIES:
1579    :CUSTOM_ID: Emacs-outlines-are-unreadable
1580    :END:
1581
1582    See the section [[http://orgmode.org/manual/Clean-view.html#Clean-view][Clean outline view]] in the manual.
1583
1584 ** C-k is killing whole subtrees!  I lost my work!
1585    :PROPERTIES:
1586    :CUSTOM_ID: C-k-is-killing-subtrees
1587    :END:
1588
1589   =(setq org-ctrl-k-protect-subtree t)= before losing your work.
1590
1591 ** Why aren't commands working on regions?
1592    :PROPERTIES:
1593    :CUSTOM_ID: transient-mark-mode
1594    :END:
1595
1596 Some org-mode commands, such as M-right and M-left for demoting or
1597 promoting headlines (see [[demote-multiple-headlines][this FAQ]]), can be applied to entire
1598 regions.  These commands, however, will only work on active regions set
1599 with [[http://www.gnu.org/software/emacs/manual/html_node/emacs/Transient-Mark.html#Transient-Mark][transient mark mode]]. Transient mark mode is enabled by default in
1600 Emacs 23. To enable it in earlier versions of emacs, put the following in
1601 your =.emacs= file:
1602
1603 : (transient-mark-mode 1)
1604
1605 Alternatively, you may turn off transient mark mode and use [[http://www.gnu.org/software/emacs/manual/html_node/emacs/Momentary-Mark.html][a momentary
1606 mark]] (=C-<SPC> C-<SPC>=).
1607
1608 ** Why is a blank line inserted after headlines and list items?
1609    :PROPERTIES:
1610    :ID:       2463F4D8-F686-4CF3-AA07-08976F8A4972
1611    :CUSTOM_ID: blank-line-after-headlines-and-list-items
1612    :END:
1613
1614 #+index: Blank
1615
1616 In org-mode, typing =M-RET= at the end of a headline will create a new
1617 headline of the same level on a new line. The same is true for plain
1618 lists. By default org-mode uses context to determine if a blank line should
1619 be inserted after each headline or plain list item when =M-RET= is
1620 pressed. For instance, if a there is a blank line before a headline, then
1621 typing =M-RET= at the end of the line will insert a blank line before the
1622 new headline. For instance, hitting =M-RET= at the end of "Headline Two"
1623 below inserts a new headline without a blank line:
1624
1625 : ** Headline One
1626 : ** Headline Two
1627 : **
1628
1629 If there is a blank line between Headline One and Headline Two,
1630 however, the results will be as follows:
1631
1632 : ** Headline One
1633 :
1634 : ** Headline Two
1635 :
1636 : **
1637
1638 If you do not like the default behavior you can change it with the
1639 variable =org-blank-before-new-entry=. You can set headings and/or
1640 plain lists to auto (the default setting), t (always), or nil (never).
1641
1642 ** How can I promote or demote multiple headlines at once?
1643    :PROPERTIES:
1644    :CUSTOM_ID: demote-multiple-headlines
1645    :END:
1646
1647 #+index: Promote!Multiple
1648 #+index: Demote!Multiple
1649
1650 If you have a long list of first level headlines that you'd like to
1651 demote to second level headlines, you can select the headlines as a
1652 region and then hit =M-<right>= to demote all the headlines at once.
1653
1654 Note: =M-S-<right>= will not work on a selected region. Its use is to
1655 demote a single subtree (i.e., a headline and all sub-headlines).
1656
1657 If M-<right> doesn't seem to work, make sure transient mark mode is
1658 enabled. See [[transient-mark-mode][this FAQ]].
1659
1660 ** What's the deal with all the ellipses in my org outlines?
1661    :PROPERTIES:
1662    :CUSTOM_ID: org-ellipses
1663    :END:
1664
1665 #+index: Ellipsis
1666
1667 Org-mode uses ellipses to indicate folded (and thus hidden) text. Most
1668 commonly, ellispes occur at the end of headings with folded content:
1669
1670 : * Heading ...
1671
1672 Or, for instance, they may indicate closed drawers:
1673
1674 : :PROPERTIES: ...
1675
1676 Sometimes, as a result of editing and cycling an outline, ellipses may
1677 appear in unexpected places. You should *never* delete these ellipses,
1678 as you may accidentally delete hidden text. Instead, you can type =C-c
1679 C-r= (org-reveal) to display all hidden text in the vicinity. Or you
1680 may type =M-x RET show-all= to reveal all text in the org file.
1681
1682 If you would prefer a symbol or face for indicating hidden text, you
1683 can customize the variable org-ellipses.
1684
1685 ** How do I yank a subtree so it's indented according to the point's location?
1686    :PROPERTIES:
1687    :CUSTOM_ID: yank-indent-subtree
1688    :END:
1689
1690 #+index: Indentation
1691
1692 You can either use =C-c C-w= with a working [[http://orgmode.org/manual/Refiling-notes.html#Refiling-notes][refile-targets]] setup.
1693
1694 Or set =org-yank-adjusted-subtrees= to =t= which will adjust the
1695 yanked headline's level correctly.
1696
1697 Just use =C-k= and =C-y= as you would everywhere else in Emacs.
1698
1699 ** Can I read org-mode outlines in vim?
1700    :PROPERTIES:
1701    :CUSTOM_ID: org-outlines-in-vim
1702    :END:
1703
1704 #+index: Vim
1705
1706 Yes, there is a script that enables one to view and navigate folded
1707 outline/org files in vim (though without most of org-mode's
1708 functionality, of course).
1709
1710   - [[http://www.vim.org/scripts/script.php?script_id%3D1266][Emacs outline mode - Imitates Emacsen : vim online]]
1711
1712 For instructions on how to set it up, please see [[http://mid.gmane.org/EA275862-B97A-4BAC-B879-177FD07A2D56@gaillourdet.net][this mailing list
1713 post]].
1714
1715 Work is also underway on an org-mode clone for Vim. You can check it
1716 out on git hub:
1717
1718 https://github.com/hsitz/VimOrganizer
1719
1720 ** Can I use another character than "*" to start a headline?
1721
1722 No.  The "*" character is used in =outline-mode=, and Org is derived from
1723 =outline-mode=.
1724
1725 If you are curious as to what other rationales there are for "*", check out
1726 [[http://permalink.gmane.org/gmane.emacs.orgmode/44271][this]] mail and the thread it is in.
1727
1728 * Todos and Tags
1729   :PROPERTIES:
1730   :CUSTOM_ID: Todos-and-Tags
1731   :END:
1732 ** How can I automatically archive canceled tasks?
1733
1734 #+BEGIN_SRC emacs-lisp
1735 (setq org-todo-state-tags-triggers '(("CANCELLED" ("ARCHIVE" . t))))
1736 #+END_SRC
1737
1738 See http://thread.gmane.org/gmane.emacs.orgmode/64824 -- thanks to Victor
1739 Rosenfeld for sharing [[http://doc.norang.ca/org-mode.html][Bernt Hansen]]'s solution.
1740
1741 ** How can I cycle through the TODO keyword of an entry?
1742    :PROPERTIES:
1743    :CUSTOM_ID: cycle-TODO-keywords
1744    :END:
1745
1746 #+index: Cycling!Todo
1747
1748   =C-c C-t= or =S-<left/right>= is what you need.
1749
1750 ** How do I track state changes for tasks in Org?
1751    :PROPERTIES:
1752    :CUSTOM_ID: track-state-changes-for-tasks
1753    :END:
1754
1755 #+index: Logging
1756
1757   Take a look at the [[http://thread.gmane.org/gmane.emacs.orgmode/6082][post by Bernt Hansen]] for setting up TODO keyword
1758   states and logging timestamps for task state changes.
1759
1760 ** Can I select the TODO keywords with a tag-like interface?
1761    :PROPERTIES:
1762    :CUSTOM_ID: select-TODO-keywords-with-tag-like-interface
1763    :END:
1764
1765 #+index: Tag!Fast selection
1766
1767   Yes.  Use =(setq org-use-fast-todo-selection t)=
1768
1769   If you want to set both your todos and your tags using a single
1770   interface, then check out the variable
1771   =org-fast-tag-selection-include-todo=.
1772
1773   See [[http://orgmode.org/manual/Fast-access-to-TODO-states.html][this section of the manual]] for more details.
1774
1775 ** How can I quickly set the tag of an entry?
1776    :PROPERTIES:
1777    :CUSTOM_ID: quickly-set-tag-of-entry
1778    :END:
1779
1780 #+index: Tag!Set   
1781
1782    Use =C-c C-c= or =C-c C-q= on the headline. =C-c C-q= is useful for
1783    setting tabs in a [[http://orgmode.org/manual/Remember.html#Remember][remember]] buffer, since =C-c C-c= is the default
1784    keybinding for filing a note from the remember buffer.
1785
1786    You can set tags even more quickly by setting one of the character
1787    shortcuts for [[http://orgmode.org/manual/Setting-tags.html#Setting-tags][fast tag selection]].
1788
1789    To set tag shortcuts for all org buffers, put something like the
1790    following in your =.emacs= file (or create the same settings by
1791    typing =M-x customize-variable RET org-tag-alist=):
1792
1793 : (setq org-tag-alist '(("computer" . ?c) ("office" . ?o) ("home" . ?h)))
1794
1795    To set tag shortcuts for a single buffer, put something like the
1796    following at the top of your org file:
1797
1798 : #+TAGS: computer(c) office(o) home(h)
1799
1800 ** How can I change the colors of TODO keywords?
1801
1802 #+index: Faces!Todo
1803
1804 You can use the variable =org-todo-keyword-faces=.  Here are some sample
1805 settings:
1806
1807 #+begin_src emacs-lisp
1808 (setq org-todo-keyword-faces
1809       '(
1810         ("TODO"  . (:foreground "firebrick2" :weight bold))
1811         ("WAITING"  . (:foreground "olivedrab" :weight bold))
1812         ("LATER"  . (:foreground "sienna" :weight bold))
1813         ("PROJECT"  . (:foreground "steelblue" :weight bold))
1814         ("DONE"  . (:foreground "forestgreen" :weight bold))
1815         ("MAYBE"  . (:foreground "dimgrey" :weight bold))
1816         ("CANCELED"  . shadow)
1817         ))
1818 #+end_src
1819
1820 If you want to change the color of all active todos or all inactive todos,
1821 type:
1822
1823 : M-x customize-face RET org-todo
1824 : M-x customize-face RET org-done
1825
1826 You can also set values for each of these in your =.emacs= file:
1827
1828 : (set-face-foreground 'org-todo "firebrick2")
1829 : (set-face-foreground 'org-done "forestgreen")
1830
1831 ** Can I use a arbitrary character in a TODO keyword?
1832
1833 Yes, provided you add it to the "word" syntax in Emacs.
1834
1835 For example, to add the =\u25b6= and the =\u25b8= chars, just add this to
1836 your Emacs configuration:
1837
1838 #+begin_src emacs-lisp
1839   (add-hook 'org-mode-hook
1840      (lambda ()
1841        (modify-syntax-entry (string-to-char "\u25b6") "w")
1842        (modify-syntax-entry (string-to-char "\u25b8") "w")))
1843 #+end_src
1844
1845 ** How do I arrange for an item to be automatically marked DONE when all checkboxes are checked?
1846
1847 #+index: Checkbox
1848
1849 This has arisen a couple of time
1850 (e.g. http://thread.gmane.org/gmane.emacs.orgmode/42715 and
1851 http://thread.gmane.org/gmane.emacs.orgmode/47363) in the mailing list.
1852
1853 There is an [[http://orgmode.org/worg/org-hacks.html#mark-done-when-all-checkboxes-checked][org-hack]] that describes a possible solution.
1854
1855 * Hyperlinks
1856   :PROPERTIES:
1857   :CUSTOM_ID: Hyperlinks
1858   :END:
1859
1860 ** Why do I have to confirm the execution of each shell/elisp link?
1861    :PROPERTIES:
1862    :CUSTOM_ID: confirm-shell/elisp-link
1863    :END:
1864
1865 #+index: Link!Shell
1866 #+index: Link!Elisp
1867
1868    The confirmation is there to protect you from unwantingly execute
1869    potentially dangerous commands.  For example, imagine a link
1870
1871    : [[shell:rm -rf ~/*][Google Search]]
1872
1873    In an Org-mode buffer, this command would look like /Google Search/,
1874    but really it would remove your home directory.  If you wish, you can
1875    make it easier to respond to the query by setting
1876
1877    : (setq org-confirm-shell-link-function 'y-or-n-p
1878    :       org-confirm-elisp-link-function 'y-or-n-p).
1879
1880    Then a single keypress will be enough to confirm those links.  It is
1881    also possible to turn off this check entirely, but I strongly
1882    recommend against this.  Be warned.
1883
1884 ** Can I use RET or TAB to follow a link?
1885    :PROPERTIES:
1886    :CUSTOM_ID: RET-or-TAB-to-follow-link
1887    :END:
1888
1889 #+index: Link!Follow
1890
1891    Yes, this is how:
1892
1893    : (setq org-return-follows-link t)
1894    : (setq org-tab-follows-link t)
1895
1896 ** Can I keep mouse-1 clicks from following a link?
1897    :PROPERTIES:
1898    :CUSTOM_ID: mouse-1-following-link
1899    :END:
1900
1901    Activating links with =mouse-1= is a new feature in Emacs 22, to make
1902    link behavior similar to other applications like web browsers.  If
1903    you hold the mouse button down a bit longer, the cursor will be set
1904    without following the link.  If you cannot get used to this behavior,
1905    you can (as in Emacs 21) use =mouse-2= to follow links and turn off
1906    link activation for =mouse-1= with
1907
1908    : (setq org-mouse-1-follows-link nil)
1909
1910 ** How can I get completion of file names when creating a link?
1911    :PROPERTIES:
1912    :CUSTOM_ID: completion-of-file-links
1913    :END:
1914
1915 #+index: Link!Completion
1916
1917 You can use org-insert-link with a prefix argument:
1918
1919 : C-u C-c C-l
1920
1921 You will be greeted with prompt in the minibuffer that allows for file
1922 completion using your preferred Emacs method for finding files.
1923
1924 ** How can I use invisible targets within lists?
1925    :PROPERTIES:
1926    :CUSTOM_ID: invisible-targets-in-lists
1927    :END:
1928
1929 #+index: Target!Invisible
1930
1931 The usual way of turning radio links invisible is to comment them, but
1932 Org comments need to be at the beginning of the line, which breaks list
1933 indentation.
1934
1935 The workaround here is to add (INVISIBLE) after your <<target>>
1936
1937 For example:
1938
1939 : 11. <<target>>(INVISIBLE)
1940 :     Some text
1941 : 12. More text [[target][go to]]
1942
1943 ** Org-mode is not opening mailto links in my default mail client
1944    :PROPERTIES:
1945    :CUSTOM_ID: mailto-links
1946    :END:
1947
1948 #+index: Link!Mailto
1949
1950 You can customize the function org-mode uses to open mailto links by
1951 setting the variable =org-link-mailto-program=:
1952
1953 =M-x customize-variable org-link-mailto-program=
1954
1955 The default function called is =browse-url=, which opens a mail
1956 composition buffer within Emacs. The type of buffer opened by
1957 browse-url depends on the setting of the variable =mail-user-agent=.
1958 Thus, if you want to ensure that mailto links use Gnus to open a
1959 message buffer, you could add the following to your =.emacs=:
1960
1961 #+begin_src elisp
1962 (setq mail-user-agent 'gnus-user-agent)
1963 #+end_src
1964
1965 ** Can I use CamelCase links?
1966    :PROPERTIES:
1967    :CUSTOM_ID: CamelCase-links
1968    :END:
1969
1970 #+index: Link!CamelCase
1971
1972 Yes, you can with the contributed package =org-wikinodes.el=.  Please
1973 consult the [[http://orgmode.org/worg/org-contrib/org-wikinodes.html][documentation]].
1974
1975 ** Can I create links to Thunderbirds emails?
1976
1977 Yes, see this: [[http://mid.gmane.org/ka42mn$mn9$1%2540ger.gmane.org][from Christoph Herzog: Re: Linking to Thunderbird (correction)]]
1978
1979 #+BEGIN_SRC emacs-lisp
1980 (require 'org)
1981
1982 (org-add-link-type "thunderlink" 'org-thunderlink-open)
1983
1984 (defun org-thunderlink-open (path)
1985   "Opens an email in Thunderbird with ThunderLink."
1986   (start-process "myname" nil "thunderbird" "-thunderlink" (concat "thunderlink:" path)))
1987
1988 (provide 'org-thunderlink)
1989 #+END_SRC
1990
1991 * Plain Lists
1992   :PROPERTIES:
1993   :CUSTOM_ID: Plain-Lists
1994   :END:
1995
1996 ** How can I insert an empty line before each newly inserted headline, but not before each newly inserted plain-list item?
1997    :PROPERTIES:
1998    :CUSTOM_ID: empty-line-before-each-new-headline-but-not-item
1999    :END:
2000
2001 : (setq org-blank-before-new-entry
2002 :       '((heading . t) (plain-list-item . nil))
2003
2004 See also [[id:2463F4D8-F686-4CF3-AA07-08976F8A4972][Why is a blank line inserted after headlines and list items?]].
2005
2006 ** How can I convert itemized lists to enumerated lists?
2007    :PROPERTIES:
2008    :CUSTOM_ID: convert-itemized-to-enumerated-lists
2009    :END:
2010
2011 #+index: List!Itemized
2012 #+index: List!Enumerated
2013
2014    You can use =C-c -= or =S-<left>/<right>= to cycle through the various
2015    bullet headlines available for lists: =-, +, *, 1., 1)=.
2016
2017    See [[http://orgmode.org/manual/Plain-lists.html#Plain-lists][this section of the manual]] for more information.
2018
2019 ** How can I convert plain lists to headlines and vice versa?
2020    :PROPERTIES:
2021    :CUSTOM_ID: convert-plain-lists-to-headlines
2022    :END:
2023
2024 #+index: List!Plain
2025 #+index: Headline
2026
2027    To convert a plain list item or line to a headline, type =C-c *= on
2028    the headline. This will make the line a subheading of the current
2029    headline.
2030
2031    To convert a headline to a plain list item, type =C-c -= while the
2032    cursor is on the headline.
2033
2034    To convert a headline to an unadorned line of text, type =C-c *= on
2035    the headline.
2036
2037    You can use query replace to accomplish the same things, as Bernt
2038    Hansen explains in [[http://article.gmane.org/gmane.emacs.orgmode/10148][this mailing list post]].
2039
2040 ** Is there a good way to create a description list?
2041    :PROPERTIES:
2042    :CUSTOM_ID: description-lists
2043    :END:
2044
2045 #+index: List!Description
2046
2047   Yes, these are now built-in:
2048
2049 #+BEGIN_EXAMPLE
2050 - item1 :: Description of this item 1
2051 - item2 :: Description of this item 2
2052 - item1 :: Description of this item 3
2053       also in multiple lines
2054 #+END_EXAMPLE
2055
2056 * Tables
2057   :PROPERTIES:
2058   :CUSTOM_ID: Tables
2059   :END:
2060
2061 ** Will there ever be support for multiple lines in a table field?
2062    :PROPERTIES:
2063    :CUSTOM_ID: table-multiline-fields
2064    :END:
2065
2066    No.
2067
2068    You can embed tables created with the =table.el= package in org-mode
2069    buffers, with mixed success when it comes to export and publishing.
2070
2071 ** How can I make table alignment work with Asian character sets
2072    :PROPERTIES:
2073    :CUSTOM_ID: table-alignment-asian-characters
2074    :END:
2075
2076 #+index: Table!Alignment
2077
2078 When table alignment fails, it usually has to do with character sets
2079 where some characters have non-integer width.  Org will deal correctly
2080 with characters that are one or two or three ASCII characters wide,
2081 but not with characters that are, for example, 1.5 ASCII characters
2082 wide.  To make table alignment work you need to switch to a different
2083 character set.
2084
2085 ** Can I plot data from a table?
2086    :PROPERTIES:
2087    :CUSTOM_ID: plotting-table-data
2088    :END:
2089
2090 #+index: Table!Plot
2091 #+index: Table!Data
2092 #+index: Plot
2093
2094    Yes, you can, using org-plot.el written by Eric Schulte and now
2095    bundled with Org.  See [[http://orgmode.org/manual/Org_002dPlot.html#Org-Plot][the manual section about this]].
2096
2097    See also [[file:org-tutorials/org-plot.org][this excellent tutorial]] by Eric Schulte.
2098
2099 ** How can I fill a table column with incremental numbers?
2100    :PROPERTIES:
2101    :CUSTOM_ID: fill-table-column-with-incremental-numbers
2102    :END:
2103
2104 #+index: Table!Fill
2105
2106 Here is how: Use a field formula to set the first value in the column:
2107
2108 #+begin_src org
2109 ,| N   |   |
2110 ,|-----+---|
2111 ,| :=1 |   |
2112 ,|     |   |
2113 ,|     |   |
2114 ,|     |   |
2115 ,#+TBLFM: @2$1=1
2116 #+end_src
2117
2118 Then define a column formula in the second field:
2119
2120 #+begin_src org
2121 ,| N        |   |
2122 ,|----------+---|
2123 ,| 1        |   |
2124 ,| =@-1 + 1 |   |
2125 ,|          |   |
2126 ,|          |   |
2127 ,#+TBLFM: @2$1=1
2128 #+end_src
2129
2130 After recomputing the table, the column will be filled with
2131 incremental numbers:
2132
2133 #+begin_src org
2134 ,| N |   |
2135 ,|---+---|
2136 ,| 1 |   |
2137 ,| 2 |   |
2138 ,| 3 |   |
2139 ,| 4 |   |
2140 ,#+TBLFM: $1=@-1 + 1::@2$1=1
2141 #+end_src
2142
2143 Note that you could use arbitrary starting values and column formulas.
2144
2145 Alternatively, you can just start the table
2146
2147 #+begin_src org
2148 ,| N |   |
2149 ,|---+---|
2150 ,| 1 |   |
2151 #+end_src
2152
2153 and with the cursor on the 1, use S-RET (bound to org-table-copy-down). That
2154 will add a row, incrementing the number as it goes. See the docstring for org-table-copy-down
2155 for more information and also see the next FAQ entry [[=S-RET= in a table keeps increasing the copied numbers.  How can I stop this?]]
2156 if you don't want this behavior.
2157
2158 ** =S-RET= in a table keeps increasing the copied numbers.  How can I stop this?
2159    :PROPERTIES:
2160    :CUSTOM_ID: S-RET-in-a-table-increases-copied-numbers
2161    :END:
2162
2163    Well, it is /supposed/ to be a feature, to make it easy to create a
2164    column with increasing numbers.  If this gets into your way, turn it
2165    off with
2166
2167    : (setq org-table-copy-increment nil)
2168
2169 ** Why does my table column get filled with #ERROR?
2170    :PROPERTIES:
2171    :CUSTOM_ID: table-column-filled-with-ERROR
2172    :END:
2173
2174 #+index: Table!#ERROR
2175
2176    Org-mode tried to compute the column from other fields using a
2177    formula stored in the =#+TBLFM:= line just below the table, and
2178    the evaluation of the formula fails.  Fix the fields used in the
2179    formula, or fix the formula, or remove it!
2180
2181 ** How can I stop the table editor from creating new lines?
2182    :PROPERTIES:
2183    :CUSTOM_ID: table-editor-creates-new-lines
2184    :END:
2185
2186    When I am in the last column of a table and just above a horizontal
2187    line in the table, pressing TAB creates a new table line before the
2188    horizontal line.  To move to the line below the
2189    horizontal line instead, do this:
2190
2191    Press =down= (to get on the separator line) and then =TAB=.
2192    Or configure the variable
2193
2194    : (setq org-table-tab-jumps-over-hlines t)
2195
2196 ** How can I get table fields starting with "="?
2197    :PROPERTIES:
2198    :CUSTOM_ID: table-fields-starting-with-=
2199    :END:
2200
2201    With the setting
2202
2203    : (setq org-table-formula-evaluate-inline nil)
2204
2205    this will no longer happen.  You can still use formulas using the
2206    commands ~C-c =~ and ~C-u C-c =~
2207
2208 ** How can I get a vertical bar "|" inside a table field?
2209    :PROPERTIES:
2210    :CUSTOM_ID: table-fields-with-vertical-bar
2211    :END:
2212
2213    You can use =\vert= to put a vertical bar inside a table field.  This
2214    will be converted for export.  To use it inside a word use
2215    =abc\vert{}def=.  If you need something that looks like a bar in the Org
2216    mode buffer, you can use the unicode character brvbar which looks like
2217    this: \brvbar{}.
2218
2219 ** How can I change the indentation of an entire table without fixing every line by hand?
2220    :PROPERTIES:
2221    :CUSTOM_ID: change-indentation-entire-table
2222    :END:
2223
2224 #+index: Table!Indentation
2225
2226    The indentation of a table is set by the first line.  So just fix the
2227    indentation of the first line and realign with =TAB=.
2228
2229 ** In my huge table the realigning after each TAB takes too long.  What can I do?
2230    :PROPERTIES:
2231    :CUSTOM_ID: table-realigning-after-TAB-takes-long
2232    :END:
2233
2234 #+index: Table!Realign
2235
2236    Either split the table into several by inserting an empty line every
2237    100 lines or so.  Or turn off the automatic re-align with
2238
2239    : (setq org-table-automatic-realign nil)
2240
2241    After this the only way to realign a table is to press =C-c C-c=.  It
2242    will no longer happen automatically, removing the corresponding delays
2243    during editing.
2244
2245 ** Recalculation of my table takes too long.  What can I do?
2246    :PROPERTIES:
2247    :CUSTOM_ID: Recalculation-of-my-table-takes-too-long
2248    :END:
2249
2250 #+index: Table!Calculation
2251
2252    Nothing, really.  The spreadsheet in org is mostly done to make
2253    calculations possible, not so much to make them fast.  Since Org-mode is
2254    firmly committed to the ASCII format, nothing is stopping you from
2255    editing the table by hand.  Therefore, there is no internal
2256    representation of the data.  Each time Org-mode starts a computation, it
2257    must scan the table for special lines, find the fields etc.  This is
2258    slow.  Furthermore, Calc is slow compared to hardware computations.  To
2259    make this work with normal editing, recalculation is not happening
2260    automatically, or only for the current line, so that the long wait for a
2261    full table iteration only happens when you ask for it.
2262
2263    So for really complex tables, moving to a "real" spreadsheet may
2264    still be the best option.
2265
2266    That said, there are some ways to optimize things in Org-mode, and I
2267    have been thinking about moving a bit further down this line.
2268    However, for my applications this has so far not been an issue at
2269    all.  If you have a good case, you could try to convince me.
2270
2271 ** When I export tables to HTML, they don't have borders.
2272    :PROPERTIES:
2273    :CUSTOM_ID: table-borders-in-html-export
2274    :END:
2275
2276 #+index: Table!HTML
2277
2278 By default, Org-mode exports tables without borders.
2279
2280 You can changed this by placing an =#+ATTR_HTML= line before the table:
2281
2282 :  #+ATTR_HTML: border="2" rules="all" frame="all"
2283
2284 See [[http://orgmode.org/manual/Tables-in-HTML-export.html#Tables-in-HTML-export][the manual]] for more details.
2285
2286 ** Why does the Calc high precision (e. g. =p20=) not work like expected?
2287    :PROPERTIES:
2288    :CUSTOM_ID: table-high-precision
2289    :END:
2290
2291 - *Short answer*
2292
2293   Avoid
2294   : | 1 / 2 * 3 | 0.16666667000000 |
2295   : #+TBLFM: $2 = $1; p20 %.14f
2296
2297   and use
2298   : | 1 / 2 * 3 | 0.16666666666667 |
2299   : #+TBLFM: $2 = $1 +.0; p20 f-14
2300
2301 - *Longer answer*
2302
2303   It is important to distinguish between the precision of
2304   1) =p20=: Calc internal calculation (=calc-internal-prec=)
2305   2) =f-14=: Calc float formatting, unlimited in precision (=calc-float-format=)
2306   3) =%.14f=: the =printf= reformatting, limited in precision
2307
2308   See [[http://orgmode.org/manual/Formula-syntax-for-Calc.html#Formula-syntax-for-Calc][the Org manual]] (org-version 6.35 or newer) for more details.
2309
2310   Use =C-h v org-calc-default-modes RET= to check the Org default settings
2311   which are used if no format specifiers are added to a table formula.
2312   The examples below have been made with the out_of_the_box Org defaults
2313   =calc-internal-prec = 12= and =calc-float-format = 8=.
2314
2315   Remember the formula debugger, toggled with =C-c {=,
2316   to view the processing stages like:
2317   |   | formula debugger label | processing stage           |
2318   | / | <                      | <>                         |
2319   |---+------------------------+----------------------------|
2320   |   | Result:                | output of Calc             |
2321   |   | Format:                | reformatting with =printf= |
2322
2323   Following are some examples to demonstrate
2324   the interaction of the three precisions.
2325
2326   - *display precision limitations for Calc formulas*
2327     - limited by Calc internal calculation precision from Org default
2328       (here =p12=)
2329       : | 0.16666666666700 |
2330       : #+TBLFM: $1 = 1 / 2 * 3;     f-14
2331
2332       : | 0.1666666666670000000 |
2333       : #+TBLFM: $1 = 1 / 2 * 3;     f-19
2334
2335     - limited by Calc float format from Org default (here =f8=)
2336       : | 0.16666667 |
2337       : #+TBLFM: $1 = 1 / 2 * 3
2338
2339       : | 0.16666667 |
2340       : #+TBLFM: $1 = 1 / 2 * 3; p20
2341
2342       : | 0.16666667000000 |
2343       : #+TBLFM: $1 = 1 / 2 * 3;          %.14f
2344
2345       : | 0.16666667000000 |
2346       : #+TBLFM: $1 = 1 / 2 * 3; p20      %.14f
2347
2348     - limited by Calc float format specified
2349       : | 0.166667 |
2350       : #+TBLFM: $1 = 1 / 2 * 3;     f-6
2351
2352       : | 0.16666666666667 |
2353       : #+TBLFM: $1 = 1 / 2 * 3; p20 f-14
2354
2355       : | 0.1666666666666666667 |
2356       : #+TBLFM: $1 = 1 / 2 * 3; p20 f-19
2357
2358     - limited by =printf= conversion to Emacs Lisp float
2359       : | 0.1666666699999999900 | the inaccuracy is platform dependent |
2360       : #+TBLFM: $1 = 1 / 2 * 3;          %.19f
2361
2362       : | 0.1666666699999999900 | the inaccuracy is platform dependent |
2363       : #+TBLFM: $1 = 1 / 2 * 3; p20      %.19f
2364
2365       : | 0.1666666666666666600 | the inaccuracy is platform dependent |
2366       : #+TBLFM: $1 = 1 / 2 * 3; p20 f-20 %.19f
2367
2368     - limited by =printf= format specified
2369       : | 0.166667 |
2370       : #+TBLFM: $1 = 1 / 2 * 3;         %.6f
2371
2372   - *display precision limitations for Emacs Lisp formulas*
2373     - limited by Emacs Lisp float
2374       : | 0.16666666666666666 |
2375       : #+TBLFM: $1 = '(/ 1.0 (* 2 3))
2376
2377       : | 0.1666666666666666574 | the inaccuracy is platform dependent |
2378       : #+TBLFM: $1 = '(/ 1.0 (* 2 3)); %.19f
2379
2380     - limited by =printf= format specified
2381       : | 0.16666666666667 |
2382       : #+TBLFM: $1 = '(/ 1.0 (* 2 3)); %.14f
2383
2384 This FAQ entry is based on this [[http://thread.gmane.org/gmane.emacs.orgmode/22642][mailing list thread]]
2385 and is continued in the [[#table-float-fraction][next FAQ entry]].
2386
2387 ** Which float format shows the fraction part also when the latter is zero?
2388    :PROPERTIES:
2389    :CUSTOM_ID: table-float-fraction
2390    :END:
2391
2392 - *Short answer*
2393
2394   Avoid
2395    : | 1 | 1 |
2396    : #+TBLFM: $2 = $1; f-3
2397   and use
2398    : | 1 | 1.000 |
2399    : #+TBLFM: $2 = $1 +.0; f-3
2400
2401 - *Longer answer*
2402
2403   For =f3= and =f-3= see =`d f' (`calc-fix-notation')= in [[http://www.delorie.com/gnu/docs/calc/calc.html#SEC_Top][the Calc manual]]
2404   in the section Mode Settings -> Display Modes -> Float Formats
2405   [[http://www.delorie.com/gnu/docs/calc/calc_163.html][found here as long as the section numbering is unchanged]].
2406
2407   Remember the formula debugger, toggled with =C-c {=,
2408   to view the processing stages like:
2409   |   | formula debugger label | processing stage           |
2410   | / | <                      | <>                         |
2411   |---+------------------------+----------------------------|
2412   |   | Result:                | output of Calc             |
2413   |   | Format:                | reformatting with =printf= |
2414
2415   Following are some examples to demonstrate different float formats.
2416
2417   - normal precision
2418     : |-----------+---------+-------+---------+----------+-------|
2419     : |    number |      f3 |   f-3 | +.0; f3 | +.0; f-3 |  %.3f |
2420     : |-----------+---------+-------+---------+----------+-------|
2421     : |         1 |       1 |     1 |   1.000 |    1.000 | 1.000 |
2422     : |         0 |       0 |     0 |   0.000 |    0.000 | 0.000 |
2423     : |-----------+---------+-------+---------+----------+-------|
2424     : |       1.0 |   1.000 | 1.000 |   1.000 |    1.000 | 1.000 |
2425     : |       0.0 |   0.000 | 0.000 |   0.000 |    0.000 | 0.000 |
2426     : |-----------+---------+-------+---------+----------+-------|
2427     : | 1.0001666 |   1.000 | 1.000 |   1.000 |    1.000 | 1.000 |
2428     : | 0.0001666 | 1.67e-4 | 0.000 | 1.67e-4 |    0.000 | 0.000 |
2429     : |-----------+---------+-------+---------+----------+-------|
2430     : | 1.0016666 |   1.002 | 1.002 |   1.002 |    1.002 | 1.002 |
2431     : | 0.0016666 |   0.002 | 0.002 |   0.002 |    0.002 | 0.002 |
2432     : |-----------+---------+-------+---------+----------+-------|
2433     : #+TBLFM: $2 = $1; f3 :: $3 = $1; f-3 :: $4 = $1 +.0; f3 :: $5 = $1 +.0; f-3 :: $6 = $1; %.3f
2434
2435   - high precision
2436     : |----------------------+--------------------------+-----------------------|
2437     : | number               |                      f19 |                  f-19 |
2438     : |----------------------+--------------------------+-----------------------|
2439     : | 1                    |                        1 |                     1 |
2440     : | 0                    |                        0 |                     0 |
2441     : |----------------------+--------------------------+-----------------------|
2442     : | 1.0                  |    1.0000000000000000000 | 1.0000000000000000000 |
2443     : | 0.0                  |    0.0000000000000000000 | 0.0000000000000000000 |
2444     : |----------------------+--------------------------+-----------------------|
2445     : | 1 + 1 / 2 * 3 * 1e19 |    1.0000000000000000000 | 1.0000000000000000000 |
2446     : | 0 + 1 / 2 * 3 * 1e19 | 1.666666666666666667e-20 | 0.0000000000000000000 |
2447     : |----------------------+--------------------------+-----------------------|
2448     : | 1 + 1 / 2 * 3 * 1e18 |    1.0000000000000000002 | 1.0000000000000000002 |
2449     : | 0 + 1 / 2 * 3 * 1e18 |    0.0000000000000000002 | 0.0000000000000000002 |
2450     : |----------------------+--------------------------+-----------------------|
2451     : #+TBLFM: $2 = $1; p20 f19 :: $3 = $1; p20 f-19
2452
2453     : |----------------------+--------------------------+-----------------------|
2454     : | number               |                 +.0; f19 |             +.0; f-19 |
2455     : |----------------------+--------------------------+-----------------------|
2456     : | 1                    |    1.0000000000000000000 | 1.0000000000000000000 |
2457     : | 0                    |    0.0000000000000000000 | 0.0000000000000000000 |
2458     : |----------------------+--------------------------+-----------------------|
2459     : | 1.0                  |    1.0000000000000000000 | 1.0000000000000000000 |
2460     : | 0.0                  |    0.0000000000000000000 | 0.0000000000000000000 |
2461     : |----------------------+--------------------------+-----------------------|
2462     : | 1 + 1 / 2 * 3 * 1e19 |    1.0000000000000000000 | 1.0000000000000000000 |
2463     : | 0 + 1 / 2 * 3 * 1e19 | 1.666666666666666667e-20 | 0.0000000000000000000 |
2464     : |----------------------+--------------------------+-----------------------|
2465     : | 1 + 1 / 2 * 3 * 1e18 |    1.0000000000000000002 | 1.0000000000000000002 |
2466     : | 0 + 1 / 2 * 3 * 1e18 |    0.0000000000000000002 | 0.0000000000000000002 |
2467     : |----------------------+--------------------------+-----------------------|
2468     : #+TBLFM: $2 = $1 +.0; p20 f19 :: $3 = $1 +.0; p20 f-19
2469
2470     The =printf= reformatting (=%.19f=) cannot be used with high precision,
2471     see the [[#table-high-precision][previous FAQ entry]].
2472
2473 ** How can I center tables in LaTeX output?
2474    :PROPERTIES:
2475    :CATEGORY: centered-tables-in-latex
2476    :END:
2477
2478 #+index: Table!Center
2479
2480 Set the `org-export-latex-tables-centered' to `t':
2481
2482 : (defcustom org-export-latex-tables-centered t
2483 :   "When non-nil, tables are exported in a center environment."
2484 :   :group 'org-export-latex
2485 :   :type 'boolean)
2486
2487 ** Can I exclude columns from a table when exporting it?
2488
2489 No.  
2490
2491 * Markup
2492   :PROPERTIES:
2493   :CUSTOM_ID: Footnotes
2494   :END:
2495 ** How can I get automatic renumbering of footnotes in org-mode?
2496    :PROPERTIES:
2497    :CUSTOM_ID:       footnote-auto-adjust
2498    :END:
2499
2500 #+index: Footnotes!Renumbering
2501
2502 You can add the following line to your .emacs file:
2503
2504 : (setq org-footnote-auto-adjust t)
2505
2506 Or, if you prefer, you can turn this option on locally by placing the
2507 following line at the top of your org file:
2508
2509 : #+STARTUP: fnadjust
2510
2511 When auto-adjust is turned on, footnotes in the file with numerical
2512 labels will be renumbered whenever a new footnote is added. Meanwhile,
2513 all footnotes, including those with custom labels such
2514 =[fn:custom-label ]=, will be sorted in the order of their appearance
2515 in the text.
2516
2517 This emulates the footnote behavior that many users may be familiar
2518 with from word-processing programs or from the footnote-mode included
2519 with emacs.
2520
2521 If you do not turn on org-footnote-auto-adjust, you sort and/or
2522 renumber footnotes at any time by calling org-footnote-action with a
2523 prefix argument.
2524
2525 ** Why isn't auto renumbering of footnotes turned on by default?
2526    :PROPERTIES:
2527    :CUSTOM_ID:       why-no-default-auto-adjust
2528    :END:
2529
2530 Org-mode has a very robust footnote mechanism allowing for a variety of
2531 types of footnotes. With some of the following footnote notations,
2532 auto-adjust may be either irrelevant or undesired:
2533
2534  - Automatically numbered
2535  - Footnotes with custom labels
2536  - Inline footnotes
2537
2538 In addition, Org-mode can be customized to place footnotes either at
2539 the end of a document or at the end of the outline heading in which
2540 they appear. Users who change this setting while editing a document
2541 may be disconcerted to find all of their footnotes rearranged
2542 automatically.
2543
2544 ** I have auto-fill-mode set and org-mode is inserting unwanted comment markers!
2545    :PROPERTIES:
2546    :CUSTOM_ID: auto-fill-and-unwanted-comments
2547    :END:
2548
2549 If the following occurs:
2550
2551 #+begin_src org
2552   ,#+OPTIONS: toc:nil
2553   ,Some entered text.
2554   ,# More entered tex.
2555 #+end_src
2556
2557 Make sure that the variable comment-start is nil.
2558
2559 ** Are there any shortcuts for entering source blocks and comment lines?
2560    :PROPERTIES:
2561    :CUSTOM_ID: shortcuts-for-entering-source-blocks
2562    :END:
2563
2564 Org-mode has some [[http://orgmode.org/manual/Literal-examples.html#Literal-examples][very convenient markup]] for including literal blocks and
2565 lines of code in a file.  (This is especially useful when exporting
2566 documents or using the contributed package [[file:org-contrib/babel/index.org][org-babel]] for executing blocks
2567 of code.)
2568
2569 #+begin_src org
2570   ,#+begin_src perl
2571   ,  print "Hello, world!\n";
2572   ,#+end_src
2573 #+end_src
2574
2575 It can be tiresome to enter the block comment lines manually. There are
2576 several possible shortcuts you can use to enter them:
2577
2578 1) Built-in expansion
2579
2580    - Org-mode has a "secret" method of expanding source code blocks
2581      and comment lines.
2582
2583    - If you type "<s" followed by =TAB= or =M-TAB=, a source block will
2584      magically appear.
2585
2586    - For a full list of expansions, type =M-x describe-variable
2587      [RET] org-structure-template-alist=.
2588
2589 2) [[http://orgmode.org/manual/Literal-examples.html#Literal-examples][Registers]]
2590
2591    - Add the following line to your emacs file:
2592
2593      =(set-register ?p "#+begin_src\n\n#+end_src perl")=
2594
2595    - Then type =C-x r i p= to insert the source block. Please note: if
2596      you save another value to the register "p" with =C-x r s p=, it
2597      will overwrite the setting above for the current emacs session.
2598
2599 3) [[http://orgmode.org/manual/Literal-examples.html#Literal-examples][Abbrevs]]
2600
2601    - Activate the abbrev minor-mode in org-mode:
2602
2603      + M-x abbrev-mode
2604
2605      + /Permanently/:
2606
2607        + =(add-hook 'org-mode-hook (lambda () (abbrev-mode 1)))=
2608
2609    - In org-mode, type "sbp" (a sample abbreviation for a perl source
2610      block).
2611
2612    - Immediately after "sbp" type =C-x a i l=.
2613
2614    - Enter the expansion:
2615
2616      - =#+begin_src perl[C-q C-j][C-q C-j]#+end_src=
2617
2618      - Note: =C-q C-j= creates a new line in the minibuffer
2619
2620    - Now, whenever, you type sbp followed by =SPACE= or =RET= in an
2621      org-mode buffer, the src block will magically appear.
2622
2623    - To review your list of abbrevs, type =M-x edit-abbrevs=.
2624
2625 4) [[http://www.slashgear.com/nokia-n900-android-dual-boot-hack-video-2371099/][Skeletons]]
2626
2627    - Skeletons offer a simple way of automatically entering text.
2628      Here's a skeleton that queries for the type of block and wraps
2629      the active region inside it:
2630
2631      #+begin_src elisp
2632        (define-skeleton skel-org-block
2633          "Insert an org block, querying for type."
2634          "Type: "
2635          "#+begin_" str "\n"
2636          _ - \n
2637          "#+end_" str "\n")
2638      #+end_src
2639
2640    - Simply type skel-org-block to insert the block.
2641
2642      - You can bind this to a key.
2643
2644      - You can also create an abbrev that invokes this function:
2645
2646        : (define-abbrev org-mode-abbrev-table "blk" "" 'skel-org-block)
2647
2648 5) [[http://code.google.com/p/yasnippet/][Yasnippet]]
2649
2650    - Several org-mode users install yasnippet for convenient, complex
2651      expansion.
2652
2653    - See Bernt Hansen's [[http://doc.norang.ca/org-mode.html#Yasnippets][org-mode setup]] for a good introduction to
2654      yasnippet.
2655
2656 * Capture and remember
2657   :PROPERTIES:
2658   :CUSTOM_ID: Remember
2659   :END:
2660
2661 ** Can I use a variable or a function inside the `org-capture-templates' variable?
2662    :PROPERTIES:
2663    :CUSTOM_ID: variable-inside-capture-templates
2664    :END:
2665
2666 #+index: Capture
2667
2668 Yes.  Use [[http://www.gnu.org/s/emacs/manual/html_node/elisp/Backquote.html][backquotes]].
2669
2670 E.g. if you have a variable called =org-test-file= and you want the
2671 variable =org-capture-templates= to "understand" (i.e. evaluate)
2672 =org-test-file= when Emacs evaluates the =(setq org-capture-templates
2673 [...])= expression, use backquotes like this:
2674
2675 #+begin_src emacs-lisp
2676 (setq org-capture-templates
2677       `(("t" "Todo" entry (file+headline ,org-test-file "Tasks")
2678        "* TODO %?\n  %i\n  %a")
2679       ("b" "Buy" item (file+olp ,org-test-file "Stuff to Buy" "House")
2680        "")))
2681 #+end_src
2682
2683 ** Can I use the remember buffer to clock a customer phone call?
2684    :PROPERTIES:
2685    :CUSTOM_ID: use-remember-buffer-to-clock-phone-call
2686    :END:
2687
2688   Yes, you can.  Take a look at the [[http://thread.gmane.org/gmane.emacs.orgmode/5482][setup described by Bernt Hansen]] and
2689   check out (in the same thread) what Nick Docos had to fix to make Bernt's
2690   set-up work for him.
2691
2692 ** Can I automatically start the clock when opening a remember template?
2693    :PROPERTIES:
2694    :CUSTOM_ID: start-clock-when-opening-remember-template
2695    :END:
2696
2697 #+index: Clock!Start
2698
2699    Yes, this is possible.  Use the following code and make sure that
2700    after executing it, `my-start-clock-if-needed' is in
2701    `remember-mode-hook' /after/ `org-remember-apply-template'.
2702
2703    : (add-hook 'remember-mode-hook 'my-start-clock-if-needed 'append)
2704    : (defun my-start-clock-if-needed ()
2705    :   (save-excursion
2706    :     (goto-char (point-min))
2707    :     (when (re-search-forward " *CLOCK-IN *" nil t)
2708    :       (replace-match "")
2709    :       (org-clock-in))))
2710
2711    Then, when a template contains the key string CLOCK-IN, the clock
2712    will be started.  Starting with Org-mode version 5.20, the clock will
2713    automatically be stopped when storing the remember buffer.
2714
2715 * Searches
2716   :PROPERTIES:
2717   :CUSTOM_ID: Searches
2718   :END:
2719
2720 ** Isearch does not find string hidden in links.  What can I do?
2721    :PROPERTIES:
2722    :CUSTOM_ID: isearch-in-links
2723    :END:
2724
2725 #+index: Isearch
2726
2727   M-x =visible-mode= will display the full link, making them searchable.
2728
2729 ** How can I reduce the amount of context shown in sparse trees?
2730    :PROPERTIES:
2731    :CUSTOM_ID: context-in-sparse-trees
2732    :END:
2733
2734 #+index: Context
2735
2736    Take a look at the following variables:
2737
2738    - =org-show-hierarchy-above=
2739    - =org-show-following-headline=
2740    - =org-show-siblings=
2741    - =org-show-entry-blow=
2742
2743    which give command-dependent control over how much context is shown by a
2744    particular operation.
2745
2746 ** How can I combine the results of two calls to =org-occur=?
2747    :PROPERTIES:
2748    :CUSTOM_ID: two-calls-to-org-occur
2749    :END:
2750
2751 #+index: Occur
2752
2753    You can construct a regular expression that matches all targets you
2754    want.  Alternatively, use a =C-u= prefix with the second and any
2755    further calls to =org-occur= to keep the current visibility and
2756    highlighting in addition to the new ones.
2757
2758 * Agenda
2759   :PROPERTIES:
2760   :CUSTOM_ID: Agenda
2761   :END:
2762
2763 ** How can I change the advanced warning time for deadlines?
2764    :PROPERTIES:
2765    :CUSTOM_ID: warning-period-for-deadlines
2766    :END:
2767 ##<<warning-period-for-deadlines>>
2768
2769 #+index: DEADLINE!Warning
2770
2771 Deadline warnings appear in the daily agenda view a specified number
2772 of days before the deadline is due. The default setting is 14 days.
2773 You can change this with the variable =org-deadline-warning-days=.
2774 (See [[http://orgmode.org/manual/Deadlines-and-scheduling.html#Deadlines-and-scheduling][this section]] of the manual.)
2775
2776 For instance,
2777
2778 : (setq org-deadline-warning-days 30)
2779
2780 would cause warnings for each deadline to appear 30 days in advance.
2781
2782 Naturally, you might not want warnings for all of your deadlines to
2783 appear so far in advance. Thus, you can change the lead time for
2784 individual items as follows:
2785
2786 : * TODO Get a gift for the party
2787 :   DEADLINE: <2009-01-16 Fri -2d>
2788
2789 The "-2d" above changes the lead time for this deadline warning to two
2790 days in advance. You can also use "w" for weeks and "m" for months.
2791
2792 ** How can I postpone a task until a certain date?
2793    :PROPERTIES:
2794    :CUSTOM_ID: deferring-tasks
2795    :END:
2796
2797 #+index: Postpone
2798
2799 The easiest way to postpone a task is to schedule it in the future.  For
2800 instance, typing =C-c C-s +2w= on a headline will push a task two weeks
2801 into the future, so that it won't show up on the daily agenda until two
2802 weeks from now.
2803
2804 If you'd like to prevent the task from showing up on your global todo list,
2805 you have a couple of options.
2806
2807 1. You can set the variable =org-agenda-todo-ignore-scheduled= to
2808    =t=.  This will exclude any scheduled items from your global list of
2809    active todos (=C-c a t=). (The variable
2810    =org-agenda-todo-ignore-with-date= will exclude both scheduled and
2811    deadline items from your todo list).
2812
2813 2. You can remove the todo keyword from the item (C-c C-t <SPC>). The item
2814    will still appear on your agenda two weeks from today, but it won't show
2815    up on your todo lists.
2816
2817 ** Can I send myself an email containing tasks or other agenda info?
2818    :PROPERTIES:
2819    :CUSTOM_ID: email-containing-tasks-or-other-agenda-info
2820    :END:
2821
2822    Yes.  See [[http://article.gmane.org/gmane.emacs.orgmode/6112][this thread]] on the list.
2823
2824 ** How can I limit the agenda view to my "work" tasks?
2825    :PROPERTIES:
2826    :CUSTOM_ID: limit-agenda-with-tag-filtering
2827    :END:
2828
2829 #+index: FILETAGS
2830
2831    It is often convenient to group org files into separate categories, such
2832    as "home" and "work" (or "personal" and "professional"). One of the main
2833    reasons for such classification is to create agenda views that are
2834    limited by type of work or area of responsibility.  For instance, while
2835    at work, one may want to see only professional tasks; while away from
2836    work, one may want to see only personal tasks.
2837
2838    One way to categorize files and tasks is to use a "#+FILETAGS"
2839    declaration at the top of each file, such as:
2840
2841    : #+FILETAGS: work
2842
2843    As long as org-use-tag-inheritance is turned on, the filetags will
2844    be inherited by all tasks in the file. A file can have multiple
2845    filetags. And, of course, tags can be added to individual headings.
2846
2847    Tasks can be quickly filtered by tag from within the agenda by
2848    typing "/" and the name of the tag. The full key sequence to filter
2849    for work items in an agenda view would be:
2850
2851    : C-c a a / work [or a tag shortcut]
2852
2853 ** How can I limit the agenda view to a particular category?
2854    :PROPERTIES:
2855    :CUSTOM_ID: limit-agenda-with-category-match
2856    :END:
2857
2858 #+index: Agenda view!Category
2859
2860    Another way to filter agenda views by type of work is to use a
2861    "#+CATEGORY" declaration at the top of each file, such as:
2862
2863    : #+CATEGORY: work
2864
2865    Categories can also be added to individual headings within a file:
2866
2867    : * Big project
2868    :   :PROPERTIES:
2869    :   :CATEGORY: work
2870    :   :END:
2871
2872    All todos belonging to the category "work" can be found a with a
2873    simple tags-todo search:
2874
2875    : C-c a M
2876
2877    At the prompt, type:
2878
2879    : CATEGORY="work"
2880
2881    The same results can be achieved with custom agenda commands, such as:
2882
2883 #+BEGIN_SRC emacs-lisp
2884 (setq org-agenda-custom-commands
2885       '(("h" tags-todo "CATEGORY=\"home\"")
2886         ("w" tags-todo "CATEGORY=\"work\"")
2887         ;; other custom agenda commands here
2888         ))
2889 #+END_SRC
2890
2891 ** How can include all org files in a directory in my agenda?
2892    :PROPERTIES:
2893    :CUSTOM_ID: set-agenda-files-using-wildcards
2894    :END:
2895
2896 #+index: Agenda!Directory
2897
2898 You can simply include the directory (as one of the items) in the value of
2899 the variable org-agenda-files:
2900
2901 : (setq org-agenda-files '("/my/special/path/org/"))
2902
2903 There is another way of accomplishing the same end:
2904
2905 : (setq org-agenda-files (file-expand-wildcards "/my/special/path/org/*.org"))
2906
2907 ** Why aren't items disappearing from my agenda once they are marked done?
2908    :PROPERTIES:
2909    :CUSTOM_ID: removing-done-items-from-agenda
2910    :END:
2911
2912 If items remain on your daily/weekly agenda after they are marked done,
2913 check the configuration of the following variables:
2914
2915 : org-agenda-skip-scheduled-if-done
2916 : org-agenda-skip-deadline-if-done
2917 : org-agenda-skip-timestamp-if-done
2918
2919 For instance, type:
2920
2921 : M-x customize-variable RET org-agenda-skip-scheduled-if-done
2922
2923 If this variable is turned off (=nil=), then scheduled items will
2924 remain on the agenda even after they are marked done.
2925
2926 If the variable is turned on (=t=), then scheduled items will
2927 disappear from the agenda after they are marked done.
2928
2929 If these settings seem not to behave the way you expect, then make
2930 sure you understand [[scheduled-vs-deadline-vs-timestamp][the
2931 difference between SCHEDULED, DEADLINE, and timestamps]].
2932
2933 ** How do I keep repeating timestamps from being displayed multiple times?
2934    :PROPERTIES:
2935    :CUSTOM_ID: repeating-timestamps-show-once
2936    :END:
2937
2938 #+index: Timestamp!Repeating
2939
2940 To show only the /current/ instance of a repeating timestamp, put the
2941 following in your .emacs:
2942
2943 #+begin_src emacs-lisp
2944 (setq org-agenda-repeating-timestamp-show-all nil)
2945 #+end_src
2946
2947 ** What is the difference between SCHEDULED, DEADLINE, and plain timestamps?
2948    :PROPERTIES:
2949    :CUSTOM_ID: scheduled-vs-deadline-vs-timestamp
2950    :END:
2951
2952 #+index: SCHEDULED
2953 #+index: DEADLINE
2954 #+index: Timestamp
2955
2956 1. SCHEDULED items (set with =C-c C-s=) will appear on your agenda on
2957    the day they are scheduled and on every day thereafter until they
2958    are done. Schedule a task if you want to be reminded to do
2959    something beginning on a certain day and until it is done.
2960
2961    : ** TODO Scheduled item
2962    :    SCHEDULED: <2009-03-01 Sun>
2963
2964 2. Items with a DEADLINE timestamp (set with =C-c C-d=) appear on your
2965    agenda in advance of the when they are due and remain on your
2966    agenda until they are done. Add a DEADLINE to an item if you want
2967    to make sure to complete it by a certain date. (The variable
2968    org-deadline-warning-days determines how far in advance items with
2969    deadlines will show up in the agenda. See [[warning-period-for-deadlines][this FAQ]] for more
2970    information.)
2971
2972    : ** TODO Item with a deadline
2973    :    DEADLINE: <2009-01-20 Tue>
2974
2975 3. An active timestamp (set with =C-c .=) will appear on your agenda
2976    only on the day it is scheduled. Use a timestamp for appointments
2977    or any reminders you want to show up only on a particular day.
2978
2979    : ** TODO Item with an active timestamp
2980    : <2009-04-18 Sat>
2981
2982 Note: items with inactive timestamps (set with C-c ! and marked by
2983 square brackets) will not show up in the agenda at all.
2984
2985 ** Can I add files recursively to my list of agenda files?
2986    :PROPERTIES:
2987    :CUSTOM_ID: set-agenda-files-recursively
2988    :END:
2989
2990 Yes, you can use the library =find-lisp=.
2991
2992 : (load-library "find-lisp")
2993 : (setq org-agenda-files (find-lisp-find-files "~/org" "\.org$"))
2994
2995 This will add all files ending in =org= in the directory "~/org"
2996 and all of its subdirectories to your list of agenda files.
2997
2998 If on a *nix machine, you can also use the find utility, which can be
2999 faster than the find-lisp library:
3000
3001 : (setq org-agenda-files
3002 :       (mapcar 'abbreviate-file-name
3003 :               (split-string
3004 :                (shell-command-to-string "find ~/org -name \"*.org\"") "\n")))
3005
3006
3007 See [[http://thread.gmane.org/gmane.emacs.orgmode/8992][this thread]] on the mailing list for more information.
3008
3009 ** Why does an item appearing at the wrong time of day in my agenda?
3010    :PROPERTIES:
3011    :CUSTOM_ID: agenda-wrong-time-of-day
3012    :END:
3013
3014 When preparing the agenda view, org-mode scans each relevant headline for a
3015 time designation.  This approach is very nice for adding free-form
3016 timestamps to an item for scheduling.  Thus, either of the following work
3017 would work to schedule an item at 10:00am:
3018
3019 #+begin_src org
3020   ,** 10:00am Get dried ice at the magic store
3021   ,   SCHEDULED: <2009-05-27 Wed>
3022 #+end_src
3023
3024 #+begin_src org
3025   ,** Get dried ice at the magic store
3026   ,   SCHEDULED: <2009-05-27 Wed 10:00>
3027 #+end_src
3028
3029 To enable this flexibility, org-mode scans the entire headline for time of
3030 day notation. A potential problem can arise if you use inactive timestamps
3031 in the headline to note when an item was created.  For example :
3032
3033 #+begin_src org
3034   ,** Get dried ice at the magic store [2009-05-26 Tue 12:58]
3035   ,   SCHEDULED: <2009-05-27 Wed>
3036 #+end_src
3037
3038 Org-mode would interpret the time in the inactive timestamp as a
3039 time-of-day indicator and the entry would appear in your agenda at
3040 12:58.
3041
3042 If you would like to turn off the time-of-day search, you can configure the
3043 variable =org-agenda-search-headline-for-time= (requires org-mode >= 6.24).
3044
3045 ** How can I change the visibility of an item from the agenda?
3046    :PROPERTIES:
3047    :CUSTOM_ID: cycling-visibility-from-agenda
3048    :END:
3049
3050 #+index: Agenda!Visibility
3051
3052 You can add a keybinding as follows:
3053
3054 #+begin_src emacs-lisp
3055 (add-hook 'org-agenda-mode-hook
3056    (lambda ()
3057      (define-key org-agenda-mode-map " " 'org-agenda-cycle-show)))
3058 #+end_src
3059
3060 Then, as you press SPACE on an item on the agenda, it will cycle the
3061 visibility of its original location.
3062
3063 ** Is there any way to set org-mode so that tags don't appear in the agenda view?
3064
3065 See the =org-agenda-remove-tags= variable.
3066
3067 ** I work late at night! How can I extend my current day past midnight?
3068    :PROPERTIES:
3069    :CUSTOM_ID: org-extend-today-until
3070    :END:
3071
3072 If you work past midnight, you may not want your daily agenda view to
3073 switch to the next day at 12 a.m. (the default). To extend your day, simply
3074 set the value of org-extend-today-until to a positive number corresponding
3075 to the number of hours you work past midnight. For example, the following
3076 setting will cause the current day to extend until 6 a.m.
3077
3078 : (setq org-extend-today-until 6)
3079
3080 * Appointments/Diary
3081   :PROPERTIES:
3082   :CUSTOM_ID: Appointments/Diary
3083   :END:
3084 ** Is it possible to include entries from org-mode files into my emacs diary?
3085    :PROPERTIES:
3086    :CUSTOM_ID: include-entries-from-org-mode-files-into-emacs-diary
3087    :END:
3088
3089 #+index: Diary
3090
3091    Since the org-mode agenda is much more powerful and can contain the
3092    diary, you should think twice before deciding to do this.  If you
3093    insist, however, integrating Org-mode information into the diary is
3094    possible.  You need to turn on /fancy diary display/ by setting in
3095    .emacs:
3096
3097    : (add-hook 'diary-display-hook 'diary-fancy-display)
3098
3099    Then include the following line into your ~/diary file, in
3100    order to get the entries from all files listed in the variable
3101    =org-agenda-files=
3102
3103    : &%%(org-diary)
3104
3105    You may also select specific files with
3106
3107    : &%%(org-diary) ~/path/to/some/org-file.org
3108    : &%%(org-diary) ~/path/to/another/org-file.org
3109
3110    If you now launch the calendar and press ~d~ to display a
3111    diary, the headlines of entries containing a timestamp, date range,
3112    schedule, or deadline referring to the selected date will be listed.
3113    Just like Org-mode's agenda view, the diary for /today/ contains
3114    additional entries for overdue deadlines and scheduled items.  See
3115    also the documentation of the =org-diary= function.  Under XEmacs, it
3116    is not possible to jump back from the diary to the org, this works
3117    only in the agenda buffer.
3118 ** I want to add my Org scheduled/deadlined entries in my diary!
3119    :PROPERTIES:
3120    :CUSTOM_ID: add-Org-scheduled/deadlined-entries-to-diary!
3121    :END:
3122
3123    Put this in your ~/.diary:
3124
3125    : &%%(org-diary :scheduled :timestamp :deadline)
3126
3127 ** How can I set up automatic reminders based on Org information?
3128    :PROPERTIES:
3129    :CUSTOM_ID: automatic-reminders
3130    :END:
3131
3132 #+index: Reminders
3133
3134   See [[http://article.gmane.org/gmane.emacs.orgmode/5271][this post]] by N. Dokos on the list. See also Russell Adams's hack in
3135   [[http://orgmode.org/worg/org-hacks.html#org-agenda-appt-zenity][org-hacks]].
3136
3137 ** How can I make =appt= notice my Org appointments?
3138    :PROPERTIES:
3139    :CUSTOM_ID: appt-notice-my-Org-appointments
3140    :END:
3141
3142 #+index: Appointment
3143 #+index: Appt
3144
3145   : M-x org-agenda-to-appt RET
3146
3147 ** How can I create more complex appointments in my org-files?
3148    :PROPERTIES:
3149    :CUSTOM_ID: diary-sexp-in-org-files
3150    :END:
3151
3152 #+index: Appointment
3153
3154 Org-mode's active timestamps work very well for scheduling individual
3155 or recurring appointments, such as:
3156
3157 #+begin_src org
3158   ,* 8:00am Dentist appointment <2009-01-16 Fri>
3159 #+end_src
3160
3161 or
3162 #+begin_src org
3163   ,* Vacation
3164   ,  <2009-03-20 Fri>--<2009-04-01 Wed>
3165 #+end_src
3166
3167 or
3168
3169 #+begin_src org
3170   ,* Weekly meeting with boss
3171   ,  <2009-01-20 Tue 14:00 +1w>
3172 #+end_src
3173
3174 Sometimes, however, you need to set up more complicated recurring
3175 appointments.  Org-mode has built-in support for many of [[http://www.gnu.org/software/emacs/manual/html_node/emacs/Sexp-Diary-Entries.html][the powerful sexp
3176 entries]] that work in [[http://www.gnu.org/software/emacs/manual/html_node/emacs/Diary.html#Diary][Emacs diary]].  
3177
3178 Let's say, for instance, that you teach a class that meets every Monday
3179 evening between February 16 and April 20, 2009. The way to enter this an
3180 org-mode file is:
3181
3182 #+begin_src org
3183   ,** Class 7:00pm-9:00pm
3184   ,   <%%(and (= 1 (calendar-day-of-week date)) (diary-block 2 16 2009 4 20 2009))>
3185 #+end_src
3186
3187 The expression above designates all Mondays that fall between February
3188 16 and April 20. How exactly does it work?
3189
3190  - (and... :: Indicates that *both* of the conditions that follow have
3191           to be true.
3192
3193    - (= 1 (calendar-day-of-week date)) :: Is the day of the week a
3194         Monday?
3195
3196        - Note: the function calendar-day-of-week converts the date to the day of week
3197          expressed in numeric form, where 0 = Sunday, 1 = Monday, and so on.
3198
3199    - (diary-block 2 16 2009 4 20 2009) :: Does the date fall between
3200         these two dates?
3201
3202 You can make a sexp as complex as you like. If you wanted to omit a week
3203 because of holidays, for instance, you could add another condition to the
3204 sexp:
3205
3206 #+begin_src org
3207   ,** Class 7:00pm-9:00pm
3208   ,   <%%(unless (diary-block 3 9 2009 3 13 2009) (and (= 1 (calendar-day-of-week date)) (diary-block 2 16 2009 4 20 2009)))>
3209 #+end_src
3210
3211 The sexp above would omit Monday during the week of March 9, 2009. For
3212 another way to accomplish the same thing, see [[org-diary-class][this FAQ]].
3213
3214 Another diary function commonly used for more complex scheduling is
3215 diary-float. For instance,
3216
3217 #+begin_src org
3218   ,* Monthly meeting
3219   ,  <%%(diary-float t 3 3)>
3220 #+end_src
3221
3222 ... would appear on the third Wednesday of every month.
3223
3224 For more ideas on how to create diary special expressions, see [[http://www.emacswiki.org/cgi-bin/wiki/DiaryMode][this
3225 page on the Emacs wiki]].
3226
3227 ** How can I schedule a weekly class that lasts for a limited period of time?
3228    :PROPERTIES:
3229    :CUSTOM_ID: org-class
3230    :END:
3231
3232 Org-mode offers a convenient diary sexp function for setting up a recurring
3233 appointment that lasts for a certain period of time, such as a class. It is
3234 called org-class and it can be entered as follows:
3235
3236 #+begin_src org
3237   ,** Class 7:00pm-9:00pm
3238   ,   <%%(org-class 2009 2 16 2009 4 20 1 10)>
3239 #+end_src
3240
3241 The function above schedules an appointment for every Monday (1)
3242 between February 16 and April 20, 2009, except for ISO week 10 (March
3243 1 to March 7).
3244
3245 If you would prefer not to place the timestamp in the headline, you can use
3246 the following format:
3247
3248 #+begin_src org
3249   ,** Class
3250   ,<%%(org-class 2009 2 16 2009 4 20 1 10)> 7:00pm-9:00pm Class
3251 #+end_src
3252
3253 In this case, the string following the sexp will be displayed in the
3254 agenda.
3255
3256 The function org-class has the following format:
3257
3258 : (org-class Y1 M1 D1 Y2 M2 D2 DAYNAME &rest SKIP-WEEKS)
3259
3260 Y1/2, M1/2, and D1/2 indicate the beginning and ending dates. DAYNAME takes
3261 the form of a number indicating the day of the week (0 = Sunday, 1 =
3262 Monday, and so on...). In addition, one can add an optional argument
3263 SKIP-WEEKS to indicate weeks on the calendar that should be skipped. This
3264 argument should be expressed as an ISO week number. You can find the number
3265 by invoking emacs' built-in calendar (=M-x calendar=), navigating to the
3266 appropriate week, and typing =p c (calendar-iso-print-date)=.  If one of
3267 the SKIP-WEEKS is the symbol =holidays=, then any holidays known to the
3268 calendar are also skipped.
3269
3270 Here is an alternative method, shared by Paul Sexton on the org mailing
3271 list:
3272
3273 Let's say you are taking night classes in Spanish. The class is every
3274 Wednesday evening at 7pm, starting on 18 August, and runs for 8
3275 weeks.  Org-mode's timestamps do not support limited occurrences of
3276 recurrent items -- you have to schedule the item with infinite recurrences,
3277 then delete it when it finishes.
3278
3279 To schedule the Spanish classes, put the following in your =.emacs=:
3280
3281 #+begin_src emacs-lisp
3282   (defun diary-limited-cyclic (recurrences interval m d y)
3283     "For use in emacs diary. Cyclic item with limited number of recurrences.
3284   Occurs every INTERVAL days, starting on YYYY-MM-DD, for a total of
3285   RECURRENCES occasions."
3286     (let ((startdate (calendar-absolute-from-gregorian (list m d y)))
3287           (today (calendar-absolute-from-gregorian date)))
3288       (and (not (minusp (- today startdate)))
3289            (zerop (% (- today startdate) interval))
3290            (< (floor (- today startdate) interval) recurrences))))
3291 #+end_src
3292
3293 The item in the org file looks like this:
3294
3295 #+begin_src org
3296   ,** 19:00-21:00 Spanish lessons
3297   ,   <%%(diary-limited-cyclic 8 7 8 18 2010)>
3298 #+end_src
3299
3300 ** How can I set an event to occur every day except Saturday and Sunday?
3301
3302 #+begin_src org
3303   ,** Daily meeting
3304   ,   <%%(memq (calendar-day-of-week date) '(1 2 3 4 5))>
3305 #+end_src
3306
3307 ** How do I schedule events relative to Easter Sunday?
3308
3309    Easter's date moves around from year to year according to a complicated
3310    set of criteria which I do not claim to understand.  However the
3311    following code will allow you to schedule recurring events relative to
3312    Easter Sunday.
3313
3314    Note: the function da-easter is from [[http://github.com/soren/elisp/blob/master/da-kalender.el][da-kalender.el]].
3315
3316    Put the following in your .emacs:
3317
3318    #+begin_src emacs-lisp
3319      (defun da-easter (year)
3320        "Calculate the date for Easter Sunday in YEAR. Returns the date in the
3321      Gregorian calendar, ie (MM DD YY) format."
3322        (let* ((century (1+ (/ year 100)))
3323               (shifted-epact (% (+ 14 (* 11 (% year 19))
3324                                    (- (/ (* 3 century) 4))
3325                                    (/ (+ 5 (* 8 century)) 25)
3326                                    (* 30 century))
3327                                 30))
3328               (adjusted-epact (if (or (= shifted-epact 0)
3329                                       (and (= shifted-epact 1)
3330                                            (< 10 (% year 19))))
3331                                   (1+ shifted-epact)
3332                                 shifted-epact))
3333               (paschal-moon (- (calendar-absolute-from-gregorian
3334                                 (list 4 19 year))
3335                                adjusted-epact)))
3336          (calendar-dayname-on-or-before 0 (+ paschal-moon 7))))
3337      
3338      
3339      (defun da-easter-gregorian (year)
3340        (calendar-gregorian-from-absolute (da-easter year)))
3341      
3342      (defun calendar-days-from-easter ()
3343        "When used in a diary sexp, this function will calculate how many days
3344      are between the current date (DATE) and Easter Sunday."
3345        (- (calendar-absolute-from-gregorian date)
3346           (da-easter (calendar-extract-year date))))
3347     #+end_src
3348
3349     Now we can schedule the public holidays associated with Easter as
3350     recurring events.  Good Friday is 2 days before "Easter", Easter Monday
3351     is one day after.
3352
3353     #+begin_src org
3354       ,* Good Friday
3355       ,  <%%(= -2 (calendar-days-from-easter))>
3356       
3357       ,* Easter Sunday
3358       ,  <%%(= 0 (calendar-days-from-easter))>
3359       
3360       ,* Easter Monday
3361       ,  <%%(= 1 (calendar-days-from-easter))>
3362     #+end_src
3363
3364    [Source: Posted by Paul Sexton on Org-mode mailing list.]
3365
3366 ** How to schedule public holiday that is "the nearest Monday to DATE"?
3367
3368    In New Zealand each regional capital has an "Anniversary Day". The date
3369    of Auckland's anniversary day is "the nearest Monday to 29 January".
3370
3371    Put this in your =.emacs=:
3372
3373    #+begin_src emacs-lisp
3374      (defun calendar-nearest-to (target-dayname target-day target-month)
3375        "Recurring event that occurs in the nearest TARGET-DAYNAME to
3376      the date TARGET-DAY, TARGET-MONTH each year."
3377        (interactive)
3378        (let* ((dayname (calendar-day-of-week date))
3379               (target-date (list target-month target-day (calendar-extract-year date)))
3380               (days-diff (abs (- (calendar-day-number date)
3381                                  (calendar-day-number target-date)))))
3382          (and (= dayname target-dayname)
3383               (< days-diff 4))))
3384     #+end_src
3385
3386    Now we can schedule Auckland Anniversary Day. The first argument, 1,
3387    means Monday (days of the week are numbered starting with Sunday=0).
3388
3389    [Source: Originally posted by Paul Sexton on Org-mode mailing list.]
3390
3391 ** How to schedule public holiday on "the 4th Monday in October"?
3392
3393 #+index: Holiday
3394
3395    This does not require any additions to =.emacs=:
3396
3397 #+begin_src org
3398   ,* Labour Day (NZ)
3399   ,  <%%(diary-float 10 1 4)>
3400 #+end_src
3401
3402 ** Why isn't the agenda showing all the times I put under a single entry?
3403    :PROPERTIES:
3404    :CATEGORY: multiple-timestamps-same-entry
3405    :END:
3406
3407 Probably because you have not set the following variable:
3408
3409 : org-agenda-skip-additional-timestamps-same-entry
3410
3411 The default value of this variable is t, which means that entries with
3412 multiple timestamps, such as the following...
3413
3414 #+begin_src org
3415   ,* Work really, really hard
3416   ,  <2010-11-20 Sat 10:00>
3417   ,  <2010-11-20 Sat 14:00>
3418 #+end_src
3419
3420 ... will only appear in the agenda at the time specified by the first
3421 timestamp. If you set =org-agenda-skip-additional-timestamps-same-entry= to
3422 nil, the item will appear will appear at all the times you specify.
3423
3424 ** Can I import iCal events/appts from Gnus?
3425
3426 #+index: iCal
3427 #+index: Gnus
3428
3429 Yes.  Vagn Johansen wrote [[http://ozymandias.dk/emacs/org-import-calendar.el][org-import-calendar.el]] which lets you do this.
3430
3431 * Export
3432   :PROPERTIES:
3433   :CUSTOM_ID: Export
3434   :END:
3435 ** Can I get TODO items exported to HTML as lists, rather than as headlines?
3436    :PROPERTIES:
3437    :CUSTOM_ID: export-TODO-items-as-lists
3438    :END:
3439
3440 #+index: Export!HTML
3441
3442    If you plan to use ASCII or HTML export, make sure things you want to
3443    be exported as item lists are level 4 at least, even if that does
3444    mean there is a level jump.  For example:
3445
3446    : * Todays top priorities
3447    : **** TODO write a letter to xyz
3448    : **** TODO Finish the paper
3449    : **** Pick up kids at the school
3450
3451    Alternatively, if you need a specific value for the heading/item
3452    transition in a particular file, use the =#+OPTIONS= line to
3453    configure the H switch.
3454
3455    : #+OPTIONS:   H:2; ...
3456
3457 ** Can I export only a single subtree?
3458    :PROPERTIES:
3459    :CUSTOM_ID: export-single-subtree
3460    :END:
3461
3462 #+index: Export!Subtree
3463
3464 If you want to export a subtree, mark the subtree as region and then
3465 export. Marking can be done with =C-c @ C-x C-x=, for example.
3466
3467 Alternatively, you can select option =1= in the org export dispatcher
3468 (e.g.., =C-c C-e 1 h= to export the current subtree to html).
3469
3470 By default, the title of the exported file will be set to the heading
3471 of the subtree. You can, however, [[#export-options-for-subtree][customize the title and other export
3472 options]].
3473
3474 ** How can I customize export options for a single subtree?
3475    :PROPERTIES:
3476    :CUSTOM_ID: export-options-for-subtree
3477    :END:
3478
3479 #+index: Export!Options
3480
3481 You can set unique export options for a [[#export-single-subtree][single subtree]] by using
3482 properties. Relevant properties include:
3483
3484  - =EXPORT_TITLE=
3485  - =EXPORT_AUTHOR=
3486  - =EXPORT_DATE=
3487  - =EXPORT_FILE_NAME=
3488  - =EXPORT_OPTIONS= (corresponds to the =#+OPTIONS:= [[http://orgmode.org/manual/Export-options.html#Export-options][configuration line]])
3489
3490 ** How can I tell my calendar web application about appointments in my agenda files?
3491
3492 Here is what you need to do:
3493
3494 1. a script that calls Emacs in batch mode and produce a .ics file
3495 2. a script that uploads this .ics file somewhere on the web
3496 3. tell your webapp to fetch this .ics file on the web
3497
3498 Here is the script I use for the first step:
3499
3500 #+begin_src shell-script-mode
3501 #!/bin/bash
3502
3503 /usr/local/bin/emacs --batch --eval \
3504 "(progn (load-file \"~/install/git/org-mode/org.el\") \
3505         (load-file \"~/elisp/config/org-batch-config.el\") \
3506         (setq org-combined-agenda-icalendar-file \"~/org/cal/org.ics\")
3507         (setq org-agenda-files (quote (\"~/org/bzg.org\"))))" \
3508     -f org-export-icalendar-combine-agenda-files
3509 #+end_src
3510
3511 Depending on your configuration, you might change the load sequence.
3512
3513 Here is the script I use for the second step:
3514
3515 #+begin_src shell-script-mode
3516 #!/bin/bash
3517 /usr/bin/rsync -rtv ~/org/org.ics -e ssh me@my_server:/home/me/public_html/
3518 #+end_src
3519
3520 Note: if you want to cron this rsync script, you will need to let
3521 =my_server= to know about your SSH public key.  Check [[http://troy.jdmz.net/rsync/index.html][this page]] as a
3522 starter.
3523
3524 Now you can cron the two scripts above and your webapp will always be
3525 up to date with your Org agendas.
3526
3527 Also see [[http://orgmode.org/org.html#Exporting-Agenda-Views][Exporting agenda views]] from Org manual.
3528
3529 ** How can I get Mac OSX 10.3 iCal to import my org-exported .ics files?
3530    :PROPERTIES:
3531    :CUSTOM_ID: iCal-import-ics-files-old
3532    :END:
3533
3534 #+index: .ics
3535 #+index:  iCal!Mac OSX 10.3 
3536
3537    When using iCal under Apple MacOS X Tiger, you can create a new C-e c=,
3538    see the variables =org-icalendar-combined-name= and
3539    =org-combined-agenda-icalendar-file=).  Then set Org-mode to overwrite
3540    the corresponding file /~/Library/Calendars/OrgMode.ics/.  You may even
3541    use AppleScript to make iCal re-read the calendar files each time a new
3542    version of /OrgMode.ics/ is produced.  Here is the setup needed for
3543    this:
3544
3545    : (setq org-combined-agenda-icalendar-file
3546    :     "~/Library/Calendars/OrgMode.ics")
3547    : (add-hook 'org-after-save-iCalendar-file-hook
3548    :  (lambda ()
3549    :   (shell-command
3550    :    "osascript -e 'tell application \"iCal\" to reload calendars'")))
3551
3552 ** How can I get Mac OSX 10.4 or later iCal to import my Org-exported .ics files?
3553    :PROPERTIES:
3554    :CUSTOM_ID: iCal-import-ics-files-new
3555    :END:
3556
3557 #+index:  iCal!Mac OSX 10.4
3558
3559    For Mac OS X 10.4, you need to write the ics file to
3560    =/Library/WebServer/Documents/= and then subscribe iCalendar to =http:
3561    //localhost/orgmode.ics=
3562
3563 ** How can I remove timestamps and todo keywords from my exported file?
3564    :PROPERTIES:
3565    :CUSTOM_ID: export-options-remove-timestamps
3566    :END:
3567
3568 #+index: Export!Timestamps
3569 #+index: Export!Todo keywords
3570
3571 You can place an options line at the top of your org file:
3572
3573 : #+OPTIONS: <:nil todo:nil
3574
3575 There is a whole host of export options you can set with an in-buffer
3576 options or via global variables. See [[http://orgmode.org/manual/Export-options.html#Export-options][this section]] of the manual for a
3577 full list.
3578
3579 ** How can I preserve faces when I export an agenda from the command line?
3580    :PROPERTIES:
3581    :CUSTOM_ID: preserving-faces-during-batch-export
3582    :END:
3583
3584 #+index: Export!Agenda
3585 #+index: Export!Faces
3586
3587 Normally, when you export an org file or an agenda view from within
3588 emacs, htmlize will convert your face definitions to direct color css
3589 styles inlined into each =<span>= object, resulting in an HTML output
3590 that preserves the general look of your Org buffers and agenda views.
3591
3592 Let's say you generate an export from the command line, such as the
3593 following:
3594
3595 : emacs -batch -l ~/.emacs -eval '(org-batch-agenda "e")'
3596
3597 or
3598
3599 : emacs -batch -l ~/.emacs -eval '(org-publish-all)'
3600
3601 In such an instance, the exported HTML will contain only very basic
3602 color styles. The reason is that when Emacs is run in batch mode, it
3603 does not have a display and therefore only rudimentary face
3604 definitions.  If you'd like to use more complex styles, you'll have to
3605 make sure that the export process only assigns classes instead of
3606 direct color values.  This can be done by binding the variable
3607 =org-export-htmlize-output-style= to =css= for the duration of the
3608 export, for example with
3609
3610 : emacs -batch -l ~/.emacs
3611 :   -eval '(let ((org-export-htmlize-generate-css (quote css)))
3612 :            (org-batch-agenda "e"))'
3613
3614 Then you can use a style file to make these classes look any way you
3615 like.  To generate face definitions for a CSS file based on any faces
3616 you are currently using in Emacs, you can use the following command:
3617
3618 : M-x org-export-htmlize-generate-css RET
3619
3620 This will generate a =<style>...</style>= section, the content of
3621 which you can add to your style file.
3622
3623 ** How can I avoid dark color background when exporting agenda to ps format?
3624    :PROPERTIES:
3625    :CUSTOM_ID: avoiding-dark-background-when-exporting-agenda
3626    :END:
3627
3628 #+index: Export!.ps
3629
3630 Add this to your .emacs and evaluate it.
3631
3632 #+BEGIN_SRC emacs-lisp
3633   (setq org-agenda-exporter-settings
3634         '((ps-print-color-p 'black-white)))
3635 #+END_SRC
3636
3637 ** How can I include e.g. an abstract in export to Latex and HTML?
3638    :PROPERTIES:
3639    :CUSTOM_ID: include-abstract-in-export-to-latex-and-html
3640    :END:
3641
3642 #+index: Export!Abstract
3643
3644 Org does not currently have special markup for abstracts, but for
3645 export purposes, you can extend the block-level structural and
3646 semantic markup in Org with the contributed package [[file:org-contrib/org-special-blocks.org][org-special-blocks]]
3647 (by Chris Gray). To turn it on, put this in your =.emacs=:
3648
3649 : (require 'org-special-blocks)
3650
3651 Now, you can mark up the abstract of your article like this:
3652
3653 : #+BEGIN_ABSTRACT
3654 : Falling apples were observed and compared with pears. Newton's laws
3655 : were confirmed at the 95% confidence level.
3656 : #+END_ABSTRACT
3657
3658 Exporting to Latex wraps this in a
3659 =\begin{abstract}....\end{abstract}= environment, which just works.
3660
3661 HTML export wraps it in a ~<div class="abstract">...</div>~
3662 element. The HTML result won't look like anything special until you
3663 style it. Here is some sample CSS to get you started; put these in
3664 your document header:
3665
3666 : #+STYLE: <style>.abstract {margin: 1em; padding: 1em; border: 1px solid black}
3667 : #+STYLE: .abstract:before {content: "Abstract: "; font-weight: bold}</style>
3668
3669 Generally, =#+begin_foo= will work for any simple Latex =foo=
3670 environment not supported by existing Org markup.
3671
3672 If you need to pass parameters, process the block content in some way,
3673 or support other exporters, you may want to consider whether you can
3674 customize it using Eric Schulte's [[file:org-contrib/org-exp-blocks.org][org-exp-blocks]] instead.
3675
3676 ** How can I get colored source code when exporting to LaTeX?
3677    :PROPERTIES:
3678    :CUSTOM_ID: fontified_source_code_w_latex
3679    :END:
3680
3681 #+index: Export!LaTeX
3682
3683 As of Sun Aug 9 2009 the "current" version of Org-mode (see
3684 [[keeping-current-with-Org-mode-development]]) supports exporting
3685 source code to LaTeX using the listings package.
3686
3687 To turn on listing export add the following to your Org-mode
3688 customization.
3689 #+begin_src emacs-lisp
3690   ;; requite org-latex so that the following variables are defined
3691   (require 'org-latex)
3692
3693   ;; tell org to use listings
3694   (setq org-export-latex-listings t)
3695
3696   ;; you must include the listings package
3697   (add-to-list 'org-export-latex-packages-alist '("" "listings"))
3698
3699   ;; if you want colored source code then you need to include the color package
3700   (add-to-list 'org-export-latex-packages-alist '("" "color"))
3701 #+end_src
3702
3703 The listings package will now be used to fontify source code in your
3704 LaTeX documents.  By default listings will not color any of your
3705 source code.  If you would like to set colors for keywords and
3706 comments in your latex documents you can do so using LaTeX directives
3707 like the following.
3708 #+begin_src latex
3709   \lstset{keywordstyle=\color{blue},
3710     commentstyle=\color{red},
3711     stringstyle=\color{green}
3712   }
3713 #+end_src
3714
3715 of if you want to get even fancier with your colors you can try
3716 something like the following
3717 #+begin_src latex
3718 \definecolor{keywords}{RGB}{255,0,90}
3719 \definecolor{comments}{RGB}{60,179,113}
3720 \definecolor{fore}{RGB}{249,242,215}
3721 \definecolor{back}{RGB}{51,51,51}
3722 \lstset{
3723   basicstyle=\color{fore},
3724   keywordstyle=\color{keywords},
3725   commentstyle=\color{comments},
3726   backgroundcolor=\color{back}
3727 }
3728 #+end_src
3729
3730 For more complex listings use cases consult the [[ftp://ftp.tex.ac.uk/tex-archive/macros/latex/contrib/listings/listings.pdf][listings manual]].
3731
3732 ** How can I export to Latex Beamer?
3733    :PROPERTIES:
3734    :CUSTOM_ID: beamer
3735    :END:
3736
3737 #+index: Export!Beamer
3738
3739 The latex [[http://latex-beamer.sourceforge.net/][Beamer Class]] is a useful class for generating slide shows.
3740 The following can be used to export Org-mode documents to LaTeX
3741 beamer.
3742
3743 Add the following to your Emacs initialization file.
3744 #+begin_src emacs-lisp
3745   (unless (boundp 'org-export-latex-classes)
3746     (setq org-export-latex-classes nil))
3747   (add-to-list 'org-export-latex-classes
3748                '("beamer"
3749                  "\\documentclass[11pt]{beamer}\n\\usepackage[utf8]{inputenc}\n\\usepackage[T1]{fontenc}\n\\usepackage{hyperref}\n\\usepackage{verbatim}\n"
3750                  ("\\section{%s}" . "\\section*{%s}")
3751                  ("\\begin{frame}\\frametitle{%s}" "\\end{frame}"
3752                   "\\begin{frame}\\frametitle{%s}" "\\end{frame}")))
3753 #+end_src
3754
3755 Then by placing
3756 : #+LaTeX_CLASS: beamer
3757 in the header of your Org-mode document it will automatically export
3758 to the Beamer document class on LaTeX export.  With the above
3759 configuration top-level headers will be mapped to sections in the
3760 Beamer document, second-level headers will be mapped to frames, and
3761 lower level headlines will be mapped to itemize objects.
3762
3763 This above is adapted from an [[http://article.gmane.org/gmane.emacs.orgmode/15077/match=beamer+dokos][email by Nick Dokos]], and an [[http://article.gmane.org/gmane.emacs.orgmode/17767/match=beamer+dokos][email by
3764 Thomas Dye]].  For a much more complex Beamer setup see the [[http://article.gmane.org/gmane.emacs.orgmode/17767/match=beamer+dokos][email by
3765 Thomas Dye]].
3766
3767 ** How can I use RefTeX in Org-mode files for LaTeX export and in Org-babel LaTeX code blocks?
3768    :PROPERTIES:
3769    :CUSTOM_ID: using-reftex-in-org-mode
3770    :END:
3771
3772 #+index: RefTeX
3773 #+index: Babel
3774 #+index: Code blocks
3775
3776 [[http://www.gnu.org/software/auctex/reftex.html][RefTeX]] is an indispensable tool for the author of LaTeX documents.  It
3777 aids in creation of bibliographies, cross-references, indexes, and
3778 glossaries.  RefTeX understands the structure of multi-file LaTeX
3779 documents and is able to collect from them information about the
3780 location(s) of external data stores used in creation of the final
3781 document.  RefTeX was written by Carsten Dominik and is currently
3782 being maintained by the [[http://www.gnu.org/software/auctex/index.html][AucTeX]] project.
3783
3784 *** Using RefTeX In Org-mode Files for LaTeX Export
3785 In Org-mode files for LaTeX export, the trick is to find a way to tell
3786 RefTeX the locations of external data stores.  One way is to set the
3787 variable, =reftex-default-bibliography=.  Add lines like these to
3788 .emacs:
3789
3790 #+begin_src emacs-lisp
3791   (setq reftex-default-bibliography
3792         (quote
3793          ("default.bib" "other-default.bib")))
3794 #+end_src
3795
3796 In practice, this is a limited solution and the
3797 typical user will want to pass this information on a per-file basis.
3798 Two solutions to this problem were posted on a blog, [[http://www.mfasold.net/blog/2009/02/using-emacs-org-mode-to-draft-papers/][Mario's
3799 Braindump]].
3800
3801 The first solution, proposed by Mario, enables the RefTeX citation
3802 function in Org-mode.  Add these lines to .emacs:
3803
3804 #+begin_src emacs-lisp
3805   (defun org-mode-reftex-setup ()
3806     (load-library "reftex")
3807     (and (buffer-file-name)
3808          (file-exists-p (buffer-file-name))
3809          (reftex-parse-all))
3810     (define-key org-mode-map (kbd "C-c )") 'reftex-citation))
3811   (add-hook 'org-mode-hook 'org-mode-reftex-setup)
3812 #+end_src
3813
3814 Then add the following lines anywhere in the Org-mode file (Org-mode
3815 will recognize them as LaTeX commands):
3816
3817 #+begin_src org
3818 \bibliographystyle{plain}
3819 \bibliography{BIB-NAME}
3820 #+end_src
3821
3822 With this setup, =C-c )= will invoke =reftex-citation= which will
3823 insert a reference in the usual way:
3824
3825 #+begin_src org
3826   ,* test reftex
3827
3828   ,This is a citation \cite{tierney90}.
3829
3830   ,\bibliographystyle{plain}
3831   ,\bibliography{tsd}
3832 #+end_src
3833
3834 This Org-mode file will export the following LaTeX output:
3835
3836 #+begin_src latex :exports code
3837   % Created 2010-03-22 Mon 14:34
3838   \documentclass[11pt,letter]{article}
3839   \usepackage[utf8]{inputenc}
3840   \usepackage[T1]{fontenc}
3841   \usepackage{hyperref}
3842
3843   \title{test.org}
3844   \author{Tom Dye}
3845   \date{2010-03-22 Mon}
3846
3847   \begin{document}
3848
3849   \maketitle
3850
3851   \setcounter{tocdepth}{3}
3852   \tableofcontents
3853   \vspace*{1cm}
3854
3855   \section{test reftex}
3856   \label{sec-1}
3857
3858
3859   This is a citation \cite{tierney90}.
3860
3861   \bibliographystyle{plain}
3862   \bibliography{tsd}
3863
3864   \end{document}
3865 #+end_src
3866
3867
3868 A second solution, to activate the RefTeX minor mode on a per-file
3869 basis, was posted by Kevin Brubeck Unhammer in response to this idea.
3870 Add the following lines to .emacs:
3871
3872 #+begin_src emacs-lisp
3873   (add-hook ‘org-mode-hook
3874              (lambda ()
3875                (if (member “WRITE” org-todo-keywords-1)
3876                    (org-mode-article-modes))))
3877 #+end_src
3878
3879 where =org-mode-article-modes= is defined as follows:
3880
3881 #+begin_src emacs-lisp
3882   (defun org-mode-article-modes ()
3883     (reftex-mode t)
3884     (bib-cite-minor-mode t)
3885     (and (buffer-file-name)
3886          (file-exists-p (buffer-file-name))
3887          (reftex-parse-all)))
3888 #+end_src
3889
3890 Add the =\bibliographystyle{}= and =\bibliography{}= lines to the
3891 Org-mode file as before and define a TODO keyword, =WRITE=, perhaps
3892 like this:
3893
3894 #+begin_src org
3895   ,#+TODO: TODO(t) STARTED(s) WRITE | DONE(d) DEFERRED(f)
3896 #+end_src
3897
3898 With this setup, you insert a citation with =M-x reftex-citation RET=.
3899
3900 *** Using RefTeX in Org-babel LaTeX Code Blocks
3901
3902 In Org-babel LaTeX code blocks, the trick is to give RefTeX access to
3903 information in other Org-babel LaTeX code blocks.  If you use an Emacs
3904 starter kit where configuration information is held in Org-mode files,
3905 then the second solution is preferable because you won't be asked for
3906 a master file when Emacs is started.  For this reason, the second
3907 solution is modified for use with Org-babel latex code blocks.  No
3908 key-binding is needed here because Org-babel code blocks are edited
3909 within the usual AucTeX environment.
3910
3911 Add the following lines to .emacs (adapted from  Kevin Brubeck Unhammer's [[http://www.mfasold.net/blog/2009/02/using-emacs-org-mode-to-draft-papers/][Reftex Setup]])
3912 #+begin_src emacs-lisp
3913   (defun org-mode-article-modes ()
3914     (reftex-mode t)
3915     (and (buffer-file-name)
3916          (file-exists-p (buffer-file-name))
3917          (reftex-parse-all)))
3918
3919   (add-hook 'org-mode-hook
3920             (lambda ()
3921               (if (member "REFTEX" org-todo-keywords-1)
3922                   (org-mode-article-modes))))
3923 #+end_src
3924
3925 Then add a line like the following line to the top of your org-mode file:
3926
3927 #+begin_src org
3928   ,#+TODO: TODO(t) STARTED(s) | DONE(d) DEFERRED(f) REFTEX
3929 #+end_src
3930
3931 When you open an org-mode file with a line like this, RefTeX will
3932 prompt for the master .tex file, which will be parsed in the usual
3933 way.  This means that the .tex file should already exist, perhaps by
3934 tangling the LaTeX preamble and postamble, before
3935 =org-mode-article-modes= is activated for the Org-mode file.
3936
3937 ** How can I use XeLaTeX for LaTeX export instead of pdfLaTeX?
3938    :PROPERTIES:
3939    :CUSTOM_ID: using-xelatex-for-pdf-export
3940    :END:
3941
3942 #+index: XeLaTeX
3943 #+index: pdfLaTeX
3944
3945 [[http://en.wikipedia.org/wiki/XeTeX][XeLaTeX]] is an alternative to pdfLaTeX for typesetting LaTeX
3946 documents.  XeTeX can use any fonts installed in the operating system
3947 without configuring TeX font metrics, and can make direct use of advanced
3948 typographic features of OpenType and other font formats.  By default,
3949 org-mode exports =org= files to =pdf= via pdfLaTeX.
3950
3951 Here is one way to smoothly incorporate XeLaTeX into org-mode's export
3952 process.  This solution takes advantage of [[http://www.phys.psu.edu/~collins/software/latexmk-jcc][latexmk]], a perl script that
3953 intelligently and automatically manages latex compilation.  It is included
3954 with TeXLive, but at present the version included is not quite up-to-date
3955 enough for our needs.  Version 4.20 and higher includes an option allowing
3956 you to specify which program to use when "pdflatex" is called.  Install a
3957 current version of latexmk as per the instructions on the [[http://www.phys.psu.edu/~collins/software/latexmk-jcc][latexmk]] site.  If
3958 necessary, disable the older version that comes with TeXLive.  This is
3959 likely in =/usr/texbin/=, and you should rename or remove it.  Then you can
3960 put the following in your =~/.emacs.d/= or equivalent:
3961
3962 #+begin_src emacs-lisp