Menu
▾
▴
[Docutils-checkins] SF.net SVN: docutils:[8874] trunk/docutils
|
From: <mi...@us...> - 2021-11-01 21:50:45
|
Revision: 8874
http://sourceforge.net/p/docutils/code/8874
Author: milde
Date: 2021-11-01 21:50:42 +0000 (Mon, 01 Nov 2021)
Log Message:
-----------
Documentation update/additions.
Remove implemented TODO item.
Add entry for rst2man.py tool.
Modified Paths:
--------------
trunk/docutils/HISTORY.txt
trunk/docutils/docs/dev/todo.txt
trunk/docutils/docs/user/tools.txt
Modified: trunk/docutils/HISTORY.txt
===================================================================
--- trunk/docutils/HISTORY.txt 2021-11-01 21:50:32 UTC (rev 8873)
+++ trunk/docutils/HISTORY.txt 2021-11-01 21:50:42 UTC (rev 8874)
@@ -16,11 +16,11 @@
* docutils/writers/_html_base.py
- - fixed handling of ``footnote_backlinks==False`` (report Alan G Isaac).
+ - Fix handling of ``footnote_backlinks==False`` (report Alan G Isaac).
* docutils/writers/html5_polyglot/math.css
- - fixed typo (bug #432).
+ - Fix typo (bug #432).
Release 0.18 (2021-10-26)
=========================
Modified: trunk/docutils/docs/dev/todo.txt
===================================================================
--- trunk/docutils/docs/dev/todo.txt 2021-11-01 21:50:32 UTC (rev 8873)
+++ trunk/docutils/docs/dev/todo.txt 2021-11-01 21:50:42 UTC (rev 8874)
@@ -68,6 +68,39 @@
.. _Sphinx: http://sphinx.pocoo.org/
+Repository
+==========
+
+Move to a Git repository.
+
+* This is a long standing `feature request`__
+ (with pointers to Sphinx issues and discussion).
+
+ __ https://sourceforge.net/p/docutils/feature-requests/58/
+
+* From a `post by David Goodger`__
+
+ An absolute requirement, for me, is that such a change be complete.
+ We can't lose any data or have to refer to the old system as an
+ "archive". So all the SVN history, all branches, and the full sandbox
+ need to be converted at the same time.
+
+ __ https://sourceforge.net/p/docutils/mailman/message/31878077/
+
+Convert with reposurgeon_?
+
+ If you are doing a full import rather than gatewaying, reposurgeon is
+ probably what you want. It has been tested against a lot of large, old,
+ nasty repositories and is thus known to be robust in the presence of
+ repository malformations (a property regularly checked by a test suite
+ that is a rogue's gallery of Subversion botches).
+
+ -- `Git Wiki`__
+
+.. _reposurgeon: http://www.catb.org/esr/reposurgeon/
+__ https://git.wiki.kernel.org/index.php/
+ Interfaces,_frontends,_and_tools#Subversion
+
General
=======
@@ -2269,22 +2302,6 @@
HTML Writer
===========
-* Make it easier to find out fragment names (#foo-bar) of ``_`inline
- targets```. Currently you have to either look at the source or
- guess the fragment.
-
- For example, we could add support for self-referencing targets
- (i.e. inline targets would [unobtrusively] link to themselves, so
- that you can just click them and then copy the address). Or we
- could add support for titles that display the fragment name (as in
- <http://subversion.tigris.org/mailing-list-guidelines.html>; just
- hover the paragraphs).
-
- Either way it should be optional and deactivated by default.
-
- This would be useful for documents like Docutils' bug list or to-do
- list.
-
* Make the _`list compacting` logic more generic: For example, allow
for literal blocks or line blocks inside of compact list items.
Modified: trunk/docutils/docs/user/tools.txt
===================================================================
--- trunk/docutils/docs/user/tools.txt 2021-11-01 21:50:32 UTC (rev 8873)
+++ trunk/docutils/docs/user/tools.txt 2021-11-01 21:50:42 UTC (rev 8874)
@@ -46,6 +46,9 @@
First, try the "``--help``" option each front-end tool has.
+Command line options and their corresponding configuration file entries
+are detailed in `Docutils Configuration`_.
+
Users who have questions or need assistance with Docutils or
reStructuredText should post a message to the Docutils-users_ mailing
list.
@@ -65,13 +68,22 @@
:Readers: Standalone, PEP
:Parser: reStructuredText, Markdown (reCommonMark)
-:Writers: html_, html4css1_, html5_, pep_html_, s5_html_,
- latex__, xelatex_, xml_, odt_, Pseudo-XML_
+:Writers: html_, html4css1_, html5_, latex__, manpage_,
+ odt_, pep_html_, pseudo-xml_, s5_html_, xelatex_, xml_,
+The ``docutils-cli.py`` front allows combining reader, parser, and
+writer components.
+
+For example, to process a Markdown_ file "``test.md``" into
+Pseudo-XML_ ::
+
+ docutils_.py --parser=markdown --writer=pseudoxml test.md test.txt
+
__ `Generating LaTeX with Docutils`_
.. _Generating LaTeX with Docutils: latex.html
+.. _manpage: manpage.html
+.. _Markdown: https://www.markdownguide.org/
-
HTML-Generating Tools
=====================
@@ -111,7 +123,9 @@
automatically). Command-line options may be used to override config
file settings or replace them altogether.
+.. _configuration file: configuration files
+
rst2html.py
-----------
@@ -371,22 +385,20 @@
.. _LuaTeX: https://en.wikipedia.org/wiki/LuaTeX
-XML-Generating Tools
-====================
+Man-Page-Generating Tools
+=========================
-rst2xml.py
+rst2man.py
----------
:Reader: Standalone
:Parser: reStructuredText
-:Writer: _`XML` (Docutils native)
+:Writer: manpage_
-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. An example is the xml2rst_ processor
-in the Docutils sandbox.
+The ``rst2man.py`` front end reads standalone reStructuredText source
+files and produces troff_ sources for Unix man pages.
-.. _xml2rst: ../../../sandbox/xml2rst
+.. _troff: https://troff.org/
ODF/OpenOffice-Generating Tools
@@ -411,6 +423,7 @@
.. _Odt Writer for Docutils:
.. _odt: odt.html
+
reStructuredText-Generating Tools
=================================
@@ -421,6 +434,24 @@
the XML (Docutils native) writer and the xml2rst_ processor.
+XML-Generating Tools
+====================
+
+rst2xml.py
+----------
+
+:Reader: Standalone
+:Parser: reStructuredText
+:Writer: _`XML` (Docutils native)
+
+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. An example is the xml2rst_ processor
+in the Docutils sandbox.
+
+.. _xml2rst: ../../../sandbox/xml2rst
+
+
Testing/Debugging Tools
=======================
@@ -458,7 +489,6 @@
- Raw native XML (with or without a stylesheet reference)
-
---------------
Customization
---------------
@@ -470,11 +500,9 @@
They take priority over configuration file settings.
Use the "--help" option on each of the front ends to list the
-command-line options it supports.
+command-line options it supports.
-.. _configuration file:
-
Configuration Files
===================
@@ -482,9 +510,9 @@
set once and take effect every time you use a front-end tool.
Command-line options and their corresponding configuration file entry
-names are listed in the `Docutils Configuration Files`_ document.
+names are listed in the `Docutils Configuration`_ document.
-.. _Docutils Configuration Files: config.html
+.. _Docutils Configuration: config.html
..
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
