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