1 #+EMAIL: mdl AT imapmail DOT org
4 #+TITLE: Org-mode Frequently Asked Questions
7 [[file:index.org][{Back to Worg's index}]]
9 * Latest questions on StackOverflow
12 <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>
15 <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>
21 :CUSTOM_ID: What-is-org-mode
23 ** Can Org-mode do "x"? Does org have "x" feature?
25 :CUSTOM_ID: can-org-do-x
28 In its default setup, Org-mode offers a simple outlining and task
29 management environment. But it also has a huge number of features and
30 settings "under the hood." Advanced users have configured Org-mode for
31 almost every conceivable use scenario.
33 Org-mode has a very active community and rich and extensive
34 documentation. Before emailing the mailing list to ask whether
35 Org-mode has a particular feature or setting, please consult the
38 - Read/search the manual.
40 - http://orgmode.org/manual/index.html
42 - Make sure to check out the following indexes:
44 - [[http://orgmode.org/manual/Main-Index.html#Main-Index][Main Index]]
45 - [[http://orgmode.org/manual/Key-Index.html#Key-Index][Key Index]]
46 - [[http://orgmode.org/manual/Variable-Index.html#Variable-Index][Variable Index]]
48 - The manual is also easily available from within emacs.
50 To read the manual within emacs, you can evaluate =(info
51 "(org)")= within emacs---i.e., type =C-x C-e= after the closing
52 paragraph of the info expression above.
54 You can also type =M-x info= and navigate to "Org Mode".
56 You can search the entire manual by typing ~C-s term~. Keep
57 pressing ~C-s~ to cycle through the results
59 - Search the [[http://dir.gmane.org/gmane.emacs.orgmode][mailing list archives]].
61 There is a good chance that the feature you are looking for has
62 already been discussed (most likely several times).
64 - Check for features from within emacs.
66 - Emacs has a wonderful built-in help system.
68 - You can browse (and change) most customization options by typing
71 - You can check for a feature by typing =M-x apropos [RET] [word]= or
72 =C-h a word=. This will search for all functions and variables
73 matching the term (or regexp) you enter.
75 - You can browse (and search for) org functions, variables, and
76 faces by using =M-x describe-variable= (=C-h v=), =M-x
77 describe-function= (=C-h f=), or =M-x describe-face=.
79 After invoking one of these commands, simply type =org-[TAB]= to
80 see a full list of relevant functions or variables or faces. You
81 can then drill down further: e.g., =org-export-[TAB]= for export
84 - Checkout the [[file:org-tutorials/index.org][tutorials on Worg]].
86 Several of these tutorials discuss advanced features (e.g.,
87 searching, custom agenda commands, tables, publishing) of Org-mode
90 There are many other resources on Worg as well:
92 - [[http://orgmode.org/worg/org-configs/index.html][Org Customization]] :: Includes a guide for beginners.
94 - [[http://orgmode.org/worg/org-hacks.html][Org Hacks]] :: User-generated modifications and add-ons.
96 - [[http://orgmode.org/worg/org-glossary.html][Org Glossary]] :: An explanation of basic Org-mode terms and
99 ** Can I implement a GTD workflow with Org-mode?
101 :CUSTOM_ID: GTD-workflow-with-Org-mode
104 Yes, you can. Check for discussions and pointers [[http://orgmode.org/worg/org-gtd-etc.html][here]].
106 ** What is the difference between Org and TaskPaper?
108 :CUSTOM_ID: Org-and-TaskPaper
111 There is really no difference. Org is as /simple/ as [[http://hogbaysoftware.com/products/taskpaper][TaskPaper]]. It
112 is just that, when using Org within Emacs, it lets you do many things
113 that you wouldn't be able to do with TaskPaper. Yes, TaskPaper is
114 fiddle-proof and people using Emacs tends to like fiddling (which is
115 orthogonal to the idea of using todo-list efficiently), but this is
116 just a matter of discipline and common sense, not one of Org's design.
118 Read [[http://article.gmane.org/gmane.emacs.orgmode/6224][Carsten's enlightening statement]] on this.
119 ** What is the meaning of the Unicorn on Org's website?
124 The Unicorn is the logo of Org-mode because:
126 - Org-mode is the UNICs of ORgaNizers.
128 - Org-mode is an Emacs mode, so it makes sense to use an animal
129 similar or related to the gnu used for GNU Emacs.
131 - Org-mode is meant to show you the way, and an animal with two horns
132 can not do this very well, can it?
134 - Unicorn tears are said to reverse petrification, and wasn't this how
135 we all felt before getting to some degree of time and task
138 - It will take forever to learn everything there is to know about a
141 - A unicorn is a fabulous creature. Org-mode wants to be a fabulous
144 Using a unicorn was originally /Bastien Guerry's/ idea. His friend,
145 the french artist [[http://intemperies.over-blog.com/][Christophe Bataillon]], designed the logo for us, and
146 /Greg Newman/ gave it a refresh some time later. Bastien writes why
150 The first reason is not linked to the animal, but to the sounding of the
151 word "Unicorn" - because Org gives you a /uni/que way of producing files
152 in several format (HTML, LaTeX, etc.)
154 The second reason is that a Unicorn doesn't really exist, it is just
155 something you can dream about, and make others believe it does exist.
156 Just like the perfect organizer.
159 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
160 Suckling]] posted a link showing how to make a simple foldable unicorn
161 (very appropriate for an outlining program!).
163 [[http://article.gmane.org/gmane.emacs.orgmode/11735][Tim Burt]] made a very complicated one which is now a treasured
164 possession of the Org-mode author.
166 - Official logo: [[http://orgmode.org/img/org-mode-unicorn.png]]
167 This logo is available in a number of different formats including
168 Photoshop /.psd/ and scaleable vector graphics /.svg/ [[http://orgmode.org/img/][here]].
170 - An [[http://orgmode.org/img/nrocinu4.jpg][alternative version]] from Christophe Bataillon (c):
172 - [[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]]:
174 - [[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
175 threshold technique".
177 - [[http://article.gmane.org/gmane.emacs.orgmode/11735/match%3D][Tim Burt]] made a folded Unicorn to match the spirit of Org - see the
178 whole set of pictures [[http://www.flickr.com/photos/tcburt/sets/72157614543357071/][on his flickr page]].
180 - Are unicorns real? Answer [[http://article.gmane.org/gmane.emacs.orgmode/11687/match%3Drosslaird%2Bunicorn][here]] by Ross Laird.
182 ** Is Org's documentation written in Org?
184 No. Org's documentation is written in TeXinfo, which is the standard
185 format for Emacs documentation. There is no export mechanism from Org
188 ** I think my Org-mode is broken! How do I report a bug?
190 :CUSTOM_ID: bug-reporting
193 1. Make sure you are running [[#updating-org][the latest version of Org-mode]].
195 2. Read [[http://orgmode.org/manual/Feedback.html][this section]] of the manual.
197 3. Provide a minimal example that duplicates the bug.
199 - Create a minimal .emacs file and start emacs with that file as
200 detailed in [[#minimal-emacs][these instructions]].
202 - Create a sample, minimal .org file that reliably reproduces the
203 problem and post it to the mailing list.
205 - Some users call this an "[[#ecm][ECM]]", a French acronym that means a
206 "minimal complete example".
213 This is a French acronym used by some mailing list members; it stands
214 for "Exemple Complet Minimal", or "Complete Minimal Example". The term
215 refers to test files that can reliably reproduce a bug with the
216 minimal amount of code. When you report a bug to the mailing list, you
217 should provide a minimal .org file (with no more text than necessary)
218 that demonstrates the bug. See [[http://permalink.gmane.org/gmane.emacs.orgmode/41281][this post]] for more information.
220 ** What should I do before contacting the mailing list?
222 :CUSTOM_ID: when-to-contact-mailing-list
225 The Org-mode mailing list is a high volume list, in which community
226 members discuss use cases, configuration, bugs, and developments.
228 If you are new to Org-mode, please read/search the excellent [[http://orgmode.org/manual/index.html][manual]]
229 (and pay special attention to the indexes) before asking your
232 You should also [[http://dir.gmane.org/gmane.emacs.orgmode][search the mailing list]] to see if your issue has
233 already been discussed.
235 See [[#can-org-do-x][this faq]] for more details.
237 ** Why hasn't my email to the mailing list shown up yet?
239 :CUSTOM_ID: ml-post-delay
242 The org-mode mailing list is moderated. Thus, if you are not
243 subscribed to the mailing list, your mail will only appear on the list
244 after it has been approved by a moderator. To ensure that your mail
245 appears quickly, please [[http://lists.gnu.org/mailman/listinfo/emacs-orgmode][subscribe to the list]].
247 ** I read the mailing list through gmane. Should I subscribe?
249 :CUSTOM_ID: ml-subscription-and-gmane
252 The org-mode mailing list is available via nntp at [[http://dir.gmane.org/gmane.emacs.orgmode][Gmane]]. Many
253 participants in the list prefer read the list in a newsreader, such as
254 Gnus, instead of receiving emails. If you choose to read the list via
255 nntp, you can still [[http://lists.gnu.org/mailman/listinfo/emacs-orgmode][subscribe]] to the list and then opt not to receive
256 any emails on the mailman settings page (see the "Mail Delivery"
259 This will ensure that your messages to the list get through quickly,
260 reduce the work load of the mailing list moderators (who need to clear
261 every mail from non-members), and provide more accurate information
262 about the number of list readers.
266 :CUSTOM_ID: Keeping-current
268 ** My Emacs ships with an older version Org-mode! How do I upgrade?
270 :CUSTOM_ID: updating-org
273 Org-mode develops quickly, which means that versions of Org-mode
274 shipped with Emacs are more or less out-of-date. If you'd like to
275 upgrade to the most recent version of org-mode, you have a number of
278 1. Download the [[http://orgmode.org/index.html#sec-3][most recent release]] of org-mode as zip or tarball and
279 follow the [[http://orgmode.org/manual/Installation.html#Installation][installation instructions]] in the manual.
280 2. Clone and install the development git repository as [[#keeping-current-with-Org-mode-development][explained
281 here]]. If you don't want to run the bleeding edge, you can still
282 use git [[#using-stable-releases-only][to track the most recent stable releases]].
283 3. Install and updated org-mode automatically through the Emacs
284 Package Manager as [[#installing-via-elpa][explained in this FAQ]].
286 ** How do I keep current with bleeding edge development?
288 :CUSTOM_ID: keeping-current-with-Org-mode-development
291 Org mode is developed in [[http://en.wikipedia.org/wiki/Git_(software)][Git]]. You can keep up-to-date with Org-mode
292 developement by cloning Org mode repository and refreshing your
293 copy with latest changes whenever you wish. You only need to use
294 two Git commands (clone and pull.) Here are the steps in brief
295 (please customize locations to suit your setup):
297 1. Select a location to house the Org mode repository (approx. 40
298 MB; includes documentation, compiled elisp files and history
299 going all the way back to v4.12a)
301 : $ mkdir $HOME/elisp && cd $HOME/elisp
303 2. Clone the Org mode Git repository.
305 Recommended approach:
307 : $ git clone git://orgmode.org/org-mode.git
309 You can also clone from this mirror (lagging one hour behind
312 : $ git clone git://repo.or.cz/org-mode.git
314 For those of you behind a firewall that allows only HTTP, you can
315 clone like this (can be somewhat slow), either from orgmode.org or
318 : $ git clone http://orgmode.org/org-mode.git
319 : $ git clone http://repo.or.cz/r/org-mode.git
321 3. Compile and install Org mode and build documentation.
323 : $ cd org-mode && make && make doc && make install
325 Please note that you can choose to /not/ compile at all and run
326 using source =.el= files only. Compiled files speed things up.
328 Also note that running =make install= is necessary only if you'd
329 like to install org-mode system-wide.
331 4. This is where you configure Org mode with Emacs. Please refer
332 to [[./org-tutorials/index.org][Org tutorials]].
334 5. Keeping up-to-date.
336 Cloning the repository is a one time activity. From this point
337 onwards you only need to /pull/ the latest changes.
339 : $ cd $HOME/elisp/org-mode
343 : $ git pull && make clean && make && make doc && make install
345 6. You should restart org mode to have the changes take effect (if
346 you are not rebooting Emacs.) Also since the intention is to
347 "keep up" with Org mode, you should visit updated sections of
348 documentation for latest updates (use =git log=.)
350 7. As you use your repository over time it will accumulate loose objects.
351 You can reduce the total size of your git repository with
355 which will consolidate loose git objects into pack files. This
356 reduces the size of the repository and speeds up data access to
359 ** How do I update the info manual pages to the latest org-mode version?
361 :CUSTOM_ID: update-info-manual-to-latest
364 Since org-mode already ships with Emacs, a rather common problem
365 among users is "How do I update the info documentation to the
366 latest version of org-mode?". There are three ways to achieve this:
368 1. You can set the =INFOPATH= environment variable in your login
371 #+begin_src shell-script :eval no
373 export INFOPATH=/path/to/org-mode/info:$INFOPATH
377 =/path/to/org-mode/info= is wherever you install org-mode.
379 2. You can achieve the same with elisp like this:
381 #+begin_src emacs-lisp :eval no
383 (add-to-list 'Info-default-directory-list
384 (expand-file-name "/path/to/org-mode/info"))
387 3. You can also specify this in the Makefile while installing
390 #+begin_src makefile-gmake :eval no
391 # Where local software is found
392 prefix=/path/to/emacs-root
394 # Where info files go.
395 infodir = $(prefix)/share/info
398 After you install org-mode with =make install=, you can now
399 install the new info files with =make install-info=. Note that
400 this method _overwrites_ the old org-mode info files that is
401 distributed with your version of GNU Emacs.
403 ** How can I keep local changes and still track Org mode development?
405 :CUSTOM_ID: keeping-local-changes-current-with-Org-mode-development
408 Say you want to make minor changes to the Makefile to reflect your
409 location for =emacs=.
411 Create a local branch for your changes on top of origin/master as
414 : $ git checkout -b local origin/master
415 : $ git config branch.local.rebase true
416 : # Make your changes to the Makefile and create a new commit
418 : $ git commit -m 'My local Makefile configurations'
419 : # Update git to a newer version
422 Now each time you pull new commits from the distribution repository
423 your local commits will be rewound and replayed on top of the new
428 You would normally work on your =local= branch which includes your
429 custom commits; there's no need to switch back to the =master=
434 Here is an example of dealing with conflict resolution during git pull.
436 If you get a conflict during a =git pull= you will need to edit the
437 file with the conflict to fix up the conflicting lines and then tell
438 git that you have resolved the conflict.
440 Conflict resolution goes something like this:
442 1. =git pull= fails with a conflict
444 3. =git add= the file to mark the conflict resolved
445 4. =git rebase --continue=
446 5. lather, rinse, and repeat 2-4 as needed
448 For this example we have the following Makefile:
458 and we need to change the =EMACS=emacs= line to =EMACS=myemacs= to
459 make it work well on our system.
463 - create a local branch for our work
465 : $ git checkout -b local origin/master
466 : $ git config branch.local.rebase true
468 This marks the branch so that all local commits on it are rebased
469 on top of any new commits we get in origin/master during a =git
472 - Make our custom changes
474 Edit the makefile so it looks like this:
484 - Create a commit with our custom changes
486 : $ git commit -m 'My local Makefile configurations'
488 - Later we do a =git pull= but that fails with conflicts.
491 : remote: Counting objects: 5, done.
493 : Patch failed at 0001.
495 : When you have resolved this problem run "git rebase --continue".
496 : If you would prefer to skip this patch, instead run "git rebase --skip".
497 : To restore the original branch and stop rebasing run "git rebase --abort".
499 - Fix the conflict in your favourite editor
501 Conflict markers look like this:
503 : <<<<<<< HEAD:Makefile
507 : >>>>>>> Change emacs location:Makefile
509 This attempted =git pull= caused a conflict. Fire up your
510 favourite editor and fix the conflict in the Makefile. The
511 conflict markers are <<<<<<<<<< , ======= , and >>>>>>>>>>. Fix
512 the Makefile appropriately and delete the conflict markers. You
513 already edited these lines earlier so fixing it should be trivial.
515 In this case we changed =EMACS=emacs= to =EMACS=myemacs= and
516 upstream changed =EMACS=emacs= to =EMACS=emacs22=. Just fix the
517 file and save it by deleting the conflict markers and keeping the
518 code you need (in this case the =EMACS=myemacs= line which we
519 originally modified.)
521 - Mark the file's conflict resolved
525 You use =git add= because you are adding new content to be tracked - you're not adding a file, but you are adding changes in content.
527 - Continue the rebase operation
529 : $ git rebase --continue
531 If any other conflicts arise you fix them the same way - edit the file, mark the conflict resolved, and continue.
533 At anytime during the rebase conflict resolution you can say "oops this is all wrong - put it back the way it was before I did a pull"
535 : $ git rebase --abort
537 ** How can I use a stable release version instead of the bleeding edge master?
539 :CUSTOM_ID: using-stable-releases-only
542 The master branch of the git repository always contains the bleeding
543 edge development code. This is important for Org's fast development,
544 because code on master gets checked out by many people daily and we
545 quickly receive bug reports if something is wrong. On rare occasions,
546 this code may not function perfectly for a limited time while we are
547 trying to fix things.
549 Not everyone like to use this bleeding-edge code and face the danger
550 to hit a surprising bug.
552 Therefore, from time to time, we make a release. This typically
553 happens when the maintainers feel that
555 1. they have reached a good point in the development
556 2. the code has a feature set that should stay and be supported in the
559 Stable releases are used as the basis for [[http://orgmode.org/index.html#sec-3_3][alternative distributions]] of
560 Org, and they are also the code that gets merged into the Emacs
561 distribution. If you want to work only with stable releases, you can
562 always download [[http://orgmode.org/index.html#sec-3][them here]], but you can also also use the git
563 repository to keep automatically up-to-date with the most recent
564 stable releases (and save bandwidth!). Here's how to do so:
566 *** Run a specific stable release
568 In the repository, do
573 To see which release tags are available. Let's say you decide to use
576 : $ git checkout release_7.01f
578 This set the working tree of the repository to the state of Org at the
579 moment of release 7.01f. You can then run Org from the repository be
580 sure to use the stable release while development continues on the
583 Later, when we release 7.02, you can switch to that using
585 : $ git fetch --tags # to get all the new stuff
587 : $ git checkout release_7.02
589 *** Always run the most recent stable release
591 Alternatively, if you just want to always run whatever the latest
592 stable release is, you can do
594 : $ git checkout -b stable origin/maint
596 and then regularly update this branch by doing
600 ** How can I install an up-to-date version of org-mode without "make" tools?
602 :CUSTOM_ID: installing-org-without-make-tools
605 If you are using org-mode on a computer that lacks developer tools for
606 compiling software, such as [[http://www.gnu.org/software/make/][GNU Make]], you will have to use a
607 *different* installation method than [[http://orgmode.org/manual/Installation.html#Installation][the one outlined in the manual]].
609 Please see [[http://article.gmane.org/gmane.emacs.orgmode/15264][this thread]] on the mailing list for several different ways
610 you can install a recent version of org-mode without using the
611 customary =make clean && make && make install=.
613 The result of that discussion is the file/function found in
614 [[http://orgmode.org/worg/org-hacks.html#compiling-org-without-make]].
616 ** I don't use git. Can I download bleeding edge .zip and .tar.gz archives?
618 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 --
619 these archives are udpated every day at midnight.
621 Alternatively, you can download a [[http://orgmode.org/w/org-mode.git/snapshot][tar.gz snapshot from orgmode.org]].
623 ** How do I install Org-mode through Emacs' Package Manager?
625 :CUSTOM_ID: installing-via-elpa
628 Daily builds of Org-mode is distributed as an ELPA package from
629 both [[http://elpa.gnu.org/packages/][GNU Emacs Lisp Package Archive]] as well as from [[http://orgmode.org/pkg/daily/][Org-mode Emacs
632 Steps for installing Org with package manager:
633 1) Do =M-x list-packages= to browse available packages.
634 2) If the above command is unavailable you need to [[#installing-elpa][install the package
635 manager]] before proceeding ahead.
636 3) If you see =org= as an available package, skip to step 5.
637 4) If you are here it means that org is unavailable in the GNU's
638 archives. Report this discrepancy to [[mailto:emacs-orgmode@gnu.org][Orgmode mailing list.]]
640 In the meanwhile, you can manually download the tarball and
641 install it. Refer [[Installing%20from%20ELPA-tar][this FAQ entry]] for further information.
642 5) Press =i= to mark the package for installation
643 6) Press =x= to install
645 8) Use =M-x locate-library RET org=. If your installation is
646 successful you would something like the following:
648 =Library is file ~/.emacs.d/elpa/org-20110403/org.elc=
650 # 7) If you get the following error "*Failed to download `Org-mode'
651 # archive.*" in step 2, you can manually download the tarball and
652 # install it. Refer [[Installing from ELPA-tar][this FAQ entry]] for more information.
654 # 8) Add Orgmode as a package archive. This can be done in two ways:
655 # 9) Use =M-x customize-variable RET package-archives=
656 # 10) Add the following line to your =.emacs= and reload Emacs.
657 # #+begin_src emacs-lisp
658 # (add-to-list 'package-archives '("Org-mode" . "http://orgmode.org/pkg/daily/"))
662 ** How do I install Emacs package manager?
664 :CUSTOM_ID: installing-elpa
667 If you are running Emacs 24 or find the command =M-x list-packages=
668 available you already have the package manager installed.
670 Steps for installing package manager on emacs-23:
671 1. Download the package manager [[http://repo.or.cz/w/emacs.git/blob_plain/1a0a666f941c99882093d7bd08ced15033bc3f0c:/lisp/emacs-lisp/package.el][package.el]]
673 2. Add the following to your =.emacs= and reload Emacs.
674 #+begin_src emacs-lisp
675 ;; change "~/elisp/" as appropiate
676 (setq load-path (cons "~/elisp" load-path))
678 ;; Add the below lines *at the end* of your .emacs. This
679 ;; ensures that packages installed with package manager
680 ;; overrides other local installation
685 ** I don't see Org-mode as an installation option in Package Manager Menu?
687 :CUSTOM_ID: why-no-org-in-elpa
690 Emacs Package Manager is a very recent addition to Emacs. Work is
691 under way to have have Org-mode seamlessly integrate with Emacs'
692 Package Manager. As a result, it will be some time before the
693 Org-mode packages are available and usable from either GNU or
694 Org-mode package archives.
696 In the meanwhile, you can install Org-mode via package manager
697 through ELPA-compatible tar. Refer [[Installing from ELPA-tar][this FAQ entry]] for more information.
699 ** How do I install Org-mode from a ELPA-compatible tarball?
701 :CUSTOM_ID: installing-from-elpa-tarball
703 # <<Installing from ELPA-tar>>
705 Org-mode is distributed as an ELPA-compatible tar which can be used
706 in conjunction with Emacs' package manager.
708 1. If you are already running Org-mode, note the current version
709 reported by M-x org-version.
710 2. Download the latest tarball from [[http://orgmode.org/pkg/daily/][Org-mode repo]].
711 3. Do =M-x package-install-file=. When prompted for =Package file
712 name=, point it to .tar file downloaded in step 2.
714 You will now see Package Manager compiling the files and
716 4. Reload emacs. This step is very important.
717 5. Note the version of the new installation using M-x
718 org-version. If the new and old versions are different, the
719 installation is done and you are all set to enjoy the updated
720 Org-mode. Otherwise skip to step 6.
721 6. Review you load-path using =C-h v load-path=. Most likely that
722 your old installation path takes precedence over the path chosen
723 by package manager (which is typically
724 =~/.emacs.d/elpa/...=). Fix this anamoly by moving
725 =(package-initialize)= line in .emacs to a more appropriate
728 - Additional Note on =org-install.el= :: Functionality of Org-mode's
729 =org-install.el= is supplanted by Package Manager's
730 =org-autoloads.el=. Since Package Manager autoloads Org-mode for
731 you, the following line =(require 'org-install)= in your =.emacs=
732 is no longer required and can be safely removed.
734 ** Why would I use ELPA tarballs instead of the snapshot tarballs?
739 ELPA-tarballs automate much the process of upgrading org-mode. Much
740 of the following grunt work is done automatically by the Package
743 1. Downloading, compiling, and activating of org-mode (including
744 setting org-mode's =load-path= and autoloads).
745 2. Updating info files.
751 ** How can I quickly browse all Org options?
753 =M-x org-customize RET=
755 See also [[file:org-tutorials/org-customize.org][Carsten's Org customize tutorial]] and [[file:org-configs/org-customization-guide.org][this customization guide]]
758 ** Can I use the editing features of org-mode in other modes?
760 :CUSTOM_ID: use-editing-features-in-other-modes
763 Not really---but there are a few editing features you can use in
766 - For tables there is =orgtbl-mode= which implements the table
767 editor as a minor mode. (To enable, type =M-x orgtbl-mode=)
768 - For ordered lists there is =orgstruct-mode= which allows for easy
769 list editing as a minor mode. (To enable, type =M-x
772 You can activate these modes automatically by using hooks:
774 : (add-hook 'mail-mode-hook 'turn-on-orgtbl)
775 : (add-hook 'mail-mode-hook 'turn-on-orgstruct)
777 For footnotes, there is the function =org-footnote-action=, which
778 works in non-org buffers. This function is a powerful tool for
779 creating and sorting footnotes. To use it globally, you can add the
780 following keybinding to your =.emacs= file (requires Org 6.17 or
783 : (global-set-key (kbd "C-c f") 'org-footnote-action)
785 For other features you need to switch to Org-mode temporarily, or
786 prepare text in a different buffer.
788 ** Why isn't feature "X" working the way it is described in the manual?
790 :CUSTOM_ID: making-sure-org-mode-is-up-to-date
793 Org-mode develops very quickly. If you are using a version of Org-mode
794 that shipped with emacs, there is a good chance that it is somewhat
797 Many of the users on the Org-mode mailing list are using either a
798 recent release of Org-mode or the
799 [[http://orgmode.org/index.html#sec-3.2][development version of
800 org-mode from the git repository]].
802 If some settings and features aren't working the way you expect, make
803 sure that the version of the manual you are consulting matches the
804 version of Org-mode you are using.
806 - You can check which version of Org-mode you are using by
807 selection =Org --> Documentation --> Show Version= in the Emacs
810 - The [[http://orgmode.org/manual/index.html][online manual]] at [[http://orgmode.org][orgmode.org]] corresponds to the most recent
813 - 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
814 released with the latest official Gnu Emacs release. Compared
815 with the manual at the orgmode.org, the manual at www.gnu.org is
816 somewhat out of date.
818 For instructions on how to stay current with Org-mode, consult [[keeping-current-with-Org-mode-development][this
819 FAQ]] or follow the instructions on [[http://orgmode.org][the official Org-mode site]].
821 ** Can I get the visibility-cycling features in outline-mode and outline-minor-mode?
823 :CUSTOM_ID: use-visibility-cycling-in-outline-mode
826 Yes, these functions are written in a way that they are independent of
827 the outline setup. The following setup provides standard Org-mode
828 functionality in outline-mode on =TAB= and =S-TAB=. For
829 outline-minor-mode, we use =C-TAB= instead of =TAB=,
830 because =TAB= usually has mode-specific tasks.
832 #+BEGIN_SRC emacs-lisp
833 (add-hook 'outline-minor-mode-hook
835 (define-key outline-minor-mode-map [(control tab)] 'org-cycle)
836 (define-key outline-minor-mode-map [(shift tab)] 'org-global-cycle)))
837 (add-hook 'outline-mode-hook
839 (define-key outline-mode-map [(tab)] 'org-cycle)
840 (define-key outline-mode-map [(shift tab)] 'org-global-cycle)))
843 Or check out /outline-magic.el/, which does this and also provides
844 promotion and demotion functionality. /outline-magic.el/ is
845 available at [[http://www.astro.uva.nl/~dominik/Tools/outline-magic.el][Outline Magic]].
847 ** Can I save/restore the visibility state of an org-mode buffer?
849 :CUSTOM_ID: saving-visibility-state
852 Well, no---at least not automatically. You can, however, control the
853 visibility of an org-file or of individual trees by adding
854 instructions to your org file. See [[http://orgmode.org/manual/Visibility-cycling.html#Visibility-cycling][this section of the manual]] for more
857 ** How can I keep track of changes in my Org files?
859 :CUSTOM_ID: track-of-changes-in-Org-files
862 Use git to track the history of the files, use a cronjob to check in
863 changes regularly. Such a setup is described by Bernt Hansen
864 in [[http://article.gmane.org/gmane.emacs.orgmode/6233][this message]] on [[http://dir.gmane.org/gmane.emacs.orgmode][emacs-orgmode]].
866 ** Can I use Org-mode as the default mode for all README files?
868 :CUSTOM_ID: Org-mode-as-default-mode
871 Add the following to your .emacs file:
873 : (add-to-list 'auto-mode-alist '("README$" . org-mode))
875 You can even make it the default mode for any files with unspecified
878 : (setq default-major-mode 'org-mode)
880 ** Can I use ido.el for completing stuff in Org?
882 :CUSTOM_ID: ido-complete
885 Yes, you can. If you are an ido user and ido-mode is active, the
886 following setting will make Org use =ido-completing-read= for most
887 of its completing prompts.
889 : (setq org-completion-use-ido t)
891 ** Should I use one big org file or multiple files?
893 :CUSTOM_ID: how-to-organize-org-mode-files
896 Org-mode is flexible enough to accomodate a variety of organizational
897 and time management schemes. Org's [[http://orgmode.org/manual/Document-Structure.html#Document-Structure][outline cycling and convenient
898 editing and navigation commands]] make it possible to maintain all of
899 your projects and notes in a single file. But org-mode's [[http://orgmode.org/manual/Hyperlinks.html#Hyperlinks][quick and
900 easy hyperlinks]], along with [[http://orgmode.org/manual/Refiling-notes.html#Refiling-notes][easy refiling of notes and todos]], also
901 make it a delight to maintain a private "wiki" consisting of multiple
904 No matter how you organize your org files, org-mode's agenda commands
905 make it easy to search all your notes and gather together crucial data
908 Moreover, several org-mode settings can be configured either globally
909 in your =.emacs= file or locally (per file or per outline tree). See
910 the [[http://orgmode.org/manual/index.html#Top][manual]] for more details. For an example of local customizations
911 see [[limit-agenda-with-category-match][this FAQ]].
913 Here are a few ideas for organizing org-mode files:
915 - A single file for all your projects and notes.
916 - One file per project.
917 - One file per client.
918 - One file per area of responsibility or type of work (e.g.,
919 household, health, work, etc.).
920 - One file for projects, one for appointments, one for reference
921 material, one for someday/maybe items, etc.
922 - A wiki of hyperlinked files that grows and adapts to meet your
925 For more ideas, see some of the links on the [[file:org-tutorials/index.org][org-tutorial index]] or
926 [[file:org-gtd-etc.org][this page on org-mode and GTD]].
928 ** Why doesn't C-c a call the agenda? Why don't some org keybindings work?
930 :CUSTOM_ID: setting-global-keybindings
933 Org-mode has a few global keybindings that the user must set
934 explicitly in an =.emacs= file. These keybindings include the
935 customary shortcut for calling the agenda (=C-c a=). If nothing
936 happens when you type =C-c a=, then make sure that the following lines
937 are in your =.emacs= file:
939 #+BEGIN_SRC emacs-lisp
940 ;; The following lines are always needed. Choose your own keys.
941 (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
942 (global-set-key "\C-cl" 'org-store-link)
943 (global-set-key "\C-ca" 'org-agenda)
944 (global-set-key "\C-cb" 'org-iswitchb)
947 You may, of course, choose whatever keybindings work best for you
948 and do not conflict with other modes.
950 Please see [[http://orgmode.org/manual/Activation.html][this section of the manual]] if you have additional
953 ** Why aren't some of the variables I've customized having an effect?
955 :CUSTOM_ID: load-org-after-setting-variables
958 Some org variables have to be set before org.el is loaded or else they
959 will not work. (An example is the new variable
960 =org-enforce-todo-dependencies=.)
962 To make sure all your variables work you should not use =(require
963 'org)=. Instead use the following setting:
965 : (require 'org-install)
967 You should also make sure that you do not require any other =org-...=
968 files in your =.emacs= file before you have set your org variables,
969 since these will also cause org.el to be loaded. To be safe, load org
970 files *after* you have set your variables.
972 ** How can I make sure that timestamps appear in English?
974 :CUSTOM_ID: timestamps-and-system-time-locale
977 If your system's locale is not set to English, but you would like the
978 timestamps in your org-mode files to appear in English, you can set
979 the following variable:
981 #+begin_src emacs-lisp
982 (setq system-time-locale "C")
985 ** What does a minimal .emacs look like?
987 :CUSTOM_ID: minimal-emacs
990 Using a stripped down minimal .emacs files removes broken custom
991 settings as the cause of an issue and makes it easy to reproduce for
992 other people. The example below has system-specific paths that you'll
993 need to change for your own use.
994 #+begin_src emacs-lisp
995 (add-to-list 'load-path (expand-file-name "~/git/org-mode/lisp"))
996 (add-to-list 'auto-mode-alist '("\\.\\(org\\ |org_archive\\|txt\\)$" . org-mode))
997 (setq org-agenda-files '("/tmp/test.org"))
998 (require 'org-install)
1001 (global-set-key "\C-cl" 'org-store-link)
1002 (global-set-key "\C-ca" 'org-agenda)
1003 (global-set-key "\C-cb" 'org-iswitchb)
1006 You can save the minimal .emacs file to ~/minimal.emacs, add suspect
1007 configuration code to it, then start emacs something like this:
1009 emacs -Q -l ~/minimal.emacs
1012 On OS X, starting emacs with minimal configuration might look
1013 something like this:
1015 /Applications/emacs.app/Contents/MacOS/Emacs -Q -l ~/minimal.emacs
1018 ** Can I migrate from Planner?
1020 Yes. This [[http://www.c0t0d0s0.de/plan2org/plan2org.pl][perl script]] or [[http://gitorious.org/bkuhn-small-hacks/org-mode/blobs/master/planner2org.plx
1021 ][this Perl script]] can help.
1023 * Errors and general problems
1027 ** Opening Org files in Emacs leads to a crash
1029 :CUSTOM_ID: Emacs-crashes-with-org-indent-mode
1031 The only known case where Org-mode can crash Emacs is when you are
1032 using =org-indent-mode= with Emacs 23.1 (in fact, any version of
1033 Emacs before version 23.1.50.3). Upgrade to Emacs 23.2 and the
1034 problem should go away.
1036 ** When I try to use Org-mode, I always get the error message =(wrong-type-argument keymapp nil)=
1038 :CUSTOM_ID: wrong-type-argument-keymapp
1041 This is a conflict with an outdated version of the /allout.el/, see
1042 the [[http://orgmode.org/manual/Conflicts.html#Conflicts][Conflicts]] section in the manual
1044 ** How can I control the application launched by Org-mode to open a certain file type like pdf, html....
1046 :CUSTOM_ID: external-application-launched-to-open-file-link
1049 If you want special control about how Org-mode opens files, see the
1050 variables =org-file-apps=, =org-file-apps-defaults-gnu=,
1051 =org-file-apps-defaults-macosx=, =org-file-apps-defaults-windowsnt=.
1053 *However*, normally it is best to just use the mechanism the
1054 operating-system provides:
1056 *** GNU/Linux systems
1057 You you have to check your mailcap settings, find the files:
1065 and modify them accordingly. Please read their manual entry.
1068 + for html pages you may configure the =browse-url-= variables through
1069 the Customize interface,
1070 + the pdf files are automatically opened with Acrobat Reader (if it is
1074 Change the application responsible for this file type by selecting
1075 such a file in the Finder, select =File->Get Info= from the menu
1076 and select the application to open this file with. Then, to
1077 propagate the change to all files with the same extension, select
1078 the =Change all= button.
1080 ** Org-mode takes over the TAB key. I also want to use YASnippet, is there a way to fix this conflict?
1082 :CUSTOM_ID: YASnippet
1085 [[http://code.google.com/p/yasnippet/][yasnippet]] is yet another snippet expansion system for Emacs. It is
1086 inspired by TextMate's templating syntax.
1087 - watch the [[http://www.youtube.com/watch?v=vOj7btx3ATg][video on YouTube]]
1088 - see the [[http://yasnippet.googlecode.com/svn/trunk/doc/index.html][intro and tutorial]]
1090 *Note*: yasnippet is not compatible with =org-indent-mode= currently
1091 there is no known way to use both successfully with =yas/trigger-key=
1092 set to =TAB= (or =[tab]= etc...)
1094 The way Org-mode binds the =TAB= key (binding to =[tab]= instead of
1095 =\t=) overrules yasnippets' access to this key. The following code
1098 #+begin_src emacs-lisp
1099 (add-hook 'org-mode-hook
1101 (org-set-local 'yas/trigger-key [tab])
1102 (define-key yas/keymap [tab] 'yas/next-field-group)))
1105 If the above code doesn't work (which it may not with later versions
1106 of yasnippet). Then try the following
1108 #+begin_src emacs-lisp
1109 (defun yas/org-very-safe-expand ()
1110 (let ((yas/fallback-behavior 'return-nil)) (yas/expand)))
1112 (add-hook 'org-mode-hook
1114 ;; yasnippet (using the new org-cycle hooks)
1115 (make-variable-buffer-local 'yas/trigger-key)
1116 (setq yas/trigger-key [tab])
1117 (add-to-list 'org-tab-first-hook 'yas/org-very-safe-expand)
1118 (define-key yas/keymap [tab] 'yas/next-field)))
1121 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]])
1122 with YASnippets for Org-mode.
1124 ** Org-mode takes over the S-cursor keys. I also want to use CUA-mode, is there a way to fix this conflict?
1126 :CUSTOM_ID: CUA-mode
1129 Yes, see the [[http://orgmode.org/manual/Conflicts.html#Conflicts][Conflicts]] section of the manual.
1131 ** Org-mode takes over the S-cursor keys. I also want to use windmove.el, is there a way to fix this conflict?
1133 :CUSTOM_ID: windmove.el
1136 Yes, see the [[http://orgmode.org/manual/Conflicts.html#Conflicts][Conflicts]] section of the manual.
1138 ** Org behaves strangely: some keys don't work, some features are missing, my settings have no effect, ...
1140 :CUSTOM_ID: loaded-old-org
1143 When this sort of things happen, it probably is because Emacs is
1144 loading an old version of Org-mode instead of the one you expected.
1145 Check it with =M-x org-version=.
1147 This happens because Emacs loads first the system org-mode (the one
1148 included with Emacs) before the one in your directory. Check the
1149 =load-path= variable; you might see that your org-mode appears /after/
1150 the system-wide path; this is bad.
1152 You should add your directories to the =load-path= at the beginning:
1154 : (add-to-list 'load-path "~/.emacs.d/org-mode/lisp") (require 'org-install)
1156 Function =add-to-list= adds at the beginning. Don't use =append=
1157 because it appends at the end. Also be sure to use =(require
1158 'org-install)= and not =(require 'org)=.
1160 This wrong version loading may also happen if you have a byte-compiled
1161 =org.elc= from an old version together with a new =org.el=. Since
1162 Emacs prefers loading byte-compiled files (even if the =.el= is
1163 newer), it will load the old Org-mode.
1165 ** Why doesn't org-batch-agenda work under Win32?
1167 :CUSTOM_ID: org-batch-agenda-under-win32
1170 When I run the example batch files to print my agenda to the console
1171 under Win32 I get the failure:
1173 : End of file during parsing
1175 and no agenda is printed.
1177 The problem is the use of single quotes surrounding the eval in the
1178 emacs command-line. This gets confused under Win32. All string
1179 parameters with spaces must be surrounded in double quotes. This means
1180 that double quotes being passed to the eval must be escaped.
1182 Therefore, instead of the following:
1184 : <path to emacs>\emacs.exe -batch -l ~/_emacs_org \
1185 : -eval '(org-batch-agenda "a")'
1187 you need to use the following:
1189 : <path to emacs>\emacs.exe -batch -l ~/_emacs_org \
1190 : -eval "(org-batch-agenda \"a\")"
1192 (all on one line, of course).
1194 ** Org agenda seems very slow
1196 :CUSTOM_ID: slow-agenda
1199 If it takes a long time to generate or refresh the agenda, you might
1200 want first check which version of org-mode you are using. There have
1201 been major optimizations of org-agenda since 6.21b, which was the
1202 version of org-mode released with Emacs 23. If you are using 6.21b or
1203 earlier (you can check with =M-x org-version=), then you might want to
1204 consider upgrading to a more recent version of org-mode.
1206 Here are some other ideas for speeding up the agenda:
1208 1. Use a one day agenda view (rather than a seven day view).
1210 =(setq org-agenda-ndays 1)=
1212 2. Archive inactive items to separate files.
1214 =C-c C-x C-s= (org-archive-subtree)
1216 3. Do not include the global todo list in your agenda view.
1218 (setq org-agenda-include-all-todo nil)
1220 4. Make sure that your org files are byte-compiled.
1222 I.e., make sure there are files ending in =.elc= in your org
1223 installation directory.
1225 5. Limit your agenda files (=org-agenda-files=) to files that have
1226 active todos and or projects.
1228 If you have a number of older reference files---i.e., files you
1229 search only occasionally---in your agenda files list, consider
1230 removing them from your agenda files and adding them to
1231 =org-agenda-text-search-extra-files= instead. Similarly, you might
1232 consider searching some of your older reference files with =M-x
1233 grep= so that Org-mode does not have to load them into memory when
1234 the agenda is called.
1236 ** Visual-line-mode doesn't work well with org-mode
1238 :CUSTOM_ID: visual-line-mode
1241 Visual-line-mode "soft wraps" lines so that the visual edge of the
1242 buffer is considered a line break for purposes of navigation, even
1243 though there is no line break in reality.
1245 In older versions of org-mode, org-beginning-of-line and
1246 org-end-of-line do not work well with visual line mode. (The two
1247 commands disregard soft line breaks and move to the beginning and end
1248 of the hard line break.) A patch was introduces to fix this behavior
1251 If you are using an older version of org mode, you can:
1253 1. Add a hook to turn off visual line mode.
1255 2. Add the following to your =.emacs=:
1257 #+begin_src emacs-lisp
1259 (add-hook 'org-mode-hook
1261 (define-key org-mode-map "\C-a" 'move-beginning-of-line)
1262 (define-key org-mode-map "\C-e" 'move-end-of-line)))
1265 ** Can I hide blocks at startup?
1269 #+begin_src emacs-lisp
1270 (setq org-hide-block-startup t)
1276 ,#+STARTUP: hideblocks
1279 on a per-file basis.
1281 * Faces and highlighting
1285 ** Org-mode has a lot of colors? How can I change them?
1287 :CUSTOM_ID: customizing-org-faces
1290 This is a question that applies to Emacs as a whole, but it comes up
1291 quite frequently on the org-mode mailing list, so it is appropriate to
1294 If you would like to change the style of a face in org-mode (or any
1295 other Emacs mode), simply type =M-x customize-face [RET]= while the
1296 cursor is on the color/style you are interested in modifying. You will
1297 be given the opportunity to customize all the faces located at that
1300 If you would like an overview of all the faces in org-mode, you can
1301 type =C-u M-x list-faces-display [RET] org= and you will be shown all
1302 the faces defined by org-mode along with an illustration of their
1305 If you would like to customize org-faces and other aspects of
1306 org-appearance, type =M-x customize-group org-font-lock [RET]=.
1308 Finally, if you would like verbose information about the properties of
1309 the text under the cursor, you can type =C-u C-x ==.
1311 See the Worg page on [[file:org-tutorials/org-appearance.org][customizing Org appearance]] for further information.
1312 ** Why do I get a tiny font in column view when using emacs daemon?
1314 :CUSTOM_ID: column-view-tiny-font
1317 When using emacs in daemon mode (=emacs --daemon=), client frames
1318 sometimes override the column view face settings, resulting in very
1319 small fonts. Here is a fix:
1321 #+begin_src emacs-lisp
1322 (defun org-column-view-uses-fixed-width-face ()
1323 ;; copy from org-faces.el
1324 (when (fboundp 'set-face-attribute)
1325 ;; Make sure that a fixed-width face is used when we have a column
1327 (set-face-attribute 'org-column nil
1328 :height (face-attribute 'default :height)
1329 :family (face-attribute 'default :family))))
1331 (when (and (fboundp 'daemonp) (daemonp))
1332 (add-hook 'org-mode-hook 'org-column-view-uses-fixed-width-face))
1335 This fix was provided in the following mailing list post:
1337 http://article.gmane.org/gmane.emacs.orgmode/27560
1338 ** How can I stop the mouse cursor from highlighting lines in the agenda?
1340 :CUSTOM_ID: ratpoison-for-agenda-highlighting
1343 You can add the following to your =.emacs=:
1345 #+begin_src emacs-lisp
1346 (add-hook 'org-finalize-agenda-hook
1347 (lambda () (remove-text-properties
1348 (point-min) (point-max) '(mouse-face t))))
1355 ** Can I close an outline section without starting a new section?
1357 :CUSTOM_ID: closing-outline-sections
1360 Can I have nested, closed outline sections, similar to xml? This
1361 question comes up quite frequently on the mailing list.
1363 See the following threads:
1365 - http://permalink.gmane.org/gmane.emacs.orgmode/40182
1366 - http://permalink.gmane.org/gmane.emacs.orgmode/36719
1367 - http://permalink.gmane.org/gmane.emacs.orgmode/24092
1368 - http://permalink.gmane.org/gmane.emacs.orgmode/12425
1370 The desired behavior looks something like this:
1385 ,# end Subsection Two
1387 ,Continue text in section one.
1390 The short answer to the question is no. Org-mode adheres to the
1391 cascading logic of outlines, in which a section is closed only by
1392 another section that occupies an equal or greater level.
1394 Here are some workarounds:
1396 1. You can use inline tasks to create non-folding subsections. See the
1397 documentation in org-inlinetask.el, which is part of the org-mode
1399 2. You can create a temporary heading, such as "** Continue main
1400 section" and then remove it when you are ready to export.
1401 3. You can create a separate outline heading (e.g., * ACTIONS),
1402 creating TODOs there with links to the relevant sections of your
1405 ** Can I add a TODO to a list item?
1407 :CUSTOM_ID: list-item-as-todo
1410 No. When generating agenda views, org-mode treats only headlines as
1413 You can, however, use a status cookie together with checkboxes to
1414 monitor your progress on a series of subtasks:
1417 ,** TODO Big task [1/3]
1424 If you would like to embed a TODO within text without treating it as
1425 an outline heading, you can use inline tasks. Simply add...
1427 : (require 'org-inlinetask)
1429 ...to your =.emacs= and then type C-c C-x C-t to insert an inline task.
1431 ** Can I have two windows on the same Org-mode file, with different outline visibilities?
1433 :CUSTOM_ID: indirect-buffers
1436 You may use /indirect buffers/ which do exactly this. See the
1437 documentation on the command =make-indirect-buffer=.
1439 Org-mode has built-in commands that allow you create an indirect
1440 buffer from a subtree of an outline. To open a subtree in new
1441 window, type =C-c C-x b=. Any changes you make in the new window
1442 will be saved to the original file, but the visibility of both
1443 buffers will remain independent of one another.
1445 For multiple indirect buffers from the same file, you must use the
1446 prefix =C-u= when creating the second (or third) buffer. Otherwise
1447 the new indirect buffer will replace the old.
1449 You can also create an independent view of an outline subtree by
1450 typing =b= on an item in the agenda.
1452 ** Emacs outlines are unreadable. Can I get rid of all those stars?
1454 :CUSTOM_ID: Emacs-outlines-are-unreadable
1457 See the section [[http://orgmode.org/manual/Clean-view.html#Clean-view][Clean outline view]] in the manual.
1458 ** C-k is killing whole subtrees! I lost my work!
1460 :CUSTOM_ID: C-k-is-killing-subtrees
1463 =(setq org-ctrl-k-protect-subtree t)= before losing your work.
1465 ** Why aren't commands working on regions?
1467 :CUSTOM_ID: transient-mark-mode
1470 Some org-mode commands, such as M-right and M-left for demoting or
1471 promoting headlines (see [[demote-multiple-headlines][this FAQ]]), can be applied to entire regions.
1472 These commands, however, will only work on active regions set with
1473 [[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
1474 Emacs 23. To enable it in earlier versions of emacs, put the following
1475 in your =.emacs= file:
1477 : (transient-mark-mode 1)
1479 Alternatively, you may turn off transient mark mode and use [[http://www.gnu.org/software/emacs/manual/html_node/emacs/Momentary-Mark.html][a
1480 momentary mark]] (=C-<SPC> C-<SPC>=).
1482 ** Why is a blank line inserted after headlines and list items?
1484 :ID: 2463F4D8-F686-4CF3-AA07-08976F8A4972
1487 :CUSTOM_ID: blank-line-after-headlines-and-list-items
1490 In org-mode, typing =M-RET= at the end of a headline will create a new
1491 headline of the same level on a new line. The same is true for plain
1492 lists. By default org-mode uses context to determine if a blank line
1493 should be inserted after each headline or plain list item when =M-RET=
1494 is pressed. For instance, if a there is a blank line before a
1495 headline, then typing =M-RET= at the end of the line will insert a
1496 blank line before the new headline. For instance, hitting =M-RET=
1497 at the end of "Headline Two" below inserts a new headline without a
1504 If there is a blank line between Headline One and Headline Two,
1505 however, the results will be as follows:
1513 If you do not like the default behavior you can change it with the
1514 variable =org-blank-before-new-entry=. You can set headings and/or
1515 plain lists to auto (the default setting), t (always), or nil (never).
1517 ** How can I promote or demote multiple headlines at once?
1519 :CUSTOM_ID: demote-multiple-headlines
1522 If you have a long list of first level headlines that you'd like to
1523 demote to second level headlines, you can select the headlines as a
1524 region and then hit =M-<right>= to demote all the headlines at once.
1526 Note: =M-S-<right>= will not work on a selected region. Its use is to
1527 demote a single subtree (i.e., a headline and all sub-headlines).
1529 If M-<right> doesn't seem to work, make sure transient mark mode is
1530 enabled. See [[transient-mark-mode][this FAQ]].
1532 ** What's the deal with all the ellipses in my org outlines?
1534 :CUSTOM_ID: org-ellipses
1537 Org-mode uses ellipses to indicate folded (and thus hidden) text. Most
1538 commonly, ellispes occur at the end of headings with folded content:
1542 Or, for instance, they may indicate closed drawers:
1546 Sometimes, as a result of editing and cycling an outline, ellipses may
1547 appear in unexpected places. You should *never* delete these ellipses,
1548 as you may accidentally delete hidden text. Instead, you can type =C-c
1549 C-r= (org-reveal) to display all hidden text in the vicinity. Or you
1550 may type =M-x RET show-all= to reveal all text in the org file.
1552 If you would prefer a symbol or face for indicating hidden text, you
1553 can customize the variable org-ellipses.
1555 ** How do I yank a subtree so it's indented according to the point's location?
1557 :CUSTOM_ID: yank-indent-subtree
1560 You can either use =C-c C-w= with a working [[http://orgmode.org/manual/Refiling-notes.html#Refiling-notes][refile-targets]] setup.
1562 Or set =org-yank-adjusted-subtrees= to =t= which will adjust the
1563 yanked headline's level correctly.
1565 Just use =C-k= and =C-y= as you would everywhere else in Emacs.
1567 ** Can I read org-mode outlines in vim?
1569 :CUSTOM_ID: org-outlines-in-vim
1572 Yes, there is a script that enables one to view and navigate folded
1573 outline/org files in vim (though without most of org-mode's
1574 functionality, of course).
1576 - [[http://www.vim.org/scripts/script.php?script_id%3D1266][Emacs outline mode - Imitates Emacsen : vim online]]
1578 For instructions on how to set it up, please see [[http://mid.gmane.org/EA275862-B97A-4BAC-B879-177FD07A2D56@gaillourdet.net][this mailing list
1581 Work is also underway on an org-mode clone for Vim. You can check it
1584 https://github.com/hsitz/VimOrganizer
1586 ** Can I use another character than "*" to start a headline?
1588 No. The "*" character is used in =outline-mode=, and Org is derived from
1591 If you are curious as to what other rationales there are for "*", check out
1592 [[http://permalink.gmane.org/gmane.emacs.orgmode/44271][this]] mail and the thread it is in.
1596 :CUSTOM_ID: Todos-and-Tags
1598 ** How can I cycle through the TODO keyword of an entry?
1600 :CUSTOM_ID: cycle-TODO-keywords
1603 =C-c C-t= or =S-<left/right>= is what you need.
1605 ** How do I track state changes for tasks in Org?
1607 :CUSTOM_ID: track-state-changes-for-tasks
1610 Take a look at the [[http://thread.gmane.org/gmane.emacs.orgmode/6082][post by Bernt Hansen]] for setting up TODO keyword
1611 states and logging timestamps for task state changes.
1613 ** Can I select the TODO keywords with a tag-like interface?
1615 :CUSTOM_ID: select-TODO-keywords-with-tag-like-interface
1618 Yes. Use =(setq org-use-fast-todo-selection t)=
1620 If you want to set both your todos and your tags using a single
1621 interface, then check out the variable
1622 =org-fast-tag-selection-include-todo=.
1624 See [[http://orgmode.org/manual/Fast-access-to-TODO-states.html][this section of the manual]] for more details.
1626 ** How can I quickly set the tag of an entry?
1628 :CUSTOM_ID: quickly-set-tag-of-entry
1631 Use =C-c C-c= or =C-c C-q= on the headline. =C-c C-q= is useful for
1632 setting tabs in a [[http://orgmode.org/manual/Remember.html#Remember][remember]] buffer, since =C-c C-c= is the default
1633 keybinding for filing a note from the remember buffer.
1635 You can set tags even more quickly by setting one of the character
1636 shortcuts for [[http://orgmode.org/manual/Setting-tags.html#Setting-tags][fast tag selection]].
1638 To set tag shortcuts for all org buffers, put something like the
1639 following in your =.emacs= file (or create the same settings by
1640 typing =M-x customize-variable RET org-tag-alist=):
1642 : (setq org-tag-alist '(("computer" . ?c) ("office" . ?o) ("home" . ?h)))
1644 To set tag shortcuts for a single buffer, put something like the
1645 following at the top of your org file:
1647 : #+TAGS: computer(c) office(o) home(h)
1649 ** How can I change the colors of TODO keywords?
1651 You can use the variable org-todo-keyword-faces. Here are some sample
1654 #+begin_src emacs-lisp
1655 (setq org-todo-keyword-faces
1657 ("TODO" . (:foreground "firebrick2" :weight bold))
1658 ("WAITING" . (:foreground "olivedrab" :weight bold))
1659 ("LATER" . (:foreground "sienna" :weight bold))
1660 ("PROJECT" . (:foreground "steelblue" :weight bold))
1661 ("DONE" . (:foreground "forestgreen" :weight bold))
1662 ("MAYBE" . (:foreground "dimgrey" :weight bold))
1663 ("CANCELED" . shadow)
1667 If you want to change the color of all active todos or all inactive
1670 : M-x customize-face RET org-todo
1671 : M-x customize-face RET org-done
1673 You can also set values for each of these in your =.emacs= file:
1675 : (set-face-foreground 'org-todo "firebrick2")
1676 : (set-face-foreground 'org-done "forestgreen")
1678 ** Can I use a arbitrary character in a TODO keyword?
1680 Yes, provided you add it to the "word" syntax in Emacs.
1682 For example, to add the =\u25b6= and the =\u25b8= chars, just add this to
1683 your Emacs configuration:
1685 #+begin_src emacs-lisp
1686 (add-hook 'org-mode-hook
1688 (modify-syntax-entry (string-to-char "\u25b6") "w")
1689 (modify-syntax-entry (string-to-char "\u25b8") "w")))
1691 ** How do I arrange for an item to be automatically marked DONE when all checkboxes are checked?
1693 This has arisen a couple of time
1694 (e.g. http://thread.gmane.org/gmane.emacs.orgmode/42715 and
1695 http://thread.gmane.org/gmane.emacs.orgmode/47363) in the mailing
1698 An item consists of a list with checkboxes. When all of the
1699 checkboxes are checked, the item should be considered complete and its
1700 TODO state should be automatically changed to DONE. The code below
1701 does that. This version is slightly enhanced over the one in the
1702 mailing list to reset the state back to TODO if a checkbox is
1705 Note that the code requires that a checkbox statistics cookie be
1706 present in order for it to work. Note also that it is too dumb to
1707 figure out whether the item has a TODO state in the first place: if
1708 there is a statistics cookie, a TODO/DONE state will be added
1709 willy-nilly any time that the statistics cookie is changed.
1711 #+begin_src emacs-lisp
1712 ;; see http://thread.gmane.org/gmane.emacs.orgmode/42715
1713 (add-to-list 'org-checkbox-statistics-hook (function ndk/checkbox-list-complete))
1715 (defun ndk/checkbox-list-complete ()
1717 (org-back-to-heading t)
1718 (let ((beg (point)) end)
1722 (if (re-search-forward "\\[\\([0-9]*%\\)\\]\\|\\[\\([0-9]*\\)/\\([0-9]*\\)\\]" end t)
1724 (if (equal (match-string 1) "100%")
1725 ;; all done - do the state change
1728 (if (and (> (match-end 2) (match-beginning 2))
1729 (equal (match-string 2) (match-string 3)))
1731 (org-todo 'todo))))))))
1737 :CUSTOM_ID: Hyperlinks
1739 ** Why do I have to confirm the execution of each shell/elisp link?
1741 :CUSTOM_ID: confirm-shell/elisp-link
1744 The confirmation is there to protect you from unwantingly execute
1745 potentially dangerous commands. For example, imagine a link
1747 : [[shell:rm -rf ~/*][Google Search]]
1749 In an Org-mode buffer, this command would look like /Google Search/,
1750 but really it would remove your home directory. If you wish, you can
1751 make it easier to respond to the query by setting
1753 : (setq org-confirm-shell-link-function 'y-or-n-p
1754 : org-confirm-elisp-link-function 'y-or-n-p).
1756 Then a single keypress will be enough to confirm those links. It is
1757 also possible to turn off this check entirely, but I strongly
1758 recommend against this. Be warned.
1760 ** Can I use RET or TAB to follow a link?
1762 :CUSTOM_ID: RET-or-TAB-to-follow-link
1767 : (setq org-return-follows-link t)
1768 : (setq org-tab-follows-link t)
1770 ** Can I keep mouse-1 clicks from following a link?
1772 :CUSTOM_ID: mouse-1-following-link
1775 Activating links with =mouse-1= is a new feature in Emacs 22, to make
1776 link behavior similar to other applications like web browsers. If
1777 you hold the mouse button down a bit longer, the cursor will be set
1778 without following the link. If you cannot get used to this behavior,
1779 you can (as in Emacs 21) use =mouse-2= to follow links and turn off
1780 link activation for =mouse-1= with
1782 : (setq org-mouse-1-follows-link nil)
1784 ** How can I get completion of file names when creating a link?
1786 :CUSTOM_ID: completion-of-file-links
1789 You can use org-insert-link with a prefix argument:
1793 You will be greeted with prompt in the minibuffer that allows for file
1794 completion using your preferred Emacs method for finding files.
1796 ** How can I use invisible targets within lists?
1798 :CUSTOM_ID: invisible-targets-in-lists
1801 The usual way of turning radio links invisible is to comment them, but
1802 Org comments need to be at the beginning of the line, which breaks list
1805 The workaround here is to add (INVISIBLE) after your <<target>>
1809 : 11. <<target>>(INVISIBLE)
1811 : 12. More text [[target][go to]]
1813 ** Org-mode is not opening mailto links in my default mail client
1815 :CUSTOM_ID: mailto-links
1818 You can customize the function org-mode uses to open mailto links by
1819 setting the variable =org-link-mailto-program=:
1821 =M-x customize-variable org-link-mailto-program=
1823 The default function called is =browse-url=, which opens a mail
1824 composition buffer within Emacs. The type of buffer opened by
1825 browse-url depends on the setting of the variable =mail-user-agent=.
1826 Thus, if you want to ensure that mailto links use Gnus to open a
1827 message buffer, you could add the following to your =.emacs=:
1830 (setq mail-user-agent 'gnus-user-agent)
1833 ** Can I use CamelCase links?
1835 :CUSTOM_ID: CamelCase-links
1838 Yes, you can with the contributed package org-wikinodes.el. Please
1839 consult the [[http://orgmode.org/worg/org-contrib/org-wikinodes.html][documentation]].
1843 :CUSTOM_ID: Plain-Lists
1845 ** How can I insert an empty line before each newly inserted headline, but not before each newly inserted plain-list item?
1847 :CUSTOM_ID: empty-line-before-each-new-headline-but-not-item
1850 : (setq org-blank-before-new-entry
1851 : '((heading . t) (plain-list-item . nil))
1853 See also [[id:2463F4D8-F686-4CF3-AA07-08976F8A4972][Why is a blank line inserted after headlines and list items?]].
1855 ** How can I convert itemized lists to enumerated lists?
1857 :CUSTOM_ID: convert-itemized-to-enumerated-lists
1860 You can use =C-c -= or =S-<left>/<right>= to cycle through the various
1861 bullet headlines available for lists: =-, +, *, 1., 1)=.
1863 See [[http://orgmode.org/manual/Plain-lists.html#Plain-lists][this section of the manual]] for more information.
1865 ** How can I convert plain lists to headlines and vice versa?
1867 :CUSTOM_ID: convert-plain-lists-to-headlines
1870 To convert a plain list item or line to a headline, type =C-c *= on
1871 the headline. This will make the line a subheading of the current
1874 To convert a headline to a plain list item, type =C-c -= while the
1875 cursor is on the headline.
1877 To convert a headline to an unadorned line of text, type =C-c *= on
1880 You can use query replace to accomplish the same things, as Bernt
1881 Hansen explains in [[http://article.gmane.org/gmane.emacs.orgmode/10148][this mailing list post]].
1883 ** Is there a good way to create a description list?
1885 :CUSTOM_ID: description-lists
1888 Yes, these are now built-in:
1891 - item1 :: Description of this item 1
1892 - item2 :: Description of this item 2
1893 - item1 :: Description of this item 3
1894 also in multiple lines
1901 ** Will there ever be support for multiple lines in a table field?
1903 :CUSTOM_ID: table-multiline-fields
1908 You can embed tables created with the table.el package in org-mode
1909 buffers, with mixed success when it comes to export and publishing.
1911 ** How can I make table alignment work with Asian character sets
1913 :CUSTOM_ID: table-alignment-asian-characters
1916 When table alignment fails, it usually has to do with character sets
1917 where some characters have non-integer width. Org will deal correctly
1918 with characters that are one or two or three ASCII characters wide,
1919 but not with characters that are, for example, 1.5 ASCII characters
1920 wide. To make table alignment work you need to switch to a different
1923 ** Can I plot data from a table?
1925 :CUSTOM_ID: plotting-table-data
1928 Yes, you can, using org-plot.el written by Eric Schulte and now
1929 bundled with Org. See [[http://orgmode.org/manual/Org_002dPlot.html#Org-Plot][the manual section about this]].
1931 See also [[file:org-tutorials/org-plot.org][this excellent tutorial]] by Eric Schulte.
1933 ** How can I fill a table column with incremental numbers?
1935 :CUSTOM_ID: fill-table-column-with-incremental-numbers
1938 Here is how: Use a field formula to set the first value in the column:
1950 Then define a column formula in the second field:
1962 After recomputing the table, the column will be filled with
1963 incremental numbers:
1972 ,#+TBLFM: $1=@-1 + 1::@2$1=1
1975 Note that you could use arbitrary starting values and column formulas.
1977 ** Why does my table column get filled with #ERROR?
1979 :CUSTOM_ID: table-column-filled-with-ERROR
1982 Org-mode tried to compute the column from other fields using a
1983 formula stored in the =#+TBLFM:= line just below the table, and
1984 the evaluation of the formula fails. Fix the fields used in the
1985 formula, or fix the formula, or remove it!
1987 ** How can I stop the table editor from creating new lines?
1989 :CUSTOM_ID: table-editor-creates-new-lines
1992 When I am in the last column of a table and just above a horizontal
1993 line in the table, pressing TAB creates a new table line before the
1994 horizontal line. To move to the line below the
1995 horizontal line instead, do this:
1997 Press =down= (to get on the separator line) and then =TAB=.
1998 Or configure the variable
2000 : (setq org-table-tab-jumps-over-hlines t)
2002 ** How can I get table fields starting with "="?
2004 :CUSTOM_ID: table-fields-starting-with-=
2009 : (setq org-table-formula-evaluate-inline nil)
2011 this will no longer happen. You can still use formulas using the
2012 commands ~C-c =~ and ~C-u C-c =~
2014 ** How can I get a vertical bar "|" inside a table field?
2016 :CUSTOM_ID: table-fields-with-vertical-bar
2019 You can use =\vert= to put a vertical bar inside a table field.
2020 This will be converted for export. To use it inside a word use
2021 =abc\vert{}def=. If you need something that looks like a bar in
2022 the Org mode buffer, you can use the unicode character brvbar which
2023 looks like this: \brvbar{}.
2026 ** How can I change the indentation of an entire table without fixing every line by hand?
2028 :CUSTOM_ID: change-indentation-entire-table
2031 The indentation of a table is set by the first line. So just fix the
2032 indentation of the first line and realign with =TAB=.
2034 ** In my huge table the realigning after each TAB takes too long. What can I do?
2036 :CUSTOM_ID: table-realigning-after-TAB-takes-long
2039 Either split the table into several by inserting an empty line every
2040 100 lines or so. Or turn off the automatic re-align with
2042 : (setq org-table-automatic-realign nil)
2044 After this the only way to realign a table is to press =C-c C-c=. It
2045 will no longer happen automatically, removing the corresponding delays
2048 ** Recalculation of my table takes too long. What can I do?
2050 :CUSTOM_ID: Recalculation-of-my-table-takes-too-long
2053 Nothing, really. The spreadsheet in org is mostly done to make
2054 calculations possible, not so much to make them fast. Since Org-mode
2055 is firmly committed to the ASCII format, nothing is stopping you from
2056 editing the table by hand. Therefore, there is no internal
2057 representation of the data. Each time Org-mode starts a computation,
2058 it must scan the table for special lines, find the fields etc. This
2059 is slow. Furthermore, Calc is slow compared to hardware
2060 computations. To make this work with normal editing, recalculation
2061 is not happening automatically, or only for the current line, so that
2062 the long wait for a full table iteration only happens when you ask
2065 So for really complex tables, moving to a "real" spreadsheet may
2066 still be the best option.
2068 That said, there are some ways to optimize things in Org-mode, and I
2069 have been thinking about moving a bit further down this line.
2070 However, for my applications this has so far not been an issue at
2071 all. If you have a good case, you could try to convince me.
2073 ** =S-RET= in a table keeps increasing the copied numbers. How can I stop this?
2075 :CUSTOM_ID: S-RET-in-a-table-increases-copied-numbers
2078 Well, it is /supposed/ to be a feature, to make it easy to create a
2079 column with increasing numbers. If this gets into your way, turn it
2082 : (setq org-org-table-copy-increment nil)
2084 ** When I export tables to html, they don't have borders.
2086 :CUSTOM_ID: table-borders-in-html-export
2089 By default, org mode exports tables without borders.
2091 You can changed this by placing an =#+ATTR_HTML= line before the
2094 : #+ATTR_HTML: border="2" rules="all" frame="all"
2096 See [[http://orgmode.org/manual/Tables-in-HTML-export.html#Tables-in-HTML-export][the manual]] for more details.
2098 ** Why does the Calc high precision (e. g. =p20=) not work like expected?
2100 :CUSTOM_ID: table-high-precision
2106 : | 1 / 2 * 3 | 0.16666667000000 |
2107 : #+TBLFM: $2 = $1; p20 %.14f
2110 : | 1 / 2 * 3 | 0.16666666666667 |
2111 : #+TBLFM: $2 = $1 +.0; p20 f-14
2115 It is important to distinguish between the precision of
2116 1) =p20=: Calc internal calculation (=calc-internal-prec=)
2117 2) =f-14=: Calc float formatting, unlimited in precision (=calc-float-format=)
2118 3) =%.14f=: the =printf= reformatting, limited in precision
2120 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.
2122 Use =C-h v org-calc-default-modes RET= to check the Org default settings
2123 which are used if no format specifiers are added to a table formula.
2124 The examples below have been made with the out_of_the_box Org defaults
2125 =calc-internal-prec = 12= and =calc-float-format = 8=.
2127 Remember the formula debugger, toggled with =C-c {=,
2128 to view the processing stages like:
2129 | | formula debugger label | processing stage |
2131 |---+------------------------+----------------------------|
2132 | | Result: | output of Calc |
2133 | | Format: | reformatting with =printf= |
2135 Following are some examples to demonstrate
2136 the interaction of the three precisions.
2138 - *display precision limitations for Calc formulas*
2139 - limited by Calc internal calculation precision from Org default
2141 : | 0.16666666666700 |
2142 : #+TBLFM: $1 = 1 / 2 * 3; f-14
2144 : | 0.1666666666670000000 |
2145 : #+TBLFM: $1 = 1 / 2 * 3; f-19
2147 - limited by Calc float format from Org default (here =f8=)
2149 : #+TBLFM: $1 = 1 / 2 * 3
2152 : #+TBLFM: $1 = 1 / 2 * 3; p20
2154 : | 0.16666667000000 |
2155 : #+TBLFM: $1 = 1 / 2 * 3; %.14f
2157 : | 0.16666667000000 |
2158 : #+TBLFM: $1 = 1 / 2 * 3; p20 %.14f
2160 - limited by Calc float format specified
2162 : #+TBLFM: $1 = 1 / 2 * 3; f-6
2164 : | 0.16666666666667 |
2165 : #+TBLFM: $1 = 1 / 2 * 3; p20 f-14
2167 : | 0.1666666666666666667 |
2168 : #+TBLFM: $1 = 1 / 2 * 3; p20 f-19
2170 - limited by =printf= conversion to Emacs Lisp float
2171 : | 0.1666666699999999900 | the inaccuracy is platform dependent |
2172 : #+TBLFM: $1 = 1 / 2 * 3; %.19f
2174 : | 0.1666666699999999900 | the inaccuracy is platform dependent |
2175 : #+TBLFM: $1 = 1 / 2 * 3; p20 %.19f
2177 : | 0.1666666666666666600 | the inaccuracy is platform dependent |
2178 : #+TBLFM: $1 = 1 / 2 * 3; p20 f-20 %.19f
2180 - limited by =printf= format specified
2182 : #+TBLFM: $1 = 1 / 2 * 3; %.6f
2184 - *display precision limitations for Emacs Lisp formulas*
2185 - limited by Emacs Lisp float
2186 : | 0.16666666666666666 |
2187 : #+TBLFM: $1 = '(/ 1.0 (* 2 3))
2189 : | 0.1666666666666666574 | the inaccuracy is platform dependent |
2190 : #+TBLFM: $1 = '(/ 1.0 (* 2 3)); %.19f
2192 - limited by =printf= format specified
2193 : | 0.16666666666667 |
2194 : #+TBLFM: $1 = '(/ 1.0 (* 2 3)); %.14f
2196 This FAQ entry is based on this [[http://thread.gmane.org/gmane.emacs.orgmode/22642][mailing list thread]]
2197 and is continued in the [[#table-float-fraction][next FAQ entry]].
2199 ** Which float format shows the fraction part also when the latter is zero?
2201 :CUSTOM_ID: table-float-fraction
2208 : #+TBLFM: $2 = $1; f-3
2211 : #+TBLFM: $2 = $1 +.0; f-3
2215 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]]
2216 in the section Mode Settings -> Display Modes -> Float Formats
2217 [[http://www.delorie.com/gnu/docs/calc/calc_163.html][found here as long as the section numbering is unchanged]].
2219 Remember the formula debugger, toggled with =C-c {=,
2220 to view the processing stages like:
2221 | | formula debugger label | processing stage |
2223 |---+------------------------+----------------------------|
2224 | | Result: | output of Calc |
2225 | | Format: | reformatting with =printf= |
2227 Following are some examples to demonstrate different float formats.
2230 : |-----------+---------+-------+---------+----------+-------|
2231 : | number | f3 | f-3 | +.0; f3 | +.0; f-3 | %.3f |
2232 : |-----------+---------+-------+---------+----------+-------|
2233 : | 1 | 1 | 1 | 1.000 | 1.000 | 1.000 |
2234 : | 0 | 0 | 0 | 0.000 | 0.000 | 0.000 |
2235 : |-----------+---------+-------+---------+----------+-------|
2236 : | 1.0 | 1.000 | 1.000 | 1.000 | 1.000 | 1.000 |
2237 : | 0.0 | 0.000 | 0.000 | 0.000 | 0.000 | 0.000 |
2238 : |-----------+---------+-------+---------+----------+-------|
2239 : | 1.0001666 | 1.000 | 1.000 | 1.000 | 1.000 | 1.000 |
2240 : | 0.0001666 | 1.67e-4 | 0.000 | 1.67e-4 | 0.000 | 0.000 |
2241 : |-----------+---------+-------+---------+----------+-------|
2242 : | 1.0016666 | 1.002 | 1.002 | 1.002 | 1.002 | 1.002 |
2243 : | 0.0016666 | 0.002 | 0.002 | 0.002 | 0.002 | 0.002 |
2244 : |-----------+---------+-------+---------+----------+-------|
2245 : #+TBLFM: $2 = $1; f3 :: $3 = $1; f-3 :: $4 = $1 +.0; f3 :: $5 = $1 +.0; f-3 :: $6 = $1; %.3f
2248 : |----------------------+--------------------------+-----------------------|
2249 : | number | f19 | f-19 |
2250 : |----------------------+--------------------------+-----------------------|
2253 : |----------------------+--------------------------+-----------------------|
2254 : | 1.0 | 1.0000000000000000000 | 1.0000000000000000000 |
2255 : | 0.0 | 0.0000000000000000000 | 0.0000000000000000000 |
2256 : |----------------------+--------------------------+-----------------------|
2257 : | 1 + 1 / 2 * 3 * 1e19 | 1.0000000000000000000 | 1.0000000000000000000 |
2258 : | 0 + 1 / 2 * 3 * 1e19 | 1.666666666666666667e-20 | 0.0000000000000000000 |
2259 : |----------------------+--------------------------+-----------------------|
2260 : | 1 + 1 / 2 * 3 * 1e18 | 1.0000000000000000002 | 1.0000000000000000002 |
2261 : | 0 + 1 / 2 * 3 * 1e18 | 0.0000000000000000002 | 0.0000000000000000002 |
2262 : |----------------------+--------------------------+-----------------------|
2263 : #+TBLFM: $2 = $1; p20 f19 :: $3 = $1; p20 f-19
2265 : |----------------------+--------------------------+-----------------------|
2266 : | number | +.0; f19 | +.0; f-19 |
2267 : |----------------------+--------------------------+-----------------------|
2268 : | 1 | 1.0000000000000000000 | 1.0000000000000000000 |
2269 : | 0 | 0.0000000000000000000 | 0.0000000000000000000 |
2270 : |----------------------+--------------------------+-----------------------|
2271 : | 1.0 | 1.0000000000000000000 | 1.0000000000000000000 |
2272 : | 0.0 | 0.0000000000000000000 | 0.0000000000000000000 |
2273 : |----------------------+--------------------------+-----------------------|
2274 : | 1 + 1 / 2 * 3 * 1e19 | 1.0000000000000000000 | 1.0000000000000000000 |
2275 : | 0 + 1 / 2 * 3 * 1e19 | 1.666666666666666667e-20 | 0.0000000000000000000 |
2276 : |----------------------+--------------------------+-----------------------|
2277 : | 1 + 1 / 2 * 3 * 1e18 | 1.0000000000000000002 | 1.0000000000000000002 |
2278 : | 0 + 1 / 2 * 3 * 1e18 | 0.0000000000000000002 | 0.0000000000000000002 |
2279 : |----------------------+--------------------------+-----------------------|
2280 : #+TBLFM: $2 = $1 +.0; p20 f19 :: $3 = $1 +.0; p20 f-19
2282 The =printf= reformatting (=%.19f=) cannot be used with high precision,
2283 see the [[#table-high-precision][previous FAQ entry]].
2285 ** How can I center tables in LaTeX output?
2287 :CATEGORY: centered-tables-in-latex
2290 Set the `org-export-latex-tables-centered' to `t':
2292 : (defcustom org-export-latex-tables-centered t
2293 : "When non-nil, tables are exported in a center environment."
2294 : :group 'org-export-latex
2299 :CUSTOM_ID: Footnotes
2301 ** How can I get automatic renumbering of footnotes in org-mode?
2303 :CUSTOM_ID: footnote-auto-adjust
2306 You can add the following line to your .emacs file:
2308 : (setq org-footnote-auto-adjust t)
2310 Or, if you prefer, you can turn this option on locally by placing the
2311 following line at the top of your org file:
2313 : #+STARTUP: fnadjust
2315 When auto-adjust is turned on, footnotes in the file with numerical
2316 labels will be renumbered whenever a new footnote is added. Meanwhile,
2317 all footnotes, including those with custom labels such
2318 =[fn:custom-label ]=, will be sorted in the order of their appearance
2321 This emulates the footnote behavior that many users may be familiar
2322 with from word-processing programs or from the footnote-mode included
2325 If you do not turn on org-footnote-auto-adjust, you sort and/or
2326 renumber footnotes at any time by calling org-footnote-action with a
2329 ** Why isn't auto renumbering of footnotes turned on by default?
2331 :CUSTOM_ID: why-no-default-auto-adjust
2334 Org mode has a very robust footnote mechanism allowing for a variety
2335 of types of footnotes. With some of the following footnote notations,
2336 auto-adjust may be either irrelevant or undesired:
2338 - Automatically numbered
2339 - Footnotes with custom labels
2342 In addition, org mode can be customized to place footnotes either at
2343 the end of a document or at the end of the outline heading in which
2344 they appear. Users who change this setting while editing a document
2345 may be disconcerted to find all of their footnotes rearranged
2348 ** I have auto-fill-mode set and org-mode is inserting unwanted comment markers!
2350 :CUSTOM_ID: auto-fill-and-unwanted-comments
2353 If the following occurs:
2358 ,# More entered tex.
2361 Make sure that the variable comment-start is nil.
2363 ** Are there any shortcuts for entering source blocks and comment lines?
2365 :CUSTOM_ID: shortcuts-for-entering-source-blocks
2368 Org mode has some [[http://orgmode.org/manual/Literal-examples.html#Literal-examples][very convenient markup]] for including literal blocks
2369 and lines of code in a file. (This is especially useful when exporting
2370 documents or using the contributed package [[file:org-contrib/babel/index.org][org-babel]] for executing
2375 , print "Hello, world!\n";
2379 It can be tiresome to enter the block comment lines manually. There
2380 are several possible shortcuts you can use to enter them:
2382 1) Built-in expansion
2384 - Org mode has a "secret" method of expanding source code blocks
2387 - If you type "<s" followed by =TAB= or =M-TAB=, a source block will
2390 - For a full list of expansions, type =M-x describe-variable
2391 [RET] org-structure-template-alist=.
2393 2) [[http://orgmode.org/manual/Literal-examples.html#Literal-examples][Registers]]
2395 - Add the following line to your emacs file:
2397 =(set-register ?p "#+begin_src\n\n#+end_src perl")=
2399 - Then type =C-x r i p= to insert the source block. Please note: if
2400 you save another value to the register "p" with =C-x r s p=, it
2401 will overwrite the setting above for the current emacs session.
2403 3) [[http://orgmode.org/manual/Literal-examples.html#Literal-examples][Abbrevs]]
2405 - Activate the abbrev minor-mode in org-mode:
2411 + =(add-hook 'org-mode-hook (lambda () (abbrev-mode 1)))=
2413 - In org-mode, type "sbp" (a sample abbreviation for a perl source
2416 - Immediately after "sbp" type =C-x a i l=.
2418 - Enter the expansion:
2420 - =#+begin_src perl[C-q C-j][C-q C-j]#+end_src=
2422 - Note: =C-q C-j= creates a new line in the minibuffer
2424 - Now, whenever, you type sbp followed by =SPACE= or =RET= in an
2425 org-mode buffer, the src block will magically appear.
2427 - To review your list of abbrevs, type =M-x edit-abbrevs=.
2429 4) [[http://www.slashgear.com/nokia-n900-android-dual-boot-hack-video-2371099/][Skeletons]]
2431 - Skeletons offer a simple way of automatically entering text.
2432 Here's a skeleton that queries for the type of block and wraps
2433 the active region inside it:
2436 (define-skeleton skel-org-block
2437 "Insert an org block, querying for type."
2444 - Simply type skel-org-block to insert the block.
2446 - You can bind this to a key.
2448 - You can also create an abbrev that invokes this function:
2450 : (define-abbrev org-mode-abbrev-table "blk" "" 'skel-org-block)
2452 5) [[http://code.google.com/p/yasnippet/][Yasnippet]]
2454 - Several org-mode users install yasnippet for convenient, complex
2457 - See Bernt Hansen's [[http://doc.norang.ca/org-mode.html#Yasnippets][org-mode setup]] for a good introduction to
2460 * Capture and remember
2462 :CUSTOM_ID: Remember
2464 ** Can I use a variable or a function inside the `org-capture-templates' variable?
2466 :CUSTOM_ID: variable-inside-capture-templates
2469 Yes. Use [[http://www.gnu.org/s/emacs/manual/html_node/elisp/Backquote.html][backquotes]].
2471 E.g. if you have a variable called =org-test-file= and you want the
2472 variable =org-capture-templates= to "understand" (i.e. evaluate)
2473 =org-test-file= when Emacs evaluates the =(setq org-capture-templates
2474 [...])= expression, use backquotes like this:
2476 #+begin_src emacs-lisp
2477 (setq org-capture-templates
2478 `(("t" "Todo" entry (file+headline ,org-test-file "Tasks")
2479 "* TODO %?\n %i\n %a")
2480 ("b" "Buy" item (file+olp ,org-test-file "Stuff to Buy" "House")
2484 ** Can I use the remember buffer to clock a customer phone call?
2486 :CUSTOM_ID: use-remember-buffer-to-clock-phone-call
2489 Yes, you can. Take a look at the [[http://thread.gmane.org/gmane.emacs.orgmode/5482][setup described by Bernt Hansen]]
2490 and check out (in the same thread) what Nick Docos had to fix to
2491 make Bernt's set-up work for him.
2492 ** Can I automatically start the clock when opening a remember template?
2494 :CUSTOM_ID: start-clock-when-opening-remember-template
2497 Yes, this is possible. Use the following code and make sure that
2498 after executing it, `my-start-clock-if-needed' is in
2499 `remember-mode-hook' /after/ `org-remember-apply-template'.
2501 : (add-hook 'remember-mode-hook 'my-start-clock-if-needed 'append)
2502 : (defun my-start-clock-if-needed ()
2504 : (goto-char (point-min))
2505 : (when (re-search-forward " *CLOCK-IN *" nil t)
2506 : (replace-match "")
2509 Then, when a template contains the key string CLOCK-IN, the clock
2510 will be started. Starting with Org-mode version 5.20, the clock will
2511 automatically be stopped when storing the remember buffer.
2515 :CUSTOM_ID: Searches
2517 ** Isearch does not find string hidden in links. What can I do?
2519 :CUSTOM_ID: isearch-in-links
2522 M-x =visible-mode= will display the full link, making them searchable.
2524 ** How can I reduce the amount of context shown in sparse trees?
2526 :CUSTOM_ID: context-in-sparse-trees
2529 Take a look at the following variables:
2531 - =org-show-hierarchy-above=
2532 - =org-show-following-headline=
2533 - =org-show-siblings=
2534 - =org-show-entry-blow=
2536 which give command-dependent control over how much context is shown
2537 by a particular operation.
2539 ** How can I combine the results of two calls to =org-occur=?
2541 :CUSTOM_ID: two-calls-to-org-occur
2544 You can construct a regular expression that matches all targets you
2545 want. Alternatively, use a =C-u= prefix with the second and any
2546 further calls to =org-occur= to keep the current visibility and
2547 highlighting in addition to the new ones.
2553 ** How can I change the advanced warning time for deadlines?
2555 :CUSTOM_ID: warning-period-for-deadlines
2557 ##<<warning-period-for-deadlines>>
2559 Deadline warnings appear in the daily agenda view a specified number
2560 of days before the deadline is due. The default setting is 14 days.
2561 You can change this with the variable =org-deadline-warning-days=.
2562 (See [[http://orgmode.org/manual/Deadlines-and-scheduling.html#Deadlines-and-scheduling][this section]] of the manual.)
2566 : (setq org-deadline-warning-days 30)
2568 would cause warnings for each deadline to appear 30 days in advance.
2570 Naturally, you might not want warnings for all of your deadlines to
2571 appear so far in advance. Thus, you can change the lead time for
2572 individual items as follows:
2574 : * TODO Get a gift for the party
2575 : DEADLINE: <2009-01-16 Fri -2d>
2577 The "-2d" above changes the lead time for this deadline warning to two
2578 days in advance. You can also use "w" for weeks and "m" for months.
2579 ** How can I postpone a task until a certain date?
2581 :CUSTOM_ID: deferring-tasks
2584 The easiest way to postpone a task is to schedule it in the future.
2585 For instance, typing =C-c C-s +2w= on a headline will push a task two
2586 weeks into the future, so that it won't show up on the daily agenda
2587 until two weeks from now.
2589 If you'd like to prevent the task from showing up on your global todo
2590 list, you have a couple of options.
2592 1. You can set the variable =org-agenda-todo-ignore-scheduled= to =t=.
2593 This will exclude any scheduled items from your global list of
2594 active todos (=C-c a t=). (The variable
2595 =org-agenda-todo-ignore-with-date= will exclude both scheduled and
2596 deadline items from your todo list).
2597 2. You can remove the todo keyword from the item (C-c C-t <SPC>). The
2598 item will still appear on your agenda two weeks from today, but it
2599 won't show up on your todo lists.
2600 ** Can I send myself an email containing tasks or other agenda info?
2602 :CUSTOM_ID: email-containing-tasks-or-other-agenda-info
2605 Yes. See [[http://article.gmane.org/gmane.emacs.orgmode/6112][this thread]] on the list.
2607 ** How can I limit the agenda view to my "work" tasks?
2609 :CUSTOM_ID: limit-agenda-with-tag-filtering
2612 It is often convenient to group org files into separate categories,
2613 such as "home" and "work" (or "personal" and "professional"). One
2614 of the main reasons for such classification is to create agenda
2615 views that are limited by type of work or area of responsibility.
2616 For instance, while at work, one may want to see only professional
2617 tasks; while away from work, one may want to see only personal
2620 One way to categorize files and tasks is to use a "#+FILETAGS"
2621 declaration at the top of each file, such as:
2625 As long as org-use-tag-inheritance is turned on, the filetags will
2626 be inherited by all tasks in the file. A file can have multiple
2627 filetags. And, of course, tags can be added to individual headings.
2629 Tasks can be quickly filtered by tag from within the agenda by
2630 typing "/" and the name of the tag. The full key sequence to filter
2631 for work items in an agenda view would be:
2633 : C-c a a / work [or a tag shortcut]
2635 ** How can I limit the agenda view to a particular category?
2637 :CUSTOM_ID: limit-agenda-with-category-match
2640 Another way to filter agenda views by type of work is to use a
2641 "#+CATEGORY" declaration at the top of each file, such as:
2645 Categories can also be added to individual headings within a file:
2652 All todos belonging to the category "work" can be found a with a
2653 simple tags-todo search:
2657 At the prompt, type:
2661 The same results can be achieved with custom agenda commands, such as:
2663 #+BEGIN_SRC emacs-lisp
2664 (setq org-agenda-custom-commands
2665 '(("h" tags-todo "CATEGORY=\"home\"")
2666 ("w" tags-todo "CATEGORY=\"work\"")
2667 ;; other custom agenda commands here
2671 ** How can include all org files in a directory in my agenda?
2673 :CUSTOM_ID: set-agenda-files-using-wildcards
2676 You can simply include the directory (as one of the items) in the
2677 value of the variable org-agenda-files:
2679 : (setq org-agenda-files '("/my/special/path/org/"))
2681 There is another way of accomplishing the same end:
2683 : (setq org-agenda-files (file-expand-wildcards "/my/special/path/org/*.org"))
2685 ** Why aren't items disappearing from my agenda once they are marked done?
2687 :CUSTOM_ID: removing-done-items-from-agenda
2690 If items remain on your daily/weekly agenda after they are marked
2691 done, check the configuration of the following variables:
2693 : org-agenda-skip-scheduled-if-done
2694 : org-agenda-skip-deadline-if-done
2695 : org-agenda-skip-timestamp-if-done
2699 : M-x customize-variable RET org-agenda-skip-scheduled-if-done
2701 If this variable is turned off (=nil=), then scheduled items will
2702 remain on the agenda even after they are marked done.
2704 If the variable is turned on (=t=), then scheduled items will
2705 disappear from the agenda after they are marked done.
2707 If these settings seem not to behave the way you expect, then make
2708 sure you understand [[scheduled-vs-deadline-vs-timestamp][the
2709 difference between SCHEDULED, DEADLINE, and timestamps]].
2711 ** How do I keep repeating timestamps from being displayed multiple times?
2713 :CUSTOM_ID: repeating-timestamps-show-once
2716 To show only the /current/ instance of a repeating timestamp, put the
2717 following in your .emacs:
2719 #+begin_src emacs-lisp
2720 (setq org-agenda-repeating-timestamp-show-all nil)
2723 ** What is the difference between SCHEDULED, DEADLINE, and plain timestamps?
2725 :CUSTOM_ID: scheduled-vs-deadline-vs-timestamp
2728 1. SCHEDULED items (set with =C-c C-s=) will appear on your agenda on
2729 the day they are scheduled and on every day thereafter until they
2730 are done. Schedule a task if you want to be reminded to do
2731 something beginning on a certain day and until it is done.
2733 : ** TODO Scheduled item
2734 : SCHEDULED: <2009-03-01 Sun>
2736 2. Items with a DEADLINE timestamp (set with =C-c C-d=) appear on your
2737 agenda in advance of the when they are due and remain on your
2738 agenda until they are done. Add a DEADLINE to an item if you want
2739 to make sure to complete it by a certain date. (The variable
2740 org-deadline-warning-days determines how far in advance items with
2741 deadlines will show up in the agenda. See [[warning-period-for-deadlines][this FAQ]] for more
2744 : ** TODO Item with a deadline
2745 : DEADLINE: <2009-01-20 Tue>
2747 3. An active timestamp (set with =C-c .=) will appear on your agenda
2748 only on the day it is scheduled. Use a timestamp for appointments
2749 or any reminders you want to show up only on a particular day.
2751 : ** TODO Item with an active timestamp
2754 Note: items with inactive timestamps (set with C-c ! and marked by
2755 square brackets) will not show up in the agenda at all.
2757 ** Can I add files recursively to my list of agenda files?
2759 :CUSTOM_ID: set-agenda-files-recursively
2762 Yes, you can use the library "find-lisp."
2764 : (load-library "find-lisp")
2765 : (setq org-agenda-files (find-lisp-find-files "~/org" "\.org$"))
2767 This will add all files ending in =org= in the directory "~/org"
2768 and all of its subdirectories to your list of agenda files.
2770 If on a *nix machine, you can also use the find utility, which can be
2771 faster than the find-lisp library:
2773 : (setq org-agenda-files
2774 : (mapcar 'abbreviate-file-name
2776 : (shell-command-to-string "find ~/org -name \"*.org\"") "\n")))
2779 See [[http://thread.gmane.org/gmane.emacs.orgmode/8992][this thread]] on the mailing list for more information.
2781 ** Why does an item appearing at the wrong time of day in my agenda?
2783 :CUSTOM_ID: agenda-wrong-time-of-day
2786 When preparing the agenda view, org-mode scans each relevant headline
2787 for a time designation. This approach is very nice for adding
2788 free-form timestamps to an item for scheduling. Thus, either of the
2789 following work would work to schedule an item at 10:00am:
2792 ,** 10:00am Get dried ice at the magic store
2793 , SCHEDULED: <2009-05-27 Wed>
2797 ,** Get dried ice at the magic store
2798 , SCHEDULED: <2009-05-27 Wed 10:00>
2801 To enable this flexibility, org-mode scans the entire headline for
2802 time of day notation. A potential problem can arise if you use
2803 inactive timestamps in the headline to note when an item was created.
2807 ,** Get dried ice at the magic store [2009-05-26 Tue 12:58]
2808 , SCHEDULED: <2009-05-27 Wed>
2811 Org mode would interpret the time in the inactive timestamp as a
2812 time-of-day indicator and the entry would appear in your agenda at
2815 If you would like to turn off the time-of-day search, you can
2816 configure the variable =org-agenda-search-headline-for-time= (requires
2819 ** How can I change the visibility of an item from the agenda?
2821 :CUSTOM_ID: cycling-visibility-from-agenda
2824 You can add a keybinding as follows:
2826 #+begin_src emacs-lisp
2827 (add-hook 'org-agenda-mode-hook
2829 (define-key org-agenda-mode-map " " 'org-agenda-cycle-show)))
2832 Then, as you press SPACE on an item on the agenda, it will cycle the
2833 visibility of its original location.
2835 ** Is there any way to set org-mode so that tags don't appear in the agenda view?
2837 See the =org-agenda-remove-tags= variable.
2839 ** I work late at night! How can I extend my current day past midnight?
2841 :CUSTOM_ID: org-extend-today-until
2844 If you work past midnight, you may not want your daily agenda view to
2845 switch to the next day at 12 a.m. (the default). To extend your day,
2846 simply set the value of org-extend-today-until to a positive number
2847 corresponding to the number of hours you work past midnight. For
2848 example, the following setting will cause the current day to extend
2851 : (setq org-extend-today-until 6)
2853 * Appointments/Diary
2855 :CUSTOM_ID: Appointments/Diary
2857 ** Is it possible to include entries from org-mode files into my emacs diary?
2859 :CUSTOM_ID: include-entries-from-org-mode-files-into-emacs-diary
2862 Since the org-mode agenda is much more powerful and can contain the
2863 diary, you should think twice before deciding to do this. If you
2864 insist, however, integrating Org-mode information into the diary is
2865 possible. You need to turn on /fancy diary display/ by setting in
2868 : (add-hook 'diary-display-hook 'diary-fancy-display)
2870 Then include the following line into your ~/diary file, in
2871 order to get the entries from all files listed in the variable
2876 You may also select specific files with
2878 : &%%(org-diary) ~/path/to/some/org-file.org
2879 : &%%(org-diary) ~/path/to/another/org-file.org
2881 If you now launch the calendar and press ~d~ to display a
2882 diary, the headlines of entries containing a timestamp, date range,
2883 schedule, or deadline referring to the selected date will be listed.
2884 Just like Org-mode's agenda view, the diary for /today/ contains
2885 additional entries for overdue deadlines and scheduled items. See
2886 also the documentation of the =org-diary= function. Under XEmacs, it
2887 is not possible to jump back from the diary to the org, this works
2888 only in the agenda buffer.
2889 ** I want to add my Org scheduled/deadlined entries in my diary!
2891 :CUSTOM_ID: add-Org-scheduled/deadlined-entries-to-diary!
2894 Put this in your ~/.diary:
2896 : &%%(org-diary :scheduled :timestamp :deadline)
2898 ** How can I set up automatic reminders based on Org information?
2900 :CUSTOM_ID: automatic-reminders
2903 See [[http://article.gmane.org/gmane.emacs.orgmode/5271][this post]] by N. Dokos on the list. See also Russell Adams's hack in [[file:org-hacks.org::#agenda-appt-zenity][org-hacks]].
2904 ** How can I make =appt= notice my Org appointments?
2906 :CUSTOM_ID: appt-notice-my-Org-appointments
2909 : M-x org-agenda-to-appt RET
2911 ** How can I create more complex appointments in my org-files?
2913 :CUSTOM_ID: diary-sexp-in-org-files
2916 Org-mode's active timestamps work very well for scheduling individual
2917 or recurring appointments, such as:
2920 ,* 8:00am Dentist appointment <2009-01-16 Fri>
2926 , <2009-03-20 Fri>--<2009-04-01 Wed>
2932 ,* Weekly meeting with boss
2933 , <2009-01-20 Tue 14:00 +1w>
2936 Sometimes, however, you need to set up more complicated recurring
2937 appointments. Org-mode has built-in support for many of
2938 [[http://www.gnu.org/software/emacs/manual/html_node/emacs/Sexp-Diary-Entries.html][the
2939 powerful sexp entries]] that work in [[http://www.gnu.org/software/emacs/manual/html_node/emacs/Diary.html#Diary][Emacs diary]]. Let's say, for
2940 instance, that you teach a class that meets every Monday evening
2941 between February 16 and April 20, 2009. The way to enter this an
2945 ,** Class 7:00pm-9:00pm
2946 , <%%(and (= 1 (calendar-day-of-week date)) (diary-block 2 16 2009 4 20 2009))>
2949 The expression above designates all Mondays that fall between February
2950 16 and April 20. How exactly does it work?
2952 - (and... :: Indicates that *both* of the conditions that follow have
2955 - (= 1 (calendar-day-of-week date)) :: Is the day of the week a
2958 - Note: the function calendar-day-of-week converts the date to the day of week
2959 expressed in numeric form, where 0 = Sunday, 1 = Monday, and so on.
2961 - (diary-block 2 16 2009 4 20 2009) :: Does the date fall between
2964 You can make a sexp as complex as you like. If you wanted to omit a
2965 week because of holidays, for instance, you could add another
2966 condition to the sexp:
2969 ,** Class 7:00pm-9:00pm
2970 , <%%(unless (diary-block 3 9 2009 3 13 2009) (and (= 1 (calendar-day-of-week date)) (diary-block 2 16 2009 4 20 2009)))>
2973 The sexp above would omit Monday during the week of March 9, 2009. For
2974 another way to accomplish the same thing, see [[org-diary-class][this FAQ]].
2976 Another diary function commonly used for more complex scheduling is
2977 diary-float. For instance,
2981 , <%%(diary-float t 3 3)>
2984 ...would appear on the third Wednesday of every month.
2986 For more ideas on how to create diary special expressions, see [[http://www.emacswiki.org/cgi-bin/wiki/DiaryMode][this
2987 page on the Emacs wiki]].
2989 ** How can I schedule a weekly class that lasts for a limited period of time?
2991 :CUSTOM_ID: org-class
2994 Org-mode offers a convenient diary sexp function for setting up a
2995 recurring appointment that lasts for a certain period of time, such as
2996 a class. It is called org-class and it can be entered as
3000 ,** Class 7:00pm-9:00pm
3001 , <%%(org-class 2009 2 16 2009 4 20 1 10)>
3004 The function above schedules an appointment for every Monday (1)
3005 between February 16 and April 20, 2009, except for ISO week 10 (March
3008 If you would prefer not to place the timestamp in the headline, you
3009 can use the following format:
3013 ,%%(org-class 2009 2 16 2009 4 20 1 10) 7:00pm-9:00pm Class
3017 In this case, the string following the sexp will be displayed in the
3020 The function org-class has the following format:
3022 : (org-class Y1 M1 D1 Y2 M2 D2 DAYNAME &rest SKIP-WEEKS)
3024 Y1/2, M1/2, and D1/2 indicate the beginning and ending dates. DAYNAME
3025 takes the form of a number indicating the day of the week (0 = Sunday,
3026 1 = Monday, and so on...). In addition, one can add an optional
3027 argument SKIP-WEEKS to indicate weeks on the calendar that should be
3028 skipped. This argument should be expressed as an ISO week number. You
3029 can find the number by invoking emacs' built-in calendar (=M-x
3030 calendar=), navigating to the appropriate week, and typing =p c
3031 (calendar-iso-print-date)=.
3033 Here is an alternative method, shared by Paul Sexton on the org
3036 Let's say you are taking night classes in Spanish. The class is every
3037 Wednesday evening at 7pm, starting on 18 August, and runs for 8 weeks.
3038 Org-mode's timestamps do not support limited occurrences of recurrent
3039 items -- you have to schedule the item with infinite recurrences, then
3040 delete it when it finishes.
3042 To schedule the Spanish classes, put the following in your =.emacs=:
3044 #+begin_src emacs-lisp
3045 (defun diary-limited-cyclic (recurrences interval m d y)
3046 "For use in emacs diary. Cyclic item with limited number of recurrences.
3047 Occurs every INTERVAL days, starting on YYYY-MM-DD, for a total of
3048 RECURRENCES occasions."
3049 (let ((startdate (calendar-absolute-from-gregorian (list m d y)))
3050 (today (calendar-absolute-from-gregorian date)))
3051 (and (not (minusp (- today startdate)))
3052 (zerop (% (- today startdate) interval))
3053 (< (floor (- today startdate) interval) recurrences))))
3055 The item in the org file looks like this:
3058 ,** 19:00-21:00 Spanish lessons
3059 , <%%(diary-limited-cyclic 8 7 8 18 2010)>
3062 ** How can I set an event to occur every day except Saturday and Sunday?
3066 , <%%(memq (calendar-day-of-week date) '(1 2 3 4 5))>
3069 ** How do I schedule events relative to Easter Sunday?
3071 Easter's date moves around from year to year according to a
3072 complicated set of criteria which I do not claim to understand.
3073 However the following code will allow you to schedule recurring
3074 events relative to Easter Sunday.
3076 Note: the function da-easter is from:
3077 http://github.com/soren/elisp/blob/master/da-kalender.el
3079 Put the following in your .emacs:
3081 #+begin_src emacs-lisp
3082 (defun da-easter (year)
3083 "Calculate the date for Easter Sunday in YEAR. Returns the date in the
3084 Gregorian calendar, ie (MM DD YY) format."
3085 (let* ((century (1+ (/ year 100)))
3086 (shifted-epact (% (+ 14 (* 11 (% year 19))
3087 (- (/ (* 3 century) 4))
3088 (/ (+ 5 (* 8 century)) 25)
3091 (adjusted-epact (if (or (= shifted-epact 0)
3092 (and (= shifted-epact 1)
3093 (< 10 (% year 19))))
3096 (paschal-moon (- (calendar-absolute-from-gregorian
3099 (calendar-dayname-on-or-before 0 (+ paschal-moon 7))))
3102 (defun da-easter-gregorian (year)
3103 (calendar-gregorian-from-absolute (da-easter year)))
3105 (defun calendar-days-from-easter ()
3106 "When used in a diary sexp, this function will calculate how many days
3107 are between the current date (DATE) and Easter Sunday."
3108 (- (calendar-absolute-from-gregorian date)
3109 (da-easter (calendar-extract-year date))))
3112 Now we can schedule the public holidays associated with Easter as
3113 recurring events. Good Friday is 2 days before "Easter", Easter
3114 Monday is one day after.
3118 , <%%(= -2 (calendar-days-from-easter))>
3121 , <%%(= 0 (calendar-days-from-easter))>
3124 , <%%(= 1 (calendar-days-from-easter))>
3126 [Source: Posted by Paul Sexton on Org-mode mailing list.]
3128 ** How to schedule public holiday that is "the nearest Monday to DATE"?
3130 In New Zealand each regional capital has an "Anniversary Day". The
3131 date of Auckland's anniversary day is "the nearest Monday to 29
3134 Put this in your =.emacs=:
3136 #+begin_src emacs-lisp
3137 (defun calendar-nearest-to (target-dayname target-day target-month)
3138 "Recurring event that occurs in the nearest TARGET-DAYNAME to
3139 the date TARGET-DAY, TARGET-MONTH each year."
3141 (let* ((dayname (calendar-day-of-week date))
3142 (target-date (list target-month target-day (calendar-extract-year date)))
3143 (days-diff (abs (- (calendar-day-number date)
3144 (calendar-day-number target-date)))))
3145 (and (= dayname target-dayname)
3149 Now we can schedule Auckland Anniversary Day. The first argument,
3150 1, means Monday (days of the week are numbered starting with
3153 [Source: Originally posted by Paul Sexton on Org-mode mailing list.]
3155 ** How to schedule public holiday on "the 4th Monday in October"?
3157 This does not require any additions to =.emacs=:
3161 , <%%(diary-float 10 1 4)>
3164 ** Why isn't the agenda showing all the times I put under a single entry?
3166 :CATEGORY: multiple-timestamps-same-entry
3169 Probably because you have not set the following variable:
3171 : org-agenda-skip-additional-timestamps-same-entry
3173 The default value of this variable is t, which means that entries with
3174 multiple timestamps, such as the following...
3177 ,* Work really, really hard
3178 , <2010-11-20 Sat 10:00>
3179 , <2010-11-20 Sat 14:00>
3182 ...will only appear in the agenda at the time specified by the first
3183 timestamp. If you set org-agenda-skip-additional-timestamps-same-entry
3184 to nil, the item will appear will appear at all the times you specify.
3186 ** Can I import iCal events/appts from Gnus?
3188 Yes. Vagn Johansen wrote [[http://ozymandias.dk/emacs/org-import-calendar.el][org-import-calendar.el]] which lets you do this.
3194 ** Can I get TODO items exported to HTML as lists, rather than as headlines?
3196 :CUSTOM_ID: export-TODO-items-as-lists
3199 If you plan to use ASCII or HTML export, make sure things you want to
3200 be exported as item lists are level 4 at least, even if that does
3201 mean there is a level jump. For example:
3203 : * Todays top priorities
3204 : **** TODO write a letter to xyz
3205 : **** TODO Finish the paper
3206 : **** Pick up kids at the school
3208 Alternatively, if you need a specific value for the heading/item
3209 transition in a particular file, use the =#+OPTIONS= line to
3210 configure the H switch.
3212 : #+OPTIONS: H:2; ...
3214 ** Can I export only a single subtree?
3216 :CUSTOM_ID: export-single-subtree
3219 If you want to export a subtree, mark the subtree as region and then
3220 export. Marking can be done with =C-c @ C-x C-x=, for example.
3222 Alternatively, you can select option =1= in the org export dispatcher
3223 (e.g.., =C-c C-e 1 h= to export the current subtree to html).
3225 By default, the title of the exported file will be set to the heading
3226 of the subtree. You can, however, [[#export-options-for-subtree][customize the title and other export
3229 ** How can I customize export options for a single subtree?
3231 :CUSTOM_ID: export-options-for-subtree
3234 You can set unique export options for a [[#export-single-subtree][single subtree]] by using
3235 properties. Relevant properties include:
3241 - EXPORT_OPTIONS (corresponds to the =#+OPTIONS:= [[http://orgmode.org/manual/Export-options.html#Export-options][configuration line]])
3243 ** How can I tell my calendar web application about appointments in my agenda files?
3245 Here is what you need to do:
3247 1. a script that calls Emacs in batch mode and produce a .ics file
3248 2. a script that uploads this .ics file somewhere on the web
3249 3. tell your webapp to fetch this .ics file on the web
3251 Here is the script I use for the first step:
3253 #+begin_src shell-script-mode
3256 /usr/local/bin/emacs --batch --eval \
3257 "(progn (load-file \"~/install/git/org-mode/org.el\") \
3258 (load-file \"~/elisp/config/org-batch-config.el\") \
3259 (setq org-combined-agenda-icalendar-file \"~/org/cal/org.ics\")
3260 (setq org-agenda-files (quote (\"~/org/bzg.org\"))))" \
3261 -f org-export-icalendar-combine-agenda-files
3264 Depending on your configuration, you might change the load sequence.
3266 Here is the script I use for the second step:
3268 #+begin_src shell-script-mode
3270 /usr/bin/rsync -rtv ~/org/org.ics -e ssh me@my_server:/home/me/public_html/
3273 Note: if you want to cron this rsync script, you will need to let
3274 =my_server= to know about your SSH public key. Check [[http://troy.jdmz.net/rsync/index.html][this page]] as a
3277 Now you can cron the two scripts above and your webapp will always be
3278 up to date with your Org agendas.
3280 Also see [[http://orgmode.org/org.html#Exporting-Agenda-Views][Exporting agenda views]] from Org manual.
3282 ** How can I get Mac OSX 10.3 iCal to import my Org-exported .ics files?
3284 :CUSTOM_ID: iCal-import-ics-files-old
3287 When using iCal under Apple MacOS X Tiger, you can create a new
3288 calendar /OrgMode/ (the default name for the calendar created by =C-c
3289 C-e c=, see the variables =org-icalendar-combined-name= and
3290 =org-combined-agenda-icalendar-file=). Then set Org-mode to
3291 overwrite the corresponding file /~/Library/Calendars/OrgMode.ics/.
3292 You may even use AppleScript to make iCal re-read the calendar files
3293 each time a new version of /OrgMode.ics/ is produced. Here is the
3294 setup needed for this:
3296 : (setq org-combined-agenda-icalendar-file
3297 : "~/Library/Calendars/OrgMode.ics")
3298 : (add-hook 'org-after-save-iCalendar-file-hook
3301 : "osascript -e 'tell application \"iCal\" to reload calendars'")))
3303 ** How can I get Mac OSX 10.4 or later iCal to import my Org-exported .ics files?
3305 :CUSTOM_ID: iCal-import-ics-files-new
3308 For Mac OS X 10.4, you need to write the ics file to
3309 =/Library/WebServer/Documents/= and then subscribe iCalendar to
3310 =http: //localhost/orgmode.ics=
3312 ** How can I remove timestamps and todo keywords from my exported file?
3314 :CUSTOM_ID: export-options-remove-timestamps
3317 You can place an options line at the top of your org file:
3319 : #+OPTIONS: <:nil todo:nil
3321 There is a whole host of export options you can set with an in-buffer
3322 options or via global variables. See [[http://orgmode.org/manual/Export-options.html#Export-options][this section]] of the manual for a
3325 ** How can I preserve faces when I export an agenda from the command line?
3327 :CUSTOM_ID: preserving-faces-during-batch-export
3330 Normally, when you export an org file or an agenda view from within
3331 emacs, htmlize will convert your face definitions to direct color css
3332 styles inlined into each =<span>= object, resulting in an HTML output
3333 that preserves the general look of your Org buffers and agenda views.
3335 Let's say you generate an export from the command line, such as the
3338 : emacs -batch -l ~/.emacs -eval '(org-batch-agenda "e")'
3342 : emacs -batch -l ~/.emacs -eval '(org-publish-all)'
3344 In such an instance, the exported HTML will contain only very basic
3345 color styles. The reason is that when Emacs is run in batch mode, it
3346 does not have a display and therefore only rudimentary face
3347 definitions. If you'd like to use more complex styles, you'll have to
3348 make sure that the export process only assigns classes instead of
3349 direct color values. This can be done by binding the variable
3350 =org-export-htmlize-output-style= to =css= for the duration of the
3351 export, for example with
3353 : emacs -batch -l ~/.emacs
3354 : -eval '(let ((org-export-htmlize-generate-css (quote css)))
3355 : (org-batch-agenda "e"))'
3357 Then you can use a style file to make these classes look any way you
3358 like. To generate face definitions for a CSS file based on any faces
3359 you are currently using in Emacs, you can use the following command:
3361 : M-x org-export-htmlize-generate-css RET
3363 This will generate a =<style>...</style>= section, the content of
3364 which you can add to your style file.
3366 ** How can I avoid dark color background when exporting agenda to ps format?
3368 :CUSTOM_ID: avoiding-dark-background-when-exporting-agenda
3371 Add this to your .emacs and evaluate it.
3373 #+BEGIN_SRC emacs-lisp
3374 (setq org-agenda-exporter-settings
3375 '((ps-print-color-p 'black-white)))
3378 ** How can I include e.g. an abstract in export to Latex and HTML?
3380 :CUSTOM_ID: include-abstract-in-export-to-latex-and-html
3383 Org does not currently have special markup for abstracts, but for
3384 export purposes, you can extend the block-level structural and
3385 semantic markup in Org with the contributed package [[file:org-contrib/org-special-blocks.org][org-special-blocks]]
3386 (by Chris Gray). To turn it on, put this in your =.emacs=:
3388 : (require 'org-special-blocks)
3390 Now, you can mark up the abstract of your article like this:
3393 : Falling apples were observed and compared with pears. Newton's laws
3394 : were confirmed at the 95% confidence level.
3397 Exporting to Latex wraps this in a
3398 =\begin{abstract}....\end{abstract}= environment, which just works.
3400 HTML export wraps it in a ~<div class="abstract">...</div>~
3401 element. The HTML result won't look like anything special until you
3402 style it. Here is some sample CSS to get you started; put these in
3403 your document header:
3405 : #+STYLE: <style>.abstract {margin: 1em; padding: 1em; border: 1px solid black}
3406 : #+STYLE: .abstract:before {content: "Abstract: "; font-weight: bold}</style>
3408 Generally, =#+begin_foo= will work for any simple Latex =foo=
3409 environment not supported by existing Org markup.
3411 If you need to pass parameters, process the block content in some way,
3412 or support other exporters, you may want to consider whether you can
3413 customize it using Eric Schulte's [[file:org-contrib/org-exp-blocks.org][org-exp-blocks]] instead.
3415 ** How can I get colored source code when exporting to LaTeX?
3417 :CUSTOM_ID: fontified_source_code_w_latex
3420 As of Sun Aug 9 2009 the "current" version of Org-mode (see
3421 [[keeping-current-with-Org-mode-development]]) supports exporting
3422 source code to LaTeX using the listings package.
3424 To turn on listing export add the following to your Org-mode
3426 #+begin_src emacs-lisp
3427 ;; requite org-latex so that the following variables are defined
3428 (require 'org-latex)
3430 ;; tell org to use listings
3431 (setq org-export-latex-listings t)
3433 ;; you must include the listings package
3434 (add-to-list 'org-export-latex-packages-alist '("" "listings"))
3436 ;; if you want colored source code then you need to include the color package
3437 (add-to-list 'org-export-latex-packages-alist '("" "color"))
3440 The listings package will now be used to fontify source code in your
3441 LaTeX documents. By default listings will not color any of your
3442 source code. If you would like to set colors for keywords and
3443 comments in your latex documents you can do so using LaTeX directives
3446 \lstset{keywordstyle=\color{blue},
3447 commentstyle=\color{red},
3448 stringstyle=\color{green}
3452 of if you want to get even fancier with your colors you can try
3453 something like the following
3455 \definecolor{keywords}{RGB}{255,0,90}
3456 \definecolor{comments}{RGB}{60,179,113}
3457 \definecolor{fore}{RGB}{249,242,215}
3458 \definecolor{back}{RGB}{51,51,51}
3460 basicstyle=\color{fore},
3461 keywordstyle=\color{keywords},
3462 commentstyle=\color{comments},
3463 backgroundcolor=\color{back}
3467 For more complex listings use cases consult the [[ftp://ftp.tex.ac.uk/tex-archive/macros/latex/contrib/listings/listings.pdf][listings manual]].
3469 ** How can I export to Latex Beamer
3473 The latex [[http://latex-beamer.sourceforge.net/][Beamer Class]] is a useful class for generating slide shows.
3474 The following can be used to export Org-mode documents to LaTeX
3477 Add the following to your Emacs initialization file.
3478 #+begin_src emacs-lisp
3479 (unless (boundp 'org-export-latex-classes)
3480 (setq org-export-latex-classes nil))
3481 (add-to-list 'org-export-latex-classes
3483 "\\documentclass[11pt]{beamer}\n\\usepackage[utf8]{inputenc}\n\\usepackage[T1]{fontenc}\n\\usepackage{hyperref}\n\\usepackage{verbatim}\n"
3484 ("\\section{%s}" . "\\section*{%s}")
3485 ("\\begin{frame}\\frametitle{%s}" "\\end{frame}"
3486 "\\begin{frame}\\frametitle{%s}" "\\end{frame}")))
3490 : #+LaTeX_CLASS: beamer
3491 in the header of your Org-mode document it will automatically export
3492 to the Beamer document class on LaTeX export. With the above
3493 configuration top-level headers will be mapped to sections in the
3494 Beamer document, second-level headers will be mapped to frames, and
3495 lower level headlines will be mapped to itemize objects.
3497 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
3498 Thomas Dye]]. For a much more complex Beamer setup see the [[http://article.gmane.org/gmane.emacs.orgmode/17767/match=beamer+dokos][email by
3501 ** How can I use RefTeX in Org-mode files for LaTeX export and in Org-babel LaTeX code blocks?
3503 :CUSTOM_ID: using-reftex-in-org-mode
3506 [[http://www.gnu.org/software/auctex/reftex.html][RefTeX]] is an indispensable tool for the author of LaTeX documents. It
3507 aids in creation of bibliographies, cross-references, indexes, and
3508 glossaries. RefTeX understands the structure of multi-file LaTeX
3509 documents and is able to collect from them information about the
3510 location(s) of external data stores used in creation of the final
3511 document. RefTeX was written by Carsten Dominik and is currently
3512 being maintained by the [[http://www.gnu.org/software/auctex/index.html][AucTeX]] project.
3514 *** Using RefTeX In Org-mode Files for LaTeX Export
3515 In Org-mode files for LaTeX export, the trick is to find a way to tell
3516 RefTeX the locations of external data stores. One way is to set the
3517 variable, =reftex-default-bibliography=. Add lines like these to
3520 #+begin_src emacs-lisp
3521 (setq reftex-default-bibliography
3523 ("default.bib" "other-default.bib")))
3526 In practice, this is a limited solution and the
3527 typical user will want to pass this information on a per-file basis.
3528 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
3531 The first solution, proposed by Mario, enables the RefTeX citation
3532 function in Org-mode. Add these lines to .emacs:
3534 #+begin_src emacs-lisp
3535 (defun org-mode-reftex-setup ()
3536 (load-library "reftex")
3537 (and (buffer-file-name)
3538 (file-exists-p (buffer-file-name))
3540 (define-key org-mode-map (kbd "C-c )") 'reftex-citation))
3541 (add-hook 'org-mode-hook 'org-mode-reftex-setup)
3544 Then add the following lines anywhere in the Org-mode file (Org-mode
3545 will recognize them as LaTeX commands):
3548 \bibliographystyle{plain}
3549 \bibliography{BIB-NAME}
3552 With this setup, =C-c )= will invoke =reftex-citation= which will
3553 insert a reference in the usual way:
3558 ,This is a citation \cite{tierney90}.
3560 ,\bibliographystyle{plain}
3564 This Org-mode file will export the following LaTeX output:
3566 #+begin_src latex :exports code
3567 % Created 2010-03-22 Mon 14:34
3568 \documentclass[11pt,letter]{article}
3569 \usepackage[utf8]{inputenc}
3570 \usepackage[T1]{fontenc}
3571 \usepackage{hyperref}
3575 \date{2010-03-22 Mon}
3581 \setcounter{tocdepth}{3}
3585 \section{test reftex}
3589 This is a citation \cite{tierney90}.
3591 \bibliographystyle{plain}
3598 A second solution, to activate the RefTeX minor mode on a per-file
3599 basis, was posted by Kevin Brubeck Unhammer in response to this idea.
3600 Add the following lines to .emacs:
3602 #+begin_src emacs-lisp
3603 (add-hook ‘org-mode-hook
3605 (if (member “WRITE” org-todo-keywords-1)
3606 (org-mode-article-modes))))
3609 where =org-mode-article-modes= is defined as follows:
3611 #+begin_src emacs-lisp
3612 (defun org-mode-article-modes ()
3614 (bib-cite-minor-mode t)
3615 (and (buffer-file-name)
3616 (file-exists-p (buffer-file-name))
3617 (reftex-parse-all)))
3620 Add the =\bibliographystyle{}= and =\bibliography{}= lines to the
3621 Org-mode file as before and define a TODO keyword, =WRITE=, perhaps
3625 ,#+TODO: TODO(t) STARTED(s) WRITE | DONE(d) DEFERRED(f)
3628 With this setup, you insert a citation with =M-x reftex-citation RET=.
3630 *** Using RefTeX in Org-babel LaTeX Code Blocks
3632 In Org-babel LaTeX code blocks, the trick is to give RefTeX access to
3633 information in other Org-babel LaTeX code blocks. If you use an Emacs
3634 starter kit where configuration information is held in Org-mode files,
3635 then the second solution is preferable because you won't be asked for
3636 a master file when Emacs is started. For this reason, the second
3637 solution is modified for use with Org-babel latex code blocks. No
3638 key-binding is needed here because Org-babel code blocks are edited
3639 within the usual AucTeX environment.
3641 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]])
3642 #+begin_src emacs-lisp
3643 (defun org-mode-article-modes ()
3645 (and (buffer-file-name)
3646 (file-exists-p (buffer-file-name))
3647 (reftex-parse-all)))
3649 (add-hook 'org-mode-hook
3651 (if (member "REFTEX" org-todo-keywords-1)
3652 (org-mode-article-modes))))
3655 Then add a line like the following line to the top of your org-mode file:
3658 ,#+TODO: TODO(t) STARTED(s) | DONE(d) DEFERRED(f) REFTEX
3661 When you open an org-mode file with a line like this, RefTeX will
3662 prompt for the master .tex file, which will be parsed in the usual
3663 way. This means that the .tex file should already exist, perhaps by
3664 tangling the LaTeX preamble and postamble, before
3665 =org-mode-article-modes= is activated for the Org-mode file.
3667 ** How can I use XeLaTeX for LaTeX export instead of pdfLaTeX?
3669 :CUSTOM_ID: using-xelatex-for-pdf-export
3671 [[http://en.wikipedia.org/wiki/XeTeX][ XeLaTeX]] is an alternative to pdfLaTeX for typesetting LaTeX
3672 documents. XeTeX can use any fonts installed in the operating system
3673 without configuring TeX font metrics, and can make direct use of
3674 advanced typographic features of OpenType and other font formats. By
3675 default, org-mode exports =org= files to =pdf= via pdfLaTeX.
3677 Here is one way to smoothly incorporate XeLaTeX into org-mode's export
3678 process. This solution takes advantage of [[http://www.phys.psu.edu/~collins/software/latexmk-jcc][latexmk]], a perl script that
3679 intelligently and automatically manages latex compilation. It
3680 is included with TeXLive, but at present the version included is not
3681 quite up-to-date enough for our needs. Version 4.20 and higher
3682 includes an option allowing you to specify which program to use when
3683 "pdflatex" is called. Install a current version of latexmk as per the
3684 instructions on the [[http://www.phys.psu.edu/~collins/software/latexmk-jcc][latexmk]] site. If necessary, disable the older
3685 version that comes with TeXLive. This is likely in =/usr/texbin/=, and
3686 you should rename or remove it. Then you can put the following in your
3687 =~/.emacs.d/= or equivalent:
3689 #+begin_src emacs-lisp
3690 (require 'org-latex)
3691 (setq org-export-latex-listings t)
3693 ;; Originally taken from Bruno Tavernier: http://thread.gmane.org/gmane.emacs.orgmode/31150/focus=31432
3694 ;; but adapted to use latexmk 4.20 or higher.
3695 (defun my-auto-tex-cmd ()
3696 "When exporting from .org with latex, automatically run latex,
3697 pdflatex, or xelatex as appropriate, using latexmk."
3699 ;; default command: oldstyle latex via dvi
3700 (setq texcmd "latexmk -dvi -pdfps -quiet %f")
3702 (if (string-match "LATEX_CMD: pdflatex" (buffer-string))
3703 (setq texcmd "latexmk -pdf -quiet %f"))
3705 (if (string-match "LATEX_CMD: xelatex" (buffer-string))
3706 (setq texcmd "latexmk -pdflatex=xelatex -pdf -quiet %f"))
3707 ;; LaTeX compilation command
3708 (setq org-latex-to-pdf-process (list texcmd)))
3710 (add-hook 'org-export-latex-after-initial-vars-hook 'my-auto-tex-cmd)
3713 ;; Specify default packages to be included in every tex file, whether pdflatex or xelatex
3714 (setq org-export-latex-packages-alist
3716 ("" "longtable" nil)
3719 (defun my-auto-tex-parameters ()
3720 "Automatically select the tex packages to include."
3721 ;; default packages for ordinary latex or pdflatex export
3722 (setq org-export-latex-default-packages-alist
3723 '(("AUTO" "inputenc" t)
3733 ("" "hyperref" nil)))
3735 ;; Packages to include when xelatex is used
3736 (if (string-match "LATEX_CMD: xelatex" (buffer-string))
3737 (setq org-export-latex-default-packages-alist
3742 ("american" "babel" t)
3743 ("babel" "csquotes" t)
3745 ("xetex" "hyperref" nil)
3748 (if (string-match "LATEX_CMD: xelatex" (buffer-string))
3749 (setq org-export-latex-classes
3751 "\\documentclass[11pt,article,oneside]{memoir}"
3752 ("\\section{%s}" . "\\section*{%s}")
3753 ("\\subsection{%s}" . "\\subsection*{%s}")
3754 ("\\subsubsection{%s}" . "\\subsubsection*{%s}")
3755 ("\\paragraph{%s}" . "\\paragraph*{%s}")
3756 ("\\subparagraph{%s}" . "\\subparagraph*{%s}"))
3757 org-export-latex-classes))))
3759 (add-hook 'org-export-latex-after-initial-vars-hook 'my-auto-tex-parameters)
3762 The =my-auto-tex-cmd= function looks at your =.org= file and checks
3763 whether you've specified which latex to use. If there are no
3764 instructions, it just runs regular old latex. If it finds the string
3765 =LATEX_CMD: pdflatex= in your file, it runs pdflatex. If it finds
3766 =LATEX_CMD: xelatex=, it runs xelatex. Because control is handed off
3767 to latexmk, nothing else is needed: it takes care of figuring things
3768 out so that the references and citations are correct.
3770 The second half of the code above specifies the latex packages that
3771 will be included in the =.tex= file. The variable
3772 =org-export-latex-packages-alist= specifies a list of packages that
3773 are always included in the header of latex documents, regardless of
3774 how they are compiled. The variable
3775 =org-export-latex-default-packages-alist= adds additional packages
3776 depending on whether latex/pdflatex or xelatex is being used. You can
3777 change the content of these as needed.
3779 Finally, the =org-export-latex-classes= variable redefines elements of
3780 the =.tex= file's preamble for the xelatex case. These can also be
3781 customized as needed.
3783 By way of example, an =.org= file you want compiled with xelatex might
3784 contain the following header:
3787 : #+AUTHOR: Jane Doe
3789 : #+OPTIONS: toc:nil num:nil
3790 : #+LATEX_CMD: xelatex
3791 : #+LATEX_HEADER: \setsansfont[Mapping=tex-text]{Unit-Bold}
3792 : #+LATEX_HEADER: \setmonofont[Mapping=tex-text,Scale=MatchLowercase]{PragmataPro}
3793 : #+LATEX_HEADER: \setromanfont[Mapping=tex-text,Numbers=OldStyle]{Minion Pro}
3795 If you always want to have the same font setup in your xelatex
3796 documents, the =fontspec= commands setting the font choices can be
3797 put in the =org-export-latex-classes= setting instead.
3799 The upshot is that when you want to export an =.org= file using
3800 XeLaTeX, you can now simply make sure the line =LATEX_CMD: xelatex= is
3801 in your =.org= file, then do =C-c C-e d= as usual, and org-mode, with
3802 latexmk in the background, does the rest for you.
3804 ** Why is my exported PDF file almost unreadable?
3806 :CUSTOM_ID: unreadable-pdfs
3809 Some PDF viewers (earlier versions (< v6) of Acrobat Reader, Evince,
3810 possibly others) do not get along with Adobe Type3 fonts, producing
3811 almost unreadable screen output (printed output is OK). If you see
3812 this, first verify the fonts that your document uses: open it with
3813 Acrobat Reader or Evince, select "Properties" from the "File" menu and
3814 click on the "Fonts" tab; alternatively, you can use the pdffonts
3815 program (part of the xpdf-reader package) from the command line. If
3816 that is indeed the problem, then either use a different viewer or
3817 install Type1 versions of the problematic fonts. For more details, see
3818 the "PDF export" section of [[./org-dependencies.org][org-dependencies]].
3820 ** Can I add attributes to a link or an image in HTML export?
3822 :CUSTOM_ID: html-image-and-link-attributes
3825 Yes. Excerpt from [[http://orgmode.org/manual/Images-in-HTML-export.html#Images-in-HTML-export][Org's manual]]:
3827 If you need to add attributes to an inlined image, use a `#+ATTR_HTML'.
3828 In the example below we specify the `alt' and `title' attributes to
3829 support text viewers and accessibility, and align it to the right.
3831 : #+CAPTION: A black cat stalking a spider
3832 : #+ATTR_HTML: alt="cat/spider image" title="Action!" align="right"
3835 and you could use `http' addresses just as well.
3837 ** How can I export an org file to rtf, odt (Open Office), or doc (Word)?
3839 :CUSTOM_ID: convert-to-open-office
3842 Orgmode exports natively to =OpenDocument= format using =org-odt=
3845 The key bindings for export are =C-c C-e o= and =C-c C-e O=.
3847 If you don't see =OpenDocumentText= as an option under =C-c C-e= you
3848 need to upgrade to =Org-mode 7.6= by one of the following means:
3850 1. Install org-7.6 using a distribution .zip or .tar.gz file, or
3851 through Git. Then do the following:
3852 1. Add =contrib/lisp= to the load-path in your =.emacs=
3853 #+begin_src emacs-lisp
3854 ;; modify org-root-dir as needed
3855 (add-to-list 'load-path "org-root-dir/contrib/lisp")
3857 2. Do =M-x customize-variable RET org-modules RET= and enable the
3860 2. Upgrade to (atleast) the =Emacs-24.1 pretest= version. Install
3861 =org-odt= package using =M-x list-packages=.
3865 - Use existing exporters
3867 Export to one of org-mode's supported export formats and then use an
3868 external tool or method to convert the exported file to doc or odt.
3870 With simple documents, these methods work well. However for complex
3871 documents containing footnotes, embedded images, math formuale etc
3872 the results may be less than satisfactory. (Note, the lists below
3873 are by no means comprehensive).
3874 1. html -> odt/doc/rtf
3875 - open html in Open Office and save as odt/doc ([[http://permalink.gmane.org/gmane.emacs.orgmode/31482][see this post by
3877 - [[http://www.artofsolving.com/opensource/pyodconverter][PyODConverter]]
3878 - [[http://johnmacfarlane.net/pandoc/][Pandoc]] (this works for LaTeX and docbook as well)
3879 - (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
3881 2. LaTeX -> odt/doc/rtf
3882 - [[http://latex2rtf.sourceforge.net/][LaTeX2rtf]] (works well with index, footnotes, and references)
3883 - [[http://www.tug.org/tex4ht/][TeX4ht]] (works with more complex latex elements, though can be
3884 difficult to install)
3885 - run =mk4ht oolatex file.tex=
3887 See [[http://permalink.gmane.org/gmane.emacs.orgmode/31168][this thread]] for further details.
3890 ** ODT export aborts on my Windows machine as I don't have zip installed. Where can I find a zip utility?
3892 You can either use [[http://en.wikipedia.org/wiki/Info-ZIP][Info-ZIP]] or zip package from Cygwin. Please
3893 customize =exec-path= to include the installation directory.
3895 ** I cannot open an exported =*.odt= file in LibreOffice because it is corrupt. What do I do?
3897 :CUSTOM_ID: debugging-org-odt
3900 Typically the corruption of =odt= file happens when the XML emitted by
3901 Org is not well-formed according to =OpenDocument schema=.
3903 If you encounter corruption issues please identify the root cause
3904 using one of the methods described below:
3906 - Use an Online validator
3907 - Pass the exported document through the [[http://tools.services.openoffice.org/odfvalidator/][ODF Validator]] and note down
3910 - Use Emacs' in-built validator
3911 1. Switch to =*.odt= buffer =(C-x b whatever.odt)=
3912 2. Open the =content.xml= file - =(Hit RET on content.xml)=
3913 3. Do a =C-u C-c C-n= - =(M-x rng-first-error)=
3914 4. Note the error message, the XML markup at the point of error and
3915 the surrounding context.
3917 Once you have identified the error
3918 1. Create a minimal org file that reproduces the error.
3919 2. Post a bug-report to =emacs-orgmode@gnu.org=.
3921 ** How can I specify ODT export styles?
3923 Check the variable =org-export-odt-styles-file=. Here is its docstring,
3924 as of Org version 7.8:
3926 : org-export-odt-styles-file is a variable defined in `org-odt.el'.
3930 : Default styles file for use with ODT export.
3931 : Valid values are one of:
3933 : 2. path to a styles.xml file
3934 : 3. path to a *.odt or a *.ott file
3935 : 4. list of the form (ODT-OR-OTT-FILE (FILE-MEMBER-1 FILE-MEMBER-2
3940 : Use "#+ODT_STYLES_FILE: ..." directive to set this variable on
3941 : a per-file basis. For example,
3943 : #+ODT_STYLES_FILE: "/path/to/styles.xml" or
3944 : #+ODT_STYLES_FILE: ("/path/to/file.ott" ("styles.xml" "image/hdr.png")).
3946 : You can customize this variable.
3950 Since =org= files are so central to your life, you probably want to back
3951 them up in a safe place.
3953 If the =org= file you want to back up are in a single directory, the
3954 preferred method is to us a =RCS= (Revision Control System) -- pick up your
3955 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
3956 RCS you use and how you use it, you can have a /local/ backup or sync it on
3959 If you want to store all your =org= files from your =$HOME= to a single
3960 =~/org/backup/= folder, you can use this shell script (as [[http://article.gmane.org/gmane.emacs.orgmode/37655][suggested by
3964 mkdir -p ~/org/backup && \
3965 find $HOME -type f -name '*\.org' ! -path "$HOME/org/backup/*" \
3966 -exec cp -t ~/org/backup/ \{\} \;
3969 It will recursively search for =org= files in your =$HOME= directory
3970 (except those in =~/org/backup/=) and copy them to =~/org/backup/=.
3971 You can then use rsync to make sure =~/org/backup/= also lives on a
3972 remote and safe place.
3976 ** Which versions of MobileOrg do exist
3978 :CUSTOM_ID: mobileorg_versions
3981 - MobileOrg for the iPhone/iPod Touch/iPad series of devices, by
3982 Richard Moreland. Check out
3983 [[http://mobileorg.ncogni.to/][Richard's page]]
3984 - Matt Jones is developing a feature-equivalent application for
3986 [[http://wiki.github.com/matburt/mobileorg-android/][his project page]].
3988 ** What can I do if I don't want to use Dropbox.com
3990 :CUSTOM_ID: mobileorg_webdav
3993 Dropbox.com is the easiest way to connect between Emacs and MobileOrg,
3994 you can get a free account there. If for some reason you cannot or do
3995 not want to use this path, you can use any webdav server. On this
3996 webdav server you need to create a dedicated directory for the
3997 communication between Emacs and MobileOrg. If you can mount that
3998 directory locally so that Emacs can directly write to it, just point
3999 to that directory using the variable =org-mobile-directory=. Using
4000 the /tramp/ method, =org-mobile-directory= may point to a remote
4001 directory accessible through, for example, /ssh/ and /scp/:
4003 #+begin_src emacs-lisp
4004 (setq org-mobile-directory "/scpc:user@@remote.host:org/webdav/")
4007 If Emacs cannot access the WebDAV directory directly using a /tramp/
4008 method, you can use a local directory for staging. Other means must
4009 then be used to keep this directory in sync with the WebDAV directory.
4010 In the following example, files are staged in =~/stage/=, and Org-mode
4011 hooks take care of moving files to and from the WebDAV directory using
4014 #+begin_src emacs-lisp
4015 (setq org-mobile-directory "~/stage/")
4016 (add-hook 'org-mobile-post-push-hook
4017 (lambda () (shell-command "scp -r ~/stage/* user@@wdhost:mobile/")))
4018 (add-hook 'org-mobile-pre-pull-hook
4019 (lambda () (shell-command "scp user@@wdhost:mobile/mobileorg.org ~/stage/ ")))
4020 (add-hook 'org-mobile-post-pull-hook
4021 (lambda () (shell-command "scp ~/stage/mobileorg.org user@@wdhost:mobile/")))
4026 ** How to install MathJax on my server?
4029 :CUSTOM_ID: install_mathjax_on_server
4032 Org uses MathJax as its default HTML display engine for equations.
4034 Org relies on the version of MathJax available from orgmode.org, but you
4035 might want to use another version and install MathJax on your own server.
4037 1. Download a [[http://sourceforge.net/projects/mathjax/files/][MathJax archive]].
4039 2. Upload it somewhere on your server (say http://me.org/mathjax/)
4041 3. Set the correct path in =org-export-html-mathjax-options= (i.e. replace
4042 http://orgmode.org/mathjax/MathJax.js by
4043 http://me.org/mathjax/MathJax.js)
4045 You can also get [[http://www.mathjax.org/resources/docs/?installation.html][MathJax from git or svn]] -- in this case, be careful not to
4046 forget to unzip the fonts.zip archive in the mathjax directory.
4050 ** Can I create an Org link from a gmail email?
4052 Yes. See [[http://comments.gmane.org/gmane.emacs.orgmode/48056][this email]] from Torsten Wagner.
4054 Also check this comment by Tom:
4056 : Since any mail can be found under the All label by definition the
4057 : simplest solution is extracting the message id from the end of
4058 : the current url and then creating a new url pointing to All.
4059 : This URL should always work unless the mail is deleted:
4061 : https://mail.google.com/mail/?shva=1#all/<msgid>
4063 ** Problems with LaTeX macros with #+latex or #+begin_latex
4065 :CUSTOM_ID: Problems-with-LaTeX-macros-with-#+latex-or-#+begin_latex
4067 Org's LaTeX exporter has a difficult job on its hands and even though
4068 it does a great job most of the time, there are times when it falls
4069 short. One situation that has arisen a few times in the past is when a
4070 macro definition or use includes an opening brace, but the
4071 corresponding closing brace is on a different line. That has caused
4072 LaTeX compilation problems or mysterious excisions of content - see
4073 for example the following two threads in the mailing list:
4075 - http://thread.gmane.org/gmane.emacs.orgmode/39308
4077 - http://thread.gmane.org/gmane.emacs.orgmode/42196
4079 In both cases, the exporter was getting confused by the opening brace
4080 which did not have a corresponding closing brace on the same
4081 line. Although the first of these cases is fixed in current Org, there
4082 might be more such cases or there might be a regression which causes
4083 the incorrect behavior again. While waiting for a fix, it's worth
4084 trying out the simple workaround of including a fake closing brace on
4085 the same line as the opening brace but *commenting it out* so that
4086 LaTeX never sees it. That is often enough to make the exporter behave
4087 properly. In other words, to take one of the examples above, instead
4090 : #+latex: \custommacro {
4094 use the following idiom instead:
4096 : #+latex: \custommacro { % hide the closing brace in a LaTeX comment }
4100 I emphasize that this is a workaround, not a fix: if you do run into such
4101 a case and the workaround fixes it, at least you can continue working, but
4102 please submit a bug report so that it can be fixed properly.
4104 ** Inserting a Mairix type link when calling Orgmode capture in VM
4106 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
4109 * COMMENT Function to create =CUSTOM_ID=
4111 #+begin_src emacs-lisp
4112 (defun org-faq-make-target ()
4113 "Make hard target for current headline."
4115 (if (not (org-on-heading-p))
4116 (error "Not on a headline"))
4117 (let ((h (org-trim (org-get-heading 'no-tags))))
4118 (if (string-match "[ \t]*\\?\\'" h)
4119 (setq h (replace-match "" t t h)))
4120 (while (string-match "[ \t]+" h)
4121 (setq h (replace-match "-" t t h)))
4122 (org-entry-put nil "CUSTOM_ID" h)))