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