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