=====================
 Docutils_ Link List
=====================

:Author: Lea Wiemann
:Contact: LeWiemann@gmail.com
:Revision: $Revision: 5562 $
:Date: $Date: 2008-05-20 16:09:51 +0200 (Die, 20 Mai 2008) $
:Copyright: This document has been placed in the public domain.

.. title:: Docutils Links

.. contents::

This document contains links users of Docutils and reStructuredText
may find useful, listed in no particular order.  Many of the project
listed here are hosted in the `Docutils Sandbox`_.  If you have
something to publish, you can get write access, too!

The most current version of this link list can always be found at
http://docutils.sourceforge.net/docs/user/links.html.


Users
-----

This section contains links which are interesting for all users of
Docutils.  All projects listed here are usable by end users in some
way, however please do not expect all of them to run straight out of
the box.

Editors
~~~~~~~

Editors with reStructuredText support and docutils GUIs:

* Emacs `rst mode <http://docutils.sf.net/docutils/tools/editors/emacs>`__.

* `reStructuredText syntax highlighting mode
  <http://www.vim.org/scripts/script.php?script_id=973>`__  for vim.

* `VST <http://skawina.eu.org/mikolaj/vst.html>`__ (Vim reStructured Text)
  is a plugin for Vim7 with folding.

* `rst mode <http://jedmodes.sf.net/mode/rst/>`__ for the 
  `JED <http://www.jedsoft.org/jed/>`__ programmers editor

* Gunnar Schwant's DocFactory_ is a wxPython GUI application for
  Docutils.

* ReSTedit_ by Bill Bumgarner is a Docutils GUI for Mac OS X.


Export 
~~~~~~

Convert reStructuredText to other formats:

* `rst2pdf.py <http://docutils.sf.net/sandbox/rst2pdf>`_ 
  is a front end for the generation of PDF documents from a
  reStructuredText source in one step cleaning up intermediate files.

* **py.rest** from the Codespeak `py Lib scripts`_ converts
  reStructuredText files to HTML and PDF (cleaning up the intermediate
  latex files).  Similar to ``buildhtml.py``, it looks recursively for
  .txt files in the given PATHS.

* odtwriter_ the Open Document Format writer developed by Dave Kuhlman
  produces files that can be processed with OpenOffice and Abiword.

* restxsl_ by Michael Alyn Miller, lets you transform reStructuredText
  documents into XML/XHTML files using XSLT stylesheets.

* rst2ht_ by Oliver Rutherfurd, converts reStructuredText to an .ht
  template, for use with ht2html_.

* htmlnav_ by Gunnar Schwant, is an HTML writer which supports navigation
  bars.

* rst2chm_ by Oliver Rutherfurd, generates Microsoft HTML Help files from
  reStructuredText files.

* `html4strict <http://docutils.sf.net/sandbox/html4strict/>`__
  produces XHTML that strictly conforms to the XHTML 1.0 specification.

* `html4trans <http://docutils.sf.net/sandbox/html4trans/>`__
  produces XHTML conforming to the version 1.0 Transitional DTD that
  contains enough formatting information to be viewed by a lightweight HTML
  browser without CSS support.

* A `simple HTML writer`_ by Bill Bumgarner that doesn't rely on CSS
  (stylesheets).

* An `XSLT script`_ by Ladislav Lhotka enables reStructuredText annotations
  to be included in RELAG NG XML schemas.

* The Docutils interface to PythonPoint_
  by Richard Jones produces PDF presentations using ReportLabs.

* `ManPage Writer`_ by Engelbert Gruber.
  
* `DocBook Writer`_ by Oliver Rutherfurd.


Import
~~~~~~

Convert other formats to reStructuredText:

* sxw2rest_, by Trent W. Buck, converts StarOffice XML Writer (SXW)
  files to reStructuredText.

* xml2rst_, an XSLT stylesheet written by Stefan Merten, converts XML
  dumps of the document tree (e.g. created with rst2xml.py) back to
  reStructuredText.

* xhtml2rest_, written by Antonios Christofides, is a simple utility
  to convert XHTML to reStructuredText.

Extensions
~~~~~~~~~~

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.

* Beni Cherniavsky has written a generic `preprocessing module`_ for
  roles and/or directives and built preprocessors for TeX math for
  both LaTeX and HTML output on top of it.


Related Applications
~~~~~~~~~~~~~~~~~~~~

Applications using docutils/reStructuredText, helper applications:

* For Wikis, please see the `FAQ entry about Wikis`_.

* For Blogs (Weblogs), please see the `FAQ entry about Blogs`_.

* PyLit_ provides a bidirectional text <--> code converter for *literate
  programming with reStructuredText*.

