1 #+TITLE: Org-Mode Homepage
3 #+EMAIL: carsten at orgmode dot org
4 #+OPTIONS: H:3 num:nil toc:2 \n:nil @:t ::t |:t ^:t *:t TeX:t
6 * Org - an Emacs Mode for Notes and Project Planning
8 #+HTML: <BASE href="http://orgmode.org/index.html">
10 Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
11 project planning with a fast and effective plain-text system.
13 Org-mode develops organizational tasks around NOTES files that contain
14 information about projects as plain text. Org-mode is implemented on
15 top of outline-mode, which makes it possible to keep the content of
16 large files well structured. Visibility cycling and structure editing
17 help to work with the tree. Tables are easily created with a built-in
18 table editor. Org-mode supports ToDo items, deadlines, time stamps,
19 and scheduling. It dynamically compiles entries into an agenda.
20 Plain text URL-like links connect to websites, emails, Usenet
21 messages, BBDB entries, and any files related to the projects. For
22 printing and sharing of notes, an Org-mode file can be exported as a
23 structured ASCII file, HTML, and LaTeX.
25 * Current Version (5.19a) and Compatibility
27 The current version is 5.19a. To see what has changed in recent
28 releases, check this [[file:Changes.html][list of user-visible changes]]. These descriptions
29 are extensive, to avoid that people will be printing the manual after
30 each incremental release. If you have an older version of the manual,
31 just check the release notes and you will be up-to-date.
33 This package works on Emacs 22, and (with minor restrictions) on Emacs
34 21 and XEmacs 21 (where you must also use /noutline.el/ shipped with
35 Org-mode). The Emacs 22.1 release ships with Org-mode version 4.67c.
36 The latest CVS emacs trunk usually contains a fairly recent version,
37 but may lag a bit behind the website release.
42 Download as [[file:org-5.19a.zip][zip file]] or [[file:org-5.19a.tar.gz][gzipped tar archive]]. These archives contain
43 both the Lisp file org.el and the documentation in PDF and (TeX)Info
44 formats. A shell script to simplify upgrading to the newest release
45 has been posted [[http://www.philfam.co.uk/pete/GTD/org-mode/update-org.sh][here]].
48 ** Manual and Reference card
49 - Read the documentation [[file:manual/index.html][online]]. This is a version consisting of many
50 small files, to save bandwidth. If you really need it, you can also
51 have the entire manual in a [[file:org.html][single monolithic file]].
52 - Download the documentation in other formats: [[file:org.pdf][PDF]], [[file:org][Info]], or [[file:org.texi][TeXInfo]].
53 - Download the [[file:orgcard.pdf][Refcard]] for org-mode, and Kyle Sherman hast created a
54 [[file:orgcard.txt][text version]] of the reference card
55 - There is also a [[http://hpcgi1.nifty.com/spen/index.cgi?OrgMode%2fManual][Japanese translation]] of the manual (version 4.60),
56 produced by Takeshi Okano.
57 - The [[file:faq.org][FAQ]] is not very up-to-date, but may still answer some of your
58 questions. Please have a look before posting to emacs-orgmode@gnu.org.
64 There is a mailing list for discussion about org-mode.
66 - Subscribe to it at [[http://lists.gnu.org/mailman/listinfo/emacs-orgmode][this webpage]].
67 - Directly [[mailto:emacs-orgmode@gnu.org][send mail to it]]. If you are not subscribed, a moderator
68 will look at the message before passing it through to the
69 list. If that has happened once, future messages from your email
70 address will get through immediately, even if you remain
72 - Read the list on [[http://www.gmane.org][Gmane]] through a [[http://news.gmane.org/gmane.emacs.orgmode][web interface]] or with a
73 [[news://news.gmane.org/gmane.emacs.orgmode][newsreader]].
75 <li><form method="get" action="http://search.gmane.org/">
76 <input type="text" name="query">
77 <input type="hidden" name="group" value="gmane.emacs.orgmode">
78 <input type="submit" value="Search gmane.emacs.orgmode">
82 ** Worg - user-driven knowledge-base about org-mode
84 [[http://129.199.80.1/~guerry/worg/][Worg]], created by [[http://www.cognition.ens.fr/~guerry/][Bastien Guerry]], is a setup to allow users to jointly
85 edit a number of Org-mode files containing documentation about
86 Org-mode. This is something like a wiki. If you'd like to contribute
87 your own setup, screenshots, tutorials etc, please go to [[http://129.199.80.1/~guerry/worg/][the Worg
88 page]], and start from there.
92 [[file:tutorials.org][Tutorials and screencasts]] are listed on a separate page.
96 In November 2007, Charles Cave organized a survey among Org-mode
97 users. The answers given in this survey can be found [[file:survey.html][here]].
99 ** Org-mode, GTD and other task management systems
100 Org-mode is flexible enough to implement many different ways of
101 organizing your projects. A frequently discusses scheme is [[http://www.davidco.com/][David
102 Allen's]] strategy for [[http://en.wikipedia.org/wiki/GTD][Getting Things Done]]. But it is clearly not
103 the only way to us Org-mode for planning. Here are a couple of
104 links related to this topic.
106 - [[http://johnwiegley.com][John Wiegley]] has written an excellent document describing his
107 way of using Org-mode as a [[http://johnwiegley.com/org.mode.day.planner.html][day planner]]. See also some later
108 messages for enhancements of his setup:
109 [[http://article.gmane.org/gmane.emacs.orgmode/2963][emacs-orgmode-2962]], [[http://article.gmane.org/gmane.emacs.orgmode/3629][emacs-orgmode-3629]]
111 - [[http://members.optusnet.com.au/charles57/Creative/][Charles Cave]] has written an [[http://members.optusnet.com.au/~charles57/GTD/orgmode.html][article/tutorial]] about the basic
112 elements of GTD and how he implements them in Org-mode. There
113 is also a [[http://129.199.80.1/~guerry/org-gtd.html][french translation]] of this document.
115 - There have been several threads on emacs-orgmode@gnu.org related
116 to GTD, the most important ones are:
118 + [[http://thread.gmane.org/gmane.emacs.orgmode/683][Another GTD question]], which contains a discussion about basic
119 GTD aspects. It also contains this
120 + [[http://article.gmane.org/gmane.emacs.orgmode/715][Post by Carsten]] summarizing several options for implementing
122 + [[http://thread.gmane.org/gmane.emacs.orgmode/523][GTD, Projects and Next Actions in org-mode]] is a thread where
123 several people describe their personal setup is
124 + The [[http://thread.gmane.org/gmane.emacs.orgmode/4915][SOMEDAY/MAYBE vs. low priorities]] thread contains a
125 discussion about priorities that is quite instructive.
126 + Here is a [[http://thread.gmane.org/gmane.emacs.orgmode/4832/focus%3D4854][very instructive post]] by Pete Phillips explaining
127 why David Allens book is where you should start to learn GTD,
128 and that the Internet and Org-mode only come into the game
129 later, when thinking about the implementation. And since
130 doing GTD the right way will give you lots of free time, don't
131 forget to listen to [[http://www.detox-jazz.co.uk/][Pete's music]]!
133 - Also on the web you can find information about how people are
134 setting up Org-mode to fit their habits. A few examples:
136 + This [[http://www.brool.com/?p=82][blog post]] shows a very simple and clear GTD setup.
140 - [[http://www.cl.cam.ac.uk/~pz215/][Piotr Zielinski]] wrote [[http://www.cl.cam.ac.uk/~pz215/files/org-mouse.el][org-mouse.el]] which is now distributed with
141 Org-mode. It implements great mouse support for many functions in
144 - [[http://dto.freeshell.org/notebook/][David O'Toole]] is the author of [[http://dto.freeshell.org/e/org-publish.el][org-publish.el]]. While this is
145 now part of the Org-mode distribution, you might find the newest
146 bug fixes and developments at his [[http://dto.freeshell.org/notebook/OrgMode.html][Org-mode page]], along with
147 several other projects like /org-blog.el/ and
148 /org-publish-escript.el/.
150 - [[http://www.cognition.ens.fr/~guerry/][Bastien Guerry]] has been really prolific in writing interesting
151 add-ons, all available at his [[http://www.cognition.ens.fr/~guerry/bastien-org-mode.html][org-mode page]]:
152 + a package for using Org-mode as the basis for blogging
153 + a LaTeX exporter that is now distributed together with
155 + a special table-of-contents buffer that simplifies navigation
156 + a registry to find locations that link a specific document.
158 - George C.F. Greve wrote [[http://www.emacswiki.org/emacs/org-mairix.el][org-mairix.el]] to add links that trigger a
163 I know about the following attempts to translate from and to
168 - [[http://www.cognition.ens.fr/~guerry/u/org2rem.el][From Org-mode to remind]] by [[http://www.cognition.ens.fr/~guerry/][Bastien Guerry]].
170 - [[file:org-export-freemind-0.1.0.tar.gz][From Org-mode to Freemind]] by Marco Vezzoli.
174 - [[http://www.olafdietsche.de/palm/palm2orgmode.pl][From Palm TODO database to Orgmode]]. This Translator was
175 written by [[http://www.olafdietsche.de/][Olaf Dietsche]].
177 - From [[http://thread.gmane.org/gmane.emacs.orgmode/5073][Remind to Org]] by Detlef Steuer.
181 Unfortunately nothing so far.
183 ** Alternative distributions
185 - Mark A. Hershberger has made some [[https://launchpad.net/~hexmode/+archive][Ubuntu packages]] for org-mode.
187 ** Contributing to Org-mode
189 You can always contribute with ideas and bug reports on the mailing
190 list. If you want to contribute a patch, code snippets, or a full
191 add-on, this is very welcome too! However, I can only make it an
192 official part of Org-mode if you have signed the papers with the
193 Free Software Foundation. Org-mode is distributed as part of Emacs
194 and must therefore adhere to strict rules about the copyright of
195 all included material. If this is what you want to do, [[file:request-assign-future.txt][here]] is the
196 form that you have to fill in and send to the FSF. After you
197 received the final copy with signatures, please scan it and send
198 the scan to the maintainer.
200 ** Future Development
202 Org-mode is still developing fast. The best way to stay up-to-date
203 is to join the mailing list where the changes are developed and
206 Here is a loose [[file:todo.org][list of ideas]] that are still to be processed
207 somehow, when I get to it...
210 [[http://sachachua.com/wp/][Sacha Chua]] about [[http://sachachua.com/wp/2007/12/26/emacs-choosing-between-org-and-planner/][Choosing between Planner and Org]].