Release 6.06.
[org-mode.git] / ORGWEBPAGE / index.org
blob605e126991b9ea6d23f952a0f82e67a1be44c43b
2 #+TITLE:     Org-Mode Homepage
3 #+LANGUAGE:  en
4 #+EMAIL:     carsten at orgmode dot org
5 #+OPTIONS:   H:3 num:nil toc:2 \n:nil @:t ::t |:t ^:t *:t TeX:t
7 * Org - an Emacs Mode for Notes and Project Planning
9 #+HTML:  <BASE href="http://orgmode.org/index.html">
11 #+BEGIN_HTML
12 <form action="http://www.google.com/cse" id="cse-search-box">
13   <div>
14     <input type="hidden" name="cx" value="002987994228320350715:2gaddxoioh4" />
15     <input type="hidden" name="ie" value="UTF-8" />
16     <input type="text" name="q" size="31" />
17     <input type="submit" name="sa" value="Search this website" />
18   </div>
19 </form>
20 <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en"></script>
21 #+END_HTML
23 Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
24 project planning with a fast and effective plain-text system.
26 Org-mode develops organizational tasks around NOTES files that contain
27 information about projects as plain text.  Org-mode is implemented on
28 top of outline-mode, which makes it possible to keep the content of
29 large files well structured.  Visibility cycling and structure editing
30 help to work with the tree.  Tables are easily created with a built-in
31 table editor.  Org-mode supports ToDo items, deadlines, time stamps,
32 and scheduling.  It dynamically compiles entries into an agenda.
33 Plain text URL-like links connect to websites, emails, Usenet
34 messages, BBDB entries, and any files related to the projects.  For
35 printing and sharing of notes, an Org-mode file can be exported as a
36 structured ASCII file, HTML, and LaTeX.
38 * News
40 Check out the [[file:GoogleTech.org][Google Tech Talk]] about Org-mode.
42 * Current Version (6.06) and Compatibility
44 The current version is 6.06.  To see what has changed in recent
45 releases, check this [[file:Changes.html][list of user-visible changes]].  These descriptions
46 are extensive, to avoid that people will be printing the manual after
47 each incremental release.  If you have an older version of the manual,
48 just check the release notes and you will be up-to-date.
50 This package works on Emacs 23 and 22, and (with minor restrictions)
51 on Emacs 21 and XEmacs 21 (where you must also use
52 /xemacs/noutline.el/ shipped with Org-mode).  The Emacs 22.2 release
53 ships with Org-mode version 4.67d.  The latest CVS emacs trunk usually
54 contains a fairly recent version, but may lag a bit behind the website
55 release.
57 * Downloads
59 ** The standard distribution
61 Download as [[file:org-6.06.zip][zip file]] or [[file:org-6.06.tar.gz][gzipped tar archive]].  These archives contain
62 both the Lisp file org.el and the documentation in PDF and (TeX)Info
63 formats.  A shell script to simplify upgrading to the newest release
64 has been posted [[http://www.philfam.co.uk/pete/GTD/org-mode/update-org.sh][here]].
66 ** The development version
68 You can check out the latest Org development version (along with every
69 release we ever had) by using git.  The git repository is [[http://repo.or.cz/w/org-mode.git][browsable
70 online]].  To get a local clone use something like the following (from 
71 the command line....):
73 : git clone git://repo.or.cz/org-mode.git
75 ** Alternative distributions
77    There are several alternative distrbutions of Org:
79    - The [[http://savannah.gnu.org/cvs/%3Fgroup%3Demacs][Emacs CVS]] contains a recent version
80    - There is also a package on [[http://aur.archlinux.org/packages.php?do_Details&ID=18206][Archlinux]], by Jiyunatori.
81    - The [[http://packages.debian.org/sid/main/org-mode][Debian package]] is maintainned by Sebastien Delafond
82    - Mark A. Hershberger has made an [[https://launchpad.net/~hexmode/+archive][Ubuntu package]] for Org, but
83      that seems to be out of date.
85 * Documentation
86 ** The Org manual
87    - Read the documentation [[file:manual/index.html][online]].  This is a version consisting of many
88      small files, to save bandwidth.  
89    - If you really need it, you can also have the entire manual in a
90      [[file:org.html][single monolithic file]].
91    - Download the documentation in other formats: [[file:org.pdf][PDF]], [[file:org][Info]], or [[file:org.texi][TeXInfo]].
92    - There is also a [[http://hpcgi1.nifty.com/spen/index.cgi?OrgMode%2fManual][Japanese translation]] of the manual (version 4.60),
93      produced by Takeshi Okano.
94    - The Org manual is a GNU Manual released under the GFDL.  If you
95      want to redistribute Org with a distribution that does not allow
96      the GFDL to be used, and if you see no other way to resolve this
97      licensing conflict, you must use the special [[file:org_dual_license.texi][dual-license version]]
98      of the manual.
99 ** Reference card
100    - Download the [[file:orgcard.pdf][Refcard]] for org-mode
101    - Kyle Sherman has created a [[file:orgcard.txt][text version]] of the reference card
102      (Org version 4.79).
103 ** The FAQ
104    - The [[http://orgmode.org/worg/org-faq.php][Org Mode FAQ]] is user-editable and is maintained by the [[http://orgmode.org/worg/][Worg
105      project]]. 
107 * Links
109 ** Google Tech Talk
110    Check out the [[file:GoogleTech.org][Google Tech Talk]] about Org-mode.
112 ** Mailing list
114    There is a mailing list for discussion about org-mode.
116    - Subscribe to it at [[http://lists.gnu.org/mailman/listinfo/emacs-orgmode][this webpage]].
117    - Directly [[mailto:emacs-orgmode@gnu.org][send mail to it]].  If you are not subscribed, a moderator
118      will look at the message before passing it through to the
119      list.  If that has happened once, future messages from your email
120      address will get through immediately, even if you remain
121      unsubscribed.
122    - Read the list on [[http://www.gmane.org][Gmane]] through a [[http://news.gmane.org/gmane.emacs.orgmode][web interface]] or with a
123      [[news://news.gmane.org/gmane.emacs.orgmode][newsreader]].
125 #+BEGIN_HTML
126 <li><form method="get" action="http://search.gmane.org/">
127 <input type="text" name="query">
128 <input type="hidden" name="group" value="gmane.emacs.orgmode">
129 <input type="submit" value="Search gmane.emacs.orgmode">
130 </form>
131 #+END_HTML
133 ** Worg - user-driven knowledge-base about org-mode
135 [[http://orgmode.org/worg/][Worg]], created by [[http://www.cognition.ens.fr/~guerry/][Bastien Guerry]], is a setup to allow users to jointly
136 edit a number of Org-mode files containing documentation about
137 Org-mode.  This is something like a wiki, but with the advantage that
138 you do not have to be online to modify a file.  If you'd like to
139 contribute your own setup, screenshots, tutorials etc, please go to
140 [[http://orgmode.org/worg/][the Worg page]], and start from there.
142 ** Tutorials
144    [[http://orgmode.org/worg/org-tutorials/index.php][Tutorials and screencasts]] are maintained by the [[http://orgmode.org/worg][Worg project]].
146 ** Survey
148    In November 2007, Charles Cave organized a survey among Org-mode
149    users.  The answers given in this survey can be found [[file:survey.html][here]].
151 ** GTD & Co
153    [[http://orgmode.org/worg/][Worg]] also has a list of links related to using Org for [[http://orgmode.org/worg/org-gtd-etc.php][GTD and
154    other task management systems]].
156 ** Contributing to Org-mode
158    You can always contribute with ideas and bug reports on the mailing
159    list.  If you want to contribute a patch, code snippets, or a full
160    add-on, this is very welcome too!  However, I can only make it an
161    official part of Org-mode if you have signed the papers with the
162    Free Software Foundation.  Org-mode is distributed as part of Emacs
163    and must therefore adhere to strict rules about the copyright of
164    all included material.  If this is what you want to do, [[file:request-assign-future.txt][here]] is the
165    form that you have to fill in and send to the FSF.  After you
166    received the final copy with signatures, please scan it and send
167    the scan to the maintainer.
169 ** Future Development
171    Org-mode is still developing fast.  The best way to stay up-to-date
172    is to join the mailing list where the changes are developed and
173    discussed.
175    Here is a loose [[file:todo.org][list of ideas]] that are still to be processed
176    somehow, when I get to it...
178 ** Related Software
180    [[http://www.emacswiki.org/cgi-bin/wiki][The Emacs Wiki]] has extensive lists of related software in the
181    categories
182    - [[http://www.emacswiki.org/cgi-bin/emacs-en/CategoryOutline][Outline]]
183    - [[http://www.emacswiki.org/cgi-bin/wiki/CategoryHypermedia][Hypermedia]]
184    - [[http://www.emacswiki.org/cgi-bin/wiki/CategoryTables][Tables]]
185    - [[http://www.emacswiki.org/cgi-bin/emacs-en/CategoryPersonalInformationManager][Personal Information Manager]]
186    - [[http://www.emacswiki.org/cgi-bin/emacs-en/CategoryCalendar][Calendar]]
187    - [[http://www.emacswiki.org/cgi-bin/wiki/CategoryTodo][Todo]]
188    - [[http://www.emacswiki.org/cgi-bin/wiki/CategoryTimeTracking][Time tracking]]
189    - [[http://www.emacswiki.org/cgi-bin/wiki/CategoryJournaling][Journaling]]