summaryrefslogtreecommitdiff
path: root/docutils/docs/user
diff options
context:
space:
mode:
authormilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2011-06-17 10:50:48 +0000
committermilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2011-06-17 10:50:48 +0000
commit07c3091a6af37f15fd81aab89186ad891ccde764 (patch)
treeca25b986cd3d260cff665be42ef50ef8dc4e1cf3 /docutils/docs/user
parentf72e34ac014b47f422bc026ec598dba8979367f7 (diff)
downloaddocutils-07c3091a6af37f15fd81aab89186ad891ccde764.tar.gz
Math directive and documentation update:
Math content can also be given as directive argument. Multiple content block separated by blank lines are put in separate nodes. git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@7056 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docutils/docs/user')
-rw-r--r--docutils/docs/user/config.txt4
-rw-r--r--docutils/docs/user/links.txt17
-rw-r--r--docutils/docs/user/rst/cheatsheet.txt2
3 files changed, 13 insertions, 10 deletions
diff --git a/docutils/docs/user/config.txt b/docutils/docs/user/config.txt
index 425eabd7f..618d20dad 100644
--- a/docutils/docs/user/config.txt
+++ b/docutils/docs/user/config.txt
@@ -779,10 +779,6 @@ _`math_output`
.. _MathPlayer: http://www.dessci.com/en/products/mathplayer/
.. _MathML: http://www.mathweb.org/wiki/MathML
- .. _Using LaTeX syntax for mathematics:
- http://docutils.sf.net/sandbox/jensj/latex_math/docs/latex_math.txt
-
-
_`option_limit`
The maximum width (in characters) for options in option lists.
Longer options will span an entire row of the table used to render
diff --git a/docutils/docs/user/links.txt b/docutils/docs/user/links.txt
index 3154a9102..a8085c8df 100644
--- a/docutils/docs/user/links.txt
+++ b/docutils/docs/user/links.txt
@@ -35,7 +35,7 @@ Editors with reStructuredText support and docutils GUIs:
is a plugin for Vim7 with folding.
* `VOoM <http://www.vim.org/scripts/script.php?script_id=2657>`__
- is a plugin for Vim that emulates two-pane outliner.
+ is a plugin for Vim that emulates two-pane outliner.
Version 4.0b2 added support for reStructuredText.
* `rst mode <http://jedmodes.sf.net/mode/rst/>`__ for the
@@ -97,6 +97,9 @@ HTML variants
created to translate the Python_ documentation, and is now `used by
<http://sphinx.pocoo.org/examples.html>`__ a wide choice of projects.
+ Generates web sites (interlinked and indexed HTML pages) and/or PDF
+ from a set of rst source files.
+
* rst2ht_ by Oliver Rutherfurd, converts reStructuredText to an .ht
template, for use with ht2html_.
@@ -152,7 +155,7 @@ Others
Emacs text editor. Texinfo can be used to produce multiple output
formats, including HTML, PDF, and Info.
-
+
Import
------
@@ -187,7 +190,7 @@ Extend the reStructuredText syntax or the features of Docutils.
More extensions are in the `Docutils Sandbox`_.
* Jens J. Mortensen developed `LaTeX math for reST`_, which writes to
- LaTeX or to MathML. It's included with Docutils > 0.7 (2010-11-05).
+ LaTeX or to MathML. It's included with Docutils since 0.8 (2010-11-05).
* BENI Cherniavsky has written a generic `preprocessing module`_ for
roles and/or directives and built preprocessors for TeX math for
@@ -216,8 +219,10 @@ Development
```````````
* Sphinx_ extends the ReStructuredText syntax to better support the
- documentation of Software projects (but other documents can be written
- with it too). Since version 2.6, the `Python documentation`_ is based on
+ documentation of Software (and other) *projects* (but other documents
+ can be written with it too).
+
+ Since version 2.6, the `Python documentation`_ is based on
reStructuredText and Sphinx.
* Trac_, a project management and bug/issue tracking system, supports
@@ -250,7 +255,7 @@ Presentations
presentations using ReportLabs' PythonPoint_.
* InkSlide_ quick and easy presentations using Inkscape_. InkSlide uses
- reStructuredText for markup, although it renders only a subset of rst.
+ reStructuredText for markup, although it renders only a subset of rst.
.. _Docutils: http://docutils.sourceforge.net/
.. _FAQ entry about Wikis: http://docutils.sf.net/FAQ.html#are-there-any-wikis-that-use-restructuredtext-syntax
diff --git a/docutils/docs/user/rst/cheatsheet.txt b/docutils/docs/user/rst/cheatsheet.txt
index 1ef0788d5..40910deac 100644
--- a/docutils/docs/user/rst/cheatsheet.txt
+++ b/docutils/docs/user/rst/cheatsheet.txt
@@ -96,6 +96,7 @@ contents Generate a table of contents
sectnum Automatically number sections, subsections, etc.
header, footer Create document decorations [0.3.8]
target-notes Create an explicit footnote for each external target
+math Mathematical notation (input in LaTeX format)
meta HTML-specific metadata
include Read an external reST file as if it were inline
raw Non-reST data passed untouched to the Writer
@@ -117,6 +118,7 @@ Role Name Description
================ ============================================================
emphasis Equivalent to *emphasis*
literal Equivalent to ``literal`` but processes backslash escapes
+math Mathematical notation (input in LaTeX format)
PEP Reference to a numbered Python Enhancement Proposal
RFC Reference to a numbered Internet Request For Comments
raw For non-reST data; cannot be used directly (see docs) [0.3.6]