261 lines
13 KiB
Org Mode
261 lines
13 KiB
Org Mode
|
|
#+TITLE: Org-Mode: Your Life in Plain Text
|
|
#+LANGUAGE: en
|
|
#+EMAIL: carsten at orgmode dot org
|
|
#+OPTIONS: H:3 num:nil toc:2 \n:nil @:t ::t |:t ^:t *:t TeX:t author:nil <:t LaTeX:t
|
|
#+STYLE: <base href="http://orgmode.org/index.html" />
|
|
#+STYLE: <link rel="stylesheet" href="http://orgmode.org/org.css" type="text/css" />
|
|
|
|
|
|
|
|
#+begin_html
|
|
<!-- The logo links to the root of the website -->
|
|
<a href="/"><img src="http://orgmode.org/img/org-mode-unicorn.png" class="logo-link" /></a>
|
|
#+end_html
|
|
|
|
#*Org - an Emacs Mode for Notes, Project Planning, and Authoring*
|
|
#+begin_html
|
|
<table>
|
|
<tr>
|
|
<td style="vertical-align:middle;">
|
|
<b>Org - an Emacs Mode for Notes, Project Planning, and Authoring</b>
|
|
<br/><br/>
|
|
Org-mode is for keeping notes, maintaining ToDo lists, doing project
|
|
planning, and authoring with a fast and effective plain-text
|
|
system.
|
|
</td>
|
|
</table>
|
|
</br> </br>
|
|
#+end_html
|
|
|
|
#+begin_html
|
|
<table width="750px">
|
|
<tr>
|
|
<td><br><img src="http://orgmode.org/img/tasks.png"
|
|
style="border:1px solid black; width:500px"
|
|
alt="http://orgmode.org/img/tasks.png"/>
|
|
</td>
|
|
|
|
<td>
|
|
<table width="220px">
|
|
<tr><td><h3 style="text-align:center;vertical-align:bottom;">Shirts and Donations</h3></td></tr>
|
|
<tr>
|
|
<td><a href="http://orgmode.org/img/shirts.jpg">
|
|
<img src="http://orgmode.org/img/shirts.jpg"
|
|
style="border:1px solid black; width:200px"
|
|
alt="http://orgmode.org/img/shirts.jpg" /></a>
|
|
<span style="font-size: 90%;"></br>
|
|
<div style="margin-top:10px;">
|
|
|
|
|
|
Promote Org-mode and support its development by
|
|
getting your Org-mode T-shirt, bag, or mug in either
|
|
the
|
|
<a href="http://orgmode.spreadshirt.com">US-Shop</a>
|
|
or the
|
|
<a href="http://orgmode.spreadshirt.de">EU-Shop</a>
|
|
</span>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td style="vertical-align:bottom;">
|
|
<div style="float:bottom; border:0px solid black;
|
|
padding:0px; vertical-align:bottom; margin-top:5px;">
|
|
<form style="float:right;padding:5px;" name="_xclick"
|
|
action="https://www.paypal.com/cgi-bin/webscr" method="post">
|
|
<div>
|
|
<input type="hidden" name="cmd" value="_xclick" />
|
|
<input type="hidden" name="business" value="carsten.dominik@gmail.com" />
|
|
<input type="hidden" name="item_name" value="Donate to Org-mode" />
|
|
<input type="hidden" name="currency_code" value="USD" />
|
|
<input type="hidden" name="lc" value="US"/>
|
|
<input type="hidden" name="amount" />
|
|
<input type="image" style="text-align:right;margin-left:auto;margin-right:0px;border-style:none;"
|
|
src="http://www.paypal.com/en_US/i/btn/x-click-but04.gif"
|
|
name="submit"
|
|
alt="Make payments with PayPal - it's fast, free and secure!" />
|
|
</div>
|
|
</form>
|
|
<span style="font-size: 90%;margin-top:10px;">
|
|
... or by making a direct donation.</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</table>
|
|
#+end_html
|
|
|
|
- Simplicity :: At its core, Org-mode is a simple outliner for
|
|
note-taking and list management. You can learn the basics for
|
|
using it in [[http://orgmode.org/worg/org-tutorials/orgtutorial_dto.php][five minutes]]. This may be all you need, and Org-mode
|
|
will not impose more complex features on you.
|
|
- Portability :: Org files are [[http://en.wikipedia.org/wiki/Plain_text][plain text]]. You can view and edit them
|
|
in any editor, or add and extract data with custom-made scripts.
|
|
Your data will never be locked into an obscure or proprietary
|
|
data format. Org-mode runs in [[http://www.gnu.org/software/emacs/][Emacs]], which is available for
|
|
nearly every platform.
|
|
- Depth :: Org-mode will not let you down when you need more than a
|
|
simple outline. The full feature set is both broad and deep,
|
|
easy to access, but unobtrusive. The [[http://orgmode.org/worg/org-faq.php][typical answer]] to "/Can it
|
|
do X?/" is "/Yes!/".
|
|
- Flexibility :: Org-mode is like a Swiss army knife. People use it
|
|
for [[http://members.optusnet.com.au/~charles57/GTD/orgmode.html][Getting Things Done (GTD)]], as a [[http://www.newartisans.com/blog_files/org.mode.day.planner.php][Day Planner]], as a [[http://sachachua.com/wp/2008/01/18/outlining-your-notes-with-org/][Notebook]],
|
|
for Web and PDF [[http://orgmode.org][Authoring]], and much more.
|
|
- Support :: Org-mode is [[http://orgmode.org/manual/index.html][documented extensively]], and many [[http://orgmode.org/worg/org-tutorials/index.php][tutorials]]
|
|
put spotlights on particular features. Org-mode is supported by
|
|
an active [[id:0B280B26-A3AB-4E5C-B4EE-B7FFC52C4D26][mailing list]] where questions are answered quickly and
|
|
effectively.
|
|
- It's free! :: Org is [[http://en.wikipedia.org/wiki/Open-source_software][open source software]], it is [[http://www.gnu.org/licenses/licenses.html#GPL][free]], like Emacs.
|
|
|
|
|
|
If you'd like to know what other people have said about Org-mode, take
|
|
a look at our [[http://orgmode.org/worg/org-quotes.php][collected quotes about Org]].
|
|
|
|
* News
|
|
#+ATTR_HTML: style="float:right;"
|
|
[[http://mobileorg.ncogni.to/][http://mobileorg.ncogni.to/images/screenshot-browse.png]]
|
|
|
|
- <2010-11-25 Thu>: Maybe the times where Org mode could change
|
|
hard-core vi users into honorable Emacs users are coming to an end?
|
|
A [[https://github.com/hsitz/VimOrganizer][Vim clone of Org]] mode is be written by Herbert Sitz, and judging
|
|
by the [[http://vimeo.com/17182850][videos]] it looks promising.
|
|
- <2010-06-06 Sun>: iPhone App [[http://mobileorg.ncogni.to/][MobileOrg]] version 1.5 introduces
|
|
encryption.
|
|
- <2010-10-27 Wed>: Release 7.02
|
|
- <2010-09-24 Fri>: FLOSS Weekly [[http://twit.tv/floss136][interview]] with Carsten available
|
|
- <2010-04-06 Tue>: Release 7.01
|
|
|
|
* Current Version (7.4)
|
|
|
|
The current version is 7.4. To see what has changed in recent
|
|
releases, check this detailed list of [[file:Changes.html][user-visible changes]].
|
|
|
|
This package works on Emacs 23 and 22, and (with minor restrictions)
|
|
on XEmacs 21. Emacs 22.2 ships with Org-mode version 4.67d, Emacs
|
|
23.1 with 6.21b. 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 [[file:org-7.4.zip][zip file]] or [[file:org-7.4.tar.gz][gzipped tar archive]]. These archives contain
|
|
both the Lisp file org.el and the documentation in PDF and (TeX)Info
|
|
formats. Follow the instructions for [[http://orgmode.org/manual/Installation.html#Installation][Installation]] and [[http://orgmode.org/manual/Activation.html#Activation][Activation]].
|
|
|
|
** 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 [[http://repo.or.cz/w/org-mode.git][browsable
|
|
online]]. At any time you can get a [[http://repo.or.cz/w/org-mode.git/snapshot][snapshot]] of the files in it. To
|
|
get a local clone of the repository 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 [[http://orgmode.org/worg/org-faq.php][FAQ]], under [[http://orgmode.org/worg/org-faq.php#keeping-current-with-Org-mode-development][How do
|
|
I keep current with Org mode development?]]. For people who cannot use
|
|
git, we provide [[file:org-latest.zip][zip]] or [[file:org-latest.tar.gz][tar.gz]] snapshot release files updated each day
|
|
and corresponding to the latest git version. Alternatively, you can
|
|
also download a [[http://repo.or.cz/w/org-mode.git/snapshot][tar.gz snapshot]] from the repo.or.cz server.
|
|
|
|
** Alternative distributions
|
|
|
|
There are several alternative distributions of Org. Some of these
|
|
are more up-to-date than others, so check if this package really
|
|
has a recent version
|
|
|
|
- The [[http://packages.debian.org/sid/main/org-mode][Debian package]] is maintained by Sebastien Delafond.
|
|
- There is also a package on [[http://aur.archlinux.org/packages.php?do_Details&ID=18206][Archlinux]], by Jiyunatori.
|
|
- The [[http://savannah.gnu.org/cvs/%3Fgroup%3Demacs][Emacs CVS]] contains a more-or-less recent version.
|
|
- The [[http://pdb.finkproject.org/pdb/package.php/org-mode][Fink package]] for Mac OS X by Jesse Alama.
|
|
- The [[https://launchpad.net/~hexmode/+archive][Ubuntu package]] by Mark A. Hershberger.
|
|
|
|
* Documentation
|
|
** The Org guide and manual
|
|
- Read the [[file:guide/index.html][online compact guide]] or download it as a [[file:orgguide.pdf][PDF document]].
|
|
The compact guide is a 40-page introduction to Org mode. It
|
|
covers all features in a basic way and has links to in-depth
|
|
documentation in the manual and on the web.
|
|
- Read the [[file:manual/index.html][online manual]]. The manual covers the complete feature
|
|
set with all the bells and whistles, in a systematic way. The
|
|
main structure is identical to the guide, so it is easy to go
|
|
back and forth between basic and advanced documentation.
|
|
- You can also have the entire manual in a [[file:org.html][single monolithic file]].
|
|
- Download the manual as a 200-page [[file:org.pdf][PDF document]].
|
|
- Translations of the manual
|
|
- A [[http://hpcgi1.nifty.com/spen/index.cgi?OrgMode%2fManual][Japanese translation]] of an older version (4.60), by Takeshi
|
|
Okano.
|
|
- A [[http://gnu.manticore.es/manual-org-emacs][Spanish translation]] (version 6.21b).
|
|
|
|
** Reference card
|
|
- Download the [[file:orgcard.pdf][Refcard]] for org-mode
|
|
- There is also a [[file:orgcard.txt][text version]] of the
|
|
reference card.
|
|
** The FAQ
|
|
- The [[http://orgmode.org/worg/org-faq.php][Org Mode FAQ]] is user-editable and is maintained by the [[http://orgmode.org/worg/][Worg
|
|
project]].
|
|
|
|
** Tutorials
|
|
- A complete list of [[http://orgmode.org/worg/org-tutorials/index.php][Tutorials and screencasts]] is maintained by the
|
|
[[http://orgmode.org/worg][Worg project]].
|
|
|
|
* Links
|
|
|
|
** Talks about Org-mode
|
|
Check out the [[file:talks/index.html#sec-1][Google Tech Talk]] about Org-mode, or another talk
|
|
given at the [[file:talks/index.html#sec-2][Max Planck Institute for Neurological Research]]. On
|
|
FLOSS Weekly [[http://twit.tv/floss136][show number 136]] Randal Schwartz interviews Carsten
|
|
about Org mode.
|
|
** Mailing list
|
|
:PROPERTIES:
|
|
:ID: 0B280B26-A3AB-4E5C-B4EE-B7FFC52C4D26
|
|
:END:
|
|
|
|
There is a mailing list for discussion about org-mode.
|
|
|
|
- [[http://lists.gnu.org/mailman/listinfo/emacs-orgmode][Subscribe to it]] at the web interface.
|
|
- Directly [[mailto:emacs-orgmode@gnu.org][send mail to it]]. If you are not subscribed, a moderator
|
|
will look at the message before passing it through to the list.
|
|
- Read the list on [[http://www.gmane.org][Gmane]] through a [[http://news.gmane.org/gmane.emacs.orgmode][web interface]] or with a
|
|
[[news://news.gmane.org/gmane.emacs.orgmode][newsreader]].
|
|
- Please read the [[http://orgmode.org/manual/Feedback.html][Feedback]] section of Org's manual before posting a
|
|
question, it helps getting useful answer. [[http://www.catb.org/esr/faqs/smart-questions.html][How To Ask Questions
|
|
The Smart Way]], by E. S. Raymond is also worth reading.
|
|
|
|
|
|
#+BEGIN_HTML
|
|
</li><li><form method="get" action="http://search.gmane.org/"><div>
|
|
<input type="text" name="query" />
|
|
<input type="hidden" name="group" value="gmane.emacs.orgmode" />
|
|
<input type="submit" value="Search gmane.emacs.orgmode" />
|
|
</div></form>
|
|
#+END_HTML
|
|
|
|
** MobileOrg
|
|
[[http://mobileorg.ncogni.to/][MobileOrg]] is an excellent open source application to read and
|
|
change Org-files on the road, using an iPhone, and then sync the
|
|
changes back to your computer. Check out Richard's [[http://mobileorg.ncogni.to/][page]].
|
|
|
|
Matt Jones is currently developing a compatible application for
|
|
Android, and this project is [[http://wiki.github.com/matburt/mobileorg-android/][hosted here]].
|
|
** Worg
|
|
|
|
[[http://orgmode.org/worg/][Worg]], created by [[http://www.cognition.ens.fr/~guerry/][Bastien Guerry]], is a setup to allow users to jointly
|
|
edit a number of Org-mode files containing documentation about
|
|
Org-mode, including the [[http://orgmode.org/worg/org-faq.php][Org Mode FAQ]] and [[http://orgmode.org/worg/org-tutorials/index.php][Tutorials]]. Worg is similar
|
|
to a wiki in that allows community to edit the contents. However,
|
|
since it uses a distributed version control system, you do not have to
|
|
be online while editing it. If you'd like to contribute to Worg,
|
|
please go to [[http://orgmode.org/worg/][the Worg page]], and start from there.
|
|
|
|
** 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! Detailed information on how and
|
|
what to contribute can be found [[http://orgmode.org/worg/org-contribute.php][here]].
|
|
|