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