From f245cbee666c5027d6337e37cf5a6e6067c23c9f Mon Sep 17 00:00:00 2001 From: milde Date: Wed, 3 Jul 2013 09:39:52 +0000 Subject: Documentation update (links and tools). git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk/docutils@7677 929543f6-e4f2-0310-98a6-ba3bd3dd1d04 --- FAQ.txt | 2 ++ docs/user/links.txt | 16 ++++++++++------ docs/user/tools.txt | 12 +++++++++++- 3 files changed, 23 insertions(+), 7 deletions(-) diff --git a/FAQ.txt b/FAQ.txt index 5d180eac9..df1dadec9 100644 --- a/FAQ.txt +++ b/FAQ.txt @@ -447,6 +447,8 @@ order: * `Firedrop `__ * `PyBloxsom `__ * `Lino WebMan `__ +* `Pelican `__ + (also listed `on PyPi `__) Please `let us know`_ of any other reStructuredText Blogs. diff --git a/docs/user/links.txt b/docs/user/links.txt index 43fe37ebe..2da1135ea 100644 --- a/docs/user/links.txt +++ b/docs/user/links.txt @@ -113,8 +113,8 @@ HTML variants created to translate the Python_ documentation, and is now `used by `__ a wide choice of projects. - Generates web sites (interlinked and indexed HTML pages) and/or PDF - from a set of rst source files. + It can generate complete web sites (interlinked and indexed HTML pages) + and/or PDF from a set of rst source files. * rst2ht_ by Oliver Rutherfurd, converts reStructuredText to an .ht template, for use with ht2html_. @@ -149,9 +149,11 @@ Others * restxsl_ by Michael Alyn Miller, lets you transform reStructuredText documents into XML/XHTML files using XSLT stylesheets. -* An `XSLT script`_ by Ladislav Lhotka enables reStructuredText annotations +* An `XSLT script`__ by Ladislav Lhotka enables reStructuredText annotations to be included in RELAG NG XML schemas. + __ http://www.cesnet.cz/doc/techzpravy/2006/rngrest/ + * `DocBook Writer`_ by Oliver Rutherfurd. * Nabu_, written by Martin Blais, is a publishing system which @@ -170,7 +172,10 @@ Others * For `confluence CMS`_ see https://github.com/cweiske/rst2confluence. -* Deploying into wikis might be aided by https://github.com/netresearch/deploy-rst. +* Deploying into wikis might be aided by deploy-rst__. + + __ https://github.com/netresearch/deploy-rst + Import ------ @@ -224,7 +229,7 @@ More extensions are in the `Docutils Sandbox`_. * zot4rst_ by Erik Hetzner is an extension that allows users to write reST documents using citations from a Zotero_ library. -* Quick and easy publishing reStructuredText source files as blog posts +* Quick and easy publishing reStructuredText source files as blog posts on blogger.com is possible with `rst2blogger`_ . Related Applications @@ -285,7 +290,6 @@ Presentations .. _PyLit: http://pylit.berlios.de .. _Pandoc: http://sophos.berkeley.edu/macfarlane/pandoc/ .. _restxsl: http://www.strangeGizmo.com/products/restxsl/ -.. _XSLT script: http://www.cesnet.cz/doc/techzpravy/2006/rngrest/ .. _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: diff --git a/docs/user/tools.txt b/docs/user/tools.txt index 110a8a49b..c7d7be4a9 100644 --- a/docs/user/tools.txt +++ b/docs/user/tools.txt @@ -301,7 +301,10 @@ rst2xml.py The ``rst2xml.py`` front end produces Docutils-native XML output. This can be transformed with standard XML tools such as XSLT -processors into arbitrary final forms. +processors into arbitrary final forms. An example is the xml2rst_ processor +in the Docutils sandbox. + +.. _xml2rst: ../../../sandbox/xml2rst ODF/OpenOffice-Generating Tools @@ -324,7 +327,14 @@ about how to use ``rst2odt.py``, the styles used ``rst2odt.py``, etc from `Odt Writer for Docutils `_. +reStructuredText-Generating Tools +================================= + +Currently, there is no reStructuredText writer in Docutils and therefore +an ``rst2rst.py`` tool is still missing. +To generate reStructuredText documents with Docutils, you can use +the XML (Docutils native) writer and the xml2rst_ processor. Testing/Debugging Tools -- cgit v1.2.1