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.  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 Editors
  25 -------
  26
  27 Editors with reStructuredText support and docutils GUIs:
  28
  29 * Emacs `rst mode <http://docutils.sf.net/docutils/tools/editors/emacs>`__.
  30
  31 * `reStructuredText syntax highlighting mode
  32   <http://www.vim.org/scripts/script.php?script_id=973>`__  for vim.
  33
  34 * `VST <http://skawina.eu.org/mikolaj/vst.html>`__ (Vim reStructured Text)
  35   is a plugin for Vim7 with folding.
  36
  37 * `VOoM <http://www.vim.org/scripts/script.php?script_id=2657>`__
  38    is a plugin for Vim that emulates two-pane outliner.
  39    Version 4.0b2 added support for reStructuredText.
  40
  41 * `rst mode <http://jedmodes.sf.net/mode/rst/>`__ for the
  42   `JED <http://www.jedsoft.org/jed/>`__ programmers editor.
  43
  44 * Gunnar Schwant's DocFactory_ is a wxPython GUI application for
  45   Docutils.
  46
  47 * ReSTedit_ by Bill Bumgarner is a Docutils GUI for Mac OS X.
  48
  49
  50 Export
  51 ------
  52
  53 Convert reStructuredText to other formats:
  54
  55 PDF
  56 ```
  57
  58 * `rst2pdf (reportlab)
  59   <http://rst2pdf.googlecode.com>`_ is a tool to go
  60   directly from restructured text to PDF, via `reportlab
  61   <http://www.reportlab.org/rl_toolkit.html>`_. No LaTeX installation is
  62   required.
  63
  64 * `rst2pdf (pdflatex)
  65   <http://docutils.sourceforge.net/sandbox/blais/rst2pdf/>`_ by Martin Blais
  66   is a minimal front end producing LaTeX, compiling the LaTeX file, getting
  67   the produced output to the destination location and finally deleting all
  68   the messy temporary files that this process generates.
  69
  70 * `rst2pdf (rubber)
  71   <http://docutils.sf.net/sandbox/rst2pdf/README.html>`_ is
  72   a front end for the generation of PDF documents from a reStructuredText
  73   source via LaTeX in one step cleaning up intermediate files. It uses the
  74   `rubber <http://iml.univ-mrs.fr/~beffara/soft/rubber/>`_ Python wrapper
  75   for LaTeX and friends.
  76
  77 * **py.rest** from the Codespeak `py Lib scripts`_ converts
  78   reStructuredText files to HTML and PDF (cleaning up the intermediate
  79   latex files).  Similar to ``buildhtml.py``, it looks recursively for
  80   .txt files in the given PATHS.
  81
  82 OpenOffice
  83 ``````````
  84
  85 * odtwriter_ the Open Document Format writer developed by Dave Kuhlman
  86   produces files that can be processed with OpenOffice and Abiword.
  87   Since version 0.5, the odtwriter_ it is part of the Docutils_ core.
  88
  89
  90 HTML variants
  91 `````````````
  92
  93 * The Sphinx_ Python Documentation Generator by Georg Brandl was originally
  94   created to translate the Python_ documentation, and is now `used by
  95   <http://sphinx.pocoo.org/examples.html>`__ a wide choice of projects.
  96
  97 * rst2ht_ by Oliver Rutherfurd, converts reStructuredText to an .ht
  98   template, for use with ht2html_.
  99
 100 * htmlnav_ by Gunnar Schwant, is an HTML writer which supports navigation
 101   bars.
 102
 103 * rest2web_, by Michael Foord, is a tool for creating web sites with
 104   reStructuredText.
 105
 106 * rst2chm_ by Oliver Rutherfurd, generates Microsoft HTML Help files from
 107   reStructuredText files.
 108
 109 * `html4strict <http://docutils.sf.net/sandbox/html4strict/>`__
 110   produces XHTML that strictly conforms to the XHTML 1.0 specification.
 111
 112 * `html4trans <http://docutils.sf.net/sandbox/html4trans/>`__
 113   produces XHTML conforming to the version 1.0 Transitional DTD that
 114   contains enough formatting information to be viewed by a lightweight HTML
 115   browser without CSS support.
 116
 117 * A `simple HTML writer`_ by Bill Bumgarner that doesn't rely on CSS
 118   (stylesheets).
 119
 120
 121 Others
 122 ``````
 123
 124 * Pandoc_ is a document converter that can write Markdown, reStructuredText,
 125   HTML, LaTeX, RTF, DocBook XML, and S5.
 126
 127 * restxsl_ by Michael Alyn Miller, lets you transform reStructuredText
 128   documents into XML/XHTML files using XSLT stylesheets.
 129
 130 * An `XSLT script`_ by Ladislav Lhotka enables reStructuredText annotations
 131   to be included in RELAG NG XML schemas.
 132
 133 * `ManPage Writer`_ by Engelbert Gruber.
 134
 135 * `DocBook Writer`_ by Oliver Rutherfurd.
 136
 137 * Nabu_, written by Martin Blais, is a publishing system which
 138   extracts information from reStructuredText documents and stores it
 139   in a database.  Python knowledge is required to write extractor
 140   functions (see `Writing an Extractor`_) and to retrieve the data
 141   from the database again.
 142
 143 * The `pickle writer`_ by Martin Blais pickles the document tree to a binary
 144   string. Later unpickling will allow you to publish with other Writers.
 145
 146
 147 * The `Texinfo Writer`_, by Jon Waltman converts reStructuredText to
 148   Texinfo, the documentation format used by the GNU project and the
 149   Emacs text editor.  Texinfo can be used to produce multiple output
 150   formats, including HTML, PDF, and Info.
 151
 152
 153 Import
 154 ------
 155
 156 Convert other formats to reStructuredText:
 157
 158 * sxw2rest_, by Trent W. Buck, converts StarOffice XML Writer (SXW)
 159   files to reStructuredText.
 160
 161 * xml2rst_, an XSLT stylesheet written by Stefan Merten, converts XML
 162   dumps of the document tree (e.g. created with rst2xml.py) back to
 163   reStructuredText.
 164
 165 * xhtml2rest_, written by Antonios Christofides, is a simple utility
 166   to convert XHTML to reStructuredText.
 167
 168 * Sphinx_ includes a `LaTeX to Rst converter
 169   <http://svn.python.org/projects/doctools/converter/>`__ in its source code
 170   (trimmed to importing the old Python docs).
 171
 172 * Pandoc_ can read Markdown and (subsets of) HTML, and LaTeX and export to
 173   (amongst others) reStructuredText.
 174
 175 * PySource_, by Tony Ibbs, is an experimental Python source Reader.
 176   There is some related code in David Goodger's sandbox
 177   (pysource_reader_) and a `Python Source Reader`_ document.
 178
 179
 180 Extensions
 181 ----------
 182
 183 Extend the reStructuredText syntax or the features of Docutils.
 184 More extensions are in the `Docutils Sandbox`_.
 185
 186 * Jens J. Mortensen developed `LaTeX math for reST`_, which writes to
 187   LaTeX or to MathML. It's included with Docutils > 0.7 (2010-11-05).
 188
 189 * BENI Cherniavsky has written a generic `preprocessing module`_ for
 190   roles and/or directives and built preprocessors for TeX math for
 191   both LaTeX and HTML output on top of it.
 192
 193 * Beni Cherniavsky maintains a Makefile_ for driving Docutils, hoping
 194   to handle everything one might do with Docutils.
 195
 196 * The `ASCII art to SVG converter`_ (aafigure) developed by
 197   Chris Liechti can parse ASCII art images, embedded in reST documents and
 198   output an image. This would mean that simple illustrations could be
 199   embedded as ASCII art in the reST source and still look nice when
 200   converted to e.g. HTML
 201
 202
 203 Related Applications
 204 --------------------
 205
 206 Applications using docutils/reStructuredText and helper applications.
 207
 208 * For Wikis, please see the `FAQ entry about Wikis`_.
 209
 210 * For Blogs (Weblogs), please see the `FAQ entry about Blogs`_.
 211
 212 Development
 213 ```````````
 214
 215 * Sphinx_ extends the ReStructuredText syntax to better support the
 216   documentation of Software projects (but other documents can be written
 217   with it too). Since version 2.6, the `Python documentation`_ is based on
 218   reStructuredText and Sphinx.
 219
 220 * Trac_, a project management and bug/issue tracking system, supports
 221   `using reStructuredText
 222   <http://projects.edgewall.com/trac/wiki/WikiRestructuredText>`__ as an
 223   alternative to wiki markup.
 224
 225 * PyLit_ provides a bidirectional text <--> code converter for *literate
 226   programming with reStructuredText*.
 227
 228 * If you are developing a Qt app, rst2qhc_ lets you generate the whole help
 229   automatically from restructured text. That includes keywords, TOC,
 230   multiple manuals per project, filters, project file, collection project
 231   file, and more.
 232
 233
 234 CMS Systems
 235 ```````````
 236
 237 * Plone_ and Zope_ both support reStructuredText markup.
 238 * ZReST_, by Richard Jones, is a "ReStructuredText Document for Zope_"
 239   application that is complete and ready to install.
 240
 241 Presentations
 242 `````````````
 243
 244 * `native support for S5 <slide-shows.s5.html>`_;
 245
 246 * The `PythonPoint interface`_ by Richard Jones produces PDF
 247   presentations using ReportLabs' PythonPoint_.
 248
 249 * InkSlide_ quick and easy presentations using Inkscape_. InkSlide uses
 250   reStructuredText for markup, although it renders only a subset of rst.
 251
 252 .. _Docutils: http://docutils.sourceforge.net/
 253 .. _FAQ entry about Wikis: http://docutils.sf.net/FAQ.html#are-there-any-wikis-that-use-restructuredtext-syntax
 254 .. _FAQ entry about Blogs: http://docutils.sf.net/FAQ.html#are-there-any-weblog-blog-projects-that-use-restructuredtext-syntax
 255 .. _py Lib scripts: http://codespeak.net/py/dist/bin.html
 256 .. _PyLit: http://pylit.berlios.de
 257 .. _Pandoc: http://sophos.berkeley.edu/macfarlane/pandoc/
 258 .. _restxsl: http://www.strangeGizmo.com/products/restxsl/
 259 .. _XSLT script: http://www.cesnet.cz/doc/techzpravy/2006/rngrest/
 260 .. _ReSTedit: http://www.friday.com/bbum/index.php?s=restedit
 261 .. _ASCII art to SVG converter: http://docutils.sf.net/sandbox/cliechti/aafigure/
 262 .. _LaTeX math for reST:
 263    http://docutils.sourceforge.net/sandbox/jensj/latex_math/
 264 .. _sxw2rest: http://twb.ath.cx/~twb/darcs/sxw2rest/
 265 .. _xml2rst: http://www.merten-home.de/FreeSoftware/xml2rst/index.html
 266 .. _rst2ht: http://www.rutherfurd.net/articles/rst-ht2html.html
 267 .. _ht2html: http://ht2html.sourceforge.net/
 268 .. _htmlnav: http://docutils.sf.net/sandbox/gschwant/htmlnav/
 269 .. _Inkscape: http://inkscape.org/
 270 .. _InkSlide: http://wiki.inkscape.org/wiki/index.php/InkSlide
 271 .. _xhtml2rest: http://docutils.sf.net/sandbox/wiemann/xhtml2rest/
 272 .. _rst2chm: http://www.rutherfurd.net/software/rst2chm/
 273 .. _rest2web: http://www.voidspace.org.uk/python/rest2web/
 274 .. _Docutils Sandbox: http://docutils.sf.net/sandbox/README.html
 275 .. _ZReST: http://docutils.sf.net/sandbox/richard/ZReST/
 276 .. _PySource: http://docutils.sf.net/sandbox/tibs/pysource/
 277 .. _pysource_reader: http://docutils.sf.net/sandbox/davidg/pysource_reader/
 278 .. _Python Source Reader: http://docutils.sf.net/docs/dev/pysource.html
 279 .. _Manpage Writer: http://docutils.sf.net/sandbox/manpage-writer/
 280 .. _ReportLabs/PDF Writer: http://docutils.sf.net/sandbox/dreamcatcher/rlpdf/
 281 .. _DocBook Writer: http://docutils.sf.net/sandbox/oliverr/docbook/
 282 .. _DocFactory: http://docutils.sf.net/sandbox/gschwant/docfactory/doc/
 283 .. _odtwriter: http://docutils.sf.net/docs/user/odt.html
 284 .. _simple HTML writer: http://docutils.sf.net/sandbox/bbum/DocArticle/
 285 .. _preprocessing module: http://docutils.sf.net/sandbox/cben/rolehack/
 286 .. _Makefile: http://docutils.sf.net/sandbox/cben/make/
 287 .. _Nabu: http://furius.ca/nabu/
 288 .. _Writing an Extractor: http://furius.ca/nabu/doc/nabu-extractor.html
 289 .. _pickle writer: http://docutils.sf.net/sandbox/blais/pickle_writer/
 290 .. _Sphinx: http://sphinx.pocoo.org/
 291 .. _Python: http://www.python.org/
 292 .. _Python documentation: http://docs.python.org/
 293 .. _PythonPoint: http://www.reportlab.org/python_point.html
 294 .. _PythonPoint interface: http://docutils.sf.net/sandbox/richard/pythonpoint/
 295 .. _rst2qhc: http://rst2qhc.googlecode.com
 296 .. _Plone: http://plone.org/
 297 .. _Zope: http://www.zope.org/
 298 .. _Trac: http://trac.edgewall.org/
 299 .. _Texinfo Writer: http://docutils.sf.net/sandbox/texinfo-writer/README.html