ORGWEBPAGE/index.org

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