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