From 763f19d1a33fa750659b1a7f08dc69da9df82c41 Mon Sep 17 00:00:00 2001 From: milde Date: Thu, 13 Nov 2014 13:40:45 +0000 Subject: [PATCH] Update link list. Move/Sort link targets to sections. git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@7778 929543f6-e4f2-0310-98a6-ba3bd3dd1d04 --- docutils/docs/user/links.txt | 173 +++++++++++++++++++++++++------------------ 1 file changed, 101 insertions(+), 72 deletions(-) diff --git a/docutils/docs/user/links.txt b/docutils/docs/user/links.txt index 33aff7d79..1440fdde9 100644 --- a/docutils/docs/user/links.txt +++ b/docutils/docs/user/links.txt @@ -2,7 +2,7 @@ Docutils_ Link List ===================== -:Author: Lea Wiemann +:Author: Lea Wiemann, the Docutils team :Contact: docutils-develop@lists.sourceforge.net :Revision: $Revision$ :Date: $Date$ @@ -13,13 +13,16 @@ .. contents:: This document contains links users of Docutils and reStructuredText -may find useful. Many of the project +may find useful. Many of the projects listed here are hosted in the `Docutils Sandbox`_. If you have something to publish, you can get write access, too! The most current version of this link list can always be found at http://docutils.sourceforge.net/docs/user/links.html. +.. _Docutils: http://docutils.sourceforge.net/ +.. _Docutils Sandbox: http://docutils.sf.net/sandbox/README.html + Editors ------- @@ -33,7 +36,7 @@ Advanced text editors with reStructuredText support, IDEs, and docutils GUIs: - `reStructuredText syntax highlighting mode `__, - - `VST `__ (Vim + - `VST `__ (Vim reStructuredText) plugin for Vim7 with folding. - `VOoM `__ @@ -63,15 +66,12 @@ Advanced text editors with reStructuredText support, IDEs, and docutils GUIs: * Gunnar Schwant's DocFactory_ is a wxPython GUI application for Docutils. - .. _DocFactory: http://docutils.sf.net/sandbox/gschwant/docfactory/doc/ - * ReSTedit_ by Bill Bumgarner is a Docutils GUI for Mac OS X. * Leo_ is an outliner_, written in Python using PyQt. It can be used as IDE for literal programming, as a filing cabinet holding any kind of data and as `document editor`__ with outlines containing reStructuredText markup. - .. _Leo: http://leoeditor.com/ .. _outliner: http://en.wikipedia.org/wiki/Outliner __ http://webpages.charter.net/edreamleo/rstplugin3.html @@ -79,7 +79,12 @@ Advanced text editors with reStructuredText support, IDEs, and docutils GUIs: with syntax highlighting and PDF/HTML export functionality using Sphinx. * `rsted `_ is a "simple online editor for - reStructuredText on Flask". You can try it on http://rst.ninjs.org/ + reStructuredText on Flask". You can try it on http://rst.ninjs.org/ + +.. _DocFactory: http://docutils.sf.net/sandbox/gschwant/docfactory/doc/ +.. _ReSTedit: http://www.friday.com/bbum/index.php?s=restedit +.. _Leo: http://leoeditor.com/ + Export ------ @@ -108,34 +113,39 @@ PDF `rubber `_ Python wrapper for LaTeX and friends. -* **py.rest** from the Codespeak `py Lib scripts`_ converts +* ``py.rest`` from the Codespeak `py Lib scripts`_ converts reStructuredText files to HTML and PDF (cleaning up the intermediate latex files). Similar to ``buildhtml.py``, it looks recursively for .txt files in the given PATHS. +* rlpdf_ is another PDF Writer based on ReportLabs. + +.. _py Lib scripts: http://codespeak.net/py/dist/bin.html +.. _rlpdf: http://docutils.sf.net/sandbox/dreamcatcher/rlpdf/ + + OpenOffice `````````` -* odtwriter_ the Open Document Format writer developed by Dave Kuhlman - produces files that can be processed with OpenOffice and Abiword. - Since version 0.5, the odtwriter_ it is part of the Docutils_ core. +* Since version 0.5, the odtwriter_ by Dave Kuhlman is part of the Docutils_ + core. +.. _odtwriter: http://docutils.sf.net/docs/user/odt.html -HTML variants -````````````` + +website generators and HTML variants +```````````````````````````````````` * The Sphinx_ Python Documentation Generator by Georg Brandl was originally - created to translate the Python_ documentation, and is now `used by + created to translate the `Python documentation`_, and is now `used by `__ a wide choice of projects. It can generate complete web sites (interlinked and indexed HTML pages) and/or PDF from a set of rst source files. -* Nikola__ static site generator, use restructured text by +* Nikola_ static site generator, use restructured text by default. - __ http://getnikola.com - * rst2ht_ by Oliver Rutherfurd, converts reStructuredText to an .ht template, for use with ht2html_. @@ -159,6 +169,15 @@ HTML variants * A `simple HTML writer`_ by Bill Bumgarner that doesn't rely on CSS (stylesheets). +.. _Sphinx: http://sphinx.pocoo.org/ +.. _nikola: http://getnikola.com/ +.. _rst2ht: http://www.rutherfurd.net/articles/rst-ht2html.html +.. _ht2html: http://ht2html.sourceforge.net/ +.. _htmlnav: http://docutils.sf.net/sandbox/gschwant/htmlnav/ +.. _rst2chm: http://www.rutherfurd.net/software/rst2chm/ +.. _rest2web: http://www.voidspace.org.uk/python/rest2web/ +.. _simple HTML writer: http://docutils.sf.net/sandbox/bbum/DocArticle/ + Others `````` @@ -192,9 +211,17 @@ Others * For `confluence CMS`_ see https://github.com/netresearch/rst2confluence. -* Deploying into wikis might be aided by deploy-rst__. +* Deploying into wikis might be aided by deploy-rst_. - __ https://github.com/netresearch/deploy-rst +.. _Pandoc: http://sophos.berkeley.edu/macfarlane/pandoc/ +.. _restxsl: http://www.strangeGizmo.com/products/restxsl/ +.. _DocBook Writer: http://docutils.sf.net/sandbox/oliverr/docbook/ +.. _Nabu: http://furius.ca/nabu/ +.. _Writing an Extractor: http://furius.ca/nabu/doc/nabu-extractor.html +.. _pickle writer: http://docutils.sf.net/sandbox/blais/pickle_writer/ +.. _Texinfo Writer: http://docutils.sf.net/sandbox/texinfo-writer/README.html +.. _confluence CMS: http://www.atlassian.com/software/confluence +.. _deploy-rst: https://github.com/netresearch/deploy-rst Import @@ -223,6 +250,14 @@ Convert other formats to reStructuredText: There is some related code in David Goodger's sandbox (pysource_reader_) and a `Python Source Reader`_ document. +.. _sxw2rest: http://twb.ath.cx/~twb/darcs/sxw2rest/ +.. _xml2rst: http://www.merten-home.de/FreeSoftware/xml2rst/index.html +.. _xhtml2rest: http://docutils.sf.net/sandbox/wiemann/xhtml2rest/ + +.. _PySource: http://docutils.sf.net/sandbox/tibs/pysource/ +.. _pysource_reader: http://docutils.sf.net/sandbox/davidg/pysource_reader/ +.. _Python Source Reader: http://docutils.sf.net/docs/dev/pysource.html + Extensions ---------- @@ -230,9 +265,6 @@ Extensions Extend the reStructuredText syntax or the features of Docutils. More extensions are in the `Docutils Sandbox`_. -* Jens J. Mortensen developed `LaTeX math for reST`_, which writes to - LaTeX or to MathML. It's included with Docutils since 0.8 (2010-11-05). - * Beni Cherniavsky has written a generic `preprocessing module`_ for roles and/or directives and built preprocessors for TeX math for both LaTeX and HTML output on top of it. @@ -252,6 +284,15 @@ More extensions are in the `Docutils Sandbox`_. * Quick and easy publishing reStructuredText source files as blog posts on blogger.com is possible with `rst2blogger`_ . +.. _preprocessing module: http://docutils.sf.net/sandbox/cben/rolehack/ +.. _Makefile: http://docutils.sf.net/sandbox/cben/make/ +.. _ASCII art to SVG converter: + http://docutils.sf.net/sandbox/cliechti/aafigure/ +.. _zot4rst: http://e6h.org/~egh/hg/zotero-plain +.. _Zotero: http://www.zotero.org/ +.. _rst2blogger: https://github.com/dhellmann/rst2blogger#readme + + Related Applications -------------------- @@ -264,6 +305,11 @@ Applications using docutils/reStructuredText and helper applications. * `Project Gutenberg`_ uses docutils, but with it's own xetex- and nroff-writer and epub. +.. _FAQ entry about Wikis: http://docutils.sf.net/FAQ.html#are-there-any-wikis-that-use-restructuredtext-syntax +.. _FAQ entry about Blogs: http://docutils.sf.net/FAQ.html#are-there-any-weblog-blog-projects-that-use-restructuredtext-syntax +.. _Project Gutenberg: http://www.gutenberg.org + + Development ``````````` @@ -287,6 +333,11 @@ Development multiple manuals per project, filters, project file, collection project file, and more. +.. _Python documentation: http://docs.python.org/ +.. _Trac: http://trac.edgewall.org/ +.. _PyLit: http://pylit.berlios.de +.. _rst2qhc: http://rst2qhc.googlecode.com + CMS Systems ``````````` @@ -295,65 +346,43 @@ CMS Systems * ZReST_, by Richard Jones, is a "ReStructuredText Document for Zope_" application that is complete and ready to install. +.. _Plone: http://plone.org/ +.. _Zope: http://www.zope.org/ +.. _ZReST: http://docutils.sf.net/sandbox/richard/ZReST/ + + Presentations ````````````` -* `native support for S5 `_; +* rst2html5_ transform restructuredtext documents to html5 + twitter's + bootstrap css, deck.js or reveal.js + +* landslide_ generates HTML5 slideshows from markdown, ReST, or textile. + +* `native support for S5 `_. * The `PythonPoint interface`_ by Richard Jones produces PDF presentations using ReportLabs' PythonPoint_. +* rst2beamer_ generates a LaTeX source that uses the `Beamer` document class. + Can be converted to PDF slides with pdfLaTeX/XeLaTeX/LuaLaTeX. + * InkSlide_ quick and easy presentations using Inkscape_. InkSlide uses reStructuredText for markup, although it renders only a subset of rst. -.. _Docutils: http://docutils.sourceforge.net/ -.. _FAQ entry about Wikis: http://docutils.sf.net/FAQ.html#are-there-any-wikis-that-use-restructuredtext-syntax -.. _FAQ entry about Blogs: http://docutils.sf.net/FAQ.html#are-there-any-weblog-blog-projects-that-use-restructuredtext-syntax -.. _py Lib scripts: http://codespeak.net/py/dist/bin.html -.. _PyLit: http://pylit.berlios.de -.. _Pandoc: http://sophos.berkeley.edu/macfarlane/pandoc/ -.. _restxsl: http://www.strangeGizmo.com/products/restxsl/ -.. _ReSTedit: http://www.friday.com/bbum/index.php?s=restedit -.. _ASCII art to SVG converter: http://docutils.sf.net/sandbox/cliechti/aafigure/ -.. _LaTeX math for reST: - http://docutils.sourceforge.net/sandbox/jensj/latex_math/ -.. _sxw2rest: http://twb.ath.cx/~twb/darcs/sxw2rest/ -.. _xml2rst: http://www.merten-home.de/FreeSoftware/xml2rst/index.html -.. _rst2ht: http://www.rutherfurd.net/articles/rst-ht2html.html -.. _ht2html: http://ht2html.sourceforge.net/ -.. _htmlnav: http://docutils.sf.net/sandbox/gschwant/htmlnav/ -.. _Inkscape: http://inkscape.org/ -.. _InkSlide: http://wiki.inkscape.org/wiki/index.php/InkSlide -.. _xhtml2rest: http://docutils.sf.net/sandbox/wiemann/xhtml2rest/ -.. _rst2chm: http://www.rutherfurd.net/software/rst2chm/ -.. _rest2web: http://www.voidspace.org.uk/python/rest2web/ -.. _Docutils Sandbox: http://docutils.sf.net/sandbox/README.html -.. _ZReST: http://docutils.sf.net/sandbox/richard/ZReST/ -.. _PySource: http://docutils.sf.net/sandbox/tibs/pysource/ -.. _pysource_reader: http://docutils.sf.net/sandbox/davidg/pysource_reader/ -.. _Python Source Reader: http://docutils.sf.net/docs/dev/pysource.html -.. _Manpage Writer: http://docutils.sf.net/sandbox/manpage-writer/ -.. _ReportLabs/PDF Writer: http://docutils.sf.net/sandbox/dreamcatcher/rlpdf/ -.. _DocBook Writer: http://docutils.sf.net/sandbox/oliverr/docbook/ -.. _odtwriter: http://docutils.sf.net/docs/user/odt.html -.. _simple HTML writer: http://docutils.sf.net/sandbox/bbum/DocArticle/ -.. _preprocessing module: http://docutils.sf.net/sandbox/cben/rolehack/ -.. _Makefile: http://docutils.sf.net/sandbox/cben/make/ -.. _Nabu: http://furius.ca/nabu/ -.. _Writing an Extractor: http://furius.ca/nabu/doc/nabu-extractor.html -.. _pickle writer: http://docutils.sf.net/sandbox/blais/pickle_writer/ -.. _Sphinx: http://sphinx.pocoo.org/ -.. _Python: http://www.python.org/ -.. _Python documentation: http://docs.python.org/ +* rst2outline_ translates a reStructuredText document to a plain text + outline. This can then be transformed to PowerPoint. + +* Pandoc_ can also be used to produce slides, as shown in this + `Pandoc Slides Demo`_ + .. _PythonPoint: http://www.reportlab.org/python_point.html .. _PythonPoint interface: http://docutils.sf.net/sandbox/richard/pythonpoint/ -.. _rst2qhc: http://rst2qhc.googlecode.com -.. _Plone: http://plone.org/ -.. _Zope: http://www.zope.org/ -.. _Zotero: http://www.zotero.org/ -.. _zot4rst: http://e6h.org/~egh/hg/zotero-plain -.. _Trac: http://trac.edgewall.org/ -.. _Texinfo Writer: http://docutils.sf.net/sandbox/texinfo-writer/README.html -.. _confluence CMS: http://www.atlassian.com/software/confluence -.. _rst2blogger: https://github.com/dhellmann/rst2blogger#readme -.. _Project Gutenberg: http://www.gutenberg.org +.. _rst2beamer: http://docutils.sf.net/sandbox/rst2beamer/ +.. _Inkscape: http://inkscape.org/ +.. _InkSlide: http://wiki.inkscape.org/wiki/index.php/InkSlide +.. _rst2html5: https://github.com/marianoguerra/rst2html5 +.. _landslide: https://github.com/adamzap/landslide +.. _rst2outline: http://docutils.sf.net/sandbox/rst2outline/ +.. _Pandoc Slides Demo: + http://johnmacfarlane.net/pandoc/demo/example9/producing-slide-shows-with-pandoc -- 2.11.4.GIT