Fix for links in lists.
[Worg.git] / org-faq.org
blob42ebff078407ee2e1535897288d859dd7e8e7a5e
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:info 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 [[file:index.org][{Back to Worg's index}]]
12 * Welcome
13   :PROPERTIES:
14   :CUSTOM_ID: Welcome
15   :END:
16   
17 Welcome to the Org-mode FAQ. 
19 You can navigate the FAQ by clicking on any of the topics in the Table
20 of Contents.
22 If your browser supports JavaScript, you can...
24 - move through the topics by typing "=n=" (next) and "=p=" (previous).
26 - see an outline view of the FAQ by typing "=m=" or clicking "=toggle
27   view=" (above).
29 - search the FAQ by typing "=s=" (basic search) or "=o=" (occur tree).
31 - see a full list of navigation commands by typing "=?=" or clicking
32   "=Help=" (above).
33   
34 * What is org-mode?
35   :PROPERTIES:
36   :CUSTOM_ID: What-is-org-mode
37   :END:
38 ** Can I implement a GTD workflow with Org-mode?
39    :PROPERTIES:
40    :CUSTOM_ID: GTD-workflow-with-Org-mode
41    :END:
43    Yes, you can.  Check for discussions and pointers [[http://orgmode.org/worg/org-gtd-etc.php][here]].
45 ** What is the difference between Org and TaskPaper?
46    :PROPERTIES:
47    :CUSTOM_ID: Org-and-TaskPaper
48    :END:
50   There is really no difference.  Org is as /simple/ as [[http://hogbaysoftware.com/products/taskpaper][TaskPaper]].  It
51   is just that, when using Org within Emacs, it lets you do many things
52   that you wouldn't be able to do with TaskPaper.  Yes, TaskPaper is
53   fiddle-proof and people using Emacs tends to like fiddling (which is
54   orthogonal to the idea of using todo-list efficiently), but this is
55   just a matter of discipline and common sense, not one of Org's design.
57   Read [[http://article.gmane.org/gmane.emacs.orgmode/6224][Carsten's enlightening statement]] on this.
58 ** What is the meaning of the Unicorn on Org's website?
59    :PROPERTIES:
60    :CUSTOM_ID: unicorn
61    :END:
63 The Unicorn is the logo of Org-mode because:
65 - Org-mode is the UNICs of ORgaNizers.
67 - Org-mode is an Emacs mode, so it makes sense to use an animal
68   similar or related to the gnu used for GNU Emacs.
70 - Org-mode is meant to show you the way, and an animal with two horns
71   can not do this very well, can it?
73 - Unicorn tears are said to reverse petrification, and wasn't this how
74   we all felt before getting to some degree of time and task
75   management?
77 - It will take forever to learn everything there is to know about a
78   unicorn.
80 - A unicorn is a fabulous creature.  Org-mode wants to be a fabulous
81   creation.
83 Using a unicorn was originally /Bastien Guerry's/ idea, his friend
84 /Christophe Bataillon/ designed the logo for us, and /Greg Newman/
85 gave it a refresh some time later.  Bastien writes why he chose a
86 unicorn:
88 #+BEGIN_QUOTE
89 The first reason is not linked to the animal, but to the sounding of the
90 word "Unicorn" - because Org gives you a /uni/que way of producing files
91 in several format (HTML, LaTeX, etc.)
93 The second reason is that a Unicorn doesn't really exist, it is just
94 something you can dream about, and make others believe it does exist.
95 Just like the perfect organizer.
96 #+END_QUOTE
98 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
99 Suckling]] posted a link showing how to make a simple foldable unicorn
100 (very appropriate for an outlining program!).
102 [[http://article.gmane.org/gmane.emacs.orgmode/11735][Tim Burt]] made a very compilcated one which is now a treasured
103 possession of the Org-mode author.
105 - Official logo: [[http://orgmode.org/img/nrocinu2.jpg]]
107 - An [[http://orgmode.org/img/nrocinu4.jpg][alternative version]] from Christophe Bataillon (c):
109 - [[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]]:
111 - [[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
112   threshold technique".
114 - [[http://article.gmane.org/gmane.emacs.orgmode/11735/match%3D][Tim Burt]] made a folded Unicorn to match the spirit of Org - see the
115   whole set of pictures [[http://www.flickr.com/photos/tcburt/sets/72157614543357071/][on his flickr page]].
117 - Are unicorns real?  Answer [[http://article.gmane.org/gmane.emacs.orgmode/11687/match%3Drosslaird%2Bunicorn][here]] by Ross Laird.
119 * Keeping current
120   :PROPERTIES:
121   :CUSTOM_ID: Keeping-current
122   :END:
123 ** How do I keep current with Org mode development?
124    :PROPERTIES:
125    :CUSTOM_ID: keeping-current-with-Org-mode-development
126    :END:
128    Org mode is developed in [[http://en.wikipedia.org/wiki/Git_(software)][Git]].  You can keep up-to-date with Org
129    mode developement by cloning Org mode repository and refreshing
130    your copy with latest changes whenever you wish.  You only need to
131    use two Git commands (clone and pull.)  Here are the steps in
132    brief (please customize locations to suit your setup):
134    1. Select a location to house the Org mode repository (approx. 40
135       MB; includes documentation, compiled elisp files and history
136       going all the way back to v4.12a)
138       : $ mkdir $HOME/elisp && cd $HOME/elisp
140    2. Clone the Org mode Git repository.
142       Recommended approach:
144       : $ git clone git://repo.or.cz/org-mode.git
146       Alternate approach if you are behind a firewall that allows only
147       HTTP (can be quite slow):
149       : $ git clone http://repo.or.cz/r/org-mode.git
151    3. Compile and install Org mode and build documentation.
153       : $ cd org-mode && make && make doc && make install
155       Please note that you can choose to /not/ compile at all and run
156       using source =.el= files only.  Compiled files speed things up.
158    4. This is where you configure Org mode with Emacs.  Please refer
159       to [[./org-tutorials/index.org][Org tutorials]].
161    5. Keeping up-to-date.
163       Cloning the repository is a one time activity.  From this point
164       onwards you only need to /pull/ the latest changes.
166       : $ cd $HOME/elisp/org-mode
168       and then
170       : $ git pull && make clean && make && make doc && make install
172    6. You should restart org mode to have the changes take effect (if
173       you are not rebooting Emacs.)  Also since the intention is to
174       "keep up" with Org mode, you should visit ChangeLog and updated
175       sections of documentation for latest updates (use =git log=.)
177    7. As you use your repository over time it will accumulate loose objects.
178       You can reduce the total size of your git repository with
180       : $ git gc
182       which will consolidate loose git objects into pack files.  This
183       reduces the size of the repository and speeds up data access to
184       the objects.
186 ** How can I keep local changes and still track Org mode development?
187    :PROPERTIES:
188    :CUSTOM_ID: keeping-local-changes-current-with-Org-mode-development
189    :END:
191   Say you want to make minor changes to the Makefile to reflect your
192   location for =emacs=.
194   Create a local branch for your changes on top of origin/master as
195   follows:
197   : $ git checkout -b local origin/master
198   : $ git config branch.local.rebase true
199   : # Make your changes to the Makefile and create a new commit
200   : $ git add Makefile
201   : $ git commit -m 'My local Makefile configurations'
202   : # Update git to a newer version
203   : $ git pull
205   Now each time you pull new commits from the distribution repository
206   your local commits will be rewound and replayed on top of the new
207   origin/master.
209 -----------
211   You would normally work on your =local= branch which includes your
212   custom commits; there's no need to switch back to the =master=
213   branch.
215 -----------
217 Here is an example of dealing with conflict resolution during git pull.
219 If you get a conflict during a =git pull= you will need to edit the
220 file with the conflict to fix up the conflicting lines and then tell
221 git that you have resolved the conflict.
223 Conflict resolution goes something like this:
225 1. =git pull= fails with a conflict
226 2. edit the file
227 3. =git add= the file to mark the conflict resolved
228 4. =git rebase --continue=
229 5. lather, rinse, and repeat 2-4 as needed
231 For this example we have the following Makefile:
233 : #
234 : # Example Makefile
235 : #
237 : EMACS=emacs
239 : VERSION=V1.0
241 and we need to change the =EMACS=emacs= line to =EMACS=myemacs= to
242 make it work well on our system.
244 To do this we
246   - create a local branch for our work
248     : $ git checkout -b local origin/master
249     : $ git config branch.local.rebase true
251     This marks the branch so that all local commits on it are rebased
252     on top of any new commits we get in origin/master during a =git
253     pull= operation.
255   - Make our custom changes
257     Edit the makefile so it looks like this:
259     : #
260     : # Example Makefile
261     : #
262     : 
263     : EMACS=myemacs
264     : 
265     : VERSION=V1.0
267   - Create a commit with our custom changes
268     : $ git add Makefile
269     : $ git commit -m 'My local Makefile configurations'
271   - Later we do a =git pull= but that fails with conflicts.
273     : $ git pull
274     : remote: Counting objects: 5, done.
275     : ...
276     : Patch failed at 0001.
277     : 
278     : When you have resolved this problem run "git rebase --continue".
279     : If you would prefer to skip this patch, instead run "git rebase --skip".
280     : To restore the original branch and stop rebasing run "git rebase --abort".
282   - Fix the conflict in your favourite editor
284     Conflict markers look like this:
286     : <<<<<<< HEAD:Makefile
287     : EMACS=emacs22
288     : =======
289     : EMACS=myemacs
290     : >>>>>>> Change emacs location:Makefile
292     This attempted =git pull= caused a conflict.  Fire up your
293     favourite editor and fix the conflict in the Makefile.  The
294     conflict markers are <<<<<<<<<< , ======= , and >>>>>>>>>>.  Fix
295     the Makefile appropriately and delete the conflict markers.  You
296     already edited these lines earlier so fixing it should be trivial.
298     In this case we changed =EMACS=emacs= to =EMACS=myemacs= and
299     upstream changed =EMACS=emacs= to =EMACS=emacs22=.  Just fix the
300     file and save it by deleting the conflict markers and keeping the
301     code you need (in this case the =EMACS=myemacs= line which we
302     originally modified.)
304   - Mark the file's conflict resolved
306     : $ git add Makefile
308     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.
310   - Continue the rebase operation
312     : $ git rebase --continue
314     If any other conflicts arise you fix them the same way - edit the file, mark the conflict resolved, and continue.
316 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" 
317 using
318 : $ git rebase --abort
320 * Setup
321   :PROPERTIES:
322   :CUSTOM_ID: Setup
323   :END:
325 ** How can I quickly browse all Org options?
327 =M-x org-customize RET=
329 See also [[file:org-tutorials/org-customize.org][Carsten's Org customize tutorial]] and [[file:org-configs/org-customization-guide.org][this customization guide]]
330 for details.
332 ** Can I use the editing features of org-mode in other modes?
333    :PROPERTIES:
334    :CUSTOM_ID: use-editing-features-in-other-modes
335    :END:
337    Not really---but there are a few editing features you can use in
338    other modes.
340    - For tables there is =orgtbl-mode= which implements the table
341      editor as a minor mode. (To enable, type =M-x orgtbl-mode=)
342    - For ordered lists there is =orgstuct-mode= which allows for easy
343      list editing as a minor mode. (To enable, type =M-x
344      orgstruct-mode=)
345    
346    You can activate these modes automatically by using hooks:
348    : (add-hook 'mail-mode-hook 'turn-on-orgtbl)
349    : (add-hook 'mail-mode-hook 'turn-on-orgstruct)
350    
351    For footnotes, there is the function =org-footnote-action=, which
352    works in non-org buffers. This function is a powerful tool for
353    creating and sorting footnotes. To use it globally, you can add the
354    following keybinding to your =.emacs= file (requires Org 6.17 or
355    greater):
356    
357    : (global-set-key (kbd "C-c f") 'org-footnote-action)
358    
359    For other features you need to switch to Org-mode temporarily, or
360    prepare text in a different buffer.
362 ** Why isn't feature "X" working the way it is described in the manual?
363    :PROPERTIES:
364    :CUSTOM_ID: making-sure-org-mode-is-up-to-date
365    :END:
367 Org-mode develops very quickly. There have been a great many changes,
368 for instance, since the release of Emacs 22, which shipped with
369 version 4.67d of org-mode. (Emacs 23 is expected to ship with version
370 6.21b.)
372 Many of the users on the org-mode mailing list are using either a
373 recent release of org-mode or the
374 [[http://orgmode.org/index.html#sec-3.2][development version of
375 org-mode from the git repository]].
377 If some settings and features aren't working the way you expect, make
378 sure that the version of the manual you are consulting matches the
379 version of org-mode you are using.
381    - You can check which version of org-mode you are using by
382      selection =Org --> Documentation --> Show Version= in the Emacs
383      menu.
385    - The [[http://orgmode.org/manual/index.html][online manual]] at [[http://orgmode.org][orgmode.org]] corresponds to the most recent
386      release.
388    - 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
389      released with the latest official Gnu Emacs release (Emacs 22 and
390      org-mode 4.67d as of February 2009). Note: compared with the
391      manual at the orgmode.org, the manual at www.gnu.org is
392      considerably out of date.
394 For instructions on how to stay current with org-mode, consult [[keeping-current-with-Org-mode-development][this
395 FAQ]] or follow the instructions on [[http://orgmode.org][the official org-mode site]].
397 ** Can I get the visibility-cycling features in outline-mode and outline-minor-mode?
398    :PROPERTIES:
399    :CUSTOM_ID: use-visibility-cycling-in-outline-mode
400    :END:
402    Yes, these functions are written in a way that they are independent of
403    the outline setup.  The following setup provides standard Org-mode
404    functionality in outline-mode on =TAB= and =S-TAB=.  For
405    outline-minor-mode, we use =C-TAB= instead of =TAB=,
406    because =TAB= usually has mode-specific tasks.
408 #+BEGIN_SRC emacs-lisp
409 (add-hook 'outline-minor-mode-hook
410   (lambda ()
411     (define-key outline-minor-mode-map [(control tab)] 'org-cycle)
412     (define-key outline-minor-mode-map [(shift tab)] 'org-global-cycle)))
413 (add-hook 'outline-mode-hook
414   (lambda ()
415     (define-key outline-mode-map [(tab)] 'org-cycle)
416     (define-key outline-mode-map [(shift tab)] 'org-global-cycle)))
417 #+END_SRC
419 Or check out /outline-magic.el/, which does this and also provides
420 promotion and demotion functionality.  /outline-magic.el/ is
421 available at [[http://www.astro.uva.nl/~dominik/Tools/outline-magic.el][Outline Magic]].
423 ** How can I keep track of changes in my Org files?
424    :PROPERTIES:
425    :CUSTOM_ID: track-of-changes-in-Org-files
426    :END:
428   Use git to track the history of the files, use a cronjob to check in
429   changes regularly.  Such a setup is described by Bernt Hansen
430   in [[http://article.gmane.org/gmane.emacs.orgmode/6233][this message]] on [[http://dir.gmane.org/gmane.emacs.orgmode][emacs-orgmode]].
432 ** Can I use Org-mode as the default mode for all README files?
433    :PROPERTIES:
434    :CUSTOM_ID: Org-mode-as-default-mode
435    :END:
437 Add the following to your .emacs file:
439 : (add-to-list 'auto-mode-alist '("README$" . org-mode))
441 You can even make it the default mode for any files with unspecified
442 mode using
444 : (setq default-major-mode 'org-mode)
446 ** Can I use ido.el for completing stuff in Org?
447    :PROPERTIES:
448    :CUSTOM_ID: ido-complete
449    :END:
451    Yes, you can.  If you are an ido user and ido-mode is active, the
452    following setting will make Org use =ido-completing-read= for most
453    of its completing prompts.
455 : (setq org-completion-use-ido t)
457 ** Should I use one big org file or multiple files?
458    :PROPERTIES:
459    :CUSTOM_ID: how-to-organize-org-mode-files
460    :END:
462 Org-mode is flexible enough to accomodate a variety of organizational
463 and time management schemes. Org's
464 [[http://orgmode.org/manual/Document-Structure.html#Document-Structure][outline
465 cycling and convenient editing and navigation commands]] make it
466 possible to maintain all of your projects and notes in a single file.
467 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
468 notes and todos]], also make it a delight to maintain a private "wiki"
469 consisting of multiple files.
471 No matter how you organize your org files, org-mode's agenda commands
472 make it easy to search all your notes and gather together crucial data
473 in a single view.
475 Moreover, several org-mode settings can be configured either globally
476 in your =.emacs= file or locally (per file or per outline tree). See
477 the [[http://orgmode.org/manual/index.html#Top][manual]] for more details. For an example of local customizations
478 see [[limit-agenda-with-category-match][this FAQ]].
480 Here are a few ideas for organizing org-mode files:
482 - A single file for all your projects and notes.
483 - One file per project.
484 - One file per client.
485 - One file per area of responsibility or type of work (e.g.,
486   household, health, work, etc.).
487 - One file for projects, one for appointments, one for reference
488   material, one for someday/maybe items, etc.
489 - A wiki of hyperlinked files that grows and adapts to meet your
490   needs.
491   
492 For more ideas, see some of the links on the [[file:org-tutorials/index.org][org-tutorial index]] or
493 [[file:org-gtd-etc.org][this page on org-mode and GTD]].
495 ** Why doesn't C-c a call the agenda? Why don't some org keybindings work?
496    :PROPERTIES:
497    :CUSTOM_ID: setting-global-keybindings
498    :END:
500 Org-mode has a few global keybindings that the user must set
501 explicitly in an =.emacs= file. These keybindings include the
502 customary shortcut for calling the agenda (=C-c a=). If nothing
503 happens when you type =C-c a=, then make sure that the following lines
504 are in your =.emacs= file:
506 #+BEGIN_SRC emacs-lisp
507 ;; The following lines are always needed.  Choose your own keys.
508 (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
509 (global-set-key "\C-cl" 'org-store-link)
510 (global-set-key "\C-ca" 'org-agenda)
511 (global-set-key "\C-cb" 'org-iswitchb)
512 #+END_SRC emacs-lisp
514 You may, of course, choose whatever keybindings work best for you
515 and do not conflict with other modes.
517 Please see [[http://orgmode.org/manual/Activation.html][this section of the manual]] if you have additional
518 questions.
520 ** Why aren't some of the variables I've customized having an effect?
521    :PROPERTIES:
522    :CUSTOM_ID: load-org-after-setting-variables
523    :END:
525 Some org variables have to be set before org.el is loaded or else they
526 will not work. (An example is the new variable
527 =org-enforce-todo-dependencies=.)
529 To make sure all your variables work you should not use =(require
530 'org)=. Instead use the following setting:
532 : (require 'org-install)
534 You should also make sure that you do not require any other =org-...=
535 files in your =.emacs= file before you have set your org variables,
536 since these will also cause org.el to be loaded. To be safe, load org
537 files *after* you have set your variables.
539 * Errors
540   :PROPERTIES:
541   :CUSTOM_ID: Errors
542   :END:
543 ** When I try to use Org-mode, I always get the error message =(wrong-type-argument keymapp nil)=
544    :PROPERTIES:
545    :CUSTOM_ID: wrong-type-argument-keymapp
546    :END:
548    This is a conflict with an outdated version of the /allout.el/, see
549    the [[http://orgmode.org/manual/Conflicts.html#Conflicts][Conflicts]] section in the manual
551 ** Org-mode takes over the TAB key.  I also want to use YASnippet, is there a way to fix this conflict?
552    :PROPERTIES:
553    :CUSTOM_ID: YASnippet
554    :END:
556 The way Org-mode binds the =TAB= key (binding to =[tab]= instead of
557 =\t=) overrules yasnippets' access to this key.  The following code
558 fixes this problem:
560 #+begin_src emacs-lisp
561 (add-hook 'org-mode-hook
562           (lambda ()
563             (org-set-local 'yas/trigger-key [tab])
564             (define-key yas/keymap [tab] 'yas/next-field-group)))
565 #+end_src
567 Rick Moynihan maintains a [[http://github.com/RickMoynihan/yasnippet-org-mode][git repository]] with YASnippets for Org-mode.
569 ** Org-mode takes over the S-cursor keys.  I also want to use CUA-mode, is there a way to fix this conflict?
570    :PROPERTIES:
571    :CUSTOM_ID: CUA-mode
572    :END:
574 Yes, see the  [[http://orgmode.org/manual/Conflicts.html#Conflicts][Conflicts]] section of the manual.
576 ** Org-mode takes over the S-cursor keys.  I also want to use windmove.el, is there a way to fix this conflict?
577    :PROPERTIES:
578    :CUSTOM_ID: windmove.el
579    :END:
581 Yes, see the [[http://orgmode.org/manual/Conflicts.html#Conflicts][Conflicts]] section of the manual.
583 ** Org behaves strangely: some keys don't work, some features are missing, my settings have no effect, ...
584    :PROPERTIES:
585    :CUSTOM_ID: loaded-old-org
586    :END:
588 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=.
590 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.
592 You should add your directories to the =load-path= at the beginning:
594 :  (add-to-list 'load-path "~/.emacs.d/org-mode/lisp") (require 'org-install)
596 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)=.
598 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.
600 ** Why doesn't org-batch-agenda work under Win32?
601    :PROPERTIES:
602    :CUSTOM_ID: org-batch-agenda-under-win32
603    :END:
605 When I run the example batch files to print my agenda to the console
606 under Win32 I get the failure:
608 : End of file during parsing
610 and no agenda is printed.
612 The problem is the use of single quotes surrounding the eval in the
613 emacs command-line. This gets confused under Win32. All string
614 parameters with spaces must be surrounded in double quotes. This means
615 that double quotes being passed to the eval must be escaped.
617 Therefore, instead of the following:
619 : <path to emacs>\emacs.exe -batch -l ~/_emacs_org \
620 :     -eval '(org-batch-agenda "a")'
622 you need to use the following:
624 :  <path to emacs>\emacs.exe -batch -l ~/_emacs_org \
625 :     -eval "(org-batch-agenda \"a\")"
627 (all on one line, of course).
629 * Outline
630   :PROPERTIES:
631   :CUSTOM_ID: Outline
632   :END:
633 ** Can I have two windows on the same Org-mode file, with different outline visibilities?
634    :PROPERTIES:
635    :CUSTOM_ID: indirect-buffers
636    :END:
638    You may use /indirect buffers/ which do exactly this.  See the
639    documentation on the command =make-indirect-buffer=.
640    
641    Org-mode has built-in commands that allow you create an indirect
642    buffer from a subtree of an outline. To open a subtree in new
643    window, type =C-c C-x b=. Any changes you make in the new window
644    will be saved to the original file, but the visibility of both
645    buffers will remain independent of one another.
647    For multiple indirect buffers from the same file, you must use the
648    prefix =C-u= when creating the second (or third) buffer. Otherwise
649    the new indirect buffer will replace the old.
651    You can also create an independent view of an outline subtree by
652    typing =b= on an item in the agenda.
654 ** Emacs outlines are unreadable.  Can I get rid of all those stars?
655    :PROPERTIES:
656    :CUSTOM_ID: Emacs-outlines-are-unreadable
657    :END:
659    See the section [[http://orgmode.org/manual/Clean-view.html#Clean-view][Clean outline view]] in the manual.
660 ** C-k is killing whole subtrees!  I lost my work!
661    :PROPERTIES:
662    :CUSTOM_ID: C-k-is-killing-subtrees
663    :END:
665   =(setq org-special-ctrl-k t)= before losing your work.
667 ** Why aren't commands working on regions?
668    :PROPERTIES:
669    :CUSTOM_ID: transient-mark-mode
670    :END:
672 Some org-mode commands, such as M-right and M-left for demoting or
673 promoting headlines (see [[demote-multiple-headlines][this FAQ]]), can be applied to entire regions.
674 These commands, however, will only work on active regions set with
675 [[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
676 Emacs 23. To enable it in earlier versions of emacs, put the following
677 in your =.emacs= file:
679 : (transient-mark-mode 1)
681 Alternatively, you may turn off transient mark mode and use [[http://www.gnu.org/software/emacs/manual/html_node/emacs/Momentary-Mark.html][a
682 momentary mark]] (=C-<SPC> C-<SPC>=).
683    
684 ** Why is a blank line inserted after headlines and list items?
685    :PROPERTIES:
686    :ID:       2463F4D8-F686-4CF3-AA07-08976F8A4972
687    :END:
688    :PROPERTIES:
689    :CUSTOM_ID: blank-line-after-headlines-and-list-items
690    :END:
692 In org-mode, typing =M-RET= at the end of a headline will create a new
693 headline of the same level on a new line. The same is true for plain
694 lists. By default org-mode uses context to determine if a blank line
695 should be inserted after each headline or plain list item when =M-RET=
696 is pressed. For instance, if a there is a blank line before a
697 headline, then typing =M-RET= at the end of the line will insert a
698 blank line before the new headline. For instance, hitting =M-RET=
699 at the end of "Headline Two" below inserts a new headline without a
700 blank line:
702 : ** Headline One
703 : ** Headline Two
704 : ** 
706 If there is a blank line between Headline One and Headline Two,
707 however, the results will be as follows:
709 : ** Headline One
711 : ** Headline Two
713 : ** 
715 If you do not like the default behavior you can change it with the
716 variable =org-blank-before-new-entry=. You can set headings and/or
717 plain lists to auto (the default setting), t (always), or nil (never).
719 ** How can I promote or demote multiple headlines at once? 
720    :PROPERTIES:
721    :CUSTOM_ID: demote-multiple-headlines
722    :END:
723    
724 If you have a long list of first level headlines that you'd like to
725 demote to second level headlines, you can select the headlines as a
726 region and then hit =M-<right>= to demote all the headlines at once.
728 Note: =M-S-<right>= will not work on a selected region. Its use is to
729 demote a single subtree (i.e., a headline and all sub-headlines).
731 If M-<right> doesn't seem to work, make sure transient mark mode is
732 enabled. See [[transient-mark-mode][this FAQ]].
733   
734 * Todos and Tags
735   :PROPERTIES:
736   :CUSTOM_ID: Todos-and-Tags
737   :END:
738 ** How can I cycle through the TODO keyword of an entry?
739    :PROPERTIES:
740    :CUSTOM_ID: cycle-TODO-keywords
741    :END:
743   =C-c C-t= or =S-<left/right>= is what you need.
745 ** How do I track state changes for tasks in Org?
746    :PROPERTIES:
747    :CUSTOM_ID: track-state-changes-for-tasks
748    :END:
749    
750   Take a look at the [[http://thread.gmane.org/gmane.emacs.orgmode/6082][post by Bernt Hansen]] for setting up TODO keyword
751   states and logging timestamps for task state changes.
752    
753 ** Can I select the TODO keywords with a tag-like interface?
754    :PROPERTIES:
755    :CUSTOM_ID: select-TODO-keywords-with-tag-like-interface
756    :END:
758   Yes.  Use =(setq org-use-fast-todo-selection t)=
760   If you want to set both your todos and your tags using a single
761   interface, then check out the variable
762   =org-fast-tag-selection-include-todo=.
764   See [[http://orgmode.org/manual/Fast-access-to-TODO-states.html][this section of the manual]] for more details.
765   
766 ** How can I quickly set the tag of an entry?
767    :PROPERTIES:
768    :CUSTOM_ID: quickly-set-tag-of-entry
769    :END:
771    Use =C-c C-c= or =C-c C-q= on the headline. =C-c C-q= is useful for
772    setting tabs in a [[http://orgmode.org/manual/Remember.html#Remember][remember]] buffer, since =C-c C-c= is the default
773    keybinding for filing a note from the remember buffer.
774   
775    You can set tags even more quickly by setting one of the character
776    shortcuts for [[http://orgmode.org/manual/Setting-tags.html#Setting-tags][fast tag selection]].
777    
778    To set tag shortcuts for all org buffers, put something like the
779    following in your =.emacs= file (or create the same settings by
780    typing =M-x customize-variable RET org-tag-alist=):
781    
782 : (setq org-tag-alist '(("computer" . ?c) ("office" . ?o) ("home" . ?h)))
783    
784    To set tag shortcuts for a single buffer, put something like the
785    following at the top of your org file: 
786    
787 : #+TAGS: computer(c) office(o) home(h)
789 ** How can I change the colors of TODO keywords?
791 You can use the variable org-todo-keyword-faces. Here are some sample
792 settings:
794 #+begin_src emacs-lisp
795 (setq org-todo-keyword-faces
796       '(
797         ("TODO"  . (:foreground "firebrick2" :weight bold))
798         ("WAITING"  . (:foreground "olivedrab" :weight bold))
799         ("LATER"  . (:foreground "sienna" :weight bold))
800         ("PROJECT"  . (:foreground "steelblue" :weight bold))
801         ("DONE"  . (:foreground "forestgreen" :weight bold))
802         ("MAYBE"  . (:foreground "dimgrey" :weight bold))
803         ("CANCELED"  . shadow)
804         ))
805 #+end_src
807 If you want to change the color of all active todos or all inactive
808 todos, type:
810 : M-x customize-face RET org-todo
811 : M-x customize-face RET org-done
813 You can also set values for each of these in your =.emacs= file:
815 : (set-face-foreground 'org-todo "firebrick2")
816 : (set-face-foreground 'org-done "forestgreen")
818 * Hyperlinks
819   :PROPERTIES:
820   :CUSTOM_ID: Hyperlinks
821   :END:
822 ** Why do I have to confirm the execution of each shell/elisp link?
823    :PROPERTIES:
824    :CUSTOM_ID: confirm-shell/elisp-link
825    :END:
827    The confirmation is there to protect you from unwantingly execute
828    potentially dangerous commands.  For example, imagine a link
830    : [[shell:rm -rf ~/*][Google Search]]
832    In an Org-mode buffer, this command would look like /Google Search/,
833    but really it would remove your home directory.  If you wish, you can
834    make it easier to respond to the query by setting
836    : (setq org-confirm-shell-link-function 'y-or-n-p
837    :       org-confirm-elisp-link-function 'y-or-n-p).
839    Then a single keypress will be enough to confirm those links.  It is
840    also possible to turn off this check entirely, but I strongly
841    recommend against this.  Be warned.
843 ** Can I use RET or TAB to follow a link?
844    :PROPERTIES:
845    :CUSTOM_ID: RET-or-TAB-to-follow-link
846    :END:
848    Yes, this is how:
850    : (setq org-return-follows-link t)
851    : (setq org-tab-follows-link t)
853 ** Can I keep mouse-1 clicks from following a link?
854    :PROPERTIES:
855    :CUSTOM_ID: mouse-1-following-link
856    :END:
858    Activating links with =mouse-1= is a new feature in Emacs 22, to make
859    link behavior similar to other applications like web browsers.  If
860    you hold the mouse button down a bit longer, the cursor will be set
861    without following the link.  If you cannot get used to this behavior,
862    you can (as in Emacs 21) use =mouse-2= to follow links and turn off
863    link activation for =mouse-1= with
865    : (setq org-mouse-1-follows-link nil)
867 ** How can I get completion of file names when creating a link?
868    :PROPERTIES:
869    :CUSTOM_ID: completion-of-file-links
870    :END:
871    
872 You can use org-insert-link with a prefix argument:
874 : C-u C-c C-l
876 You will be greeted with prompt in the minibuffer that allows for file
877 completion using your preferred Emacs method for finding files.
879 * Plain Lists
880   :PROPERTIES:
881   :CUSTOM_ID: Plain-Lists
882   :END:
883 ** How can I insert an empty line before each newly inserted headline, but not before each newly inserted plain-list item?
884    :PROPERTIES:
885    :CUSTOM_ID: empty-line-before-each-new-headline-but-not-item
886    :END:
888 : (setq org-blank-before-new-entry
889 :       '((heading . t) (plain-list-item . nil))
891 See also [[id:2463F4D8-F686-4CF3-AA07-08976F8A4972][Why is a blank line inserted after headlines and list items?]].
892    
893 ** How can I convert itemized lists to enumerated lists?
894    :PROPERTIES:
895    :CUSTOM_ID: convert-itemized-to-enumerated-lists
896    :END:
897    
898    You can use =C-c -= or =S-<left>/<right>= to cycle through the various
899    bullet headlines available for lists: =-, +, *, 1., 1)=.
900    
901    See [[http://orgmode.org/manual/Plain-lists.html#Plain-lists][this section of the manual]] for more information.
902    
903 ** How can I convert plain lists to headlines and vice versa?
904    :PROPERTIES:
905    :CUSTOM_ID: convert-plain-lists-to-headlines
906    :END:
907   
908    To convert a plain list item or line to a headline, type =C-c *= on
909    the headline. This will make the line a subheading of the current
910    headline.
911     
912    To convert a headline to a plain list item, type =C-c -= while the
913    cursor is on the headline.
914    
915    To convert a headline to an unadorned line of text, type =C-c *= on
916    the headline.
917   
918    You can use query replace to accomplish the same things, as Bernt
919    Hansen explains in [[http://article.gmane.org/gmane.emacs.orgmode/10148][this mailing list post]].
921 ** Is there a good way to create a description list?
922    :PROPERTIES:
923    :CUSTOM_ID: description-lists
924    :END:
926   Yes, these are now built-in:
928 #+BEGIN_EXAMPLE
929 - item1 :: Description of this item 1
930 - item2 :: Description of this item 2
931 - item1 :: Description of this item 3
932       also in multiple lines
933 #+END_EXAMPLE
935 * Tables
936   :PROPERTIES:
937   :CUSTOM_ID: Tables
938   :END:
939 ** Can I plot data from a table?
940    :PROPERTIES:
941    :CUSTOM_ID: plotting-table-data
942    :END:
944    Yes, you can, using org-plot.el written by James TD Smith and now
945    bundled with Org.  See [[http://orgmode.org/manual/Org-Plot.html#Org-Plot][the manual section about this]].
947    See also [[file:org-tutorials/org-plot.org][this excellent tutorial]] by Eric Schulte.
948    
949 ** How can I fill a table column with incremental numbers?
950    :PROPERTIES:
951    :CUSTOM_ID: fill-table-column-with-incremental-numbers
952    :END:
954 Here is how: Use a field formula to set the first value in the column:
956 #+begin_src org
957 ,| N   |   |
958 ,|-----+---|
959 ,| :=1 |   |
960 ,|     |   |
961 ,|     |   |
962 ,|     |   |
963 ,#+TBLFM: @2$1=1
964 #+end_src
966 Then define a column formula in the second field:
968 #+begin_src org
969 ,| N        |   |
970 ,|----------+---|
971 ,| 1        |   |
972 ,| =@-1 + 1 |   |
973 ,|          |   |
974 ,|          |   |
975 ,#+TBLFM: @2$1=1
976 #+end_src
978 After recomputing the table, the column will be filled with
979 incremental numbers:
981 #+begin_src org
982 ,| N |   |
983 ,|---+---|
984 ,| 1 |   |
985 ,| 2 |   |
986 ,| 3 |   |
987 ,| 4 |   |
988 ,#+TBLFM: $1=@-1 + 1::@2$1=1
989 #+end_src
991 Note that you could use arbitrary starting values and column formulas.
993 ** Why does my table column get filled with #ERROR?
994    :PROPERTIES:
995    :CUSTOM_ID: table-column-filled-with-ERROR
996    :END:
998    Org-mode tried to compute the column from other fields using a
999    formula stored in the =#+TBLFM:= line just below the table, and
1000    the evaluation of the formula fails.  Fix the fields used in the
1001    formula, or fix the formula, or remove it!
1003 ** How can I stop the table editor from creating new lines?
1004    :PROPERTIES:
1005    :CUSTOM_ID: table-editor-creates-new-lines
1006    :END:
1008    When I am in the last column of a table and just above a horizontal
1009    line in the table, pressing TAB creates a new table line before the
1010    horizontal line.  To move to the line below the
1011    horizontal line instead, do this:
1013    Press =down= (to get on the separator line) and then =TAB=.
1014    Or configure the variable
1016    : (setq org-table-tab-jumps-over-hlines t)
1018 ** How can I get table fields starting with "="?
1019    :PROPERTIES:
1020    :CUSTOM_ID: table-fields-starting-with-=
1021    :END:
1023    With the setting
1025    : (setq org-table-formula-evaluate-inline nil)
1027    this will no longer happen.  You can still use formulas using the
1028    commands @<tt>C-c =@</tt> and @<tt>C-u C-c =@</tt>
1030 ** How can I change the indentation of an entire table without fixing every line by hand?
1031    :PROPERTIES:
1032    :CUSTOM_ID: change-indentation-entire-table
1033    :END:
1035    The indentation of a table is set by the first line.  So just fix the
1036    indentation of the first line and realign with =TAB=.
1038 ** In my huge table the realigning after each TAB takes too long.  What can I do?
1039    :PROPERTIES:
1040    :CUSTOM_ID: table-realigning-after-TAB-takes-long
1041    :END:
1043    Either split the table into several by inserting an empty line every
1044    100 lines or so.  Or turn off the automatic re-align with
1046    : (setq org-table-automatic-realign nil)
1048    After this the only way to realign a table is to press =C-c C-c=.  It
1049    will no longer happen automatically, removing the corresponding delays
1050    during editing.
1052 ** Recalculation of my table takes too long.  What can I do?
1053    :PROPERTIES:
1054    :CUSTOM_ID: Recalculation-of-my-table-takes-too-long
1055    :END:
1057    Nothing, really.  The spreadsheet in org is mostly done to make
1058    calculations possible, not so much to make them fast.  Since Org-mode
1059    is firmly committed to the ASCII format, nothing is stopping you from
1060    editing the table by hand.  Therefore, there is no internal
1061    representation of the data.  Each time Org-mode starts a computation,
1062    it must scan the table for special lines, find the fields etc.  This
1063    is slow.  Furthermore, Calc is slow compared to hardware
1064    computations.  To make this work with normal editing, recalculation
1065    is not happening automatically, or only for the current line, so that
1066    the long wait for a full table iteration only happens when you ask
1067    for it.
1069    So for really complex tables, moving to a "real" spreadsheet may
1070    still be the best option.
1072    That said, there are some ways to optimize things in Org-mode, and I
1073    have been thinking about moving a bit further down this line.
1074    However, for my applications this has so far not been an issue at
1075    all.  If you have a good case, you could try to convince me.
1077 ** =S-RET= in a table keeps increasing the copied numbers.  How can I stop this?
1078    :PROPERTIES:
1079    :CUSTOM_ID: S-RET-in-a-table-increases-copied-numbers
1080    :END:
1082    Well, it is /supposed/ to be a feature, to make it easy to create a
1083    column with increasing numbers.  If this gets into your way, turn it
1084    off with
1086    : (setq org-org-table-copy-increment nil)
1088 * Remember
1089   :PROPERTIES:
1090   :CUSTOM_ID: Remember
1091   :END:
1092 ** Can I use the remember buffer to clock a customer phone call?
1093    :PROPERTIES:
1094    :CUSTOM_ID: use-remember-buffer-to-clock-phone-call
1095    :END:
1097   Yes, you can.  Take a look at the [[http://thread.gmane.org/gmane.emacs.orgmode/5482][setup described by Bernt Hansen]]
1098   and check out (in the same thread) what Nick Docos had to fix to
1099   make Bernt's set-up work for him.
1100 ** Can I automatically start the clock when opening a remember template?
1101    :PROPERTIES:
1102    :CUSTOM_ID: start-clock-when-opening-remember-template
1103    :END:
1105    Yes, this is possible.  Use the following code and make sure that
1106    after executing it, `my-start-clock-if-needed' is in
1107    `remember-mode-hook' /after/ `org-remember-apply-template'.
1109    : (add-hook 'remember-mode-hook 'my-start-clock-if-needed 'append)
1110    : (defun my-start-clock-if-needed ()
1111    :   (save-excursion
1112    :     (goto-char (point-min))
1113    :     (when (re-search-forward " *CLOCK-IN *" nil t)
1114    :       (replace-match "")
1115    :       (org-clock-in))))
1117    Then, when a template contains the key string CLOCK-IN, the clock
1118    will be started.  Starting with Org-mode version 5.20, the clock will
1119    automatically be stopped when storing the remember buffer.
1121 * Searches
1122   :PROPERTIES:
1123   :CUSTOM_ID: Searches
1124   :END:
1125 ** Isearch does not find string hidden in links.  What can I do?
1126    :PROPERTIES:
1127    :CUSTOM_ID: isearch-in-links
1128    :END:
1130   M-x =visible-mode= will display the full link, making them searchable.
1132 ** How can I reduce the amount of context shown in sparse trees?
1133    :PROPERTIES:
1134    :CUSTOM_ID: context-in-sparse-trees
1135    :END:
1137    Take a look at the following variables:
1139    - =org-show-hierarchy-above=
1140    - =org-show-following-headline=
1141    - =org-show-siblings=
1142    - =org-show-entry-blow=
1144    which give command-dependent control over how much context is shown
1145    by a particular operation.
1147 ** How can I combine the results of two calls to =org-occur=?
1148    :PROPERTIES:
1149    :CUSTOM_ID: two-calls-to-org-occur
1150    :END:
1152    You can construct a regular expression that matches all targets you
1153    want.  Alternatively, use a =C-u= prefix with the second and any
1154    further calls to =org-occur= to keep the current visibility and
1155    highlighting in addition to the new ones.
1157 * Agenda
1158   :PROPERTIES:
1159   :CUSTOM_ID: Agenda
1160   :END:
1161 ** How can I change the advanced warning time for deadlines?
1162 ##<<warning-period-for-deadlines>>
1164 Deadline warnings appear in the daily agenda view a specified number
1165 of days before the deadline is due. The default setting is 14 days.
1166 You can change this with the variable =org-deadline-warning-days=.
1167 (See [[http://orgmode.org/manual/Deadlines-and-scheduling.html#Deadlines-and-scheduling][this section]] of the manual.)
1169 For instance, 
1171 : (setq org-deadline-warning-days 30)
1173 would cause warnings for each deadline to appear 30 days in advance.
1175 Naturally, you might not want warnings for all of your deadlines to
1176 appear so far in advance. Thus, you can change the lead time for
1177 individual items as follows:
1179 : * TODO Get a gift for the party
1180 :   DEADLINE: <2009-01-16 Fri -2d>
1182 The "-2d" above changes the lead time for this deadline warning to two
1183 days in advance. You can also use "w" for weeks and "m" for months.
1184 ** How can I postpone a task until a certain date?
1185    :PROPERTIES:
1186    :CUSTOM_ID: deferring-tasks
1187    :END:
1188    
1189 The easiest way to postpone a task is to schedule it in the future.
1190 For instance, typing =C-c C-s +2w= on a headline will push a task two
1191 weeks into the future, so that it won't show up on the daily agenda
1192 until two weeks from now.
1194 If you'd like to prevent the task from showing up on your global todo
1195 list, you have a couple of options.
1197 1. You can set the variable =org-agenda-todo-ignore-scheduled= to =t=.
1198    This will exclude any scheduled items from your global list of
1199    active todos (=C-c a t=). (The variable
1200    =org-agenda-todo-ignore-with-date= will exclude both scheduled and
1201    deadline items from your todo list).
1202 2. You can remove the todo keyword from the item (C-c C-t <SPC>). The
1203    item will still appear on your agenda two weeks from today, but it
1204    won't show up on your todo lists.
1205 ** Can I send myself an email containing tasks or other agenda info?
1206    :PROPERTIES:
1207    :CUSTOM_ID: email-containing-tasks-or-other-agenda-info
1208    :END:
1210    Yes.  See [[http://article.gmane.org/gmane.emacs.orgmode/6112][this thread]] on the list.
1212 ** How can I limit the agenda view to my "work" tasks?
1213    :PROPERTIES:
1214    :CUSTOM_ID: limit-agenda-with-tag-filtering
1215    :END:
1217    It is often convenient to group org files into separate categories,
1218    such as "home" and "work" (or "personal" and "professional"). One
1219    of the main reasons for such classification is to create agenda
1220    views that are limited by type of work or area of responsibility.
1221    For instance, while at work, one may want to see only professional
1222    tasks; while away from work, one may want to see only personal
1223    tasks.
1225    One way to categorize files and tasks is to use a "#+FILETAGS"
1226    declaration at the top of each file, such as:
1228    : #+FILETAGS: work
1230    As long as org-use-tag-inheritance is turned on, the filetags will
1231    be inherited by all tasks in the file. A file can have multiple
1232    filetags. And, of course, tags can be added to individual headings.
1234    Tasks can be quickly filtered by tag from within the agenda by
1235    typing "/" and the name of the tag. The full key sequence to filter
1236    for work items in an agenda view would be:
1238    : C-c a a / work [or a tag shortcut]
1239    
1240 ** How can I limit the agenda view to a particular category?
1241    :PROPERTIES:
1242    :CUSTOM_ID: limit-agenda-with-category-match
1243    :END:
1244    
1245    Another way to filter agenda views by type of work is to use a
1246    "#+CATEGORY" declaration at the top of each file, such as:
1248    : #+CATEGORY: work
1250    Categories can also be added to individual headings within a file:
1252    : * Big project
1253    :   :PROPERTIES:
1254    :   :CATEGORY: work
1255    :   :END:
1257    All todos belonging to the category "work" can be found a with a
1258    simple tags-todo search:
1260    : C-c a M 
1261    
1262    At the prompt, type:
1263    
1264    : CATEGORY="work"
1266    The same results can be achieved with custom agenda commands, such as:
1268 #+BEGIN_SRC emacs-lisp
1269 (setq org-agenda-custom-commands
1270       '(("h" tags-todo "CATEGORY=\"home\"")
1271         ("w" tags-todo "CATEGORY=\"work\"")
1272         ;; other custom agenda commands here
1273         ))
1274 #+END_SRC 
1276 ** How can include all org files in a directory in my agenda?
1277    :PROPERTIES:
1278    :CUSTOM_ID: set-agenda-files-using-wildcards
1279    :END:
1281 You can use the file-expand-wildcards function to all files ending in
1282 =org= in a directory to your agenda files list:
1284 : (setq org-agenda-files (file-expand-wildcards "~/org/*.org"))
1286 ** Why aren't items disappearing from my agenda once they are marked done?
1287    :PROPERTIES:
1288    :CUSTOM_ID: removing-done-items-from-agenda
1289    :END:
1291 If items remain on your daily/weekly agenda after they are marked
1292 done, check the configuration of the following variables:
1294 : org-agenda-skip-scheduled-if-done
1295 : org-agenda-skip-deadline-if-done
1296 : org-agenda-skip-timestamp-if-done
1298 For instance, type:
1300 : M-x customize-variable RET org-agenda-skip-scheduled-if-done
1302 If this variable is turned off (=nil=), then scheduled items will
1303 remain on the agenda even after they are marked done.
1305 If the variable is turned on (=t=), then scheduled items will
1306 disappear from the agenda after they are marked done.
1308 If these settings seem not to behave the way you expect, then make
1309 sure you understand [[scheduled-vs-deadline-vs-timestamp][the
1310 difference between SCHEDULED, DEADLINE, and timestamps]].
1312 ** What is the difference between SCHEDULED, DEADLINE, and plain timestamps?
1313    :PROPERTIES:
1314    :CUSTOM_ID: scheduled-vs-deadline-vs-timestamp
1315    :END:
1317 1. SCHEDULED items (set with =C-c C-s=) will appear on your agenda on
1318    the day they are scheduled and on every day thereafter until they
1319    are done. Schedule a task if you want to be reminded to do
1320    something beginning on a certain day and until it is done.
1322 : ** TODO Scheduled item
1323 :    SCHEDULED: <2009-03-01 Sun>
1325 2. Items with a DEADLINE timestamp (set with =C-c C-d=) appear on your
1326    agenda in advance of the when they are due and remain on your
1327    agenda until they are done. Add a DEADLINE to an item if you want
1328    to make sure to complete it by a certain date. (The variable
1329    org-deadline-warning-days determines how far in advance items with
1330    deadlines will show up in the agenda. See [[warning-period-for-deadlines][this FAQ]] for more
1331    information.)
1333 : ** TODO Item with a deadline
1334 :    DEADLINE: <2009-01-20 Tue>
1336 3. An active timestamp (set with =C-c .=) will appear on your agenda
1337    only on the day it is scheduled. Use a timestamp for appointments
1338    or any reminders you want to show up only on a particular day.
1340 : ** TODO Item with an active timestamp
1341 : <2009-04-18 Sat>
1343 Note: items with inactive timestamps (set with C-c ! and marked by
1344 square brackets) will not show up in the agenda at all.
1346 ** Can I add files recursively to my list of agenda files?
1347    :PROPERTIES:
1348    :CUSTOM_ID: set-agenda-files-recursively
1349    :END:
1350    
1351 Yes, you can use the library "find-lisp."
1353 : (load-library "find-lisp")
1354 : (setq org-agenda-files (find-lisp-find-files "~/org" "\.org$"))
1356 This will add all files ending in =org= in the directory "~/org"
1357 and all of its subdirectories to your list of agenda files.
1359 See [[http://thread.gmane.org/gmane.emacs.orgmode/8992][this thread]] on the mailing list for more information.
1361 ** Why does an item appearing at the wrong time of day in my agenda?
1362    :PROPERTIES:
1363    :CUSTOM_ID: agenda-wrong-time-of-day
1364    :END:
1366 When preparing the agenda view, org-mode scans each relevant headline
1367 for a time designation. This approach is very nice for adding
1368 free-form timestamps to an item for scheduling. Thus, either of the
1369 following work would work to schedule an item at 10:00am:
1371 #+begin_src org
1372 ,** 10:00am Get dried ice at the magic store
1373 ,   SCHEDULED: <2009-05-27 Wed>
1374 #+end_src
1376 #+begin_src org
1377 ,** Get dried ice at the magic store
1378 ,   SCHEDULED: <2009-05-27 Wed 10:00>
1379 #+end_src
1381 To enable this flexibility, org-mode scans the entire headline for
1382 time of day notation. A potential problem can arise if you use
1383 inactive timestamps in the headline to note when an item was created.
1384 For example,
1386 #+begin_src org
1387 ,** Get dried ice at the magic store [2009-05-26 Tue 12:58]
1388 ,   SCHEDULED: <2009-05-27 Wed>
1389 #+end_src
1391 Org mode would interpret the time in the inactive timestamp as a
1392 time-of-day indicator and the entry would appear in your agenda at
1393 12:58.
1395 If you would like to turn off the time-of-day search, you can
1396 configure the variable =org-agenda-search-headline-for-time= (requires
1397 org-mode >= 6.24).
1399 * Appointments/Diary
1400   :PROPERTIES:
1401   :CUSTOM_ID: Appointments/Diary
1402   :END:
1403 ** Is it possible to include entries from org-mode files into my emacs diary?
1404    :PROPERTIES:
1405    :CUSTOM_ID: include-entries-from-org-mode-files-into-emacs-diary
1406    :END:
1408    Since the org-mode agenda is much more powerful and can contain the
1409    diary, you should think twice before deciding to do this.  If you
1410    insist, however, integrating Org-mode information into the diary is
1411    possible.  You need to turn on /fancy diary display/ by setting in
1412    .emacs:
1414    : (add-hook 'diary-display-hook 'fancy-diary-display)
1416    Then include the following line into your ~/diary file, in
1417    order to get the entries from all files listed in the variable
1418    =org-agenda-files=
1420    : &%%(org-diary)
1422    You may also select specific files with
1424    : &%%(org-diary) ~/path/to/some/org-file.org
1425    : &%%(org-diary) ~/path/to/another/org-file.org
1427    If you now launch the calendar and press @<tt>d@</tt> to display a
1428    diary, the headlines of entries containing a timestamp, date range,
1429    schedule, or deadline referring to the selected date will be listed.
1430    Just like Org-mode's agenda view, the diary for /today/ contains
1431    additional entries for overdue deadlines and scheduled items.  See
1432    also the documentation of the =org-diary= function.  Under XEmacs, it
1433    is not possible to jump back from the diary to the org, this works
1434    only in the agenda buffer.
1435 ** I want to add my Org scheduled/deadlined entries in my diary!
1436    :PROPERTIES:
1437    :CUSTOM_ID: add-Org-scheduled/deadlined-entries-to-diary!
1438    :END:
1440   Put this in your ~/.diary:
1442   : &%%(org-diary :scheduled :timestamp :deadline)
1444 ** How can I set up automatic reminders based on Org information?
1445    :PROPERTIES:
1446    :CUSTOM_ID: automatic-reminders
1447    :END:
1449   See [[http://article.gmane.org/gmane.emacs.orgmode/5271][this post]] by N. Dokos on the list.
1450 ** How can I make =appt= notice my Org appointments?
1451    :PROPERTIES:
1452    :CUSTOM_ID: appt-notice-my-Org-appointments
1453    :END:
1455   : M-x org-agenda-to-appt RET
1457 ** How can I shedule an weekly appointment that lasts only until a certain date?
1458    :PROPERTIES:
1459    :CUSTOM_ID: diary-sexp-in-org-files
1460    :END:
1462 Org-mode's active timestamps work very well for scheduling individual
1463 or recurring appointments, such as:
1465 : * 8:00am Dentist appointment <2009-01-16 Fri>
1467 or 
1469 : * Weekly meeting with boss
1470 :   <2009-01-20 Tue 14:00 +1w>
1472 Sometimes, however, you need to set up more complicated recurring
1473 appointments. Org-mode has built-in support for many of [[http://www.gnu.org/software/emacs/manual/html_node/emacs/Sexp-Diary-Entries.html][the powerful
1474 sexp entries]] that work in [[http://www.gnu.org/software/emacs/manual/html_node/emacs/Diary.html#Diary][Emacs diary]]. Let's say, for instance, that
1475 you teach a class that meets every Monday evening between February 16
1476 and April 20, 2009. The way to enter this an org-mode file is:
1478 : ** Class 7:00pm-9:00pm
1479 : <%%(and (= 1 (calendar-day-of-week date)) (diary-block 2 16 2009 4 20 2009))>
1481 The expression above designates all Mondays (1) that fall between
1482 February 16 and April 20.
1484 For more ideas on how to create such expressions, see [[http://www.emacswiki.org/cgi-bin/wiki/DiaryMode][this page on the
1485 Emacs wiki]].
1487 * Export
1488   :PROPERTIES:
1489   :CUSTOM_ID: Export
1490   :END:
1491 ** Can I get TODO items exported to HTML as lists, rather than as headlines?
1492    :PROPERTIES:
1493    :CUSTOM_ID: export-TODO-items-as-lists
1494    :END:
1496    If you plan to use ASCII or HTML export, make sure things you want to
1497    be exported as item lists are level 4 at least, even if that does
1498    mean there is a level jump.  For example:
1500    : * Todays top priorities
1501    : **** TODO write a letter to xyz
1502    : **** TODO Finish the paper
1503    : **** Pick up kids at the school
1505    Alternatively, if you need a specific value for the heading/item
1506    transition in a particular file, use the =#+OPTIONS= line to
1507    configure the H switch.
1509    : #+OPTIONS:   H:2; ...
1511 ** Can I export only a single subtree?
1512    :PROPERTIES:
1513    :CUSTOM_ID: export-single-subtree
1514    :END:
1516    If you want to export a subtree, mark the subtree as region and then
1517    export.  Marking can be done with =C-c @ C-x C-x=, for example.
1519 ** How can I tell my calendar web application about appointments in my agenda files?
1521 Here is what you need to do:
1523 1. a script that calls Emacs in batch mode and produce a .ics file
1524 2. a script that uploads this .ics file somewhere on the web
1525 3. tell your webapp to fetch this .ics file on the web
1527 Here is the script I use for the first step:
1529 #+begin_src shell-script-mode
1530 #!/bin/bash
1532 /usr/local/bin/emacs --batch --eval \
1533 "(progn (load-file \"~/install/git/org-mode/org.el\") \
1534         (load-file \"~/elisp/config/org-batch-config.el\") \
1535         (setq org-combined-agenda-icalendar-file \"~/org/cal/org.ics\")
1536         (setq org-agenda-files (quote (\"~/org/bzg.org\"))))" \
1537     -f org-export-icalendar-combine-agenda-files
1538 #+end_src
1540 Depending on your configuration, you might change the load sequence.
1542 Here is the script I use for the second step:
1544 #+begin_src shell-script-mode
1545 #!/bin/bash
1546 /usr/bin/rsync -rtv ~/org/org.ics -e ssh me@my_server:/home/me/public_html/
1547 #+end_src
1549 Note: if you want to cron this rsync script, you will need to let
1550 =my_server= to know about your SSH public key.  Check [[http://troy.jdmz.net/rsync/index.html][this page]] as a
1551 starter.
1553 Now you can cron the two scripts above and your webapp will always be
1554 up to date with your Org agendas.
1556 Also see [[http://orgmode.org/org.html#Exporting-Agenda-Views][Exporting agenda views]] from Org manual.
1558 ** How can I get Mac OSX 10.3 iCal to import my Org-exported .ics files?
1559    :PROPERTIES:
1560    :CUSTOM_ID: iCal-import-ics-files-old
1561    :END:
1563    When using iCal under Apple MacOS X Tiger, you can create a new
1564    calendar /OrgMode/ (the default name for the calendar created by =C-c
1565    C-e c=, see the variables =org-icalendar-combined-name= and
1566    =org-combined-agenda-icalendar-file=).  Then set Org-mode to
1567    overwrite the corresponding file /~/Library/Calendars/OrgMode.ics/.
1568    You may even use AppleScript to make iCal re-read the calendar files
1569    each time a new version of /OrgMode.ics/ is produced.  Here is the
1570    setup needed for this:
1572    : (setq org-combined-agenda-icalendar-file
1573    :     "~/Library/Calendars/OrgMode.ics")
1574    : (add-hook 'org-after-save-iCalendar-file-hook
1575    :  (lambda ()
1576    :   (shell-command
1577    :    "osascript -e 'tell application \"iCal\" to reload calendars'")))
1579 ** How can I get Mac OSX 10.4 or later iCal to import my Org-exported .ics files?
1580    :PROPERTIES:
1581    :CUSTOM_ID: iCal-import-ics-files-new
1582    :END:
1584    For Mac OS X 10.4, you need to write the ics file to
1585    =/Library/WebServer/Documents/= and then subscribe iCalendar to
1586    =http: //localhost/orgmode.ics=
1588 ** How can I remove timestamps and todo keywords from my exported file?
1589    :PROPERTIES:
1590    :CUSTOM_ID: export-options-remove-timestamps
1591    :END:
1593 You can place an options line at the top of your org file:
1595 : #+OPTIONS: <:nil todo:nil
1597 There is a whole host of export options you can set with an in-buffer
1598 options or via global variables. See [[http://orgmode.org/manual/Export-options.html#Export-options][this section]] of the manual for a
1599 full list.
1601 ** How can I preserve faces when I export an agenda from the command line?
1602    :PROPERTIES:
1603    :CUSTOM_ID: preserving-faces-during-batch-export
1604    :END:
1605    
1606 Normally, when you export an org file or an agenda view from within
1607 emacs, htmlize will convert your face definitions to direct color css
1608 styles inlined into each =<span>= object, resulting in an HTML output
1609 that preserves the general look of your Org buffers and agenda views.
1611 Let's say you generate an export from the command line, such as the
1612 following:
1614 : emacs -batch -l ~/.emacs -eval '(org-batch-agenda "e")'
1618 : emacs -batch -l ~/.emacs -eval '(org-publish-all)'
1620 In such an instance, the exported HTML will contain only very basic
1621 color styles. The reason is that when Emacs is run in batch mode, it
1622 does not have a display and therefore only rudimentary face
1623 definitions.  If you'd like to use more complex styles, you'll have to
1624 make sure that the export process only assigns classes instead of
1625 direct color values.  This can be done by binding the variable
1626 =org-export-htmlize-output-style= to =css= for the duration of the
1627 export, for example with
1629 : emacs -batch -l ~/.emacs
1630 :   -eval '(let ((org-export-htmlize-generate-css (quote css)))
1631 :            (org-batch-agenda "e"))'
1633 Then you can use a style file to make these classes look any way you
1634 like.  To generate face definitions for a CSS file based on any faces
1635 you are currently using in Emacs, you can use the following command:
1637 : M-x org-export-htmlize-generate-css RET
1639 This will generate a =<style>...</style>= section, the content of
1640 which you can add to your style file.
1642 ** How can I avoid dark color background when exporting agenda to ps format?
1643    :PROPERTIES:
1644    :CUSTOM_ID: avoiding-dark-background-when-exporting-agenda
1645    :END:
1647 Add this to your .emacs and evaluate it.
1649 #+BEGIN_SRC emacs-lisp
1650   (setq org-agenda-exporter-settings
1651         '((ps-print-color-p 'black-white)))
1652 #+END_SRC
1654 * COMMENT HTML style specifications
1656 #+begin_src emacs-lisp
1657 (defun org-faq-make-target ()
1658   "Make hard target for current headline."
1659   (interactive)
1660   (if (not (org-on-heading-p))
1661       (error "Not on a headline"))
1662   (let ((h (org-trim (org-get-heading 'no-tags))))
1663     (if (string-match "[ \t]*\\?\\'" h)
1664         (setq h (replace-match "" t t h)))
1665     (while (string-match "[ \t]+" h)
1666       (setq h (replace-match "-" t t h)))
1667     (org-entry-put nil "CUSTOM_ID" h)))
1668 #+end_src
1671 # Local Variables:
1672 # org-export-html-style: ""
1673 # org-export-html-style-extra: "<link rel=stylesheet href=\"/org.css\" type=\"text/css\" />"
1674 # End:
1675