Release 6.13
[org-mode.git] / ORGWEBPAGE / index.org
blobd2930f445257bdf274b8c7f79c416a6de67fdccd
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.13) and Compatibility
44 The current version is 6.13.  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 Emacs 23 release is expected
54 to ship with 6.12a. The latest CVS emacs trunk usually contains a
55 fairly recent version, but may lag a bit behind the website release.
57 * Downloads
59 ** The standard distribution
61 Download as [[file:org-6.13.zip][zip file]] or [[file:org-6.13.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 Some more information about this can be found in the [[http://orgmode.org/worg/org-faq.php][FAQ]], under
76 /How can I keep current with Org mode development?/.
78 ** Alternative distributions
80    There are several alternative distrbutions of Org:
82    - The [[http://savannah.gnu.org/cvs/%3Fgroup%3Demacs][Emacs CVS]] contains a recent version
83    - There is also a package on [[http://aur.archlinux.org/packages.php?do_Details&ID=18206][Archlinux]], by Jiyunatori.
84    - The [[http://packages.debian.org/sid/main/org-mode][Debian package]] is maintainned by Sebastien Delafond
85    - The [[http://pdb.finkproject.org/pdb/package.php/org-mode][Fink package]] for Mac OS X by Jesse Alama
86    - Mark A. Hershberger has made an [[https://launchpad.net/~hexmode/+archive][Ubuntu package]] for Org, but
87      that seems to be out of date.
89 * Documentation
90 ** The Org manual
91    - Read the documentation [[file:manual/index.html][online]].  This is a version consisting of many
92      small files, to save bandwidth.  
93    - If you really need it, you can also have the entire manual in a
94      [[file:org.html][single monolithic file]].
95    - Download the documentation as a  [[file:org.pdf][PDF document]].
96    - There is also a [[http://hpcgi1.nifty.com/spen/index.cgi?OrgMode%2fManual][Japanese translation]] of the manual (version 4.60),
97      produced by Takeshi Okano.
98    - The Org manual is a GNU Manual released under the GFDL.  If you
99      want to redistribute Org with a distribution that does not allow
100      the GFDL to be used, and if you see no other way to resolve this
101      licensing conflict, you must use the special [[file:org_dual_license.texi][dual-license version]]
102      of the manual.
103 ** Reference card
104    - Download the [[file:orgcard.pdf][Refcard]] for org-mode
105    - Kyle Sherman has created a [[file:orgcard.txt][text version]] of the reference card
106      (Org version 6.07).
107 ** The FAQ
108    - The [[http://orgmode.org/worg/org-faq.php][Org Mode FAQ]] is user-editable and is maintained by the [[http://orgmode.org/worg/][Worg
109      project]]. 
111 * Links
113 ** Google Tech Talk
114    Check out the [[file:GoogleTech.org][Google Tech Talk]] about Org-mode.
116 ** Mailing list
118    There is a mailing list for discussion about org-mode.
120    - Subscribe to it at [[http://lists.gnu.org/mailman/listinfo/emacs-orgmode][this webpage]].
121    - Directly [[mailto:emacs-orgmode@gnu.org][send mail to it]].  If you are not subscribed, a moderator
122      will look at the message before passing it through to the
123      list.  If that has happened once, future messages from your email
124      address will get through immediately, even if you remain
125      unsubscribed.
126    - Read the list on [[http://www.gmane.org][Gmane]] through a [[http://news.gmane.org/gmane.emacs.orgmode][web interface]] or with a
127      [[news://news.gmane.org/gmane.emacs.orgmode][newsreader]].
129 #+BEGIN_HTML
130 <li><form method="get" action="http://search.gmane.org/">
131 <input type="text" name="query">
132 <input type="hidden" name="group" value="gmane.emacs.orgmode">
133 <input type="submit" value="Search gmane.emacs.orgmode">
134 </form>
135 #+END_HTML
137 ** Worg - user-driven knowledge-base about org-mode
139 [[http://orgmode.org/worg/][Worg]], created by [[http://www.cognition.ens.fr/~guerry/][Bastien Guerry]], is a setup to allow users to jointly
140 edit a number of Org-mode files containing documentation about
141 Org-mode.  This is something like a wiki, but with the advantage that
142 you do not have to be online to modify a file.  If you'd like to
143 contribute your own setup, screenshots, tutorials etc, please go to
144 [[http://orgmode.org/worg/][the Worg page]], and start from there.
146 ** Tutorials
148    [[http://orgmode.org/worg/org-tutorials/index.php][Tutorials and screencasts]] are maintained by the [[http://orgmode.org/worg][Worg project]].
150 ** Survey
152    In November 2007, Charles Cave organized a survey among Org-mode
153    users.  The answers given in this survey can be found [[file:survey.html][here]].
155 ** GTD & Co
157    [[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
158    other task management systems]].
160 ** Contributing to Org-mode
162    You can always contribute with ideas and bug reports on the mailing
163    list.  If you want to contribute a patch, code snippets, or a full
164    add-on, this is very welcome too!  However, I can only make it an
165    official part of Org-mode if you have signed the papers with the
166    Free Software Foundation.  Org-mode is distributed as part of Emacs
167    and must therefore adhere to strict rules about the copyright of
168    all included material.  If this is what you want to do, [[file:request-assign-future.txt][here]] is the
169    form that you have to fill in and send to the FSF.  After you
170    received the final copy with signatures, please scan it and send
171    the scan to the maintainer.
173 ** Future Development
175    Org-mode is still developing fast.  The best way to stay up-to-date
176    is to join the mailing list where the changes are developed and
177    discussed.
179    Here is a loose [[file:todo.org][list of ideas]] that are still to be processed
180    somehow, when I get to it...
182 ** Related Software
184    [[http://www.emacswiki.org/cgi-bin/wiki][The Emacs Wiki]] has extensive lists of related software in the
185    categories
186    - [[http://www.emacswiki.org/cgi-bin/emacs-en/CategoryOutline][Outline]]
187    - [[http://www.emacswiki.org/cgi-bin/wiki/CategoryHypermedia][Hypermedia]]
188    - [[http://www.emacswiki.org/cgi-bin/wiki/CategoryTables][Tables]]
189    - [[http://www.emacswiki.org/cgi-bin/emacs-en/CategoryPersonalInformationManager][Personal Information Manager]]
190    - [[http://www.emacswiki.org/cgi-bin/emacs-en/CategoryCalendar][Calendar]]
191    - [[http://www.emacswiki.org/cgi-bin/wiki/CategoryTodo][Todo]]
192    - [[http://www.emacswiki.org/cgi-bin/wiki/CategoryTimeTracking][Time tracking]]
193    - [[http://www.emacswiki.org/cgi-bin/wiki/CategoryJournaling][Journaling]]