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   Generates web sites (interlinked and indexed HTML pages) and/or PDF
 117   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 * `DocBook Writer`_ by Oliver Rutherfurd.
 156
 157 * Nabu_, written by Martin Blais, is a publishing system which
 158   extracts information from reStructuredText documents and stores it
 159   in a database.  Python knowledge is required to write extractor
 160   functions (see `Writing an Extractor`_) and to retrieve the data
 161   from the database again.
 162
 163 * The `pickle writer`_ by Martin Blais pickles the document tree to a binary
 164   string. Later unpickling will allow you to publish with other Writers.
 165
 166 * The `Texinfo Writer`_, by Jon Waltman converts reStructuredText to
 167   Texinfo, the documentation format used by the GNU project and the
 168   Emacs text editor.  Texinfo can be used to produce multiple output
 169   formats, including HTML, PDF, and Info.
 170
 171 * For `confluence CMS`_ see https://github.com/cweiske/rst2confluence.
 172
 173 * Deploying into wikis might be aided by https://github.com/netresearch/deploy-rst.
 174
 175 Import
 176 ------
 177
 178 Convert other formats to reStructuredText:
 179
 180 * sxw2rest_, by Trent W. Buck, converts StarOffice XML Writer (SXW)
 181   files to reStructuredText.
 182
 183 * xml2rst_, an XSLT stylesheet written by Stefan Merten, converts XML
 184   dumps of the document tree (e.g. created with rst2xml.py) back to
 185   reStructuredText.
 186
 187 * xhtml2rest_, written by Antonios Christofides, is a simple utility
 188   to convert XHTML to reStructuredText.
 189
 190 * Sphinx_ includes a `LaTeX to Rst converter
 191   <http://svn.python.org/projects/doctools/converter/>`__ in its source code
 192   (trimmed to importing the old Python docs).
 193
 194 * Pandoc_ can read Markdown and (subsets of) HTML, and LaTeX and export to
 195   (amongst others) reStructuredText.
 196
 197 * PySource_, by Tony Ibbs, is an experimental Python source Reader.
 198   There is some related code in David Goodger's sandbox
 199   (pysource_reader_) and a `Python Source Reader`_ document.
 200
 201
 202 Extensions
 203 ----------
 204
 205 Extend the reStructuredText syntax or the features of Docutils.
 206 More extensions are in the `Docutils Sandbox`_.
 207
 208 * Jens J. Mortensen developed `LaTeX math for reST`_, which writes to
 209   LaTeX or to MathML. It's included with Docutils since 0.8 (2010-11-05).
 210
 211 * Beni Cherniavsky has written a generic `preprocessing module`_ for
 212   roles and/or directives and built preprocessors for TeX math for
 213   both LaTeX and HTML output on top of it.
 214
 215 * Beni Cherniavsky maintains a Makefile_ for driving Docutils, hoping
 216   to handle everything one might do with Docutils.
 217
 218 * The `ASCII art to SVG converter`_ (aafigure) developed by
 219   Chris Liechti can parse ASCII art images, embedded in reST documents and
 220   output an image. This would mean that simple illustrations could be
 221   embedded as ASCII art in the reST source and still look nice when
 222   converted to e.g. HTML
 223
 224 * zot4rst_ by Erik Hetzner is an extension that allows users to write reST
 225   documents using citations from a Zotero_ library.
 226
 227 * Quick and easy publishing reStructuredText source files as blog posts
 228   on blogger.com is possible with `rst2blogger`_ .
 229
 230 Related Applications
 231 --------------------
 232
 233 Applications using docutils/reStructuredText and helper applications.
 234
 235 * For Wikis, please see the `FAQ entry about Wikis`_.
 236
 237 * For Blogs (Weblogs), please see the `FAQ entry about Blogs`_.
 238
 239 Development
 240 ```````````
 241
 242 * Sphinx_ extends the ReStructuredText syntax to better support the
 243   documentation of Software (and other) *projects* (but other documents
 244   can be written with it too).
 245
 246   Since version 2.6, the `Python documentation`_ is based on
 247   reStructuredText and Sphinx.
 248
 249 * Trac_, a project management and bug/issue tracking system, supports
 250   `using reStructuredText
 251   <http://projects.edgewall.com/trac/wiki/WikiRestructuredText>`__ as an
 252   alternative to wiki markup.
 253
 254 * PyLit_ provides a bidirectional text <--> code converter for *literate
 255   programming with reStructuredText*.
 256
 257 * If you are developing a Qt app, rst2qhc_ lets you generate the whole help
 258   automatically from reStructuredText. That includes keywords, TOC,
 259   multiple manuals per project, filters, project file, collection project
 260   file, and more.
 261
 262
 263 CMS Systems
 264 ```````````
 265
 266 * Plone_ and Zope_ both support reStructuredText markup.
 267 * ZReST_, by Richard Jones, is a "ReStructuredText Document for Zope_"
 268   application that is complete and ready to install.
 269
 270 Presentations
 271 `````````````
 272
 273 * `native support for S5 <slide-shows.s5.html>`_;
 274
 275 * The `PythonPoint interface`_ by Richard Jones produces PDF
 276   presentations using ReportLabs' PythonPoint_.
 277
 278 * InkSlide_ quick and easy presentations using Inkscape_. InkSlide uses
 279   reStructuredText for markup, although it renders only a subset of rst.
 280
 281 .. _Docutils: http://docutils.sourceforge.net/
 282 .. _FAQ entry about Wikis: http://docutils.sf.net/FAQ.html#are-there-any-wikis-that-use-restructuredtext-syntax
 283 .. _FAQ entry about Blogs: http://docutils.sf.net/FAQ.html#are-there-any-weblog-blog-projects-that-use-restructuredtext-syntax
 284 .. _py Lib scripts: http://codespeak.net/py/dist/bin.html
 285 .. _PyLit: http://pylit.berlios.de
 286 .. _Pandoc: http://sophos.berkeley.edu/macfarlane/pandoc/
 287 .. _restxsl: http://www.strangeGizmo.com/products/restxsl/
 288 .. _XSLT script: http://www.cesnet.cz/doc/techzpravy/2006/rngrest/
 289 .. _ReSTedit: http://www.friday.com/bbum/index.php?s=restedit
 290 .. _ASCII art to SVG converter: http://docutils.sf.net/sandbox/cliechti/aafigure/
 291 .. _LaTeX math for reST:
 292    http://docutils.sourceforge.net/sandbox/jensj/latex_math/
 293 .. _sxw2rest: http://twb.ath.cx/~twb/darcs/sxw2rest/
 294 .. _xml2rst: http://www.merten-home.de/FreeSoftware/xml2rst/index.html
 295 .. _rst2ht: http://www.rutherfurd.net/articles/rst-ht2html.html
 296 .. _ht2html: http://ht2html.sourceforge.net/
 297 .. _htmlnav: http://docutils.sf.net/sandbox/gschwant/htmlnav/
 298 .. _Inkscape: http://inkscape.org/
 299 .. _InkSlide: http://wiki.inkscape.org/wiki/index.php/InkSlide
 300 .. _xhtml2rest: http://docutils.sf.net/sandbox/wiemann/xhtml2rest/
 301 .. _rst2chm: http://www.rutherfurd.net/software/rst2chm/
 302 .. _rest2web: http://www.voidspace.org.uk/python/rest2web/
 303 .. _Docutils Sandbox: http://docutils.sf.net/sandbox/README.html
 304 .. _ZReST: http://docutils.sf.net/sandbox/richard/ZReST/
 305 .. _PySource: http://docutils.sf.net/sandbox/tibs/pysource/
 306 .. _pysource_reader: http://docutils.sf.net/sandbox/davidg/pysource_reader/
 307 .. _Python Source Reader: http://docutils.sf.net/docs/dev/pysource.html
 308 .. _Manpage Writer: http://docutils.sf.net/sandbox/manpage-writer/
 309 .. _ReportLabs/PDF Writer: http://docutils.sf.net/sandbox/dreamcatcher/rlpdf/
 310 .. _DocBook Writer: http://docutils.sf.net/sandbox/oliverr/docbook/
 311 .. _odtwriter: http://docutils.sf.net/docs/user/odt.html
 312 .. _simple HTML writer: http://docutils.sf.net/sandbox/bbum/DocArticle/
 313 .. _preprocessing module: http://docutils.sf.net/sandbox/cben/rolehack/
 314 .. _Makefile: http://docutils.sf.net/sandbox/cben/make/
 315 .. _Nabu: http://furius.ca/nabu/
 316 .. _Writing an Extractor: http://furius.ca/nabu/doc/nabu-extractor.html
 317 .. _pickle writer: http://docutils.sf.net/sandbox/blais/pickle_writer/
 318 .. _Sphinx: http://sphinx.pocoo.org/
 319 .. _Python: http://www.python.org/
 320 .. _Python documentation: http://docs.python.org/
 321 .. _PythonPoint: http://www.reportlab.org/python_point.html
 322 .. _PythonPoint interface: http://docutils.sf.net/sandbox/richard/pythonpoint/
 323 .. _rst2qhc: http://rst2qhc.googlecode.com
 324 .. _Plone: http://plone.org/
 325 .. _Zope: http://www.zope.org/
 326 .. _Zotero: http://www.zotero.org/
 327 .. _zot4rst: http://e6h.org/~egh/hg/zotero-plain
 328 .. _Trac: http://trac.edgewall.org/
 329 .. _Texinfo Writer: http://docutils.sf.net/sandbox/texinfo-writer/README.html
 330 .. _confluence CMS: http://www.atlassian.com/software/confluence
 331 .. _rst2blogger: https://github.com/dhellmann/rst2blogger#readme