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