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