[Docutils-checkins] SF.net SVN: docutils:[7828] trunk/docutils

[<mi...@us...>]

Revision: 7828
          http://sourceforge.net/p/docutils/code/7828
Author:   milde
Date:     2015-03-13 13:38:56 +0000 (Fri, 13 Mar 2015)
Log Message:
-----------
Documentation update.

Modified Paths:
--------------
    trunk/docutils/docs/user/config.txt
    trunk/docutils/docs/user/tools.txt
    trunk/docutils/docutils/parsers/rst/states.py

Modified: trunk/docutils/docs/user/config.txt
===================================================================
--- trunk/docutils/docs/user/config.txt	2015-03-13 11:42:35 UTC (rev 7827)
+++ trunk/docutils/docs/user/config.txt	2015-03-13 13:38:56 UTC (rev 7828)
@@ -1102,22 +1102,37 @@
 
 __ `xml_declaration [docutils_xml writer]`_
 
+[html-base writer]
+~~~~~~~~~~~~~~~~~~
+
+The `html-base` writer uses the settings described in the `[html4css1
+writer]`_ section with the following exceptions:
+
+Removed options:
+  `field_name_limit`_, `option_limit`_.
+
+Different default for:
+
+`stylesheet_path <stylesheet_path [html4css1 writer]_>`_:
+  Default: "html-base.css"
+
+`stylesheet_dirs <stylesheet_dirs [html4css1 writer]_>`_:
+  Default: Installation-dependent. Use the --help option to get the exact
+  value.
+
+
 [xhtml11 writer]
 ~~~~~~~~~~~~~~~~~
 
-The XHTML1.1 Writer derives from the standard HTML Writer, and shares
-most settings defined in the `[html4css1 writer]`_ section.  The
-"[html4css1 writer]" section of configuration files is processed
-before the "[xhtml11 writer]" section.
+The XHTML1.1 Writer derives from the `html-base` writer and uses the same
+setings. The "[html-base writer]" section of configuration files is
+processed before the "[xhtml11 writer]" section.
 
-removed options:
-  `field_name_limit`_, `option_limit`_
 
-The XHTML1.1 Writer's default for the following settings differ from
-those of the standard HTML Writer:
+Different default for:
 
 `stylesheet_path <stylesheet_path [html4css1 writer]_>`_:
-  Default: "html4css1.css,xhtml11.css"
+  Default: "html-base.css,xhtml11.css"
 
 `stylesheet_dirs <stylesheet_dirs [html4css1 writer]_>`_:
   Default: Installation-dependent. Use the --help option to get the exact

Modified: trunk/docutils/docs/user/tools.txt
===================================================================
--- trunk/docutils/docs/user/tools.txt	2015-03-13 11:42:35 UTC (rev 7827)
+++ trunk/docutils/docs/user/tools.txt	2015-03-13 13:38:56 UTC (rev 7828)
@@ -158,8 +158,9 @@
 :Writer: html5
 
 The ``rst2html5.py`` front end reads standalone reStructuredText source
-files and produces simple HTML 5 output. A stylesheet is required for
-proper rendering; a complete stylesheet is installed and used by default.
+files and produces simple HTML 5 output (compatible to XHTML 1.0
+transitional). A stylesheet is required for proper rendering; a complete
+stylesheet is installed and used by default.
 
 rstpep2html.py
 --------------
@@ -310,7 +311,29 @@
 
 For details see `Generating LaTeX with Docutils`_.
 
+rst2xetex.py
+------------
 
+:Reader: Standalone
+:Parser: reStructuredText
+:Writer: XeTeX
+
+The ``rst2xetex.py`` front end reads standalone reStructuredText source
+files and produces `LaTeX` output for processing with unicode-aware
+TeX engines (`XeTeX` or `LuaTeX`_). For example, to process a
+reStructuredText file "``test.txt``" into LaTeX::
+
+    rst2xetex.py test.txt test.tex
+
+The output file "``test.tex``" should then be processed with ``xelatex`` or
+``lualatex`` to get a document in PDF format for printing or on-screen
+viewing.
+
+For details see `Generating LaTeX with Docutils`_.
+
+.. _XeTeX: https://en.wikipedia.org/wiki/XeTeX
+.. _LuaTeX: https://en.wikipedia.org/wiki/LuaTeX
+
 XML-Generating Tools
 ====================
 

Modified: trunk/docutils/docutils/parsers/rst/states.py
===================================================================
--- trunk/docutils/docutils/parsers/rst/states.py	2015-03-13 11:42:35 UTC (rev 7827)
+++ trunk/docutils/docutils/parsers/rst/states.py	2015-03-13 13:38:56 UTC (rev 7828)
@@ -1547,6 +1547,9 @@
 
     def doctest(self, match, context, next_state):
         data = '\n'.join(self.state_machine.get_text_block())
+        # TODO: prepend class value ['pycon'] (Python Console)
+        # parse with `directives.body.CodeBlock` (returns literal-block
+        # with class "code" and syntax highlight markup).
         self.parent += nodes.doctest_block(data, data)
         return [], next_state, []
 

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.