1 #+EMAIL: carsten.dominik@gmail.com
4 #+TITLE: Org-mode Frequently Asked Questions
8 <style type="text/css">
9 <!--/*--><![CDATA[/*><!--*/
14 -webkit-box-shadow: 0 0 0 0;
15 -moz-box-shadow: 0 0 0 0;
16 -webkit-border-bottom-left-radius: 0;
17 -moz-border-radius-bottomleft: 0;
21 #table-of-contents h2 {
29 #table-of-contents #text-table-of-contents {
32 #table-of-contents:hover #text-table-of-contents {
40 [[file:index.org][{Back to Worg's index}]]
44 :CUSTOM_ID: What-is-org-mode
46 ** Can I implement a GTD workflow with Org-mode?
48 :CUSTOM_ID: GTD-workflow-with-Org-mode
51 Yes, you can. Check for discussions and pointers [[http://orgmode.org/worg/org-gtd-etc.html][here]].
53 ** What is the difference between Org and TaskPaper?
55 :CUSTOM_ID: Org-and-TaskPaper
58 There is really no difference. Org is as /simple/ as [[http://hogbaysoftware.com/products/taskpaper][TaskPaper]]. It
59 is just that, when using Org within Emacs, it lets you do many things
60 that you wouldn't be able to do with TaskPaper. Yes, TaskPaper is
61 fiddle-proof and people using Emacs tends to like fiddling (which is
62 orthogonal to the idea of using todo-list efficiently), but this is
63 just a matter of discipline and common sense, not one of Org's design.
65 Read [[http://article.gmane.org/gmane.emacs.orgmode/6224][Carsten's enlightening statement]] on this.
66 ** What is the meaning of the Unicorn on Org's website?
71 The Unicorn is the logo of Org-mode because:
73 - Org-mode is the UNICs of ORgaNizers.
75 - Org-mode is an Emacs mode, so it makes sense to use an animal
76 similar or related to the gnu used for GNU Emacs.
78 - Org-mode is meant to show you the way, and an animal with two horns
79 can not do this very well, can it?
81 - Unicorn tears are said to reverse petrification, and wasn't this how
82 we all felt before getting to some degree of time and task
85 - It will take forever to learn everything there is to know about a
88 - A unicorn is a fabulous creature. Org-mode wants to be a fabulous
91 Using a unicorn was originally /Bastien Guerry's/ idea, his friend
92 /Christophe Bataillon/ designed the logo for us, and /Greg Newman/
93 gave it a refresh some time later. Bastien writes why he chose a
97 The first reason is not linked to the animal, but to the sounding of the
98 word "Unicorn" - because Org gives you a /uni/que way of producing files
99 in several format (HTML, LaTeX, etc.)
101 The second reason is that a Unicorn doesn't really exist, it is just
102 something you can dream about, and make others believe it does exist.
103 Just like the perfect organizer.
106 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
107 Suckling]] posted a link showing how to make a simple foldable unicorn
108 (very appropriate for an outlining program!).
110 [[http://article.gmane.org/gmane.emacs.orgmode/11735][Tim Burt]] made a very complicated one which is now a treasured
111 possession of the Org-mode author.
113 - Official logo: [[http://orgmode.org/img/org-mode-unicorn.png]]
114 This logo is available in a number of different formats including
115 Photoshop /.psd/ and scaleable vector graphics /.svg/ [[http://orgmode.org/img/][here]].
117 - An [[http://orgmode.org/img/nrocinu4.jpg][alternative version]] from Christophe Bataillon (c):
119 - [[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]]:
121 - [[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
122 threshold technique".
124 - [[http://article.gmane.org/gmane.emacs.orgmode/11735/match%3D][Tim Burt]] made a folded Unicorn to match the spirit of Org - see the
125 whole set of pictures [[http://www.flickr.com/photos/tcburt/sets/72157614543357071/][on his flickr page]].
127 - Are unicorns real? Answer [[http://article.gmane.org/gmane.emacs.orgmode/11687/match%3Drosslaird%2Bunicorn][here]] by Ross Laird.
130 ** Why hasn't my email to the mailing list shown up yet?
132 :CUSTOM_ID: ml-post-delay
135 The org-mode mailing list is moderated. Thus, if you are not
136 subscribed to the mailing list, your mail will only appear on the list
137 after it has been approved by a moderator. To ensure that your mail
138 appears quickly, please [[http://lists.gnu.org/mailman/listinfo/emacs-orgmode][subscribe to the list]].
140 ** I read the mailing list through gmane. Should I subscribe?
142 :CUSTOM_ID: ml-subscription-and-gmane
145 The org-mode mailing list is available via nntp at [[http://dir.gmane.org/gmane.emacs.orgmode][Gmane]]. Many
146 participants in the list prefer read the list in a newsreader, such as
147 Gnus, instead of receiving emails. If you choose to read the list via
148 nntp, you can still [[http://lists.gnu.org/mailman/listinfo/emacs-orgmode][subscribe]] to the list and then opt not to receive
149 any emails on the mailman settings page (see the "Mail Delivery"
152 This will ensure that your messages to the list get through quickly,
153 reduce the work load of the mailing list moderators (who need to clear
154 every mail from non-members), and provide more accurate information
155 about the number of list readers.
159 :CUSTOM_ID: Keeping-current
161 ** My Emacs ships with an older version Org-mode! How do I upgrade?
163 :CUSTOM_ID: updating-org
166 Org-mode develops quickly, which means that versions of Org-mode
167 shipped with Emacs are more or less out-of-date. If you'd like to
168 upgrade to the most recent version of org-mode, you have a number of
171 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
172 follow the [[http://orgmode.org/manual/Installation.html#Installation][installation instructions]] in the manual.
173 2. Clone and install the development git repository as [[#keeping-current-with-Org-mode-development][explained
174 here]]. If you don't want to run the bleeding edge, you can still
175 use git [[#using-stable-releases-only][to track the most recent stable releases]].
176 3. Install and updated org-mode automatically through the Emacs
177 Package Manager as [[#installing-via-elpa][explained in this FAQ]].
179 ** How do I keep current with bleeding edge development?
181 :CUSTOM_ID: keeping-current-with-Org-mode-development
184 Org mode is developed in [[http://en.wikipedia.org/wiki/Git_(software)][Git]]. You can keep up-to-date with Org-mode
185 developement by cloning Org mode repository and refreshing your
186 copy with latest changes whenever you wish. You only need to use
187 two Git commands (clone and pull.) Here are the steps in brief
188 (please customize locations to suit your setup):
190 1. Select a location to house the Org mode repository (approx. 40
191 MB; includes documentation, compiled elisp files and history
192 going all the way back to v4.12a)
194 : $ mkdir $HOME/elisp && cd $HOME/elisp
196 2. Clone the Org mode Git repository.
198 Recommended approach:
200 : $ git clone git://orgmode.org/org-mode.git
202 You can also clone from this mirror (lagging one hour behind
205 : $ git clone git://repo.or.cz/org-mode.git
207 For those of you behind a firewall that allows only HTTP, you can
208 clone like this (can be somewhat slow), either from orgmode.org or
211 : $ git clone http://orgmode.org/org-mode.git
212 : $ git clone http://repo.or.cz/r/org-mode.git
214 3. Compile and install Org mode and build documentation.
216 : $ cd org-mode && make && make doc && make install
218 Please note that you can choose to /not/ compile at all and run
219 using source =.el= files only. Compiled files speed things up.
221 Also note that running =make install= is necessary only if you'd
222 like to install org-mode system-wide.
224 4. This is where you configure Org mode with Emacs. Please refer
225 to [[./org-tutorials/index.org][Org tutorials]].
227 5. Keeping up-to-date.
229 Cloning the repository is a one time activity. From this point
230 onwards you only need to /pull/ the latest changes.
232 : $ cd $HOME/elisp/org-mode
236 : $ git pull && make clean && make && make doc && make install
238 6. You should restart org mode to have the changes take effect (if
239 you are not rebooting Emacs.) Also since the intention is to
240 "keep up" with Org mode, you should visit updated sections of
241 documentation for latest updates (use =git log=.)
243 7. As you use your repository over time it will accumulate loose objects.
244 You can reduce the total size of your git repository with
248 which will consolidate loose git objects into pack files. This
249 reduces the size of the repository and speeds up data access to
252 ** How can I keep local changes and still track Org mode development?
254 :CUSTOM_ID: keeping-local-changes-current-with-Org-mode-development
257 Say you want to make minor changes to the Makefile to reflect your
258 location for =emacs=.
260 Create a local branch for your changes on top of origin/master as
263 : $ git checkout -b local origin/master
264 : $ git config branch.local.rebase true
265 : # Make your changes to the Makefile and create a new commit
267 : $ git commit -m 'My local Makefile configurations'
268 : # Update git to a newer version
271 Now each time you pull new commits from the distribution repository
272 your local commits will be rewound and replayed on top of the new
277 You would normally work on your =local= branch which includes your
278 custom commits; there's no need to switch back to the =master=
283 Here is an example of dealing with conflict resolution during git pull.
285 If you get a conflict during a =git pull= you will need to edit the
286 file with the conflict to fix up the conflicting lines and then tell
287 git that you have resolved the conflict.
289 Conflict resolution goes something like this:
291 1. =git pull= fails with a conflict
293 3. =git add= the file to mark the conflict resolved
294 4. =git rebase --continue=
295 5. lather, rinse, and repeat 2-4 as needed
297 For this example we have the following Makefile:
307 and we need to change the =EMACS=emacs= line to =EMACS=myemacs= to
308 make it work well on our system.
312 - create a local branch for our work
314 : $ git checkout -b local origin/master
315 : $ git config branch.local.rebase true
317 This marks the branch so that all local commits on it are rebased
318 on top of any new commits we get in origin/master during a =git
321 - Make our custom changes
323 Edit the makefile so it looks like this:
333 - Create a commit with our custom changes
335 : $ git commit -m 'My local Makefile configurations'
337 - Later we do a =git pull= but that fails with conflicts.
340 : remote: Counting objects: 5, done.
342 : Patch failed at 0001.
344 : When you have resolved this problem run "git rebase --continue".
345 : If you would prefer to skip this patch, instead run "git rebase --skip".
346 : To restore the original branch and stop rebasing run "git rebase --abort".
348 - Fix the conflict in your favourite editor
350 Conflict markers look like this:
352 : <<<<<<< HEAD:Makefile
356 : >>>>>>> Change emacs location:Makefile
358 This attempted =git pull= caused a conflict. Fire up your
359 favourite editor and fix the conflict in the Makefile. The
360 conflict markers are <<<<<<<<<< , ======= , and >>>>>>>>>>. Fix
361 the Makefile appropriately and delete the conflict markers. You
362 already edited these lines earlier so fixing it should be trivial.
364 In this case we changed =EMACS=emacs= to =EMACS=myemacs= and
365 upstream changed =EMACS=emacs= to =EMACS=emacs22=. Just fix the
366 file and save it by deleting the conflict markers and keeping the
367 code you need (in this case the =EMACS=myemacs= line which we
368 originally modified.)
370 - Mark the file's conflict resolved
374 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.
376 - Continue the rebase operation
378 : $ git rebase --continue
380 If any other conflicts arise you fix them the same way - edit the file, mark the conflict resolved, and continue.
382 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"
384 : $ git rebase --abort
386 ** How can I use a stable release version instead of the bleeding edge master?
388 :CUSTOM_ID: using-stable-releases-only
391 The master branch of the git repository always contains the bleeding
392 edge development code. This is important for Org's fast development,
393 because code on master gets checked out by many people daily and we
394 quickly receive bug reports if something is wrong. On rare occasions,
395 this code may not function perfectly for a limited time while we are
396 trying to fix things.
398 Not everyone like to use this bleeding-edge code and face the danger
399 to hit a surprising bug.
401 Therefore, from time to time, we make a release. This typically
402 happens when the maintainers feel that
404 1. they have reached a good point in the development
405 2. the code has a feature set that should stay and be supported in the
408 Stable releases are used as the basis for [[http://orgmode.org/index.html#sec-3_3][alternative distributions]] of
409 Org, and they are also the code that gets merged into the Emacs
410 distribution. If you want to work only with stable releases, you can
411 always download [[http://orgmode.org/index.html#sec-3][them here]], but you can also also use the git
412 repository to keep automatically up-to-date with the most recent
413 stable releases (and save bandwidth!). Here's how to do so:
415 *** Run a specific stable release
417 In the repository, do
422 To see which release tags are available. Let's say you decide to use
425 : $ git checkout release_7.01f
427 This set the working tree of the repository to the state of Org at the
428 moment of release 7.01f. You can then run Org from the repository be
429 sure to use the stable release while development continues on the
432 Later, when we release 7.02, you can switch to that using
434 : $ git fetch --tags # to get all the new stuff
436 : $ git checkout release_7.02
438 *** Always run the most recent stable release
440 Alternatively, if you just want to always run whatever the latest
441 stable release is, you can do
443 : $ git checkout -b stable origin/maint
445 and then regularly update this branch by doing
449 ** How can I install an up-to-date version of org-mode without "make" tools?
451 :CUSTOM_ID: installing-org-without-make-tools
454 If you are using org-mode on a computer that lacks developer tools for
455 compiling software, such as [[http://www.gnu.org/software/make/][GNU Make]], you will have to use a
456 *different* installation method than [[http://orgmode.org/manual/Installation.html#Installation][the one outlined in the manual]].
458 Please see [[http://article.gmane.org/gmane.emacs.orgmode/15264][this thread]] on the mailing list for several different ways
459 you can install a recent version of org-mode without using the
460 customary =make clean && make && make install=.
462 The result of that discussion is the file/function found in
463 [[http://orgmode.org/worg/org-hacks.html#compiling-org-without-make]].
465 ** I don't use git. Can I download bleeding edge .zip and .tar.gz archives?
467 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 --
468 these archives are udpated every day at midnight.
470 Alternatively, you can download a [[http://orgmode.org/w/org-mode.git/snapshot][tar.gz snapshot from orgmode.org]].
472 ** How can I install Org-mode through Emacs' Package Manager?
474 :CUSTOM_ID: installing-via-elpa
477 Emacs 24 includes an automated package management tool ([[http://tromey.com/elpa/][ELPA]]) that
478 can be used to install and upgrade elisp packages such as Org-mode.
479 If you are running an older version of Emacs (23 or earlier), you
480 will have to install the package manager before using it to install
481 Org-mode. See [[#installing-elpa][this FAQ]] for more details.
483 Org-mode is distributed as an ELPA package from [[http://elpa.gnu.org/packages/][GNU Emacs Lisp
484 Package Archive]] as well as from [[http://orgmode.org/pkg/daily/][Org-mode Emacs Lisp Archive]].
486 Steps for adding Org-mode as a package archive:
487 1. Add Org-mode as a package archive. This can be done in two ways.
488 1. Use =M-x customize-variable RET package-archives=
489 2. Add the following line to your =.emacs= and reload Emacs.
491 #+begin_src emacs-lisp
492 (add-to-list 'package-archives '("Org-mode" . "http://orgmode.org/pkg/daily/"))
495 2. Use the Emacs package manager's =M-x list-packages= to browse
496 and install the latest version.
498 3. If you get the following error "*Failed to download `Org-mode'
499 archive.*" in step 2, you can manually download the tarball and
500 install it. Refer [[Installing from ELPA-tar][this FAQ entry]] for more information.
502 ** How do I install Emacs package manager?
504 :CUSTOM_ID: installing-elpa
507 If you are running Emacs-24 or find the command =M-x list-packages=
508 available you already have the package manager installed.
510 Steps for installing package manager:
511 1. Download the latest package manager -
512 [[http://repo.or.cz/w/emacs.git/blob_plain/HEAD:/lisp/emacs-lisp/package.el][package.el]].
513 2. Add the following to your =.emacs= and reload Emacs.
514 #+begin_src emacs-lisp
515 ;; change "~/elisp/" as appropiate
516 (setq load-path (cons "~/elisp" load-path))
521 ** I don't see Org-mode as an installation option in Package Manager Menu?
523 :CUSTOM_ID: why-no-org-in-elpa
526 Emacs Package Manager is a very recent addition to Emacs. Work is
527 under way to have have Org-mode seamlessly integrate with Emacs'
528 Package Manager. As a result, it will be some time before the
529 Org-mode packages are available and usable from either GNU or
530 Org-mode package archives.
532 In the meanwhile, you can install Org-mode via package manager
533 through ELPA-compatible tar. Refer [[Installing from ELPA-tar][this FAQ entry]] for more information.
535 ** How do I install Org-mode from a ELPA-compatible tarball?
537 :CUSTOM_ID: installing-from-elpa-tarball
539 # <<Installing from ELPA-tar>>
541 Org-mode is distributed as an ELPA-compatible tar which can be used
542 in conjunction with Emacs' package manager.
544 1. If you are already running Org-mode, note the current version
545 reported by M-x org-version.
546 2. Download the latest tarball from [[http://orgmode.org/pkg/daily/][Org-mode repo]].
547 3. Do =M-x package-install-file=. When prompted for =Package file
548 name=, point it to .tar file downloaded in step 2.
550 You will now see Package Manager compiling the files and
552 4. Reload emacs. This step is very important.
553 5. Note the version of the new installation using M-x
554 org-version. If the new and old versions are different, the
555 installation is done and you are all set to enjoy the updated
556 Org-mode. Otherwise skip to step 6.
557 6. Review you load-path using =C-h v load-path=. Most likely that
558 your old installation path takes precedence over the path chosen
559 by package manager (which is typically
560 =~/.emacs.d/elpa/...=). Fix this anamoly by moving
561 =(package-initialize)= line in .emacs to a more appropriate
564 - Additional Note on =org-install.el= :: Functionality of Org-mode's
565 =org-install.el= is supplanted by Package Manager's
566 =org-autoloads.el=. Since Package Manager autoloads Org-mode for
567 you, the following line =(require 'org-install)= in your =.emacs=
568 is no longer required and can be safely removed.
570 ** Why would I use ELPA tarballs instead of the snapshot tarballs?
575 ELPA-tarballs automate much the process of upgrading org-mode. Much
576 of the following grunt work is done automatically by the Package
579 1. Downloading, compiling, and activating of org-mode (including
580 setting org-mode's =load-path= and autoloads).
581 2. Updating info files.
587 ** How can I quickly browse all Org options?
589 =M-x org-customize RET=
591 See also [[file:org-tutorials/org-customize.org][Carsten's Org customize tutorial]] and [[file:org-configs/org-customization-guide.org][this customization guide]]
594 ** Can I use the editing features of org-mode in other modes?
596 :CUSTOM_ID: use-editing-features-in-other-modes
599 Not really---but there are a few editing features you can use in
602 - For tables there is =orgtbl-mode= which implements the table
603 editor as a minor mode. (To enable, type =M-x orgtbl-mode=)
604 - For ordered lists there is =orgstuct-mode= which allows for easy
605 list editing as a minor mode. (To enable, type =M-x
608 You can activate these modes automatically by using hooks:
610 : (add-hook 'mail-mode-hook 'turn-on-orgtbl)
611 : (add-hook 'mail-mode-hook 'turn-on-orgstruct)
613 For footnotes, there is the function =org-footnote-action=, which
614 works in non-org buffers. This function is a powerful tool for
615 creating and sorting footnotes. To use it globally, you can add the
616 following keybinding to your =.emacs= file (requires Org 6.17 or
619 : (global-set-key (kbd "C-c f") 'org-footnote-action)
621 For other features you need to switch to Org-mode temporarily, or
622 prepare text in a different buffer.
624 ** Why isn't feature "X" working the way it is described in the manual?
626 :CUSTOM_ID: making-sure-org-mode-is-up-to-date
629 Org-mode develops very quickly. If you are using a version of Org-mode
630 that shipped with emacs, there is a good chance that it is somewhat
633 Many of the users on the Org-mode mailing list are using either a
634 recent release of Org-mode or the
635 [[http://orgmode.org/index.html#sec-3.2][development version of
636 org-mode from the git repository]].
638 If some settings and features aren't working the way you expect, make
639 sure that the version of the manual you are consulting matches the
640 version of Org-mode you are using.
642 - You can check which version of Org-mode you are using by
643 selection =Org --> Documentation --> Show Version= in the Emacs
646 - The [[http://orgmode.org/manual/index.html][online manual]] at [[http://orgmode.org][orgmode.org]] corresponds to the most recent
649 - 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
650 released with the latest official Gnu Emacs release. Compared
651 with the manual at the orgmode.org, the manual at www.gnu.org is
652 somewhat out of date.
654 For instructions on how to stay current with Org-mode, consult [[keeping-current-with-Org-mode-development][this
655 FAQ]] or follow the instructions on [[http://orgmode.org][the official Org-mode site]].
657 ** Can I get the visibility-cycling features in outline-mode and outline-minor-mode?
659 :CUSTOM_ID: use-visibility-cycling-in-outline-mode
662 Yes, these functions are written in a way that they are independent of
663 the outline setup. The following setup provides standard Org-mode
664 functionality in outline-mode on =TAB= and =S-TAB=. For
665 outline-minor-mode, we use =C-TAB= instead of =TAB=,
666 because =TAB= usually has mode-specific tasks.
668 #+BEGIN_SRC emacs-lisp
669 (add-hook 'outline-minor-mode-hook
671 (define-key outline-minor-mode-map [(control tab)] 'org-cycle)
672 (define-key outline-minor-mode-map [(shift tab)] 'org-global-cycle)))
673 (add-hook 'outline-mode-hook
675 (define-key outline-mode-map [(tab)] 'org-cycle)
676 (define-key outline-mode-map [(shift tab)] 'org-global-cycle)))
679 Or check out /outline-magic.el/, which does this and also provides
680 promotion and demotion functionality. /outline-magic.el/ is
681 available at [[http://www.astro.uva.nl/~dominik/Tools/outline-magic.el][Outline Magic]].
683 ** Can I save/restore the visibility state of an org-mode buffer?
685 :CUSTOM_ID: saving-visibility-state
688 Well, no---at least not automatically. You can, however, control the
689 visibility of an org-file or of individual trees by adding
690 instructions to your org file. See [[http://orgmode.org/manual/Visibility-cycling.html#Visibility-cycling][this section of the manual]] for more
693 ** How can I keep track of changes in my Org files?
695 :CUSTOM_ID: track-of-changes-in-Org-files
698 Use git to track the history of the files, use a cronjob to check in
699 changes regularly. Such a setup is described by Bernt Hansen
700 in [[http://article.gmane.org/gmane.emacs.orgmode/6233][this message]] on [[http://dir.gmane.org/gmane.emacs.orgmode][emacs-orgmode]].
702 ** Can I use Org-mode as the default mode for all README files?
704 :CUSTOM_ID: Org-mode-as-default-mode
707 Add the following to your .emacs file:
709 : (add-to-list 'auto-mode-alist '("README$" . org-mode))
711 You can even make it the default mode for any files with unspecified
714 : (setq default-major-mode 'org-mode)
716 ** Can I use ido.el for completing stuff in Org?
718 :CUSTOM_ID: ido-complete
721 Yes, you can. If you are an ido user and ido-mode is active, the
722 following setting will make Org use =ido-completing-read= for most
723 of its completing prompts.
725 : (setq org-completion-use-ido t)
727 ** Should I use one big org file or multiple files?
729 :CUSTOM_ID: how-to-organize-org-mode-files
732 Org-mode is flexible enough to accomodate a variety of organizational
733 and time management schemes. Org's [[http://orgmode.org/manual/Document-Structure.html#Document-Structure][outline cycling and convenient
734 editing and navigation commands]] make it possible to maintain all of
735 your projects and notes in a single file. But org-mode's [[http://orgmode.org/manual/Hyperlinks.html#Hyperlinks][quick and
736 easy hyperlinks]], along with [[http://orgmode.org/manual/Refiling-notes.html#Refiling-notes][easy refiling of notes and todos]], also
737 make it a delight to maintain a private "wiki" consisting of multiple
740 No matter how you organize your org files, org-mode's agenda commands
741 make it easy to search all your notes and gather together crucial data
744 Moreover, several org-mode settings can be configured either globally
745 in your =.emacs= file or locally (per file or per outline tree). See
746 the [[http://orgmode.org/manual/index.html#Top][manual]] for more details. For an example of local customizations
747 see [[limit-agenda-with-category-match][this FAQ]].
749 Here are a few ideas for organizing org-mode files:
751 - A single file for all your projects and notes.
752 - One file per project.
753 - One file per client.
754 - One file per area of responsibility or type of work (e.g.,
755 household, health, work, etc.).
756 - One file for projects, one for appointments, one for reference
757 material, one for someday/maybe items, etc.
758 - A wiki of hyperlinked files that grows and adapts to meet your
761 For more ideas, see some of the links on the [[file:org-tutorials/index.org][org-tutorial index]] or
762 [[file:org-gtd-etc.org][this page on org-mode and GTD]].
764 ** Why doesn't C-c a call the agenda? Why don't some org keybindings work?
766 :CUSTOM_ID: setting-global-keybindings
769 Org-mode has a few global keybindings that the user must set
770 explicitly in an =.emacs= file. These keybindings include the
771 customary shortcut for calling the agenda (=C-c a=). If nothing
772 happens when you type =C-c a=, then make sure that the following lines
773 are in your =.emacs= file:
775 #+BEGIN_SRC emacs-lisp
776 ;; The following lines are always needed. Choose your own keys.
777 (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
778 (global-set-key "\C-cl" 'org-store-link)
779 (global-set-key "\C-ca" 'org-agenda)
780 (global-set-key "\C-cb" 'org-iswitchb)
783 You may, of course, choose whatever keybindings work best for you
784 and do not conflict with other modes.
786 Please see [[http://orgmode.org/manual/Activation.html][this section of the manual]] if you have additional
789 ** Why aren't some of the variables I've customized having an effect?
791 :CUSTOM_ID: load-org-after-setting-variables
794 Some org variables have to be set before org.el is loaded or else they
795 will not work. (An example is the new variable
796 =org-enforce-todo-dependencies=.)
798 To make sure all your variables work you should not use =(require
799 'org)=. Instead use the following setting:
801 : (require 'org-install)
803 You should also make sure that you do not require any other =org-...=
804 files in your =.emacs= file before you have set your org variables,
805 since these will also cause org.el to be loaded. To be safe, load org
806 files *after* you have set your variables.
808 ** How can I make sure that timestamps appear in English?
810 :CUSTOM_ID: timestamps-and-system-time-locale
813 If your system's locale is not set to English, but you would like the
814 timestamps in your org-mode files to appear in English, you can set
815 the following variable:
817 #+begin_src emacs-lisp
818 (setq system-time-locale "C")
821 ** What does a minimal .emacs look like?
823 :CUSTOM_ID: minimal-emacs
826 Using a stripped down minimal .emacs files removes broken custom
827 settings as the cause of an issue and makes it easy to reproduce for
828 other people. The example below has system-specific paths that you'll
829 need to change for your own use.
830 #+begin_src emacs-lisp
831 (add-to-list 'load-path (expand-file-name "~/git/org-mode/lisp"))
832 (add-to-list 'auto-mode-alist '("\\.\\(org\\ |org_archive\\|txt\\)$" . org-mode))
833 (setq org-agenda-files '("/tmp/test.org"))
834 (require 'org-install)
837 (global-set-key "\C-cl" 'org-store-link)
838 (global-set-key "\C-ca" 'org-agenda)
839 (global-set-key "\C-cb" 'org-iswitchb)
842 You can save the minimal .emacs file to ~/minimal.emacs, add suspect
843 configuration code to it, then start emacs something like this:
845 emacs -Q -l ~/minimal.emacs
848 On OS X, starting emacs with minimal configuration might look
851 /Applications/emacs.app/Contents/MacOS/Emacs -Q -l ~/minimal.emacs
854 ** Can I migrate from Planner?
856 Yes. This [[http://www.c0t0d0s0.de/plan2org/plan2org.pl][perl script]] or [[http://gitorious.org/bkuhn-small-hacks/org-mode/blobs/master/planner2org.plx
857 ][this Perl script]] can help.
859 * Errors and general problems
863 ** Opening Org files in Emacs leads to a crash
865 :CUSTOM_ID: Emacs-crashes-with-org-indent-mode
867 The only known case where Org-mode can crash Emacs is when you are
868 using =org-indent-mode= with Emacs 23.1 (in fact, any version of
869 Emacs before version 23.1.50.3). Upgrade to Emacs 23.2 and the
870 problem should go away.
872 ** When I try to use Org-mode, I always get the error message =(wrong-type-argument keymapp nil)=
874 :CUSTOM_ID: wrong-type-argument-keymapp
877 This is a conflict with an outdated version of the /allout.el/, see
878 the [[http://orgmode.org/manual/Conflicts.html#Conflicts][Conflicts]] section in the manual
880 ** How can I control the application launched by Org-mode to open a certain file type like pdf, html....
882 :CUSTOM_ID: external-application-launched-to-open-file-link
885 If you want special control about how Org-mode opens files, see the
886 variables =org-file-apps=, =org-file-apps-defaults-gnu=,
887 =org-file-apps-defaults-macosx=, =org-file-apps-defaults-windowsnt=.
889 *However*, normally it is best to just use the mechanism the
890 operating-system provides:
892 *** GNU/Linux systems
893 You you have to check your mailcap settings, find the files:
901 and modify them accordingly. Please read their manual entry.
904 + for html pages you may configure the =browse-url-= variables through
905 the Customize interface,
906 + the pdf files are automatically opened with Acrobat Reader (if it is
910 Change the application responsible for this file type by selecting
911 such a file in the Finder, select =File->Get Info= from the menu
912 and select the application to open this file with. Then, to
913 propagate the change to all files with the same extension, select
914 the =Change all= button.
916 ** Org-mode takes over the TAB key. I also want to use YASnippet, is there a way to fix this conflict?
918 :CUSTOM_ID: YASnippet
921 [[http://code.google.com/p/yasnippet/][yasnippet]] is yet another snippet expansion system for Emacs. It is
922 inspired by TextMate's templating syntax.
923 - watch the [[http://www.youtube.com/watch?v=vOj7btx3ATg][video on YouTube]]
924 - see the [[http://yasnippet.googlecode.com/svn/trunk/doc/index.html][intro and tutorial]]
926 *Note*: yasnippet is not compatible with =org-indent-mode= currently
927 there is no known way to use both successfully with =yas/trigger-key=
928 set to =TAB= (or =[tab]= etc...)
930 The way Org-mode binds the =TAB= key (binding to =[tab]= instead of
931 =\t=) overrules yasnippets' access to this key. The following code
934 #+begin_src emacs-lisp
935 (add-hook 'org-mode-hook
937 (org-set-local 'yas/trigger-key [tab])
938 (define-key yas/keymap [tab] 'yas/next-field-group)))
941 If the above code doesn't work (which it may not with later versions
942 of yasnippet). Then try the following
944 #+begin_src emacs-lisp
945 (defun yas/org-very-safe-expand ()
946 (let ((yas/fallback-behavior 'return-nil)) (yas/expand)))
948 (add-hook 'org-mode-hook
950 ;; yasnippet (using the new org-cycle hooks)
951 (make-variable-buffer-local 'yas/trigger-key)
952 (setq yas/trigger-key [tab])
953 (add-to-list 'org-tab-first-hook 'yas/org-very-safe-expand)
954 (define-key yas/keymap [tab] 'yas/next-field)))
957 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]])
958 with YASnippets for Org-mode.
960 ** Org-mode takes over the S-cursor keys. I also want to use CUA-mode, is there a way to fix this conflict?
965 Yes, see the [[http://orgmode.org/manual/Conflicts.html#Conflicts][Conflicts]] section of the manual.
967 ** Org-mode takes over the S-cursor keys. I also want to use windmove.el, is there a way to fix this conflict?
969 :CUSTOM_ID: windmove.el
972 Yes, see the [[http://orgmode.org/manual/Conflicts.html#Conflicts][Conflicts]] section of the manual.
974 ** Org behaves strangely: some keys don't work, some features are missing, my settings have no effect, ...
976 :CUSTOM_ID: loaded-old-org
979 When this sort of things happen, it probably is because Emacs is
980 loading an old version of Org-mode instead of the one you expected.
981 Check it with =M-x org-version=.
983 This happens because Emacs loads first the system org-mode (the one
984 included with Emacs) before the one in your directory. Check the
985 =load-path= variable; you might see that your org-mode appears /after/
986 the system-wide path; this is bad.
988 You should add your directories to the =load-path= at the beginning:
990 : (add-to-list 'load-path "~/.emacs.d/org-mode/lisp") (require 'org-install)
992 Function =add-to-list= adds at the beginning. Don't use =append=
993 because it appends at the end. Also be sure to use =(require
994 'org-install)= and not =(require 'org)=.
996 This wrong version loading may also happen if you have a byte-compiled
997 =org.elc= from an old version together with a new =org.el=. Since
998 Emacs prefers loading byte-compiled files (even if the =.el= is
999 newer), it will load the old Org-mode.
1001 ** Why doesn't org-batch-agenda work under Win32?
1003 :CUSTOM_ID: org-batch-agenda-under-win32
1006 When I run the example batch files to print my agenda to the console
1007 under Win32 I get the failure:
1009 : End of file during parsing
1011 and no agenda is printed.
1013 The problem is the use of single quotes surrounding the eval in the
1014 emacs command-line. This gets confused under Win32. All string
1015 parameters with spaces must be surrounded in double quotes. This means
1016 that double quotes being passed to the eval must be escaped.
1018 Therefore, instead of the following:
1020 : <path to emacs>\emacs.exe -batch -l ~/_emacs_org \
1021 : -eval '(org-batch-agenda "a")'
1023 you need to use the following:
1025 : <path to emacs>\emacs.exe -batch -l ~/_emacs_org \
1026 : -eval "(org-batch-agenda \"a\")"
1028 (all on one line, of course).
1030 ** Org agenda seems very slow
1032 :CUSTOM_ID: slow-agenda
1035 If it takes a long time to generate or refresh the agenda, you might
1036 want first check which version of org-mode you are using. There have
1037 been major optimizations of org-agenda since 6.21b, which was the
1038 version of org-mode released with Emacs 23. If you are using 6.21b or
1039 earlier (you can check with =M-x org-version=), then you might want to
1040 consider upgrading to a more recent version of org-mode.
1042 Here are some other ideas for speeding up the agenda:
1044 1. Use a one day agenda view (rather than a seven day view).
1046 =(setq org-agenda-ndays 1)=
1048 2. Archive inactive items to separate files.
1050 =C-c C-x C-s= (org-archive-subtree)
1052 3. Do not include the global todo list in your agenda view.
1054 (setq org-agenda-include-all-todo nil)
1056 4. Make sure that your org files are byte-compiled.
1058 I.e., make sure there are files ending in =.elc= in your org
1059 installation directory.
1061 5. Limit your agenda files (=org-agenda-files=) to files that have
1062 active todos and or projects.
1064 If you have a number of older reference files---i.e., files you
1065 search only occasionally---in your agenda files list, consider
1066 removing them from your agenda files and adding them to
1067 =org-agenda-text-search-extra-files= instead. Similarly, you might
1068 consider searching some of your older reference files with =M-x
1069 grep= so that Org-mode does not have to load them into memory when
1070 the agenda is called.
1072 ** Visual-line-mode doesn't work well with org-mode
1074 :CUSTOM_ID: visual-line-mode
1077 Visual-line-mode "soft wraps" lines so that the visual edge of the
1078 buffer is considered a line break for purposes of navigation, even
1079 though there is no line break in reality.
1081 In older versions of org-mode, org-beginning-of-line and
1082 org-end-of-line do not work well with visual line mode. (The two
1083 commands disregard soft line breaks and move to the beginning and end
1084 of the hard line break.) A patch was introduces to fix this behavior
1087 If you are using an older version of org mode, you can:
1089 1. Add a hook to turn off visual line mode.
1091 2. Add the following to your =.emacs=:
1093 #+begin_src emacs-lisp
1095 (add-hook 'org-mode-hook
1097 (define-key org-mode-map "\C-a" 'move-beginning-of-line)
1098 (define-key org-mode-map "\C-e" 'move-end-of-line)))
1101 * Faces and highlighting
1105 ** Org-mode has a lot of colors? How can I change them?
1107 :CUSTOM_ID: customizing-org-faces
1110 This is a question that applies to Emacs as a whole, but it comes up
1111 quite frequently on the org-mode mailing list, so it is appropriate to
1114 If you would like to change the style of a face in org-mode (or any
1115 other Emacs mode), simply type =M-x customize-face [RET]= while the
1116 cursor is on the color/style you are interested in modifying. You will
1117 be given the opportunity to customize all the faces located at that
1120 If you would like an overview of all the faces in org-mode, you can
1121 type =C-u M-x list-faces-display [RET] org= and you will be shown all
1122 the faces defined by org-mode along with an illustration of their
1125 If you would like to customize org-faces and other aspects of
1126 org-appearance, type =M-x customize-group org-font-lock [RET]=.
1128 Finally, if you would like verbose information about the properties of
1129 the text under the cursor, you can type =C-u C-x ==.
1131 See the Worg page on [[file:org-tutorials/org-appearance.org][customizing Org appearance]] for further information.
1132 ** Why do I get a tiny font in column view when using emacs daemon?
1134 :CUSTOM_ID: column-view-tiny-font
1137 When using emacs in daemon mode (=emacs --daemon=), client frames
1138 sometimes override the column view face settings, resulting in very
1139 small fonts. Here is a fix:
1141 #+begin_src emacs-lisp
1142 (defun org-column-view-uses-fixed-width-face ()
1143 ;; copy from org-faces.el
1144 (when (fboundp 'set-face-attribute)
1145 ;; Make sure that a fixed-width face is used when we have a column
1147 (set-face-attribute 'org-column nil
1148 :height (face-attribute 'default :height)
1149 :family (face-attribute 'default :family))))
1151 (when (and (fboundp 'daemonp) (daemonp))
1152 (add-hook 'org-mode-hook 'org-column-view-uses-fixed-width-face))
1155 This fix was provided in the following mailing list post:
1157 http://article.gmane.org/gmane.emacs.orgmode/27560
1158 ** How can I stop the mouse cursor from highlighting lines in the agenda?
1160 :CUSTOM_ID: ratpoison-for-agenda-highlighting
1163 You can add the following to your =.emacs=:
1165 #+begin_src emacs-lisp
1166 (add-hook 'org-finalize-agenda-hook
1167 (lambda () (remove-text-properties
1168 (point-min) (point-max) '(mouse-face t))))
1175 ** Can I have two windows on the same Org-mode file, with different outline visibilities?
1177 :CUSTOM_ID: indirect-buffers
1180 You may use /indirect buffers/ which do exactly this. See the
1181 documentation on the command =make-indirect-buffer=.
1183 Org-mode has built-in commands that allow you create an indirect
1184 buffer from a subtree of an outline. To open a subtree in new
1185 window, type =C-c C-x b=. Any changes you make in the new window
1186 will be saved to the original file, but the visibility of both
1187 buffers will remain independent of one another.
1189 For multiple indirect buffers from the same file, you must use the
1190 prefix =C-u= when creating the second (or third) buffer. Otherwise
1191 the new indirect buffer will replace the old.
1193 You can also create an independent view of an outline subtree by
1194 typing =b= on an item in the agenda.
1196 ** Emacs outlines are unreadable. Can I get rid of all those stars?
1198 :CUSTOM_ID: Emacs-outlines-are-unreadable
1201 See the section [[http://orgmode.org/manual/Clean-view.html#Clean-view][Clean outline view]] in the manual.
1202 ** C-k is killing whole subtrees! I lost my work!
1204 :CUSTOM_ID: C-k-is-killing-subtrees
1207 =(setq org-special-ctrl-k t)= before losing your work.
1209 ** Why aren't commands working on regions?
1211 :CUSTOM_ID: transient-mark-mode
1214 Some org-mode commands, such as M-right and M-left for demoting or
1215 promoting headlines (see [[demote-multiple-headlines][this FAQ]]), can be applied to entire regions.
1216 These commands, however, will only work on active regions set with
1217 [[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
1218 Emacs 23. To enable it in earlier versions of emacs, put the following
1219 in your =.emacs= file:
1221 : (transient-mark-mode 1)
1223 Alternatively, you may turn off transient mark mode and use [[http://www.gnu.org/software/emacs/manual/html_node/emacs/Momentary-Mark.html][a
1224 momentary mark]] (=C-<SPC> C-<SPC>=).
1226 ** Why is a blank line inserted after headlines and list items?
1228 :ID: 2463F4D8-F686-4CF3-AA07-08976F8A4972
1231 :CUSTOM_ID: blank-line-after-headlines-and-list-items
1234 In org-mode, typing =M-RET= at the end of a headline will create a new
1235 headline of the same level on a new line. The same is true for plain
1236 lists. By default org-mode uses context to determine if a blank line
1237 should be inserted after each headline or plain list item when =M-RET=
1238 is pressed. For instance, if a there is a blank line before a
1239 headline, then typing =M-RET= at the end of the line will insert a
1240 blank line before the new headline. For instance, hitting =M-RET=
1241 at the end of "Headline Two" below inserts a new headline without a
1248 If there is a blank line between Headline One and Headline Two,
1249 however, the results will be as follows:
1257 If you do not like the default behavior you can change it with the
1258 variable =org-blank-before-new-entry=. You can set headings and/or
1259 plain lists to auto (the default setting), t (always), or nil (never).
1261 ** How can I promote or demote multiple headlines at once?
1263 :CUSTOM_ID: demote-multiple-headlines
1266 If you have a long list of first level headlines that you'd like to
1267 demote to second level headlines, you can select the headlines as a
1268 region and then hit =M-<right>= to demote all the headlines at once.
1270 Note: =M-S-<right>= will not work on a selected region. Its use is to
1271 demote a single subtree (i.e., a headline and all sub-headlines).
1273 If M-<right> doesn't seem to work, make sure transient mark mode is
1274 enabled. See [[transient-mark-mode][this FAQ]].
1276 ** What's the deal with all the ellipses in my org outlines?
1278 :CUSTOM_ID: org-ellipses
1281 Org-mode uses ellipses to indicate folded (and thus hidden) text. Most
1282 commonly, ellispes occur at the end of headings with folded content:
1286 Or, for instance, they may indicate closed drawers:
1290 Sometimes, as a result of editing and cycling an outline, ellipses may
1291 appear in unexpected places. You should *never* delete these ellipses,
1292 as you may accidentally delete hidden text. Instead, you can type =C-c
1293 C-r= (org-reveal) to display all hidden text in the vicinity. Or you
1294 may type =M-x RET show-all= to reveal all text in the org file.
1296 If you would prefer a symbol or face for indicating hidden text, you
1297 can customize the variable org-ellipses.
1299 ** How do I yank a subtree so it's indented according to the point's location?
1301 :CUSTOM_ID: yank-indent-subtree
1304 You can either use =C-c C-w= with a working [[http://orgmode.org/manual/Refiling-notes.html#Refiling-notes][refile-targets]] setup.
1306 Or set =org-yank-adjusted-subtrees= to =t= which will adjust the
1307 yanked headline's level correctly.
1309 Just use =C-k= and =C-y= as you would everywhere else in Emacs.
1311 ** Can I read org-mode outlines in vim?
1313 :CUSTOM_ID: org-outlines-in-vim
1316 Yes, there is a script that enables one to view and navigate folded
1317 outline/org files in vim (though without most of org-mode's
1318 functionality, of course).
1320 - [[http://www.vim.org/scripts/script.php?script_id%3D1266][Emacs outline mode - Imitates Emacsen : vim online]]
1322 For instructions on how to set it up, please see [[http://mid.gmane.org/EA275862-B97A-4BAC-B879-177FD07A2D56@gaillourdet.net][this mailing list
1325 Work is also underway on an org-mode clone for Vim. You can check it
1328 https://github.com/hsitz/VimOrganizer
1332 :CUSTOM_ID: Todos-and-Tags
1334 ** How can I cycle through the TODO keyword of an entry?
1336 :CUSTOM_ID: cycle-TODO-keywords
1339 =C-c C-t= or =S-<left/right>= is what you need.
1341 ** How do I track state changes for tasks in Org?
1343 :CUSTOM_ID: track-state-changes-for-tasks
1346 Take a look at the [[http://thread.gmane.org/gmane.emacs.orgmode/6082][post by Bernt Hansen]] for setting up TODO keyword
1347 states and logging timestamps for task state changes.
1349 ** Can I select the TODO keywords with a tag-like interface?
1351 :CUSTOM_ID: select-TODO-keywords-with-tag-like-interface
1354 Yes. Use =(setq org-use-fast-todo-selection t)=
1356 If you want to set both your todos and your tags using a single
1357 interface, then check out the variable
1358 =org-fast-tag-selection-include-todo=.
1360 See [[http://orgmode.org/manual/Fast-access-to-TODO-states.html][this section of the manual]] for more details.
1362 ** How can I quickly set the tag of an entry?
1364 :CUSTOM_ID: quickly-set-tag-of-entry
1367 Use =C-c C-c= or =C-c C-q= on the headline. =C-c C-q= is useful for
1368 setting tabs in a [[http://orgmode.org/manual/Remember.html#Remember][remember]] buffer, since =C-c C-c= is the default
1369 keybinding for filing a note from the remember buffer.
1371 You can set tags even more quickly by setting one of the character
1372 shortcuts for [[http://orgmode.org/manual/Setting-tags.html#Setting-tags][fast tag selection]].
1374 To set tag shortcuts for all org buffers, put something like the
1375 following in your =.emacs= file (or create the same settings by
1376 typing =M-x customize-variable RET org-tag-alist=):
1378 : (setq org-tag-alist '(("computer" . ?c) ("office" . ?o) ("home" . ?h)))
1380 To set tag shortcuts for a single buffer, put something like the
1381 following at the top of your org file:
1383 : #+TAGS: computer(c) office(o) home(h)
1385 ** How can I change the colors of TODO keywords?
1387 You can use the variable org-todo-keyword-faces. Here are some sample
1390 #+begin_src emacs-lisp
1391 (setq org-todo-keyword-faces
1393 ("TODO" . (:foreground "firebrick2" :weight bold))
1394 ("WAITING" . (:foreground "olivedrab" :weight bold))
1395 ("LATER" . (:foreground "sienna" :weight bold))
1396 ("PROJECT" . (:foreground "steelblue" :weight bold))
1397 ("DONE" . (:foreground "forestgreen" :weight bold))
1398 ("MAYBE" . (:foreground "dimgrey" :weight bold))
1399 ("CANCELED" . shadow)
1403 If you want to change the color of all active todos or all inactive
1406 : M-x customize-face RET org-todo
1407 : M-x customize-face RET org-done
1409 You can also set values for each of these in your =.emacs= file:
1411 : (set-face-foreground 'org-todo "firebrick2")
1412 : (set-face-foreground 'org-done "forestgreen")
1416 :CUSTOM_ID: Hyperlinks
1418 ** Why do I have to confirm the execution of each shell/elisp link?
1420 :CUSTOM_ID: confirm-shell/elisp-link
1423 The confirmation is there to protect you from unwantingly execute
1424 potentially dangerous commands. For example, imagine a link
1426 : [[shell:rm -rf ~/*][Google Search]]
1428 In an Org-mode buffer, this command would look like /Google Search/,
1429 but really it would remove your home directory. If you wish, you can
1430 make it easier to respond to the query by setting
1432 : (setq org-confirm-shell-link-function 'y-or-n-p
1433 : org-confirm-elisp-link-function 'y-or-n-p).
1435 Then a single keypress will be enough to confirm those links. It is
1436 also possible to turn off this check entirely, but I strongly
1437 recommend against this. Be warned.
1439 ** Can I use RET or TAB to follow a link?
1441 :CUSTOM_ID: RET-or-TAB-to-follow-link
1446 : (setq org-return-follows-link t)
1447 : (setq org-tab-follows-link t)
1449 ** Can I keep mouse-1 clicks from following a link?
1451 :CUSTOM_ID: mouse-1-following-link
1454 Activating links with =mouse-1= is a new feature in Emacs 22, to make
1455 link behavior similar to other applications like web browsers. If
1456 you hold the mouse button down a bit longer, the cursor will be set
1457 without following the link. If you cannot get used to this behavior,
1458 you can (as in Emacs 21) use =mouse-2= to follow links and turn off
1459 link activation for =mouse-1= with
1461 : (setq org-mouse-1-follows-link nil)
1463 ** How can I get completion of file names when creating a link?
1465 :CUSTOM_ID: completion-of-file-links
1468 You can use org-insert-link with a prefix argument:
1472 You will be greeted with prompt in the minibuffer that allows for file
1473 completion using your preferred Emacs method for finding files.
1475 ** How can I use invisible targets within lists?
1477 :CUSTOM_ID: invisible-targets-in-lists
1480 The usual way of turning radio links invisible is to comment them, but
1481 Org comments need to be at the beginning of the line, which breaks list
1484 The workaround here is to add (INVISIBLE) after your <<target>>
1488 : 11. <<target>>(INVISIBLE)
1490 : 12. More text [[target][go to]]
1492 ** Org-mode is not opening mailto links in my default mail client
1494 :CUSTOM_ID: mailto-links
1497 You can customize the function org-mode uses to open mailto links by
1498 setting the variable =org-link-mailto-program=:
1500 =M-x customize-variable org-link-mailto-program=
1502 The default function called is =browse-url=, which opens a mail
1503 composition buffer within Emacs. The type of buffer opened by
1504 browse-url depends on the setting of the variable =mail-user-agent=.
1505 Thus, if you want to ensure that mailto links use Gnus to open a
1506 message buffer, you could add the following to your =.emacs=:
1509 (setq mail-user-agent 'gnus-user-agent)
1512 ** Can I use CamelCase links?
1514 :CUSTOM_ID: CamelCase-links
1517 Yes, you can with the contributed package org-wikinodes.el. Please
1518 consult the [[http://orgmode.org/worg/org-contrib/org-wikinodes.html][documentation]].
1522 :CUSTOM_ID: Plain-Lists
1524 ** How can I insert an empty line before each newly inserted headline, but not before each newly inserted plain-list item?
1526 :CUSTOM_ID: empty-line-before-each-new-headline-but-not-item
1529 : (setq org-blank-before-new-entry
1530 : '((heading . t) (plain-list-item . nil))
1532 See also [[id:2463F4D8-F686-4CF3-AA07-08976F8A4972][Why is a blank line inserted after headlines and list items?]].
1534 ** How can I convert itemized lists to enumerated lists?
1536 :CUSTOM_ID: convert-itemized-to-enumerated-lists
1539 You can use =C-c -= or =S-<left>/<right>= to cycle through the various
1540 bullet headlines available for lists: =-, +, *, 1., 1)=.
1542 See [[http://orgmode.org/manual/Plain-lists.html#Plain-lists][this section of the manual]] for more information.
1544 ** How can I convert plain lists to headlines and vice versa?
1546 :CUSTOM_ID: convert-plain-lists-to-headlines
1549 To convert a plain list item or line to a headline, type =C-c *= on
1550 the headline. This will make the line a subheading of the current
1553 To convert a headline to a plain list item, type =C-c -= while the
1554 cursor is on the headline.
1556 To convert a headline to an unadorned line of text, type =C-c *= on
1559 You can use query replace to accomplish the same things, as Bernt
1560 Hansen explains in [[http://article.gmane.org/gmane.emacs.orgmode/10148][this mailing list post]].
1562 ** Is there a good way to create a description list?
1564 :CUSTOM_ID: description-lists
1567 Yes, these are now built-in:
1570 - item1 :: Description of this item 1
1571 - item2 :: Description of this item 2
1572 - item1 :: Description of this item 3
1573 also in multiple lines
1580 ** How can I make table alignment work with Asian character sets
1582 :CUSTOM_ID: table-alignment-asian-characters
1585 When table alignment fails, it usually has to do with character sets
1586 where some characters have non-integer width. Org will deal correctly
1587 with characters that are one or two or three ASCII characters wide,
1588 but not with characters that are, for example, 1.5 ASCII characters
1589 wide. To make table alignment work you need to switch to a different
1592 ** Can I plot data from a table?
1594 :CUSTOM_ID: plotting-table-data
1597 Yes, you can, using org-plot.el written by Eric Schulte and now
1598 bundled with Org. See [[http://orgmode.org/manual/Org_002dPlot.html#Org-Plot][the manual section about this]].
1600 See also [[file:org-tutorials/org-plot.org][this excellent tutorial]] by Eric Schulte.
1602 ** How can I fill a table column with incremental numbers?
1604 :CUSTOM_ID: fill-table-column-with-incremental-numbers
1607 Here is how: Use a field formula to set the first value in the column:
1619 Then define a column formula in the second field:
1631 After recomputing the table, the column will be filled with
1632 incremental numbers:
1641 ,#+TBLFM: $1=@-1 + 1::@2$1=1
1644 Note that you could use arbitrary starting values and column formulas.
1646 ** Why does my table column get filled with #ERROR?
1648 :CUSTOM_ID: table-column-filled-with-ERROR
1651 Org-mode tried to compute the column from other fields using a
1652 formula stored in the =#+TBLFM:= line just below the table, and
1653 the evaluation of the formula fails. Fix the fields used in the
1654 formula, or fix the formula, or remove it!
1656 ** How can I stop the table editor from creating new lines?
1658 :CUSTOM_ID: table-editor-creates-new-lines
1661 When I am in the last column of a table and just above a horizontal
1662 line in the table, pressing TAB creates a new table line before the
1663 horizontal line. To move to the line below the
1664 horizontal line instead, do this:
1666 Press =down= (to get on the separator line) and then =TAB=.
1667 Or configure the variable
1669 : (setq org-table-tab-jumps-over-hlines t)
1671 ** How can I get table fields starting with "="?
1673 :CUSTOM_ID: table-fields-starting-with-=
1678 : (setq org-table-formula-evaluate-inline nil)
1680 this will no longer happen. You can still use formulas using the
1681 commands @<tt>C-c =@</tt> and @<tt>C-u C-c =@</tt>
1683 ** How can I change the indentation of an entire table without fixing every line by hand?
1685 :CUSTOM_ID: change-indentation-entire-table
1688 The indentation of a table is set by the first line. So just fix the
1689 indentation of the first line and realign with =TAB=.
1691 ** In my huge table the realigning after each TAB takes too long. What can I do?
1693 :CUSTOM_ID: table-realigning-after-TAB-takes-long
1696 Either split the table into several by inserting an empty line every
1697 100 lines or so. Or turn off the automatic re-align with
1699 : (setq org-table-automatic-realign nil)
1701 After this the only way to realign a table is to press =C-c C-c=. It
1702 will no longer happen automatically, removing the corresponding delays
1705 ** Recalculation of my table takes too long. What can I do?
1707 :CUSTOM_ID: Recalculation-of-my-table-takes-too-long
1710 Nothing, really. The spreadsheet in org is mostly done to make
1711 calculations possible, not so much to make them fast. Since Org-mode
1712 is firmly committed to the ASCII format, nothing is stopping you from
1713 editing the table by hand. Therefore, there is no internal
1714 representation of the data. Each time Org-mode starts a computation,
1715 it must scan the table for special lines, find the fields etc. This
1716 is slow. Furthermore, Calc is slow compared to hardware
1717 computations. To make this work with normal editing, recalculation
1718 is not happening automatically, or only for the current line, so that
1719 the long wait for a full table iteration only happens when you ask
1722 So for really complex tables, moving to a "real" spreadsheet may
1723 still be the best option.
1725 That said, there are some ways to optimize things in Org-mode, and I
1726 have been thinking about moving a bit further down this line.
1727 However, for my applications this has so far not been an issue at
1728 all. If you have a good case, you could try to convince me.
1730 ** =S-RET= in a table keeps increasing the copied numbers. How can I stop this?
1732 :CUSTOM_ID: S-RET-in-a-table-increases-copied-numbers
1735 Well, it is /supposed/ to be a feature, to make it easy to create a
1736 column with increasing numbers. If this gets into your way, turn it
1739 : (setq org-org-table-copy-increment nil)
1741 ** When I export tables to html, they don't have borders.
1743 :CUSTOM_ID: table-borders-in-html-export
1746 By default, org mode exports tables without borders.
1748 You can changed this by placing an =#+ATTR_HTML= line before the
1751 : #+ATTR_HTML: border="2" rules="all" frame="all"
1753 See [[http://orgmode.org/manual/Tables-in-HTML-export.html#Tables-in-HTML-export][the manual]] for more details.
1755 ** Why does the Calc high precision (e. g. =p20=) not work like expected?
1757 :CUSTOM_ID: table-high-precision
1763 : | 1 / 2 * 3 | 0.16666667000000 |
1764 : #+TBLFM: $2 = $1; p20 %.14f
1767 : | 1 / 2 * 3 | 0.16666666666667 |
1768 : #+TBLFM: $2 = $1 +.0; p20 f-14
1772 It is important to distinguish between the precision of
1773 1) =p20=: Calc internal calculation (=calc-internal-prec=)
1774 2) =f-14=: Calc float formatting, unlimited in precision (=calc-float-format=)
1775 3) =%.14f=: the =printf= reformatting, limited in precision
1777 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.
1779 Use =C-h v org-calc-default-modes RET= to check the Org default settings
1780 which are used if no format specifiers are added to a table formula.
1781 The examples below have been made with the out_of_the_box Org defaults
1782 =calc-internal-prec = 12= and =calc-float-format = 8=.
1784 Remember the formula debugger, toggled with =C-c {=,
1785 to view the processing stages like:
1786 | | formula debugger label | processing stage |
1788 |---+------------------------+----------------------------|
1789 | | Result: | output of Calc |
1790 | | Format: | reformatting with =printf= |
1792 Following are some examples to demonstrate
1793 the interaction of the three precisions.
1795 - *display precision limitations for Calc formulas*
1796 - limited by Calc internal calculation precision from Org default
1798 : | 0.16666666666700 |
1799 : #+TBLFM: $1 = 1 / 2 * 3; f-14
1801 : | 0.1666666666670000000 |
1802 : #+TBLFM: $1 = 1 / 2 * 3; f-19
1804 - limited by Calc float format from Org default (here =f8=)
1806 : #+TBLFM: $1 = 1 / 2 * 3
1809 : #+TBLFM: $1 = 1 / 2 * 3; p20
1811 : | 0.16666667000000 |
1812 : #+TBLFM: $1 = 1 / 2 * 3; %.14f
1814 : | 0.16666667000000 |
1815 : #+TBLFM: $1 = 1 / 2 * 3; p20 %.14f
1817 - limited by Calc float format specified
1819 : #+TBLFM: $1 = 1 / 2 * 3; f-6
1821 : | 0.16666666666667 |
1822 : #+TBLFM: $1 = 1 / 2 * 3; p20 f-14
1824 : | 0.1666666666666666667 |
1825 : #+TBLFM: $1 = 1 / 2 * 3; p20 f-19
1827 - limited by =printf= conversion to Emacs Lisp float
1828 : | 0.1666666699999999900 | the inaccuracy is platform dependent |
1829 : #+TBLFM: $1 = 1 / 2 * 3; %.19f
1831 : | 0.1666666699999999900 | the inaccuracy is platform dependent |
1832 : #+TBLFM: $1 = 1 / 2 * 3; p20 %.19f
1834 : | 0.1666666666666666600 | the inaccuracy is platform dependent |
1835 : #+TBLFM: $1 = 1 / 2 * 3; p20 f-20 %.19f
1837 - limited by =printf= format specified
1839 : #+TBLFM: $1 = 1 / 2 * 3; %.6f
1841 - *display precision limitations for Emacs Lisp formulas*
1842 - limited by Emacs Lisp float
1843 : | 0.16666666666666666 |
1844 : #+TBLFM: $1 = '(/ 1.0 (* 2 3))
1846 : | 0.1666666666666666574 | the inaccuracy is platform dependent |
1847 : #+TBLFM: $1 = '(/ 1.0 (* 2 3)); %.19f
1849 - limited by =printf= format specified
1850 : | 0.16666666666667 |
1851 : #+TBLFM: $1 = '(/ 1.0 (* 2 3)); %.14f
1853 This FAQ entry is based on this [[http://thread.gmane.org/gmane.emacs.orgmode/22642][mailing list thread]]
1854 and is continued in the [[#table-float-fraction][next FAQ entry]].
1856 ** Which float format shows the fraction part also when the latter is zero?
1858 :CUSTOM_ID: table-float-fraction
1865 : #+TBLFM: $2 = $1; f-3
1868 : #+TBLFM: $2 = $1 +.0; f-3
1872 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]]
1873 in the section Mode Settings -> Display Modes -> Float Formats
1874 [[http://www.delorie.com/gnu/docs/calc/calc_163.html][found here as long as the section numbering is unchanged]].
1876 Remember the formula debugger, toggled with =C-c {=,
1877 to view the processing stages like:
1878 | | formula debugger label | processing stage |
1880 |---+------------------------+----------------------------|
1881 | | Result: | output of Calc |
1882 | | Format: | reformatting with =printf= |
1884 Following are some examples to demonstrate different float formats.
1887 : |-----------+---------+-------+---------+----------+-------|
1888 : | number | f3 | f-3 | +.0; f3 | +.0; f-3 | %.3f |
1889 : |-----------+---------+-------+---------+----------+-------|
1890 : | 1 | 1 | 1 | 1.000 | 1.000 | 1.000 |
1891 : | 0 | 0 | 0 | 0.000 | 0.000 | 0.000 |
1892 : |-----------+---------+-------+---------+----------+-------|
1893 : | 1.0 | 1.000 | 1.000 | 1.000 | 1.000 | 1.000 |
1894 : | 0.0 | 0.000 | 0.000 | 0.000 | 0.000 | 0.000 |
1895 : |-----------+---------+-------+---------+----------+-------|
1896 : | 1.0001666 | 1.000 | 1.000 | 1.000 | 1.000 | 1.000 |
1897 : | 0.0001666 | 1.67e-4 | 0.000 | 1.67e-4 | 0.000 | 0.000 |
1898 : |-----------+---------+-------+---------+----------+-------|
1899 : | 1.0016666 | 1.002 | 1.002 | 1.002 | 1.002 | 1.002 |
1900 : | 0.0016666 | 0.002 | 0.002 | 0.002 | 0.002 | 0.002 |
1901 : |-----------+---------+-------+---------+----------+-------|
1902 : #+TBLFM: $2 = $1; f3 :: $3 = $1; f-3 :: $4 = $1 +.0; f3 :: $5 = $1 +.0; f-3 :: $6 = $1; %.3f
1905 : |----------------------+--------------------------+-----------------------|
1906 : | number | f19 | f-19 |
1907 : |----------------------+--------------------------+-----------------------|
1910 : |----------------------+--------------------------+-----------------------|
1911 : | 1.0 | 1.0000000000000000000 | 1.0000000000000000000 |
1912 : | 0.0 | 0.0000000000000000000 | 0.0000000000000000000 |
1913 : |----------------------+--------------------------+-----------------------|
1914 : | 1 + 1 / 2 * 3 * 1e19 | 1.0000000000000000000 | 1.0000000000000000000 |
1915 : | 0 + 1 / 2 * 3 * 1e19 | 1.666666666666666667e-20 | 0.0000000000000000000 |
1916 : |----------------------+--------------------------+-----------------------|
1917 : | 1 + 1 / 2 * 3 * 1e18 | 1.0000000000000000002 | 1.0000000000000000002 |
1918 : | 0 + 1 / 2 * 3 * 1e18 | 0.0000000000000000002 | 0.0000000000000000002 |
1919 : |----------------------+--------------------------+-----------------------|
1920 : #+TBLFM: $2 = $1; p20 f19 :: $3 = $1; p20 f-19
1922 : |----------------------+--------------------------+-----------------------|
1923 : | number | +.0; f19 | +.0; f-19 |
1924 : |----------------------+--------------------------+-----------------------|
1925 : | 1 | 1.0000000000000000000 | 1.0000000000000000000 |
1926 : | 0 | 0.0000000000000000000 | 0.0000000000000000000 |
1927 : |----------------------+--------------------------+-----------------------|
1928 : | 1.0 | 1.0000000000000000000 | 1.0000000000000000000 |
1929 : | 0.0 | 0.0000000000000000000 | 0.0000000000000000000 |
1930 : |----------------------+--------------------------+-----------------------|
1931 : | 1 + 1 / 2 * 3 * 1e19 | 1.0000000000000000000 | 1.0000000000000000000 |
1932 : | 0 + 1 / 2 * 3 * 1e19 | 1.666666666666666667e-20 | 0.0000000000000000000 |
1933 : |----------------------+--------------------------+-----------------------|
1934 : | 1 + 1 / 2 * 3 * 1e18 | 1.0000000000000000002 | 1.0000000000000000002 |
1935 : | 0 + 1 / 2 * 3 * 1e18 | 0.0000000000000000002 | 0.0000000000000000002 |
1936 : |----------------------+--------------------------+-----------------------|
1937 : #+TBLFM: $2 = $1 +.0; p20 f19 :: $3 = $1 +.0; p20 f-19
1939 The =printf= reformatting (=%.19f=) cannot be used with high precision,
1940 see the [[#table-high-precision][previous FAQ entry]].
1942 ** How can I center tables in LaTeX output?
1944 :CATEGORY: centered-tables-in-latex
1947 Set the `org-export-latex-tables-centered' to `t':
1949 : (defcustom org-export-latex-tables-centered t
1950 : "When non-nil, tables are exported in a center environment."
1951 : :group 'org-export-latex
1956 :CUSTOM_ID: Footnotes
1958 ** How can I get automatic renumbering of footnotes in org-mode?
1960 :CUSTOM_ID: footnote-auto-adjust
1963 You can add the following line to your .emacs file:
1965 : (setq org-footnote-auto-adjust t)
1967 Or, if you prefer, you can turn this option on locally by placing the
1968 following line at the top of your org file:
1970 : #+STARTUP: fnadjust
1972 When auto-adjust is turned on, footnotes in the file with numerical
1973 labels will be renumbered whenever a new footnote is added. Meanwhile,
1974 all footnotes, including those with custom labels such
1975 =[fn:custom-label ]=, will be sorted in the order of their appearance
1978 This emulates the footnote behavior that many users may be familiar
1979 with from word-processing programs or from the footnote-mode included
1982 If you do not turn on org-footnote-auto-adjust, you sort and/or
1983 renumber footnotes at any time by calling org-footnote-action with a
1986 ** Why isn't auto renumbering of footnotes turned on by default?
1988 :CUSTOM_ID: why-no-default-auto-adjust
1991 Org mode has a very robust footnote mechanism allowing for a variety
1992 of types of footnotes. With some of the following footnote notations,
1993 auto-adjust may be either irrelevant or undesired:
1995 - Automatically numbered
1996 - Footnotes with custom labels
1999 In addition, org mode can be customized to place footnotes either at
2000 the end of a document or at the end of the outline heading in which
2001 they appear. Users who change this setting while editing a document
2002 may be disconcerted to find all of their footnotes rearranged
2005 ** I have auto-fill-mode set and org-mode is inserting unwanted comment markers!
2007 :CUSTOM_ID: auto-fill-and-unwanted-comments
2010 If the following occurs:
2015 ,# More entered tex.
2018 Make sure that the variable comment-start is nil.
2020 ** Are there any shortcuts for entering source blocks and comment lines?
2022 :CUSTOM_ID: shortcuts-for-entering-source-blocks
2025 Org mode has some [[http://orgmode.org/manual/Literal-examples.html#Literal-examples][very convenient markup]] for including literal blocks
2026 and lines of code in a file. (This is especially useful when exporting
2027 documents or using the contributed package [[file:org-contrib/babel/index.org][org-babel]] for executing
2032 , print "Hello, world!\n";
2036 It can be tiresome to enter the block comment lines manually. There
2037 are several possible shortcuts you can use to enter them:
2039 1) Built-in expansion
2041 - Org mode has a "secret" method of expanding source code blocks
2044 - If you type "<s" followed by =TAB= or =M-TAB=, a source block will
2047 - For a full list of expansions, type =M-x describe-variable
2048 [RET] org-structure-template-alist=.
2050 2) [[http://orgmode.org/manual/Literal-examples.html#Literal-examples][Registers]]
2052 - Add the following line to your emacs file:
2054 =(set-register ?p "#+begin_src\n\n#+end_src perl")=
2056 - Then type =C-x r i p= to insert the source block. Please note: if
2057 you save another value to the register "p" with =C-x r s p=, it
2058 will overwrite the setting above for the current emacs session.
2060 3) [[http://orgmode.org/manual/Literal-examples.html#Literal-examples][Abbrevs]]
2062 - Activate the abbrev minor-mode in org-mode:
2068 + =(add-hook 'org-mode-hook (lambda () (abbrev-mode 1)))=
2070 - In org-mode, type "sbp" (a sample abbreviation for a perl source
2073 - Immediately after "sbp" type =C-x a i l=.
2075 - Enter the expansion:
2077 - =#+begin_src perl[C-q C-j][C-q C-j]#+end_src=
2079 - Note: =C-q C-j= creates a new line in the minibuffer
2081 - Now, whenever, you type sbp followed by =SPACE= or =RET= in an
2082 org-mode buffer, the src block will magically appear.
2084 - To review your list of abbrevs, type =M-x edit-abbrevs=.
2086 4) [[http://www.slashgear.com/nokia-n900-android-dual-boot-hack-video-2371099/][Skeletons]]
2088 - Skeletons offer a simple way of automatically entering text.
2089 Here's a skeleton that queries for the type of block and wraps
2090 the active region inside it:
2093 (define-skeleton skel-org-block
2094 "Insert an org block, querying for type."
2101 - Simply type skel-org-block to insert the block.
2103 - You can bind this to a key.
2105 - You can also create an abbrev that invokes this function:
2107 : (define-abbrev org-mode-abbrev-table "blk" "" 'skel-org-block)
2109 5) [[http://code.google.com/p/yasnippet/][Yasnippet]]
2111 - Several org-mode users install yasnippet for convenient, complex
2114 - See Bernt Hansen's [[http://doc.norang.ca/org-mode.html#Yasnippets][org-mode setup]] for a good introduction to
2117 * Capture and remember
2119 :CUSTOM_ID: Remember
2121 ** Can I use a variable or a function inside the `org-capture-templates' variable?
2123 :CUSTOM_ID: variable-inside-capture-templates
2126 Yes. Use [[http://www.gnu.org/s/emacs/manual/html_node/elisp/Backquote.html][backquotes]].
2128 E.g. if you have a variable called =org-test-file= and you want the
2129 variable =org-capture-templates= to "understand" (i.e. evaluate)
2130 =org-test-file= when Emacs evaluates the =(setq org-capture-templates
2131 [...])= expression, use backquotes like this:
2133 #+begin_src emacs-lisp
2134 (setq org-capture-templates
2135 `(("t" "Todo" entry (file+headline ,org-test-file "Tasks")
2136 "* TODO %?\n %i\n %a")
2137 ("b" "Buy" item (file+olp ,org-test-file "Stuff to Buy" "House")
2141 ** Can I use the remember buffer to clock a customer phone call?
2143 :CUSTOM_ID: use-remember-buffer-to-clock-phone-call
2146 Yes, you can. Take a look at the [[http://thread.gmane.org/gmane.emacs.orgmode/5482][setup described by Bernt Hansen]]
2147 and check out (in the same thread) what Nick Docos had to fix to
2148 make Bernt's set-up work for him.
2149 ** Can I automatically start the clock when opening a remember template?
2151 :CUSTOM_ID: start-clock-when-opening-remember-template
2154 Yes, this is possible. Use the following code and make sure that
2155 after executing it, `my-start-clock-if-needed' is in
2156 `remember-mode-hook' /after/ `org-remember-apply-template'.
2158 : (add-hook 'remember-mode-hook 'my-start-clock-if-needed 'append)
2159 : (defun my-start-clock-if-needed ()
2161 : (goto-char (point-min))
2162 : (when (re-search-forward " *CLOCK-IN *" nil t)
2163 : (replace-match "")
2166 Then, when a template contains the key string CLOCK-IN, the clock
2167 will be started. Starting with Org-mode version 5.20, the clock will
2168 automatically be stopped when storing the remember buffer.
2172 :CUSTOM_ID: Searches
2174 ** Isearch does not find string hidden in links. What can I do?
2176 :CUSTOM_ID: isearch-in-links
2179 M-x =visible-mode= will display the full link, making them searchable.
2181 ** How can I reduce the amount of context shown in sparse trees?
2183 :CUSTOM_ID: context-in-sparse-trees
2186 Take a look at the following variables:
2188 - =org-show-hierarchy-above=
2189 - =org-show-following-headline=
2190 - =org-show-siblings=
2191 - =org-show-entry-blow=
2193 which give command-dependent control over how much context is shown
2194 by a particular operation.
2196 ** How can I combine the results of two calls to =org-occur=?
2198 :CUSTOM_ID: two-calls-to-org-occur
2201 You can construct a regular expression that matches all targets you
2202 want. Alternatively, use a =C-u= prefix with the second and any
2203 further calls to =org-occur= to keep the current visibility and
2204 highlighting in addition to the new ones.
2210 ** How can I change the advanced warning time for deadlines?
2212 :CUSTOM_ID: warning-period-for-deadlines
2214 ##<<warning-period-for-deadlines>>
2216 Deadline warnings appear in the daily agenda view a specified number
2217 of days before the deadline is due. The default setting is 14 days.
2218 You can change this with the variable =org-deadline-warning-days=.
2219 (See [[http://orgmode.org/manual/Deadlines-and-scheduling.html#Deadlines-and-scheduling][this section]] of the manual.)
2223 : (setq org-deadline-warning-days 30)
2225 would cause warnings for each deadline to appear 30 days in advance.
2227 Naturally, you might not want warnings for all of your deadlines to
2228 appear so far in advance. Thus, you can change the lead time for
2229 individual items as follows:
2231 : * TODO Get a gift for the party
2232 : DEADLINE: <2009-01-16 Fri -2d>
2234 The "-2d" above changes the lead time for this deadline warning to two
2235 days in advance. You can also use "w" for weeks and "m" for months.
2236 ** How can I postpone a task until a certain date?
2238 :CUSTOM_ID: deferring-tasks
2241 The easiest way to postpone a task is to schedule it in the future.
2242 For instance, typing =C-c C-s +2w= on a headline will push a task two
2243 weeks into the future, so that it won't show up on the daily agenda
2244 until two weeks from now.
2246 If you'd like to prevent the task from showing up on your global todo
2247 list, you have a couple of options.
2249 1. You can set the variable =org-agenda-todo-ignore-scheduled= to =t=.
2250 This will exclude any scheduled items from your global list of
2251 active todos (=C-c a t=). (The variable
2252 =org-agenda-todo-ignore-with-date= will exclude both scheduled and
2253 deadline items from your todo list).
2254 2. You can remove the todo keyword from the item (C-c C-t <SPC>). The
2255 item will still appear on your agenda two weeks from today, but it
2256 won't show up on your todo lists.
2257 ** Can I send myself an email containing tasks or other agenda info?
2259 :CUSTOM_ID: email-containing-tasks-or-other-agenda-info
2262 Yes. See [[http://article.gmane.org/gmane.emacs.orgmode/6112][this thread]] on the list.
2264 ** How can I limit the agenda view to my "work" tasks?
2266 :CUSTOM_ID: limit-agenda-with-tag-filtering
2269 It is often convenient to group org files into separate categories,
2270 such as "home" and "work" (or "personal" and "professional"). One
2271 of the main reasons for such classification is to create agenda
2272 views that are limited by type of work or area of responsibility.
2273 For instance, while at work, one may want to see only professional
2274 tasks; while away from work, one may want to see only personal
2277 One way to categorize files and tasks is to use a "#+FILETAGS"
2278 declaration at the top of each file, such as:
2282 As long as org-use-tag-inheritance is turned on, the filetags will
2283 be inherited by all tasks in the file. A file can have multiple
2284 filetags. And, of course, tags can be added to individual headings.
2286 Tasks can be quickly filtered by tag from within the agenda by
2287 typing "/" and the name of the tag. The full key sequence to filter
2288 for work items in an agenda view would be:
2290 : C-c a a / work [or a tag shortcut]
2292 ** How can I limit the agenda view to a particular category?
2294 :CUSTOM_ID: limit-agenda-with-category-match
2297 Another way to filter agenda views by type of work is to use a
2298 "#+CATEGORY" declaration at the top of each file, such as:
2302 Categories can also be added to individual headings within a file:
2309 All todos belonging to the category "work" can be found a with a
2310 simple tags-todo search:
2314 At the prompt, type:
2318 The same results can be achieved with custom agenda commands, such as:
2320 #+BEGIN_SRC emacs-lisp
2321 (setq org-agenda-custom-commands
2322 '(("h" tags-todo "CATEGORY=\"home\"")
2323 ("w" tags-todo "CATEGORY=\"work\"")
2324 ;; other custom agenda commands here
2328 ** How can include all org files in a directory in my agenda?
2330 :CUSTOM_ID: set-agenda-files-using-wildcards
2333 You can simply include the directory (as one of the items) in the
2334 value of the variable org-agenda-files:
2336 : (setq org-agenda-files '("/my/special/path/org/"))
2338 There is another way of accomplishing the same end:
2340 : (setq org-agenda-files (file-expand-wildcards "/my/special/path/org/*.org"))
2342 ** Why aren't items disappearing from my agenda once they are marked done?
2344 :CUSTOM_ID: removing-done-items-from-agenda
2347 If items remain on your daily/weekly agenda after they are marked
2348 done, check the configuration of the following variables:
2350 : org-agenda-skip-scheduled-if-done
2351 : org-agenda-skip-deadline-if-done
2352 : org-agenda-skip-timestamp-if-done
2356 : M-x customize-variable RET org-agenda-skip-scheduled-if-done
2358 If this variable is turned off (=nil=), then scheduled items will
2359 remain on the agenda even after they are marked done.
2361 If the variable is turned on (=t=), then scheduled items will
2362 disappear from the agenda after they are marked done.
2364 If these settings seem not to behave the way you expect, then make
2365 sure you understand [[scheduled-vs-deadline-vs-timestamp][the
2366 difference between SCHEDULED, DEADLINE, and timestamps]].
2368 ** How do I keep repeating timestamps from being displayed multiple times?
2370 :CUSTOM_ID: repeating-timestamps-show-once
2373 To show only the /current/ instance of a repeating timestamp, put the
2374 following in your .emacs:
2376 #+begin_src emacs-lisp
2377 (setq org-agenda-repeating-timestamp-show-all nil)
2380 ** What is the difference between SCHEDULED, DEADLINE, and plain timestamps?
2382 :CUSTOM_ID: scheduled-vs-deadline-vs-timestamp
2385 1. SCHEDULED items (set with =C-c C-s=) will appear on your agenda on
2386 the day they are scheduled and on every day thereafter until they
2387 are done. Schedule a task if you want to be reminded to do
2388 something beginning on a certain day and until it is done.
2390 : ** TODO Scheduled item
2391 : SCHEDULED: <2009-03-01 Sun>
2393 2. Items with a DEADLINE timestamp (set with =C-c C-d=) appear on your
2394 agenda in advance of the when they are due and remain on your
2395 agenda until they are done. Add a DEADLINE to an item if you want
2396 to make sure to complete it by a certain date. (The variable
2397 org-deadline-warning-days determines how far in advance items with
2398 deadlines will show up in the agenda. See [[warning-period-for-deadlines][this FAQ]] for more
2401 : ** TODO Item with a deadline
2402 : DEADLINE: <2009-01-20 Tue>
2404 3. An active timestamp (set with =C-c .=) will appear on your agenda
2405 only on the day it is scheduled. Use a timestamp for appointments
2406 or any reminders you want to show up only on a particular day.
2408 : ** TODO Item with an active timestamp
2411 Note: items with inactive timestamps (set with C-c ! and marked by
2412 square brackets) will not show up in the agenda at all.
2414 ** Can I add files recursively to my list of agenda files?
2416 :CUSTOM_ID: set-agenda-files-recursively
2419 Yes, you can use the library "find-lisp."
2421 : (load-library "find-lisp")
2422 : (setq org-agenda-files (find-lisp-find-files "~/org" "\.org$"))
2424 This will add all files ending in =org= in the directory "~/org"
2425 and all of its subdirectories to your list of agenda files.
2427 See [[http://thread.gmane.org/gmane.emacs.orgmode/8992][this thread]] on the mailing list for more information.
2429 ** Why does an item appearing at the wrong time of day in my agenda?
2431 :CUSTOM_ID: agenda-wrong-time-of-day
2434 When preparing the agenda view, org-mode scans each relevant headline
2435 for a time designation. This approach is very nice for adding
2436 free-form timestamps to an item for scheduling. Thus, either of the
2437 following work would work to schedule an item at 10:00am:
2440 ,** 10:00am Get dried ice at the magic store
2441 , SCHEDULED: <2009-05-27 Wed>
2445 ,** Get dried ice at the magic store
2446 , SCHEDULED: <2009-05-27 Wed 10:00>
2449 To enable this flexibility, org-mode scans the entire headline for
2450 time of day notation. A potential problem can arise if you use
2451 inactive timestamps in the headline to note when an item was created.
2455 ,** Get dried ice at the magic store [2009-05-26 Tue 12:58]
2456 , SCHEDULED: <2009-05-27 Wed>
2459 Org mode would interpret the time in the inactive timestamp as a
2460 time-of-day indicator and the entry would appear in your agenda at
2463 If you would like to turn off the time-of-day search, you can
2464 configure the variable =org-agenda-search-headline-for-time= (requires
2467 ** How can I change the visibility of an item from the agenda?
2469 :CUSTOM_ID: cycling-visibility-from-agenda
2472 You can add a keybinding as follows:
2474 #+begin_src emacs-lisp
2475 (add-hook 'org-agenda-mode-hook
2477 (define-key org-agenda-mode-map " " 'org-agenda-cycle-show)))
2480 Then, as you press SPACE on an item on the agenda, it will cycle the
2481 visibility of its original location.
2483 ** Is there any way to set org-mode so that tags don't appear in the agenda view?
2485 See the =org-agenda-remove-tags= variable.
2487 ** I work late at night! How can I extend my current day past midnight?
2489 :CUSTOM_ID: org-extend-today-until
2492 If you work past midnight, you may not want your daily agenda view to
2493 switch to the next day at 12 a.m. (the default). To extend your day,
2494 simply set the value of org-extend-today-until to a positive number
2495 corresponding to the number of hours you work past midnight. For
2496 example, the following setting will cause the current day to extend
2499 : (setq org-extend-today-until 6)
2501 * Appointments/Diary
2503 :CUSTOM_ID: Appointments/Diary
2505 ** Is it possible to include entries from org-mode files into my emacs diary?
2507 :CUSTOM_ID: include-entries-from-org-mode-files-into-emacs-diary
2510 Since the org-mode agenda is much more powerful and can contain the
2511 diary, you should think twice before deciding to do this. If you
2512 insist, however, integrating Org-mode information into the diary is
2513 possible. You need to turn on /fancy diary display/ by setting in
2516 : (add-hook 'diary-display-hook 'diary-fancy-display)
2518 Then include the following line into your ~/diary file, in
2519 order to get the entries from all files listed in the variable
2524 You may also select specific files with
2526 : &%%(org-diary) ~/path/to/some/org-file.org
2527 : &%%(org-diary) ~/path/to/another/org-file.org
2529 If you now launch the calendar and press @<tt>d@</tt> to display a
2530 diary, the headlines of entries containing a timestamp, date range,
2531 schedule, or deadline referring to the selected date will be listed.
2532 Just like Org-mode's agenda view, the diary for /today/ contains
2533 additional entries for overdue deadlines and scheduled items. See
2534 also the documentation of the =org-diary= function. Under XEmacs, it
2535 is not possible to jump back from the diary to the org, this works
2536 only in the agenda buffer.
2537 ** I want to add my Org scheduled/deadlined entries in my diary!
2539 :CUSTOM_ID: add-Org-scheduled/deadlined-entries-to-diary!
2542 Put this in your ~/.diary:
2544 : &%%(org-diary :scheduled :timestamp :deadline)
2546 ** How can I set up automatic reminders based on Org information?
2548 :CUSTOM_ID: automatic-reminders
2551 See [[http://article.gmane.org/gmane.emacs.orgmode/5271][this post]] by N. Dokos on the list.
2552 ** How can I make =appt= notice my Org appointments?
2554 :CUSTOM_ID: appt-notice-my-Org-appointments
2557 : M-x org-agenda-to-appt RET
2559 ** How can I create more complex appointments in my org-files?
2561 :CUSTOM_ID: diary-sexp-in-org-files
2564 Org-mode's active timestamps work very well for scheduling individual
2565 or recurring appointments, such as:
2568 ,* 8:00am Dentist appointment <2009-01-16 Fri>
2574 , <2009-03-20 Fri>--<2009-04-01 Wed>
2580 ,* Weekly meeting with boss
2581 , <2009-01-20 Tue 14:00 +1w>
2584 Sometimes, however, you need to set up more complicated recurring
2585 appointments. Org-mode has built-in support for many of
2586 [[http://www.gnu.org/software/emacs/manual/html_node/emacs/Sexp-Diary-Entries.html][the
2587 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
2588 instance, that you teach a class that meets every Monday evening
2589 between February 16 and April 20, 2009. The way to enter this an
2593 ,** Class 7:00pm-9:00pm
2594 , <%%(and (= 1 (calendar-day-of-week date)) (diary-block 2 16 2009 4 20 2009))>
2597 The expression above designates all Mondays that fall between February
2598 16 and April 20. How exactly does it work?
2600 - (and... :: Indicates that *both* of the conditions that follow have
2603 - (= 1 (calendar-day-of-week date)) :: Is the day of the week a
2606 - Note: the function calendar-day-of-week converts the date to the day of week
2607 expressed in numeric form, where 0 = Sunday, 1 = Monday, and so on.
2609 - (diary-block 2 16 2009 4 20 2009) :: Does the date fall between
2612 You can make a sexp as complex as you like. If you wanted to omit a
2613 week because of holidays, for instance, you could add another
2614 condition to the sexp:
2617 ,** Class 7:00pm-9:00pm
2618 , <%%(unless (diary-block 3 9 2009 3 13 2009) (and (= 1 (calendar-day-of-week date)) (diary-block 2 16 2009 4 20 2009)))>
2621 The sexp above would omit Monday during the week of March 9, 2009. For
2622 another way to accomplish the same thing, see [[org-diary-class][this FAQ]].
2624 Another diary function commonly used for more complex scheduling is
2625 diary-float. For instance,
2629 , <%%(diary-float t 3 3)>
2632 ...would appear on the third Wednesday of every month.
2634 For more ideas on how to create diary special expressions, see [[http://www.emacswiki.org/cgi-bin/wiki/DiaryMode][this
2635 page on the Emacs wiki]].
2637 ** How can I schedule a weekly class that lasts for a limited period of time?
2639 :CUSTOM_ID: org-diary-class
2642 Org-mode offers a convenient diary sexp function for setting up a
2643 recurring appointment that lasts for a certain period of time, such as
2644 a class. It is called org-diary-class and it can be entered as
2648 ,** Class 7:00pm-9:00pm
2649 , <%%(org-diary-class 2 16 2009 4 20 2009 1 10)>
2652 The function above schedules an appointment for every Monday (1)
2653 between February 16 and April 20, 2009, except for ISO week 10 (March
2656 The function org-diary-class has the following format:
2658 : (org-diary-class M1 D1 Y1 M2 D2 Y2 DAYNAME &rest SKIP-WEEKS)
2660 M1/2, D1/2, and Y1/2 indicate the beginning and ending dates. Dayname
2661 takes the form of a number indicating the day of the week (0 = Sunday,
2662 1 = Monday, and so on...). In addition, one can add an optional
2663 argument SKIP-WEEKS to indicate weeks on the calendar that should be
2664 skipped. This argument should be expressed as an ISO week number. You
2665 can find the number by invoking emacs' built-in calendar (=M-x
2666 calendar=), navigating to the appropriate week, and typing =p c=
2667 (calendar-iso-print-date).
2669 Please note: the order of the month, day, and year arguments depends
2670 on the variables =calendar-date-style= and/or
2671 =european=calendar=style=. (See the documentation for these variables
2672 with C-h v or M-x describe variable.) For instance, the example above
2673 works if =calendar-date-style= is set to ='american=. If
2674 =calendar-date-style= is set to ='iso=, then the arguments to the
2675 org-diary-class sexp would have the following format:
2677 : (org-diary-class Y1 M1 D1 Y2 M2 D2 DAYNAME &rest SKIP-WEEKS)
2679 Here is an alternative method, shared by Paul Sexton on the org
2682 Let's say you are taking night classes in Spanish. The class is every
2683 Wednesday evening at 7pm, starting on 18 August, and runs for 8 weeks.
2684 Org-mode's timestamps do not support limited occurrences of recurrent
2685 items -- you have to schedule the item with infinite recurrences, then
2686 delete it when it finishes.
2688 To schedule the Spanish classes, put the following in your =.emacs=:
2690 #+begin_src emacs-lisp
2691 (defun diary-limited-cyclic (recurrences interval m d y)
2692 "For use in emacs diary. Cyclic item with limited number of recurrences.
2693 Occurs every INTERVAL days, starting on YYYY-MM-DD, for a total of
2694 RECURRENCES occasions."
2695 (let ((startdate (calendar-absolute-from-gregorian (list m d y)))
2696 (today (calendar-absolute-from-gregorian date)))
2697 (and (not (minusp (- today startdate)))
2698 (zerop (% (- today startdate) interval))
2699 (< (floor (- today startdate) interval) recurrences))))
2701 The item in the org file looks like this:
2704 ,** 19:00-21:00 Spanish lessons
2705 , <%%(diary-limited-cyclic 8 7 8 18 2010)>
2708 ** How can I set an event to occur every day except Saturday and Sunday?
2712 , <%%(memq (calendar-day-of-week date) '(1 2 3 4 5))>
2715 ** How do I schedule events relative to Easter Sunday?
2717 Easter's date moves around from year to year according to a
2718 complicated set of criteria which I do not claim to understand.
2719 However the following code will allow you to schedule recurring
2720 events relative to Easter Sunday.
2722 Note: the function da-easter is from:
2723 http://github.com/soren/elisp/blob/master/da-kalender.el
2725 Put the following in your .emacs:
2727 #+begin_src emacs-lisp
2728 (defun da-easter (year)
2729 "Calculate the date for Easter Sunday in YEAR. Returns the date in the
2730 Gregorian calendar, ie (MM DD YY) format."
2731 (let* ((century (1+ (/ year 100)))
2732 (shifted-epact (% (+ 14 (* 11 (% year 19))
2733 (- (/ (* 3 century) 4))
2734 (/ (+ 5 (* 8 century)) 25)
2737 (adjusted-epact (if (or (= shifted-epact 0)
2738 (and (= shifted-epact 1)
2739 (< 10 (% year 19))))
2742 (paschal-moon (- (calendar-absolute-from-gregorian
2745 (calendar-dayname-on-or-before 0 (+ paschal-moon 7))))
2748 (defun da-easter-gregorian (year)
2749 (calendar-gregorian-from-absolute (da-easter year)))
2751 (defun calendar-days-from-easter ()
2752 "When used in a diary sexp, this function will calculate how many days
2753 are between the current date (DATE) and Easter Sunday."
2754 (- (calendar-absolute-from-gregorian date)
2755 (da-easter (calendar-extract-year date))))
2758 Now we can schedule the public holidays associated with Easter as
2759 recurring events. Good Friday is 2 days before "Easter", Easter
2760 Monday is one day after.
2764 , <%%(= -2 (calendar-days-from-easter))>
2767 , <%%(= 0 (calendar-days-from-easter))>
2770 , <%%(= 1 (calendar-days-from-easter))>
2772 [Source: Posted by Paul Sexton on Org-mode mailing list.]
2774 ** How to schedule public holiday that is "the nearest Monday to DATE"?
2776 In New Zealand each regional capital has an "Anniversary Day". The
2777 date of Auckland's anniversary day is "the nearest Monday to 29
2780 Put this in your =.emacs=:
2782 #+begin_src emacs-lisp
2783 (defun calendar-nearest-to (target-dayname target-day target-month)
2784 "Recurring event that occurs in the nearest TARGET-DAYNAME to
2785 the date TARGET-DAY, TARGET-MONTH each year."
2787 (let* ((dayname (calendar-day-of-week date))
2788 (target-date (list target-month target-day (calendar-extract-year date)))
2789 (days-diff (abs (- (calendar-day-number date)
2790 (calendar-day-number target-date)))))
2791 (and (= dayname target-dayname)
2795 Now we can schedule Auckland Anniversary Day. The first argument,
2796 1, means Monday (days of the week are numbered starting with
2799 [Source: Originally posted by Paul Sexton on Org-mode mailing list.]
2801 ** How to schedule public holiday on "the 4th Monday in October"?
2803 This does not require any additions to =.emacs=:
2807 , <%%(diary-float 10 1 4)>
2810 ** Why isn't the agenda showing all the times I put under a single entry?
2812 :CATEGORY: multiple-timestamps-same-entry
2815 Probably because you have not set the following variable:
2817 : org-agenda-skip-additional-timestamps-same-entry
2819 The default value of this variable is t, which means that entries with
2820 multiple timestamps, such as the following...
2823 ,* Work really, really hard
2824 , <2010-11-20 Sat 10:00>
2825 , <2010-11-20 Sat 14:00>
2828 ...will only appear in the agenda at the time specified by the first
2829 timestamp. If you set org-agenda-skip-additional-timestamps-same-entry
2830 to nil, the item will appear will appear at all the times you specify.
2836 ** Can I get TODO items exported to HTML as lists, rather than as headlines?
2838 :CUSTOM_ID: export-TODO-items-as-lists
2841 If you plan to use ASCII or HTML export, make sure things you want to
2842 be exported as item lists are level 4 at least, even if that does
2843 mean there is a level jump. For example:
2845 : * Todays top priorities
2846 : **** TODO write a letter to xyz
2847 : **** TODO Finish the paper
2848 : **** Pick up kids at the school
2850 Alternatively, if you need a specific value for the heading/item
2851 transition in a particular file, use the =#+OPTIONS= line to
2852 configure the H switch.
2854 : #+OPTIONS: H:2; ...
2856 ** Can I export only a single subtree?
2858 :CUSTOM_ID: export-single-subtree
2861 If you want to export a subtree, mark the subtree as region and then
2862 export. Marking can be done with =C-c @ C-x C-x=, for example.
2864 Alternatively, you can select option =1= in the org export dispatcher
2865 (e.g.., =C-c C-e 1 h= to export the current subtree to html).
2867 By default, the title of the exported file will be set to the heading
2868 of the subtree. You can, however, [[#export-options-for-subtree][customize the title and other export
2871 ** How can I customize export options for a single subtree?
2873 :CUSTOM_ID: export-options-for-subtree
2876 You can set unique export options for a [[#export-single-subtree][single subtree]] by using
2877 properties. Relevant properties include:
2883 - EXPORT_OPTIONS (corresponds to the =#+OPTIONS:= [[http://orgmode.org/manual/Export-options.html#Export-options][configuration line]])
2885 ** How can I tell my calendar web application about appointments in my agenda files?
2887 Here is what you need to do:
2889 1. a script that calls Emacs in batch mode and produce a .ics file
2890 2. a script that uploads this .ics file somewhere on the web
2891 3. tell your webapp to fetch this .ics file on the web
2893 Here is the script I use for the first step:
2895 #+begin_src shell-script-mode
2898 /usr/local/bin/emacs --batch --eval \
2899 "(progn (load-file \"~/install/git/org-mode/org.el\") \
2900 (load-file \"~/elisp/config/org-batch-config.el\") \
2901 (setq org-combined-agenda-icalendar-file \"~/org/cal/org.ics\")
2902 (setq org-agenda-files (quote (\"~/org/bzg.org\"))))" \
2903 -f org-export-icalendar-combine-agenda-files
2906 Depending on your configuration, you might change the load sequence.
2908 Here is the script I use for the second step:
2910 #+begin_src shell-script-mode
2912 /usr/bin/rsync -rtv ~/org/org.ics -e ssh me@my_server:/home/me/public_html/
2915 Note: if you want to cron this rsync script, you will need to let
2916 =my_server= to know about your SSH public key. Check [[http://troy.jdmz.net/rsync/index.html][this page]] as a
2919 Now you can cron the two scripts above and your webapp will always be
2920 up to date with your Org agendas.
2922 Also see [[http://orgmode.org/org.html#Exporting-Agenda-Views][Exporting agenda views]] from Org manual.
2924 ** How can I get Mac OSX 10.3 iCal to import my Org-exported .ics files?
2926 :CUSTOM_ID: iCal-import-ics-files-old
2929 When using iCal under Apple MacOS X Tiger, you can create a new
2930 calendar /OrgMode/ (the default name for the calendar created by =C-c
2931 C-e c=, see the variables =org-icalendar-combined-name= and
2932 =org-combined-agenda-icalendar-file=). Then set Org-mode to
2933 overwrite the corresponding file /~/Library/Calendars/OrgMode.ics/.
2934 You may even use AppleScript to make iCal re-read the calendar files
2935 each time a new version of /OrgMode.ics/ is produced. Here is the
2936 setup needed for this:
2938 : (setq org-combined-agenda-icalendar-file
2939 : "~/Library/Calendars/OrgMode.ics")
2940 : (add-hook 'org-after-save-iCalendar-file-hook
2943 : "osascript -e 'tell application \"iCal\" to reload calendars'")))
2945 ** How can I get Mac OSX 10.4 or later iCal to import my Org-exported .ics files?
2947 :CUSTOM_ID: iCal-import-ics-files-new
2950 For Mac OS X 10.4, you need to write the ics file to
2951 =/Library/WebServer/Documents/= and then subscribe iCalendar to
2952 =http: //localhost/orgmode.ics=
2954 ** How can I remove timestamps and todo keywords from my exported file?
2956 :CUSTOM_ID: export-options-remove-timestamps
2959 You can place an options line at the top of your org file:
2961 : #+OPTIONS: <:nil todo:nil
2963 There is a whole host of export options you can set with an in-buffer
2964 options or via global variables. See [[http://orgmode.org/manual/Export-options.html#Export-options][this section]] of the manual for a
2967 ** How can I preserve faces when I export an agenda from the command line?
2969 :CUSTOM_ID: preserving-faces-during-batch-export
2972 Normally, when you export an org file or an agenda view from within
2973 emacs, htmlize will convert your face definitions to direct color css
2974 styles inlined into each =<span>= object, resulting in an HTML output
2975 that preserves the general look of your Org buffers and agenda views.
2977 Let's say you generate an export from the command line, such as the
2980 : emacs -batch -l ~/.emacs -eval '(org-batch-agenda "e")'
2984 : emacs -batch -l ~/.emacs -eval '(org-publish-all)'
2986 In such an instance, the exported HTML will contain only very basic
2987 color styles. The reason is that when Emacs is run in batch mode, it
2988 does not have a display and therefore only rudimentary face
2989 definitions. If you'd like to use more complex styles, you'll have to
2990 make sure that the export process only assigns classes instead of
2991 direct color values. This can be done by binding the variable
2992 =org-export-htmlize-output-style= to =css= for the duration of the
2993 export, for example with
2995 : emacs -batch -l ~/.emacs
2996 : -eval '(let ((org-export-htmlize-generate-css (quote css)))
2997 : (org-batch-agenda "e"))'
2999 Then you can use a style file to make these classes look any way you
3000 like. To generate face definitions for a CSS file based on any faces
3001 you are currently using in Emacs, you can use the following command:
3003 : M-x org-export-htmlize-generate-css RET
3005 This will generate a =<style>...</style>= section, the content of
3006 which you can add to your style file.
3008 ** How can I avoid dark color background when exporting agenda to ps format?
3010 :CUSTOM_ID: avoiding-dark-background-when-exporting-agenda
3013 Add this to your .emacs and evaluate it.
3015 #+BEGIN_SRC emacs-lisp
3016 (setq org-agenda-exporter-settings
3017 '((ps-print-color-p 'black-white)))
3020 ** How can I include e.g. an abstract in export to Latex and HTML?
3022 :CUSTOM_ID: include-abstract-in-export-to-latex-and-html
3025 Org does not currently have special markup for abstracts, but for
3026 export purposes, you can extend the block-level structural and
3027 semantic markup in Org with the contributed package [[file:org-contrib/org-special-blocks.org][org-special-blocks]]
3028 (by Chris Gray). To turn it on, put this in your =.emacs=:
3030 : (require 'org-special-blocks)
3032 Now, you can mark up the abstract of your article like this:
3035 : Falling apples were observed and compared with pears. Newton's laws
3036 : were confirmed at the 95% confidence level.
3039 Exporting to Latex wraps this in a
3040 =\begin{abstract}....\end{abstract}= environment, which just works.
3042 HTML export wraps it in a ~<div class="abstract">...</div>~
3043 element. The HTML result won't look like anything special until you
3044 style it. Here is some sample CSS to get you started; put these in
3045 your document header:
3047 : #+STYLE: <style>.abstract {margin: 1em; padding: 1em; border: 1px solid black}
3048 : #+STYLE: .abstract:before {content: "Abstract: "; font-weight: bold}</style>
3050 Generally, =#+begin_foo= will work for any simple Latex =foo=
3051 environment not supported by existing Org markup.
3053 If you need to pass parameters, process the block content in some way,
3054 or support other exporters, you may want to consider whether you can
3055 customize it using Eric Schulte's [[file:org-contrib/org-exp-blocks.org][org-exp-blocks]] instead.
3057 ** How can I get colored source code when exporting to LaTeX?
3059 :CUSTOM_ID: fontified_source_code_w_latex
3062 As of Sun Aug 9 2009 the "current" version of Org-mode (see
3063 [[keeping-current-with-Org-mode-development]]) supports exporting
3064 source code to LaTeX using the listings package.
3066 To turn on listing export add the following to your Org-mode
3068 #+begin_src emacs-lisp
3069 ;; requite org-latex so that the following variables are defined
3070 (require 'org-latex)
3072 ;; tell org to use listings
3073 (setq org-export-latex-listings t)
3075 ;; you must include the listings package
3076 (add-to-list 'org-export-latex-packages-alist '("" "listings"))
3078 ;; if you want colored source code then you need to include the color package
3079 (add-to-list 'org-export-latex-packages-alist '("" "color"))
3082 The listings package will now be used to fontify source code in your
3083 LaTeX documents. By default listings will not color any of your
3084 source code. If you would like to set colors for keywords and
3085 comments in your latex documents you can do so using LaTeX directives
3088 \lstset{keywordstyle=\color{blue},
3089 commentstyle=\color{red},
3090 stringstyle=\color{green}
3094 of if you want to get even fancier with your colors you can try
3095 something like the following
3097 \definecolor{keywords}{RGB}{255,0,90}
3098 \definecolor{comments}{RGB}{60,179,113}
3099 \definecolor{fore}{RGB}{249,242,215}
3100 \definecolor{back}{RGB}{51,51,51}
3102 basicstyle=\color{fore},
3103 keywordstyle=\color{keywords},
3104 commentstyle=\color{comments},
3105 backgroundcolor=\color{back}
3109 For more complex listings use cases consult the [[ftp://ftp.tex.ac.uk/tex-archive/macros/latex/contrib/listings/listings.pdf][listings manual]].
3111 ** How can I export to Latex Beamer
3115 The latex [[http://latex-beamer.sourceforge.net/][Beamer Class]] is a useful class for generating slide shows.
3116 The following can be used to export Org-mode documents to LaTeX
3119 Add the following to your Emacs initialization file.
3120 #+begin_src emacs-lisp
3121 (unless (boundp 'org-export-latex-classes)
3122 (setq org-export-latex-classes nil))
3123 (add-to-list 'org-export-latex-classes
3125 "\\documentclass[11pt]{beamer}\n\\usepackage[utf8]{inputenc}\n\\usepackage[T1]{fontenc}\n\\usepackage{hyperref}\n\\usepackage{verbatim}\n"
3126 ("\\section{%s}" . "\\section*{%s}")
3127 ("\\begin{frame}\\frametitle{%s}" "\\end{frame}"
3128 "\\begin{frame}\\frametitle{%s}" "\\end{frame}")))
3132 : #+LaTeX_CLASS: beamer
3133 in the header of your Org-mode document it will automatically export
3134 to the Beamer document class on LaTeX export. With the above
3135 configuration top-level headers will be mapped to sections in the
3136 Beamer document, second-level headers will be mapped to frames, and
3137 lower level headlines will be mapped to itemize objects.
3139 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
3140 Thomas Dye]]. For a much more complex Beamer setup see the [[http://article.gmane.org/gmane.emacs.orgmode/17767/match=beamer+dokos][email by
3143 ** How can I use RefTeX in Org-mode files for LaTeX export and in Org-babel LaTeX code blocks?
3145 :CUSTOM_ID: using-reftex-in-org-mode
3148 [[http://www.gnu.org/software/auctex/reftex.html][RefTeX]] is an indispensable tool for the author of LaTeX documents. It
3149 aids in creation of bibliographies, cross-references, indexes, and
3150 glossaries. RefTeX understands the structure of multi-file LaTeX
3151 documents and is able to collect from them information about the
3152 location(s) of external data stores used in creation of the final
3153 document. RefTeX was written by Carsten Dominik and is currently
3154 being maintained by the [[http://www.gnu.org/software/auctex/index.html][AucTeX]] project.
3156 *** Using RefTeX In Org-mode Files for LaTeX Export
3157 In Org-mode files for LaTeX export, the trick is to find a way to tell
3158 RefTeX the locations of external data stores. One way is to set the
3159 variable, =reftex-default-bibliography=. Add lines like these to
3162 #+begin_src emacs-lisp
3163 (setq reftex-default-bibliography
3165 ("default.bib" "other-default.bib")))
3168 In practice, this is a limited solution and the
3169 typical user will want to pass this information on a per-file basis.
3170 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
3173 The first solution, proposed by Mario, enables the RefTeX citation
3174 function in Org-mode. Add these lines to .emacs:
3176 #+begin_src emacs-lisp
3177 (defun org-mode-reftex-setup ()
3178 (load-library "reftex")
3179 (and (buffer-file-name)
3180 (file-exists-p (buffer-file-name))
3182 (define-key org-mode-map (kbd "C-c )") 'reftex-citation))
3183 (add-hook 'org-mode-hook 'org-mode-reftex-setup)
3186 Then add the following lines anywhere in the Org-mode file (Org-mode
3187 will recognize them as LaTeX commands):
3190 \bibliographystyle{plain}
3191 \bibliography{BIB-NAME}
3194 With this setup, =C-c )= will invoke =reftex-citation= which will
3195 insert a reference in the usual way:
3200 ,This is a citation \cite{tierney90}.
3202 ,\bibliographystyle{plain}
3206 This Org-mode file will export the following LaTeX output:
3208 #+begin_src latex :exports code
3209 % Created 2010-03-22 Mon 14:34
3210 \documentclass[11pt,letter]{article}
3211 \usepackage[utf8]{inputenc}
3212 \usepackage[T1]{fontenc}
3213 \usepackage{hyperref}
3217 \date{2010-03-22 Mon}
3223 \setcounter{tocdepth}{3}
3227 \section{test reftex}
3231 This is a citation \cite{tierney90}.
3233 \bibliographystyle{plain}
3240 A second solution, to activate the RefTeX minor mode on a per-file
3241 basis, was posted by Kevin Brubeck Unhammer in response to this idea.
3242 Add the following lines to .emacs:
3244 #+begin_src emacs-lisp
3245 (add-hook ‘org-mode-hook
3247 (if (member “WRITE” org-todo-keywords-1)
3248 (org-mode-article-modes))))
3251 where =org-mode-article-modes= is defined as follows:
3253 #+begin_src emacs-lisp
3254 (defun org-mode-article-modes ()
3256 (bib-cite-minor-mode t)
3257 (and (buffer-file-name)
3258 (file-exists-p (buffer-file-name))
3259 (reftex-parse-all)))
3262 Add the =\bibliographystyle{}= and =\bibliography{}= lines to the
3263 Org-mode file as before and define a TODO keyword, =WRITE=, perhaps
3267 ,#+TODO: TODO(t) STARTED(s) WRITE | DONE(d) DEFERRED(f)
3270 With this setup, you insert a citation with =M-x reftex-citation RET=.
3272 *** Using RefTeX in Org-babel LaTeX Code Blocks
3274 In Org-babel LaTeX code blocks, the trick is to give RefTeX access to
3275 information in other Org-babel LaTeX code blocks. If you use an Emacs
3276 starter kit where configuration information is held in Org-mode files,
3277 then the second solution is preferable because you won't be asked for
3278 a master file when Emacs is started. For this reason, the second
3279 solution is modified for use with Org-babel latex code blocks. No
3280 key-binding is needed here because Org-babel code blocks are edited
3281 within the usual AucTeX environment.
3283 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]])
3284 #+begin_src emacs-lisp
3285 (defun org-mode-article-modes ()
3287 (and (buffer-file-name)
3288 (file-exists-p (buffer-file-name))
3289 (reftex-parse-all)))
3291 (add-hook 'org-mode-hook
3293 (if (member "REFTEX" org-todo-keywords-1)
3294 (org-mode-article-modes))))
3297 Then add a line like the following line to the top of your org-mode file:
3300 ,#+TODO: TODO(t) STARTED(s) | DONE(d) DEFERRED(f) REFTEX
3303 When you open an org-mode file with a line like this, RefTeX will
3304 prompt for the master .tex file, which will be parsed in the usual
3305 way. This means that the .tex file should already exist, perhaps by
3306 tangling the LaTeX preamble and postamble, before
3307 =org-mode-article-modes= is activated for the Org-mode file.
3309 ** How can I use XeLaTeX for LaTeX export instead of pdfLaTeX?
3311 :CUSTOM_ID: using-xelatex-for-pdf-export
3313 [[http://en.wikipedia.org/wiki/XeTeX][ XeLaTeX]] is an alternative to pdfLaTeX for typesetting LaTeX
3314 documents. XeTeX can use any fonts installed in the operating system
3315 without configuring TeX font metrics, and can make direct use of
3316 advanced typographic features of OpenType and other font formats. By
3317 default, org-mode exports =org= files to =pdf= via pdfLaTeX.
3319 Here is one way to smoothly incorporate XeLaTeX into org-mode's export
3320 process. This solution takes advantage of [[http://www.phys.psu.edu/~collins/software/latexmk-jcc][latexmk]], a perl script that
3321 intelligently and automatically manages latex compilation. It
3322 is included with TeXLive, but at present the version included is not
3323 quite up-to-date enough for our needs. Version 4.20 and higher
3324 includes an option allowing you to specify which program to use when
3325 "pdflatex" is called. Install a current version of latexmk as per the
3326 instructions on the [[http://www.phys.psu.edu/~collins/software/latexmk-jcc][latexmk]] site. If necessary, disable the older
3327 version that comes with TeXLive. This is likely in =/usr/texbin/=, and
3328 you should rename or remove it. Then you can put the following in your
3329 =~/.emacs.d/= or equivalent:
3331 #+begin_src emacs-lisp
3332 (require 'org-latex)
3333 (setq org-export-latex-listings t)
3335 ;; Originally taken from Bruno Tavernier: http://thread.gmane.org/gmane.emacs.orgmode/31150/focus=31432
3336 ;; but adapted to use latexmk 4.20 or higher.
3337 (defun my-auto-tex-cmd ()
3338 "When exporting from .org with latex, automatically run latex,
3339 pdflatex, or xelatex as appropriate, using latexmk."
3341 ;; default command: oldstyle latex via dvi
3342 (setq texcmd "latexmk -dvi -pdfps -quiet %f")
3344 (if (string-match "LATEX_CMD: pdflatex" (buffer-string))
3345 (setq texcmd "latexmk -pdf -quiet %f"))
3347 (if (string-match "LATEX_CMD: xelatex" (buffer-string))
3348 (setq texcmd "latexmk -pdflatex=xelatex -pdf -quiet %f"))
3349 ;; LaTeX compilation command
3350 (setq org-latex-to-pdf-process (list texcmd)))
3352 (add-hook 'org-export-latex-after-initial-vars-hook 'my-auto-tex-cmd)
3355 ;; Specify default packages to be included in every tex file, whether pdflatex or xelatex
3356 (setq org-export-latex-packages-alist
3358 ("" "longtable" nil)
3361 (defun my-auto-tex-parameters ()
3362 "Automatically select the tex packages to include."
3363 ;; default packages for ordinary latex or pdflatex export
3364 (setq org-export-latex-default-packages-alist
3365 '(("AUTO" "inputenc" t)
3375 ("" "hyperref" nil)))
3377 ;; Packages to include when xelatex is used
3378 (if (string-match "LATEX_CMD: xelatex" (buffer-string))
3379 (setq org-export-latex-default-packages-alist
3384 ("american" "babel" t)
3385 ("babel" "csquotes" t)
3387 ("xetex" "hyperref" nil)
3390 (if (string-match "LATEX_CMD: xelatex" (buffer-string))
3391 (setq org-export-latex-classes
3393 "\\documentclass[11pt,article,oneside]{memoir}"
3394 ("\\section{%s}" . "\\section*{%s}")
3395 ("\\subsection{%s}" . "\\subsection*{%s}")
3396 ("\\subsubsection{%s}" . "\\subsubsection*{%s}")
3397 ("\\paragraph{%s}" . "\\paragraph*{%s}")
3398 ("\\subparagraph{%s}" . "\\subparagraph*{%s}"))
3399 org-export-latex-classes))))
3401 (add-hook 'org-export-latex-after-initial-vars-hook 'my-auto-tex-parameters)
3404 The =my-auto-tex-cmd= function looks at your =.org= file and checks
3405 whether you've specified which latex to use. If there are no
3406 instructions, it just runs regular old latex. If it finds the string
3407 =LATEX_CMD: pdflatex= in your file, it runs pdflatex. If it finds
3408 =LATEX_CMD: xelatex=, it runs xelatex. Because control is handed off
3409 to latexmk, nothing else is needed: it takes care of figuring things
3410 out so that the references and citations are correct.
3412 The second half of the code above specifies the latex packages that
3413 will be included in the =.tex= file. The variable
3414 =org-export-latex-packages-alist= specifies a list of packages that
3415 are always included in the header of latex documents, regardless of
3416 how they are compiled. The variable
3417 =org-export-latex-default-packages-alist= adds additional packages
3418 depending on whether latex/pdflatex or xelatex is being used. You can
3419 change the content of these as needed.
3421 Finally, the =org-export-latex-classes= variable redefines elements of
3422 the =.tex= file's preamble for the xelatex case. These can also be
3423 customized as needed.
3425 By way of example, an =.org= file you want compiled with xelatex might
3426 contain the following header:
3429 : #+AUTHOR: Jane Doe
3431 : #+OPTIONS: toc:nil num:nil
3432 : #+LATEX_CMD: xelatex
3433 : #+LATEX_HEADER: \setsansfont[Mapping=tex-text]{Unit-Bold}
3434 : #+LATEX_HEADER: \setmonofont[Mapping=tex-text,Scale=MatchLowercase]{PragmataPro}
3435 : #+LATEX_HEADER: \setromanfont[Mapping=tex-text,Numbers=OldStyle]{Minion Pro}
3437 If you always want to have the same font setup in your xelatex
3438 documents, the =fontspec= commands setting the font choices can be
3439 put in the =org-export-latex-classes= setting instead.
3441 The upshot is that when you want to export an =.org= file using
3442 XeLaTeX, you can now simply make sure the line =LATEX_CMD: xelatex= is
3443 in your =.org= file, then do =C-c C-e d= as usual, and org-mode, with
3444 latexmk in the background, does the rest for you.
3446 ** Why is my exported PDF file almost unreadable?
3448 :CUSTOM_ID: unreadable-pdfs
3451 Some PDF viewers (earlier versions (< v6) of Acrobat Reader, Evince,
3452 possibly others) do not get along with Adobe Type3 fonts, producing
3453 almost unreadable screen output (printed output is OK). If you see
3454 this, first verify the fonts that your document uses: open it with
3455 Acrobat Reader or Evince, select "Properties" from the "File" menu and
3456 click on the "Fonts" tab; alternatively, you can use the pdffonts
3457 program (part of the xpdf-reader package) from the command line. If
3458 that is indeed the problem, then either use a different viewer or
3459 install Type1 versions of the problematic fonts. For more details, see
3460 the "PDF export" section of [[./org-dependencies.org][org-dependencies]].
3462 ** Can I add attributes to a link or an image in HTML export?
3464 :CUSTOM_ID: html-image-and-link-attributes
3467 Yes. Excerpt from [[http://orgmode.org/manual/Images-in-HTML-export.html#Images-in-HTML-export][Org's manual]]:
3469 If you need to add attributes to an inlined image, use a `#+ATTR_HTML'.
3470 In the example below we specify the `alt' and `title' attributes to
3471 support text viewers and accessibility, and align it to the right.
3473 : #+CAPTION: A black cat stalking a spider
3474 : #+ATTR_HTML: alt="cat/spider image" title="Action!" align="right"
3477 and you could use `http' addresses just as well.
3479 ** How can I export an org file to rtf, odt (Open Office), or doc (Word)?
3481 :CUSTOM_ID: convert-to-open-office
3484 While you cannot export directly from org to doc or odt, you can
3485 export to one of org-mode's supported export formats and then use an
3486 external tool or method to convert the exported file to doc or odt.
3487 While most of these methods work with simple documents, they may work
3488 more or less well when the document contains complex elements, such as
3489 footnotes, embedded images, math formulas, and so on. (Note, the lists
3490 below are by no means comprehensive).
3492 1. html -> odt/doc/rtf
3493 - open html in Open Office and save as odt/doc ([[http://permalink.gmane.org/gmane.emacs.orgmode/31482][see this post by
3495 - [[http://www.artofsolving.com/opensource/pyodconverter][PyODConverter]]
3496 - [[http://johnmacfarlane.net/pandoc/][Pandoc]] (this works for LaTeX and docbook as well)
3497 - (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
3500 2. LaTeX -> odt/doc/rtf
3501 - [[http://latex2rtf.sourceforge.net/][LaTeX2rtf]] (works well with index, footnotes, and references)
3502 - [[http://www.tug.org/tex4ht/][TeX4ht]] (works with more complex latex elements, though can be
3503 difficult to install)
3504 - run =mk4ht oolatex file.tex=
3506 See [[http://permalink.gmane.org/gmane.emacs.orgmode/31168][this thread]] for further details.
3510 ** Which versions of MobileOrg do exist
3512 :CUSTOM_ID: mobileorg_versions
3515 - MobileOrg for the iPhone/iPod Touch/iPad series of devices, by
3516 Richard Moreland. Check out
3517 [[http://mobileorg.ncogni.to/][Richard's page]]
3518 - Matt Jones is developing a feature-equivalent application for
3520 [[http://wiki.github.com/matburt/mobileorg-android/][his project page]].
3522 ** What can I do if I don't want to use Dropbox.com
3524 :CUSTOM_ID: mobileorg_webdav
3527 Dropbox.com is the easiest way to connect between Emacs and MobileOrg,
3528 you can get a free account there. If for some reason you cannot or do
3529 not want to use this path, you can use any webdav server. On this
3530 webdav server you need to create a dedicated directory for the
3531 communication between Emacs and MobileOrg. If you can mount that
3532 directory locally so that Emacs can directly write to it, just point
3533 to that directory using the variable =org-mobile-directory=. Using
3534 the /tramp/ method, =org-mobile-directory= may point to a remote
3535 directory accessible through, for example, /ssh/ and /scp/:
3537 #+begin_src emacs-lisp
3538 (setq org-mobile-directory "/scpc:user@@remote.host:org/webdav/")
3541 If Emacs cannot access the WebDAV directory directly using a /tramp/
3542 method, you can use a local directory for staging. Other means must
3543 then be used to keep this directory in sync with the WebDAV directory.
3544 In the following example, files are staged in =~/stage/=, and Org-mode
3545 hooks take care of moving files to and from the WebDAV directory using
3548 #+begin_src emacs-lisp
3549 (setq org-mobile-directory "~/stage/")
3550 (add-hook 'org-mobile-post-push-hook
3551 (lambda () (shell-command "scp -r ~/stage/* user@@wdhost:mobile/")))
3552 (add-hook 'org-mobile-pre-pull-hook
3553 (lambda () (shell-command "scp user@@wdhost:mobile/mobileorg.org ~/stage/ ")))
3554 (add-hook 'org-mobile-post-pull-hook
3555 (lambda () (shell-command "scp ~/stage/mobileorg.org user@@wdhost:mobile/")))
3560 ** How to install MathJax on my server?
3563 :CUSTOM_ID: install_mathjax_on_server
3566 Org uses MathJax as its default HTML display engine for equations.
3568 Org relies on the version of MathJax available from orgmode.org, but you
3569 might want to use another version and install MathJax on your own server.
3571 1. Download a [[http://sourceforge.net/projects/mathjax/files/][MathJax archive]].
3573 2. Upload it somewhere on your server (say http://me.org/mathjax/)
3575 3. Set the correct path in =org-export-html-mathjax-options= (i.e. replace
3576 http://orgmode.org/mathjax/MathJax.js by
3577 http://me.org/mathjax/MathJax.js)
3579 You can also get [[http://www.mathjax.org/resources/docs/?installation.html][MathJax from git or svn]] -- in this case, be careful not to
3580 forget to unzip the fonts.zip archive in the mathjax directory.
3582 * COMMENT Function to create =CUSTOM_ID=
3584 #+begin_src emacs-lisp
3585 (defun org-faq-make-target ()
3586 "Make hard target for current headline."
3588 (if (not (org-on-heading-p))
3589 (error "Not on a headline"))
3590 (let ((h (org-trim (org-get-heading 'no-tags))))
3591 (if (string-match "[ \t]*\\?\\'" h)
3592 (setq h (replace-match "" t t h)))
3593 (while (string-match "[ \t]+" h)
3594 (setq h (replace-match "-" t t h)))
3595 (org-entry-put nil "CUSTOM_ID" h)))