[Emacs-diffs] /srv/bzr/emacs/trunk r106714: text.texi: add a section about Org Mode.

[Bastien Guerry]

------------------------------------------------------------
revno: 106714
committer: Bastien Guerry <address@hidden>
branch nick: trunk
timestamp: Wed 2011-12-21 15:02:38 +0100
message:
  text.texi: add a section about Org Mode.
  
  This section describes general concepts behind Org Mode
  and redirects to the Org Manual when necessary.
modified:
  doc/emacs/text.texi

=== modified file 'doc/emacs/text.texi'
--- a/doc/emacs/text.texi       2011-12-04 16:19:57 +0000
+++ b/doc/emacs/text.texi       2011-12-21 14:02:38 +0000
@@ -21,7 +21,10 @@
 the file contains ordinary text, use Text mode, which customizes Emacs
 in small ways for the syntactic conventions of text.  Outline mode
 provides special commands for operating on text with an outline
-structure.
+structure.  Org mode extends Outline mode and turn Emacs into a
+full-fledged organizer: you can manage TODO lists, store notes and
+publish them in many formats.
+
 @iftex
 @xref{Outline Mode}.
 @end iftex
@@ -70,6 +73,7 @@
 * Case::                Changing the case of text.
 * Text Mode::           The major modes for editing text files.
 * Outline Mode::        Editing outlines.
+* Org Mode::            The Emacs organizer.
 * TeX Mode::            Editing input to the formatter TeX.
 * HTML Mode::           Editing HTML and SGML files.
 * Nroff Mode::          Editing input to the formatter nroff.
@@ -1250,6 +1254,143 @@
 (eval-after-load "outline" '(require 'foldout))
 @end example
 
address@hidden Org Mode
address@hidden Org Mode
address@hidden TAB @r{(Org Mode)}
address@hidden S-TAB @r{(Org Mode)}
address@hidden organizer
address@hidden planner
address@hidden org-mode
address@hidden fold
address@hidden headline
address@hidden M-<up> @r{(Org Mode)}
address@hidden M-<down> @r{(Org Mode)}
address@hidden M-<left> @r{(Org Mode)}
address@hidden M-<right> @r{(Org Mode)}
address@hidden S-M-<up> @r{(Org Mode)}
address@hidden S-M-<down> @r{(Org Mode)}
address@hidden S-M-<left> @r{(Org Mode)}
address@hidden S-M-<right> @r{(Org Mode)}
+
+Org mode extends Outline mode to turn Emacs into an organizer and an
+authoring system.
+
+When editing a file ending with the @file{.org} extension, Emacs
+automatically uses @code{org-mode} as the major mode.  In this mode,
+headlines start with one (or more) leading star(s) and comments start
+with the @code{#} character at the beginning of a line.
+
address@hidden
+* This is the first headline
+** This is a first sub-headline
+* This is the second headline
+
+Some content here.
+
+# Some comment here.
address@hidden example
+
+From here, you can use Org mode as a simple outliner: @key{TAB} on a
+headline will cycle through the various folding states of a subtree,
+and @key{S-TAB} anywhere in the buffer will (un)fold the whole
+structure.
+
+You can also manipulate the structure of your document by moving a
+headline up and down with @key{M-<up>} and @key{M-<down>}, or by
+promoting and demoting a headline with @key{M-<left>} and
address@hidden<left>}.  If you want to act on the whole subtree (i.e. the
+headline and its content, including other headlines), simply add the
address@hidden key and use @key{S-M-<up>}, @key{S-M-<down>},
address@hidden<left>} and @key{S-M-<right>}.
+
+For further details, see @ref{Document Structure,,,org, The Org Manual}.
+
address@hidden
+* Org as an organizer::         Manage TODO lists and agendas
+* Org as an authoring system::  Export to various formats
address@hidden menu
+
address@hidden Org as an organizer
address@hidden Org as an organizer
+
address@hidden TODO keywords
address@hidden C-c C-t @r{(Org Mode)}
address@hidden C-c C-s @r{(Org Mode)}
address@hidden C-c C-d @r{(Org Mode)}
address@hidden org-todo-keywords
address@hidden org-todo
address@hidden org-agenda
address@hidden scheduled
address@hidden deadline
address@hidden agenda
+
+Each headline can be turned into a TODO item calling @code{org-todo}
+with @key{C-c C-t} anywhere on it.  This will add the TODO keyword
address@hidden  Hit @key{C-c C-t} to cycle through the list of available
+TODO keywords: you can configure the variable @code{org-todo-keywords}
+to use your own list of keywords.
+
+Now that you have something to do, let's add a date to it: pressing
address@hidden C-s} on a headline will add @code{SCHEDULED} below it, and
+you will be prompted for a date through the calendar.  @key{C-c C-d}
+has the same effect, except that the item will have a @code{DEADLINE}
+instead.
+
+Now that some TODO items are planned in the current file, add it to
+the list of agenda files with @key{C-c [}.  Calling the interactive
+command @code{org-agenda} will prompt you for what you want to see: a
+list of things to do this week, a list of TODO items with specific
+keywords, etc.
+
+For further details, see @ref{TODO items,,,org, The Org Manual} and
address@hidden and times,,,org, The Org Manual}.
+
address@hidden Org as an authoring system
address@hidden Org as an authoring system
address@hidden export
address@hidden org-export
address@hidden publish
address@hidden code block
address@hidden quote
+
+You may want to format your Org notes nicely and to prepare them for
+export and publication.  Org supports simple text formatting:
+
address@hidden
+- This text is /emphasized/
+- This item uses *a bold font*
+- This text is _underlined_
+- This text uses =a teletype font=
address@hidden example
+
+If a paragraph is a quote or an example, you can use specific
+environments:
+
address@hidden
+#+begin_quote
+``This is a quote.''
+#+end_quote
+
+#+begin_example
+This is an example.
+#+end_example
address@hidden example
+
+These environments will be displayed in a specific way with respect
+to the selected export/publish backend.
+
+To export the current buffer, press the @key{C-c C-e} key anywhere in
+an Org buffer.  Supported export formats include @code{HTML}, address@hidden
+and @file{.odt} (OpenDocument format.)  Depending on your system
+installation, you can also directly export to @code{pdf}.
+
+To export several files at once to a specific directory either locally
+or on the Internet, you will need to define a list of projects through
+the variable @code{org-publish-project-alist}.
+
+For further details, see @ref{Exporting,,,org, The Org Manual} and
address@hidden,,,org, The Org Manual}.
+
 @node TeX Mode
 @section @TeX{} Mode
 @cindex @TeX{} mode