Release 6.02a
[org-mode.git] / ORGWEBPAGE / index.org
blobab44aceea4822e9b1da35c972de469b33d316aea
1 #+TITLE:     Org-Mode Homepage
2 #+LANGUAGE:  en
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 (6.02a) and Compatibility
27 The current version is 6.02a.  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.
39 * Downloads
41 **** Distribution
43 Download as [[file:org-6.02a.zip][zip file]] or [[file:org-6.02a.tar.gz][gzipped tar archive]].  These archives contain
44 both the Lisp file org.el and the documentation in PDF and (TeX)Info
45 formats.  A shell script to simplify upgrading to the newest release
46 has been posted [[http://www.philfam.co.uk/pete/GTD/org-mode/update-org.sh][here]].
48 **** Get the development version
50 You can check out the latest Org development version by using git.  
51 More information on this page: http://repo.or.cz/w/org-mode.git
53 * Documentation
54 ** Manual and Reference card
55    - Read the documentation [[file:manual/index.html][online]].  This is a version consisting of many
56      small files, to save bandwidth.  If you really need it, you can also
57      have the entire manual in a [[file:org.html][single monolithic file]].
58    - Download the documentation in other formats: [[file:org.pdf][PDF]], [[file:org][Info]], or [[file:org.texi][TeXInfo]].
59    - Download the [[file:orgcard.pdf][Refcard]] for org-mode, and Kyle Sherman hast created a
60      [[file:orgcard.txt][text version]] of the reference card
61    - There is also a [[http://hpcgi1.nifty.com/spen/index.cgi?OrgMode%2fManual][Japanese translation]] of the manual (version 4.60),
62      produced by Takeshi Okano.
63    - The [[file:faq.org][FAQ]] is not very up-to-date, but may still answer some of your
64      questions.  Please have a look before posting to emacs-orgmode@gnu.org.
66 * Links
68 ** Mailing list
70    There is a mailing list for discussion about org-mode.
72    - Subscribe to it at [[http://lists.gnu.org/mailman/listinfo/emacs-orgmode][this webpage]].
73    - Directly [[mailto:emacs-orgmode@gnu.org][send mail to it]].  If you are not subscribed, a moderator
74      will look at the message before passing it through to the
75      list.  If that has happened once, future messages from your email
76      address will get through immediately, even if you remain
77      unsubscribed.
78    - Read the list on [[http://www.gmane.org][Gmane]] through a [[http://news.gmane.org/gmane.emacs.orgmode][web interface]] or with a
79      [[news://news.gmane.org/gmane.emacs.orgmode][newsreader]].
81 #+BEGIN_HTML
82 <li><form method="get" action="http://search.gmane.org/">
83 <input type="text" name="query">
84 <input type="hidden" name="group" value="gmane.emacs.orgmode">
85 <input type="submit" value="Search gmane.emacs.orgmode">
86 </form>
87 #+END_HTML
89 ** Worg - user-driven knowledge-base about org-mode
91 [[http://www.legito.net/worg/][Worg]], created by [[http://www.cognition.ens.fr/~guerry/][Bastien Guerry]], is a setup to allow users to jointly
92 edit a number of Org-mode files containing documentation about
93 Org-mode.  This is something like a wiki, but with the advantage that
94 you do not have to be online to modify a file.  If you'd like to
95 contribute your own setup, screenshots, tutorials etc, please go to
96 [[http://www.legito.net/worg/][the Worg page]], and start from there.
98 ** Tutorials
100    [[http://www.legito.net/worg/org-tutorials/index.php][Tutorials and screencasts]] are maintained by the [[http://www.legito.net/worg][Worg project]].
102 ** Survey
104    In November 2007, Charles Cave organized a survey among Org-mode
105    users.  The answers given in this survey can be found [[file:survey.html][here]].
107 ** Org-mode, GTD and other task management systems 
108     Org-mode is flexible enough to implement many different ways of
109     organizing your projects.  A frequently discusses scheme is [[http://www.davidco.com/][David
110     Allen's]] strategy for [[http://en.wikipedia.org/wiki/GTD][Getting Things Done]].  But it is clearly not
111     the only way to us Org-mode for planning.  Here are a couple of
112     links related to this topic.
114     - [[http://johnwiegley.com][John Wiegley]] has written an excellent document describing his
115       way of using Org-mode as a [[http://johnwiegley.com/org.mode.day.planner.html][day planner]]. See also some later
116       messages for enhancements of his setup:
117       [[http://article.gmane.org/gmane.emacs.orgmode/2963][emacs-orgmode-2962]], [[http://article.gmane.org/gmane.emacs.orgmode/3629][emacs-orgmode-3629]]
119     - [[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
120       elements of GTD and how he implements them in Org-mode.  There
121       is also a [[http://www.legito.net/worg/org-tutorials/orgtutorial_dto-fr.php][french translation]] of this document.
123     - There have been several threads on emacs-orgmode@gnu.org related
124       to GTD, the most important ones are:
126       + [[http://thread.gmane.org/gmane.emacs.orgmode/683][Another GTD question]], which contains a discussion about basic
127         GTD aspects.  It also contains this
128       + [[http://article.gmane.org/gmane.emacs.orgmode/715][Post by Carsten]] summarizing several options for implementing
129         GTD in org-mode.
130       + [[http://thread.gmane.org/gmane.emacs.orgmode/523][GTD, Projects and Next Actions in org-mode]] is a thread where
131         several people describe their personal setup is 
132       + The [[http://thread.gmane.org/gmane.emacs.orgmode/4915][SOMEDAY/MAYBE vs. low priorities]] thread contains a
133         discussion about priorities that is quite instructive.
134       + Here is a [[http://thread.gmane.org/gmane.emacs.orgmode/4832/focus%3D4854][very instructive post]] by Pete Phillips explaining
135         why David Allens book is where you should start to learn GTD,
136         and that the Internet and Org-mode only come into the game
137         later, when thinking about the implementation.  And since
138         doing GTD the right way will give you lots of free time, don't
139         forget to listen to [[http://www.detox-jazz.co.uk/][Pete's music]]!
141     - Also on the web you can find information about how people are
142       setting up Org-mode to fit their habits.  A few examples:
144       + This [[http://www.brool.com/?p=82][blog post]] shows a very simple and clear GTD setup.
146 ** Add-Ons
148    - [[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
149      Org-mode. It implements great mouse support for many functions in
150      org-mode.
152    - [[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
153      now part of the Org-mode distribution, you might find the newest
154      bug fixes and developments at his [[http://dto.freeshell.org/notebook/OrgMode.html][Org-mode page]], along with
155      several other projects like /org-blog.el/ and
156      /org-publish-escript.el/.
158    - [[http://www.cognition.ens.fr/~guerry/][Bastien Guerry]] has been really prolific in writing interesting
159      add-ons, all available at his [[http://www.cognition.ens.fr/~guerry/bastien-org-mode.html][org-mode page]]:
160      + a package for using Org-mode as the basis for blogging
161      + a LaTeX exporter that is now distributed together with
162        org-mode
163      + a special table-of-contents buffer that simplifies navigation
164      + a registry to find locations that link a specific document.
166    - George C.F. Greve wrote [[http://www.emacswiki.org/emacs/org-mairix.el][org-mairix.el]] to add links that trigger a
167      mairix search.
169 ** Translators
170    
171    I know about the following attempts to translate from and to
172    Org-mode files:
174 *** Org-mode to XXX
176     - [[http://www.cognition.ens.fr/~guerry/u/org2rem.el][From Org-mode to remind]] by [[http://www.cognition.ens.fr/~guerry/][Bastien Guerry]].
177       
178     - From Org-mode to Freemind by Marco Vezzoli, this is available in
179       the contrib directory of the distribution.
181 *** XXX to Org-mode
183     - [[http://www.olafdietsche.de/palm/palm2orgmode.pl][From Palm TODO database to Orgmode]].  This Translator was
184       written by [[http://www.olafdietsche.de/][Olaf Dietsche]].
186     - From [[http://thread.gmane.org/gmane.emacs.orgmode/5073][Remind to Org]] by Detlef Steuer.
188 *** Bi-directional
189     
190     Unfortunately nothing so far.
192 ** Alternative distributions
194    - Mark A. Hershberger has made some [[https://launchpad.net/~hexmode/+archive][Ubuntu packages]] for org-mode.
196 ** Contributing to Org-mode
198    You can always contribute with ideas and bug reports on the mailing
199    list.  If you want to contribute a patch, code snippets, or a full
200    add-on, this is very welcome too!  However, I can only make it an
201    official part of Org-mode if you have signed the papers with the
202    Free Software Foundation.  Org-mode is distributed as part of Emacs
203    and must therefore adhere to strict rules about the copyright of
204    all included material.  If this is what you want to do, [[file:request-assign-future.txt][here]] is the
205    form that you have to fill in and send to the FSF.  After you
206    received the final copy with signatures, please scan it and send
207    the scan to the maintainer.
209 ** Future Development
211    Org-mode is still developing fast.  The best way to stay up-to-date
212    is to join the mailing list where the changes are developed and
213    discusssed.
215    Here is a loose [[file:todo.org][list of ideas]] that are still to be processed
216    somehow, when I get to it...
218 * Related Software
220   [[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]].
222