diff options
author | goodger <goodger@929543f6-e4f2-0310-98a6-ba3bd3dd1d04> | 2010-06-17 20:16:08 +0000 |
---|---|---|
committer | goodger <goodger@929543f6-e4f2-0310-98a6-ba3bd3dd1d04> | 2010-06-17 20:16:08 +0000 |
commit | 2b6cacc46394b98d229a9fac0ec231198a26fe97 (patch) | |
tree | ababad583d33c31073d252cd4ab65f75fa4894e4 /docs/user/emacs.txt | |
parent | e2280c8692b6625a8cfc003bf88cba674c9523d3 (diff) | |
download | docutils-2b6cacc46394b98d229a9fac0ec231198a26fe97.tar.gz |
split out usage section, added info about rst-mode in recent Emacs
git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk/docutils@6346 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docs/user/emacs.txt')
-rw-r--r-- | docs/user/emacs.txt | 37 |
1 files changed, 27 insertions, 10 deletions
diff --git a/docs/user/emacs.txt b/docs/user/emacs.txt index 5d6c16066..6a7503f82 100644 --- a/docs/user/emacs.txt +++ b/docs/user/emacs.txt @@ -56,23 +56,39 @@ reStructuredText_: ``rst.el``. This document describes the features it provides, and how to setup your emacs to use them and how to invoke them. -``rst.el`` can be found in the ``tools/editors/emacs/`` directory of -the snapshot or repository. `A copy can also be downloaded here. -<http://docutils.sourceforge.net/tools/editors/emacs/rst.el>`__ - Installation ============ -The emacs support is implemented as an Emacs major mode (``rst-mode``) -provided by the ``rst.el`` emacs package. In order to use -``rst-mode``, you need to put the ``rst.el`` in a directory located in -your emacs ``load-path`` (use ``C-h v load-path`` to check), and load -it with:: +Emacs support for reStructuredText is implemented as an Emacs major +mode (``rst-mode``) provided by the ``rst.el`` emacs package. + +For recent versions of Emacs, there's no need to install anything to +get reST support; ``rst-mode`` is already available. So:: + + M-x rst-mode + +will work out of the box. If this works for you, please skip to the +Usage_ section. + +For older versions of Emacs, ``rst.el`` can be found in the +``tools/editors/emacs/`` directory of the Docutils snapshot or +repository. `A copy can also be downloaded here. +<http://docutils.sourceforge.net/tools/editors/emacs/rst.el>`__ + +In order to use ``rst-mode``, you need to put the ``rst.el`` in a +directory located in your emacs ``load-path`` (use ``C-h v load-path`` +to check). + + +Usage +===== + +Load rst-mode with:: (require 'rst) -To enable ``rst-mode``, simple type ``M-x rst-mode``. Alternatively, +To enable ``rst-mode``, simply type ``M-x rst-mode``. Alternatively, you can modify ``auto-mode-alist`` to automatically turn it on whenever you visit reStructuredText_ documents:: @@ -117,6 +133,7 @@ decorations and to build the hierarchy of the document. What we call section decorations or adornments are the underlines or under- and overlines used to mark a section title. + Adjusting a Section Title ------------------------- |