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 "complete minimal 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 most recent release of org-mode ([[http://orgmode.org/org-7.3.zip][zip]] or [[http://orgmode.org/org-7.3.tar.gz][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 can I keep local changes and still track Org mode development?
361 :CUSTOM_ID: keeping-local-changes-current-with-Org-mode-development
364 Say you want to make minor changes to the Makefile to reflect your
365 location for =emacs=.
367 Create a local branch for your changes on top of origin/master as
370 : $ git checkout -b local origin/master
371 : $ git config branch.local.rebase true
372 : # Make your changes to the Makefile and create a new commit
374 : $ git commit -m 'My local Makefile configurations'
375 : # Update git to a newer version
378 Now each time you pull new commits from the distribution repository
379 your local commits will be rewound and replayed on top of the new
384 You would normally work on your =local= branch which includes your
385 custom commits; there's no need to switch back to the =master=
390 Here is an example of dealing with conflict resolution during git pull.
392 If you get a conflict during a =git pull= you will need to edit the
393 file with the conflict to fix up the conflicting lines and then tell
394 git that you have resolved the conflict.
396 Conflict resolution goes something like this:
398 1. =git pull= fails with a conflict
400 3. =git add= the file to mark the conflict resolved
401 4. =git rebase --continue=
402 5. lather, rinse, and repeat 2-4 as needed
404 For this example we have the following Makefile:
414 and we need to change the =EMACS=emacs= line to =EMACS=myemacs= to
415 make it work well on our system.
419 - create a local branch for our work
421 : $ git checkout -b local origin/master
422 : $ git config branch.local.rebase true
424 This marks the branch so that all local commits on it are rebased
425 on top of any new commits we get in origin/master during a =git
428 - Make our custom changes
430 Edit the makefile so it looks like this:
440 - Create a commit with our custom changes
442 : $ git commit -m 'My local Makefile configurations'
444 - Later we do a =git pull= but that fails with conflicts.
447 : remote: Counting objects: 5, done.
449 : Patch failed at 0001.
451 : When you have resolved this problem run "git rebase --continue".
452 : If you would prefer to skip this patch, instead run "git rebase --skip".
453 : To restore the original branch and stop rebasing run "git rebase --abort".
455 - Fix the conflict in your favourite editor
457 Conflict markers look like this:
459 : <<<<<<< HEAD:Makefile
463 : >>>>>>> Change emacs location:Makefile
465 This attempted =git pull= caused a conflict. Fire up your
466 favourite editor and fix the conflict in the Makefile. The
467 conflict markers are <<<<<<<<<< , ======= , and >>>>>>>>>>. Fix
468 the Makefile appropriately and delete the conflict markers. You
469 already edited these lines earlier so fixing it should be trivial.
471 In this case we changed =EMACS=emacs= to =EMACS=myemacs= and
472 upstream changed =EMACS=emacs= to =EMACS=emacs22=. Just fix the
473 file and save it by deleting the conflict markers and keeping the
474 code you need (in this case the =EMACS=myemacs= line which we
475 originally modified.)
477 - Mark the file's conflict resolved
481 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.
483 - Continue the rebase operation
485 : $ git rebase --continue
487 If any other conflicts arise you fix them the same way - edit the file, mark the conflict resolved, and continue.
489 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"
491 : $ git rebase --abort
493 ** How can I use a stable release version instead of the bleeding edge master?
495 :CUSTOM_ID: using-stable-releases-only
498 The master branch of the git repository always contains the bleeding
499 edge development code. This is important for Org's fast development,
500 because code on master gets checked out by many people daily and we
501 quickly receive bug reports if something is wrong. On rare occasions,
502 this code may not function perfectly for a limited time while we are
503 trying to fix things.
505 Not everyone like to use this bleeding-edge code and face the danger
506 to hit a surprising bug.
508 Therefore, from time to time, we make a release. This typically
509 happens when the maintainers feel that
511 1. they have reached a good point in the development
512 2. the code has a feature set that should stay and be supported in the
515 Stable releases are used as the basis for [[http://orgmode.org/index.html#sec-3_3][alternative distributions]] of
516 Org, and they are also the code that gets merged into the Emacs
517 distribution. If you want to work only with stable releases, you can
518 always download [[http://orgmode.org/index.html#sec-3][them here]], but you can also also use the git
519 repository to keep automatically up-to-date with the most recent
520 stable releases (and save bandwidth!). Here's how to do so:
522 *** Run a specific stable release
524 In the repository, do
529 To see which release tags are available. Let's say you decide to use
532 : $ git checkout release_7.01f
534 This set the working tree of the repository to the state of Org at the
535 moment of release 7.01f. You can then run Org from the repository be
536 sure to use the stable release while development continues on the
539 Later, when we release 7.02, you can switch to that using
541 : $ git fetch --tags # to get all the new stuff
543 : $ git checkout release_7.02
545 *** Always run the most recent stable release
547 Alternatively, if you just want to always run whatever the latest
548 stable release is, you can do
550 : $ git checkout -b stable origin/maint
552 and then regularly update this branch by doing
556 ** How can I install an up-to-date version of org-mode without "make" tools?
558 :CUSTOM_ID: installing-org-without-make-tools
561 If you are using org-mode on a computer that lacks developer tools for
562 compiling software, such as [[http://www.gnu.org/software/make/][GNU Make]], you will have to use a
563 *different* installation method than [[http://orgmode.org/manual/Installation.html#Installation][the one outlined in the manual]].
565 Please see [[http://article.gmane.org/gmane.emacs.orgmode/15264][this thread]] on the mailing list for several different ways
566 you can install a recent version of org-mode without using the
567 customary =make clean && make && make install=.
569 The result of that discussion is the file/function found in
570 [[http://orgmode.org/worg/org-hacks.html#compiling-org-without-make]].
572 ** I don't use git. Can I download bleeding edge .zip and .tar.gz archives?
574 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 --
575 these archives are udpated every day at midnight.
577 Alternatively, you can download a [[http://orgmode.org/w/org-mode.git/snapshot][tar.gz snapshot from orgmode.org]].
579 ** How do I install Org-mode through Emacs' Package Manager?
581 :CUSTOM_ID: installing-via-elpa
584 Daily builds of Org-mode is distributed as an ELPA package from
585 both [[http://elpa.gnu.org/packages/][GNU Emacs Lisp Package Archive]] as well as from [[http://orgmode.org/pkg/daily/][Org-mode Emacs
588 Steps for installing Org with package manager:
589 1) Do =M-x list-packages= to browse available packages
590 2) If the above command is unavailable you need to [[#installing-elpa][install package
591 manager]] before proceeding ahead.
592 3) If you see =org= as available package skip to step 5.
593 4) If you are here it means that org is unavailable in the GNU's
594 archives. Report this discrepancy to [[mailto:emacs-orgmode@gnu.org][Orgmode mailing list.]]
596 In the meanwhile, you can manually download the tarball and
597 install it. Refer [[Installing%20from%20ELPA-tar][this FAQ entry]] for further information.
598 5) Press =i= to mark the package for installation
599 6) Press =x= to install
601 8) Use =M-x locate-library RET org=. If your installation is
602 successful you would something like the following:
604 =Library is file ~/.emacs.d/elpa/org-20110403/org.elc=
606 # 7) If you get the following error "*Failed to download `Org-mode'
607 # archive.*" in step 2, you can manually download the tarball and
608 # install it. Refer [[Installing from ELPA-tar][this FAQ entry]] for more information.
610 # 8) Add Orgmode as a package archive. This can be done in two ways:
611 # 9) Use =M-x customize-variable RET package-archives=
612 # 10) Add the following line to your =.emacs= and reload Emacs.
613 # #+begin_src emacs-lisp
614 # (add-to-list 'package-archives '("Org-mode" . "http://orgmode.org/pkg/daily/"))
618 ** How do I install Emacs package manager?
620 :CUSTOM_ID: installing-elpa
623 If you are running Emacs 24 or find the command =M-x list-packages=
624 available you already have the package manager installed.
626 Steps for installing package manager on emacs-23:
627 1. Download the package manager [[http://repo.or.cz/w/emacs.git/blob_plain/1a0a666f941c99882093d7bd08ced15033bc3f0c:/lisp/emacs-lisp/package.el][package.el]]
629 2. Add the following to your =.emacs= and reload Emacs.
630 #+begin_src emacs-lisp
631 ;; change "~/elisp/" as appropiate
632 (setq load-path (cons "~/elisp" load-path))
634 ;; Add the below lines *at the end* of your .emacs. This
635 ;; ensures that packages installed with package manager
636 ;; overrides other local installation
641 ** I don't see Org-mode as an installation option in Package Manager Menu?
643 :CUSTOM_ID: why-no-org-in-elpa
646 Emacs Package Manager is a very recent addition to Emacs. Work is
647 under way to have have Org-mode seamlessly integrate with Emacs'
648 Package Manager. As a result, it will be some time before the
649 Org-mode packages are available and usable from either GNU or
650 Org-mode package archives.
652 In the meanwhile, you can install Org-mode via package manager
653 through ELPA-compatible tar. Refer [[Installing from ELPA-tar][this FAQ entry]] for more information.
655 ** How do I install Org-mode from a ELPA-compatible tarball?
657 :CUSTOM_ID: installing-from-elpa-tarball
659 # <<Installing from ELPA-tar>>
661 Org-mode is distributed as an ELPA-compatible tar which can be used
662 in conjunction with Emacs' package manager.
664 1. If you are already running Org-mode, note the current version
665 reported by M-x org-version.
666 2. Download the latest tarball from [[http://orgmode.org/pkg/daily/][Org-mode repo]].
667 3. Do =M-x package-install-file=. When prompted for =Package file
668 name=, point it to .tar file downloaded in step 2.
670 You will now see Package Manager compiling the files and
672 4. Reload emacs. This step is very important.
673 5. Note the version of the new installation using M-x
674 org-version. If the new and old versions are different, the
675 installation is done and you are all set to enjoy the updated
676 Org-mode. Otherwise skip to step 6.
677 6. Review you load-path using =C-h v load-path=. Most likely that
678 your old installation path takes precedence over the path chosen
679 by package manager (which is typically
680 =~/.emacs.d/elpa/...=). Fix this anamoly by moving
681 =(package-initialize)= line in .emacs to a more appropriate
684 - Additional Note on =org-install.el= :: Functionality of Org-mode's
685 =org-install.el= is supplanted by Package Manager's
686 =org-autoloads.el=. Since Package Manager autoloads Org-mode for
687 you, the following line =(require 'org-install)= in your =.emacs=
688 is no longer required and can be safely removed.
690 ** Why would I use ELPA tarballs instead of the snapshot tarballs?
695 ELPA-tarballs automate much the process of upgrading org-mode. Much
696 of the following grunt work is done automatically by the Package
699 1. Downloading, compiling, and activating of org-mode (including
700 setting org-mode's =load-path= and autoloads).
701 2. Updating info files.
707 ** How can I quickly browse all Org options?
709 =M-x org-customize RET=
711 See also [[file:org-tutorials/org-customize.org][Carsten's Org customize tutorial]] and [[file:org-configs/org-customization-guide.org][this customization guide]]
714 ** Can I use the editing features of org-mode in other modes?
716 :CUSTOM_ID: use-editing-features-in-other-modes
719 Not really---but there are a few editing features you can use in
722 - For tables there is =orgtbl-mode= which implements the table
723 editor as a minor mode. (To enable, type =M-x orgtbl-mode=)
724 - For ordered lists there is =orgstruct-mode= which allows for easy
725 list editing as a minor mode. (To enable, type =M-x
728 You can activate these modes automatically by using hooks:
730 : (add-hook 'mail-mode-hook 'turn-on-orgtbl)
731 : (add-hook 'mail-mode-hook 'turn-on-orgstruct)
733 For footnotes, there is the function =org-footnote-action=, which
734 works in non-org buffers. This function is a powerful tool for
735 creating and sorting footnotes. To use it globally, you can add the
736 following keybinding to your =.emacs= file (requires Org 6.17 or
739 : (global-set-key (kbd "C-c f") 'org-footnote-action)
741 For other features you need to switch to Org-mode temporarily, or
742 prepare text in a different buffer.
744 ** Why isn't feature "X" working the way it is described in the manual?
746 :CUSTOM_ID: making-sure-org-mode-is-up-to-date
749 Org-mode develops very quickly. If you are using a version of Org-mode
750 that shipped with emacs, there is a good chance that it is somewhat
753 Many of the users on the Org-mode mailing list are using either a
754 recent release of Org-mode or the
755 [[http://orgmode.org/index.html#sec-3.2][development version of
756 org-mode from the git repository]].
758 If some settings and features aren't working the way you expect, make
759 sure that the version of the manual you are consulting matches the
760 version of Org-mode you are using.
762 - You can check which version of Org-mode you are using by
763 selection =Org --> Documentation --> Show Version= in the Emacs
766 - The [[http://orgmode.org/manual/index.html][online manual]] at [[http://orgmode.org][orgmode.org]] corresponds to the most recent
769 - 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
770 released with the latest official Gnu Emacs release. Compared
771 with the manual at the orgmode.org, the manual at www.gnu.org is
772 somewhat out of date.
774 For instructions on how to stay current with Org-mode, consult [[keeping-current-with-Org-mode-development][this
775 FAQ]] or follow the instructions on [[http://orgmode.org][the official Org-mode site]].
777 ** Can I get the visibility-cycling features in outline-mode and outline-minor-mode?
779 :CUSTOM_ID: use-visibility-cycling-in-outline-mode
782 Yes, these functions are written in a way that they are independent of
783 the outline setup. The following setup provides standard Org-mode
784 functionality in outline-mode on =TAB= and =S-TAB=. For
785 outline-minor-mode, we use =C-TAB= instead of =TAB=,
786 because =TAB= usually has mode-specific tasks.
788 #+BEGIN_SRC emacs-lisp
789 (add-hook 'outline-minor-mode-hook
791 (define-key outline-minor-mode-map [(control tab)] 'org-cycle)
792 (define-key outline-minor-mode-map [(shift tab)] 'org-global-cycle)))
793 (add-hook 'outline-mode-hook
795 (define-key outline-mode-map [(tab)] 'org-cycle)
796 (define-key outline-mode-map [(shift tab)] 'org-global-cycle)))
799 Or check out /outline-magic.el/, which does this and also provides
800 promotion and demotion functionality. /outline-magic.el/ is
801 available at [[http://www.astro.uva.nl/~dominik/Tools/outline-magic.el][Outline Magic]].
803 ** Can I save/restore the visibility state of an org-mode buffer?
805 :CUSTOM_ID: saving-visibility-state
808 Well, no---at least not automatically. You can, however, control the
809 visibility of an org-file or of individual trees by adding
810 instructions to your org file. See [[http://orgmode.org/manual/Visibility-cycling.html#Visibility-cycling][this section of the manual]] for more
813 ** How can I keep track of changes in my Org files?
815 :CUSTOM_ID: track-of-changes-in-Org-files
818 Use git to track the history of the files, use a cronjob to check in
819 changes regularly. Such a setup is described by Bernt Hansen
820 in [[http://article.gmane.org/gmane.emacs.orgmode/6233][this message]] on [[http://dir.gmane.org/gmane.emacs.orgmode][emacs-orgmode]].
822 ** Can I use Org-mode as the default mode for all README files?
824 :CUSTOM_ID: Org-mode-as-default-mode
827 Add the following to your .emacs file:
829 : (add-to-list 'auto-mode-alist '("README$" . org-mode))
831 You can even make it the default mode for any files with unspecified
834 : (setq default-major-mode 'org-mode)
836 ** Can I use ido.el for completing stuff in Org?
838 :CUSTOM_ID: ido-complete
841 Yes, you can. If you are an ido user and ido-mode is active, the
842 following setting will make Org use =ido-completing-read= for most
843 of its completing prompts.
845 : (setq org-completion-use-ido t)
847 ** Should I use one big org file or multiple files?
849 :CUSTOM_ID: how-to-organize-org-mode-files
852 Org-mode is flexible enough to accomodate a variety of organizational
853 and time management schemes. Org's [[http://orgmode.org/manual/Document-Structure.html#Document-Structure][outline cycling and convenient
854 editing and navigation commands]] make it possible to maintain all of
855 your projects and notes in a single file. But org-mode's [[http://orgmode.org/manual/Hyperlinks.html#Hyperlinks][quick and
856 easy hyperlinks]], along with [[http://orgmode.org/manual/Refiling-notes.html#Refiling-notes][easy refiling of notes and todos]], also
857 make it a delight to maintain a private "wiki" consisting of multiple
860 No matter how you organize your org files, org-mode's agenda commands
861 make it easy to search all your notes and gather together crucial data
864 Moreover, several org-mode settings can be configured either globally
865 in your =.emacs= file or locally (per file or per outline tree). See
866 the [[http://orgmode.org/manual/index.html#Top][manual]] for more details. For an example of local customizations
867 see [[limit-agenda-with-category-match][this FAQ]].
869 Here are a few ideas for organizing org-mode files:
871 - A single file for all your projects and notes.
872 - One file per project.
873 - One file per client.
874 - One file per area of responsibility or type of work (e.g.,
875 household, health, work, etc.).
876 - One file for projects, one for appointments, one for reference
877 material, one for someday/maybe items, etc.
878 - A wiki of hyperlinked files that grows and adapts to meet your
881 For more ideas, see some of the links on the [[file:org-tutorials/index.org][org-tutorial index]] or
882 [[file:org-gtd-etc.org][this page on org-mode and GTD]].
884 ** Why doesn't C-c a call the agenda? Why don't some org keybindings work?
886 :CUSTOM_ID: setting-global-keybindings
889 Org-mode has a few global keybindings that the user must set
890 explicitly in an =.emacs= file. These keybindings include the
891 customary shortcut for calling the agenda (=C-c a=). If nothing
892 happens when you type =C-c a=, then make sure that the following lines
893 are in your =.emacs= file:
895 #+BEGIN_SRC emacs-lisp
896 ;; The following lines are always needed. Choose your own keys.
897 (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
898 (global-set-key "\C-cl" 'org-store-link)
899 (global-set-key "\C-ca" 'org-agenda)
900 (global-set-key "\C-cb" 'org-iswitchb)
903 You may, of course, choose whatever keybindings work best for you
904 and do not conflict with other modes.
906 Please see [[http://orgmode.org/manual/Activation.html][this section of the manual]] if you have additional
909 ** Why aren't some of the variables I've customized having an effect?
911 :CUSTOM_ID: load-org-after-setting-variables
914 Some org variables have to be set before org.el is loaded or else they
915 will not work. (An example is the new variable
916 =org-enforce-todo-dependencies=.)
918 To make sure all your variables work you should not use =(require
919 'org)=. Instead use the following setting:
921 : (require 'org-install)
923 You should also make sure that you do not require any other =org-...=
924 files in your =.emacs= file before you have set your org variables,
925 since these will also cause org.el to be loaded. To be safe, load org
926 files *after* you have set your variables.
928 ** How can I make sure that timestamps appear in English?
930 :CUSTOM_ID: timestamps-and-system-time-locale
933 If your system's locale is not set to English, but you would like the
934 timestamps in your org-mode files to appear in English, you can set
935 the following variable:
937 #+begin_src emacs-lisp
938 (setq system-time-locale "C")
941 ** What does a minimal .emacs look like?
943 :CUSTOM_ID: minimal-emacs
946 Using a stripped down minimal .emacs files removes broken custom
947 settings as the cause of an issue and makes it easy to reproduce for
948 other people. The example below has system-specific paths that you'll
949 need to change for your own use.
950 #+begin_src emacs-lisp
951 (add-to-list 'load-path (expand-file-name "~/git/org-mode/lisp"))
952 (add-to-list 'auto-mode-alist '("\\.\\(org\\ |org_archive\\|txt\\)$" . org-mode))
953 (setq org-agenda-files '("/tmp/test.org"))
954 (require 'org-install)
957 (global-set-key "\C-cl" 'org-store-link)
958 (global-set-key "\C-ca" 'org-agenda)
959 (global-set-key "\C-cb" 'org-iswitchb)
962 You can save the minimal .emacs file to ~/minimal.emacs, add suspect
963 configuration code to it, then start emacs something like this:
965 emacs -Q -l ~/minimal.emacs
968 On OS X, starting emacs with minimal configuration might look
971 /Applications/emacs.app/Contents/MacOS/Emacs -Q -l ~/minimal.emacs
974 ** Can I migrate from Planner?
976 Yes. This [[http://www.c0t0d0s0.de/plan2org/plan2org.pl][perl script]] or [[http://gitorious.org/bkuhn-small-hacks/org-mode/blobs/master/planner2org.plx
977 ][this Perl script]] can help.
979 * Errors and general problems
983 ** Opening Org files in Emacs leads to a crash
985 :CUSTOM_ID: Emacs-crashes-with-org-indent-mode
987 The only known case where Org-mode can crash Emacs is when you are
988 using =org-indent-mode= with Emacs 23.1 (in fact, any version of
989 Emacs before version 23.1.50.3). Upgrade to Emacs 23.2 and the
990 problem should go away.
992 ** When I try to use Org-mode, I always get the error message =(wrong-type-argument keymapp nil)=
994 :CUSTOM_ID: wrong-type-argument-keymapp
997 This is a conflict with an outdated version of the /allout.el/, see
998 the [[http://orgmode.org/manual/Conflicts.html#Conflicts][Conflicts]] section in the manual
1000 ** How can I control the application launched by Org-mode to open a certain file type like pdf, html....
1002 :CUSTOM_ID: external-application-launched-to-open-file-link
1005 If you want special control about how Org-mode opens files, see the
1006 variables =org-file-apps=, =org-file-apps-defaults-gnu=,
1007 =org-file-apps-defaults-macosx=, =org-file-apps-defaults-windowsnt=.
1009 *However*, normally it is best to just use the mechanism the
1010 operating-system provides:
1012 *** GNU/Linux systems
1013 You you have to check your mailcap settings, find the files:
1021 and modify them accordingly. Please read their manual entry.
1024 + for html pages you may configure the =browse-url-= variables through
1025 the Customize interface,
1026 + the pdf files are automatically opened with Acrobat Reader (if it is
1030 Change the application responsible for this file type by selecting
1031 such a file in the Finder, select =File->Get Info= from the menu
1032 and select the application to open this file with. Then, to
1033 propagate the change to all files with the same extension, select
1034 the =Change all= button.
1036 ** Org-mode takes over the TAB key. I also want to use YASnippet, is there a way to fix this conflict?
1038 :CUSTOM_ID: YASnippet
1041 [[http://code.google.com/p/yasnippet/][yasnippet]] is yet another snippet expansion system for Emacs. It is
1042 inspired by TextMate's templating syntax.
1043 - watch the [[http://www.youtube.com/watch?v=vOj7btx3ATg][video on YouTube]]
1044 - see the [[http://yasnippet.googlecode.com/svn/trunk/doc/index.html][intro and tutorial]]
1046 *Note*: yasnippet is not compatible with =org-indent-mode= currently
1047 there is no known way to use both successfully with =yas/trigger-key=
1048 set to =TAB= (or =[tab]= etc...)
1050 The way Org-mode binds the =TAB= key (binding to =[tab]= instead of
1051 =\t=) overrules yasnippets' access to this key. The following code
1054 #+begin_src emacs-lisp
1055 (add-hook 'org-mode-hook
1057 (org-set-local 'yas/trigger-key [tab])
1058 (define-key yas/keymap [tab] 'yas/next-field-group)))
1061 If the above code doesn't work (which it may not with later versions
1062 of yasnippet). Then try the following
1064 #+begin_src emacs-lisp
1065 (defun yas/org-very-safe-expand ()
1066 (let ((yas/fallback-behavior 'return-nil)) (yas/expand)))
1068 (add-hook 'org-mode-hook
1070 ;; yasnippet (using the new org-cycle hooks)
1071 (make-variable-buffer-local 'yas/trigger-key)
1072 (setq yas/trigger-key [tab])
1073 (add-to-list 'org-tab-first-hook 'yas/org-very-safe-expand)
1074 (define-key yas/keymap [tab] 'yas/next-field)))
1077 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]])
1078 with YASnippets for Org-mode.
1080 ** Org-mode takes over the S-cursor keys. I also want to use CUA-mode, is there a way to fix this conflict?
1082 :CUSTOM_ID: CUA-mode
1085 Yes, see the [[http://orgmode.org/manual/Conflicts.html#Conflicts][Conflicts]] section of the manual.
1087 ** Org-mode takes over the S-cursor keys. I also want to use windmove.el, is there a way to fix this conflict?
1089 :CUSTOM_ID: windmove.el
1092 Yes, see the [[http://orgmode.org/manual/Conflicts.html#Conflicts][Conflicts]] section of the manual.
1094 ** Org behaves strangely: some keys don't work, some features are missing, my settings have no effect, ...
1096 :CUSTOM_ID: loaded-old-org
1099 When this sort of things happen, it probably is because Emacs is
1100 loading an old version of Org-mode instead of the one you expected.
1101 Check it with =M-x org-version=.
1103 This happens because Emacs loads first the system org-mode (the one
1104 included with Emacs) before the one in your directory. Check the
1105 =load-path= variable; you might see that your org-mode appears /after/
1106 the system-wide path; this is bad.
1108 You should add your directories to the =load-path= at the beginning:
1110 : (add-to-list 'load-path "~/.emacs.d/org-mode/lisp") (require 'org-install)
1112 Function =add-to-list= adds at the beginning. Don't use =append=
1113 because it appends at the end. Also be sure to use =(require
1114 'org-install)= and not =(require 'org)=.
1116 This wrong version loading may also happen if you have a byte-compiled
1117 =org.elc= from an old version together with a new =org.el=. Since
1118 Emacs prefers loading byte-compiled files (even if the =.el= is
1119 newer), it will load the old Org-mode.
1121 ** Why doesn't org-batch-agenda work under Win32?
1123 :CUSTOM_ID: org-batch-agenda-under-win32
1126 When I run the example batch files to print my agenda to the console
1127 under Win32 I get the failure:
1129 : End of file during parsing
1131 and no agenda is printed.
1133 The problem is the use of single quotes surrounding the eval in the
1134 emacs command-line. This gets confused under Win32. All string
1135 parameters with spaces must be surrounded in double quotes. This means
1136 that double quotes being passed to the eval must be escaped.
1138 Therefore, instead of the following:
1140 : <path to emacs>\emacs.exe -batch -l ~/_emacs_org \
1141 : -eval '(org-batch-agenda "a")'
1143 you need to use the following:
1145 : <path to emacs>\emacs.exe -batch -l ~/_emacs_org \
1146 : -eval "(org-batch-agenda \"a\")"
1148 (all on one line, of course).
1150 ** Org agenda seems very slow
1152 :CUSTOM_ID: slow-agenda
1155 If it takes a long time to generate or refresh the agenda, you might
1156 want first check which version of org-mode you are using. There have
1157 been major optimizations of org-agenda since 6.21b, which was the
1158 version of org-mode released with Emacs 23. If you are using 6.21b or
1159 earlier (you can check with =M-x org-version=), then you might want to
1160 consider upgrading to a more recent version of org-mode.
1162 Here are some other ideas for speeding up the agenda:
1164 1. Use a one day agenda view (rather than a seven day view).
1166 =(setq org-agenda-ndays 1)=
1168 2. Archive inactive items to separate files.
1170 =C-c C-x C-s= (org-archive-subtree)
1172 3. Do not include the global todo list in your agenda view.
1174 (setq org-agenda-include-all-todo nil)
1176 4. Make sure that your org files are byte-compiled.
1178 I.e., make sure there are files ending in =.elc= in your org
1179 installation directory.
1181 5. Limit your agenda files (=org-agenda-files=) to files that have
1182 active todos and or projects.
1184 If you have a number of older reference files---i.e., files you
1185 search only occasionally---in your agenda files list, consider
1186 removing them from your agenda files and adding them to
1187 =org-agenda-text-search-extra-files= instead. Similarly, you might
1188 consider searching some of your older reference files with =M-x
1189 grep= so that Org-mode does not have to load them into memory when
1190 the agenda is called.
1192 ** Visual-line-mode doesn't work well with org-mode
1194 :CUSTOM_ID: visual-line-mode
1197 Visual-line-mode "soft wraps" lines so that the visual edge of the
1198 buffer is considered a line break for purposes of navigation, even
1199 though there is no line break in reality.
1201 In older versions of org-mode, org-beginning-of-line and
1202 org-end-of-line do not work well with visual line mode. (The two
1203 commands disregard soft line breaks and move to the beginning and end
1204 of the hard line break.) A patch was introduces to fix this behavior
1207 If you are using an older version of org mode, you can:
1209 1. Add a hook to turn off visual line mode.
1211 2. Add the following to your =.emacs=:
1213 #+begin_src emacs-lisp
1215 (add-hook 'org-mode-hook
1217 (define-key org-mode-map "\C-a" 'move-beginning-of-line)
1218 (define-key org-mode-map "\C-e" 'move-end-of-line)))
1221 ** Can I hide blocks at startup?
1225 #+begin_src emacs-lisp
1226 (setq org-hide-block-startup t)
1232 ,#+STARTUP: hideblocks
1235 on a per-file basis.
1237 * Faces and highlighting
1241 ** Org-mode has a lot of colors? How can I change them?
1243 :CUSTOM_ID: customizing-org-faces
1246 This is a question that applies to Emacs as a whole, but it comes up
1247 quite frequently on the org-mode mailing list, so it is appropriate to
1250 If you would like to change the style of a face in org-mode (or any
1251 other Emacs mode), simply type =M-x customize-face [RET]= while the
1252 cursor is on the color/style you are interested in modifying. You will
1253 be given the opportunity to customize all the faces located at that
1256 If you would like an overview of all the faces in org-mode, you can
1257 type =C-u M-x list-faces-display [RET] org= and you will be shown all
1258 the faces defined by org-mode along with an illustration of their
1261 If you would like to customize org-faces and other aspects of
1262 org-appearance, type =M-x customize-group org-font-lock [RET]=.
1264 Finally, if you would like verbose information about the properties of
1265 the text under the cursor, you can type =C-u C-x ==.
1267 See the Worg page on [[file:org-tutorials/org-appearance.org][customizing Org appearance]] for further information.
1268 ** Why do I get a tiny font in column view when using emacs daemon?
1270 :CUSTOM_ID: column-view-tiny-font
1273 When using emacs in daemon mode (=emacs --daemon=), client frames
1274 sometimes override the column view face settings, resulting in very
1275 small fonts. Here is a fix:
1277 #+begin_src emacs-lisp
1278 (defun org-column-view-uses-fixed-width-face ()
1279 ;; copy from org-faces.el
1280 (when (fboundp 'set-face-attribute)
1281 ;; Make sure that a fixed-width face is used when we have a column
1283 (set-face-attribute 'org-column nil
1284 :height (face-attribute 'default :height)
1285 :family (face-attribute 'default :family))))
1287 (when (and (fboundp 'daemonp) (daemonp))
1288 (add-hook 'org-mode-hook 'org-column-view-uses-fixed-width-face))
1291 This fix was provided in the following mailing list post:
1293 http://article.gmane.org/gmane.emacs.orgmode/27560
1294 ** How can I stop the mouse cursor from highlighting lines in the agenda?
1296 :CUSTOM_ID: ratpoison-for-agenda-highlighting
1299 You can add the following to your =.emacs=:
1301 #+begin_src emacs-lisp
1302 (add-hook 'org-finalize-agenda-hook
1303 (lambda () (remove-text-properties
1304 (point-min) (point-max) '(mouse-face t))))
1311 ** Can I close an outline section without starting a new section?
1313 :CUSTOM_ID: closing-outline-sections
1316 Can I have nested, closed outline sections, similar to xml? This
1317 question comes up quite frequently on the mailing list.
1319 See the following threads:
1321 - http://permalink.gmane.org/gmane.emacs.orgmode/40182
1322 - http://permalink.gmane.org/gmane.emacs.orgmode/36719
1323 - http://permalink.gmane.org/gmane.emacs.orgmode/24092
1324 - http://permalink.gmane.org/gmane.emacs.orgmode/12425
1326 The desired behavior looks something like this:
1341 ,# end Subsection Two
1343 ,Continue text in section one.
1346 The short answer to the question is no. Org-mode adheres to the
1347 cascading logic of outlines, in which a section is closed only by
1348 another section that occupies an equal or greater level.
1350 Here are some workarounds:
1352 1. You can use inline tasks to create non-folding subsections. See the
1353 documentation in org-inlinetask.el, which is part of the org-mode
1355 2. You can create a temporary heading, such as "** Continue main
1356 section" and then remove it when you are ready to export.
1357 3. You can create a separate outline heading (e.g., * ACTIONS),
1358 creating TODOs there with links to the relevant sections of your
1361 ** Can I add a TODO to a list item?
1363 :CUSTOM_ID: list-item-as-todo
1366 No. When generating agenda views, org-mode treats only headlines as
1369 You can, however, use a status cookie together with checkboxes to
1370 monitor your progress on a series of subtasks:
1373 ,** TODO Big task [1/3]
1380 If you would like to embed a TODO within text without treating it as
1381 an outline heading, you can use inline tasks. Simply add...
1383 : (require 'org-inlinetask)
1385 ...to your =.emacs= and then type C-c C-x C-t to insert an inline task.
1387 ** Can I have two windows on the same Org-mode file, with different outline visibilities?
1389 :CUSTOM_ID: indirect-buffers
1392 You may use /indirect buffers/ which do exactly this. See the
1393 documentation on the command =make-indirect-buffer=.
1395 Org-mode has built-in commands that allow you create an indirect
1396 buffer from a subtree of an outline. To open a subtree in new
1397 window, type =C-c C-x b=. Any changes you make in the new window
1398 will be saved to the original file, but the visibility of both
1399 buffers will remain independent of one another.
1401 For multiple indirect buffers from the same file, you must use the
1402 prefix =C-u= when creating the second (or third) buffer. Otherwise
1403 the new indirect buffer will replace the old.
1405 You can also create an independent view of an outline subtree by
1406 typing =b= on an item in the agenda.
1408 ** Emacs outlines are unreadable. Can I get rid of all those stars?
1410 :CUSTOM_ID: Emacs-outlines-are-unreadable
1413 See the section [[http://orgmode.org/manual/Clean-view.html#Clean-view][Clean outline view]] in the manual.
1414 ** C-k is killing whole subtrees! I lost my work!
1416 :CUSTOM_ID: C-k-is-killing-subtrees
1419 =(setq org-ctrl-k-protect-subtree t)= before losing your work.
1421 ** Why aren't commands working on regions?
1423 :CUSTOM_ID: transient-mark-mode
1426 Some org-mode commands, such as M-right and M-left for demoting or
1427 promoting headlines (see [[demote-multiple-headlines][this FAQ]]), can be applied to entire regions.
1428 These commands, however, will only work on active regions set with
1429 [[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
1430 Emacs 23. To enable it in earlier versions of emacs, put the following
1431 in your =.emacs= file:
1433 : (transient-mark-mode 1)
1435 Alternatively, you may turn off transient mark mode and use [[http://www.gnu.org/software/emacs/manual/html_node/emacs/Momentary-Mark.html][a
1436 momentary mark]] (=C-<SPC> C-<SPC>=).
1438 ** Why is a blank line inserted after headlines and list items?
1440 :ID: 2463F4D8-F686-4CF3-AA07-08976F8A4972
1443 :CUSTOM_ID: blank-line-after-headlines-and-list-items
1446 In org-mode, typing =M-RET= at the end of a headline will create a new
1447 headline of the same level on a new line. The same is true for plain
1448 lists. By default org-mode uses context to determine if a blank line
1449 should be inserted after each headline or plain list item when =M-RET=
1450 is pressed. For instance, if a there is a blank line before a
1451 headline, then typing =M-RET= at the end of the line will insert a
1452 blank line before the new headline. For instance, hitting =M-RET=
1453 at the end of "Headline Two" below inserts a new headline without a
1460 If there is a blank line between Headline One and Headline Two,
1461 however, the results will be as follows:
1469 If you do not like the default behavior you can change it with the
1470 variable =org-blank-before-new-entry=. You can set headings and/or
1471 plain lists to auto (the default setting), t (always), or nil (never).
1473 ** How can I promote or demote multiple headlines at once?
1475 :CUSTOM_ID: demote-multiple-headlines
1478 If you have a long list of first level headlines that you'd like to
1479 demote to second level headlines, you can select the headlines as a
1480 region and then hit =M-<right>= to demote all the headlines at once.
1482 Note: =M-S-<right>= will not work on a selected region. Its use is to
1483 demote a single subtree (i.e., a headline and all sub-headlines).
1485 If M-<right> doesn't seem to work, make sure transient mark mode is
1486 enabled. See [[transient-mark-mode][this FAQ]].
1488 ** What's the deal with all the ellipses in my org outlines?
1490 :CUSTOM_ID: org-ellipses
1493 Org-mode uses ellipses to indicate folded (and thus hidden) text. Most
1494 commonly, ellispes occur at the end of headings with folded content:
1498 Or, for instance, they may indicate closed drawers:
1502 Sometimes, as a result of editing and cycling an outline, ellipses may
1503 appear in unexpected places. You should *never* delete these ellipses,
1504 as you may accidentally delete hidden text. Instead, you can type =C-c
1505 C-r= (org-reveal) to display all hidden text in the vicinity. Or you
1506 may type =M-x RET show-all= to reveal all text in the org file.
1508 If you would prefer a symbol or face for indicating hidden text, you
1509 can customize the variable org-ellipses.
1511 ** How do I yank a subtree so it's indented according to the point's location?
1513 :CUSTOM_ID: yank-indent-subtree
1516 You can either use =C-c C-w= with a working [[http://orgmode.org/manual/Refiling-notes.html#Refiling-notes][refile-targets]] setup.
1518 Or set =org-yank-adjusted-subtrees= to =t= which will adjust the
1519 yanked headline's level correctly.
1521 Just use =C-k= and =C-y= as you would everywhere else in Emacs.
1523 ** Can I read org-mode outlines in vim?
1525 :CUSTOM_ID: org-outlines-in-vim
1528 Yes, there is a script that enables one to view and navigate folded
1529 outline/org files in vim (though without most of org-mode's
1530 functionality, of course).
1532 - [[http://www.vim.org/scripts/script.php?script_id%3D1266][Emacs outline mode - Imitates Emacsen : vim online]]
1534 For instructions on how to set it up, please see [[http://mid.gmane.org/EA275862-B97A-4BAC-B879-177FD07A2D56@gaillourdet.net][this mailing list
1537 Work is also underway on an org-mode clone for Vim. You can check it
1540 https://github.com/hsitz/VimOrganizer
1542 ** Can I use another character than "*" to start a headline?
1544 No. The "*" character is used in =outline-mode=, and Org is derived from
1547 If you are curious as to what other rationales there are for "*", check out
1548 [[http://permalink.gmane.org/gmane.emacs.orgmode/44271][this]] mail and the thread it is in.
1552 :CUSTOM_ID: Todos-and-Tags
1554 ** How can I cycle through the TODO keyword of an entry?
1556 :CUSTOM_ID: cycle-TODO-keywords
1559 =C-c C-t= or =S-<left/right>= is what you need.
1561 ** How do I track state changes for tasks in Org?
1563 :CUSTOM_ID: track-state-changes-for-tasks
1566 Take a look at the [[http://thread.gmane.org/gmane.emacs.orgmode/6082][post by Bernt Hansen]] for setting up TODO keyword
1567 states and logging timestamps for task state changes.
1569 ** Can I select the TODO keywords with a tag-like interface?
1571 :CUSTOM_ID: select-TODO-keywords-with-tag-like-interface
1574 Yes. Use =(setq org-use-fast-todo-selection t)=
1576 If you want to set both your todos and your tags using a single
1577 interface, then check out the variable
1578 =org-fast-tag-selection-include-todo=.
1580 See [[http://orgmode.org/manual/Fast-access-to-TODO-states.html][this section of the manual]] for more details.
1582 ** How can I quickly set the tag of an entry?
1584 :CUSTOM_ID: quickly-set-tag-of-entry
1587 Use =C-c C-c= or =C-c C-q= on the headline. =C-c C-q= is useful for
1588 setting tabs in a [[http://orgmode.org/manual/Remember.html#Remember][remember]] buffer, since =C-c C-c= is the default
1589 keybinding for filing a note from the remember buffer.
1591 You can set tags even more quickly by setting one of the character
1592 shortcuts for [[http://orgmode.org/manual/Setting-tags.html#Setting-tags][fast tag selection]].
1594 To set tag shortcuts for all org buffers, put something like the
1595 following in your =.emacs= file (or create the same settings by
1596 typing =M-x customize-variable RET org-tag-alist=):
1598 : (setq org-tag-alist '(("computer" . ?c) ("office" . ?o) ("home" . ?h)))
1600 To set tag shortcuts for a single buffer, put something like the
1601 following at the top of your org file:
1603 : #+TAGS: computer(c) office(o) home(h)
1605 ** How can I change the colors of TODO keywords?
1607 You can use the variable org-todo-keyword-faces. Here are some sample
1610 #+begin_src emacs-lisp
1611 (setq org-todo-keyword-faces
1613 ("TODO" . (:foreground "firebrick2" :weight bold))
1614 ("WAITING" . (:foreground "olivedrab" :weight bold))
1615 ("LATER" . (:foreground "sienna" :weight bold))
1616 ("PROJECT" . (:foreground "steelblue" :weight bold))
1617 ("DONE" . (:foreground "forestgreen" :weight bold))
1618 ("MAYBE" . (:foreground "dimgrey" :weight bold))
1619 ("CANCELED" . shadow)
1623 If you want to change the color of all active todos or all inactive
1626 : M-x customize-face RET org-todo
1627 : M-x customize-face RET org-done
1629 You can also set values for each of these in your =.emacs= file:
1631 : (set-face-foreground 'org-todo "firebrick2")
1632 : (set-face-foreground 'org-done "forestgreen")
1634 ** Can I use a arbitrary character in a TODO keyword?
1636 Yes, provided you add it to the "word" syntax in Emacs.
1638 For example, to add the =\u25b6= and the =\u25b8= chars, just add this to
1639 your Emacs configuration:
1641 #+begin_src emacs-lisp
1642 (add-hook 'org-mode-hook
1644 (modify-syntax-entry (string-to-char "\u25b6") "w")
1645 (modify-syntax-entry (string-to-char "\u25b8") "w")))
1650 :CUSTOM_ID: Hyperlinks
1652 ** Why do I have to confirm the execution of each shell/elisp link?
1654 :CUSTOM_ID: confirm-shell/elisp-link
1657 The confirmation is there to protect you from unwantingly execute
1658 potentially dangerous commands. For example, imagine a link
1660 : [[shell:rm -rf ~/*][Google Search]]
1662 In an Org-mode buffer, this command would look like /Google Search/,
1663 but really it would remove your home directory. If you wish, you can
1664 make it easier to respond to the query by setting
1666 : (setq org-confirm-shell-link-function 'y-or-n-p
1667 : org-confirm-elisp-link-function 'y-or-n-p).
1669 Then a single keypress will be enough to confirm those links. It is
1670 also possible to turn off this check entirely, but I strongly
1671 recommend against this. Be warned.
1673 ** Can I use RET or TAB to follow a link?
1675 :CUSTOM_ID: RET-or-TAB-to-follow-link
1680 : (setq org-return-follows-link t)
1681 : (setq org-tab-follows-link t)
1683 ** Can I keep mouse-1 clicks from following a link?
1685 :CUSTOM_ID: mouse-1-following-link
1688 Activating links with =mouse-1= is a new feature in Emacs 22, to make
1689 link behavior similar to other applications like web browsers. If
1690 you hold the mouse button down a bit longer, the cursor will be set
1691 without following the link. If you cannot get used to this behavior,
1692 you can (as in Emacs 21) use =mouse-2= to follow links and turn off
1693 link activation for =mouse-1= with
1695 : (setq org-mouse-1-follows-link nil)
1697 ** How can I get completion of file names when creating a link?
1699 :CUSTOM_ID: completion-of-file-links
1702 You can use org-insert-link with a prefix argument:
1706 You will be greeted with prompt in the minibuffer that allows for file
1707 completion using your preferred Emacs method for finding files.
1709 ** How can I use invisible targets within lists?
1711 :CUSTOM_ID: invisible-targets-in-lists
1714 The usual way of turning radio links invisible is to comment them, but
1715 Org comments need to be at the beginning of the line, which breaks list
1718 The workaround here is to add (INVISIBLE) after your <<target>>
1722 : 11. <<target>>(INVISIBLE)
1724 : 12. More text [[target][go to]]
1726 ** Org-mode is not opening mailto links in my default mail client
1728 :CUSTOM_ID: mailto-links
1731 You can customize the function org-mode uses to open mailto links by
1732 setting the variable =org-link-mailto-program=:
1734 =M-x customize-variable org-link-mailto-program=
1736 The default function called is =browse-url=, which opens a mail
1737 composition buffer within Emacs. The type of buffer opened by
1738 browse-url depends on the setting of the variable =mail-user-agent=.
1739 Thus, if you want to ensure that mailto links use Gnus to open a
1740 message buffer, you could add the following to your =.emacs=:
1743 (setq mail-user-agent 'gnus-user-agent)
1746 ** Can I use CamelCase links?
1748 :CUSTOM_ID: CamelCase-links
1751 Yes, you can with the contributed package org-wikinodes.el. Please
1752 consult the [[http://orgmode.org/worg/org-contrib/org-wikinodes.html][documentation]].
1756 :CUSTOM_ID: Plain-Lists
1758 ** How can I insert an empty line before each newly inserted headline, but not before each newly inserted plain-list item?
1760 :CUSTOM_ID: empty-line-before-each-new-headline-but-not-item
1763 : (setq org-blank-before-new-entry
1764 : '((heading . t) (plain-list-item . nil))
1766 See also [[id:2463F4D8-F686-4CF3-AA07-08976F8A4972][Why is a blank line inserted after headlines and list items?]].
1768 ** How can I convert itemized lists to enumerated lists?
1770 :CUSTOM_ID: convert-itemized-to-enumerated-lists
1773 You can use =C-c -= or =S-<left>/<right>= to cycle through the various
1774 bullet headlines available for lists: =-, +, *, 1., 1)=.
1776 See [[http://orgmode.org/manual/Plain-lists.html#Plain-lists][this section of the manual]] for more information.
1778 ** How can I convert plain lists to headlines and vice versa?
1780 :CUSTOM_ID: convert-plain-lists-to-headlines
1783 To convert a plain list item or line to a headline, type =C-c *= on
1784 the headline. This will make the line a subheading of the current
1787 To convert a headline to a plain list item, type =C-c -= while the
1788 cursor is on the headline.
1790 To convert a headline to an unadorned line of text, type =C-c *= on
1793 You can use query replace to accomplish the same things, as Bernt
1794 Hansen explains in [[http://article.gmane.org/gmane.emacs.orgmode/10148][this mailing list post]].
1796 ** Is there a good way to create a description list?
1798 :CUSTOM_ID: description-lists
1801 Yes, these are now built-in:
1804 - item1 :: Description of this item 1
1805 - item2 :: Description of this item 2
1806 - item1 :: Description of this item 3
1807 also in multiple lines
1814 ** Will there ever be support for multiple lines in a table field?
1816 :CUSTOM_ID: table-multiline-fields
1821 You can embed tables created with the table.el package in org-mode
1822 buffers, with mixed success when it comes to export and publishing.
1824 ** How can I make table alignment work with Asian character sets
1826 :CUSTOM_ID: table-alignment-asian-characters
1829 When table alignment fails, it usually has to do with character sets
1830 where some characters have non-integer width. Org will deal correctly
1831 with characters that are one or two or three ASCII characters wide,
1832 but not with characters that are, for example, 1.5 ASCII characters
1833 wide. To make table alignment work you need to switch to a different
1836 ** Can I plot data from a table?
1838 :CUSTOM_ID: plotting-table-data
1841 Yes, you can, using org-plot.el written by Eric Schulte and now
1842 bundled with Org. See [[http://orgmode.org/manual/Org_002dPlot.html#Org-Plot][the manual section about this]].
1844 See also [[file:org-tutorials/org-plot.org][this excellent tutorial]] by Eric Schulte.
1846 ** How can I fill a table column with incremental numbers?
1848 :CUSTOM_ID: fill-table-column-with-incremental-numbers
1851 Here is how: Use a field formula to set the first value in the column:
1863 Then define a column formula in the second field:
1875 After recomputing the table, the column will be filled with
1876 incremental numbers:
1885 ,#+TBLFM: $1=@-1 + 1::@2$1=1
1888 Note that you could use arbitrary starting values and column formulas.
1890 ** Why does my table column get filled with #ERROR?
1892 :CUSTOM_ID: table-column-filled-with-ERROR
1895 Org-mode tried to compute the column from other fields using a
1896 formula stored in the =#+TBLFM:= line just below the table, and
1897 the evaluation of the formula fails. Fix the fields used in the
1898 formula, or fix the formula, or remove it!
1900 ** How can I stop the table editor from creating new lines?
1902 :CUSTOM_ID: table-editor-creates-new-lines
1905 When I am in the last column of a table and just above a horizontal
1906 line in the table, pressing TAB creates a new table line before the
1907 horizontal line. To move to the line below the
1908 horizontal line instead, do this:
1910 Press =down= (to get on the separator line) and then =TAB=.
1911 Or configure the variable
1913 : (setq org-table-tab-jumps-over-hlines t)
1915 ** How can I get table fields starting with "="?
1917 :CUSTOM_ID: table-fields-starting-with-=
1922 : (setq org-table-formula-evaluate-inline nil)
1924 this will no longer happen. You can still use formulas using the
1925 commands ~C-c =~ and ~C-u C-c =~
1927 ** How can I get a vertical bar "|" inside a table field?
1929 :CUSTOM_ID: table-fields-with-vertical-bar
1932 You can use =\vert= to put a vertical bar inside a table field.
1933 This will be converted for export. To use it inside a word use
1934 =abc\vert{}def=. If you need something that looks like a bar in
1935 the Org mode buffer, you can use the unicode character brvbar which
1936 looks like this: \brvbar{}.
1939 ** How can I change the indentation of an entire table without fixing every line by hand?
1941 :CUSTOM_ID: change-indentation-entire-table
1944 The indentation of a table is set by the first line. So just fix the
1945 indentation of the first line and realign with =TAB=.
1947 ** In my huge table the realigning after each TAB takes too long. What can I do?
1949 :CUSTOM_ID: table-realigning-after-TAB-takes-long
1952 Either split the table into several by inserting an empty line every
1953 100 lines or so. Or turn off the automatic re-align with
1955 : (setq org-table-automatic-realign nil)
1957 After this the only way to realign a table is to press =C-c C-c=. It
1958 will no longer happen automatically, removing the corresponding delays
1961 ** Recalculation of my table takes too long. What can I do?
1963 :CUSTOM_ID: Recalculation-of-my-table-takes-too-long
1966 Nothing, really. The spreadsheet in org is mostly done to make
1967 calculations possible, not so much to make them fast. Since Org-mode
1968 is firmly committed to the ASCII format, nothing is stopping you from
1969 editing the table by hand. Therefore, there is no internal
1970 representation of the data. Each time Org-mode starts a computation,
1971 it must scan the table for special lines, find the fields etc. This
1972 is slow. Furthermore, Calc is slow compared to hardware
1973 computations. To make this work with normal editing, recalculation
1974 is not happening automatically, or only for the current line, so that
1975 the long wait for a full table iteration only happens when you ask
1978 So for really complex tables, moving to a "real" spreadsheet may
1979 still be the best option.
1981 That said, there are some ways to optimize things in Org-mode, and I
1982 have been thinking about moving a bit further down this line.
1983 However, for my applications this has so far not been an issue at
1984 all. If you have a good case, you could try to convince me.
1986 ** =S-RET= in a table keeps increasing the copied numbers. How can I stop this?
1988 :CUSTOM_ID: S-RET-in-a-table-increases-copied-numbers
1991 Well, it is /supposed/ to be a feature, to make it easy to create a
1992 column with increasing numbers. If this gets into your way, turn it
1995 : (setq org-org-table-copy-increment nil)
1997 ** When I export tables to html, they don't have borders.
1999 :CUSTOM_ID: table-borders-in-html-export
2002 By default, org mode exports tables without borders.
2004 You can changed this by placing an =#+ATTR_HTML= line before the
2007 : #+ATTR_HTML: border="2" rules="all" frame="all"
2009 See [[http://orgmode.org/manual/Tables-in-HTML-export.html#Tables-in-HTML-export][the manual]] for more details.
2011 ** Why does the Calc high precision (e. g. =p20=) not work like expected?
2013 :CUSTOM_ID: table-high-precision
2019 : | 1 / 2 * 3 | 0.16666667000000 |
2020 : #+TBLFM: $2 = $1; p20 %.14f
2023 : | 1 / 2 * 3 | 0.16666666666667 |
2024 : #+TBLFM: $2 = $1 +.0; p20 f-14
2028 It is important to distinguish between the precision of
2029 1) =p20=: Calc internal calculation (=calc-internal-prec=)
2030 2) =f-14=: Calc float formatting, unlimited in precision (=calc-float-format=)
2031 3) =%.14f=: the =printf= reformatting, limited in precision
2033 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.
2035 Use =C-h v org-calc-default-modes RET= to check the Org default settings
2036 which are used if no format specifiers are added to a table formula.
2037 The examples below have been made with the out_of_the_box Org defaults
2038 =calc-internal-prec = 12= and =calc-float-format = 8=.
2040 Remember the formula debugger, toggled with =C-c {=,
2041 to view the processing stages like:
2042 | | formula debugger label | processing stage |
2044 |---+------------------------+----------------------------|
2045 | | Result: | output of Calc |
2046 | | Format: | reformatting with =printf= |
2048 Following are some examples to demonstrate
2049 the interaction of the three precisions.
2051 - *display precision limitations for Calc formulas*
2052 - limited by Calc internal calculation precision from Org default
2054 : | 0.16666666666700 |
2055 : #+TBLFM: $1 = 1 / 2 * 3; f-14
2057 : | 0.1666666666670000000 |
2058 : #+TBLFM: $1 = 1 / 2 * 3; f-19
2060 - limited by Calc float format from Org default (here =f8=)
2062 : #+TBLFM: $1 = 1 / 2 * 3
2065 : #+TBLFM: $1 = 1 / 2 * 3; p20
2067 : | 0.16666667000000 |
2068 : #+TBLFM: $1 = 1 / 2 * 3; %.14f
2070 : | 0.16666667000000 |
2071 : #+TBLFM: $1 = 1 / 2 * 3; p20 %.14f
2073 - limited by Calc float format specified
2075 : #+TBLFM: $1 = 1 / 2 * 3; f-6
2077 : | 0.16666666666667 |
2078 : #+TBLFM: $1 = 1 / 2 * 3; p20 f-14
2080 : | 0.1666666666666666667 |
2081 : #+TBLFM: $1 = 1 / 2 * 3; p20 f-19
2083 - limited by =printf= conversion to Emacs Lisp float
2084 : | 0.1666666699999999900 | the inaccuracy is platform dependent |
2085 : #+TBLFM: $1 = 1 / 2 * 3; %.19f
2087 : | 0.1666666699999999900 | the inaccuracy is platform dependent |
2088 : #+TBLFM: $1 = 1 / 2 * 3; p20 %.19f
2090 : | 0.1666666666666666600 | the inaccuracy is platform dependent |
2091 : #+TBLFM: $1 = 1 / 2 * 3; p20 f-20 %.19f
2093 - limited by =printf= format specified
2095 : #+TBLFM: $1 = 1 / 2 * 3; %.6f
2097 - *display precision limitations for Emacs Lisp formulas*
2098 - limited by Emacs Lisp float
2099 : | 0.16666666666666666 |
2100 : #+TBLFM: $1 = '(/ 1.0 (* 2 3))
2102 : | 0.1666666666666666574 | the inaccuracy is platform dependent |
2103 : #+TBLFM: $1 = '(/ 1.0 (* 2 3)); %.19f
2105 - limited by =printf= format specified
2106 : | 0.16666666666667 |
2107 : #+TBLFM: $1 = '(/ 1.0 (* 2 3)); %.14f
2109 This FAQ entry is based on this [[http://thread.gmane.org/gmane.emacs.orgmode/22642][mailing list thread]]
2110 and is continued in the [[#table-float-fraction][next FAQ entry]].
2112 ** Which float format shows the fraction part also when the latter is zero?
2114 :CUSTOM_ID: table-float-fraction
2121 : #+TBLFM: $2 = $1; f-3
2124 : #+TBLFM: $2 = $1 +.0; f-3
2128 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]]
2129 in the section Mode Settings -> Display Modes -> Float Formats
2130 [[http://www.delorie.com/gnu/docs/calc/calc_163.html][found here as long as the section numbering is unchanged]].
2132 Remember the formula debugger, toggled with =C-c {=,
2133 to view the processing stages like:
2134 | | formula debugger label | processing stage |
2136 |---+------------------------+----------------------------|
2137 | | Result: | output of Calc |
2138 | | Format: | reformatting with =printf= |
2140 Following are some examples to demonstrate different float formats.
2143 : |-----------+---------+-------+---------+----------+-------|
2144 : | number | f3 | f-3 | +.0; f3 | +.0; f-3 | %.3f |
2145 : |-----------+---------+-------+---------+----------+-------|
2146 : | 1 | 1 | 1 | 1.000 | 1.000 | 1.000 |
2147 : | 0 | 0 | 0 | 0.000 | 0.000 | 0.000 |
2148 : |-----------+---------+-------+---------+----------+-------|
2149 : | 1.0 | 1.000 | 1.000 | 1.000 | 1.000 | 1.000 |
2150 : | 0.0 | 0.000 | 0.000 | 0.000 | 0.000 | 0.000 |
2151 : |-----------+---------+-------+---------+----------+-------|
2152 : | 1.0001666 | 1.000 | 1.000 | 1.000 | 1.000 | 1.000 |
2153 : | 0.0001666 | 1.67e-4 | 0.000 | 1.67e-4 | 0.000 | 0.000 |
2154 : |-----------+---------+-------+---------+----------+-------|
2155 : | 1.0016666 | 1.002 | 1.002 | 1.002 | 1.002 | 1.002 |
2156 : | 0.0016666 | 0.002 | 0.002 | 0.002 | 0.002 | 0.002 |
2157 : |-----------+---------+-------+---------+----------+-------|
2158 : #+TBLFM: $2 = $1; f3 :: $3 = $1; f-3 :: $4 = $1 +.0; f3 :: $5 = $1 +.0; f-3 :: $6 = $1; %.3f
2161 : |----------------------+--------------------------+-----------------------|
2162 : | number | f19 | f-19 |
2163 : |----------------------+--------------------------+-----------------------|
2166 : |----------------------+--------------------------+-----------------------|
2167 : | 1.0 | 1.0000000000000000000 | 1.0000000000000000000 |
2168 : | 0.0 | 0.0000000000000000000 | 0.0000000000000000000 |
2169 : |----------------------+--------------------------+-----------------------|
2170 : | 1 + 1 / 2 * 3 * 1e19 | 1.0000000000000000000 | 1.0000000000000000000 |
2171 : | 0 + 1 / 2 * 3 * 1e19 | 1.666666666666666667e-20 | 0.0000000000000000000 |
2172 : |----------------------+--------------------------+-----------------------|
2173 : | 1 + 1 / 2 * 3 * 1e18 | 1.0000000000000000002 | 1.0000000000000000002 |
2174 : | 0 + 1 / 2 * 3 * 1e18 | 0.0000000000000000002 | 0.0000000000000000002 |
2175 : |----------------------+--------------------------+-----------------------|
2176 : #+TBLFM: $2 = $1; p20 f19 :: $3 = $1; p20 f-19
2178 : |----------------------+--------------------------+-----------------------|
2179 : | number | +.0; f19 | +.0; f-19 |
2180 : |----------------------+--------------------------+-----------------------|
2181 : | 1 | 1.0000000000000000000 | 1.0000000000000000000 |
2182 : | 0 | 0.0000000000000000000 | 0.0000000000000000000 |
2183 : |----------------------+--------------------------+-----------------------|
2184 : | 1.0 | 1.0000000000000000000 | 1.0000000000000000000 |
2185 : | 0.0 | 0.0000000000000000000 | 0.0000000000000000000 |
2186 : |----------------------+--------------------------+-----------------------|
2187 : | 1 + 1 / 2 * 3 * 1e19 | 1.0000000000000000000 | 1.0000000000000000000 |
2188 : | 0 + 1 / 2 * 3 * 1e19 | 1.666666666666666667e-20 | 0.0000000000000000000 |
2189 : |----------------------+--------------------------+-----------------------|
2190 : | 1 + 1 / 2 * 3 * 1e18 | 1.0000000000000000002 | 1.0000000000000000002 |
2191 : | 0 + 1 / 2 * 3 * 1e18 | 0.0000000000000000002 | 0.0000000000000000002 |
2192 : |----------------------+--------------------------+-----------------------|
2193 : #+TBLFM: $2 = $1 +.0; p20 f19 :: $3 = $1 +.0; p20 f-19
2195 The =printf= reformatting (=%.19f=) cannot be used with high precision,
2196 see the [[#table-high-precision][previous FAQ entry]].
2198 ** How can I center tables in LaTeX output?
2200 :CATEGORY: centered-tables-in-latex
2203 Set the `org-export-latex-tables-centered' to `t':
2205 : (defcustom org-export-latex-tables-centered t
2206 : "When non-nil, tables are exported in a center environment."
2207 : :group 'org-export-latex
2212 :CUSTOM_ID: Footnotes
2214 ** How can I get automatic renumbering of footnotes in org-mode?
2216 :CUSTOM_ID: footnote-auto-adjust
2219 You can add the following line to your .emacs file:
2221 : (setq org-footnote-auto-adjust t)
2223 Or, if you prefer, you can turn this option on locally by placing the
2224 following line at the top of your org file:
2226 : #+STARTUP: fnadjust
2228 When auto-adjust is turned on, footnotes in the file with numerical
2229 labels will be renumbered whenever a new footnote is added. Meanwhile,
2230 all footnotes, including those with custom labels such
2231 =[fn:custom-label ]=, will be sorted in the order of their appearance
2234 This emulates the footnote behavior that many users may be familiar
2235 with from word-processing programs or from the footnote-mode included
2238 If you do not turn on org-footnote-auto-adjust, you sort and/or
2239 renumber footnotes at any time by calling org-footnote-action with a
2242 ** Why isn't auto renumbering of footnotes turned on by default?
2244 :CUSTOM_ID: why-no-default-auto-adjust
2247 Org mode has a very robust footnote mechanism allowing for a variety
2248 of types of footnotes. With some of the following footnote notations,
2249 auto-adjust may be either irrelevant or undesired:
2251 - Automatically numbered
2252 - Footnotes with custom labels
2255 In addition, org mode can be customized to place footnotes either at
2256 the end of a document or at the end of the outline heading in which
2257 they appear. Users who change this setting while editing a document
2258 may be disconcerted to find all of their footnotes rearranged
2261 ** I have auto-fill-mode set and org-mode is inserting unwanted comment markers!
2263 :CUSTOM_ID: auto-fill-and-unwanted-comments
2266 If the following occurs:
2271 ,# More entered tex.
2274 Make sure that the variable comment-start is nil.
2276 ** Are there any shortcuts for entering source blocks and comment lines?
2278 :CUSTOM_ID: shortcuts-for-entering-source-blocks
2281 Org mode has some [[http://orgmode.org/manual/Literal-examples.html#Literal-examples][very convenient markup]] for including literal blocks
2282 and lines of code in a file. (This is especially useful when exporting
2283 documents or using the contributed package [[file:org-contrib/babel/index.org][org-babel]] for executing
2288 , print "Hello, world!\n";
2292 It can be tiresome to enter the block comment lines manually. There
2293 are several possible shortcuts you can use to enter them:
2295 1) Built-in expansion
2297 - Org mode has a "secret" method of expanding source code blocks
2300 - If you type "<s" followed by =TAB= or =M-TAB=, a source block will
2303 - For a full list of expansions, type =M-x describe-variable
2304 [RET] org-structure-template-alist=.
2306 2) [[http://orgmode.org/manual/Literal-examples.html#Literal-examples][Registers]]
2308 - Add the following line to your emacs file:
2310 =(set-register ?p "#+begin_src\n\n#+end_src perl")=
2312 - Then type =C-x r i p= to insert the source block. Please note: if
2313 you save another value to the register "p" with =C-x r s p=, it
2314 will overwrite the setting above for the current emacs session.
2316 3) [[http://orgmode.org/manual/Literal-examples.html#Literal-examples][Abbrevs]]
2318 - Activate the abbrev minor-mode in org-mode:
2324 + =(add-hook 'org-mode-hook (lambda () (abbrev-mode 1)))=
2326 - In org-mode, type "sbp" (a sample abbreviation for a perl source
2329 - Immediately after "sbp" type =C-x a i l=.
2331 - Enter the expansion:
2333 - =#+begin_src perl[C-q C-j][C-q C-j]#+end_src=
2335 - Note: =C-q C-j= creates a new line in the minibuffer
2337 - Now, whenever, you type sbp followed by =SPACE= or =RET= in an
2338 org-mode buffer, the src block will magically appear.
2340 - To review your list of abbrevs, type =M-x edit-abbrevs=.
2342 4) [[http://www.slashgear.com/nokia-n900-android-dual-boot-hack-video-2371099/][Skeletons]]
2344 - Skeletons offer a simple way of automatically entering text.
2345 Here's a skeleton that queries for the type of block and wraps
2346 the active region inside it:
2349 (define-skeleton skel-org-block
2350 "Insert an org block, querying for type."
2357 - Simply type skel-org-block to insert the block.
2359 - You can bind this to a key.
2361 - You can also create an abbrev that invokes this function:
2363 : (define-abbrev org-mode-abbrev-table "blk" "" 'skel-org-block)
2365 5) [[http://code.google.com/p/yasnippet/][Yasnippet]]
2367 - Several org-mode users install yasnippet for convenient, complex
2370 - See Bernt Hansen's [[http://doc.norang.ca/org-mode.html#Yasnippets][org-mode setup]] for a good introduction to
2373 * Capture and remember
2375 :CUSTOM_ID: Remember
2377 ** Can I use a variable or a function inside the `org-capture-templates' variable?
2379 :CUSTOM_ID: variable-inside-capture-templates
2382 Yes. Use [[http://www.gnu.org/s/emacs/manual/html_node/elisp/Backquote.html][backquotes]].
2384 E.g. if you have a variable called =org-test-file= and you want the
2385 variable =org-capture-templates= to "understand" (i.e. evaluate)
2386 =org-test-file= when Emacs evaluates the =(setq org-capture-templates
2387 [...])= expression, use backquotes like this:
2389 #+begin_src emacs-lisp
2390 (setq org-capture-templates
2391 `(("t" "Todo" entry (file+headline ,org-test-file "Tasks")
2392 "* TODO %?\n %i\n %a")
2393 ("b" "Buy" item (file+olp ,org-test-file "Stuff to Buy" "House")
2397 ** Can I use the remember buffer to clock a customer phone call?
2399 :CUSTOM_ID: use-remember-buffer-to-clock-phone-call
2402 Yes, you can. Take a look at the [[http://thread.gmane.org/gmane.emacs.orgmode/5482][setup described by Bernt Hansen]]
2403 and check out (in the same thread) what Nick Docos had to fix to
2404 make Bernt's set-up work for him.
2405 ** Can I automatically start the clock when opening a remember template?
2407 :CUSTOM_ID: start-clock-when-opening-remember-template
2410 Yes, this is possible. Use the following code and make sure that
2411 after executing it, `my-start-clock-if-needed' is in
2412 `remember-mode-hook' /after/ `org-remember-apply-template'.
2414 : (add-hook 'remember-mode-hook 'my-start-clock-if-needed 'append)
2415 : (defun my-start-clock-if-needed ()
2417 : (goto-char (point-min))
2418 : (when (re-search-forward " *CLOCK-IN *" nil t)
2419 : (replace-match "")
2422 Then, when a template contains the key string CLOCK-IN, the clock
2423 will be started. Starting with Org-mode version 5.20, the clock will
2424 automatically be stopped when storing the remember buffer.
2428 :CUSTOM_ID: Searches
2430 ** Isearch does not find string hidden in links. What can I do?
2432 :CUSTOM_ID: isearch-in-links
2435 M-x =visible-mode= will display the full link, making them searchable.
2437 ** How can I reduce the amount of context shown in sparse trees?
2439 :CUSTOM_ID: context-in-sparse-trees
2442 Take a look at the following variables:
2444 - =org-show-hierarchy-above=
2445 - =org-show-following-headline=
2446 - =org-show-siblings=
2447 - =org-show-entry-blow=
2449 which give command-dependent control over how much context is shown
2450 by a particular operation.
2452 ** How can I combine the results of two calls to =org-occur=?
2454 :CUSTOM_ID: two-calls-to-org-occur
2457 You can construct a regular expression that matches all targets you
2458 want. Alternatively, use a =C-u= prefix with the second and any
2459 further calls to =org-occur= to keep the current visibility and
2460 highlighting in addition to the new ones.
2466 ** How can I change the advanced warning time for deadlines?
2468 :CUSTOM_ID: warning-period-for-deadlines
2470 ##<<warning-period-for-deadlines>>
2472 Deadline warnings appear in the daily agenda view a specified number
2473 of days before the deadline is due. The default setting is 14 days.
2474 You can change this with the variable =org-deadline-warning-days=.
2475 (See [[http://orgmode.org/manual/Deadlines-and-scheduling.html#Deadlines-and-scheduling][this section]] of the manual.)
2479 : (setq org-deadline-warning-days 30)
2481 would cause warnings for each deadline to appear 30 days in advance.
2483 Naturally, you might not want warnings for all of your deadlines to
2484 appear so far in advance. Thus, you can change the lead time for
2485 individual items as follows:
2487 : * TODO Get a gift for the party
2488 : DEADLINE: <2009-01-16 Fri -2d>
2490 The "-2d" above changes the lead time for this deadline warning to two
2491 days in advance. You can also use "w" for weeks and "m" for months.
2492 ** How can I postpone a task until a certain date?
2494 :CUSTOM_ID: deferring-tasks
2497 The easiest way to postpone a task is to schedule it in the future.
2498 For instance, typing =C-c C-s +2w= on a headline will push a task two
2499 weeks into the future, so that it won't show up on the daily agenda
2500 until two weeks from now.
2502 If you'd like to prevent the task from showing up on your global todo
2503 list, you have a couple of options.
2505 1. You can set the variable =org-agenda-todo-ignore-scheduled= to =t=.
2506 This will exclude any scheduled items from your global list of
2507 active todos (=C-c a t=). (The variable
2508 =org-agenda-todo-ignore-with-date= will exclude both scheduled and
2509 deadline items from your todo list).
2510 2. You can remove the todo keyword from the item (C-c C-t <SPC>). The
2511 item will still appear on your agenda two weeks from today, but it
2512 won't show up on your todo lists.
2513 ** Can I send myself an email containing tasks or other agenda info?
2515 :CUSTOM_ID: email-containing-tasks-or-other-agenda-info
2518 Yes. See [[http://article.gmane.org/gmane.emacs.orgmode/6112][this thread]] on the list.
2520 ** How can I limit the agenda view to my "work" tasks?
2522 :CUSTOM_ID: limit-agenda-with-tag-filtering
2525 It is often convenient to group org files into separate categories,
2526 such as "home" and "work" (or "personal" and "professional"). One
2527 of the main reasons for such classification is to create agenda
2528 views that are limited by type of work or area of responsibility.
2529 For instance, while at work, one may want to see only professional
2530 tasks; while away from work, one may want to see only personal
2533 One way to categorize files and tasks is to use a "#+FILETAGS"
2534 declaration at the top of each file, such as:
2538 As long as org-use-tag-inheritance is turned on, the filetags will
2539 be inherited by all tasks in the file. A file can have multiple
2540 filetags. And, of course, tags can be added to individual headings.
2542 Tasks can be quickly filtered by tag from within the agenda by
2543 typing "/" and the name of the tag. The full key sequence to filter
2544 for work items in an agenda view would be:
2546 : C-c a a / work [or a tag shortcut]
2548 ** How can I limit the agenda view to a particular category?
2550 :CUSTOM_ID: limit-agenda-with-category-match
2553 Another way to filter agenda views by type of work is to use a
2554 "#+CATEGORY" declaration at the top of each file, such as:
2558 Categories can also be added to individual headings within a file:
2565 All todos belonging to the category "work" can be found a with a
2566 simple tags-todo search:
2570 At the prompt, type:
2574 The same results can be achieved with custom agenda commands, such as:
2576 #+BEGIN_SRC emacs-lisp
2577 (setq org-agenda-custom-commands
2578 '(("h" tags-todo "CATEGORY=\"home\"")
2579 ("w" tags-todo "CATEGORY=\"work\"")
2580 ;; other custom agenda commands here
2584 ** How can include all org files in a directory in my agenda?
2586 :CUSTOM_ID: set-agenda-files-using-wildcards
2589 You can simply include the directory (as one of the items) in the
2590 value of the variable org-agenda-files:
2592 : (setq org-agenda-files '("/my/special/path/org/"))
2594 There is another way of accomplishing the same end:
2596 : (setq org-agenda-files (file-expand-wildcards "/my/special/path/org/*.org"))
2598 ** Why aren't items disappearing from my agenda once they are marked done?
2600 :CUSTOM_ID: removing-done-items-from-agenda
2603 If items remain on your daily/weekly agenda after they are marked
2604 done, check the configuration of the following variables:
2606 : org-agenda-skip-scheduled-if-done
2607 : org-agenda-skip-deadline-if-done
2608 : org-agenda-skip-timestamp-if-done
2612 : M-x customize-variable RET org-agenda-skip-scheduled-if-done
2614 If this variable is turned off (=nil=), then scheduled items will
2615 remain on the agenda even after they are marked done.
2617 If the variable is turned on (=t=), then scheduled items will
2618 disappear from the agenda after they are marked done.
2620 If these settings seem not to behave the way you expect, then make
2621 sure you understand [[scheduled-vs-deadline-vs-timestamp][the
2622 difference between SCHEDULED, DEADLINE, and timestamps]].
2624 ** How do I keep repeating timestamps from being displayed multiple times?
2626 :CUSTOM_ID: repeating-timestamps-show-once
2629 To show only the /current/ instance of a repeating timestamp, put the
2630 following in your .emacs:
2632 #+begin_src emacs-lisp
2633 (setq org-agenda-repeating-timestamp-show-all nil)
2636 ** What is the difference between SCHEDULED, DEADLINE, and plain timestamps?
2638 :CUSTOM_ID: scheduled-vs-deadline-vs-timestamp
2641 1. SCHEDULED items (set with =C-c C-s=) will appear on your agenda on
2642 the day they are scheduled and on every day thereafter until they
2643 are done. Schedule a task if you want to be reminded to do
2644 something beginning on a certain day and until it is done.
2646 : ** TODO Scheduled item
2647 : SCHEDULED: <2009-03-01 Sun>
2649 2. Items with a DEADLINE timestamp (set with =C-c C-d=) appear on your
2650 agenda in advance of the when they are due and remain on your
2651 agenda until they are done. Add a DEADLINE to an item if you want
2652 to make sure to complete it by a certain date. (The variable
2653 org-deadline-warning-days determines how far in advance items with
2654 deadlines will show up in the agenda. See [[warning-period-for-deadlines][this FAQ]] for more
2657 : ** TODO Item with a deadline
2658 : DEADLINE: <2009-01-20 Tue>
2660 3. An active timestamp (set with =C-c .=) will appear on your agenda
2661 only on the day it is scheduled. Use a timestamp for appointments
2662 or any reminders you want to show up only on a particular day.
2664 : ** TODO Item with an active timestamp
2667 Note: items with inactive timestamps (set with C-c ! and marked by
2668 square brackets) will not show up in the agenda at all.
2670 ** Can I add files recursively to my list of agenda files?
2672 :CUSTOM_ID: set-agenda-files-recursively
2675 Yes, you can use the library "find-lisp."
2677 : (load-library "find-lisp")
2678 : (setq org-agenda-files (find-lisp-find-files "~/org" "\.org$"))
2680 This will add all files ending in =org= in the directory "~/org"
2681 and all of its subdirectories to your list of agenda files.
2683 If on a *nix machine, you can also use the find utility, which can be
2684 faster than the find-lisp library:
2686 : (setq org-agenda-files
2687 : (mapcar 'abbreviate-file-name
2689 : (shell-command-to-string "find ~/org -name \"*.org\"") "\n")))
2692 See [[http://thread.gmane.org/gmane.emacs.orgmode/8992][this thread]] on the mailing list for more information.
2694 ** Why does an item appearing at the wrong time of day in my agenda?
2696 :CUSTOM_ID: agenda-wrong-time-of-day
2699 When preparing the agenda view, org-mode scans each relevant headline
2700 for a time designation. This approach is very nice for adding
2701 free-form timestamps to an item for scheduling. Thus, either of the
2702 following work would work to schedule an item at 10:00am:
2705 ,** 10:00am Get dried ice at the magic store
2706 , SCHEDULED: <2009-05-27 Wed>
2710 ,** Get dried ice at the magic store
2711 , SCHEDULED: <2009-05-27 Wed 10:00>
2714 To enable this flexibility, org-mode scans the entire headline for
2715 time of day notation. A potential problem can arise if you use
2716 inactive timestamps in the headline to note when an item was created.
2720 ,** Get dried ice at the magic store [2009-05-26 Tue 12:58]
2721 , SCHEDULED: <2009-05-27 Wed>
2724 Org mode would interpret the time in the inactive timestamp as a
2725 time-of-day indicator and the entry would appear in your agenda at
2728 If you would like to turn off the time-of-day search, you can
2729 configure the variable =org-agenda-search-headline-for-time= (requires
2732 ** How can I change the visibility of an item from the agenda?
2734 :CUSTOM_ID: cycling-visibility-from-agenda
2737 You can add a keybinding as follows:
2739 #+begin_src emacs-lisp
2740 (add-hook 'org-agenda-mode-hook
2742 (define-key org-agenda-mode-map " " 'org-agenda-cycle-show)))
2745 Then, as you press SPACE on an item on the agenda, it will cycle the
2746 visibility of its original location.
2748 ** Is there any way to set org-mode so that tags don't appear in the agenda view?
2750 See the =org-agenda-remove-tags= variable.
2752 ** I work late at night! How can I extend my current day past midnight?
2754 :CUSTOM_ID: org-extend-today-until
2757 If you work past midnight, you may not want your daily agenda view to
2758 switch to the next day at 12 a.m. (the default). To extend your day,
2759 simply set the value of org-extend-today-until to a positive number
2760 corresponding to the number of hours you work past midnight. For
2761 example, the following setting will cause the current day to extend
2764 : (setq org-extend-today-until 6)
2766 * Appointments/Diary
2768 :CUSTOM_ID: Appointments/Diary
2770 ** Is it possible to include entries from org-mode files into my emacs diary?
2772 :CUSTOM_ID: include-entries-from-org-mode-files-into-emacs-diary
2775 Since the org-mode agenda is much more powerful and can contain the
2776 diary, you should think twice before deciding to do this. If you
2777 insist, however, integrating Org-mode information into the diary is
2778 possible. You need to turn on /fancy diary display/ by setting in
2781 : (add-hook 'diary-display-hook 'diary-fancy-display)
2783 Then include the following line into your ~/diary file, in
2784 order to get the entries from all files listed in the variable
2789 You may also select specific files with
2791 : &%%(org-diary) ~/path/to/some/org-file.org
2792 : &%%(org-diary) ~/path/to/another/org-file.org
2794 If you now launch the calendar and press ~d~ to display a
2795 diary, the headlines of entries containing a timestamp, date range,
2796 schedule, or deadline referring to the selected date will be listed.
2797 Just like Org-mode's agenda view, the diary for /today/ contains
2798 additional entries for overdue deadlines and scheduled items. See
2799 also the documentation of the =org-diary= function. Under XEmacs, it
2800 is not possible to jump back from the diary to the org, this works
2801 only in the agenda buffer.
2802 ** I want to add my Org scheduled/deadlined entries in my diary!
2804 :CUSTOM_ID: add-Org-scheduled/deadlined-entries-to-diary!
2807 Put this in your ~/.diary:
2809 : &%%(org-diary :scheduled :timestamp :deadline)
2811 ** How can I set up automatic reminders based on Org information?
2813 :CUSTOM_ID: automatic-reminders
2816 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]].
2817 ** How can I make =appt= notice my Org appointments?
2819 :CUSTOM_ID: appt-notice-my-Org-appointments
2822 : M-x org-agenda-to-appt RET
2824 ** How can I create more complex appointments in my org-files?
2826 :CUSTOM_ID: diary-sexp-in-org-files
2829 Org-mode's active timestamps work very well for scheduling individual
2830 or recurring appointments, such as:
2833 ,* 8:00am Dentist appointment <2009-01-16 Fri>
2839 , <2009-03-20 Fri>--<2009-04-01 Wed>
2845 ,* Weekly meeting with boss
2846 , <2009-01-20 Tue 14:00 +1w>
2849 Sometimes, however, you need to set up more complicated recurring
2850 appointments. Org-mode has built-in support for many of
2851 [[http://www.gnu.org/software/emacs/manual/html_node/emacs/Sexp-Diary-Entries.html][the
2852 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
2853 instance, that you teach a class that meets every Monday evening
2854 between February 16 and April 20, 2009. The way to enter this an
2858 ,** Class 7:00pm-9:00pm
2859 , <%%(and (= 1 (calendar-day-of-week date)) (diary-block 2 16 2009 4 20 2009))>
2862 The expression above designates all Mondays that fall between February
2863 16 and April 20. How exactly does it work?
2865 - (and... :: Indicates that *both* of the conditions that follow have
2868 - (= 1 (calendar-day-of-week date)) :: Is the day of the week a
2871 - Note: the function calendar-day-of-week converts the date to the day of week
2872 expressed in numeric form, where 0 = Sunday, 1 = Monday, and so on.
2874 - (diary-block 2 16 2009 4 20 2009) :: Does the date fall between
2877 You can make a sexp as complex as you like. If you wanted to omit a
2878 week because of holidays, for instance, you could add another
2879 condition to the sexp:
2882 ,** Class 7:00pm-9:00pm
2883 , <%%(unless (diary-block 3 9 2009 3 13 2009) (and (= 1 (calendar-day-of-week date)) (diary-block 2 16 2009 4 20 2009)))>
2886 The sexp above would omit Monday during the week of March 9, 2009. For
2887 another way to accomplish the same thing, see [[org-diary-class][this FAQ]].
2889 Another diary function commonly used for more complex scheduling is
2890 diary-float. For instance,
2894 , <%%(diary-float t 3 3)>
2897 ...would appear on the third Wednesday of every month.
2899 For more ideas on how to create diary special expressions, see [[http://www.emacswiki.org/cgi-bin/wiki/DiaryMode][this
2900 page on the Emacs wiki]].
2902 ** How can I schedule a weekly class that lasts for a limited period of time?
2904 :CUSTOM_ID: org-diary-class
2907 Org-mode offers a convenient diary sexp function for setting up a
2908 recurring appointment that lasts for a certain period of time, such as
2909 a class. It is called org-diary-class and it can be entered as
2913 ,** Class 7:00pm-9:00pm
2914 , <%%(org-diary-class 2 16 2009 4 20 2009 1 10)>
2917 The function above schedules an appointment for every Monday (1)
2918 between February 16 and April 20, 2009, except for ISO week 10 (March
2921 If you would prefer not to place the timestamp in the headline, you
2922 can use the following format:
2926 ,%%(org-diary-class 2 16 2009 4 20 2009 1 10) 7:00pm-9:00pm Class
2930 In this case, the string following the sexp will be displayed in the
2933 The function org-diary-class has the following format:
2935 : (org-diary-class M1 D1 Y1 M2 D2 Y2 DAYNAME &rest SKIP-WEEKS)
2937 M1/2, D1/2, and Y1/2 indicate the beginning and ending dates. Dayname
2938 takes the form of a number indicating the day of the week (0 = Sunday,
2939 1 = Monday, and so on...). In addition, one can add an optional
2940 argument SKIP-WEEKS to indicate weeks on the calendar that should be
2941 skipped. This argument should be expressed as an ISO week number. You
2942 can find the number by invoking emacs' built-in calendar (=M-x
2943 calendar=), navigating to the appropriate week, and typing =p c=
2944 (calendar-iso-print-date).
2946 Please note: the order of the month, day, and year arguments depends
2947 on the variables =calendar-date-style= and/or
2948 =european=calendar=style=. (See the documentation for these variables
2949 with C-h v or M-x describe variable.) For instance, the example above
2950 works if =calendar-date-style= is set to ='american=. If
2951 =calendar-date-style= is set to ='iso=, then the arguments to the
2952 org-diary-class sexp would have the following format:
2954 : (org-diary-class Y1 M1 D1 Y2 M2 D2 DAYNAME &rest SKIP-WEEKS)
2956 Here is an alternative method, shared by Paul Sexton on the org
2959 Let's say you are taking night classes in Spanish. The class is every
2960 Wednesday evening at 7pm, starting on 18 August, and runs for 8 weeks.
2961 Org-mode's timestamps do not support limited occurrences of recurrent
2962 items -- you have to schedule the item with infinite recurrences, then
2963 delete it when it finishes.
2965 To schedule the Spanish classes, put the following in your =.emacs=:
2967 #+begin_src emacs-lisp
2968 (defun diary-limited-cyclic (recurrences interval m d y)
2969 "For use in emacs diary. Cyclic item with limited number of recurrences.
2970 Occurs every INTERVAL days, starting on YYYY-MM-DD, for a total of
2971 RECURRENCES occasions."
2972 (let ((startdate (calendar-absolute-from-gregorian (list m d y)))
2973 (today (calendar-absolute-from-gregorian date)))
2974 (and (not (minusp (- today startdate)))
2975 (zerop (% (- today startdate) interval))
2976 (< (floor (- today startdate) interval) recurrences))))
2978 The item in the org file looks like this:
2981 ,** 19:00-21:00 Spanish lessons
2982 , <%%(diary-limited-cyclic 8 7 8 18 2010)>
2985 ** How can I set an event to occur every day except Saturday and Sunday?
2989 , <%%(memq (calendar-day-of-week date) '(1 2 3 4 5))>
2992 ** How do I schedule events relative to Easter Sunday?
2994 Easter's date moves around from year to year according to a
2995 complicated set of criteria which I do not claim to understand.
2996 However the following code will allow you to schedule recurring
2997 events relative to Easter Sunday.
2999 Note: the function da-easter is from:
3000 http://github.com/soren/elisp/blob/master/da-kalender.el
3002 Put the following in your .emacs:
3004 #+begin_src emacs-lisp
3005 (defun da-easter (year)
3006 "Calculate the date for Easter Sunday in YEAR. Returns the date in the
3007 Gregorian calendar, ie (MM DD YY) format."
3008 (let* ((century (1+ (/ year 100)))
3009 (shifted-epact (% (+ 14 (* 11 (% year 19))
3010 (- (/ (* 3 century) 4))
3011 (/ (+ 5 (* 8 century)) 25)
3014 (adjusted-epact (if (or (= shifted-epact 0)
3015 (and (= shifted-epact 1)
3016 (< 10 (% year 19))))
3019 (paschal-moon (- (calendar-absolute-from-gregorian
3022 (calendar-dayname-on-or-before 0 (+ paschal-moon 7))))
3025 (defun da-easter-gregorian (year)
3026 (calendar-gregorian-from-absolute (da-easter year)))
3028 (defun calendar-days-from-easter ()
3029 "When used in a diary sexp, this function will calculate how many days
3030 are between the current date (DATE) and Easter Sunday."
3031 (- (calendar-absolute-from-gregorian date)
3032 (da-easter (calendar-extract-year date))))
3035 Now we can schedule the public holidays associated with Easter as
3036 recurring events. Good Friday is 2 days before "Easter", Easter
3037 Monday is one day after.
3041 , <%%(= -2 (calendar-days-from-easter))>
3044 , <%%(= 0 (calendar-days-from-easter))>
3047 , <%%(= 1 (calendar-days-from-easter))>
3049 [Source: Posted by Paul Sexton on Org-mode mailing list.]
3051 ** How to schedule public holiday that is "the nearest Monday to DATE"?
3053 In New Zealand each regional capital has an "Anniversary Day". The
3054 date of Auckland's anniversary day is "the nearest Monday to 29
3057 Put this in your =.emacs=:
3059 #+begin_src emacs-lisp
3060 (defun calendar-nearest-to (target-dayname target-day target-month)
3061 "Recurring event that occurs in the nearest TARGET-DAYNAME to
3062 the date TARGET-DAY, TARGET-MONTH each year."
3064 (let* ((dayname (calendar-day-of-week date))
3065 (target-date (list target-month target-day (calendar-extract-year date)))
3066 (days-diff (abs (- (calendar-day-number date)
3067 (calendar-day-number target-date)))))
3068 (and (= dayname target-dayname)
3072 Now we can schedule Auckland Anniversary Day. The first argument,
3073 1, means Monday (days of the week are numbered starting with
3076 [Source: Originally posted by Paul Sexton on Org-mode mailing list.]
3078 ** How to schedule public holiday on "the 4th Monday in October"?
3080 This does not require any additions to =.emacs=:
3084 , <%%(diary-float 10 1 4)>
3087 ** Why isn't the agenda showing all the times I put under a single entry?
3089 :CATEGORY: multiple-timestamps-same-entry
3092 Probably because you have not set the following variable:
3094 : org-agenda-skip-additional-timestamps-same-entry
3096 The default value of this variable is t, which means that entries with
3097 multiple timestamps, such as the following...
3100 ,* Work really, really hard
3101 , <2010-11-20 Sat 10:00>
3102 , <2010-11-20 Sat 14:00>
3105 ...will only appear in the agenda at the time specified by the first
3106 timestamp. If you set org-agenda-skip-additional-timestamps-same-entry
3107 to nil, the item will appear will appear at all the times you specify.
3109 ** Can I import iCal events/appts from Gnus?
3111 Yes. Vagn Johansen wrote [[http://ozymandias.dk/emacs/org-import-calendar.el][org-import-calendar.el]] which lets you do this.
3117 ** Can I get TODO items exported to HTML as lists, rather than as headlines?
3119 :CUSTOM_ID: export-TODO-items-as-lists
3122 If you plan to use ASCII or HTML export, make sure things you want to
3123 be exported as item lists are level 4 at least, even if that does
3124 mean there is a level jump. For example:
3126 : * Todays top priorities
3127 : **** TODO write a letter to xyz
3128 : **** TODO Finish the paper
3129 : **** Pick up kids at the school
3131 Alternatively, if you need a specific value for the heading/item
3132 transition in a particular file, use the =#+OPTIONS= line to
3133 configure the H switch.
3135 : #+OPTIONS: H:2; ...
3137 ** Can I export only a single subtree?
3139 :CUSTOM_ID: export-single-subtree
3142 If you want to export a subtree, mark the subtree as region and then
3143 export. Marking can be done with =C-c @ C-x C-x=, for example.
3145 Alternatively, you can select option =1= in the org export dispatcher
3146 (e.g.., =C-c C-e 1 h= to export the current subtree to html).
3148 By default, the title of the exported file will be set to the heading
3149 of the subtree. You can, however, [[#export-options-for-subtree][customize the title and other export
3152 ** How can I customize export options for a single subtree?
3154 :CUSTOM_ID: export-options-for-subtree
3157 You can set unique export options for a [[#export-single-subtree][single subtree]] by using
3158 properties. Relevant properties include:
3164 - EXPORT_OPTIONS (corresponds to the =#+OPTIONS:= [[http://orgmode.org/manual/Export-options.html#Export-options][configuration line]])
3166 ** How can I tell my calendar web application about appointments in my agenda files?
3168 Here is what you need to do:
3170 1. a script that calls Emacs in batch mode and produce a .ics file
3171 2. a script that uploads this .ics file somewhere on the web
3172 3. tell your webapp to fetch this .ics file on the web
3174 Here is the script I use for the first step:
3176 #+begin_src shell-script-mode
3179 /usr/local/bin/emacs --batch --eval \
3180 "(progn (load-file \"~/install/git/org-mode/org.el\") \
3181 (load-file \"~/elisp/config/org-batch-config.el\") \
3182 (setq org-combined-agenda-icalendar-file \"~/org/cal/org.ics\")
3183 (setq org-agenda-files (quote (\"~/org/bzg.org\"))))" \
3184 -f org-export-icalendar-combine-agenda-files
3187 Depending on your configuration, you might change the load sequence.
3189 Here is the script I use for the second step:
3191 #+begin_src shell-script-mode
3193 /usr/bin/rsync -rtv ~/org/org.ics -e ssh me@my_server:/home/me/public_html/
3196 Note: if you want to cron this rsync script, you will need to let
3197 =my_server= to know about your SSH public key. Check [[http://troy.jdmz.net/rsync/index.html][this page]] as a
3200 Now you can cron the two scripts above and your webapp will always be
3201 up to date with your Org agendas.
3203 Also see [[http://orgmode.org/org.html#Exporting-Agenda-Views][Exporting agenda views]] from Org manual.
3205 ** How can I get Mac OSX 10.3 iCal to import my Org-exported .ics files?
3207 :CUSTOM_ID: iCal-import-ics-files-old
3210 When using iCal under Apple MacOS X Tiger, you can create a new
3211 calendar /OrgMode/ (the default name for the calendar created by =C-c
3212 C-e c=, see the variables =org-icalendar-combined-name= and
3213 =org-combined-agenda-icalendar-file=). Then set Org-mode to
3214 overwrite the corresponding file /~/Library/Calendars/OrgMode.ics/.
3215 You may even use AppleScript to make iCal re-read the calendar files
3216 each time a new version of /OrgMode.ics/ is produced. Here is the
3217 setup needed for this:
3219 : (setq org-combined-agenda-icalendar-file
3220 : "~/Library/Calendars/OrgMode.ics")
3221 : (add-hook 'org-after-save-iCalendar-file-hook
3224 : "osascript -e 'tell application \"iCal\" to reload calendars'")))
3226 ** How can I get Mac OSX 10.4 or later iCal to import my Org-exported .ics files?
3228 :CUSTOM_ID: iCal-import-ics-files-new
3231 For Mac OS X 10.4, you need to write the ics file to
3232 =/Library/WebServer/Documents/= and then subscribe iCalendar to
3233 =http: //localhost/orgmode.ics=
3235 ** How can I remove timestamps and todo keywords from my exported file?
3237 :CUSTOM_ID: export-options-remove-timestamps
3240 You can place an options line at the top of your org file:
3242 : #+OPTIONS: <:nil todo:nil
3244 There is a whole host of export options you can set with an in-buffer
3245 options or via global variables. See [[http://orgmode.org/manual/Export-options.html#Export-options][this section]] of the manual for a
3248 ** How can I preserve faces when I export an agenda from the command line?
3250 :CUSTOM_ID: preserving-faces-during-batch-export
3253 Normally, when you export an org file or an agenda view from within
3254 emacs, htmlize will convert your face definitions to direct color css
3255 styles inlined into each =<span>= object, resulting in an HTML output
3256 that preserves the general look of your Org buffers and agenda views.
3258 Let's say you generate an export from the command line, such as the
3261 : emacs -batch -l ~/.emacs -eval '(org-batch-agenda "e")'
3265 : emacs -batch -l ~/.emacs -eval '(org-publish-all)'
3267 In such an instance, the exported HTML will contain only very basic
3268 color styles. The reason is that when Emacs is run in batch mode, it
3269 does not have a display and therefore only rudimentary face
3270 definitions. If you'd like to use more complex styles, you'll have to
3271 make sure that the export process only assigns classes instead of
3272 direct color values. This can be done by binding the variable
3273 =org-export-htmlize-output-style= to =css= for the duration of the
3274 export, for example with
3276 : emacs -batch -l ~/.emacs
3277 : -eval '(let ((org-export-htmlize-generate-css (quote css)))
3278 : (org-batch-agenda "e"))'
3280 Then you can use a style file to make these classes look any way you
3281 like. To generate face definitions for a CSS file based on any faces
3282 you are currently using in Emacs, you can use the following command:
3284 : M-x org-export-htmlize-generate-css RET
3286 This will generate a =<style>...</style>= section, the content of
3287 which you can add to your style file.
3289 ** How can I avoid dark color background when exporting agenda to ps format?
3291 :CUSTOM_ID: avoiding-dark-background-when-exporting-agenda
3294 Add this to your .emacs and evaluate it.
3296 #+BEGIN_SRC emacs-lisp
3297 (setq org-agenda-exporter-settings
3298 '((ps-print-color-p 'black-white)))
3301 ** How can I include e.g. an abstract in export to Latex and HTML?
3303 :CUSTOM_ID: include-abstract-in-export-to-latex-and-html
3306 Org does not currently have special markup for abstracts, but for
3307 export purposes, you can extend the block-level structural and
3308 semantic markup in Org with the contributed package [[file:org-contrib/org-special-blocks.org][org-special-blocks]]
3309 (by Chris Gray). To turn it on, put this in your =.emacs=:
3311 : (require 'org-special-blocks)
3313 Now, you can mark up the abstract of your article like this:
3316 : Falling apples were observed and compared with pears. Newton's laws
3317 : were confirmed at the 95% confidence level.
3320 Exporting to Latex wraps this in a
3321 =\begin{abstract}....\end{abstract}= environment, which just works.
3323 HTML export wraps it in a ~<div class="abstract">...</div>~
3324 element. The HTML result won't look like anything special until you
3325 style it. Here is some sample CSS to get you started; put these in
3326 your document header:
3328 : #+STYLE: <style>.abstract {margin: 1em; padding: 1em; border: 1px solid black}
3329 : #+STYLE: .abstract:before {content: "Abstract: "; font-weight: bold}</style>
3331 Generally, =#+begin_foo= will work for any simple Latex =foo=
3332 environment not supported by existing Org markup.
3334 If you need to pass parameters, process the block content in some way,
3335 or support other exporters, you may want to consider whether you can
3336 customize it using Eric Schulte's [[file:org-contrib/org-exp-blocks.org][org-exp-blocks]] instead.
3338 ** How can I get colored source code when exporting to LaTeX?
3340 :CUSTOM_ID: fontified_source_code_w_latex
3343 As of Sun Aug 9 2009 the "current" version of Org-mode (see
3344 [[keeping-current-with-Org-mode-development]]) supports exporting
3345 source code to LaTeX using the listings package.
3347 To turn on listing export add the following to your Org-mode
3349 #+begin_src emacs-lisp
3350 ;; requite org-latex so that the following variables are defined
3351 (require 'org-latex)
3353 ;; tell org to use listings
3354 (setq org-export-latex-listings t)
3356 ;; you must include the listings package
3357 (add-to-list 'org-export-latex-packages-alist '("" "listings"))
3359 ;; if you want colored source code then you need to include the color package
3360 (add-to-list 'org-export-latex-packages-alist '("" "color"))
3363 The listings package will now be used to fontify source code in your
3364 LaTeX documents. By default listings will not color any of your
3365 source code. If you would like to set colors for keywords and
3366 comments in your latex documents you can do so using LaTeX directives
3369 \lstset{keywordstyle=\color{blue},
3370 commentstyle=\color{red},
3371 stringstyle=\color{green}
3375 of if you want to get even fancier with your colors you can try
3376 something like the following
3378 \definecolor{keywords}{RGB}{255,0,90}
3379 \definecolor{comments}{RGB}{60,179,113}
3380 \definecolor{fore}{RGB}{249,242,215}
3381 \definecolor{back}{RGB}{51,51,51}
3383 basicstyle=\color{fore},
3384 keywordstyle=\color{keywords},
3385 commentstyle=\color{comments},
3386 backgroundcolor=\color{back}
3390 For more complex listings use cases consult the [[ftp://ftp.tex.ac.uk/tex-archive/macros/latex/contrib/listings/listings.pdf][listings manual]].
3392 ** How can I export to Latex Beamer
3396 The latex [[http://latex-beamer.sourceforge.net/][Beamer Class]] is a useful class for generating slide shows.
3397 The following can be used to export Org-mode documents to LaTeX
3400 Add the following to your Emacs initialization file.
3401 #+begin_src emacs-lisp
3402 (unless (boundp 'org-export-latex-classes)
3403 (setq org-export-latex-classes nil))
3404 (add-to-list 'org-export-latex-classes
3406 "\\documentclass[11pt]{beamer}\n\\usepackage[utf8]{inputenc}\n\\usepackage[T1]{fontenc}\n\\usepackage{hyperref}\n\\usepackage{verbatim}\n"
3407 ("\\section{%s}" . "\\section*{%s}")
3408 ("\\begin{frame}\\frametitle{%s}" "\\end{frame}"
3409 "\\begin{frame}\\frametitle{%s}" "\\end{frame}")))
3413 : #+LaTeX_CLASS: beamer
3414 in the header of your Org-mode document it will automatically export
3415 to the Beamer document class on LaTeX export. With the above
3416 configuration top-level headers will be mapped to sections in the
3417 Beamer document, second-level headers will be mapped to frames, and
3418 lower level headlines will be mapped to itemize objects.
3420 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
3421 Thomas Dye]]. For a much more complex Beamer setup see the [[http://article.gmane.org/gmane.emacs.orgmode/17767/match=beamer+dokos][email by
3424 ** How can I use RefTeX in Org-mode files for LaTeX export and in Org-babel LaTeX code blocks?
3426 :CUSTOM_ID: using-reftex-in-org-mode
3429 [[http://www.gnu.org/software/auctex/reftex.html][RefTeX]] is an indispensable tool for the author of LaTeX documents. It
3430 aids in creation of bibliographies, cross-references, indexes, and
3431 glossaries. RefTeX understands the structure of multi-file LaTeX
3432 documents and is able to collect from them information about the
3433 location(s) of external data stores used in creation of the final
3434 document. RefTeX was written by Carsten Dominik and is currently
3435 being maintained by the [[http://www.gnu.org/software/auctex/index.html][AucTeX]] project.
3437 *** Using RefTeX In Org-mode Files for LaTeX Export
3438 In Org-mode files for LaTeX export, the trick is to find a way to tell
3439 RefTeX the locations of external data stores. One way is to set the
3440 variable, =reftex-default-bibliography=. Add lines like these to
3443 #+begin_src emacs-lisp
3444 (setq reftex-default-bibliography
3446 ("default.bib" "other-default.bib")))
3449 In practice, this is a limited solution and the
3450 typical user will want to pass this information on a per-file basis.
3451 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
3454 The first solution, proposed by Mario, enables the RefTeX citation
3455 function in Org-mode. Add these lines to .emacs:
3457 #+begin_src emacs-lisp
3458 (defun org-mode-reftex-setup ()
3459 (load-library "reftex")
3460 (and (buffer-file-name)
3461 (file-exists-p (buffer-file-name))
3463 (define-key org-mode-map (kbd "C-c )") 'reftex-citation))
3464 (add-hook 'org-mode-hook 'org-mode-reftex-setup)
3467 Then add the following lines anywhere in the Org-mode file (Org-mode
3468 will recognize them as LaTeX commands):
3471 \bibliographystyle{plain}
3472 \bibliography{BIB-NAME}
3475 With this setup, =C-c )= will invoke =reftex-citation= which will
3476 insert a reference in the usual way:
3481 ,This is a citation \cite{tierney90}.
3483 ,\bibliographystyle{plain}
3487 This Org-mode file will export the following LaTeX output:
3489 #+begin_src latex :exports code
3490 % Created 2010-03-22 Mon 14:34
3491 \documentclass[11pt,letter]{article}
3492 \usepackage[utf8]{inputenc}
3493 \usepackage[T1]{fontenc}
3494 \usepackage{hyperref}
3498 \date{2010-03-22 Mon}
3504 \setcounter{tocdepth}{3}
3508 \section{test reftex}
3512 This is a citation \cite{tierney90}.
3514 \bibliographystyle{plain}
3521 A second solution, to activate the RefTeX minor mode on a per-file
3522 basis, was posted by Kevin Brubeck Unhammer in response to this idea.
3523 Add the following lines to .emacs:
3525 #+begin_src emacs-lisp
3526 (add-hook ‘org-mode-hook
3528 (if (member “WRITE” org-todo-keywords-1)
3529 (org-mode-article-modes))))
3532 where =org-mode-article-modes= is defined as follows:
3534 #+begin_src emacs-lisp
3535 (defun org-mode-article-modes ()
3537 (bib-cite-minor-mode t)
3538 (and (buffer-file-name)
3539 (file-exists-p (buffer-file-name))
3540 (reftex-parse-all)))
3543 Add the =\bibliographystyle{}= and =\bibliography{}= lines to the
3544 Org-mode file as before and define a TODO keyword, =WRITE=, perhaps
3548 ,#+TODO: TODO(t) STARTED(s) WRITE | DONE(d) DEFERRED(f)
3551 With this setup, you insert a citation with =M-x reftex-citation RET=.
3553 *** Using RefTeX in Org-babel LaTeX Code Blocks
3555 In Org-babel LaTeX code blocks, the trick is to give RefTeX access to
3556 information in other Org-babel LaTeX code blocks. If you use an Emacs
3557 starter kit where configuration information is held in Org-mode files,
3558 then the second solution is preferable because you won't be asked for
3559 a master file when Emacs is started. For this reason, the second
3560 solution is modified for use with Org-babel latex code blocks. No
3561 key-binding is needed here because Org-babel code blocks are edited
3562 within the usual AucTeX environment.
3564 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]])
3565 #+begin_src emacs-lisp
3566 (defun org-mode-article-modes ()
3568 (and (buffer-file-name)
3569 (file-exists-p (buffer-file-name))
3570 (reftex-parse-all)))
3572 (add-hook 'org-mode-hook
3574 (if (member "REFTEX" org-todo-keywords-1)
3575 (org-mode-article-modes))))
3578 Then add a line like the following line to the top of your org-mode file:
3581 ,#+TODO: TODO(t) STARTED(s) | DONE(d) DEFERRED(f) REFTEX
3584 When you open an org-mode file with a line like this, RefTeX will
3585 prompt for the master .tex file, which will be parsed in the usual
3586 way. This means that the .tex file should already exist, perhaps by
3587 tangling the LaTeX preamble and postamble, before
3588 =org-mode-article-modes= is activated for the Org-mode file.
3590 ** How can I use XeLaTeX for LaTeX export instead of pdfLaTeX?
3592 :CUSTOM_ID: using-xelatex-for-pdf-export
3594 [[http://en.wikipedia.org/wiki/XeTeX][ XeLaTeX]] is an alternative to pdfLaTeX for typesetting LaTeX
3595 documents. XeTeX can use any fonts installed in the operating system
3596 without configuring TeX font metrics, and can make direct use of
3597 advanced typographic features of OpenType and other font formats. By
3598 default, org-mode exports =org= files to =pdf= via pdfLaTeX.
3600 Here is one way to smoothly incorporate XeLaTeX into org-mode's export
3601 process. This solution takes advantage of [[http://www.phys.psu.edu/~collins/software/latexmk-jcc][latexmk]], a perl script that
3602 intelligently and automatically manages latex compilation. It
3603 is included with TeXLive, but at present the version included is not
3604 quite up-to-date enough for our needs. Version 4.20 and higher
3605 includes an option allowing you to specify which program to use when
3606 "pdflatex" is called. Install a current version of latexmk as per the
3607 instructions on the [[http://www.phys.psu.edu/~collins/software/latexmk-jcc][latexmk]] site. If necessary, disable the older
3608 version that comes with TeXLive. This is likely in =/usr/texbin/=, and
3609 you should rename or remove it. Then you can put the following in your
3610 =~/.emacs.d/= or equivalent:
3612 #+begin_src emacs-lisp
3613 (require 'org-latex)
3614 (setq org-export-latex-listings t)
3616 ;; Originally taken from Bruno Tavernier: http://thread.gmane.org/gmane.emacs.orgmode/31150/focus=31432
3617 ;; but adapted to use latexmk 4.20 or higher.
3618 (defun my-auto-tex-cmd ()
3619 "When exporting from .org with latex, automatically run latex,
3620 pdflatex, or xelatex as appropriate, using latexmk."
3622 ;; default command: oldstyle latex via dvi
3623 (setq texcmd "latexmk -dvi -pdfps -quiet %f")
3625 (if (string-match "LATEX_CMD: pdflatex" (buffer-string))
3626 (setq texcmd "latexmk -pdf -quiet %f"))
3628 (if (string-match "LATEX_CMD: xelatex" (buffer-string))
3629 (setq texcmd "latexmk -pdflatex=xelatex -pdf -quiet %f"))
3630 ;; LaTeX compilation command
3631 (setq org-latex-to-pdf-process (list texcmd)))
3633 (add-hook 'org-export-latex-after-initial-vars-hook 'my-auto-tex-cmd)
3636 ;; Specify default packages to be included in every tex file, whether pdflatex or xelatex
3637 (setq org-export-latex-packages-alist
3639 ("" "longtable" nil)
3642 (defun my-auto-tex-parameters ()
3643 "Automatically select the tex packages to include."
3644 ;; default packages for ordinary latex or pdflatex export
3645 (setq org-export-latex-default-packages-alist
3646 '(("AUTO" "inputenc" t)
3656 ("" "hyperref" nil)))
3658 ;; Packages to include when xelatex is used
3659 (if (string-match "LATEX_CMD: xelatex" (buffer-string))
3660 (setq org-export-latex-default-packages-alist
3665 ("american" "babel" t)
3666 ("babel" "csquotes" t)
3668 ("xetex" "hyperref" nil)
3671 (if (string-match "LATEX_CMD: xelatex" (buffer-string))
3672 (setq org-export-latex-classes
3674 "\\documentclass[11pt,article,oneside]{memoir}"
3675 ("\\section{%s}" . "\\section*{%s}")
3676 ("\\subsection{%s}" . "\\subsection*{%s}")
3677 ("\\subsubsection{%s}" . "\\subsubsection*{%s}")
3678 ("\\paragraph{%s}" . "\\paragraph*{%s}")
3679 ("\\subparagraph{%s}" . "\\subparagraph*{%s}"))
3680 org-export-latex-classes))))
3682 (add-hook 'org-export-latex-after-initial-vars-hook 'my-auto-tex-parameters)
3685 The =my-auto-tex-cmd= function looks at your =.org= file and checks
3686 whether you've specified which latex to use. If there are no
3687 instructions, it just runs regular old latex. If it finds the string
3688 =LATEX_CMD: pdflatex= in your file, it runs pdflatex. If it finds
3689 =LATEX_CMD: xelatex=, it runs xelatex. Because control is handed off
3690 to latexmk, nothing else is needed: it takes care of figuring things
3691 out so that the references and citations are correct.
3693 The second half of the code above specifies the latex packages that
3694 will be included in the =.tex= file. The variable
3695 =org-export-latex-packages-alist= specifies a list of packages that
3696 are always included in the header of latex documents, regardless of
3697 how they are compiled. The variable
3698 =org-export-latex-default-packages-alist= adds additional packages
3699 depending on whether latex/pdflatex or xelatex is being used. You can
3700 change the content of these as needed.
3702 Finally, the =org-export-latex-classes= variable redefines elements of
3703 the =.tex= file's preamble for the xelatex case. These can also be
3704 customized as needed.
3706 By way of example, an =.org= file you want compiled with xelatex might
3707 contain the following header:
3710 : #+AUTHOR: Jane Doe
3712 : #+OPTIONS: toc:nil num:nil
3713 : #+LATEX_CMD: xelatex
3714 : #+LATEX_HEADER: \setsansfont[Mapping=tex-text]{Unit-Bold}
3715 : #+LATEX_HEADER: \setmonofont[Mapping=tex-text,Scale=MatchLowercase]{PragmataPro}
3716 : #+LATEX_HEADER: \setromanfont[Mapping=tex-text,Numbers=OldStyle]{Minion Pro}
3718 If you always want to have the same font setup in your xelatex
3719 documents, the =fontspec= commands setting the font choices can be
3720 put in the =org-export-latex-classes= setting instead.
3722 The upshot is that when you want to export an =.org= file using
3723 XeLaTeX, you can now simply make sure the line =LATEX_CMD: xelatex= is
3724 in your =.org= file, then do =C-c C-e d= as usual, and org-mode, with
3725 latexmk in the background, does the rest for you.
3727 ** Why is my exported PDF file almost unreadable?
3729 :CUSTOM_ID: unreadable-pdfs
3732 Some PDF viewers (earlier versions (< v6) of Acrobat Reader, Evince,
3733 possibly others) do not get along with Adobe Type3 fonts, producing
3734 almost unreadable screen output (printed output is OK). If you see
3735 this, first verify the fonts that your document uses: open it with
3736 Acrobat Reader or Evince, select "Properties" from the "File" menu and
3737 click on the "Fonts" tab; alternatively, you can use the pdffonts
3738 program (part of the xpdf-reader package) from the command line. If
3739 that is indeed the problem, then either use a different viewer or
3740 install Type1 versions of the problematic fonts. For more details, see
3741 the "PDF export" section of [[./org-dependencies.org][org-dependencies]].
3743 ** Can I add attributes to a link or an image in HTML export?
3745 :CUSTOM_ID: html-image-and-link-attributes
3748 Yes. Excerpt from [[http://orgmode.org/manual/Images-in-HTML-export.html#Images-in-HTML-export][Org's manual]]:
3750 If you need to add attributes to an inlined image, use a `#+ATTR_HTML'.
3751 In the example below we specify the `alt' and `title' attributes to
3752 support text viewers and accessibility, and align it to the right.
3754 : #+CAPTION: A black cat stalking a spider
3755 : #+ATTR_HTML: alt="cat/spider image" title="Action!" align="right"
3758 and you could use `http' addresses just as well.
3760 ** How can I export an org file to rtf, odt (Open Office), or doc (Word)?
3762 :CUSTOM_ID: convert-to-open-office
3765 Orgmode exports natively to =OpenDocument= format using =org-odt=
3768 The key bindings for export are =C-c C-e o= and =C-c C-e O=.
3770 If you don't see =OpenDocumentText= as an option under =C-c C-e= you
3771 need to upgrade to =Org-mode 7.6= by one of the following means:
3773 1. Install org-7.6 using a distribution .zip or .tar.gz file, or
3774 through Git. Then do the following:
3775 1. Add =contrib/lisp= to the load-path in your =.emacs=
3776 #+begin_src emacs-lisp
3777 ;; modify org-root-dir as needed
3778 (add-to-list 'load-path "org-root-dir/contrib/lisp")
3780 2. Do =M-x customize-variable RET org-modules RET= and enable the
3783 2. Upgrade to (atleast) the =Emacs-24.1 pretest= version. Install
3784 =org-odt= package using =M-x list-packages=.
3788 - Use existing exporters
3790 Export to one of org-mode's supported export formats and then use an
3791 external tool or method to convert the exported file to doc or odt.
3793 With simple documents, these methods work well. However for complex
3794 documents containing footnotes, embedded images, math formuale etc
3795 the results may be less than satisfactory. (Note, the lists below
3796 are by no means comprehensive).
3797 1. html -> odt/doc/rtf
3798 - open html in Open Office and save as odt/doc ([[http://permalink.gmane.org/gmane.emacs.orgmode/31482][see this post by
3800 - [[http://www.artofsolving.com/opensource/pyodconverter][PyODConverter]]
3801 - [[http://johnmacfarlane.net/pandoc/][Pandoc]] (this works for LaTeX and docbook as well)
3802 - (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
3804 2. LaTeX -> odt/doc/rtf
3805 - [[http://latex2rtf.sourceforge.net/][LaTeX2rtf]] (works well with index, footnotes, and references)
3806 - [[http://www.tug.org/tex4ht/][TeX4ht]] (works with more complex latex elements, though can be
3807 difficult to install)
3808 - run =mk4ht oolatex file.tex=
3810 See [[http://permalink.gmane.org/gmane.emacs.orgmode/31168][this thread]] for further details.
3813 ** I cannot open an exported =*.odt= file in LibreOffice because it is corrupt. What do I do?
3815 :CUSTOM_ID: debugging-org-odt
3818 Typically the corruption of =odt= file happens when the XML emitted by
3819 Org is not well-formed according to =OpenDocument schema=.
3821 If you encounter corruption issues please identify the root cause as
3824 1. Switch to =*.odt= buffer =(C-x b whatever.odt)=
3825 2. Open the =content.xml= file - =(Hit RET on content.xml)=
3826 3. Do a =C-u C-c C-n= - =(M-x rng-first-error)=
3827 4. Note the error message, the XML markup at the point of error and
3828 the surrounding context.
3829 5. Create a minimal org file that reproduces the error in =step 4=.
3830 6. Post a bug-report to =emacs-orgmode@gnu.org=
3834 Since =org= files are so central to your life, you probably want to back
3835 them up in a safe place.
3837 If the =org= file you want to back up are in a single directory, the
3838 preferred method is to us a =RCS= (Revision Control System) -- pick up your
3839 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
3840 RCS you use and how you use it, you can have a /local/ backup or sync it on
3843 If you want to store all your =org= files from your =$HOME= to a single
3844 =~/org/backup/= folder, you can use this shell script (as [[http://article.gmane.org/gmane.emacs.orgmode/37655][suggested by
3848 mkdir -p ~/org/backup && \
3849 find $HOME -type f -name '*\.org' ! -path "$HOME/org/*" \
3850 -exec cp -t ~/org/backup/ \{\} \;
3853 It will recursively search for =org= files in your =$HOME= directory
3854 (except those in =~/org/backup/=) and copy them to =~/org/backup/=.
3855 You can then use rsync to make sure =~/org/backup/= also lives on a
3856 remote and safe place.
3860 ** Which versions of MobileOrg do exist
3862 :CUSTOM_ID: mobileorg_versions
3865 - MobileOrg for the iPhone/iPod Touch/iPad series of devices, by
3866 Richard Moreland. Check out
3867 [[http://mobileorg.ncogni.to/][Richard's page]]
3868 - Matt Jones is developing a feature-equivalent application for
3870 [[http://wiki.github.com/matburt/mobileorg-android/][his project page]].
3872 ** What can I do if I don't want to use Dropbox.com
3874 :CUSTOM_ID: mobileorg_webdav
3877 Dropbox.com is the easiest way to connect between Emacs and MobileOrg,
3878 you can get a free account there. If for some reason you cannot or do
3879 not want to use this path, you can use any webdav server. On this
3880 webdav server you need to create a dedicated directory for the
3881 communication between Emacs and MobileOrg. If you can mount that
3882 directory locally so that Emacs can directly write to it, just point
3883 to that directory using the variable =org-mobile-directory=. Using
3884 the /tramp/ method, =org-mobile-directory= may point to a remote
3885 directory accessible through, for example, /ssh/ and /scp/:
3887 #+begin_src emacs-lisp
3888 (setq org-mobile-directory "/scpc:user@@remote.host:org/webdav/")
3891 If Emacs cannot access the WebDAV directory directly using a /tramp/
3892 method, you can use a local directory for staging. Other means must
3893 then be used to keep this directory in sync with the WebDAV directory.
3894 In the following example, files are staged in =~/stage/=, and Org-mode
3895 hooks take care of moving files to and from the WebDAV directory using
3898 #+begin_src emacs-lisp
3899 (setq org-mobile-directory "~/stage/")
3900 (add-hook 'org-mobile-post-push-hook
3901 (lambda () (shell-command "scp -r ~/stage/* user@@wdhost:mobile/")))
3902 (add-hook 'org-mobile-pre-pull-hook
3903 (lambda () (shell-command "scp user@@wdhost:mobile/mobileorg.org ~/stage/ ")))
3904 (add-hook 'org-mobile-post-pull-hook
3905 (lambda () (shell-command "scp ~/stage/mobileorg.org user@@wdhost:mobile/")))
3910 ** How to install MathJax on my server?
3913 :CUSTOM_ID: install_mathjax_on_server
3916 Org uses MathJax as its default HTML display engine for equations.
3918 Org relies on the version of MathJax available from orgmode.org, but you
3919 might want to use another version and install MathJax on your own server.
3921 1. Download a [[http://sourceforge.net/projects/mathjax/files/][MathJax archive]].
3923 2. Upload it somewhere on your server (say http://me.org/mathjax/)
3925 3. Set the correct path in =org-export-html-mathjax-options= (i.e. replace
3926 http://orgmode.org/mathjax/MathJax.js by
3927 http://me.org/mathjax/MathJax.js)
3929 You can also get [[http://www.mathjax.org/resources/docs/?installation.html][MathJax from git or svn]] -- in this case, be careful not to
3930 forget to unzip the fonts.zip archive in the mathjax directory.
3933 ** Problems with LaTeX macros with #+latex or #+begin_latex
3935 :CUSTOM_ID: Problems-with-LaTeX-macros-with-#+latex-or-#+begin_latex
3937 Org's LaTeX exporter has a difficult job on its hands and even though
3938 it does a great job most of the time, there are times when it falls
3939 short. One situation that has arisen a few times in the past is when a
3940 macro definition or use includes an opening brace, but the
3941 corresponding closing brace is on a different line. That has caused
3942 LaTeX compilation problems or mysterious excisions of content - see
3943 for example the following two threads in the mailing list:
3945 - http://thread.gmane.org/gmane.emacs.orgmode/39308
3947 - http://thread.gmane.org/gmane.emacs.orgmode/42196
3949 In both cases, the exporter was getting confused by the opening brace
3950 which did not have a corresponding closing brace on the same
3951 line. Although the first of these cases is fixed in current Org, there
3952 might be more such cases or there might be a regression which causes
3953 the incorrect behavior again. While waiting for a fix, it's worth
3954 trying out the simple workaround of including a fake closing brace on
3955 the same line as the opening brace but *commenting it out* so that
3956 LaTeX never sees it. That is often enough to make the exporter behave
3957 properly. In other words, to take one of the examples above, instead
3960 : #+latex: \custommacro {
3964 use the following idiom instead:
3966 : #+latex: \custommacro { % hide the closing brace in a LaTeX comment }
3970 I emphasize that this is a workaround, not a fix: if you do run into such
3971 a case and the workaround fixes it, at least you can continue working, but
3972 please submit a bug report so that it can be fixed properly.
3974 ** Inserting a Mairix type link when calling Orgmode capture in VM
3976 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
3979 * COMMENT Function to create =CUSTOM_ID=
3981 #+begin_src emacs-lisp
3982 (defun org-faq-make-target ()
3983 "Make hard target for current headline."
3985 (if (not (org-on-heading-p))
3986 (error "Not on a headline"))
3987 (let ((h (org-trim (org-get-heading 'no-tags))))
3988 (if (string-match "[ \t]*\\?\\'" h)
3989 (setq h (replace-match "" t t h)))
3990 (while (string-match "[ \t]+" h)
3991 (setq h (replace-match "-" t t h)))
3992 (org-entry-put nil "CUSTOM_ID" h)))