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