docs/user/links.txt

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