docs/user/links.txt

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