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