8.9 KiB

Raw Blame History

Org-Mode Homepage

Org - an Emacs Mode for Notes and Project Planning
News
Current Version (6.12b) and Compatibility
Downloads
Documentation
Links

Org - an Emacs Mode for Notes and Project Planning

Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing project planning with a fast and effective plain-text system.

Org-mode develops organizational tasks around NOTES files that contain information about projects as plain text. Org-mode is implemented on top of outline-mode, which makes it possible to keep the content of large files well structured. Visibility cycling and structure editing help to work with the tree. Tables are easily created with a built-in table editor. Org-mode supports ToDo items, deadlines, time stamps, and scheduling. It dynamically compiles entries into an agenda. Plain text URL-like links connect to websites, emails, Usenet messages, BBDB entries, and any files related to the projects. For printing and sharing of notes, an Org-mode file can be exported as a structured ASCII file, HTML, and LaTeX.

News

Check out the Google Tech Talk about Org-mode.

Current Version (6.12b) and Compatibility

The current version is 6.12b. To see what has changed in recent releases, check this list of user-visible changes. These descriptions are extensive, to avoid that people will be printing the manual after each incremental release. If you have an older version of the manual, just check the release notes and you will be up-to-date.

This package works on Emacs 23 and 22, and (with minor restrictions) on Emacs 21 and XEmacs 21 (where you must also use xemacs/noutline.el shipped with Org-mode). The Emacs 22.2 release ships with Org-mode version 4.67d. The Emacs 23 release is expected to ship with 6.12a. The latest CVS emacs trunk usually contains a fairly recent version, but may lag a bit behind the website release.

Downloads

The standard distribution

Download as zip file or gzipped tar archive. These archives contain both the Lisp file org.el and the documentation in PDF and (TeX)Info formats. A shell script to simplify upgrading to the newest release has been posted here.

The development version

You can check out the latest Org development version (along with every release we ever had) by using git. The git repository is browsable online. To get a local clone use something like the following (from the command line….):

git clone git://repo.or.cz/org-mode.git

Some more information about this can be found in the FAQ, under How can I keep current with Org mode development?.

Alternative distributions

There are several alternative distrbutions of Org:

The Emacs CVS contains a recent version
There is also a package on Archlinux, by Jiyunatori.
The Debian package is maintainned by Sebastien Delafond
The Fink package for Mac OS X by Jesse Alama
Mark A. Hershberger has made an Ubuntu package for Org, but that seems to be out of date.

Documentation

The Org manual

Read the documentation online. This is a version consisting of many small files, to save bandwidth.
If you really need it, you can also have the entire manual in a single monolithic file.
Download the documentation as a PDF document.
There is also a Japanese translation of the manual (version 4.60), produced by Takeshi Okano.
The Org manual is a GNU Manual released under the GFDL. If you want to redistribute Org with a distribution that does not allow the GFDL to be used, and if you see no other way to resolve this licensing conflict, you must use the special dual-license version of the manual.

Reference card

Download the Refcard for org-mode
Kyle Sherman has created a text version of the reference card (Org version 6.07).

The FAQ

The Org Mode FAQ is user-editable and is maintained by the Worg project.

Links

Google Tech Talk

Check out the Google Tech Talk about Org-mode.

Mailing list

There is a mailing list for discussion about org-mode.

Subscribe to it at this webpage.
Directly send mail to it. If you are not subscribed, a moderator will look at the message before passing it through to the list. If that has happened once, future messages from your email address will get through immediately, even if you remain unsubscribed.
Read the list on Gmane through a web interface or with a newsreader.

Worg - user-driven knowledge-base about org-mode

Worg, created by Bastien Guerry, is a setup to allow users to jointly edit a number of Org-mode files containing documentation about Org-mode. This is something like a wiki, but with the advantage that you do not have to be online to modify a file. If you'd like to contribute your own setup, screenshots, tutorials etc, please go to the Worg page, and start from there.

Tutorials

Tutorials and screencasts are maintained by the Worg project.

Survey

In November 2007, Charles Cave organized a survey among Org-mode users. The answers given in this survey can be found here.

GTD & Co

Worg also has a list of links related to using Org for GTD and other task management systems.

Contributing to Org-mode

You can always contribute with ideas and bug reports on the mailing list. If you want to contribute a patch, code snippets, or a full add-on, this is very welcome too! However, I can only make it an official part of Org-mode if you have signed the papers with the Free Software Foundation. Org-mode is distributed as part of Emacs and must therefore adhere to strict rules about the copyright of all included material. If this is what you want to do, here is the form that you have to fill in and send to the FSF. After you received the final copy with signatures, please scan it and send the scan to the maintainer.

Future Development

Org-mode is still developing fast. The best way to stay up-to-date is to join the mailing list where the changes are developed and discussed.

Here is a loose list of ideas that are still to be processed somehow, when I get to it…

Related Software

The Emacs Wiki has extensive lists of related software in the categories

8.9 KiB Raw Blame History