Remove mailing list prefix from issue titles.
[Worg.git] / org-faq.org
blob77c8b19fad289bd6d53203c2e22f06cfa316889e
1 #+STARTUP:   overview
2 #+OPTIONS:   H:2 num:t toc:t \n:nil @:t ::t |:t ^:t *:t TeX:t
3 #+EMAIL:     carsten.dominik@gmail.com
4 #+AUTHOR:    Worg people
5 #+LANGUAGE:  en
6 #+TITLE:     Org-mode Frequently Asked Questions
7 #+INFOJS_OPT: view:content toc:1 path:http://orgmode.org/worg/code/org-info-js/org-info.js tdepth:1 ftoc:t buttons:0 mouse:underline
8 #+OPTIONS:   H:3 num:nil toc:t \n:nil @:t ::t |:t ^:{} -:t f:t *:t TeX:t LaTeX:t skip:nil d:(HIDE) tags:not-in-toc
10 #+begin_html
11 <a href="/"><img src="http://orgmode.org/img/org-mode-unicorn.png" class="logo-link" /></a>
12 #+end_html
14 [[file:index.org][{Back to Worg's index}]]
16 * Welcome
17   :PROPERTIES:
18   :CUSTOM_ID: Welcome
19   :END:
21 Welcome to the Org-mode FAQ.
23 You can navigate the FAQ by clicking on any of the topics in the Table
24 of Contents.
26 If your browser supports JavaScript, you can...
28 - move through the topics by typing "=n=" (next) and "=p=" (previous).
30 - see an outline view of the FAQ by typing "=m=" or clicking "=toggle
31   view=" (above).
33 - search the FAQ by typing "=s=" (basic search) or "=o=" (occur tree).
35 - see a full list of navigation commands by typing "=?=" or clicking
36   "=Help=" (above).
38 * What is org-mode?
39   :PROPERTIES:
40   :CUSTOM_ID: What-is-org-mode
41   :END:
42 ** Can I implement a GTD workflow with Org-mode?
43    :PROPERTIES:
44    :CUSTOM_ID: GTD-workflow-with-Org-mode
45    :END:
47    Yes, you can.  Check for discussions and pointers [[http://orgmode.org/worg/org-gtd-etc.php][here]].
49 ** What is the difference between Org and TaskPaper?
50    :PROPERTIES:
51    :CUSTOM_ID: Org-and-TaskPaper
52    :END:
54   There is really no difference.  Org is as /simple/ as [[http://hogbaysoftware.com/products/taskpaper][TaskPaper]].  It
55   is just that, when using Org within Emacs, it lets you do many things
56   that you wouldn't be able to do with TaskPaper.  Yes, TaskPaper is
57   fiddle-proof and people using Emacs tends to like fiddling (which is
58   orthogonal to the idea of using todo-list efficiently), but this is
59   just a matter of discipline and common sense, not one of Org's design.
61   Read [[http://article.gmane.org/gmane.emacs.orgmode/6224][Carsten's enlightening statement]] on this.
62 ** What is the meaning of the Unicorn on Org's website?
63    :PROPERTIES:
64    :CUSTOM_ID: unicorn
65    :END:
67 The Unicorn is the logo of Org-mode because:
69 - Org-mode is the UNICs of ORgaNizers.
71 - Org-mode is an Emacs mode, so it makes sense to use an animal
72   similar or related to the gnu used for GNU Emacs.
74 - Org-mode is meant to show you the way, and an animal with two horns
75   can not do this very well, can it?
77 - Unicorn tears are said to reverse petrification, and wasn't this how
78   we all felt before getting to some degree of time and task
79   management?
81 - It will take forever to learn everything there is to know about a
82   unicorn.
84 - A unicorn is a fabulous creature.  Org-mode wants to be a fabulous
85   creation.
87 Using a unicorn was originally /Bastien Guerry's/ idea, his friend
88 /Christophe Bataillon/ designed the logo for us, and /Greg Newman/
89 gave it a refresh some time later.  Bastien writes why he chose a
90 unicorn:
92 #+BEGIN_QUOTE
93 The first reason is not linked to the animal, but to the sounding of the
94 word "Unicorn" - because Org gives you a /uni/que way of producing files
95 in several format (HTML, LaTeX, etc.)
97 The second reason is that a Unicorn doesn't really exist, it is just
98 something you can dream about, and make others believe it does exist.
99 Just like the perfect organizer.
100 #+END_QUOTE
102 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
103 Suckling]] posted a link showing how to make a simple foldable unicorn
104 (very appropriate for an outlining program!).
106 [[http://article.gmane.org/gmane.emacs.orgmode/11735][Tim Burt]] made a very complicated one which is now a treasured
107 possession of the Org-mode author.
109 - Official logo: [[http://orgmode.org/img/org-mode-unicorn.png]]
110   This logo is available in a number of different formats including
111   Photoshop /.psd/ and scaleable vector graphics /.svg/ [[http://orgmode.org/img/][here]].
113 - An [[http://orgmode.org/img/nrocinu4.jpg][alternative version]] from Christophe Bataillon (c):
115 - [[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]]:
117 - [[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
118   threshold technique".
120 - [[http://article.gmane.org/gmane.emacs.orgmode/11735/match%3D][Tim Burt]] made a folded Unicorn to match the spirit of Org - see the
121   whole set of pictures [[http://www.flickr.com/photos/tcburt/sets/72157614543357071/][on his flickr page]].
123 - Are unicorns real?  Answer [[http://article.gmane.org/gmane.emacs.orgmode/11687/match%3Drosslaird%2Bunicorn][here]] by Ross Laird.
125 * Mailing list
126 ** Why hasn't my email to the mailing list shown up yet?
127    :PROPERTIES:
128    :CUSTOM_ID: ml-post-delay
129    :END:
131 The org-mode mailing list is moderated. Thus, if you are not
132 subscribed to the mailing list, your mail will only appear on the list
133 after it has been approved by a moderator. To ensure that your mail
134 appears quickly, please [[http://lists.gnu.org/mailman/listinfo/emacs-orgmode][subscribe to the list]].
136 ** I read the mailing list through gmane. Should I subscribe?
137    :PROPERTIES:
138    :CUSTOM_ID: ml-subscription-and-gmane
139    :END:
141 The org-mode mailing list is available via nntp at [[http://dir.gmane.org/gmane.emacs.orgmode][Gmane]]. Many
142 participants in the list prefer read the list in a newsreader, such as
143 Gnus, instead of receiving emails. If you choose to read the list via
144 nntp, you can still [[http://lists.gnu.org/mailman/listinfo/emacs-orgmode][subscribe]] to the list and then opt not to receive
145 any emails on the mailman settings page (see the "Mail Delivery"
146 setting).
148 This will ensure that your messages to the list get through quickly,
149 reduce the work load of the mailing list moderators (who need to clear
150 every mail from non-members), and provide more accurate information
151 about the number of list readers.
153 * Keeping current
154   :PROPERTIES:
155   :CUSTOM_ID: Keeping-current
156   :END:
157 ** How do I keep current with Org mode development?
158    :PROPERTIES:
159    :CUSTOM_ID: keeping-current-with-Org-mode-development
160    :END:
162    Org mode is developed in [[http://en.wikipedia.org/wiki/Git_(software)][Git]].  You can keep up-to-date with Org
163    mode developement by cloning Org mode repository and refreshing
164    your copy with latest changes whenever you wish.  You only need to
165    use two Git commands (clone and pull.)  Here are the steps in
166    brief (please customize locations to suit your setup):
168    1. Select a location to house the Org mode repository (approx. 40
169       MB; includes documentation, compiled elisp files and history
170       going all the way back to v4.12a)
172       : $ mkdir $HOME/elisp && cd $HOME/elisp
174    2. Clone the Org mode Git repository.
176       Recommended approach:
178       : $ git clone git://repo.or.cz/org-mode.git
180       Alternate approach if you are behind a firewall that allows only
181       HTTP (can be quite slow):
183       : $ git clone http://repo.or.cz/r/org-mode.git
185    3. Compile and install Org mode and build documentation.
187       : $ cd org-mode && make && make doc && make install
189       Please note that you can choose to /not/ compile at all and run
190       using source =.el= files only.  Compiled files speed things up.
192    4. This is where you configure Org mode with Emacs.  Please refer
193       to [[./org-tutorials/index.org][Org tutorials]].
195    5. Keeping up-to-date.
197       Cloning the repository is a one time activity.  From this point
198       onwards you only need to /pull/ the latest changes.
200       : $ cd $HOME/elisp/org-mode
202       and then
204       : $ git pull && make clean && make && make doc && make install
206    6. You should restart org mode to have the changes take effect (if
207       you are not rebooting Emacs.)  Also since the intention is to
208       "keep up" with Org mode, you should visit ChangeLog and updated
209       sections of documentation for latest updates (use =git log=.)
211    7. As you use your repository over time it will accumulate loose objects.
212       You can reduce the total size of your git repository with
214       : $ git gc
216       which will consolidate loose git objects into pack files.  This
217       reduces the size of the repository and speeds up data access to
218       the objects.
220 ** How can I keep local changes and still track Org mode development?
221    :PROPERTIES:
222    :CUSTOM_ID: keeping-local-changes-current-with-Org-mode-development
223    :END:
225   Say you want to make minor changes to the Makefile to reflect your
226   location for =emacs=.
228   Create a local branch for your changes on top of origin/master as
229   follows:
231   : $ git checkout -b local origin/master
232   : $ git config branch.local.rebase true
233   : # Make your changes to the Makefile and create a new commit
234   : $ git add Makefile
235   : $ git commit -m 'My local Makefile configurations'
236   : # Update git to a newer version
237   : $ git pull
239   Now each time you pull new commits from the distribution repository
240   your local commits will be rewound and replayed on top of the new
241   origin/master.
243 -----------
245   You would normally work on your =local= branch which includes your
246   custom commits; there's no need to switch back to the =master=
247   branch.
249 -----------
251 Here is an example of dealing with conflict resolution during git pull.
253 If you get a conflict during a =git pull= you will need to edit the
254 file with the conflict to fix up the conflicting lines and then tell
255 git that you have resolved the conflict.
257 Conflict resolution goes something like this:
259 1. =git pull= fails with a conflict
260 2. edit the file
261 3. =git add= the file to mark the conflict resolved
262 4. =git rebase --continue=
263 5. lather, rinse, and repeat 2-4 as needed
265 For this example we have the following Makefile:
267 : #
268 : # Example Makefile
269 : #
271 : EMACS=emacs
273 : VERSION=V1.0
275 and we need to change the =EMACS=emacs= line to =EMACS=myemacs= to
276 make it work well on our system.
278 To do this we
280   - create a local branch for our work
282     : $ git checkout -b local origin/master
283     : $ git config branch.local.rebase true
285     This marks the branch so that all local commits on it are rebased
286     on top of any new commits we get in origin/master during a =git
287     pull= operation.
289   - Make our custom changes
291     Edit the makefile so it looks like this:
293     : #
294     : # Example Makefile
295     : #
296     :
297     : EMACS=myemacs
298     :
299     : VERSION=V1.0
301   - Create a commit with our custom changes
302     : $ git add Makefile
303     : $ git commit -m 'My local Makefile configurations'
305   - Later we do a =git pull= but that fails with conflicts.
307     : $ git pull
308     : remote: Counting objects: 5, done.
309     : ...
310     : Patch failed at 0001.
311     :
312     : When you have resolved this problem run "git rebase --continue".
313     : If you would prefer to skip this patch, instead run "git rebase --skip".
314     : To restore the original branch and stop rebasing run "git rebase --abort".
316   - Fix the conflict in your favourite editor
318     Conflict markers look like this:
320     : <<<<<<< HEAD:Makefile
321     : EMACS=emacs22
322     : =======
323     : EMACS=myemacs
324     : >>>>>>> Change emacs location:Makefile
326     This attempted =git pull= caused a conflict.  Fire up your
327     favourite editor and fix the conflict in the Makefile.  The
328     conflict markers are <<<<<<<<<< , ======= , and >>>>>>>>>>.  Fix
329     the Makefile appropriately and delete the conflict markers.  You
330     already edited these lines earlier so fixing it should be trivial.
332     In this case we changed =EMACS=emacs= to =EMACS=myemacs= and
333     upstream changed =EMACS=emacs= to =EMACS=emacs22=.  Just fix the
334     file and save it by deleting the conflict markers and keeping the
335     code you need (in this case the =EMACS=myemacs= line which we
336     originally modified.)
338   - Mark the file's conflict resolved
340     : $ git add Makefile
342     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.
344   - Continue the rebase operation
346     : $ git rebase --continue
348     If any other conflicts arise you fix them the same way - edit the file, mark the conflict resolved, and continue.
350 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"
351 using
352 : $ git rebase --abort
354 ** How can I install an up-to-date version of org-mode without "make" tools?
355    :PROPERTIES:
356    :CUSTOM_ID: installing-org-without-make-tools
357    :END:
359 If you are using org-mode on a computer that lacks developer tools for
360 compiling software, such as [[http://www.gnu.org/software/make/][GNU Make]], you will have to use a
361 *different* installation method than [[http://orgmode.org/manual/Installation.html#Installation][the one outlined in the manual]].
363 Please see [[http://article.gmane.org/gmane.emacs.orgmode/15264][this thread]] on the mailing list for several different ways
364 you can install a recent version of org-mode without using the
365 customary =make clean && make && make install=.
367 The result of that discussion is the file/function found in
368 [[http://orgmode.org/worg/org-hacks.php#compiling-org-without-make]].
370 * Setup
371   :PROPERTIES:
372   :CUSTOM_ID: Setup
373   :END:
375 ** How can I quickly browse all Org options?
377 =M-x org-customize RET=
379 See also [[file:org-tutorials/org-customize.org][Carsten's Org customize tutorial]] and [[file:org-configs/org-customization-guide.org][this customization guide]]
380 for details.
382 ** Can I use the editing features of org-mode in other modes?
383    :PROPERTIES:
384    :CUSTOM_ID: use-editing-features-in-other-modes
385    :END:
387    Not really---but there are a few editing features you can use in
388    other modes.
390    - For tables there is =orgtbl-mode= which implements the table
391      editor as a minor mode. (To enable, type =M-x orgtbl-mode=)
392    - For ordered lists there is =orgstuct-mode= which allows for easy
393      list editing as a minor mode. (To enable, type =M-x
394      orgstruct-mode=)
396    You can activate these modes automatically by using hooks:
398    : (add-hook 'mail-mode-hook 'turn-on-orgtbl)
399    : (add-hook 'mail-mode-hook 'turn-on-orgstruct)
401    For footnotes, there is the function =org-footnote-action=, which
402    works in non-org buffers. This function is a powerful tool for
403    creating and sorting footnotes. To use it globally, you can add the
404    following keybinding to your =.emacs= file (requires Org 6.17 or
405    greater):
407    : (global-set-key (kbd "C-c f") 'org-footnote-action)
409    For other features you need to switch to Org-mode temporarily, or
410    prepare text in a different buffer.
412 ** Why isn't feature "X" working the way it is described in the manual?
413    :PROPERTIES:
414    :CUSTOM_ID: making-sure-org-mode-is-up-to-date
415    :END:
417 Org-mode develops very quickly. There have been a great many changes,
418 for instance, since the release of Emacs 22, which shipped with
419 version 4.67d of org-mode. (Emacs 23 is expected to ship with version
420 6.21b.)
422 Many of the users on the org-mode mailing list are using either a
423 recent release of org-mode or the
424 [[http://orgmode.org/index.html#sec-3.2][development version of
425 org-mode from the git repository]].
427 If some settings and features aren't working the way you expect, make
428 sure that the version of the manual you are consulting matches the
429 version of org-mode you are using.
431    - You can check which version of org-mode you are using by
432      selection =Org --> Documentation --> Show Version= in the Emacs
433      menu.
435    - The [[http://orgmode.org/manual/index.html][online manual]] at [[http://orgmode.org][orgmode.org]] corresponds to the most recent
436      release.
438    - 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
439      released with the latest official Gnu Emacs release (Emacs 22 and
440      org-mode 4.67d as of February 2009). Note: compared with the
441      manual at the orgmode.org, the manual at www.gnu.org is
442      considerably out of date.
444 For instructions on how to stay current with org-mode, consult [[keeping-current-with-Org-mode-development][this
445 FAQ]] or follow the instructions on [[http://orgmode.org][the official org-mode site]].
447 ** Can I get the visibility-cycling features in outline-mode and outline-minor-mode?
448    :PROPERTIES:
449    :CUSTOM_ID: use-visibility-cycling-in-outline-mode
450    :END:
452    Yes, these functions are written in a way that they are independent of
453    the outline setup.  The following setup provides standard Org-mode
454    functionality in outline-mode on =TAB= and =S-TAB=.  For
455    outline-minor-mode, we use =C-TAB= instead of =TAB=,
456    because =TAB= usually has mode-specific tasks.
458 #+BEGIN_SRC emacs-lisp
459 (add-hook 'outline-minor-mode-hook
460   (lambda ()
461     (define-key outline-minor-mode-map [(control tab)] 'org-cycle)
462     (define-key outline-minor-mode-map [(shift tab)] 'org-global-cycle)))
463 (add-hook 'outline-mode-hook
464   (lambda ()
465     (define-key outline-mode-map [(tab)] 'org-cycle)
466     (define-key outline-mode-map [(shift tab)] 'org-global-cycle)))
467 #+END_SRC
469 Or check out /outline-magic.el/, which does this and also provides
470 promotion and demotion functionality.  /outline-magic.el/ is
471 available at [[http://www.astro.uva.nl/~dominik/Tools/outline-magic.el][Outline Magic]].
473 ** Can I save/restore the visibility state of an org-mode buffer?
475 Well, no.
477 ** How can I keep track of changes in my Org files?
478    :PROPERTIES:
479    :CUSTOM_ID: track-of-changes-in-Org-files
480    :END:
482   Use git to track the history of the files, use a cronjob to check in
483   changes regularly.  Such a setup is described by Bernt Hansen
484   in [[http://article.gmane.org/gmane.emacs.orgmode/6233][this message]] on [[http://dir.gmane.org/gmane.emacs.orgmode][emacs-orgmode]].
486 ** Can I use Org-mode as the default mode for all README files?
487    :PROPERTIES:
488    :CUSTOM_ID: Org-mode-as-default-mode
489    :END:
491 Add the following to your .emacs file:
493 : (add-to-list 'auto-mode-alist '("README$" . org-mode))
495 You can even make it the default mode for any files with unspecified
496 mode using
498 : (setq default-major-mode 'org-mode)
500 ** Can I use ido.el for completing stuff in Org?
501    :PROPERTIES:
502    :CUSTOM_ID: ido-complete
503    :END:
505    Yes, you can.  If you are an ido user and ido-mode is active, the
506    following setting will make Org use =ido-completing-read= for most
507    of its completing prompts.
509 : (setq org-completion-use-ido t)
511 ** Should I use one big org file or multiple files?
512    :PROPERTIES:
513    :CUSTOM_ID: how-to-organize-org-mode-files
514    :END:
516 Org-mode is flexible enough to accomodate a variety of organizational
517 and time management schemes. Org's
518 [[http://orgmode.org/manual/Document-Structure.html#Document-Structure][outline
519 cycling and convenient editing and navigation commands]] make it
520 possible to maintain all of your projects and notes in a single file.
521 But org-mode's [[http://orgmode.org/manual/Hyperlinks.html#Hyperlinks][quick and easy hyperlinks]], along with [[http://orgmode.org/manual/Refiling-notes.html#Refiling-notes][easy refiling of
522 notes and todos]], also make it a delight to maintain a private "wiki"
523 consisting of multiple files.
525 No matter how you organize your org files, org-mode's agenda commands
526 make it easy to search all your notes and gather together crucial data
527 in a single view.
529 Moreover, several org-mode settings can be configured either globally
530 in your =.emacs= file or locally (per file or per outline tree). See
531 the [[http://orgmode.org/manual/index.html#Top][manual]] for more details. For an example of local customizations
532 see [[limit-agenda-with-category-match][this FAQ]].
534 Here are a few ideas for organizing org-mode files:
536 - A single file for all your projects and notes.
537 - One file per project.
538 - One file per client.
539 - One file per area of responsibility or type of work (e.g.,
540   household, health, work, etc.).
541 - One file for projects, one for appointments, one for reference
542   material, one for someday/maybe items, etc.
543 - A wiki of hyperlinked files that grows and adapts to meet your
544   needs.
546 For more ideas, see some of the links on the [[file:org-tutorials/index.org][org-tutorial index]] or
547 [[file:org-gtd-etc.org][this page on org-mode and GTD]].
549 ** Why doesn't C-c a call the agenda? Why don't some org keybindings work?
550    :PROPERTIES:
551    :CUSTOM_ID: setting-global-keybindings
552    :END:
554 Org-mode has a few global keybindings that the user must set
555 explicitly in an =.emacs= file. These keybindings include the
556 customary shortcut for calling the agenda (=C-c a=). If nothing
557 happens when you type =C-c a=, then make sure that the following lines
558 are in your =.emacs= file:
560 #+BEGIN_SRC emacs-lisp
561 ;; The following lines are always needed.  Choose your own keys.
562 (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
563 (global-set-key "\C-cl" 'org-store-link)
564 (global-set-key "\C-ca" 'org-agenda)
565 (global-set-key "\C-cb" 'org-iswitchb)
566 #+END_SRC emacs-lisp
568 You may, of course, choose whatever keybindings work best for you
569 and do not conflict with other modes.
571 Please see [[http://orgmode.org/manual/Activation.html][this section of the manual]] if you have additional
572 questions.
574 ** Why aren't some of the variables I've customized having an effect?
575    :PROPERTIES:
576    :CUSTOM_ID: load-org-after-setting-variables
577    :END:
579 Some org variables have to be set before org.el is loaded or else they
580 will not work. (An example is the new variable
581 =org-enforce-todo-dependencies=.)
583 To make sure all your variables work you should not use =(require
584 'org)=. Instead use the following setting:
586 : (require 'org-install)
588 You should also make sure that you do not require any other =org-...=
589 files in your =.emacs= file before you have set your org variables,
590 since these will also cause org.el to be loaded. To be safe, load org
591 files *after* you have set your variables.
593 ** Org-mode has a lot of colors?  How can I change them?
594    :PROPERTIES:
595    :CUSTOM_ID: customizing-org-faces
596    :END:
598 This is a question that applies to Emacs as a whole, but it comes up
599 quite frequently on the org-mode mailing list, so it is appropriate to
600 discuss it here.
602 If you would like to change the style of a face in org-mode (or any
603 other Emacs mode), simply type =M-x customize-face [RET]= while the
604 cursor is on the color/style you are interested in modifying. You will
605 be given the opportunity to customize all the faces located at that
606 point.
608 If you would like an overview of all the faces in org-mode, you can
609 type =C-u M-x list-faces-display [RET] org= and you will be shown all
610 the faces defined by org-mode along with an illustration of their
611 current settings.
613 If you would like to customize org-faces and other aspects of
614 org-appearance, type =M-x customize-group org-font-lock [RET]=.
616 Finally, if you would like verbose information about the properties of
617 the text under the cursor, you can type =C-u C-x ==.
619 See the Worg page on [[file:org-tutorials/org-appearance.org][customizing Org appearance]] for further information.
621 ** How can I make sure that timestamps appear in English?
622    :PROPERTIES:
623    :CUSTOM_ID: timestamps-and-system-time-locale
624    :END:
626 If your system's locale is not set to English, but you would like the
627 timestamps in your org-mode files to appear in English, you can set
628 the following variable:
630 #+begin_src emacs-lisp
631   (setq system-time-locale "C")
632 #+end_src
634 ** What does a minimal .emacs look like?
635 Using a stripped down minimal .emacs files removes broken custom
636 settings as the cause of an issue and makes it easy to reproduce for
637 other people.  The example below has system-specific paths that you'll
638 need to change for your own use.
639 #+begin_src emacs-lisp
640   (add-to-list 'load-path (expand-file-name "~/git/org-mode/lisp"))
641   (add-to-list 'auto-mode-alist '("\\.\\(org\\  |org_archive\\|txt\\)$" . org-mode))
642   (setq org-agenda-files '("/tmp/test.org"))
643   (require 'org-install)
644   (require 'org-habit)
645   
646   (global-set-key "\C-cl" 'org-store-link)
647   (global-set-key "\C-ca" 'org-agenda)
648   (global-set-key "\C-cb" 'org-iswitchb)
649 #+end_src
651 You can save the minimal .emacs file to ~/minimal.emacs, add suspect
652 configuration code to it, then start emacs something like this:
653 #+begin_src sh
654   emacs -Q -l ~/minimal.emacs
655 #+end_src
657 On OS X, starting emacs with minimal configuration might look
658 something like this:
659 #+begin_src sh 
660   /Applications/emacs.app/Contents/MacOS/Emacs -Q -l ~/minimal.emacs
661 #+end_src sh
664 * Errors and general problems
665   :PROPERTIES:
666   :CUSTOM_ID: Errors
667   :END:
668 ** Opening Org files in Emacs leads to a crash
669    :PROPERTIES:
670    :CUSTOM_ID: Emacs-crashes-with-org-indent-mode
671    :END:
672    The only known case where Org-mode can crash Emacs is when you are
673    using =org-indent-mode= with Emacs 23.1 (in fact, any version of
674    Emacs before version 23.1.50.3).  Upgrade to Emacs 23.2 and the
675    problem should go away.
677 ** When I try to use Org-mode, I always get the error message =(wrong-type-argument keymapp nil)=
678    :PROPERTIES:
679    :CUSTOM_ID: wrong-type-argument-keymapp
680    :END:
682    This is a conflict with an outdated version of the /allout.el/, see
683    the [[http://orgmode.org/manual/Conflicts.html#Conflicts][Conflicts]] section in the manual
685 ** How can I control the application launched by Org-mode to open a certain file type like pdf, html.... 
686    :PROPERTIES:
687    :CUSTOM_ID: external-application-launched-to-open-file-link
688    :END:
690 If you want special control about how Org-mode opens files, see the
691 variables =org-file-apps=, =org-file-apps-defaults-gnu=,
692 =org-file-apps-defaults-macosx=, =org-file-apps-defaults-windowsnt=.
694 *However*, normally it is best to just use the mechanism the
695 operating-system provides:
697 *** GNU/Linux systems
698     You you have to check your mailcap settings, find the files:
700     : /etc/mailcap
701     : 
702     : or  
703     : 
704     : $HOME/.mailcap
706 and modify them accordingly. Please read their manual entry.
708 *** Windows systems 
709     + for html pages you may configure the =browse-url-= variables through
710       the Customize interface,
711     + the pdf files are automatically opened with Acrobat Reader (if it is
712       installed)
714 *** Mac OSX
715     Change the application responsible for this file type by selecting
716     such a file in the Finder, select =File->Get Info= from the menu
717     and select the application to open this file with.  Then, to
718     propagate the change to all files with the same extension, select
719     the =Change all= button.
721 ** Org-mode takes over the TAB key.  I also want to use YASnippet, is there a way to fix this conflict?
722    :PROPERTIES:
723    :CUSTOM_ID: YASnippet
724    :END:
726 [[http://code.google.com/p/yasnippet/][yasnippet]] is yet another snippet expansion system for Emacs.  It is
727 inspired by TextMate's templating syntax.
728 - watch the [[http://www.youtube.com/watch?v=vOj7btx3ATg][video on YouTube]]
729 - see the [[http://yasnippet.googlecode.com/svn/trunk/doc/index.html][intro and tutorial]]
731 *Note*: yasnippet is not compatible with =org-indent-mode= currently
732 there is no known way to use both successfully with =yas/trigger-key=
733 set to =TAB= (or =[tab]= etc...)
735 The way Org-mode binds the =TAB= key (binding to =[tab]= instead of
736 =\t=) overrules yasnippets' access to this key.  The following code
737 fixes this problem:
739 #+begin_src emacs-lisp
740 (add-hook 'org-mode-hook
741           (lambda ()
742             (org-set-local 'yas/trigger-key [tab])
743             (define-key yas/keymap [tab] 'yas/next-field-group)))
744 #+end_src
746 If the above code doesn't work (which it may not with later versions
747 of yasnippet).  Then try the following
749 #+begin_src emacs-lisp
750   (defun yas/org-very-safe-expand ()
751     (let ((yas/fallback-behavior 'return-nil)) (yas/expand)))
752   
753   (add-hook 'org-mode-hook
754             (lambda ()
755               ;; yasnippet (using the new org-cycle hooks)
756               (make-variable-buffer-local 'yas/trigger-key)
757               (setq yas/trigger-key [tab])
758               (add-to-list 'org-tab-first-hook 'yas/org-very-safe-expand)
759               (define-key yas/keymap [tab] 'yas/next-field)))
760 #+end_src
762 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]])
763 with YASnippets for Org-mode.
765 ** Org-mode takes over the S-cursor keys.  I also want to use CUA-mode, is there a way to fix this conflict?
766    :PROPERTIES:
767    :CUSTOM_ID: CUA-mode
768    :END:
770 Yes, see the  [[http://orgmode.org/manual/Conflicts.html#Conflicts][Conflicts]] section of the manual.
772 ** Org-mode takes over the S-cursor keys.  I also want to use windmove.el, is there a way to fix this conflict?
773    :PROPERTIES:
774    :CUSTOM_ID: windmove.el
775    :END:
777 Yes, see the [[http://orgmode.org/manual/Conflicts.html#Conflicts][Conflicts]] section of the manual.
779 ** Org behaves strangely: some keys don't work, some features are missing, my settings have no effect, ...
780    :PROPERTIES:
781    :CUSTOM_ID: loaded-old-org
782    :END:
784 When this sort of things happen, it probably is because Emacs is loading an old version of Org-mode instead of the one you expected. Check it with =M-x org-version=.
786 This happens because Emacs loads first the system org-mode (the one included with Emacs) before the one in your directory. Check the =load-path= variable; you might see that your org-mode appears /after/ the system-wide path; this is bad.
788 You should add your directories to the =load-path= at the beginning:
790 :  (add-to-list 'load-path "~/.emacs.d/org-mode/lisp") (require 'org-install)
792 Function =add-to-list= adds at the beginning. Don't use =append= because it appends at the end. Also be sure to use =(require 'org-install)= and not =(require 'org)=.
794 This wrong version loading may also happen if you have a byte-compiled =org.elc= from an old version together with a new =org.el=. Since Emacs prefers loading byte-compiled files (even if the =.el= is newer), it will load the old Org-mode.
796 ** Why doesn't org-batch-agenda work under Win32?
797    :PROPERTIES:
798    :CUSTOM_ID: org-batch-agenda-under-win32
799    :END:
801 When I run the example batch files to print my agenda to the console
802 under Win32 I get the failure:
804 : End of file during parsing
806 and no agenda is printed.
808 The problem is the use of single quotes surrounding the eval in the
809 emacs command-line. This gets confused under Win32. All string
810 parameters with spaces must be surrounded in double quotes. This means
811 that double quotes being passed to the eval must be escaped.
813 Therefore, instead of the following:
815 : <path to emacs>\emacs.exe -batch -l ~/_emacs_org \
816 :     -eval '(org-batch-agenda "a")'
818 you need to use the following:
820 :  <path to emacs>\emacs.exe -batch -l ~/_emacs_org \
821 :     -eval "(org-batch-agenda \"a\")"
823 (all on one line, of course).
825 ** Org agenda seems very slow
826    :PROPERTIES:
827    :CUSTOM_ID: slow-agenda
828    :END:
830 If it takes a long time to generate or refresh the agenda, you might
831 want first check which version of org-mode you are using. There have
832 been major optimizations of org-agenda since 6.21b, which was the
833 version of org-mode released with Emacs 23. If you are using 6.21b or
834 earlier (you can check with =M-x org-version=), then you might want to
835 consider upgrading to a more recent version of org-mode.
837 Here are some other ideas for speeding up the agenda:
839 1. Use a one day agenda view (rather than a seven day view).
841    =(setq org-agenda-ndays 1)=
843 2. Archive inactive items to separate files.
844    
845    =C-c C-x C-s= (org-archive-subtree)
847 3. Do not include the global todo list in your agenda view.
849    (setq org-agenda-include-all-todo nil)
851 4. Make sure that your org files are byte-compiled.
853    I.e., make sure there are files ending in .elc in your org
854    installation directory.
856 ** Visual-line-mode doesn't work well with org-mode
857    :PROPERTIES:
858    :CUSTOM_ID: visual-line-mode
859    :END:
861 Visual-line-mode "soft wraps" lines so that the visual edge of the
862 buffer is considered a line break for purposes of navigation, even
863 though there is no line break in reality. 
865 In older versions of org-mode, org-beginning-of-line and
866 org-end-of-line do not work well with visual line mode. (The two
867 commands disregard soft line breaks and move to the beginning and end
868 of the hard line break.) A patch was introduces to fix this behavior
869 in July of 2009. n
871 If you are using an older version of org mode, you can:
873 1. Add a hook to turn off visual line mode.
875 2. Add the following to your =.emacs=:
877 #+begin_src emacs-lisp
879 (add-hook 'org-mode-hook
880   (lambda ()
881     (define-key org-mode-map "\C-a" 'move-beginning-of-line)
882     (define-key org-mode-map "\C-e" 'move-end-of-line)))
884 #+end_src
886 * Outline
887   :PROPERTIES:
888   :CUSTOM_ID: Outline
889   :END:
890 ** Can I have two windows on the same Org-mode file, with different outline visibilities?
891    :PROPERTIES:
892    :CUSTOM_ID: indirect-buffers
893    :END:
895    You may use /indirect buffers/ which do exactly this.  See the
896    documentation on the command =make-indirect-buffer=.
898    Org-mode has built-in commands that allow you create an indirect
899    buffer from a subtree of an outline. To open a subtree in new
900    window, type =C-c C-x b=. Any changes you make in the new window
901    will be saved to the original file, but the visibility of both
902    buffers will remain independent of one another.
904    For multiple indirect buffers from the same file, you must use the
905    prefix =C-u= when creating the second (or third) buffer. Otherwise
906    the new indirect buffer will replace the old.
908    You can also create an independent view of an outline subtree by
909    typing =b= on an item in the agenda.
911 ** Emacs outlines are unreadable.  Can I get rid of all those stars?
912    :PROPERTIES:
913    :CUSTOM_ID: Emacs-outlines-are-unreadable
914    :END:
916    See the section [[http://orgmode.org/manual/Clean-view.html#Clean-view][Clean outline view]] in the manual.
917 ** C-k is killing whole subtrees!  I lost my work!
918    :PROPERTIES:
919    :CUSTOM_ID: C-k-is-killing-subtrees
920    :END:
922   =(setq org-special-ctrl-k t)= before losing your work.
924 ** Why aren't commands working on regions?
925    :PROPERTIES:
926    :CUSTOM_ID: transient-mark-mode
927    :END:
929 Some org-mode commands, such as M-right and M-left for demoting or
930 promoting headlines (see [[demote-multiple-headlines][this FAQ]]), can be applied to entire regions.
931 These commands, however, will only work on active regions set with
932 [[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
933 Emacs 23. To enable it in earlier versions of emacs, put the following
934 in your =.emacs= file:
936 : (transient-mark-mode 1)
938 Alternatively, you may turn off transient mark mode and use [[http://www.gnu.org/software/emacs/manual/html_node/emacs/Momentary-Mark.html][a
939 momentary mark]] (=C-<SPC> C-<SPC>=).
941 ** Why is a blank line inserted after headlines and list items?
942    :PROPERTIES:
943    :ID:       2463F4D8-F686-4CF3-AA07-08976F8A4972
944    :END:
945    :PROPERTIES:
946    :CUSTOM_ID: blank-line-after-headlines-and-list-items
947    :END:
949 In org-mode, typing =M-RET= at the end of a headline will create a new
950 headline of the same level on a new line. The same is true for plain
951 lists. By default org-mode uses context to determine if a blank line
952 should be inserted after each headline or plain list item when =M-RET=
953 is pressed. For instance, if a there is a blank line before a
954 headline, then typing =M-RET= at the end of the line will insert a
955 blank line before the new headline. For instance, hitting =M-RET=
956 at the end of "Headline Two" below inserts a new headline without a
957 blank line:
959 : ** Headline One
960 : ** Headline Two
961 : **
963 If there is a blank line between Headline One and Headline Two,
964 however, the results will be as follows:
966 : ** Headline One
968 : ** Headline Two
970 : **
972 If you do not like the default behavior you can change it with the
973 variable =org-blank-before-new-entry=. You can set headings and/or
974 plain lists to auto (the default setting), t (always), or nil (never).
976 ** How can I promote or demote multiple headlines at once?
977    :PROPERTIES:
978    :CUSTOM_ID: demote-multiple-headlines
979    :END:
981 If you have a long list of first level headlines that you'd like to
982 demote to second level headlines, you can select the headlines as a
983 region and then hit =M-<right>= to demote all the headlines at once.
985 Note: =M-S-<right>= will not work on a selected region. Its use is to
986 demote a single subtree (i.e., a headline and all sub-headlines).
988 If M-<right> doesn't seem to work, make sure transient mark mode is
989 enabled. See [[transient-mark-mode][this FAQ]].
991 ** What's the deal with all the ellipses in my org outlines?
992    :PROPERTIES:
993    :CUSTOM_ID: org-ellipses
994    :END:
996 Org-mode uses ellipses to indicate folded (and thus hidden) text. Most
997 commonly, ellispes occur at the end of headings with folded content:
999 : * Heading ...
1001 Or, for instance, they may indicate closed drawers:
1003 : :PROPERTIES: ...
1005 Sometimes, as a result of editing and cycling an outline, ellipses may
1006 appear in unexpected places. You should *never* delete these ellipses,
1007 as you may accidentally delete hidden text. Instead, you can type =C-c
1008 C-r= (org-reveal) to display all hidden text in the vicinity. Or you
1009 may type =M-x RET show-all= to reveal all text in the org file.
1011 If you would prefer a symbol or face for indicating hidden text, you
1012 can customize the variable org-ellipses.
1014 ** How do I yank a subtree so it's indented according to points' location?
1015    :PROPERTIES:
1016    :CUSTOM_ID: yank-indent-subtree
1017    :END:
1019 You can either use =C-c C-w= with a working [[http://orgmode.org/manual/Refiling-notes.html#Refiling-notes][refile-targets]] setup.
1021 Or set =org-yank-adjusted-subtrees= to =t= which will adjust the
1022 yanked headline's level correctly.
1024 Just use =C-k= and =C-y= as you would everywhere else in Emacs.
1026 ** Can I read org-mode outlines in vim?
1027    :PROPERTIES:
1028    :CUSTOM_ID: org-outlines-in-vim
1029    :END:
1031 Yes, there is a script that enables one to view and navigate folded
1032 outline/org files in vim (though without most of org-mode's
1033 functionality, of course).
1035   - [[http://www.vim.org/scripts/script.php?script_id%3D1266][Emacs outline mode - Imitates Emacsen : vim online]]
1037 For instructions on how to set it up, please see [[http://mid.gmane.org/EA275862-B97A-4BAC-B879-177FD07A2D56@gaillourdet.net][this mailing list
1038 post]].
1040 * Todos and Tags
1041   :PROPERTIES:
1042   :CUSTOM_ID: Todos-and-Tags
1043   :END:
1044 ** How can I cycle through the TODO keyword of an entry?
1045    :PROPERTIES:
1046    :CUSTOM_ID: cycle-TODO-keywords
1047    :END:
1049   =C-c C-t= or =S-<left/right>= is what you need.
1051 ** How do I track state changes for tasks in Org?
1052    :PROPERTIES:
1053    :CUSTOM_ID: track-state-changes-for-tasks
1054    :END:
1056   Take a look at the [[http://thread.gmane.org/gmane.emacs.orgmode/6082][post by Bernt Hansen]] for setting up TODO keyword
1057   states and logging timestamps for task state changes.
1059 ** Can I select the TODO keywords with a tag-like interface?
1060    :PROPERTIES:
1061    :CUSTOM_ID: select-TODO-keywords-with-tag-like-interface
1062    :END:
1064   Yes.  Use =(setq org-use-fast-todo-selection t)=
1066   If you want to set both your todos and your tags using a single
1067   interface, then check out the variable
1068   =org-fast-tag-selection-include-todo=.
1070   See [[http://orgmode.org/manual/Fast-access-to-TODO-states.html][this section of the manual]] for more details.
1072 ** How can I quickly set the tag of an entry?
1073    :PROPERTIES:
1074    :CUSTOM_ID: quickly-set-tag-of-entry
1075    :END:
1077    Use =C-c C-c= or =C-c C-q= on the headline. =C-c C-q= is useful for
1078    setting tabs in a [[http://orgmode.org/manual/Remember.html#Remember][remember]] buffer, since =C-c C-c= is the default
1079    keybinding for filing a note from the remember buffer.
1081    You can set tags even more quickly by setting one of the character
1082    shortcuts for [[http://orgmode.org/manual/Setting-tags.html#Setting-tags][fast tag selection]].
1084    To set tag shortcuts for all org buffers, put something like the
1085    following in your =.emacs= file (or create the same settings by
1086    typing =M-x customize-variable RET org-tag-alist=):
1088 : (setq org-tag-alist '(("computer" . ?c) ("office" . ?o) ("home" . ?h)))
1090    To set tag shortcuts for a single buffer, put something like the
1091    following at the top of your org file:
1093 : #+TAGS: computer(c) office(o) home(h)
1095 ** How can I change the colors of TODO keywords?
1097 You can use the variable org-todo-keyword-faces. Here are some sample
1098 settings:
1100 #+begin_src emacs-lisp
1101 (setq org-todo-keyword-faces
1102       '(
1103         ("TODO"  . (:foreground "firebrick2" :weight bold))
1104         ("WAITING"  . (:foreground "olivedrab" :weight bold))
1105         ("LATER"  . (:foreground "sienna" :weight bold))
1106         ("PROJECT"  . (:foreground "steelblue" :weight bold))
1107         ("DONE"  . (:foreground "forestgreen" :weight bold))
1108         ("MAYBE"  . (:foreground "dimgrey" :weight bold))
1109         ("CANCELED"  . shadow)
1110         ))
1111 #+end_src
1113 If you want to change the color of all active todos or all inactive
1114 todos, type:
1116 : M-x customize-face RET org-todo
1117 : M-x customize-face RET org-done
1119 You can also set values for each of these in your =.emacs= file:
1121 : (set-face-foreground 'org-todo "firebrick2")
1122 : (set-face-foreground 'org-done "forestgreen")
1124 * Hyperlinks
1125   :PROPERTIES:
1126   :CUSTOM_ID: Hyperlinks
1127   :END:
1128 ** Why do I have to confirm the execution of each shell/elisp link?
1129    :PROPERTIES:
1130    :CUSTOM_ID: confirm-shell/elisp-link
1131    :END:
1133    The confirmation is there to protect you from unwantingly execute
1134    potentially dangerous commands.  For example, imagine a link
1136    : [[shell:rm -rf ~/*][Google Search]]
1138    In an Org-mode buffer, this command would look like /Google Search/,
1139    but really it would remove your home directory.  If you wish, you can
1140    make it easier to respond to the query by setting
1142    : (setq org-confirm-shell-link-function 'y-or-n-p
1143    :       org-confirm-elisp-link-function 'y-or-n-p).
1145    Then a single keypress will be enough to confirm those links.  It is
1146    also possible to turn off this check entirely, but I strongly
1147    recommend against this.  Be warned.
1149 ** Can I use RET or TAB to follow a link?
1150    :PROPERTIES:
1151    :CUSTOM_ID: RET-or-TAB-to-follow-link
1152    :END:
1154    Yes, this is how:
1156    : (setq org-return-follows-link t)
1157    : (setq org-tab-follows-link t)
1159 ** Can I keep mouse-1 clicks from following a link?
1160    :PROPERTIES:
1161    :CUSTOM_ID: mouse-1-following-link
1162    :END:
1164    Activating links with =mouse-1= is a new feature in Emacs 22, to make
1165    link behavior similar to other applications like web browsers.  If
1166    you hold the mouse button down a bit longer, the cursor will be set
1167    without following the link.  If you cannot get used to this behavior,
1168    you can (as in Emacs 21) use =mouse-2= to follow links and turn off
1169    link activation for =mouse-1= with
1171    : (setq org-mouse-1-follows-link nil)
1173 ** How can I get completion of file names when creating a link?
1174    :PROPERTIES:
1175    :CUSTOM_ID: completion-of-file-links
1176    :END:
1178 You can use org-insert-link with a prefix argument:
1180 : C-u C-c C-l
1182 You will be greeted with prompt in the minibuffer that allows for file
1183 completion using your preferred Emacs method for finding files.
1185 * Plain Lists
1186   :PROPERTIES:
1187   :CUSTOM_ID: Plain-Lists
1188   :END:
1189 ** How can I insert an empty line before each newly inserted headline, but not before each newly inserted plain-list item?
1190    :PROPERTIES:
1191    :CUSTOM_ID: empty-line-before-each-new-headline-but-not-item
1192    :END:
1194 : (setq org-blank-before-new-entry
1195 :       '((heading . t) (plain-list-item . nil))
1197 See also [[id:2463F4D8-F686-4CF3-AA07-08976F8A4972][Why is a blank line inserted after headlines and list items?]].
1199 ** How can I convert itemized lists to enumerated lists?
1200    :PROPERTIES:
1201    :CUSTOM_ID: convert-itemized-to-enumerated-lists
1202    :END:
1204    You can use =C-c -= or =S-<left>/<right>= to cycle through the various
1205    bullet headlines available for lists: =-, +, *, 1., 1)=.
1207    See [[http://orgmode.org/manual/Plain-lists.html#Plain-lists][this section of the manual]] for more information.
1209 ** How can I convert plain lists to headlines and vice versa?
1210    :PROPERTIES:
1211    :CUSTOM_ID: convert-plain-lists-to-headlines
1212    :END:
1214    To convert a plain list item or line to a headline, type =C-c *= on
1215    the headline. This will make the line a subheading of the current
1216    headline.
1218    To convert a headline to a plain list item, type =C-c -= while the
1219    cursor is on the headline.
1221    To convert a headline to an unadorned line of text, type =C-c *= on
1222    the headline.
1224    You can use query replace to accomplish the same things, as Bernt
1225    Hansen explains in [[http://article.gmane.org/gmane.emacs.orgmode/10148][this mailing list post]].
1227 ** Is there a good way to create a description list?
1228    :PROPERTIES:
1229    :CUSTOM_ID: description-lists
1230    :END:
1232   Yes, these are now built-in:
1234 #+BEGIN_EXAMPLE
1235 - item1 :: Description of this item 1
1236 - item2 :: Description of this item 2
1237 - item1 :: Description of this item 3
1238       also in multiple lines
1239 #+END_EXAMPLE
1241 * Tables
1242   :PROPERTIES:
1243   :CUSTOM_ID: Tables
1244   :END:
1245 ** Can I plot data from a table?
1246    :PROPERTIES:
1247    :CUSTOM_ID: plotting-table-data
1248    :END:
1250    Yes, you can, using org-plot.el written by James TD Smith and now
1251    bundled with Org.  See [[http://orgmode.org/manual/Org-Plot.html#Org-Plot][the manual section about this]].
1253    See also [[file:org-tutorials/org-plot.org][this excellent tutorial]] by Eric Schulte.
1255 ** How can I fill a table column with incremental numbers?
1256    :PROPERTIES:
1257    :CUSTOM_ID: fill-table-column-with-incremental-numbers
1258    :END:
1260 Here is how: Use a field formula to set the first value in the column:
1262 #+begin_src org
1263 ,| N   |   |
1264 ,|-----+---|
1265 ,| :=1 |   |
1266 ,|     |   |
1267 ,|     |   |
1268 ,|     |   |
1269 ,#+TBLFM: @2$1=1
1270 #+end_src
1272 Then define a column formula in the second field:
1274 #+begin_src org
1275 ,| N        |   |
1276 ,|----------+---|
1277 ,| 1        |   |
1278 ,| =@-1 + 1 |   |
1279 ,|          |   |
1280 ,|          |   |
1281 ,#+TBLFM: @2$1=1
1282 #+end_src
1284 After recomputing the table, the column will be filled with
1285 incremental numbers:
1287 #+begin_src org
1288 ,| N |   |
1289 ,|---+---|
1290 ,| 1 |   |
1291 ,| 2 |   |
1292 ,| 3 |   |
1293 ,| 4 |   |
1294 ,#+TBLFM: $1=@-1 + 1::@2$1=1
1295 #+end_src
1297 Note that you could use arbitrary starting values and column formulas.
1299 ** Why does my table column get filled with #ERROR?
1300    :PROPERTIES:
1301    :CUSTOM_ID: table-column-filled-with-ERROR
1302    :END:
1304    Org-mode tried to compute the column from other fields using a
1305    formula stored in the =#+TBLFM:= line just below the table, and
1306    the evaluation of the formula fails.  Fix the fields used in the
1307    formula, or fix the formula, or remove it!
1309 ** How can I stop the table editor from creating new lines?
1310    :PROPERTIES:
1311    :CUSTOM_ID: table-editor-creates-new-lines
1312    :END:
1314    When I am in the last column of a table and just above a horizontal
1315    line in the table, pressing TAB creates a new table line before the
1316    horizontal line.  To move to the line below the
1317    horizontal line instead, do this:
1319    Press =down= (to get on the separator line) and then =TAB=.
1320    Or configure the variable
1322    : (setq org-table-tab-jumps-over-hlines t)
1324 ** How can I get table fields starting with "="?
1325    :PROPERTIES:
1326    :CUSTOM_ID: table-fields-starting-with-=
1327    :END:
1329    With the setting
1331    : (setq org-table-formula-evaluate-inline nil)
1333    this will no longer happen.  You can still use formulas using the
1334    commands @<tt>C-c =@</tt> and @<tt>C-u C-c =@</tt>
1336 ** How can I change the indentation of an entire table without fixing every line by hand?
1337    :PROPERTIES:
1338    :CUSTOM_ID: change-indentation-entire-table
1339    :END:
1341    The indentation of a table is set by the first line.  So just fix the
1342    indentation of the first line and realign with =TAB=.
1344 ** In my huge table the realigning after each TAB takes too long.  What can I do?
1345    :PROPERTIES:
1346    :CUSTOM_ID: table-realigning-after-TAB-takes-long
1347    :END:
1349    Either split the table into several by inserting an empty line every
1350    100 lines or so.  Or turn off the automatic re-align with
1352    : (setq org-table-automatic-realign nil)
1354    After this the only way to realign a table is to press =C-c C-c=.  It
1355    will no longer happen automatically, removing the corresponding delays
1356    during editing.
1358 ** Recalculation of my table takes too long.  What can I do?
1359    :PROPERTIES:
1360    :CUSTOM_ID: Recalculation-of-my-table-takes-too-long
1361    :END:
1363    Nothing, really.  The spreadsheet in org is mostly done to make
1364    calculations possible, not so much to make them fast.  Since Org-mode
1365    is firmly committed to the ASCII format, nothing is stopping you from
1366    editing the table by hand.  Therefore, there is no internal
1367    representation of the data.  Each time Org-mode starts a computation,
1368    it must scan the table for special lines, find the fields etc.  This
1369    is slow.  Furthermore, Calc is slow compared to hardware
1370    computations.  To make this work with normal editing, recalculation
1371    is not happening automatically, or only for the current line, so that
1372    the long wait for a full table iteration only happens when you ask
1373    for it.
1375    So for really complex tables, moving to a "real" spreadsheet may
1376    still be the best option.
1378    That said, there are some ways to optimize things in Org-mode, and I
1379    have been thinking about moving a bit further down this line.
1380    However, for my applications this has so far not been an issue at
1381    all.  If you have a good case, you could try to convince me.
1383 ** =S-RET= in a table keeps increasing the copied numbers.  How can I stop this?
1384    :PROPERTIES:
1385    :CUSTOM_ID: S-RET-in-a-table-increases-copied-numbers
1386    :END:
1388    Well, it is /supposed/ to be a feature, to make it easy to create a
1389    column with increasing numbers.  If this gets into your way, turn it
1390    off with
1392    : (setq org-org-table-copy-increment nil)
1394 ** When I export tables to html, they don't have borders.
1395    :PROPERTIES:
1396    :CUSTOM_ID: table-borders-in-html-export
1397    :END:
1399 By default, org mode exports tables without borders.
1401 You can changed this by placing an =#+ATTR_HTML= line before the
1402 table:
1404 :  #+ATTR_HTML: border="2" rules="all" frame="all"
1406 See [[http://orgmode.org/manual/Tables-in-HTML-export.html#Tables-in-HTML-export][the manual]] for more details.
1408 ** Why does the Calc high precision (e. g. =p20=) not work like expected?
1409    :PROPERTIES:
1410    :CUSTOM_ID: table-high-precision
1411    :END:
1413 - *Short answer*
1415   Avoid
1416   : | 0.16666667000000 |
1417   : #+TBLFM: $1 = 1 / 2 * 3; p20 %.14f
1418   and use
1419   : | 0.16666666666667 |
1420   : #+TBLFM: $1 = 1 / 2 * 3; p20 f14
1422 - *Longer answer*
1424   It is important to distinguish between the precision of
1425   1) =p20=: Calc internal calculation (=calc-internal-prec=)
1426   2) =f14=: Calc float formatting, unlimited in precision (=calc-float-format=)
1427   3) =%.14f=: the =printf= reformatting, limited in precision
1429   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.
1431   Use =C-h v org-calc-default-modes RET= to check the Org default settings
1432   which are used if no format specifiers are added to a table formula.
1433   The examples below have been made with the out_of_the_box Org defaults
1434   =calc-internal-prec = 12= and =calc-float-format = 8=.
1436   Remember the formula debugger, toggled with =C-c {=,
1437   to view the processing stages like:
1438   |   | formula debugger label | processing stage           |
1439   | / | <                      | <>                         |
1440   |---+------------------------+----------------------------|
1441   |   | Result:                | output of Calc             |
1442   |   | Format:                | reformatting with =printf= |
1444   Following are some examples to demonstrate
1445   the interaction of the three precisions.
1447   - *display precision limitations for Calc formulas*
1448     - limited by Calc internal calculation precision from Org default
1449       (here =p12=)
1450       : | 0.16666666666700 |
1451       : #+TBLFM: $1 = 1 / 2 * 3;     f14
1453       : | 0.1666666666670000000 |
1454       : #+TBLFM: $1 = 1 / 2 * 3;     f19
1456     - limited by Calc float format from Org default (here =f8=)
1457       : | 0.16666667 |
1458       : #+TBLFM: $1 = 1 / 2 * 3
1460       : | 0.16666667 |
1461       : #+TBLFM: $1 = 1 / 2 * 3; p20
1463       : | 0.16666667000000 |
1464       : #+TBLFM: $1 = 1 / 2 * 3;         %.14f
1466       : | 0.16666667000000 |
1467       : #+TBLFM: $1 = 1 / 2 * 3; p20     %.14f
1469     - limited by Calc float format specified
1470       : | 0.166667 |
1471       : #+TBLFM: $1 = 1 / 2 * 3;     f6
1473       : | 0.16666666666667 |
1474       : #+TBLFM: $1 = 1 / 2 * 3; p20 f14
1476       : | 0.1666666666666666667 |
1477       : #+TBLFM: $1 = 1 / 2 * 3; p20 f19
1479     - limited by =printf= conversion to Emacs Lisp float
1480       : | 0.1666666699999999900 | the inaccuracy is platform dependent |
1481       : #+TBLFM: $1 = 1 / 2 * 3;         %.19f
1483       : | 0.1666666699999999900 | the inaccuracy is platform dependent |
1484       : #+TBLFM: $1 = 1 / 2 * 3; p20     %.19f
1486       : | 0.1666666666666666600 | the inaccuracy is platform dependent |
1487       : #+TBLFM: $1 = 1 / 2 * 3; p20 f20 %.19f
1489     - limited by =printf= format specified
1490       : | 0.166667 |
1491       : #+TBLFM: $1 = 1 / 2 * 3;         %.6f
1493   - *display precision limitations for Emacs Lisp formulas*
1494     - limited by Emacs Lisp float
1495       : | 0.16666666666666666 |
1496       : #+TBLFM: $1 = '(/ 1.0 (* 2 3))
1498       : | 0.1666666666666666574 | the inaccuracy is platform dependent |
1499       : #+TBLFM: $1 = '(/ 1.0 (* 2 3)); %.19f
1501     - limited by =printf= format specified
1502       : | 0.16666666666667 |
1503       : #+TBLFM: $1 = '(/ 1.0 (* 2 3)); %.14f
1505 This FAQ entry is based on this [[http://thread.gmane.org/gmane.emacs.orgmode/22642][mailing list thread]]
1506 and is continued in the [[#table-float-fraction][next FAQ entry]].
1508 ** Which float format shows the fraction part also when the latter is zero?
1509    :PROPERTIES:
1510    :CUSTOM_ID: table-float-fraction
1511    :END:
1513 - *Short answer*
1515   Avoid
1516   : | 1 |
1517   : #+TBLFM: $1 = 1 + 0; f3
1518   and use
1519   : | 1.000 |
1520   : #+TBLFM: $1 = 1 + 0; %.3f
1522 - *Longer answer*
1524   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]]
1525   in the section Mode Settings -> Display Modes -> Float Formats
1526   [[http://www.delorie.com/gnu/docs/calc/calc_163.html][found here as long as the section numbering is kept]].
1528   Remember the formula debugger, toggled with =C-c {=,
1529   to view the processing stages like:
1530   |   | formula debugger label | processing stage           |
1531   | / | <                      | <>                         |
1532   |---+------------------------+----------------------------|
1533   |   | Result:                | output of Calc             |
1534   |   | Format:                | reformatting with =printf= |
1536   Following are some examples to demonstrate different float formats.
1538   - normal precision
1539     : |----------------------+---------+-------+-------|
1540     : | number               |      f3 |   f-3 |  %.3f |
1541     : |----------------------+---------+-------+-------|
1542     : | 1 + 0                |       1 |     1 | 1.000 |
1543     : | 0 + 0                |       0 |     0 | 0.000 |
1544     : |----------------------+---------+-------+-------|
1545     : | 1 + 1 / 2 * 3 * 1000 |   1.000 | 1.000 | 1.000 |
1546     : | 0 + 1 / 2 * 3 * 1000 | 1.67e-4 | 0.000 | 0.000 |
1547     : |----------------------+---------+-------+-------|
1548     : | 1 + 1 / 2 * 3 *  100 |   1.002 | 1.002 | 1.002 |
1549     : | 0 + 1 / 2 * 3 *  100 |   0.002 | 0.002 | 0.002 |
1550     : |----------------------+---------+-------+-------|
1551     : #+TBLFM: $2 = $1; f3 :: $3 = $1; f-3 :: $4 = $1; %.3f
1553   - high precision
1554     : |----------------------+--------------------------+-----------------------|
1555     : | number               |                      f19 |                  f-19 |
1556     : |----------------------+--------------------------+-----------------------|
1557     : | 1 + 0                |                        1 |                     1 |
1558     : | 0 + 0                |                        0 |                     0 |
1559     : |----------------------+--------------------------+-----------------------|
1560     : | 1 + 1 / 2 * 3 * 1e19 |    1.0000000000000000000 | 1.0000000000000000000 |
1561     : | 0 + 1 / 2 * 3 * 1e19 | 1.666666666666666667e-20 | 0.0000000000000000000 |
1562     : |----------------------+--------------------------+-----------------------|
1563     : | 1 + 1 / 2 * 3 * 1e18 |    1.0000000000000000002 | 1.0000000000000000002 |
1564     : | 0 + 1 / 2 * 3 * 1e18 |    0.0000000000000000002 | 0.0000000000000000002 |
1565     : |----------------------+--------------------------+-----------------------|
1566     : #+TBLFM: $2 = $1; p20 f19 :: $3 = $1; p20 f-19
1568     The =printf= reformatting (=%.19f=) cannot be used with high precision,
1569     see the [[#table-high-precision][previous FAQ entry]].
1571 * Markup
1572   :PROPERTIES:
1573   :CUSTOM_ID: Footnotes
1574   :END:
1575 ** How can I get automatic renumbering of footnotes in org-mode?
1576    :PROPERTIES:
1577    :CUSTOM_ID:       footnote-auto-adjust
1578    :END:
1580 You can add the following line to your .emacs file:
1582 : (setq org-footnote-auto-adjust t)
1584 Or, if you prefer, you can turn this option on locally by placing the
1585 following line at the top of your org file:
1587 : #+STARTUP: fnadjust
1589 When auto-adjust is turned on, footnotes in the file with numerical
1590 labels will be renumbered whenever a new footnote is added. Meanwhile,
1591 all footnotes, including those with custom labels such
1592 =[fn:custom-label ]=, will be sorted in the order of their appearance
1593 in the text.
1595 This emulates the footnote behavior that many users may be familiar
1596 with from word-processing programs or from the footnote-mode included
1597 with emacs.
1599 If you do not turn on org-footnote-auto-adjust, you sort and/or
1600 renumber footnotes at any time by calling org-footnote-action with a
1601 prefix argument.
1603 ** Why isn't auto renumbering of footnotes turned on by default?
1604    :PROPERTIES:
1605    :CUSTOM_ID:       why-no-default-auto-adjust
1606    :END:
1608 Org mode has a very robust footnote mechanism allowing for a variety
1609 of types of footnotes. With some of the following footnote notations,
1610 auto-adjust may be either irrelevant or undesired:
1612  - Automatically numbered
1613  - Footnotes with custom labels
1614  - Inline footnotes
1616 In addition, org mode can be customized to place footnotes either at
1617 the end of a document or at the end of the outline heading in which
1618 they appear. Users who change this setting while editing a document
1619 may be disconcerted to find all of their footnotes rearranged
1620 automatically.
1622 ** I have auto-fill-mode set and org-mode is inserting unwanted comment markers!
1623    :PROPERTIES:
1624    :CUSTOM_ID: auto-fill-and-unwanted-comments
1625    :END:
1627 If the following occurs:
1629 #+begin_src org
1631 #+OPTIONS: toc:nil
1632 Some entered text.
1633 # More entered tex.
1635 #+end_src
1637 Make sure that the variable comment-start is nil.
1639 ** Are there any shortcuts for entering source blocks and comment lines?
1640    :PROPERTIES:
1641    :CUSTOM_ID: shortcuts-for-entering-source-blocks
1642    :END:
1644 Org mode has some [[http://orgmode.org/manual/Literal-examples.html#Literal-examples][very convenient markup]] for including literal blocks
1645 and lines of code in a file. (This is especially useful when exporting
1646 documents or using the contributed package [[file:org-contrib/babel/index.org][org-babel]] for executing
1647 blocks of code.)
1649 #+begin_src org
1650   ,#+begin_src perl
1651   ,  print "Hello, world!\n";
1652   ,#+end_src
1653 #+end_src
1655 It can be tiresome to enter the block comment lines manually. There
1656 are several possible shortcuts you can use to enter them:
1658 1) Built-in expansion
1660    - Org mode has a "secret" method of expanding source code blocks
1661      and comment lines.
1663    - If you type "<s" followed by =TAB= or =M-TAB=, a source block will
1664      magically appear.
1666    - For a full list of expansions, type =M-x describe-variable
1667      [RET] org-structure-template-alist=.
1669 2) [[http://orgmode.org/manual/Literal-examples.html#Literal-examples][Registers]]
1671    - Add the following line to your emacs file:
1673      =(set-register ?p "#+begin_src\n\n#+end_src perl")=
1675    - Then type =C-x r i p= to insert the source block. Please note: if
1676      you save another value to the register "p" with =C-x r s p=, it
1677      will overwrite the setting above for the current emacs session.
1679 3) [[http://orgmode.org/manual/Literal-examples.html#Literal-examples][Abbrevs]]
1681  - Activate the abbrev minor-mode in org-mode:
1683    + M-x abbrev-mode
1685    + /Permanently/:
1687        + =(add-hook 'org-mode-hook (lambda () (abbrev-mode 1)))=
1689  - In org-mode, type "sbp" (a sample abbreviation for a perl source
1690    block).
1692  - Immediately after "sbp" type =C-x a i l=.
1694  - Enter the expansion: 
1696    - =#+begin_src perl[C-q C-j][C-q C-j]#+end_src=
1698    - Note: =C-q C-j= creates a new line in the minibuffer
1700  - Now, whenever, you type sbp followed by =SPACE= or =RET= in an
1701    org-mode buffer, the src block will magically appear.
1703  - To review your list of abbrevs, type =M-x edit-abbrevs=.
1705  - If you want more complex completion (like yasnippet) you can combine
1706    abbrev mode with [[http://www.emacswiki.org/emacs/SkeletonMode][skeletons]].
1708 4) [[http://code.google.com/p/yasnippet/][Yasnippet]]
1710  - Several org-mode users install yasnippet for convenient, complex
1711    expansion.
1713  - See Bernt Hansen's [[http://doc.norang.ca/org-mode.html#Yasnippets][org-mode setup]] for a good introduction to
1714    yasnippet.
1716 * Remember
1717   :PROPERTIES:
1718   :CUSTOM_ID: Remember
1719   :END:
1720 ** Can I use the remember buffer to clock a customer phone call?
1721    :PROPERTIES:
1722    :CUSTOM_ID: use-remember-buffer-to-clock-phone-call
1723    :END:
1725   Yes, you can.  Take a look at the [[http://thread.gmane.org/gmane.emacs.orgmode/5482][setup described by Bernt Hansen]]
1726   and check out (in the same thread) what Nick Docos had to fix to
1727   make Bernt's set-up work for him.
1728 ** Can I automatically start the clock when opening a remember template?
1729    :PROPERTIES:
1730    :CUSTOM_ID: start-clock-when-opening-remember-template
1731    :END:
1733    Yes, this is possible.  Use the following code and make sure that
1734    after executing it, `my-start-clock-if-needed' is in
1735    `remember-mode-hook' /after/ `org-remember-apply-template'.
1737    : (add-hook 'remember-mode-hook 'my-start-clock-if-needed 'append)
1738    : (defun my-start-clock-if-needed ()
1739    :   (save-excursion
1740    :     (goto-char (point-min))
1741    :     (when (re-search-forward " *CLOCK-IN *" nil t)
1742    :       (replace-match "")
1743    :       (org-clock-in))))
1745    Then, when a template contains the key string CLOCK-IN, the clock
1746    will be started.  Starting with Org-mode version 5.20, the clock will
1747    automatically be stopped when storing the remember buffer.
1749 * Searches
1750   :PROPERTIES:
1751   :CUSTOM_ID: Searches
1752   :END:
1753 ** Isearch does not find string hidden in links.  What can I do?
1754    :PROPERTIES:
1755    :CUSTOM_ID: isearch-in-links
1756    :END:
1758   M-x =visible-mode= will display the full link, making them searchable.
1760 ** How can I reduce the amount of context shown in sparse trees?
1761    :PROPERTIES:
1762    :CUSTOM_ID: context-in-sparse-trees
1763    :END:
1765    Take a look at the following variables:
1767    - =org-show-hierarchy-above=
1768    - =org-show-following-headline=
1769    - =org-show-siblings=
1770    - =org-show-entry-blow=
1772    which give command-dependent control over how much context is shown
1773    by a particular operation.
1775 ** How can I combine the results of two calls to =org-occur=?
1776    :PROPERTIES:
1777    :CUSTOM_ID: two-calls-to-org-occur
1778    :END:
1780    You can construct a regular expression that matches all targets you
1781    want.  Alternatively, use a =C-u= prefix with the second and any
1782    further calls to =org-occur= to keep the current visibility and
1783    highlighting in addition to the new ones.
1785 * Agenda
1786   :PROPERTIES:
1787   :CUSTOM_ID: Agenda
1788   :END:
1789 ** How can I change the advanced warning time for deadlines?
1790 ##<<warning-period-for-deadlines>>
1792 Deadline warnings appear in the daily agenda view a specified number
1793 of days before the deadline is due. The default setting is 14 days.
1794 You can change this with the variable =org-deadline-warning-days=.
1795 (See [[http://orgmode.org/manual/Deadlines-and-scheduling.html#Deadlines-and-scheduling][this section]] of the manual.)
1797 For instance,
1799 : (setq org-deadline-warning-days 30)
1801 would cause warnings for each deadline to appear 30 days in advance.
1803 Naturally, you might not want warnings for all of your deadlines to
1804 appear so far in advance. Thus, you can change the lead time for
1805 individual items as follows:
1807 : * TODO Get a gift for the party
1808 :   DEADLINE: <2009-01-16 Fri -2d>
1810 The "-2d" above changes the lead time for this deadline warning to two
1811 days in advance. You can also use "w" for weeks and "m" for months.
1812 ** How can I postpone a task until a certain date?
1813    :PROPERTIES:
1814    :CUSTOM_ID: deferring-tasks
1815    :END:
1817 The easiest way to postpone a task is to schedule it in the future.
1818 For instance, typing =C-c C-s +2w= on a headline will push a task two
1819 weeks into the future, so that it won't show up on the daily agenda
1820 until two weeks from now.
1822 If you'd like to prevent the task from showing up on your global todo
1823 list, you have a couple of options.
1825 1. You can set the variable =org-agenda-todo-ignore-scheduled= to =t=.
1826    This will exclude any scheduled items from your global list of
1827    active todos (=C-c a t=). (The variable
1828    =org-agenda-todo-ignore-with-date= will exclude both scheduled and
1829    deadline items from your todo list).
1830 2. You can remove the todo keyword from the item (C-c C-t <SPC>). The
1831    item will still appear on your agenda two weeks from today, but it
1832    won't show up on your todo lists.
1833 ** Can I send myself an email containing tasks or other agenda info?
1834    :PROPERTIES:
1835    :CUSTOM_ID: email-containing-tasks-or-other-agenda-info
1836    :END:
1838    Yes.  See [[http://article.gmane.org/gmane.emacs.orgmode/6112][this thread]] on the list.
1840 ** How can I limit the agenda view to my "work" tasks?
1841    :PROPERTIES:
1842    :CUSTOM_ID: limit-agenda-with-tag-filtering
1843    :END:
1845    It is often convenient to group org files into separate categories,
1846    such as "home" and "work" (or "personal" and "professional"). One
1847    of the main reasons for such classification is to create agenda
1848    views that are limited by type of work or area of responsibility.
1849    For instance, while at work, one may want to see only professional
1850    tasks; while away from work, one may want to see only personal
1851    tasks.
1853    One way to categorize files and tasks is to use a "#+FILETAGS"
1854    declaration at the top of each file, such as:
1856    : #+FILETAGS: work
1858    As long as org-use-tag-inheritance is turned on, the filetags will
1859    be inherited by all tasks in the file. A file can have multiple
1860    filetags. And, of course, tags can be added to individual headings.
1862    Tasks can be quickly filtered by tag from within the agenda by
1863    typing "/" and the name of the tag. The full key sequence to filter
1864    for work items in an agenda view would be:
1866    : C-c a a / work [or a tag shortcut]
1868 ** How can I limit the agenda view to a particular category?
1869    :PROPERTIES:
1870    :CUSTOM_ID: limit-agenda-with-category-match
1871    :END:
1873    Another way to filter agenda views by type of work is to use a
1874    "#+CATEGORY" declaration at the top of each file, such as:
1876    : #+CATEGORY: work
1878    Categories can also be added to individual headings within a file:
1880    : * Big project
1881    :   :PROPERTIES:
1882    :   :CATEGORY: work
1883    :   :END:
1885    All todos belonging to the category "work" can be found a with a
1886    simple tags-todo search:
1888    : C-c a M
1890    At the prompt, type:
1892    : CATEGORY="work"
1894    The same results can be achieved with custom agenda commands, such as:
1896 #+BEGIN_SRC emacs-lisp
1897 (setq org-agenda-custom-commands
1898       '(("h" tags-todo "CATEGORY=\"home\"")
1899         ("w" tags-todo "CATEGORY=\"work\"")
1900         ;; other custom agenda commands here
1901         ))
1902 #+END_SRC
1904 ** How can include all org files in a directory in my agenda?
1905    :PROPERTIES:
1906    :CUSTOM_ID: set-agenda-files-using-wildcards
1907    :END:
1909 You can simply include the directory (as one of the items) in the
1910 value of the variable org-agenda-files:
1912 : (setq org-agenda-files '("/my/special/path/org/"))
1914 There is another way of accomplishing the same end:
1916 : (setq org-agenda-files (file-expand-wildcards "/my/special/path/org/*.org"))
1918 ** Why aren't items disappearing from my agenda once they are marked done?
1919    :PROPERTIES:
1920    :CUSTOM_ID: removing-done-items-from-agenda
1921    :END:
1923 If items remain on your daily/weekly agenda after they are marked
1924 done, check the configuration of the following variables:
1926 : org-agenda-skip-scheduled-if-done
1927 : org-agenda-skip-deadline-if-done
1928 : org-agenda-skip-timestamp-if-done
1930 For instance, type:
1932 : M-x customize-variable RET org-agenda-skip-scheduled-if-done
1934 If this variable is turned off (=nil=), then scheduled items will
1935 remain on the agenda even after they are marked done.
1937 If the variable is turned on (=t=), then scheduled items will
1938 disappear from the agenda after they are marked done.
1940 If these settings seem not to behave the way you expect, then make
1941 sure you understand [[scheduled-vs-deadline-vs-timestamp][the
1942 difference between SCHEDULED, DEADLINE, and timestamps]].
1944 ** What is the difference between SCHEDULED, DEADLINE, and plain timestamps?
1945    :PROPERTIES:
1946    :CUSTOM_ID: scheduled-vs-deadline-vs-timestamp
1947    :END:
1949 1. SCHEDULED items (set with =C-c C-s=) will appear on your agenda on
1950    the day they are scheduled and on every day thereafter until they
1951    are done. Schedule a task if you want to be reminded to do
1952    something beginning on a certain day and until it is done.
1954 : ** TODO Scheduled item
1955 :    SCHEDULED: <2009-03-01 Sun>
1957 2. Items with a DEADLINE timestamp (set with =C-c C-d=) appear on your
1958    agenda in advance of the when they are due and remain on your
1959    agenda until they are done. Add a DEADLINE to an item if you want
1960    to make sure to complete it by a certain date. (The variable
1961    org-deadline-warning-days determines how far in advance items with
1962    deadlines will show up in the agenda. See [[warning-period-for-deadlines][this FAQ]] for more
1963    information.)
1965 : ** TODO Item with a deadline
1966 :    DEADLINE: <2009-01-20 Tue>
1968 3. An active timestamp (set with =C-c .=) will appear on your agenda
1969    only on the day it is scheduled. Use a timestamp for appointments
1970    or any reminders you want to show up only on a particular day.
1972 : ** TODO Item with an active timestamp
1973 : <2009-04-18 Sat>
1975 Note: items with inactive timestamps (set with C-c ! and marked by
1976 square brackets) will not show up in the agenda at all.
1978 ** Can I add files recursively to my list of agenda files?
1979    :PROPERTIES:
1980    :CUSTOM_ID: set-agenda-files-recursively
1981    :END:
1983 Yes, you can use the library "find-lisp."
1985 : (load-library "find-lisp")
1986 : (setq org-agenda-files (find-lisp-find-files "~/org" "\.org$"))
1988 This will add all files ending in =org= in the directory "~/org"
1989 and all of its subdirectories to your list of agenda files.
1991 See [[http://thread.gmane.org/gmane.emacs.orgmode/8992][this thread]] on the mailing list for more information.
1993 ** Why does an item appearing at the wrong time of day in my agenda?
1994    :PROPERTIES:
1995    :CUSTOM_ID: agenda-wrong-time-of-day
1996    :END:
1998 When preparing the agenda view, org-mode scans each relevant headline
1999 for a time designation. This approach is very nice for adding
2000 free-form timestamps to an item for scheduling. Thus, either of the
2001 following work would work to schedule an item at 10:00am:
2003 #+begin_src org
2004 ,** 10:00am Get dried ice at the magic store
2005 ,   SCHEDULED: <2009-05-27 Wed>
2006 #+end_src
2008 #+begin_src org
2009 ,** Get dried ice at the magic store
2010 ,   SCHEDULED: <2009-05-27 Wed 10:00>
2011 #+end_src
2013 To enable this flexibility, org-mode scans the entire headline for
2014 time of day notation. A potential problem can arise if you use
2015 inactive timestamps in the headline to note when an item was created.
2016 For example,
2018 #+begin_src org
2019 ,** Get dried ice at the magic store [2009-05-26 Tue 12:58]
2020 ,   SCHEDULED: <2009-05-27 Wed>
2021 #+end_src
2023 Org mode would interpret the time in the inactive timestamp as a
2024 time-of-day indicator and the entry would appear in your agenda at
2025 12:58.
2027 If you would like to turn off the time-of-day search, you can
2028 configure the variable =org-agenda-search-headline-for-time= (requires
2029 org-mode >= 6.24).
2031 * Appointments/Diary
2032   :PROPERTIES:
2033   :CUSTOM_ID: Appointments/Diary
2034   :END:
2035 ** Is it possible to include entries from org-mode files into my emacs diary?
2036    :PROPERTIES:
2037    :CUSTOM_ID: include-entries-from-org-mode-files-into-emacs-diary
2038    :END:
2040    Since the org-mode agenda is much more powerful and can contain the
2041    diary, you should think twice before deciding to do this.  If you
2042    insist, however, integrating Org-mode information into the diary is
2043    possible.  You need to turn on /fancy diary display/ by setting in
2044    .emacs:
2046    : (add-hook 'diary-display-hook 'diary-fancy-display)
2048    Then include the following line into your ~/diary file, in
2049    order to get the entries from all files listed in the variable
2050    =org-agenda-files=
2052    : &%%(org-diary)
2054    You may also select specific files with
2056    : &%%(org-diary) ~/path/to/some/org-file.org
2057    : &%%(org-diary) ~/path/to/another/org-file.org
2059    If you now launch the calendar and press @<tt>d@</tt> to display a
2060    diary, the headlines of entries containing a timestamp, date range,
2061    schedule, or deadline referring to the selected date will be listed.
2062    Just like Org-mode's agenda view, the diary for /today/ contains
2063    additional entries for overdue deadlines and scheduled items.  See
2064    also the documentation of the =org-diary= function.  Under XEmacs, it
2065    is not possible to jump back from the diary to the org, this works
2066    only in the agenda buffer.
2067 ** I want to add my Org scheduled/deadlined entries in my diary!
2068    :PROPERTIES:
2069    :CUSTOM_ID: add-Org-scheduled/deadlined-entries-to-diary!
2070    :END:
2072   Put this in your ~/.diary:
2074   : &%%(org-diary :scheduled :timestamp :deadline)
2076 ** How can I set up automatic reminders based on Org information?
2077    :PROPERTIES:
2078    :CUSTOM_ID: automatic-reminders
2079    :END:
2081   See [[http://article.gmane.org/gmane.emacs.orgmode/5271][this post]] by N. Dokos on the list.
2082 ** How can I make =appt= notice my Org appointments?
2083    :PROPERTIES:
2084    :CUSTOM_ID: appt-notice-my-Org-appointments
2085    :END:
2087   : M-x org-agenda-to-appt RET
2089 ** How can I create more complex appointments in my org-files?
2090    :PROPERTIES:
2091    :CUSTOM_ID: diary-sexp-in-org-files
2092    :END:
2094 Org-mode's active timestamps work very well for scheduling individual
2095 or recurring appointments, such as:
2097 #+begin_src org
2098   ,* 8:00am Dentist appointment <2009-01-16 Fri>
2099 #+end_src
2102 #+begin_src org
2103   ,* Vacation
2104   ,  <2009-03-20 Fri>--<2009-04-01 Wed>
2105 #+end_src
2109 #+begin_src org
2110   ,* Weekly meeting with boss
2111   ,  <2009-01-20 Tue 14:00 +1w>
2112 #+end_src
2114 Sometimes, however, you need to set up more complicated recurring
2115 appointments. Org-mode has built-in support for many of
2116 [[http://www.gnu.org/software/emacs/manual/html_node/emacs/Sexp-Diary-Entries.html][the
2117 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
2118 instance, that you teach a class that meets every Monday evening
2119 between February 16 and April 20, 2009. The way to enter this an
2120 org-mode file is:
2122 #+begin_src org
2123   ,** Class 7:00pm-9:00pm
2124   ,   <%%(and (= 1 (calendar-day-of-week date)) (diary-block 2 16 2009 4 20 2009))>
2125 #+end_src
2127 The expression above designates all Mondays that fall between February
2128 16 and April 20. How exactly does it work?
2130  - (and... :: Indicates that *both* of the conditions that follow have
2131           to be true.
2133    - (= 1 (calendar-day-of-week date)) :: Is the day of the week a
2134         Monday?
2136        - Note: the function calendar-day-of-week converts the date to the day of week
2137          expressed in numeric form, where 0 = Sunday, 1 = Monday, and so on.
2139    - (diary-block 2 16 2009 4 20 2009) :: Does the date fall between
2140         these two dates?
2142 You can make a sexp as complex as you like. If you wanted to omit a
2143 week because of holidays, for instance, you could add another
2144 condition to the sexp:
2146 #+begin_src org
2147   ,** Class 7:00pm-9:00pm
2148   ,   <%%(unless (diary-block 3 9 2009 3 13 2009) (and (= 1 (calendar-day-of-week date)) (diary-block 2 16 2009 4 20 2009)))>
2149 #+end_src
2151 The sexp above would omit Monday during the week of March 9, 2009. For
2152 another way to accomplish the same thing, see [[org-diary-class][this FAQ]].
2154 Another diary function commonly used for more complex scheduling is
2155 diary-float. For instance,
2157 #+begin_src org
2158   ,* Monthly meeting
2159   ,  <%%(diary-float t 3 3)>
2160 #+end_src
2162 ...would appear on the third Wednesday of every month.
2164 For more ideas on how to create diary special expressions, see [[http://www.emacswiki.org/cgi-bin/wiki/DiaryMode][this
2165 page on the Emacs wiki]].
2167 ** How can I schedule a weekly class that lasts for a limited period of time?
2168    :PROPERTIES:
2169    :CUSTOM_ID: org-diary-class
2170    :END:
2172 Org-mode offers a convenient diary sexp function for setting up a
2173 recurring appointment that lasts for a certain period of time, such as
2174 a class. It is called org-diary-class and it can be entered as
2175 follows:
2177 #+begin_src org
2178   ,** Class 7:00pm-9:00pm
2179   ,   <%%(org-diary-class 2 16 2009 4 20 2009 1 10)>
2180 #+end_src
2182 The function above schedules an appointment for every Monday (1)
2183 between February 16 and April 20, 2009, except for ISO week 10 (March
2184 1 to March 7).
2186 The function org-diary-class has the following format:
2188 : (org-diary-class M1 D1 Y1 M2 D2 Y2 DAYNAME &rest SKIP-WEEKS)
2190 M1/2, D1/2, and Y1/2 indicate the beginning and ending dates. Dayname
2191 takes the form of a number indicating the day of the week (0 = Sunday,
2192 1 = Monday, and so on...). In addition, one can add an optional
2193 argument SKIP-WEEKS to indicate weeks on the calendar that should be
2194 skipped. This argument should be expressed as an ISO week number. You
2195 can find the number by invoking emacs' built-in calendar (=M-x
2196 calendar=), navigating to the appropriate week, and typing =p c=
2197 (calendar-iso-print-date).
2199 ** How can I set an event to occur every day except Saturday and Sunday?
2201    #+begin_example
2202    ** Daily meeting
2203       <%%(memq (calendar-day-of-week date) '(1 2 3 4 5))>
2204    #+end_example
2206 * Export
2207   :PROPERTIES:
2208   :CUSTOM_ID: Export
2209   :END:
2210 ** Can I get TODO items exported to HTML as lists, rather than as headlines?
2211    :PROPERTIES:
2212    :CUSTOM_ID: export-TODO-items-as-lists
2213    :END:
2215    If you plan to use ASCII or HTML export, make sure things you want to
2216    be exported as item lists are level 4 at least, even if that does
2217    mean there is a level jump.  For example:
2219    : * Todays top priorities
2220    : **** TODO write a letter to xyz
2221    : **** TODO Finish the paper
2222    : **** Pick up kids at the school
2224    Alternatively, if you need a specific value for the heading/item
2225    transition in a particular file, use the =#+OPTIONS= line to
2226    configure the H switch.
2228    : #+OPTIONS:   H:2; ...
2230 ** Can I export only a single subtree?
2231    :PROPERTIES:
2232    :CUSTOM_ID: export-single-subtree
2233    :END:
2235    If you want to export a subtree, mark the subtree as region and then
2236    export.  Marking can be done with =C-c @ C-x C-x=, for example.
2238 ** How can I tell my calendar web application about appointments in my agenda files?
2240 Here is what you need to do:
2242 1. a script that calls Emacs in batch mode and produce a .ics file
2243 2. a script that uploads this .ics file somewhere on the web
2244 3. tell your webapp to fetch this .ics file on the web
2246 Here is the script I use for the first step:
2248 #+begin_src shell-script-mode
2249 #!/bin/bash
2251 /usr/local/bin/emacs --batch --eval \
2252 "(progn (load-file \"~/install/git/org-mode/org.el\") \
2253         (load-file \"~/elisp/config/org-batch-config.el\") \
2254         (setq org-combined-agenda-icalendar-file \"~/org/cal/org.ics\")
2255         (setq org-agenda-files (quote (\"~/org/bzg.org\"))))" \
2256     -f org-export-icalendar-combine-agenda-files
2257 #+end_src
2259 Depending on your configuration, you might change the load sequence.
2261 Here is the script I use for the second step:
2263 #+begin_src shell-script-mode
2264 #!/bin/bash
2265 /usr/bin/rsync -rtv ~/org/org.ics -e ssh me@my_server:/home/me/public_html/
2266 #+end_src
2268 Note: if you want to cron this rsync script, you will need to let
2269 =my_server= to know about your SSH public key.  Check [[http://troy.jdmz.net/rsync/index.html][this page]] as a
2270 starter.
2272 Now you can cron the two scripts above and your webapp will always be
2273 up to date with your Org agendas.
2275 Also see [[http://orgmode.org/org.html#Exporting-Agenda-Views][Exporting agenda views]] from Org manual.
2277 ** How can I get Mac OSX 10.3 iCal to import my Org-exported .ics files?
2278    :PROPERTIES:
2279    :CUSTOM_ID: iCal-import-ics-files-old
2280    :END:
2282    When using iCal under Apple MacOS X Tiger, you can create a new
2283    calendar /OrgMode/ (the default name for the calendar created by =C-c
2284    C-e c=, see the variables =org-icalendar-combined-name= and
2285    =org-combined-agenda-icalendar-file=).  Then set Org-mode to
2286    overwrite the corresponding file /~/Library/Calendars/OrgMode.ics/.
2287    You may even use AppleScript to make iCal re-read the calendar files
2288    each time a new version of /OrgMode.ics/ is produced.  Here is the
2289    setup needed for this:
2291    : (setq org-combined-agenda-icalendar-file
2292    :     "~/Library/Calendars/OrgMode.ics")
2293    : (add-hook 'org-after-save-iCalendar-file-hook
2294    :  (lambda ()
2295    :   (shell-command
2296    :    "osascript -e 'tell application \"iCal\" to reload calendars'")))
2298 ** How can I get Mac OSX 10.4 or later iCal to import my Org-exported .ics files?
2299    :PROPERTIES:
2300    :CUSTOM_ID: iCal-import-ics-files-new
2301    :END:
2303    For Mac OS X 10.4, you need to write the ics file to
2304    =/Library/WebServer/Documents/= and then subscribe iCalendar to
2305    =http: //localhost/orgmode.ics=
2307 ** How can I remove timestamps and todo keywords from my exported file?
2308    :PROPERTIES:
2309    :CUSTOM_ID: export-options-remove-timestamps
2310    :END:
2312 You can place an options line at the top of your org file:
2314 : #+OPTIONS: <:nil todo:nil
2316 There is a whole host of export options you can set with an in-buffer
2317 options or via global variables. See [[http://orgmode.org/manual/Export-options.html#Export-options][this section]] of the manual for a
2318 full list.
2320 ** How can I preserve faces when I export an agenda from the command line?
2321    :PROPERTIES:
2322    :CUSTOM_ID: preserving-faces-during-batch-export
2323    :END:
2325 Normally, when you export an org file or an agenda view from within
2326 emacs, htmlize will convert your face definitions to direct color css
2327 styles inlined into each =<span>= object, resulting in an HTML output
2328 that preserves the general look of your Org buffers and agenda views.
2330 Let's say you generate an export from the command line, such as the
2331 following:
2333 : emacs -batch -l ~/.emacs -eval '(org-batch-agenda "e")'
2337 : emacs -batch -l ~/.emacs -eval '(org-publish-all)'
2339 In such an instance, the exported HTML will contain only very basic
2340 color styles. The reason is that when Emacs is run in batch mode, it
2341 does not have a display and therefore only rudimentary face
2342 definitions.  If you'd like to use more complex styles, you'll have to
2343 make sure that the export process only assigns classes instead of
2344 direct color values.  This can be done by binding the variable
2345 =org-export-htmlize-output-style= to =css= for the duration of the
2346 export, for example with
2348 : emacs -batch -l ~/.emacs
2349 :   -eval '(let ((org-export-htmlize-generate-css (quote css)))
2350 :            (org-batch-agenda "e"))'
2352 Then you can use a style file to make these classes look any way you
2353 like.  To generate face definitions for a CSS file based on any faces
2354 you are currently using in Emacs, you can use the following command:
2356 : M-x org-export-htmlize-generate-css RET
2358 This will generate a =<style>...</style>= section, the content of
2359 which you can add to your style file.
2361 ** How can I avoid dark color background when exporting agenda to ps format?
2362    :PROPERTIES:
2363    :CUSTOM_ID: avoiding-dark-background-when-exporting-agenda
2364    :END:
2366 Add this to your .emacs and evaluate it.
2368 #+BEGIN_SRC emacs-lisp
2369   (setq org-agenda-exporter-settings
2370         '((ps-print-color-p 'black-white)))
2371 #+END_SRC
2373 ** How can I get colored source code when exporting to LaTeX?
2374    :PROPERTIES:
2375    :CUSTOM_ID: fontified_source_code_w_latex
2376    :END:
2378 As of Sun Aug 9 2009 the "current" version of Org-mode (see
2379 [[keeping-current-with-Org-mode-development]]) supports exporting source
2380 code to LaTeX using the listings package.
2382 To turn on listing export add the following to your Org-mode
2383 customization.
2384 #+begin_src emacs-lisp
2385   ;; requite org-latex so that the following variables are defined
2386   (require 'org-latex)
2387   
2388   ;; tell org to use listings
2389   (setq org-export-latex-listings t)
2390   
2391   ;; you must include the listings package
2392   (add-to-list 'org-export-latex-packages-alist '("" "listings"))
2393   
2394   ;; if you want colored source code then you need to include the color package
2395   (add-to-list 'org-export-latex-packages-alist '("" "color"))
2396 #+end_src
2398 The listings package will now be used to fontify source code in your
2399 LaTeX documents.  By default listings will not color any of your
2400 source code.  If you would like to set colors for keywords and
2401 comments in your latex documents you can do so using LaTeX directives
2402 like the following.
2403 #+begin_src latex
2404   \lstset{keywordstyle=\color{blue},
2405     commentstyle=\color{red},
2406     stringstyle=\color{green}
2407   }
2408 #+end_src
2410 of if you want to get even fancier with your colors you can try
2411 something like the following
2412 #+begin_src latex
2413 \definecolor{keywords}{RGB}{255,0,90}
2414 \definecolor{comments}{RGB}{60,179,113}
2415 \definecolor{fore}{RGB}{249,242,215}
2416 \definecolor{back}{RGB}{51,51,51}
2417 \lstset{
2418   basicstyle=\color{fore},
2419   keywordstyle=\color{keywords},  
2420   commentstyle=\color{comments},
2421   backgroundcolor=\color{back}
2423 #+end_src
2425 For more complex listings use cases consult the [[ftp://ftp.tex.ac.uk/tex-archive/macros/latex/contrib/listings/listings.pdf][listings manual]].
2427 ** How can I export to Latex Beamer
2428    :PROPERTIES:
2429    :CUSTOM_ID: beamer
2430    :END:
2431 The latex [[http://latex-beamer.sourceforge.net/][Beamer Class]] is a useful class for generating slide shows.
2432 The following can be used to export Org-mode documents to LaTeX
2433 beamer.
2435 Add the following to your Emacs initialization file.
2436 #+begin_src emacs-lisp
2437   (unless (boundp 'org-export-latex-classes)
2438     (setq org-export-latex-classes nil))
2439   (add-to-list 'org-export-latex-classes
2440                '("beamer"
2441                  "\\documentclass[11pt]{beamer}\n\\usepackage[utf8]{inputenc}\n\\usepackage[T1]{fontenc}\n\\usepackage{hyperref}\n\\usepackage{verbatim}\n"
2442                  ("\\section{%s}" . "\\section*{%s}")
2443                  ("\\begin{frame}\\frametitle{%s}" "\\end{frame}"
2444                   "\\begin{frame}\\frametitle{%s}" "\\end{frame}")))
2445 #+end_src
2447 Then by placing
2448 : #+LaTeX_CLASS: beamer
2449 in the header of your Org-mode document it will automatically export
2450 to the Beamer document class on LaTeX export.  With the above
2451 configuration top-level headers will be mapped to sections in the
2452 Beamer document, second-level headers will be mapped to frames, and
2453 lower level headlines will be mapped to itemize objects.
2455 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
2456 Thomas Dye]].  For a much more complex Beamer setup see the [[http://article.gmane.org/gmane.emacs.orgmode/17767/match=beamer+dokos][email by
2457 Thomas Dye]].
2459 ** How can I use RefTeX in Org-mode files for LaTeX export and in Org-babel LaTeX code blocks?
2461 [[http://www.gnu.org/software/auctex/reftex.html][RefTeX]] is an indispensable tool for the author of LaTeX documents.  It
2462 aids in creation of bibliographies, cross-references, indexes, and
2463 glossaries.  RefTeX understands the structure of multi-file LaTeX
2464 documents and is able to collect from them information about the
2465 location(s) of external data stores used in creation of the final
2466 document.  RefTeX was written by Carsten Dominik and is currently
2467 being maintained by the [[http://www.gnu.org/software/auctex/index.html][AucTeX]] project.
2469 *** Using RefTeX In Org-mode Files for LaTeX Export
2470 In Org-mode files for LaTeX export, the trick is to find a way to tell
2471 RefTeX the locations of external data stores.  One way is to set the
2472 variable, =reftex-default-bibliography=.  Add lines like these to
2473 .emacs:
2475 #+begin_src emacs-lisp 
2476   (setq reftex-default-bibliography
2477         (quote
2478          ("default.bib" "other-default.bib")))       
2479 #+end_src
2481 In practice, this is a limited solution and the
2482 typical user will want to pass this information on a per-file basis.
2483 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
2484 Braindump]].  
2486 The first solution, proposed by Mario, enables the RefTeX citation
2487 function in Org-mode.  Add these lines to .emacs:
2489 #+begin_src emacs-lisp
2490   (defun org-mode-reftex-setup ()
2491     (load-library "reftex")
2492     (and (buffer-file-name)
2493          (file-exists-p (buffer-file-name))
2494          (reftex-parse-all))
2495     (define-key org-mode-map (kbd "C-c )") 'reftex-citation))
2496   (add-hook 'org-mode-hook 'org-mode-reftex-setup)
2497 #+end_src
2499 Then add the following lines anywhere in the Org-mode file (Org-mode
2500 will recognize them as LaTeX commands):
2502 #+begin_src org
2503 \bibliographystyle{plain}
2504 \bibliography{BIB-NAME}
2505 #+end_src
2507 With this setup, =C-c )= will invoke =reftex-citation= which will
2508 insert a reference in the usual way:
2510 #+begin_src org
2511   ,* test reftex
2512   
2513   ,This is a citation \cite{tierney90}.
2514   
2515   ,\bibliographystyle{plain}
2516   ,\bibliography{tsd}
2517 #+end_src
2519 This Org-mode file will export the following LaTeX output:
2521 #+begin_src latex :exports code
2522   % Created 2010-03-22 Mon 14:34
2523   \documentclass[11pt,letter]{article}
2524   \usepackage[utf8]{inputenc}
2525   \usepackage[T1]{fontenc}
2526   \usepackage{hyperref}
2527   
2528   \title{test.org}
2529   \author{Tom Dye}
2530   \date{2010-03-22 Mon}
2531   
2532   \begin{document}
2533   
2534   \maketitle
2535   
2536   \setcounter{tocdepth}{3}
2537   \tableofcontents
2538   \vspace*{1cm}
2539   
2540   \section{test reftex}
2541   \label{sec-1}
2542   
2543   
2544   This is a citation \cite{tierney90}.
2545   
2546   \bibliographystyle{plain}
2547   \bibliography{tsd}
2548   
2549   \end{document}
2550 #+end_src
2553 A second solution, to activate the RefTeX minor mode on a per-file
2554 basis, was posted by Kevin Brubeck Unhammer in response to this idea.
2555 Add the following lines to .emacs:
2557 #+begin_src emacs-lisp
2558   (add-hook ‘org-mode-hook
2559              (lambda ()
2560                (if (member “WRITE” org-todo-keywords-1)
2561                    (org-mode-article-modes))))
2562 #+end_src
2564 where =org-mode-article-modes= is defined as follows:
2566 #+begin_src emacs-lisp
2567   (defun org-mode-article-modes ()
2568     (reftex-mode t)
2569     (bib-cite-minor-mode t)
2570     (and (buffer-file-name)
2571          (file-exists-p (buffer-file-name))
2572          (reftex-parse-all)))
2573 #+end_src
2575 Add the =\bibliographystyle{}= and =\bibliography{}= lines to the
2576 Org-mode file as before and define a TODO keyword, =WRITE=, perhaps
2577 like this:
2579 #+begin_src org
2580   ,#+TODO: TODO(t) STARTED(s) WRITE | DONE(d) DEFERRED(f)
2581 #+end_src
2583 With this setup, you insert a citation with =M-x reftex-citation RET=.
2585 *** Using RefTeX in Org-babel LaTeX Code Blocks
2587 In Org-babel LaTeX code blocks, the trick is to give RefTeX access to
2588 information in other Org-babel LaTeX code blocks.  If you use an Emacs
2589 starter kit where configuration information is held in Org-mode files,
2590 then the second solution is preferable because you won't be asked for
2591 a master file when Emacs is started.  For this reason, the second
2592 solution is modified for use with Org-babel latex code blocks.  No
2593 key-binding is needed here because Org-babel code blocks are edited
2594 within the usual AucTeX environment.
2596 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]])
2597 #+begin_src emacs-lisp
2598   (defun org-mode-article-modes ()
2599     (reftex-mode t)
2600     (and (buffer-file-name)
2601          (file-exists-p (buffer-file-name))
2602          (reftex-parse-all)))
2603   
2604   (add-hook 'org-mode-hook
2605             (lambda ()
2606               (if (member "REFTEX" org-todo-keywords-1)
2607                   (org-mode-article-modes))))
2608 #+end_src
2610 Then add a line like the following line to the top of your org-mode file:
2612 #+begin_src org
2613   ,#+TODO: TODO(t) STARTED(s) | DONE(d) DEFERRED(f) REFTEX
2614 #+end_src
2616 When you open an org-mode file with a line like this, RefTeX will
2617 prompt for the master .tex file, which will be parsed in the usual
2618 way.  This means that the .tex file should already exist, perhaps by
2619 tangling the LaTeX preamble and postamble, before
2620 =org-mode-article-modes= is activated for the Org-mode file.
2622 * MobileOrg
2624 ** Which versions of MobileOrg do exist
2625    :PROPERTIES:
2626    :CUSTOM_ID: mobileorg_versions
2627    :END:
2629 - MobileOrg for the iPhone/iPod Touch/iPad series of devices, by
2630   Richard Moreland.  Check out
2631   [[http://mobileorg.ncogni.to/][Richard's page]]
2632 - Matt Jones is developing a feature-equivalent application for
2633   Android, see
2634   [[http://wiki.github.com/matburt/mobileorg-android/][his project page]].
2636 ** What can I do if I don't want to use Dropbox.com
2637    :PROPERTIES:
2638    :CUSTOM_ID: mobileorg_webdav
2639    :END:
2641 Dropbox.com is the easiest way to connect between Emacs and MobileOrg,
2642 you can get a free account there.  If for some reason you cannot or do
2643 not want to use this path, you can use any webdav server.  On this
2644 webdav server you need to create a dedicated directory for the
2645 communication between Emacs and MobileOrg.  If you can mount that
2646 directory locally so that Emacs can directly write to it, just point
2647 to that directory using the variable =org-mobile-directory=.  Using
2648 the /tramp/ method, =org-mobile-directory= may point to a remote
2649 directory accessible through, for example, /ssh/ and /scp/:
2651 #+begin_src emacs-lisp
2652 (setq org-mobile-directory "/scpc:user@@remote.host:org/webdav/")
2653 #+end_src
2655 If Emacs cannot access the WebDAV directory directly using a /tramp/
2656 method, you can use a local directory for staging.  Other means must
2657 then be used to keep this directory in sync with the WebDAV directory.
2658 In the following example, files are staged in =~/stage/=, and Org-mode
2659 hooks take care of moving files to and from the WebDAV directory using
2660 /scp/.
2662 #+begin_src emacs-lisp
2663 (setq org-mobile-directory "~/stage/")
2664 (add-hook 'org-mobile-post-push-hook
2665   (lambda () (shell-command "scp -r ~/stage/* user@@wdhost:mobile/")))
2666 (add-hook 'org-mobile-pre-pull-hook
2667   (lambda () (shell-command "scp user@@wdhost:mobile/mobileorg.org ~/stage/ ")))
2668 (add-hook 'org-mobile-post-pull-hook
2669   (lambda () (shell-command "scp ~/stage/mobileorg.org user@@wdhost:mobile/")))
2670 #+end_src
2672 * COMMENT HTML style specifications
2674 #+begin_src emacs-lisp
2675   (defun org-faq-make-target ()
2676     "Make hard target for current headline."
2677     (interactive)
2678     (if (not (org-on-heading-p))
2679         (error "Not on a headline"))
2680     (let ((h (org-trim (org-get-heading 'no-tags))))
2681       (if (string-match "[ \t]*\\?\\'" h)
2682           (setq h (replace-match "" t t h)))
2683       (while (string-match "[ \t]+" h)
2684         (setq h (replace-match "-" t t h)))
2685       (org-entry-put nil "CUSTOM_ID" h)))
2686 #+end_src