#+EMAIL: carsten.dominik@gmail.com #+AUTHOR: Worg people #+LANGUAGE: en #+TITLE: Org-mode Frequently Asked Questions #+OPTIONS: toc:t H:2 #+begin_html #+end_html * Welcome :PROPERTIES: :CUSTOM_ID: Welcome :END: Welcome to the Org-mode FAQ. * What is org-mode? :PROPERTIES: :CUSTOM_ID: What-is-org-mode :END: ** Can I implement a GTD workflow with Org-mode? :PROPERTIES: :CUSTOM_ID: GTD-workflow-with-Org-mode :END: Yes, you can. Check for discussions and pointers [[http://orgmode.org/worg/org-gtd-etc.html][here]]. ** What is the difference between Org and TaskPaper? :PROPERTIES: :CUSTOM_ID: Org-and-TaskPaper :END: There is really no difference. Org is as /simple/ as [[http://hogbaysoftware.com/products/taskpaper][TaskPaper]]. It is just that, when using Org within Emacs, it lets you do many things that you wouldn't be able to do with TaskPaper. Yes, TaskPaper is fiddle-proof and people using Emacs tends to like fiddling (which is orthogonal to the idea of using todo-list efficiently), but this is just a matter of discipline and common sense, not one of Org's design. Read [[http://article.gmane.org/gmane.emacs.orgmode/6224][Carsten's enlightening statement]] on this. ** What is the meaning of the Unicorn on Org's website? :PROPERTIES: :CUSTOM_ID: unicorn :END: The Unicorn is the logo of Org-mode because: - Org-mode is the UNICs of ORgaNizers. - Org-mode is an Emacs mode, so it makes sense to use an animal similar or related to the gnu used for GNU Emacs. - Org-mode is meant to show you the way, and an animal with two horns can not do this very well, can it? - Unicorn tears are said to reverse petrification, and wasn't this how we all felt before getting to some degree of time and task management? - It will take forever to learn everything there is to know about a unicorn. - A unicorn is a fabulous creature. Org-mode wants to be a fabulous creation. Using a unicorn was originally /Bastien Guerry's/ idea, his friend /Christophe Bataillon/ designed the logo for us, and /Greg Newman/ gave it a refresh some time later. Bastien writes why he chose a unicorn: #+BEGIN_QUOTE The first reason is not linked to the animal, but to the sounding of the word "Unicorn" - because Org gives you a /uni/que way of producing files in several format (HTML, LaTeX, etc.) The second reason is that a Unicorn doesn't really exist, it is just something you can dream about, and make others believe it does exist. Just like the perfect organizer. #+END_QUOTE 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 Suckling]] posted a link showing how to make a simple foldable unicorn (very appropriate for an outlining program!). [[http://article.gmane.org/gmane.emacs.orgmode/11735][Tim Burt]] made a very complicated one which is now a treasured possession of the Org-mode author. - Official logo: [[http://orgmode.org/img/org-mode-unicorn.png]] This logo is available in a number of different formats including Photoshop /.psd/ and scaleable vector graphics /.svg/ [[http://orgmode.org/img/][here]]. - An [[http://orgmode.org/img/nrocinu4.jpg][alternative version]] from Christophe Bataillon (c): - [[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]]: - [[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 threshold technique". - [[http://article.gmane.org/gmane.emacs.orgmode/11735/match%3D][Tim Burt]] made a folded Unicorn to match the spirit of Org - see the whole set of pictures [[http://www.flickr.com/photos/tcburt/sets/72157614543357071/][on his flickr page]]. - Are unicorns real? Answer [[http://article.gmane.org/gmane.emacs.orgmode/11687/match%3Drosslaird%2Bunicorn][here]] by Ross Laird. * Mailing list ** Why hasn't my email to the mailing list shown up yet? :PROPERTIES: :CUSTOM_ID: ml-post-delay :END: The org-mode mailing list is moderated. Thus, if you are not subscribed to the mailing list, your mail will only appear on the list after it has been approved by a moderator. To ensure that your mail appears quickly, please [[http://lists.gnu.org/mailman/listinfo/emacs-orgmode][subscribe to the list]]. ** I read the mailing list through gmane. Should I subscribe? :PROPERTIES: :CUSTOM_ID: ml-subscription-and-gmane :END: The org-mode mailing list is available via nntp at [[http://dir.gmane.org/gmane.emacs.orgmode][Gmane]]. Many participants in the list prefer read the list in a newsreader, such as Gnus, instead of receiving emails. If you choose to read the list via nntp, you can still [[http://lists.gnu.org/mailman/listinfo/emacs-orgmode][subscribe]] to the list and then opt not to receive any emails on the mailman settings page (see the "Mail Delivery" setting). This will ensure that your messages to the list get through quickly, reduce the work load of the mailing list moderators (who need to clear every mail from non-members), and provide more accurate information about the number of list readers. * Keeping current :PROPERTIES: :CUSTOM_ID: Keeping-current :END: ** My Emacs ships with an older version Org-mode! How do I upgrade? :PROPERTIES: :CUSTOM_ID: updating-org :END: Org-mode develops quickly, which means that versions of Org-mode shipped with Emacs are more or less out-of-date. If you'd like to upgrade to the most recent version of org-mode, you have a number of options. 1. Download the most recent release of org-mode ([[http://orgmode.org/org-7.3.zip][zip]] or [[http://orgmode.org/org-7.3.tar.gz][tarball]]) and follow the [[http://orgmode.org/manual/Installation.html#Installation][installation instructions]] in the manual. 2. Clone and install the development git repository as [[#keeping-current-with-Org-mode-development][explained here]]. If you don't want to run the bleeding edge, you can still use git [[#using-stable-releases-only][to track the most recent stable releases]]. 3. Install and updated org-mode automatically through the Emacs Package Manager as [[#installing-via-elpa][explained in this FAQ]]. ** How do I keep current with bleeding edge development? :PROPERTIES: :CUSTOM_ID: keeping-current-with-Org-mode-development :END: Org mode is developed in [[http://en.wikipedia.org/wiki/Git_(software)][Git]]. You can keep up-to-date with Org-mode developement by cloning Org mode repository and refreshing your copy with latest changes whenever you wish. You only need to use two Git commands (clone and pull.) Here are the steps in brief (please customize locations to suit your setup): 1. Select a location to house the Org mode repository (approx. 40 MB; includes documentation, compiled elisp files and history going all the way back to v4.12a) : $ mkdir $HOME/elisp && cd $HOME/elisp 2. Clone the Org mode Git repository. Recommended approach: : $ git clone git://orgmode.org/org-mode.git You can also clone from this mirror (lagging one hour behind orgmode.org repo): : $ git clone git://repo.or.cz/org-mode.git For those of you behind a firewall that allows only HTTP, you can clone like this (can be somewhat slow), either from orgmode.org or from repo.or.cz: : $ git clone http://orgmode.org/org-mode.git : $ git clone http://repo.or.cz/r/org-mode.git 3. Compile and install Org mode and build documentation. : $ cd org-mode && make && make doc && make install Please note that you can choose to /not/ compile at all and run using source =.el= files only. Compiled files speed things up. Also note that running =make install= is necessary only if you'd like to install org-mode system-wide. 4. This is where you configure Org mode with Emacs. Please refer to [[./org-tutorials/index.org][Org tutorials]]. 5. Keeping up-to-date. Cloning the repository is a one time activity. From this point onwards you only need to /pull/ the latest changes. : $ cd $HOME/elisp/org-mode and then : $ git pull && make clean && make && make doc && make install 6. You should restart org mode to have the changes take effect (if you are not rebooting Emacs.) Also since the intention is to "keep up" with Org mode, you should visit updated sections of documentation for latest updates (use =git log=.) 7. As you use your repository over time it will accumulate loose objects. You can reduce the total size of your git repository with : $ git gc which will consolidate loose git objects into pack files. This reduces the size of the repository and speeds up data access to the objects. ** How can I keep local changes and still track Org mode development? :PROPERTIES: :CUSTOM_ID: keeping-local-changes-current-with-Org-mode-development :END: Say you want to make minor changes to the Makefile to reflect your location for =emacs=. Create a local branch for your changes on top of origin/master as follows: : $ git checkout -b local origin/master : $ git config branch.local.rebase true : # Make your changes to the Makefile and create a new commit : $ git add Makefile : $ git commit -m 'My local Makefile configurations' : # Update git to a newer version : $ git pull Now each time you pull new commits from the distribution repository your local commits will be rewound and replayed on top of the new origin/master. ----------- You would normally work on your =local= branch which includes your custom commits; there's no need to switch back to the =master= branch. ----------- Here is an example of dealing with conflict resolution during git pull. If you get a conflict during a =git pull= you will need to edit the file with the conflict to fix up the conflicting lines and then tell git that you have resolved the conflict. Conflict resolution goes something like this: 1. =git pull= fails with a conflict 2. edit the file 3. =git add= the file to mark the conflict resolved 4. =git rebase --continue= 5. lather, rinse, and repeat 2-4 as needed For this example we have the following Makefile: : # : # Example Makefile : # : : EMACS=emacs : : VERSION=V1.0 and we need to change the =EMACS=emacs= line to =EMACS=myemacs= to make it work well on our system. To do this we - create a local branch for our work : $ git checkout -b local origin/master : $ git config branch.local.rebase true This marks the branch so that all local commits on it are rebased on top of any new commits we get in origin/master during a =git pull= operation. - Make our custom changes Edit the makefile so it looks like this: : # : # Example Makefile : # : : EMACS=myemacs : : VERSION=V1.0 - Create a commit with our custom changes : $ git add Makefile : $ git commit -m 'My local Makefile configurations' - Later we do a =git pull= but that fails with conflicts. : $ git pull : remote: Counting objects: 5, done. : ... : Patch failed at 0001. : : When you have resolved this problem run "git rebase --continue". : If you would prefer to skip this patch, instead run "git rebase --skip". : To restore the original branch and stop rebasing run "git rebase --abort". - Fix the conflict in your favourite editor Conflict markers look like this: : <<<<<<< HEAD:Makefile : EMACS=emacs22 : ======= : EMACS=myemacs : >>>>>>> Change emacs location:Makefile This attempted =git pull= caused a conflict. Fire up your favourite editor and fix the conflict in the Makefile. The conflict markers are <<<<<<<<<< , ======= , and >>>>>>>>>>. Fix the Makefile appropriately and delete the conflict markers. You already edited these lines earlier so fixing it should be trivial. In this case we changed =EMACS=emacs= to =EMACS=myemacs= and upstream changed =EMACS=emacs= to =EMACS=emacs22=. Just fix the file and save it by deleting the conflict markers and keeping the code you need (in this case the =EMACS=myemacs= line which we originally modified.) - Mark the file's conflict resolved : $ git add Makefile 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. - Continue the rebase operation : $ git rebase --continue If any other conflicts arise you fix them the same way - edit the file, mark the conflict resolved, and continue. 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" using : $ git rebase --abort ** How can I use a stable release version instead of the bleeding edge master? :PROPERTIES: :CUSTOM_ID: using-stable-releases-only :END: The master branch of the git repository always contains the bleeding edge development code. This is important for Org's fast development, because code on master gets checked out by many people daily and we quickly receive bug reports if something is wrong. On rare occasions, this code may not function perfectly for a limited time while we are trying to fix things. Not everyone like to use this bleeding-edge code and face the danger to hit a surprising bug. Therefore, from time to time, we make a release. This typically happens when the maintainers feel that 1. they have reached a good point in the development 2. the code has a feature set that should stay and be supported in the future Stable releases are used as the basis for [[http://orgmode.org/index.html#sec-3_3][alternative distributions]] of Org, and they are also the code that gets merged into the Emacs distribution. If you want to work only with stable releases, you can always download [[http://orgmode.org/index.html#sec-3][them here]], but you can also also use the git repository to keep automatically up-to-date with the most recent stable releases (and save bandwidth!). Here's how to do so: *** Run a specific stable release In the repository, do : $ git fetch --tags : $ git tag To see which release tags are available. Let's say you decide to use =release_7.01f=. : $ git checkout release_7.01f This set the working tree of the repository to the state of Org at the moment of release 7.01f. You can then run Org from the repository be sure to use the stable release while development continues on the master branch. Later, when we release 7.02, you can switch to that using : $ git fetch --tags # to get all the new stuff : $ git tag : $ git checkout release_7.02 *** Always run the most recent stable release Alternatively, if you just want to always run whatever the latest stable release is, you can do : $ git checkout -b stable origin/maint and then regularly update this branch by doing : $ git pull ** How can I install an up-to-date version of org-mode without "make" tools? :PROPERTIES: :CUSTOM_ID: installing-org-without-make-tools :END: If you are using org-mode on a computer that lacks developer tools for compiling software, such as [[http://www.gnu.org/software/make/][GNU Make]], you will have to use a *different* installation method than [[http://orgmode.org/manual/Installation.html#Installation][the one outlined in the manual]]. Please see [[http://article.gmane.org/gmane.emacs.orgmode/15264][this thread]] on the mailing list for several different ways you can install a recent version of org-mode without using the customary =make clean && make && make install=. The result of that discussion is the file/function found in [[http://orgmode.org/worg/org-hacks.html#compiling-org-without-make]]. ** I don't use git. Can I download bleeding edge .zip and .tar.gz archives? Yes. You can download [[http://orgmode.org/org-latest.zip][org-latest.zip]] or [[http://orgmode.org/org-latest.tar.gz][org-latest.tar.gz]] of Org-mode -- these archives are udpated every day at midnight. Alternatively, you can download a [[http://orgmode.org/w/org-mode.git/snapshot][tar.gz snapshot from orgmode.org]]. ** How can I install Org-mode through Emacs' Package Manager? :PROPERTIES: :CUSTOM_ID: installing-via-elpa :END: Emacs 24 includes an automated package management tool ([[http://tromey.com/elpa/][ELPA]]) that can be used to install and upgrade elisp packages such as Org-mode. If you are running an older version of Emacs (23 or earlier), you will have to install the package manager before using it to install Org-mode. See [[#installing-elpa][this FAQ]] for more details. Org-mode is distributed as an ELPA package from [[http://elpa.gnu.org/packages/][GNU Emacs Lisp Package Archive]] as well as from [[http://orgmode.org/pkg/daily/][Org-mode Emacs Lisp Archive]]. Steps for adding Org-mode as a package archive: 1. Add Org-mode as a package archive. This can be done in two ways. 1. Use =M-x customize-variable RET package-archives= 2. Add the following line to your =.emacs= and reload Emacs. #+begin_src emacs-lisp (add-to-list 'package-archives '("Org-mode" . "http://orgmode.org/pkg/daily/")) #+end_src 2. Use the Emacs package manager's =M-x list-packages= to browse and install the latest version. 3. If you get the following error "*Failed to download `Org-mode' archive.*" in step 2, you can manually download the tarball and install it. Refer [[Installing from ELPA-tar][this FAQ entry]] for more information. ** How do I install Emacs package manager? :PROPERTIES: :CUSTOM_ID: installing-elpa :END: If you are running Emacs-24 or find the command =M-x list-packages= available you already have the package manager installed. Steps for installing package manager: 1. Download the latest package manager - [[http://repo.or.cz/w/emacs.git/blob_plain/HEAD:/lisp/emacs-lisp/package.el][package.el]]. 2. Add the following to your =.emacs= and reload Emacs. #+begin_src emacs-lisp ;; change "~/elisp/" as appropiate (setq load-path (cons "~/elisp" load-path)) (require 'package) (package-initialize) #+end_src ** I don't see Org-mode as an installation option in Package Manager Menu? :PROPERTIES: :CUSTOM_ID: why-no-org-in-elpa :END: Emacs Package Manager is a very recent addition to Emacs. Work is under way to have have Org-mode seamlessly integrate with Emacs' Package Manager. As a result, it will be some time before the Org-mode packages are available and usable from either GNU or Org-mode package archives. In the meanwhile, you can install Org-mode via package manager through ELPA-compatible tar. Refer [[Installing from ELPA-tar][this FAQ entry]] for more information. ** How do I install Org-mode from a ELPA-compatible tarball? :PROPERTIES: :CUSTOM_ID: installing-from-elpa-tarball :END: # <> Org-mode is distributed as an ELPA-compatible tar which can be used in conjunction with Emacs' package manager. 1. If you are already running Org-mode, note the current version reported by M-x org-version. 2. Download the latest tarball from [[http://orgmode.org/pkg/daily/][Org-mode repo]]. 3. Do =M-x package-install-file=. When prompted for =Package file name=, point it to .tar file downloaded in step 2. You will now see Package Manager compiling the files and installing it. 4. Reload emacs. This step is very important. 5. Note the version of the new installation using M-x org-version. If the new and old versions are different, the installation is done and you are all set to enjoy the updated Org-mode. Otherwise skip to step 6. 6. Review you load-path using =C-h v load-path=. Most likely that your old installation path takes precedence over the path chosen by package manager (which is typically =~/.emacs.d/elpa/...=). Fix this anamoly by moving =(package-initialize)= line in .emacs to a more appropriate location. - Additional Note on =org-install.el= :: Functionality of Org-mode's =org-install.el= is supplanted by Package Manager's =org-autoloads.el=. Since Package Manager autoloads Org-mode for you, the following line =(require 'org-install)= in your =.emacs= is no longer required and can be safely removed. ** Why would I use ELPA tarballs instead of the snapshot tarballs? :PROPERTIES: :CUSTOM_ID: why-elpa :END: ELPA-tarballs automate much the process of upgrading org-mode. Much of the following grunt work is done automatically by the Package Manager: 1. Downloading, compiling, and activating of org-mode (including setting org-mode's =load-path= and autoloads). 2. Updating info files. * Setup :PROPERTIES: :CUSTOM_ID: Setup :END: ** How can I quickly browse all Org options? =M-x org-customize RET= See also [[file:org-tutorials/org-customize.org][Carsten's Org customize tutorial]] and [[file:org-configs/org-customization-guide.org][this customization guide]] for details. ** Can I use the editing features of org-mode in other modes? :PROPERTIES: :CUSTOM_ID: use-editing-features-in-other-modes :END: Not really---but there are a few editing features you can use in other modes. - For tables there is =orgtbl-mode= which implements the table editor as a minor mode. (To enable, type =M-x orgtbl-mode=) - For ordered lists there is =orgstuct-mode= which allows for easy list editing as a minor mode. (To enable, type =M-x orgstruct-mode=) You can activate these modes automatically by using hooks: : (add-hook 'mail-mode-hook 'turn-on-orgtbl) : (add-hook 'mail-mode-hook 'turn-on-orgstruct) For footnotes, there is the function =org-footnote-action=, which works in non-org buffers. This function is a powerful tool for creating and sorting footnotes. To use it globally, you can add the following keybinding to your =.emacs= file (requires Org 6.17 or greater): : (global-set-key (kbd "C-c f") 'org-footnote-action) For other features you need to switch to Org-mode temporarily, or prepare text in a different buffer. ** Why isn't feature "X" working the way it is described in the manual? :PROPERTIES: :CUSTOM_ID: making-sure-org-mode-is-up-to-date :END: Org-mode develops very quickly. If you are using a version of Org-mode that shipped with emacs, there is a good chance that it is somewhat out of date. Many of the users on the Org-mode mailing list are using either a recent release of Org-mode or the [[http://orgmode.org/index.html#sec-3.2][development version of org-mode from the git repository]]. If some settings and features aren't working the way you expect, make sure that the version of the manual you are consulting matches the version of Org-mode you are using. - You can check which version of Org-mode you are using by selection =Org --> Documentation --> Show Version= in the Emacs menu. - The [[http://orgmode.org/manual/index.html][online manual]] at [[http://orgmode.org][orgmode.org]] corresponds to the most recent release. - 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 released with the latest official Gnu Emacs release. Compared with the manual at the orgmode.org, the manual at www.gnu.org is somewhat out of date. For instructions on how to stay current with Org-mode, consult [[keeping-current-with-Org-mode-development][this FAQ]] or follow the instructions on [[http://orgmode.org][the official Org-mode site]]. ** Can I get the visibility-cycling features in outline-mode and outline-minor-mode? :PROPERTIES: :CUSTOM_ID: use-visibility-cycling-in-outline-mode :END: Yes, these functions are written in a way that they are independent of the outline setup. The following setup provides standard Org-mode functionality in outline-mode on =TAB= and =S-TAB=. For outline-minor-mode, we use =C-TAB= instead of =TAB=, because =TAB= usually has mode-specific tasks. #+BEGIN_SRC emacs-lisp (add-hook 'outline-minor-mode-hook (lambda () (define-key outline-minor-mode-map [(control tab)] 'org-cycle) (define-key outline-minor-mode-map [(shift tab)] 'org-global-cycle))) (add-hook 'outline-mode-hook (lambda () (define-key outline-mode-map [(tab)] 'org-cycle) (define-key outline-mode-map [(shift tab)] 'org-global-cycle))) #+END_SRC Or check out /outline-magic.el/, which does this and also provides promotion and demotion functionality. /outline-magic.el/ is available at [[http://www.astro.uva.nl/~dominik/Tools/outline-magic.el][Outline Magic]]. ** Can I save/restore the visibility state of an org-mode buffer? :PROPERTIES: :CUSTOM_ID: saving-visibility-state :END: Well, no---at least not automatically. You can, however, control the visibility of an org-file or of individual trees by adding instructions to your org file. See [[http://orgmode.org/manual/Visibility-cycling.html#Visibility-cycling][this section of the manual]] for more information. ** How can I keep track of changes in my Org files? :PROPERTIES: :CUSTOM_ID: track-of-changes-in-Org-files :END: Use git to track the history of the files, use a cronjob to check in changes regularly. Such a setup is described by Bernt Hansen in [[http://article.gmane.org/gmane.emacs.orgmode/6233][this message]] on [[http://dir.gmane.org/gmane.emacs.orgmode][emacs-orgmode]]. ** Can I use Org-mode as the default mode for all README files? :PROPERTIES: :CUSTOM_ID: Org-mode-as-default-mode :END: Add the following to your .emacs file: : (add-to-list 'auto-mode-alist '("README$" . org-mode)) You can even make it the default mode for any files with unspecified mode using : (setq default-major-mode 'org-mode) ** Can I use ido.el for completing stuff in Org? :PROPERTIES: :CUSTOM_ID: ido-complete :END: Yes, you can. If you are an ido user and ido-mode is active, the following setting will make Org use =ido-completing-read= for most of its completing prompts. : (setq org-completion-use-ido t) ** Should I use one big org file or multiple files? :PROPERTIES: :CUSTOM_ID: how-to-organize-org-mode-files :END: Org-mode is flexible enough to accomodate a variety of organizational and time management schemes. Org's [[http://orgmode.org/manual/Document-Structure.html#Document-Structure][outline cycling and convenient editing and navigation commands]] make it possible to maintain all of your projects and notes in a single file. 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 notes and todos]], also make it a delight to maintain a private "wiki" consisting of multiple files. No matter how you organize your org files, org-mode's agenda commands make it easy to search all your notes and gather together crucial data in a single view. Moreover, several org-mode settings can be configured either globally in your =.emacs= file or locally (per file or per outline tree). See the [[http://orgmode.org/manual/index.html#Top][manual]] for more details. For an example of local customizations see [[limit-agenda-with-category-match][this FAQ]]. Here are a few ideas for organizing org-mode files: - A single file for all your projects and notes. - One file per project. - One file per client. - One file per area of responsibility or type of work (e.g., household, health, work, etc.). - One file for projects, one for appointments, one for reference material, one for someday/maybe items, etc. - A wiki of hyperlinked files that grows and adapts to meet your needs. For more ideas, see some of the links on the [[file:org-tutorials/index.org][org-tutorial index]] or [[file:org-gtd-etc.org][this page on org-mode and GTD]]. ** Why doesn't C-c a call the agenda? Why don't some org keybindings work? :PROPERTIES: :CUSTOM_ID: setting-global-keybindings :END: Org-mode has a few global keybindings that the user must set explicitly in an =.emacs= file. These keybindings include the customary shortcut for calling the agenda (=C-c a=). If nothing happens when you type =C-c a=, then make sure that the following lines are in your =.emacs= file: #+BEGIN_SRC emacs-lisp ;; The following lines are always needed. Choose your own keys. (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode)) (global-set-key "\C-cl" 'org-store-link) (global-set-key "\C-ca" 'org-agenda) (global-set-key "\C-cb" 'org-iswitchb) #+END_SRC emacs-lisp You may, of course, choose whatever keybindings work best for you and do not conflict with other modes. Please see [[http://orgmode.org/manual/Activation.html][this section of the manual]] if you have additional questions. ** Why aren't some of the variables I've customized having an effect? :PROPERTIES: :CUSTOM_ID: load-org-after-setting-variables :END: Some org variables have to be set before org.el is loaded or else they will not work. (An example is the new variable =org-enforce-todo-dependencies=.) To make sure all your variables work you should not use =(require 'org)=. Instead use the following setting: : (require 'org-install) You should also make sure that you do not require any other =org-...= files in your =.emacs= file before you have set your org variables, since these will also cause org.el to be loaded. To be safe, load org files *after* you have set your variables. ** How can I make sure that timestamps appear in English? :PROPERTIES: :CUSTOM_ID: timestamps-and-system-time-locale :END: If your system's locale is not set to English, but you would like the timestamps in your org-mode files to appear in English, you can set the following variable: #+begin_src emacs-lisp (setq system-time-locale "C") #+end_src ** What does a minimal .emacs look like? :PROPERTIES: :CUSTOM_ID: minimal-emacs :END: Using a stripped down minimal .emacs files removes broken custom settings as the cause of an issue and makes it easy to reproduce for other people. The example below has system-specific paths that you'll need to change for your own use. #+begin_src emacs-lisp (add-to-list 'load-path (expand-file-name "~/git/org-mode/lisp")) (add-to-list 'auto-mode-alist '("\\.\\(org\\ |org_archive\\|txt\\)$" . org-mode)) (setq org-agenda-files '("/tmp/test.org")) (require 'org-install) (require 'org-habit) (global-set-key "\C-cl" 'org-store-link) (global-set-key "\C-ca" 'org-agenda) (global-set-key "\C-cb" 'org-iswitchb) #+end_src You can save the minimal .emacs file to ~/minimal.emacs, add suspect configuration code to it, then start emacs something like this: #+begin_src sh emacs -Q -l ~/minimal.emacs #+end_src On OS X, starting emacs with minimal configuration might look something like this: #+begin_src sh /Applications/emacs.app/Contents/MacOS/Emacs -Q -l ~/minimal.emacs #+end_src sh ** Can I migrate from Planner? Yes. This [[http://www.c0t0d0s0.de/plan2org/plan2org.pl][perl script]] can help. * Errors and general problems :PROPERTIES: :CUSTOM_ID: Errors :END: ** Opening Org files in Emacs leads to a crash :PROPERTIES: :CUSTOM_ID: Emacs-crashes-with-org-indent-mode :END: The only known case where Org-mode can crash Emacs is when you are using =org-indent-mode= with Emacs 23.1 (in fact, any version of Emacs before version 23.1.50.3). Upgrade to Emacs 23.2 and the problem should go away. ** When I try to use Org-mode, I always get the error message =(wrong-type-argument keymapp nil)= :PROPERTIES: :CUSTOM_ID: wrong-type-argument-keymapp :END: This is a conflict with an outdated version of the /allout.el/, see the [[http://orgmode.org/manual/Conflicts.html#Conflicts][Conflicts]] section in the manual ** How can I control the application launched by Org-mode to open a certain file type like pdf, html.... :PROPERTIES: :CUSTOM_ID: external-application-launched-to-open-file-link :END: If you want special control about how Org-mode opens files, see the variables =org-file-apps=, =org-file-apps-defaults-gnu=, =org-file-apps-defaults-macosx=, =org-file-apps-defaults-windowsnt=. *However*, normally it is best to just use the mechanism the operating-system provides: *** GNU/Linux systems You you have to check your mailcap settings, find the files: : /etc/mailcap : : or : : $HOME/.mailcap and modify them accordingly. Please read their manual entry. *** Windows systems + for html pages you may configure the =browse-url-= variables through the Customize interface, + the pdf files are automatically opened with Acrobat Reader (if it is installed) *** Mac OSX Change the application responsible for this file type by selecting such a file in the Finder, select =File->Get Info= from the menu and select the application to open this file with. Then, to propagate the change to all files with the same extension, select the =Change all= button. ** Org-mode takes over the TAB key. I also want to use YASnippet, is there a way to fix this conflict? :PROPERTIES: :CUSTOM_ID: YASnippet :END: [[http://code.google.com/p/yasnippet/][yasnippet]] is yet another snippet expansion system for Emacs. It is inspired by TextMate's templating syntax. - watch the [[http://www.youtube.com/watch?v=vOj7btx3ATg][video on YouTube]] - see the [[http://yasnippet.googlecode.com/svn/trunk/doc/index.html][intro and tutorial]] *Note*: yasnippet is not compatible with =org-indent-mode= currently there is no known way to use both successfully with =yas/trigger-key= set to =TAB= (or =[tab]= etc...) The way Org-mode binds the =TAB= key (binding to =[tab]= instead of =\t=) overrules yasnippets' access to this key. The following code fixes this problem: #+begin_src emacs-lisp (add-hook 'org-mode-hook (lambda () (org-set-local 'yas/trigger-key [tab]) (define-key yas/keymap [tab] 'yas/next-field-group))) #+end_src If the above code doesn't work (which it may not with later versions of yasnippet). Then try the following #+begin_src emacs-lisp (defun yas/org-very-safe-expand () (let ((yas/fallback-behavior 'return-nil)) (yas/expand))) (add-hook 'org-mode-hook (lambda () ;; yasnippet (using the new org-cycle hooks) (make-variable-buffer-local 'yas/trigger-key) (setq yas/trigger-key [tab]) (add-to-list 'org-tab-first-hook 'yas/org-very-safe-expand) (define-key yas/keymap [tab] 'yas/next-field))) #+end_src 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]]) with YASnippets for Org-mode. ** Org-mode takes over the S-cursor keys. I also want to use CUA-mode, is there a way to fix this conflict? :PROPERTIES: :CUSTOM_ID: CUA-mode :END: Yes, see the [[http://orgmode.org/manual/Conflicts.html#Conflicts][Conflicts]] section of the manual. ** Org-mode takes over the S-cursor keys. I also want to use windmove.el, is there a way to fix this conflict? :PROPERTIES: :CUSTOM_ID: windmove.el :END: Yes, see the [[http://orgmode.org/manual/Conflicts.html#Conflicts][Conflicts]] section of the manual. ** Org behaves strangely: some keys don't work, some features are missing, my settings have no effect, ... :PROPERTIES: :CUSTOM_ID: loaded-old-org :END: 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=. 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. You should add your directories to the =load-path= at the beginning: : (add-to-list 'load-path "~/.emacs.d/org-mode/lisp") (require 'org-install) 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)=. 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. ** Why doesn't org-batch-agenda work under Win32? :PROPERTIES: :CUSTOM_ID: org-batch-agenda-under-win32 :END: When I run the example batch files to print my agenda to the console under Win32 I get the failure: : End of file during parsing and no agenda is printed. The problem is the use of single quotes surrounding the eval in the emacs command-line. This gets confused under Win32. All string parameters with spaces must be surrounded in double quotes. This means that double quotes being passed to the eval must be escaped. Therefore, instead of the following: : \emacs.exe -batch -l ~/_emacs_org \ : -eval '(org-batch-agenda "a")' you need to use the following: : \emacs.exe -batch -l ~/_emacs_org \ : -eval "(org-batch-agenda \"a\")" (all on one line, of course). ** Org agenda seems very slow :PROPERTIES: :CUSTOM_ID: slow-agenda :END: If it takes a long time to generate or refresh the agenda, you might want first check which version of org-mode you are using. There have been major optimizations of org-agenda since 6.21b, which was the version of org-mode released with Emacs 23. If you are using 6.21b or earlier (you can check with =M-x org-version=), then you might want to consider upgrading to a more recent version of org-mode. Here are some other ideas for speeding up the agenda: 1. Use a one day agenda view (rather than a seven day view). =(setq org-agenda-ndays 1)= 2. Archive inactive items to separate files. =C-c C-x C-s= (org-archive-subtree) 3. Do not include the global todo list in your agenda view. (setq org-agenda-include-all-todo nil) 4. Make sure that your org files are byte-compiled. I.e., make sure there are files ending in =.elc= in your org installation directory. 5. Limit your agenda files (=org-agenda-files=) to files that have active todos and or projects. If you have a number of older reference files---i.e., files you search only occasionally---in your agenda files list, consider removing them from your agenda files and adding them to =org-agenda-text-search-extra-files= instead. Similarly, you might consider searching some of your older reference files with =M-x grep= so that Org-mode does not have to load them into memory when the agenda is called. ** Visual-line-mode doesn't work well with org-mode :PROPERTIES: :CUSTOM_ID: visual-line-mode :END: Visual-line-mode "soft wraps" lines so that the visual edge of the buffer is considered a line break for purposes of navigation, even though there is no line break in reality. In older versions of org-mode, org-beginning-of-line and org-end-of-line do not work well with visual line mode. (The two commands disregard soft line breaks and move to the beginning and end of the hard line break.) A patch was introduces to fix this behavior in July of 2009. n If you are using an older version of org mode, you can: 1. Add a hook to turn off visual line mode. 2. Add the following to your =.emacs=: #+begin_src emacs-lisp (add-hook 'org-mode-hook (lambda () (define-key org-mode-map "\C-a" 'move-beginning-of-line) (define-key org-mode-map "\C-e" 'move-end-of-line))) #+end_src * Faces and highlighting :PROPERTIES: :CUSTOM_ID: Faces :END: ** Org-mode has a lot of colors? How can I change them? :PROPERTIES: :CUSTOM_ID: customizing-org-faces :END: This is a question that applies to Emacs as a whole, but it comes up quite frequently on the org-mode mailing list, so it is appropriate to discuss it here. If you would like to change the style of a face in org-mode (or any other Emacs mode), simply type =M-x customize-face [RET]= while the cursor is on the color/style you are interested in modifying. You will be given the opportunity to customize all the faces located at that point. If you would like an overview of all the faces in org-mode, you can type =C-u M-x list-faces-display [RET] org= and you will be shown all the faces defined by org-mode along with an illustration of their current settings. If you would like to customize org-faces and other aspects of org-appearance, type =M-x customize-group org-font-lock [RET]=. Finally, if you would like verbose information about the properties of the text under the cursor, you can type =C-u C-x ==. See the Worg page on [[file:org-tutorials/org-appearance.org][customizing Org appearance]] for further information. ** Why do I get a tiny font in column view when using emacs daemon? :PROPERTIES: :CUSTOM_ID: column-view-tiny-font :END: When using emacs in daemon mode (=emacs --daemon=), client frames sometimes override the column view face settings, resulting in very small fonts. Here is a fix: #+begin_src emacs-lisp (defun org-column-view-uses-fixed-width-face () ;; copy from org-faces.el (when (fboundp 'set-face-attribute) ;; Make sure that a fixed-width face is used when we have a column ;; table. (set-face-attribute 'org-column nil :height (face-attribute 'default :height) :family (face-attribute 'default :family)))) (when (and (fboundp 'daemonp) (daemonp)) (add-hook 'org-mode-hook 'org-column-view-uses-fixed-width-face)) #+end_src This fix was provided in the following mailing list post: http://article.gmane.org/gmane.emacs.orgmode/27560 ** How can I stop the mouse cursor from highlighting lines in the agenda? :PROPERTIES: :CUSTOM_ID: ratpoison-for-agenda-highlighting :END: You can add the following to your =.emacs=: #+begin_src emacs-lisp (add-hook 'org-finalize-agenda-hook (lambda () (remove-text-properties (point-min) (point-max) '(mouse-face t)))) #+end_src * Outline :PROPERTIES: :CUSTOM_ID: Outline :END: ** Can I have two windows on the same Org-mode file, with different outline visibilities? :PROPERTIES: :CUSTOM_ID: indirect-buffers :END: You may use /indirect buffers/ which do exactly this. See the documentation on the command =make-indirect-buffer=. Org-mode has built-in commands that allow you create an indirect buffer from a subtree of an outline. To open a subtree in new window, type =C-c C-x b=. Any changes you make in the new window will be saved to the original file, but the visibility of both buffers will remain independent of one another. For multiple indirect buffers from the same file, you must use the prefix =C-u= when creating the second (or third) buffer. Otherwise the new indirect buffer will replace the old. You can also create an independent view of an outline subtree by typing =b= on an item in the agenda. ** Emacs outlines are unreadable. Can I get rid of all those stars? :PROPERTIES: :CUSTOM_ID: Emacs-outlines-are-unreadable :END: See the section [[http://orgmode.org/manual/Clean-view.html#Clean-view][Clean outline view]] in the manual. ** C-k is killing whole subtrees! I lost my work! :PROPERTIES: :CUSTOM_ID: C-k-is-killing-subtrees :END: =(setq org-special-ctrl-k t)= before losing your work. ** Why aren't commands working on regions? :PROPERTIES: :CUSTOM_ID: transient-mark-mode :END: Some org-mode commands, such as M-right and M-left for demoting or promoting headlines (see [[demote-multiple-headlines][this FAQ]]), can be applied to entire regions. These commands, however, will only work on active regions set with [[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 Emacs 23. To enable it in earlier versions of emacs, put the following in your =.emacs= file: : (transient-mark-mode 1) Alternatively, you may turn off transient mark mode and use [[http://www.gnu.org/software/emacs/manual/html_node/emacs/Momentary-Mark.html][a momentary mark]] (=C- C-=). ** Why is a blank line inserted after headlines and list items? :PROPERTIES: :ID: 2463F4D8-F686-4CF3-AA07-08976F8A4972 :END: :PROPERTIES: :CUSTOM_ID: blank-line-after-headlines-and-list-items :END: In org-mode, typing =M-RET= at the end of a headline will create a new headline of the same level on a new line. The same is true for plain lists. By default org-mode uses context to determine if a blank line should be inserted after each headline or plain list item when =M-RET= is pressed. For instance, if a there is a blank line before a headline, then typing =M-RET= at the end of the line will insert a blank line before the new headline. For instance, hitting =M-RET= at the end of "Headline Two" below inserts a new headline without a blank line: : ** Headline One : ** Headline Two : ** If there is a blank line between Headline One and Headline Two, however, the results will be as follows: : ** Headline One : : ** Headline Two : : ** If you do not like the default behavior you can change it with the variable =org-blank-before-new-entry=. You can set headings and/or plain lists to auto (the default setting), t (always), or nil (never). ** How can I promote or demote multiple headlines at once? :PROPERTIES: :CUSTOM_ID: demote-multiple-headlines :END: If you have a long list of first level headlines that you'd like to demote to second level headlines, you can select the headlines as a region and then hit =M-= to demote all the headlines at once. Note: =M-S-= will not work on a selected region. Its use is to demote a single subtree (i.e., a headline and all sub-headlines). If M- doesn't seem to work, make sure transient mark mode is enabled. See [[transient-mark-mode][this FAQ]]. ** What's the deal with all the ellipses in my org outlines? :PROPERTIES: :CUSTOM_ID: org-ellipses :END: Org-mode uses ellipses to indicate folded (and thus hidden) text. Most commonly, ellispes occur at the end of headings with folded content: : * Heading ... Or, for instance, they may indicate closed drawers: : :PROPERTIES: ... Sometimes, as a result of editing and cycling an outline, ellipses may appear in unexpected places. You should *never* delete these ellipses, as you may accidentally delete hidden text. Instead, you can type =C-c C-r= (org-reveal) to display all hidden text in the vicinity. Or you may type =M-x RET show-all= to reveal all text in the org file. If you would prefer a symbol or face for indicating hidden text, you can customize the variable org-ellipses. ** How do I yank a subtree so it's indented according to the point's location? :PROPERTIES: :CUSTOM_ID: yank-indent-subtree :END: You can either use =C-c C-w= with a working [[http://orgmode.org/manual/Refiling-notes.html#Refiling-notes][refile-targets]] setup. Or set =org-yank-adjusted-subtrees= to =t= which will adjust the yanked headline's level correctly. Just use =C-k= and =C-y= as you would everywhere else in Emacs. ** Can I read org-mode outlines in vim? :PROPERTIES: :CUSTOM_ID: org-outlines-in-vim :END: Yes, there is a script that enables one to view and navigate folded outline/org files in vim (though without most of org-mode's functionality, of course). - [[http://www.vim.org/scripts/script.php?script_id%3D1266][Emacs outline mode - Imitates Emacsen : vim online]] For instructions on how to set it up, please see [[http://mid.gmane.org/EA275862-B97A-4BAC-B879-177FD07A2D56@gaillourdet.net][this mailing list post]]. Work is also underway on an org-mode clone for Vim. You can check it out on git hub: https://github.com/hsitz/VimOrganizer * Todos and Tags :PROPERTIES: :CUSTOM_ID: Todos-and-Tags :END: ** How can I cycle through the TODO keyword of an entry? :PROPERTIES: :CUSTOM_ID: cycle-TODO-keywords :END: =C-c C-t= or =S-= is what you need. ** How do I track state changes for tasks in Org? :PROPERTIES: :CUSTOM_ID: track-state-changes-for-tasks :END: Take a look at the [[http://thread.gmane.org/gmane.emacs.orgmode/6082][post by Bernt Hansen]] for setting up TODO keyword states and logging timestamps for task state changes. ** Can I select the TODO keywords with a tag-like interface? :PROPERTIES: :CUSTOM_ID: select-TODO-keywords-with-tag-like-interface :END: Yes. Use =(setq org-use-fast-todo-selection t)= If you want to set both your todos and your tags using a single interface, then check out the variable =org-fast-tag-selection-include-todo=. See [[http://orgmode.org/manual/Fast-access-to-TODO-states.html][this section of the manual]] for more details. ** How can I quickly set the tag of an entry? :PROPERTIES: :CUSTOM_ID: quickly-set-tag-of-entry :END: Use =C-c C-c= or =C-c C-q= on the headline. =C-c C-q= is useful for setting tabs in a [[http://orgmode.org/manual/Remember.html#Remember][remember]] buffer, since =C-c C-c= is the default keybinding for filing a note from the remember buffer. You can set tags even more quickly by setting one of the character shortcuts for [[http://orgmode.org/manual/Setting-tags.html#Setting-tags][fast tag selection]]. To set tag shortcuts for all org buffers, put something like the following in your =.emacs= file (or create the same settings by typing =M-x customize-variable RET org-tag-alist=): : (setq org-tag-alist '(("computer" . ?c) ("office" . ?o) ("home" . ?h))) To set tag shortcuts for a single buffer, put something like the following at the top of your org file: : #+TAGS: computer(c) office(o) home(h) ** How can I change the colors of TODO keywords? You can use the variable org-todo-keyword-faces. Here are some sample settings: #+begin_src emacs-lisp (setq org-todo-keyword-faces '( ("TODO" . (:foreground "firebrick2" :weight bold)) ("WAITING" . (:foreground "olivedrab" :weight bold)) ("LATER" . (:foreground "sienna" :weight bold)) ("PROJECT" . (:foreground "steelblue" :weight bold)) ("DONE" . (:foreground "forestgreen" :weight bold)) ("MAYBE" . (:foreground "dimgrey" :weight bold)) ("CANCELED" . shadow) )) #+end_src If you want to change the color of all active todos or all inactive todos, type: : M-x customize-face RET org-todo : M-x customize-face RET org-done You can also set values for each of these in your =.emacs= file: : (set-face-foreground 'org-todo "firebrick2") : (set-face-foreground 'org-done "forestgreen") * Hyperlinks :PROPERTIES: :CUSTOM_ID: Hyperlinks :END: ** Why do I have to confirm the execution of each shell/elisp link? :PROPERTIES: :CUSTOM_ID: confirm-shell/elisp-link :END: The confirmation is there to protect you from unwantingly execute potentially dangerous commands. For example, imagine a link : [[shell:rm -rf ~/*][Google Search]] In an Org-mode buffer, this command would look like /Google Search/, but really it would remove your home directory. If you wish, you can make it easier to respond to the query by setting : (setq org-confirm-shell-link-function 'y-or-n-p : org-confirm-elisp-link-function 'y-or-n-p). Then a single keypress will be enough to confirm those links. It is also possible to turn off this check entirely, but I strongly recommend against this. Be warned. ** Can I use RET or TAB to follow a link? :PROPERTIES: :CUSTOM_ID: RET-or-TAB-to-follow-link :END: Yes, this is how: : (setq org-return-follows-link t) : (setq org-tab-follows-link t) ** Can I keep mouse-1 clicks from following a link? :PROPERTIES: :CUSTOM_ID: mouse-1-following-link :END: Activating links with =mouse-1= is a new feature in Emacs 22, to make link behavior similar to other applications like web browsers. If you hold the mouse button down a bit longer, the cursor will be set without following the link. If you cannot get used to this behavior, you can (as in Emacs 21) use =mouse-2= to follow links and turn off link activation for =mouse-1= with : (setq org-mouse-1-follows-link nil) ** How can I get completion of file names when creating a link? :PROPERTIES: :CUSTOM_ID: completion-of-file-links :END: You can use org-insert-link with a prefix argument: : C-u C-c C-l You will be greeted with prompt in the minibuffer that allows for file completion using your preferred Emacs method for finding files. ** How can I use invisible targets within lists? :PROPERTIES: :CUSTOM_ID: invisible-targets-in-lists :END: The usual way of turning radio links invisible is to comment them, but Org comments need to be at the beginning of the line, which breaks list indentation. The workaround here is to add (INVISIBLE) after your <> For example: : 11. <>(INVISIBLE) : Some text : 12. More text [[target][go to]] ** Org-mode is not opening mailto links in my default mail client :PROPERTIES: :CUSTOM_ID: mailto-links :END: You can customize the function org-mode uses to open mailto links by setting the variable =org-link-mailto-program=: =M-x customize-variable org-link-mailto-program= The default function called is =browse-url=, which opens a mail composition buffer within Emacs. The type of buffer opened by browse-url depends on the setting of the variable =mail-user-agent=. Thus, if you want to ensure that mailto links use Gnus to open a message buffer, you could add the following to your =.emacs=: #+begin_src elisp (setq mail-user-agent 'gnus-user-agent) #+end_src ** Can I use CamelCase links? :PROPERTIES: :CUSTOM_ID: CamelCase-links :END: Yes, you can with the contributed package org-wikinodes.el. Please consult the [[http://orgmode.org/worg/org-contrib/org-wikinodes.html][documentation]]. * Plain Lists :PROPERTIES: :CUSTOM_ID: Plain-Lists :END: ** How can I insert an empty line before each newly inserted headline, but not before each newly inserted plain-list item? :PROPERTIES: :CUSTOM_ID: empty-line-before-each-new-headline-but-not-item :END: : (setq org-blank-before-new-entry : '((heading . t) (plain-list-item . nil)) See also [[id:2463F4D8-F686-4CF3-AA07-08976F8A4972][Why is a blank line inserted after headlines and list items?]]. ** How can I convert itemized lists to enumerated lists? :PROPERTIES: :CUSTOM_ID: convert-itemized-to-enumerated-lists :END: You can use =C-c -= or =S-/= to cycle through the various bullet headlines available for lists: =-, +, *, 1., 1)=. See [[http://orgmode.org/manual/Plain-lists.html#Plain-lists][this section of the manual]] for more information. ** How can I convert plain lists to headlines and vice versa? :PROPERTIES: :CUSTOM_ID: convert-plain-lists-to-headlines :END: To convert a plain list item or line to a headline, type =C-c *= on the headline. This will make the line a subheading of the current headline. To convert a headline to a plain list item, type =C-c -= while the cursor is on the headline. To convert a headline to an unadorned line of text, type =C-c *= on the headline. You can use query replace to accomplish the same things, as Bernt Hansen explains in [[http://article.gmane.org/gmane.emacs.orgmode/10148][this mailing list post]]. ** Is there a good way to create a description list? :PROPERTIES: :CUSTOM_ID: description-lists :END: Yes, these are now built-in: #+BEGIN_EXAMPLE - item1 :: Description of this item 1 - item2 :: Description of this item 2 - item1 :: Description of this item 3 also in multiple lines #+END_EXAMPLE * Tables :PROPERTIES: :CUSTOM_ID: Tables :END: ** How can I make table alignment work with Asian character sets :PROPERTIES: :CUSTOM_ID: table-alignment-asian-characters :END: When table alignment fails, it usually has to do with character sets where some characters have non-integer width. Org will deal correctly with characters that are one or two or three ASCII characters wide, but not with characters that are, for example, 1.5 ASCII characters wide. To make table alignment work you need to switch to a different character set. ** Can I plot data from a table? :PROPERTIES: :CUSTOM_ID: plotting-table-data :END: Yes, you can, using org-plot.el written by Eric Schulte and now bundled with Org. See [[http://orgmode.org/manual/Org_002dPlot.html#Org-Plot][the manual section about this]]. See also [[file:org-tutorials/org-plot.org][this excellent tutorial]] by Eric Schulte. ** How can I fill a table column with incremental numbers? :PROPERTIES: :CUSTOM_ID: fill-table-column-with-incremental-numbers :END: Here is how: Use a field formula to set the first value in the column: #+begin_src org ,| N | | ,|-----+---| ,| :=1 | | ,| | | ,| | | ,| | | ,#+TBLFM: @2$1=1 #+end_src Then define a column formula in the second field: #+begin_src org ,| N | | ,|----------+---| ,| 1 | | ,| =@-1 + 1 | | ,| | | ,| | | ,#+TBLFM: @2$1=1 #+end_src After recomputing the table, the column will be filled with incremental numbers: #+begin_src org ,| N | | ,|---+---| ,| 1 | | ,| 2 | | ,| 3 | | ,| 4 | | ,#+TBLFM: $1=@-1 + 1::@2$1=1 #+end_src Note that you could use arbitrary starting values and column formulas. ** Why does my table column get filled with #ERROR? :PROPERTIES: :CUSTOM_ID: table-column-filled-with-ERROR :END: Org-mode tried to compute the column from other fields using a formula stored in the =#+TBLFM:= line just below the table, and the evaluation of the formula fails. Fix the fields used in the formula, or fix the formula, or remove it! ** How can I stop the table editor from creating new lines? :PROPERTIES: :CUSTOM_ID: table-editor-creates-new-lines :END: When I am in the last column of a table and just above a horizontal line in the table, pressing TAB creates a new table line before the horizontal line. To move to the line below the horizontal line instead, do this: Press =down= (to get on the separator line) and then =TAB=. Or configure the variable : (setq org-table-tab-jumps-over-hlines t) ** How can I get table fields starting with "="? :PROPERTIES: :CUSTOM_ID: table-fields-starting-with-= :END: With the setting : (setq org-table-formula-evaluate-inline nil) this will no longer happen. You can still use formulas using the commands @C-c =@ and @C-u C-c =@ ** How can I change the indentation of an entire table without fixing every line by hand? :PROPERTIES: :CUSTOM_ID: change-indentation-entire-table :END: The indentation of a table is set by the first line. So just fix the indentation of the first line and realign with =TAB=. ** In my huge table the realigning after each TAB takes too long. What can I do? :PROPERTIES: :CUSTOM_ID: table-realigning-after-TAB-takes-long :END: Either split the table into several by inserting an empty line every 100 lines or so. Or turn off the automatic re-align with : (setq org-table-automatic-realign nil) After this the only way to realign a table is to press =C-c C-c=. It will no longer happen automatically, removing the corresponding delays during editing. ** Recalculation of my table takes too long. What can I do? :PROPERTIES: :CUSTOM_ID: Recalculation-of-my-table-takes-too-long :END: Nothing, really. The spreadsheet in org is mostly done to make calculations possible, not so much to make them fast. Since Org-mode is firmly committed to the ASCII format, nothing is stopping you from editing the table by hand. Therefore, there is no internal representation of the data. Each time Org-mode starts a computation, it must scan the table for special lines, find the fields etc. This is slow. Furthermore, Calc is slow compared to hardware computations. To make this work with normal editing, recalculation is not happening automatically, or only for the current line, so that the long wait for a full table iteration only happens when you ask for it. So for really complex tables, moving to a "real" spreadsheet may still be the best option. That said, there are some ways to optimize things in Org-mode, and I have been thinking about moving a bit further down this line. However, for my applications this has so far not been an issue at all. If you have a good case, you could try to convince me. ** =S-RET= in a table keeps increasing the copied numbers. How can I stop this? :PROPERTIES: :CUSTOM_ID: S-RET-in-a-table-increases-copied-numbers :END: Well, it is /supposed/ to be a feature, to make it easy to create a column with increasing numbers. If this gets into your way, turn it off with : (setq org-org-table-copy-increment nil) ** When I export tables to html, they don't have borders. :PROPERTIES: :CUSTOM_ID: table-borders-in-html-export :END: By default, org mode exports tables without borders. You can changed this by placing an =#+ATTR_HTML= line before the table: : #+ATTR_HTML: border="2" rules="all" frame="all" See [[http://orgmode.org/manual/Tables-in-HTML-export.html#Tables-in-HTML-export][the manual]] for more details. ** Why does the Calc high precision (e. g. =p20=) not work like expected? :PROPERTIES: :CUSTOM_ID: table-high-precision :END: - *Short answer* Avoid : | 1 / 2 * 3 | 0.16666667000000 | : #+TBLFM: $2 = $1; p20 %.14f and use : | 1 / 2 * 3 | 0.16666666666667 | : #+TBLFM: $2 = $1 +.0; p20 f-14 - *Longer answer* It is important to distinguish between the precision of 1) =p20=: Calc internal calculation (=calc-internal-prec=) 2) =f-14=: Calc float formatting, unlimited in precision (=calc-float-format=) 3) =%.14f=: the =printf= reformatting, limited in precision 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. Use =C-h v org-calc-default-modes RET= to check the Org default settings which are used if no format specifiers are added to a table formula. The examples below have been made with the out_of_the_box Org defaults =calc-internal-prec = 12= and =calc-float-format = 8=. Remember the formula debugger, toggled with =C-c {=, to view the processing stages like: | | formula debugger label | processing stage | | / | < | <> | |---+------------------------+----------------------------| | | Result: | output of Calc | | | Format: | reformatting with =printf= | Following are some examples to demonstrate the interaction of the three precisions. - *display precision limitations for Calc formulas* - limited by Calc internal calculation precision from Org default (here =p12=) : | 0.16666666666700 | : #+TBLFM: $1 = 1 / 2 * 3; f-14 : | 0.1666666666670000000 | : #+TBLFM: $1 = 1 / 2 * 3; f-19 - limited by Calc float format from Org default (here =f8=) : | 0.16666667 | : #+TBLFM: $1 = 1 / 2 * 3 : | 0.16666667 | : #+TBLFM: $1 = 1 / 2 * 3; p20 : | 0.16666667000000 | : #+TBLFM: $1 = 1 / 2 * 3; %.14f : | 0.16666667000000 | : #+TBLFM: $1 = 1 / 2 * 3; p20 %.14f - limited by Calc float format specified : | 0.166667 | : #+TBLFM: $1 = 1 / 2 * 3; f-6 : | 0.16666666666667 | : #+TBLFM: $1 = 1 / 2 * 3; p20 f-14 : | 0.1666666666666666667 | : #+TBLFM: $1 = 1 / 2 * 3; p20 f-19 - limited by =printf= conversion to Emacs Lisp float : | 0.1666666699999999900 | the inaccuracy is platform dependent | : #+TBLFM: $1 = 1 / 2 * 3; %.19f : | 0.1666666699999999900 | the inaccuracy is platform dependent | : #+TBLFM: $1 = 1 / 2 * 3; p20 %.19f : | 0.1666666666666666600 | the inaccuracy is platform dependent | : #+TBLFM: $1 = 1 / 2 * 3; p20 f-20 %.19f - limited by =printf= format specified : | 0.166667 | : #+TBLFM: $1 = 1 / 2 * 3; %.6f - *display precision limitations for Emacs Lisp formulas* - limited by Emacs Lisp float : | 0.16666666666666666 | : #+TBLFM: $1 = '(/ 1.0 (* 2 3)) : | 0.1666666666666666574 | the inaccuracy is platform dependent | : #+TBLFM: $1 = '(/ 1.0 (* 2 3)); %.19f - limited by =printf= format specified : | 0.16666666666667 | : #+TBLFM: $1 = '(/ 1.0 (* 2 3)); %.14f This FAQ entry is based on this [[http://thread.gmane.org/gmane.emacs.orgmode/22642][mailing list thread]] and is continued in the [[#table-float-fraction][next FAQ entry]]. ** Which float format shows the fraction part also when the latter is zero? :PROPERTIES: :CUSTOM_ID: table-float-fraction :END: - *Short answer* Avoid : | 1 | 1 | : #+TBLFM: $2 = $1; f-3 and use : | 1 | 1.000 | : #+TBLFM: $2 = $1 +.0; f-3 - *Longer answer* 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]] in the section Mode Settings -> Display Modes -> Float Formats [[http://www.delorie.com/gnu/docs/calc/calc_163.html][found here as long as the section numbering is unchanged]]. Remember the formula debugger, toggled with =C-c {=, to view the processing stages like: | | formula debugger label | processing stage | | / | < | <> | |---+------------------------+----------------------------| | | Result: | output of Calc | | | Format: | reformatting with =printf= | Following are some examples to demonstrate different float formats. - normal precision : |-----------+---------+-------+---------+----------+-------| : | number | f3 | f-3 | +.0; f3 | +.0; f-3 | %.3f | : |-----------+---------+-------+---------+----------+-------| : | 1 | 1 | 1 | 1.000 | 1.000 | 1.000 | : | 0 | 0 | 0 | 0.000 | 0.000 | 0.000 | : |-----------+---------+-------+---------+----------+-------| : | 1.0 | 1.000 | 1.000 | 1.000 | 1.000 | 1.000 | : | 0.0 | 0.000 | 0.000 | 0.000 | 0.000 | 0.000 | : |-----------+---------+-------+---------+----------+-------| : | 1.0001666 | 1.000 | 1.000 | 1.000 | 1.000 | 1.000 | : | 0.0001666 | 1.67e-4 | 0.000 | 1.67e-4 | 0.000 | 0.000 | : |-----------+---------+-------+---------+----------+-------| : | 1.0016666 | 1.002 | 1.002 | 1.002 | 1.002 | 1.002 | : | 0.0016666 | 0.002 | 0.002 | 0.002 | 0.002 | 0.002 | : |-----------+---------+-------+---------+----------+-------| : #+TBLFM: $2 = $1; f3 :: $3 = $1; f-3 :: $4 = $1 +.0; f3 :: $5 = $1 +.0; f-3 :: $6 = $1; %.3f - high precision : |----------------------+--------------------------+-----------------------| : | number | f19 | f-19 | : |----------------------+--------------------------+-----------------------| : | 1 | 1 | 1 | : | 0 | 0 | 0 | : |----------------------+--------------------------+-----------------------| : | 1.0 | 1.0000000000000000000 | 1.0000000000000000000 | : | 0.0 | 0.0000000000000000000 | 0.0000000000000000000 | : |----------------------+--------------------------+-----------------------| : | 1 + 1 / 2 * 3 * 1e19 | 1.0000000000000000000 | 1.0000000000000000000 | : | 0 + 1 / 2 * 3 * 1e19 | 1.666666666666666667e-20 | 0.0000000000000000000 | : |----------------------+--------------------------+-----------------------| : | 1 + 1 / 2 * 3 * 1e18 | 1.0000000000000000002 | 1.0000000000000000002 | : | 0 + 1 / 2 * 3 * 1e18 | 0.0000000000000000002 | 0.0000000000000000002 | : |----------------------+--------------------------+-----------------------| : #+TBLFM: $2 = $1; p20 f19 :: $3 = $1; p20 f-19 : |----------------------+--------------------------+-----------------------| : | number | +.0; f19 | +.0; f-19 | : |----------------------+--------------------------+-----------------------| : | 1 | 1.0000000000000000000 | 1.0000000000000000000 | : | 0 | 0.0000000000000000000 | 0.0000000000000000000 | : |----------------------+--------------------------+-----------------------| : | 1.0 | 1.0000000000000000000 | 1.0000000000000000000 | : | 0.0 | 0.0000000000000000000 | 0.0000000000000000000 | : |----------------------+--------------------------+-----------------------| : | 1 + 1 / 2 * 3 * 1e19 | 1.0000000000000000000 | 1.0000000000000000000 | : | 0 + 1 / 2 * 3 * 1e19 | 1.666666666666666667e-20 | 0.0000000000000000000 | : |----------------------+--------------------------+-----------------------| : | 1 + 1 / 2 * 3 * 1e18 | 1.0000000000000000002 | 1.0000000000000000002 | : | 0 + 1 / 2 * 3 * 1e18 | 0.0000000000000000002 | 0.0000000000000000002 | : |----------------------+--------------------------+-----------------------| : #+TBLFM: $2 = $1 +.0; p20 f19 :: $3 = $1 +.0; p20 f-19 The =printf= reformatting (=%.19f=) cannot be used with high precision, see the [[#table-high-precision][previous FAQ entry]]. ** How can I center tables in LaTeX output? :PROPERTIES: :CATEGORY: centered-tables-in-latex :END: Set the `org-export-latex-tables-centered' to `t': : (defcustom org-export-latex-tables-centered t : "When non-nil, tables are exported in a center environment." : :group 'org-export-latex : :type 'boolean) * Markup :PROPERTIES: :CUSTOM_ID: Footnotes :END: ** How can I get automatic renumbering of footnotes in org-mode? :PROPERTIES: :CUSTOM_ID: footnote-auto-adjust :END: You can add the following line to your .emacs file: : (setq org-footnote-auto-adjust t) Or, if you prefer, you can turn this option on locally by placing the following line at the top of your org file: : #+STARTUP: fnadjust When auto-adjust is turned on, footnotes in the file with numerical labels will be renumbered whenever a new footnote is added. Meanwhile, all footnotes, including those with custom labels such =[fn:custom-label ]=, will be sorted in the order of their appearance in the text. This emulates the footnote behavior that many users may be familiar with from word-processing programs or from the footnote-mode included with emacs. If you do not turn on org-footnote-auto-adjust, you sort and/or renumber footnotes at any time by calling org-footnote-action with a prefix argument. ** Why isn't auto renumbering of footnotes turned on by default? :PROPERTIES: :CUSTOM_ID: why-no-default-auto-adjust :END: Org mode has a very robust footnote mechanism allowing for a variety of types of footnotes. With some of the following footnote notations, auto-adjust may be either irrelevant or undesired: - Automatically numbered - Footnotes with custom labels - Inline footnotes In addition, org mode can be customized to place footnotes either at the end of a document or at the end of the outline heading in which they appear. Users who change this setting while editing a document may be disconcerted to find all of their footnotes rearranged automatically. ** I have auto-fill-mode set and org-mode is inserting unwanted comment markers! :PROPERTIES: :CUSTOM_ID: auto-fill-and-unwanted-comments :END: If the following occurs: #+begin_src org ,#+OPTIONS: toc:nil ,Some entered text. ,# More entered tex. #+end_src Make sure that the variable comment-start is nil. ** Are there any shortcuts for entering source blocks and comment lines? :PROPERTIES: :CUSTOM_ID: shortcuts-for-entering-source-blocks :END: Org mode has some [[http://orgmode.org/manual/Literal-examples.html#Literal-examples][very convenient markup]] for including literal blocks and lines of code in a file. (This is especially useful when exporting documents or using the contributed package [[file:org-contrib/babel/index.org][org-babel]] for executing blocks of code.) #+begin_src org ,#+begin_src perl , print "Hello, world!\n"; ,#+end_src #+end_src It can be tiresome to enter the block comment lines manually. There are several possible shortcuts you can use to enter them: 1) Built-in expansion - Org mode has a "secret" method of expanding source code blocks and comment lines. - If you type "