* Pandoc_ is a document converter; it can read Markdown and (subsets
  of) reStructuredText, HTML, and LaTeX, and it can write Markdown,
  reStructuredText, HTML, LaTeX, RTF, DocBook XML, and S5.

* rest2web_, by Michael Foord, is a tool for creating web sites with
  reStructuredText.

* There is an `ASCII art to SVG converter`_ (aafigure), developed by
  Chris Liechti.

* ZReST_, by Richard Jones, is a "ReStructuredText Document for Zope"
  application that is complete and ready to install.

* Beni Cherniavsky maintains a Makefile_ for driving Docutils, hoping
  to handle everything one might do with Docutils.



API Developers
--------------

This section contains links which are primarily interesting for
developers who use the Docutils API from within their own
applications.

* Nabu_, written by Martin Blais, is a publishing system which
  extracts information from reStructuredText documents and stores it
  in a database.  Python knowledge is required to write extractor
  functions (see `Writing an Extractor`_) and to retrieve the data
  from the database again.

* There is a `pickle writer`_, written by Martin Blais.


Core Developers
---------------

Links primarily interesting for developers who work with the Docutils
code base.

* PySource_, by Tony Ibbs, is an experimental Python source Reader.
  There is some related code in David Goodger's sandbox
  (pysource_reader_) and a `Python Source Reader`_ document.


.. _Docutils: http://docutils.sourceforge.net/
.. _FAQ entry about Wikis: http://docutils.sf.net/FAQ.html#are-there-any-wikis-that-use-restructuredtext-syntax
.. _FAQ entry about Blogs: http://docutils.sf.net/FAQ.html#are-there-any-weblog-blog-projects-that-use-restructuredtext-syntax
.. _py Lib scripts: http://codespeak.net/py/dist/bin.html
.. _PyLit: http://pylit.berlios.de
.. _Pandoc: http://sophos.berkeley.edu/macfarlane/pandoc/
.. _restxsl: http://www.strangeGizmo.com/products/restxsl/
.. _XSLT script: http://www.cesnet.cz/doc/techzpravy/2006/rngrest/
.. _ReSTedit: http://www.friday.com/bbum/index.php?s=restedit
.. _ASCII art to SVG converter: http://docutils.sf.net/sandbox/cliechti/aafigure/
.. _LaTeX math for reST:
   http://docutils.sourceforge.net/sandbox/jensj/latex_math/
.. _sxw2rest: http://twb.ath.cx/~twb/darcs/sxw2rest/
.. _xml2rst: http://www.merten-home.de/FreeSoftware/xml2rst/index.html
.. _rst2ht: http://www.rutherfurd.net/articles/rst-ht2html.html
.. _ht2html: http://ht2html.sourceforge.net/
.. _htmlnav: http://docutils.sf.net/sandbox/gschwant/htmlnav/
.. _xhtml2rest: http://docutils.sf.net/sandbox/wiemann/xhtml2rest/
.. _rst2chm: http://www.rutherfurd.net/software/rst2chm/
.. _rest2web: http://www.voidspace.org.uk/python/rest2web/
.. _Docutils Sandbox: http://docutils.sf.net/sandbox/README.html
.. _ZReST: http://docutils.sf.net/sandbox/richard/ZReST/
.. _PySource: http://docutils.sf.net/sandbox/tibs/pysource/
.. _pysource_reader: http://docutils.sf.net/sandbox/davidg/pysource_reader/
.. _Python Source Reader: http://docutils.sf.net/docs/dev/pysource.html
.. _PythonPoint: http://docutils.sf.net/sandbox/richard/pythonpoint/
.. _Manpage Writer: http://docutils.sf.net/sandbox/manpage-writer/
.. _ReportLabs/PDF Writer: http://docutils.sf.net/sandbox/dreamcatcher/rlpdf/
.. _DocBook Writer: http://docutils.sf.net/sandbox/oliverr/docbook/
.. _DocFactory: http://docutils.sf.net/sandbox/gschwant/docfactory/doc/
.. _odtwriter: http://docutils.sf.net/sandbox/dkuhlman/OpenDocument/README.html
.. _simple HTML writer: http://docutils.sf.net/sandbox/bbum/DocArticle/
.. _preprocessing module: http://docutils.sf.net/sandbox/cben/rolehack/
.. _Makefile: http://docutils.sf.net/sandbox/cben/make/
.. _Nabu: http://furius.ca/nabu/
.. _Writing an Extractor: http://furius.ca/nabu/doc/nabu-extractor.html
.. _pickle writer: http://docutils.sf.net/sandbox/blais/pickle_writer/
