Release 6.16a
[org-mode.git] / ORGWEBPAGE / index.org
blobf5669fc9a272d7af1c73c4a87b3d0673c81d174a
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 If you'd like to know what other people have said about Org-mode, take
39 a look at our [[http://orgmode.org/worg/org-quotes.php][collected quotes about Org]].
41 * News
43 - Check out [[http://article.gmane.org/gmane.emacs.orgmode/8547][Russel Adams' presentations]] with the Houston Linux User
44   Group.  This is a two part video with much of the first part about
45   other stuff, but the end of the first part and all of the second is
46   really about Org-mode.
48 - Check out the [[file:GoogleTech.org][Google Tech Talk]] about Org-mode.
50 * Current Version (6.16a) and Compatibility
52 The current version is 6.16a.  To see what has changed in recent
53 releases, check this [[file:Changes.html][list of user-visible changes]].  These descriptions
54 are extensive, to avoid that people will be printing the manual after
55 each incremental release.  If you have an older version of the manual,
56 just check the release notes and you will be up-to-date.
58 This package works on Emacs 23 and 22, and (with minor restrictions)
59 on Emacs 21 and XEmacs 21 (where you must also use
60 /xemacs/noutline.el/ shipped with Org-mode).  The Emacs 22.2 release
61 ships with Org-mode version 4.67d.  The Emacs 23.1 release is expected
62 to ship with 6.16.  The latest CVS emacs trunk usually contains a
63 fairly recent version, but may lag a bit behind the website release.
65 * Downloads
67 ** The standard distribution
69 Download as [[file:org-6.16a.zip][zip file]] or [[file:org-6.16a.tar.gz][gzipped tar archive]].  These archives contain
70 both the Lisp file org.el and the documentation in PDF and (TeX)Info
71 formats.  A shell script to simplify upgrading to the newest release
72 has been posted [[http://www.philfam.co.uk/pete/GTD/org-mode/update-org.sh][here]].
74 ** The development version
76 You can check out the latest Org development version (along with every
77 release we ever had) by using git.  The git repository is [[http://repo.or.cz/w/org-mode.git][browsable
78 online]].  To get a local clone use something like the following (from 
79 the command line....):
81 : git clone git://repo.or.cz/org-mode.git
83 Some more information about this can be found in the [[http://orgmode.org/worg/org-faq.php][FAQ]], under
84 /How can I keep current with Org mode development?/.
86 ** Alternative distributions
88    There are several alternative distrbutions of Org:
90    - The [[http://savannah.gnu.org/cvs/%3Fgroup%3Demacs][Emacs CVS]] contains a recent version
91    - There is also a package on [[http://aur.archlinux.org/packages.php?do_Details&ID=18206][Archlinux]], by Jiyunatori.
92    - The [[http://packages.debian.org/sid/main/org-mode][Debian package]] is maintainned by Sebastien Delafond
93    - The [[http://pdb.finkproject.org/pdb/package.php/org-mode][Fink package]] for Mac OS X by Jesse Alama
94    - Mark A. Hershberger has made an [[https://launchpad.net/~hexmode/+archive][Ubuntu package]] for Org, but
95      that seems to be out of date.
97 * Documentation
98 ** The Org manual
99    - Read the documentation [[file:manual/index.html][online]].  This is a version consisting of many
100      small files, to save bandwidth.  
101    - If you really need it, you can also have the entire manual in a
102      [[file:org.html][single monolithic file]].
103    - Download the documentation as a  [[file:org.pdf][PDF document]].
104    - There is also a [[http://hpcgi1.nifty.com/spen/index.cgi?OrgMode%2fManual][Japanese translation]] of the manual (version 4.60),
105      produced by Takeshi Okano.
106    - The Org manual is a GNU Manual released under the GFDL.  If you
107      want to redistribute Org with a distribution that does not allow
108      the GFDL to be used, and if you see no other way to resolve this
109      licensing conflict, you must use the special [[file:org_dual_license.texi][dual-license version]]
110      of the manual.
111 ** Reference card
112    - Download the [[file:orgcard.pdf][Refcard]] for org-mode
113    - Kyle Sherman has created a [[file:orgcard.txt][text version]] of the reference card
114      (Org version 6.07).
115 ** The FAQ
116    - The [[http://orgmode.org/worg/org-faq.php][Org Mode FAQ]] is user-editable and is maintained by the [[http://orgmode.org/worg/][Worg
117      project]]. 
119 * Links
121 ** Google Tech Talk
122    Check out the [[file:GoogleTech.org][Google Tech Talk]] about Org-mode.
124 ** Mailing list
126    There is a mailing list for discussion about org-mode.
128    - Subscribe to it at [[http://lists.gnu.org/mailman/listinfo/emacs-orgmode][this webpage]].
129    - Directly [[mailto:emacs-orgmode@gnu.org][send mail to it]].  If you are not subscribed, a moderator
130      will look at the message before passing it through to the
131      list.  If that has happened once, future messages from your email
132      address will get through immediately, even if you remain
133      unsubscribed.
134    - Read the list on [[http://www.gmane.org][Gmane]] through a [[http://news.gmane.org/gmane.emacs.orgmode][web interface]] or with a
135      [[news://news.gmane.org/gmane.emacs.orgmode][newsreader]].
137 #+BEGIN_HTML
138 <li><form method="get" action="http://search.gmane.org/">
139 <input type="text" name="query">
140 <input type="hidden" name="group" value="gmane.emacs.orgmode">
141 <input type="submit" value="Search gmane.emacs.orgmode">
142 </form>
143 #+END_HTML
145 ** Worg - user-driven knowledge-base about org-mode
147 [[http://orgmode.org/worg/][Worg]], created by [[http://www.cognition.ens.fr/~guerry/][Bastien Guerry]], is a setup to allow users to jointly
148 edit a number of Org-mode files containing documentation about
149 Org-mode.  This is something like a wiki, but with the advantage that
150 you do not have to be online to modify a file.  If you'd like to
151 contribute your own setup, screenshots, tutorials etc, please go to
152 [[http://orgmode.org/worg/][the Worg page]], and start from there.
154 ** Tutorials
156    [[http://orgmode.org/worg/org-tutorials/index.php][Tutorials and screencasts]] are maintained by the [[http://orgmode.org/worg][Worg project]].
158 ** Survey
160    In November 2007, Charles Cave organized a survey among Org-mode
161    users.  The answers given in this survey can be found [[file:survey.html][here]].
163 ** GTD & Co
165    [[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
166    other task management systems]].
168 ** Contributing to Org-mode
170    You can always contribute with ideas and bug reports on the mailing
171    list.  If you want to contribute a patch, code snippets, or a full
172    add-on, this is very welcome too!  However, I can only make it an
173    official part of Org-mode if you have signed the papers with the
174    Free Software Foundation.  Org-mode is distributed as part of Emacs
175    and must therefore adhere to strict rules about the copyright of
176    all included material.  If this is what you want to do, [[file:request-assign-future.txt][here]] is the
177    form that you have to fill in and send to the FSF.  After you
178    received the final copy with signatures, please scan it and send
179    the scan to the maintainer.
181 ** Future Development
183    Org-mode is still developing fast.  The best way to stay up-to-date
184    is to join the mailing list where the changes are developed and
185    discussed.
187    Here is a loose [[file:todo.org][list of ideas]] that are still to be processed
188    somehow, when I get to it...
190 ** Related Software
192    [[http://www.emacswiki.org/cgi-bin/wiki][The Emacs Wiki]] has extensive lists of related software in the
193    categories
194    - [[http://www.emacswiki.org/cgi-bin/emacs-en/CategoryOutline][Outline]]
195    - [[http://www.emacswiki.org/cgi-bin/wiki/CategoryHypermedia][Hypermedia]]
196    - [[http://www.emacswiki.org/cgi-bin/wiki/CategoryTables][Tables]]
197    - [[http://www.emacswiki.org/cgi-bin/emacs-en/CategoryPersonalInformationManager][Personal Information Manager]]
198    - [[http://www.emacswiki.org/cgi-bin/emacs-en/CategoryCalendar][Calendar]]
199    - [[http://www.emacswiki.org/cgi-bin/wiki/CategoryTodo][Todo]]
200    - [[http://www.emacswiki.org/cgi-bin/wiki/CategoryTimeTracking][Time tracking]]
201    - [[http://www.emacswiki.org/cgi-bin/wiki/CategoryJournaling][Journaling]]