docs/user/links.txt

   1 =====================
   2  Docutils_ Link List
   3 =====================
   4
   5 :Author: Lea Wiemann
   6 :Contact: LeWiemann@gmail.com
   7 :Revision: $Revision$
   8 :Date: $Date$
   9 :Copyright: This document has been placed in the public domain.
  10
  11 .. title:: Docutils Links
  12
  13 .. contents::
  14
  15 This document contains links users of Docutils and reStructuredText
  16 may find useful, listed in no particular order.  Many of the project
  17 listed here are hosted in the `Docutils Sandbox`_.  If you have
  18 something to publish, you can get write access, too!
  19
  20 The most current version of this link list can always be found at
  21 http://docutils.sourceforge.net/docs/user/links.html.
  22
  23
  24 Users
  25 -----
  26
  27 This section contains links which are interesting for all users of
  28 Docutils.  All projects listed here are usable by end users in some
  29 way, however please do not expect all of them to run straight out of
  30 the box.
  31
  32 Editors
  33 ~~~~~~~
  34
  35 Editors with reStructuredText support and docutils GUIs:
  36
  37 * Emacs `rst mode <http://docutils.sf.net/docutils/tools/editors/emacs>`__.
  38
  39 * `reStructuredText syntax highlighting mode
  40   <http://www.vim.org/scripts/script.php?script_id=973>`__  for vim.
  41
  42 * `VST <http://skawina.eu.org/mikolaj/vst.html>`__ (Vim reStructured Text)
  43   is a plugin for Vim7 with folding.
  44
  45 * `rst mode <http://jedmodes.sf.net/mode/rst/>`__ for the
  46   `JED <http://www.jedsoft.org/jed/>`__ programmers editor
  47
  48 * Gunnar Schwant's DocFactory_ is a wxPython GUI application for
  49   Docutils.
  50
  51 * ReSTedit_ by Bill Bumgarner is a Docutils GUI for Mac OS X.
  52
  53
  54 Export
  55 ~~~~~~
  56
  57 Convert reStructuredText to other formats:
  58
  59 * `rst2pdf.py <http://docutils.sf.net/sandbox/rst2pdf>`_
  60   is a front end for the generation of PDF documents from a
  61   reStructuredText source in one step cleaning up intermediate files.
  62
  63 * **py.rest** from the Codespeak `py Lib scripts`_ converts
  64   reStructuredText files to HTML and PDF (cleaning up the intermediate
  65   latex files).  Similar to ``buildhtml.py``, it looks recursively for
  66   .txt files in the given PATHS.
  67
  68 * odtwriter_ the Open Document Format writer developed by Dave Kuhlman
  69   produces files that can be processed with OpenOffice and Abiword.
  70
  71 * restxsl_ by Michael Alyn Miller, lets you transform reStructuredText
  72   documents into XML/XHTML files using XSLT stylesheets.
  73
  74 * rst2ht_ by Oliver Rutherfurd, converts reStructuredText to an .ht
  75   template, for use with ht2html_.
  76
  77 * htmlnav_ by Gunnar Schwant, is an HTML writer which supports navigation
  78   bars.
  79
  80 * rst2chm_ by Oliver Rutherfurd, generates Microsoft HTML Help files from
  81   reStructuredText files.
  82
  83 * `html4strict <http://docutils.sf.net/sandbox/html4strict/>`__
  84   produces XHTML that strictly conforms to the XHTML 1.0 specification.
  85
  86 * `html4trans <http://docutils.sf.net/sandbox/html4trans/>`__
  87   produces XHTML conforming to the version 1.0 Transitional DTD that
  88   contains enough formatting information to be viewed by a lightweight HTML
  89   browser without CSS support.
  90
  91 * A `simple HTML writer`_ by Bill Bumgarner that doesn't rely on CSS
  92   (stylesheets).
  93
  94 * An `XSLT script`_ by Ladislav Lhotka enables reStructuredText annotations
  95   to be included in RELAG NG XML schemas.
  96
  97 * The Docutils interface to PythonPoint_
  98   by Richard Jones produces PDF presentations using ReportLabs.
  99
 100 * `ManPage Writer`_ by Engelbert Gruber.
 101
 102 * `DocBook Writer`_ by Oliver Rutherfurd.
 103
 104
 105 Import
 106 ~~~~~~
 107
 108 Convert other formats to reStructuredText:
 109
 110 * sxw2rest_, by Trent W. Buck, converts StarOffice XML Writer (SXW)
 111   files to reStructuredText.
 112
 113 * xml2rst_, an XSLT stylesheet written by Stefan Merten, converts XML
 114   dumps of the document tree (e.g. created with rst2xml.py) back to
 115   reStructuredText.
 116
 117 * xhtml2rest_, written by Antonios Christofides, is a simple utility
 118   to convert XHTML to reStructuredText.
 119
 120 Extensions
 121 ~~~~~~~~~~
 122
 123 Extend the reStructuredText syntax or the features of docutils.
 124 More extensions are in the `Docutils Sandbox`_.
 125
 126 * Jens J. Mortensen developed `LaTeX math for reST`_, which writes to
 127   LaTeX or to MathML.
 128
 129 * Beni Cherniavsky has written a generic `preprocessing module`_ for
 130   roles and/or directives and built preprocessors for TeX math for
 131   both LaTeX and HTML output on top of it.
 132
 133
 134 Related Applications
 135 ~~~~~~~~~~~~~~~~~~~~
 136
 137 Applications using docutils/reStructuredText, helper applications:
 138
 139 * For Wikis, please see the `FAQ entry about Wikis`_.
 140
 141 * For Blogs (Weblogs), please see the `FAQ entry about Blogs`_.
 142
 143 * PyLit_ provides a bidirectional text <--> code converter for *literate
 144   programming with reStructuredText*.
 145
 146 * Pandoc_ is a document converter; it can read Markdown and (subsets
 147   of) reStructuredText, HTML, and LaTeX, and it can write Markdown,
 148   reStructuredText, HTML, LaTeX, RTF, DocBook XML, and S5.
 149
 150 * rest2web_, by Michael Foord, is a tool for creating web sites with
 151   reStructuredText.
 152
 153 * There is an `ASCII art to SVG converter`_ (aafigure), developed by
 154   Chris Liechti.
 155
 156 * ZReST_, by Richard Jones, is a "ReStructuredText Document for Zope"
 157   application that is complete and ready to install.
 158
 159 * Beni Cherniavsky maintains a Makefile_ for driving Docutils, hoping
 160   to handle everything one might do with Docutils.
 161
 162
 163
 164 API Developers
 165 --------------
 166
 167 This section contains links which are primarily interesting for
 168 developers who use the Docutils API from within their own
 169 applications.
 170
 171 * Nabu_, written by Martin Blais, is a publishing system which
 172   extracts information from reStructuredText documents and stores it
 173   in a database.  Python knowledge is required to write extractor
 174   functions (see `Writing an Extractor`_) and to retrieve the data
 175   from the database again.
 176
 177 * There is a `pickle writer`_, written by Martin Blais.
 178
 179
 180 Core Developers
 181 ---------------
 182
 183 Links primarily interesting for developers who work with the Docutils
 184 code base.
 185
 186 * PySource_, by Tony Ibbs, is an experimental Python source Reader.
 187   There is some related code in David Goodger's sandbox
 188   (pysource_reader_) and a `Python Source Reader`_ document.
 189
 190
 191 .. _Docutils: http://docutils.sourceforge.net/
 192 .. _FAQ entry about Wikis: http://docutils.sf.net/FAQ.html#are-there-any-wikis-that-use-restructuredtext-syntax
 193 .. _FAQ entry about Blogs: http://docutils.sf.net/FAQ.html#are-there-any-weblog-blog-projects-that-use-restructuredtext-syntax
 194 .. _py Lib scripts: http://codespeak.net/py/dist/bin.html
 195 .. _PyLit: http://pylit.berlios.de
 196 .. _Pandoc: http://sophos.berkeley.edu/macfarlane/pandoc/
 197 .. _restxsl: http://www.strangeGizmo.com/products/restxsl/
 198 .. _XSLT script: http://www.cesnet.cz/doc/techzpravy/2006/rngrest/
 199 .. _ReSTedit: http://www.friday.com/bbum/index.php?s=restedit
 200 .. _ASCII art to SVG converter: http://docutils.sf.net/sandbox/cliechti/aafigure/
 201 .. _LaTeX math for reST:
 202    http://docutils.sourceforge.net/sandbox/jensj/latex_math/
 203 .. _sxw2rest: http://twb.ath.cx/~twb/darcs/sxw2rest/
 204 .. _xml2rst: http://www.merten-home.de/FreeSoftware/xml2rst/index.html
 205 .. _rst2ht: http://www.rutherfurd.net/articles/rst-ht2html.html
 206 .. _ht2html: http://ht2html.sourceforge.net/
 207 .. _htmlnav: http://docutils.sf.net/sandbox/gschwant/htmlnav/
 208 .. _xhtml2rest: http://docutils.sf.net/sandbox/wiemann/xhtml2rest/
 209 .. _rst2chm: http://www.rutherfurd.net/software/rst2chm/
 210 .. _rest2web: http://www.voidspace.org.uk/python/rest2web/
 211 .. _Docutils Sandbox: http://docutils.sf.net/sandbox/README.html
 212 .. _ZReST: http://docutils.sf.net/sandbox/richard/ZReST/
 213 .. _PySource: http://docutils.sf.net/sandbox/tibs/pysource/
 214 .. _pysource_reader: http://docutils.sf.net/sandbox/davidg/pysource_reader/
 215 .. _Python Source Reader: http://docutils.sf.net/docs/dev/pysource.html
 216 .. _PythonPoint: http://docutils.sf.net/sandbox/richard/pythonpoint/
 217 .. _Manpage Writer: http://docutils.sf.net/sandbox/manpage-writer/
 218 .. _ReportLabs/PDF Writer: http://docutils.sf.net/sandbox/dreamcatcher/rlpdf/
 219 .. _DocBook Writer: http://docutils.sf.net/sandbox/oliverr/docbook/
 220 .. _DocFactory: http://docutils.sf.net/sandbox/gschwant/docfactory/doc/
 221 .. _odtwriter: http://docutils.sf.net/sandbox/dkuhlman/OpenDocument/README.html
 222 .. _simple HTML writer: http://docutils.sf.net/sandbox/bbum/DocArticle/
 223 .. _preprocessing module: http://docutils.sf.net/sandbox/cben/rolehack/
 224 .. _Makefile: http://docutils.sf.net/sandbox/cben/make/
 225 .. _Nabu: http://furius.ca/nabu/
 226 .. _Writing an Extractor: http://furius.ca/nabu/doc/nabu-extractor.html
 227 .. _pickle writer: http://docutils.sf.net/sandbox/blais/pickle_writer/