From: <gr...@us...> - 2012-01-19 21:00:28
|
Revision: 7319 http://docutils.svn.sourceforge.net/docutils/?rev=7319&view=rev Author: grubert Date: 2012-01-19 21:00:21 +0000 (Thu, 19 Jan 2012) Log Message: ----------- Do not emit comment line with trailng blank Modified Paths: -------------- trunk/docutils/HISTORY.txt trunk/docutils/docutils/writers/manpage.py trunk/docutils/test/functional/expected/standalone_rst_manpage.man trunk/docutils/test/test_writers/test_manpage.py trunk/sandbox/manpage-writer/expected/characters.man trunk/sandbox/manpage-writer/expected/docinfo-deu-l_de.man trunk/sandbox/manpage-writer/expected/docinfo-deu-l_en.man trunk/sandbox/manpage-writer/expected/docinfo-deu.man trunk/sandbox/manpage-writer/expected/docinfo-eng-l_de.man trunk/sandbox/manpage-writer/expected/docinfo-eng-l_en.man trunk/sandbox/manpage-writer/expected/docinfo-eng.man trunk/sandbox/manpage-writer/expected/man-de.1.man trunk/sandbox/manpage-writer/expected/optionslisttest.man trunk/sandbox/manpage-writer/expected/test.man Modified: trunk/docutils/HISTORY.txt =================================================================== --- trunk/docutils/HISTORY.txt 2012-01-19 20:46:00 UTC (rev 7318) +++ trunk/docutils/HISTORY.txt 2012-01-19 21:00:21 UTC (rev 7319) @@ -72,6 +72,10 @@ instead of minidom to facilitate special handling of selected nodes. - Support raw XML (inserted as-is inside a <raw></raw> node). +* docutils/writers/manpage.py + + - Do not emit comment line with trailing blank. Problematic for VCS. + Release 0.8.1 (2011-08-30) ========================== Modified: trunk/docutils/docutils/writers/manpage.py =================================================================== --- trunk/docutils/docutils/writers/manpage.py 2012-01-19 20:46:00 UTC (rev 7318) +++ trunk/docutils/docutils/writers/manpage.py 2012-01-19 21:00:21 UTC (rev 7319) @@ -588,7 +588,7 @@ self.body.append('.SH COPYRIGHT\n%s\n' % self._docinfo['copyright']) self.body.append(self.comment( - 'Generated by docutils manpage writer.\n')) + 'Generated by docutils manpage writer.')) def visit_emphasis(self, node): self.body.append(self.defs['emphasis'][0]) Modified: trunk/docutils/test/functional/expected/standalone_rst_manpage.man =================================================================== --- trunk/docutils/test/functional/expected/standalone_rst_manpage.man 2012-01-19 20:46:00 UTC (rev 7318) +++ trunk/docutils/test/functional/expected/standalone_rst_manpage.man 2012-01-19 21:00:21 UTC (rev 7319) @@ -102,5 +102,4 @@ .SH COPYRIGHT public domain .\" Generated by docutils manpage writer. -.\" . Modified: trunk/docutils/test/test_writers/test_manpage.py =================================================================== --- trunk/docutils/test/test_writers/test_manpage.py 2012-01-19 20:46:00 UTC (rev 7318) +++ trunk/docutils/test/test_writers/test_manpage.py 2012-01-19 21:00:21 UTC (rev 7319) @@ -57,7 +57,6 @@ .\" Man page generated from reStructeredText. . .\" Generated by docutils manpage writer. -.\" . """], ] @@ -142,7 +141,6 @@ .SH COPYRIGHT public domain .\" Generated by docutils manpage writer. -.\" . """], ] @@ -190,7 +188,6 @@ .UNINDENT .UNINDENT .\\" Generated by docutils manpage writer. -.\\" . '''] ] @@ -247,7 +244,6 @@ bla bla bla .UNINDENT .\\" Generated by docutils manpage writer. -.\\" \n\ ."""], ] @@ -291,7 +287,6 @@ Description of Term 1 Description of Term 1 .UNINDENT .\\" Generated by docutils manpage writer. -.\\" \n\ .'''], ] Modified: trunk/sandbox/manpage-writer/expected/characters.man =================================================================== --- trunk/sandbox/manpage-writer/expected/characters.man 2012-01-19 20:46:00 UTC (rev 7318) +++ trunk/sandbox/manpage-writer/expected/characters.man 2012-01-19 21:00:21 UTC (rev 7319) @@ -48,5 +48,4 @@ Unicode breaks the man processing chain. The display ends with \fBsingle:\fP . .\" Generated by docutils manpage writer. -.\" . Modified: trunk/sandbox/manpage-writer/expected/docinfo-deu-l_de.man =================================================================== --- trunk/sandbox/manpage-writer/expected/docinfo-deu-l_de.man 2012-01-19 20:46:00 UTC (rev 7318) +++ trunk/sandbox/manpage-writer/expected/docinfo-deu-l_de.man 2012-01-19 21:00:21 UTC (rev 7319) @@ -33,5 +33,4 @@ .sp Test document information Verarbeitung. .\" Generated by docutils manpage writer. -.\" . Modified: trunk/sandbox/manpage-writer/expected/docinfo-deu-l_en.man =================================================================== --- trunk/sandbox/manpage-writer/expected/docinfo-deu-l_en.man 2012-01-19 20:46:00 UTC (rev 7318) +++ trunk/sandbox/manpage-writer/expected/docinfo-deu-l_en.man 2012-01-19 21:00:21 UTC (rev 7319) @@ -35,5 +35,4 @@ Datum: 2009-08-24 .\" Generated by docutils manpage writer. -.\" . Modified: trunk/sandbox/manpage-writer/expected/docinfo-deu.man =================================================================== --- trunk/sandbox/manpage-writer/expected/docinfo-deu.man 2012-01-19 20:46:00 UTC (rev 7318) +++ trunk/sandbox/manpage-writer/expected/docinfo-deu.man 2012-01-19 21:00:21 UTC (rev 7319) @@ -35,5 +35,4 @@ Datum: 2009-08-24 .\" Generated by docutils manpage writer. -.\" . Modified: trunk/sandbox/manpage-writer/expected/docinfo-eng-l_de.man =================================================================== --- trunk/sandbox/manpage-writer/expected/docinfo-eng-l_de.man 2012-01-19 20:46:00 UTC (rev 7318) +++ trunk/sandbox/manpage-writer/expected/docinfo-eng-l_de.man 2012-01-19 21:00:21 UTC (rev 7319) @@ -33,5 +33,4 @@ .sp Test document information processing. .\" Generated by docutils manpage writer. -.\" . Modified: trunk/sandbox/manpage-writer/expected/docinfo-eng-l_en.man =================================================================== --- trunk/sandbox/manpage-writer/expected/docinfo-eng-l_en.man 2012-01-19 20:46:00 UTC (rev 7318) +++ trunk/sandbox/manpage-writer/expected/docinfo-eng-l_en.man 2012-01-19 21:00:21 UTC (rev 7319) @@ -33,5 +33,4 @@ .sp Test document information processing. .\" Generated by docutils manpage writer. -.\" . Modified: trunk/sandbox/manpage-writer/expected/docinfo-eng.man =================================================================== --- trunk/sandbox/manpage-writer/expected/docinfo-eng.man 2012-01-19 20:46:00 UTC (rev 7318) +++ trunk/sandbox/manpage-writer/expected/docinfo-eng.man 2012-01-19 21:00:21 UTC (rev 7319) @@ -33,5 +33,4 @@ .sp Test document information processing. .\" Generated by docutils manpage writer. -.\" . Modified: trunk/sandbox/manpage-writer/expected/man-de.1.man =================================================================== --- trunk/sandbox/manpage-writer/expected/man-de.1.man 2012-01-19 20:46:00 UTC (rev 7318) +++ trunk/sandbox/manpage-writer/expected/man-de.1.man 2012-01-19 21:00:21 UTC (rev 7319) @@ -644,5 +644,4 @@ .sp Für persönliche Würdigungen und Zusätze siehe Quelltexte. .\" Generated by docutils manpage writer. -.\" . Modified: trunk/sandbox/manpage-writer/expected/optionslisttest.man =================================================================== --- trunk/sandbox/manpage-writer/expected/optionslisttest.man 2012-01-19 20:46:00 UTC (rev 7318) +++ trunk/sandbox/manpage-writer/expected/optionslisttest.man 2012-01-19 21:00:21 UTC (rev 7319) @@ -191,5 +191,4 @@ .SH COPYRIGHT public domain .\" Generated by docutils manpage writer. -.\" . Modified: trunk/sandbox/manpage-writer/expected/test.man =================================================================== --- trunk/sandbox/manpage-writer/expected/test.man 2012-01-19 20:46:00 UTC (rev 7318) +++ trunk/sandbox/manpage-writer/expected/test.man 2012-01-19 21:00:21 UTC (rev 7319) @@ -410,5 +410,4 @@ public domain Behave responsible. .\" Generated by docutils manpage writer. -.\" . This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <gr...@us...> - 2012-01-20 06:50:51
|
Revision: 7321 http://docutils.svn.sourceforge.net/docutils/?rev=7321&view=rev Author: grubert Date: 2012-01-20 06:50:44 +0000 (Fri, 20 Jan 2012) Log Message: ----------- Fix typo in generated from comment Modified Paths: -------------- trunk/docutils/docutils/writers/manpage.py trunk/docutils/test/functional/expected/standalone_rst_manpage.man trunk/docutils/test/test_writers/test_manpage.py trunk/sandbox/manpage-writer/expected/characters.man trunk/sandbox/manpage-writer/expected/compact_lists.man trunk/sandbox/manpage-writer/expected/docinfo-deu-l_de.man trunk/sandbox/manpage-writer/expected/docinfo-deu-l_en.man trunk/sandbox/manpage-writer/expected/docinfo-deu.man trunk/sandbox/manpage-writer/expected/docinfo-eng-l_de.man trunk/sandbox/manpage-writer/expected/docinfo-eng-l_en.man trunk/sandbox/manpage-writer/expected/docinfo-eng.man trunk/sandbox/manpage-writer/expected/man-de.1.man trunk/sandbox/manpage-writer/expected/optionslisttest.man trunk/sandbox/manpage-writer/expected/test.man Modified: trunk/docutils/docutils/writers/manpage.py =================================================================== --- trunk/docutils/docutils/writers/manpage.py 2012-01-19 22:33:02 UTC (rev 7320) +++ trunk/docutils/docutils/writers/manpage.py 2012-01-20 06:50:44 UTC (rev 7321) @@ -159,7 +159,7 @@ words_and_spaces = re.compile(r'\S+| +|\n') possibly_a_roff_command = re.compile(r'\.\w') - document_start = """Man page generated from reStructeredText.""" + document_start = """Man page generated from reStructuredText.""" def __init__(self, document): nodes.NodeVisitor.__init__(self, document) Modified: trunk/docutils/test/functional/expected/standalone_rst_manpage.man =================================================================== --- trunk/docutils/test/functional/expected/standalone_rst_manpage.man 2012-01-19 22:33:02 UTC (rev 7320) +++ trunk/docutils/test/functional/expected/standalone_rst_manpage.man 2012-01-20 06:50:44 UTC (rev 7321) @@ -1,4 +1,4 @@ -.\" Man page generated from reStructeredText. +.\" Man page generated from reStructuredText. . .TH RST2MAN 1 "2006-10-22" "0.1" "text processing" .SH NAME Modified: trunk/docutils/test/test_writers/test_manpage.py =================================================================== --- trunk/docutils/test/test_writers/test_manpage.py 2012-01-19 22:33:02 UTC (rev 7320) +++ trunk/docutils/test/test_writers/test_manpage.py 2012-01-20 06:50:44 UTC (rev 7321) @@ -54,7 +54,7 @@ r""".TH "" "" "" .SH NAME \- -.\" Man page generated from reStructeredText. +.\" Man page generated from reStructuredText. . .\" Generated by docutils manpage writer. . @@ -103,7 +103,7 @@ With mixed case. """, - r""".\" Man page generated from reStructeredText. + r""".\" Man page generated from reStructuredText. . .TH SIMPLE 1 "2009-08-05" "0.1" "text processing" .SH NAME @@ -158,7 +158,7 @@ .TH "" "" "" .SH NAME \\- \n\ -.\\" Man page generated from reStructeredText. +.\\" Man page generated from reStructuredText. . .INDENT 0.0 .INDENT 3.5 @@ -215,7 +215,7 @@ .TH "" "" "" .SH NAME \\- \n\ -.\\" Man page generated from reStructeredText. +.\\" Man page generated from reStructuredText. . optin group with dot as group item .INDENT 0.0 @@ -271,7 +271,7 @@ .TH DEFINITION LIST TEST "" "" "" .SH NAME Definition List Test \\- \n\ -.\\" Man page generated from reStructeredText. +.\\" Man page generated from reStructuredText. . .SS Abstract .sp Modified: trunk/sandbox/manpage-writer/expected/characters.man =================================================================== --- trunk/sandbox/manpage-writer/expected/characters.man 2012-01-19 22:33:02 UTC (rev 7320) +++ trunk/sandbox/manpage-writer/expected/characters.man 2012-01-20 06:50:44 UTC (rev 7321) @@ -1,7 +1,7 @@ .TH SPECIAL CHARACTERS "" "" "" .SH NAME special characters \- test special characters -.\" Man page generated from reStructeredText. +.\" Man page generated from reStructuredText. . .SH SEE ALSO .sp Modified: trunk/sandbox/manpage-writer/expected/compact_lists.man =================================================================== --- trunk/sandbox/manpage-writer/expected/compact_lists.man 2012-01-19 22:33:02 UTC (rev 7320) +++ trunk/sandbox/manpage-writer/expected/compact_lists.man 2012-01-20 06:50:44 UTC (rev 7321) @@ -1,7 +1,7 @@ .TH "" "" "" .SH NAME \- -.\" Man page generated from reStructeredText. +.\" Man page generated from reStructuredText. . .INDENT 0.0 .IP \(bu 2 Modified: trunk/sandbox/manpage-writer/expected/docinfo-deu-l_de.man =================================================================== --- trunk/sandbox/manpage-writer/expected/docinfo-deu-l_de.man 2012-01-19 22:33:02 UTC (rev 7320) +++ trunk/sandbox/manpage-writer/expected/docinfo-deu-l_de.man 2012-01-20 06:50:44 UTC (rev 7321) @@ -1,4 +1,4 @@ -.\" Man page generated from reStructeredText. +.\" Man page generated from reStructuredText. . .TH DEUTSCHES_MANPAGE_BEISPIEL 1 "2009-08-24" "0.5" "Beispielmanpages" .SH NAME Modified: trunk/sandbox/manpage-writer/expected/docinfo-deu-l_en.man =================================================================== --- trunk/sandbox/manpage-writer/expected/docinfo-deu-l_en.man 2012-01-19 22:33:02 UTC (rev 7320) +++ trunk/sandbox/manpage-writer/expected/docinfo-deu-l_en.man 2012-01-20 06:50:44 UTC (rev 7321) @@ -1,4 +1,4 @@ -.\" Man page generated from reStructeredText. +.\" Man page generated from reStructuredText. . .TH DEUTSCHES_MANPAGE_BEISPIEL 1 "" "0.5" "Beispielmanpages" .SH NAME Modified: trunk/sandbox/manpage-writer/expected/docinfo-deu.man =================================================================== --- trunk/sandbox/manpage-writer/expected/docinfo-deu.man 2012-01-19 22:33:02 UTC (rev 7320) +++ trunk/sandbox/manpage-writer/expected/docinfo-deu.man 2012-01-20 06:50:44 UTC (rev 7321) @@ -1,4 +1,4 @@ -.\" Man page generated from reStructeredText. +.\" Man page generated from reStructuredText. . .TH DEUTSCHES_MANPAGE_BEISPIEL 1 "" "0.5" "Beispielmanpages" .SH NAME Modified: trunk/sandbox/manpage-writer/expected/docinfo-eng-l_de.man =================================================================== --- trunk/sandbox/manpage-writer/expected/docinfo-eng-l_de.man 2012-01-19 22:33:02 UTC (rev 7320) +++ trunk/sandbox/manpage-writer/expected/docinfo-eng-l_de.man 2012-01-20 06:50:44 UTC (rev 7321) @@ -1,4 +1,4 @@ -.\" Man page generated from reStructeredText. +.\" Man page generated from reStructuredText. . .TH ENGLISH_MANPAGE_SAMPLE 1 "2009-08-24" "0.5" "Example manpages" .SH NAME Modified: trunk/sandbox/manpage-writer/expected/docinfo-eng-l_en.man =================================================================== --- trunk/sandbox/manpage-writer/expected/docinfo-eng-l_en.man 2012-01-19 22:33:02 UTC (rev 7320) +++ trunk/sandbox/manpage-writer/expected/docinfo-eng-l_en.man 2012-01-20 06:50:44 UTC (rev 7321) @@ -1,4 +1,4 @@ -.\" Man page generated from reStructeredText. +.\" Man page generated from reStructuredText. . .TH ENGLISH_MANPAGE_SAMPLE 1 "2009-08-24" "0.5" "Example manpages" .SH NAME Modified: trunk/sandbox/manpage-writer/expected/docinfo-eng.man =================================================================== --- trunk/sandbox/manpage-writer/expected/docinfo-eng.man 2012-01-19 22:33:02 UTC (rev 7320) +++ trunk/sandbox/manpage-writer/expected/docinfo-eng.man 2012-01-20 06:50:44 UTC (rev 7321) @@ -1,4 +1,4 @@ -.\" Man page generated from reStructeredText. +.\" Man page generated from reStructuredText. . .TH ENGLISH_MANPAGE_SAMPLE 1 "2009-08-24" "0.5" "Example manpages" .SH NAME Modified: trunk/sandbox/manpage-writer/expected/man-de.1.man =================================================================== --- trunk/sandbox/manpage-writer/expected/man-de.1.man 2012-01-19 22:33:02 UTC (rev 7320) +++ trunk/sandbox/manpage-writer/expected/man-de.1.man 2012-01-20 06:50:44 UTC (rev 7321) @@ -1,4 +1,4 @@ -.\" Man page generated from reStructeredText. +.\" Man page generated from reStructuredText. . .TH MAN 1 "2008-01-28" "2.5.1" "Manual Hilfsprogramme" .SH NAME Modified: trunk/sandbox/manpage-writer/expected/optionslisttest.man =================================================================== --- trunk/sandbox/manpage-writer/expected/optionslisttest.man 2012-01-19 22:33:02 UTC (rev 7320) +++ trunk/sandbox/manpage-writer/expected/optionslisttest.man 2012-01-20 06:50:44 UTC (rev 7321) @@ -1,4 +1,4 @@ -.\" Man page generated from reStructeredText. +.\" Man page generated from reStructuredText. . .TH OPTIONLISTTEST 1 "2008-04-29" "" "" .SH NAME Modified: trunk/sandbox/manpage-writer/expected/test.man =================================================================== --- trunk/sandbox/manpage-writer/expected/test.man 2012-01-19 22:33:02 UTC (rev 7320) +++ trunk/sandbox/manpage-writer/expected/test.man 2012-01-20 06:50:44 UTC (rev 7321) @@ -1,4 +1,4 @@ -.\" Man page generated from reStructeredText. +.\" Man page generated from reStructuredText. . .TH RST2MAN 1 "2009-06-22" "0.0.1" "text processing" .SH NAME This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <gr...@us...> - 2012-06-17 20:44:34
|
Revision: 7445 http://docutils.svn.sourceforge.net/docutils/?rev=7445&view=rev Author: grubert Date: 2012-06-17 20:44:28 +0000 (Sun, 17 Jun 2012) Log Message: ----------- pre 0.9.1 doc Modified Paths: -------------- trunk/docutils/RELEASE-NOTES.txt trunk/sandbox/infrastructure/releasing-log.txt Modified: trunk/docutils/RELEASE-NOTES.txt =================================================================== --- trunk/docutils/RELEASE-NOTES.txt 2012-06-16 09:41:40 UTC (rev 7444) +++ trunk/docutils/RELEASE-NOTES.txt 2012-06-17 20:44:28 UTC (rev 7445) @@ -48,6 +48,10 @@ Changes Since 0.9 ================= +* General: + + Several fixes for Python 3 usage. + * docutils/setup.py - Fix [ 3527842 ]. Under Python 3, converted tests and tools were Modified: trunk/sandbox/infrastructure/releasing-log.txt =================================================================== --- trunk/sandbox/infrastructure/releasing-log.txt 2012-06-16 09:41:40 UTC (rev 7444) +++ trunk/sandbox/infrastructure/releasing-log.txt 2012-06-17 20:44:28 UTC (rev 7445) @@ -8,6 +8,17 @@ Notes on what happend while releasing. +Release 0.9.1 +============= + +same failures as for 0.9 plus + +* python 2.3: twice, ignored :: + + - [Errno 2] No such file or directory: 'bogus.csv'. + + [Errno 2] No such file or directory: u'bogus.csv'. + + Release 0.9 =========== This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <gr...@us...> - 2012-06-18 20:05:21
|
Revision: 7461 http://docutils.svn.sourceforge.net/docutils/?rev=7461&view=rev Author: grubert Date: 2012-06-18 20:05:14 +0000 (Mon, 18 Jun 2012) Log Message: ----------- pypi download urls must be set, for older releases to be useable Modified Paths: -------------- trunk/docutils/docs/dev/release.txt trunk/sandbox/infrastructure/release.sh Modified: trunk/docutils/docs/dev/release.txt =================================================================== --- trunk/docutils/docs/dev/release.txt 2012-06-17 23:06:33 UTC (rev 7460) +++ trunk/docutils/docs/dev/release.txt 2012-06-18 20:05:14 UTC (rev 7461) @@ -136,6 +136,8 @@ * Register with PyPI (``python setup.py register``). + Set the download-url so eggs can access older releases. + * Restore ``__version_details__`` in docutils/docutils/__init__.py to "repository" (from "release"). Modified: trunk/sandbox/infrastructure/release.sh =================================================================== --- trunk/sandbox/infrastructure/release.sh 2012-06-17 23:06:33 UTC (rev 7460) +++ trunk/sandbox/infrastructure/release.sh 2012-06-18 20:05:14 UTC (rev 7461) @@ -444,6 +444,7 @@ done confirm test_tarball echo 'Registering with PyPI...' + echo 'TODO upload to pypi or set download url for this release' echo 'Press enter to proceed (or enter anything to skip)...' read if [ ! "$REPLY" ]; then This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <gr...@us...> - 2012-07-04 15:27:16
|
Revision: 7480 http://docutils.svn.sourceforge.net/docutils/?rev=7480&view=rev Author: grubert Date: 2012-07-04 15:27:05 +0000 (Wed, 04 Jul 2012) Log Message: ----------- Apply [3527397] Add indentation to literal blocks in manpage writer Modified Paths: -------------- trunk/docutils/HISTORY.txt trunk/docutils/docutils/writers/manpage.py trunk/docutils/test/test_writers/test_manpage.py trunk/sandbox/manpage-writer/expected/characters.man trunk/sandbox/manpage-writer/expected/indent-1.latin1 trunk/sandbox/manpage-writer/expected/indent-1.man trunk/sandbox/manpage-writer/expected/indent-2.ascii trunk/sandbox/manpage-writer/expected/indent-2.latin1 trunk/sandbox/manpage-writer/expected/indent-2.man trunk/sandbox/manpage-writer/expected/man-de.1.latin1 trunk/sandbox/manpage-writer/expected/man-de.1.man trunk/sandbox/manpage-writer/expected/man-de.1.utf8 trunk/sandbox/manpage-writer/expected/test.latin1 trunk/sandbox/manpage-writer/expected/test.man Modified: trunk/docutils/HISTORY.txt =================================================================== --- trunk/docutils/HISTORY.txt 2012-07-04 14:23:07 UTC (rev 7479) +++ trunk/docutils/HISTORY.txt 2012-07-04 15:27:05 UTC (rev 7480) @@ -27,7 +27,11 @@ - FileInput/FileOutput: no system-exit on IOError. The `handle_io_errors` option is ignored and will be removed in a future release. +* docutils/writers/manpage.py + - Apply [3527397] Add indentation to literal blocks in manpage writer. + + Release 0.9.1 (2012-06-17) ========================== Modified: trunk/docutils/docutils/writers/manpage.py =================================================================== --- trunk/docutils/docutils/writers/manpage.py 2012-07-04 14:23:07 UTC (rev 7479) +++ trunk/docutils/docutils/writers/manpage.py 2012-07-04 15:27:05 UTC (rev 7480) @@ -57,6 +57,7 @@ DEFINITION_LIST_INDENT = 7 OPTION_LIST_INDENT = 7 BLOCKQOUTE_INDENT = 3.5 +LITERAL_BLOCK_INDENT = 3.5 # Define two macros so man/roff can calculate the # indent/unindent margins by itself @@ -799,12 +800,18 @@ self.body.append(self.defs['literal'][1]) def visit_literal_block(self, node): + # BUG/HACK: indent alway uses the _last_ indention, + # thus we need two of them. + self.indent(LITERAL_BLOCK_INDENT) + self.indent(0) self.body.append(self.defs['literal_block'][0]) self._in_literal = True def depart_literal_block(self, node): self._in_literal = False self.body.append(self.defs['literal_block'][1]) + self.dedent() + self.dedent() def visit_math(self, node): self.document.reporter.warning('"math" role not supported', Modified: trunk/docutils/test/test_writers/test_manpage.py =================================================================== --- trunk/docutils/test/test_writers/test_manpage.py 2012-07-04 14:23:07 UTC (rev 7479) +++ trunk/docutils/test/test_writers/test_manpage.py 2012-07-04 15:27:05 UTC (rev 7480) @@ -110,12 +110,16 @@ simple \- The way to go """+indend_macros+ r""".SH SYNOPSIS +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C K.I.S.S keep it simple. .ft P .fi +.UNINDENT +.UNINDENT .SH DESCRIPTION .sp General rule of life. Modified: trunk/sandbox/manpage-writer/expected/characters.man =================================================================== --- trunk/sandbox/manpage-writer/expected/characters.man 2012-07-04 14:23:07 UTC (rev 7479) +++ trunk/sandbox/manpage-writer/expected/characters.man 2012-07-04 15:27:05 UTC (rev 7480) @@ -6,6 +6,8 @@ .SH SEE ALSO .sp In mercurial the following substitutions are in use: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C @@ -14,6 +16,8 @@ \&.. |hgignore(5)| replace:: **hgignore**\e (5) .ft P .fi +.UNINDENT +.UNINDENT .sp resulting in. .sp Modified: trunk/sandbox/manpage-writer/expected/indent-1.latin1 =================================================================== --- trunk/sandbox/manpage-writer/expected/indent-1.latin1 2012-07-04 14:23:07 UTC (rev 7479) +++ trunk/sandbox/manpage-writer/expected/indent-1.latin1 2012-07-04 15:27:05 UTC (rev 7480) @@ -11,7 +11,7 @@ Example: - $ man ls + $ man ls AAUUTTHHOORR joe...@ex... Modified: trunk/sandbox/manpage-writer/expected/indent-1.man =================================================================== --- trunk/sandbox/manpage-writer/expected/indent-1.man 2012-07-04 14:23:07 UTC (rev 7479) +++ trunk/sandbox/manpage-writer/expected/indent-1.man 2012-07-04 15:27:05 UTC (rev 7480) @@ -36,12 +36,16 @@ literal blocks. .sp Example: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ man ls .ft P .fi +.UNINDENT +.UNINDENT .SH AUTHOR joe...@ex... .\" Generated by docutils manpage writer. Modified: trunk/sandbox/manpage-writer/expected/indent-2.ascii =================================================================== --- trunk/sandbox/manpage-writer/expected/indent-2.ascii 2012-07-04 14:23:07 UTC (rev 7479) +++ trunk/sandbox/manpage-writer/expected/indent-2.ascii 2012-07-04 15:27:05 UTC (rev 7480) @@ -17,7 +17,7 @@ Example: - $ man ls + $ man ls AAUUTTHHOORR joe...@ex... Modified: trunk/sandbox/manpage-writer/expected/indent-2.latin1 =================================================================== --- trunk/sandbox/manpage-writer/expected/indent-2.latin1 2012-07-04 14:23:07 UTC (rev 7479) +++ trunk/sandbox/manpage-writer/expected/indent-2.latin1 2012-07-04 15:27:05 UTC (rev 7480) @@ -17,7 +17,7 @@ Example: - $ man ls + $ man ls AAUUTTHHOORR joe...@ex... Modified: trunk/sandbox/manpage-writer/expected/indent-2.man =================================================================== --- trunk/sandbox/manpage-writer/expected/indent-2.man 2012-07-04 14:23:07 UTC (rev 7479) +++ trunk/sandbox/manpage-writer/expected/indent-2.man 2012-07-04 15:27:05 UTC (rev 7480) @@ -44,12 +44,16 @@ .UNINDENT .sp Example: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ man ls .ft P .fi +.UNINDENT +.UNINDENT .RE .SH AUTHOR joe...@ex... Modified: trunk/sandbox/manpage-writer/expected/man-de.1.latin1 =================================================================== --- trunk/sandbox/manpage-writer/expected/man-de.1.latin1 2012-07-04 14:23:07 UTC (rev 7479) +++ trunk/sandbox/manpage-writer/expected/man-de.1.latin1 2012-07-04 15:27:05 UTC (rev 7480) @@ -197,7 +197,7 @@ Umgebungsvariablen die gewuenschte Sprache einstellen. Die Sprache wird normalerweise in dem durch POSIX 1003.1 definierten Format angegeben: - <Sprache>[_<Region>[.<Zeichensatz>[,<Version>]]] + <Sprache>[_<Region>[.<Zeichensatz>[,<Version>]]] Wenn die angeforderte Seite in der locale vorhanden ist, wird sie anstelle der Standardseite (normalerweise in amerikanischem Englisch) @@ -242,7 +242,7 @@ kette fuer den Praeprozessor untersucht. Eine solche Praeprozessor- Zeichenkette muss folgendes Aussehen haben: - '\" <Zeichenkette> + '\" <Zeichenkette> wobei Zeichenkette jede Kombination von Buchstaben sein kann, die unter Option -p weiter unten beschrieben sind. @@ -318,8 +318,8 @@ Abschnittsnummer in runden Klammern ersetzt. Die Zeichenkette, die im Normalfall verwendet wird ist: - \ Manual\ page\ \$MAN_PN\ ?ltline\ %lt?L/%L.: - byte\ %bB?s/%s..?\ (END):?pB %pB\\%.. + \ Manual\ page\ \$MAN_PN\ ?ltline\ %lt?L/%L.: + byte\ %bB?s/%s..?\ (END):?pB %pB\\%.. Die zweizeilige Darstellung wurde nur der besseren Lesbarkeit wegen gew\xE4hlt. N\xE4here Informationen liefert less(1). Da die Modified: trunk/sandbox/manpage-writer/expected/man-de.1.man =================================================================== --- trunk/sandbox/manpage-writer/expected/man-de.1.man 2012-07-04 14:23:07 UTC (rev 7479) +++ trunk/sandbox/manpage-writer/expected/man-de.1.man 2012-07-04 15:27:05 UTC (rev 7480) @@ -284,12 +284,16 @@ man entweder in $LC_MESSAGES, $LANG oder anderen systemabhaengigen Umgebungsvariablen die gewuenschte Sprache einstellen. Die Sprache wird normalerweise in dem durch POSIX 1003.1 definierten Format angegeben: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C <Sprache>[_<Region>[.<Zeichensatz>[,<Version>]]] .ft P .fi +.UNINDENT +.UNINDENT .sp Wenn die angeforderte Seite in der locale vorhanden ist, wird sie anstelle der Standardseite (normalerweise in amerikanischem Englisch) @@ -333,12 +337,16 @@ gesetzt ist, wird die Anfangszeile der nroff\-Datei nach einer Zeichen\- kette fuer den Praeprozessor untersucht. Eine solche Praeprozessor\- Zeichenkette muss folgendes Aussehen haben: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C \(aq\e" <Zeichenkette> .ft P .fi +.UNINDENT +.UNINDENT .sp wobei Zeichenkette jede Kombination von Buchstaben sein kann, die unter Option \-p weiter unten beschrieben sind. @@ -418,6 +426,8 @@ durch den Namen der Manualseite gefolgt von der Abschnittsnummer in runden Klammern ersetzt. Die Zeichenkette, die im Normalfall verwendet wird ist: +.INDENT 7.0 +.INDENT 3.5 .sp .nf .ft C @@ -425,6 +435,8 @@ byte\e %bB?s/%s..?\e (END):?pB %pB\e\e%.. .ft P .fi +.UNINDENT +.UNINDENT .sp Die zweizeilige Darstellung wurde nur der besseren Lesbarkeit wegen gewählt. Nähere Informationen liefert less(1). Da die Modified: trunk/sandbox/manpage-writer/expected/man-de.1.utf8 =================================================================== --- trunk/sandbox/manpage-writer/expected/man-de.1.utf8 2012-07-04 14:23:07 UTC (rev 7479) +++ trunk/sandbox/manpage-writer/expected/man-de.1.utf8 2012-07-04 15:27:05 UTC (rev 7480) @@ -197,7 +197,7 @@ Umgebungsvariablen die gewuenschte Sprache einstellen. Die Sprache wird normalerweise in dem durch POSIX 1003.1 definierten Format angegeben: - <Sprache>[_<Region>[.<Zeichensatz>[,<Version>]]] + <Sprache>[_<Region>[.<Zeichensatz>[,<Version>]]] Wenn die angeforderte Seite in der locale vorhanden ist, wird sie anstelle der Standardseite (normalerweise in amerikanischem Englisch) @@ -242,7 +242,7 @@ kette fuer den Praeprozessor untersucht. Eine solche Praeprozessor- Zeichenkette muss folgendes Aussehen haben: - '\" <Zeichenkette> + '\" <Zeichenkette> wobei Zeichenkette jede Kombination von Buchstaben sein kann, die unter Option -p weiter unten beschrieben sind. @@ -318,8 +318,8 @@ Abschnittsnummer in runden Klammern ersetzt. Die Zeichenkette, die im Normalfall verwendet wird ist: - \ Manual\ page\ \$MAN_PN\ ?ltline\ %lt?L/%L.: - byte\ %bB?s/%s..?\ (END):?pB %pB\\%.. + \ Manual\ page\ \$MAN_PN\ ?ltline\ %lt?L/%L.: + byte\ %bB?s/%s..?\ (END):?pB %pB\\%.. Die zweizeilige Darstellung wurde nur der besseren Lesbarkeit wegen gewählt. Nähere Informationen liefert less(1). Da die Modified: trunk/sandbox/manpage-writer/expected/test.latin1 =================================================================== --- trunk/sandbox/manpage-writer/expected/test.latin1 2012-07-04 14:23:07 UTC (rev 7479) +++ trunk/sandbox/manpage-writer/expected/test.latin1 2012-07-04 15:27:05 UTC (rev 7480) @@ -147,17 +147,17 @@ LLiitteerraall some literal text - here now it starts - and continues - indented - and back + here now it starts + and continues + indented + and back and a paragraph after the literal. some special characters and roff formatting in literal: - .SS "." at line start - backslash "\" + .SS "." at line start + backslash "\" LLiinnee bblloocckkss This is a line block. It ends with a blank line. Modified: trunk/sandbox/manpage-writer/expected/test.man =================================================================== --- trunk/sandbox/manpage-writer/expected/test.man 2012-07-04 14:23:07 UTC (rev 7479) +++ trunk/sandbox/manpage-writer/expected/test.man 2012-07-04 15:27:05 UTC (rev 7480) @@ -229,6 +229,8 @@ .SS Literal .sp some literal text +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C @@ -238,10 +240,14 @@ and back .ft P .fi +.UNINDENT +.UNINDENT .sp and a paragraph after the literal. .sp some special characters and roff formatting in literal: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C @@ -249,6 +255,8 @@ backslash "\e" .ft P .fi +.UNINDENT +.UNINDENT .SS Line blocks .nf This is a line block. It ends with a blank line. This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <gr...@us...> - 2012-07-06 08:17:39
|
Revision: 7485 http://docutils.svn.sourceforge.net/docutils/?rev=7485&view=rev Author: grubert Date: 2012-07-06 08:17:28 +0000 (Fri, 06 Jul 2012) Log Message: ----------- Apply [3527401] manpage writer addmonition's don't preserve indentation Modified Paths: -------------- trunk/docutils/HISTORY.txt trunk/docutils/docutils/writers/manpage.py trunk/docutils/test/test_writers/test_manpage.py trunk/sandbox/manpage-writer/expected/test.latin1 trunk/sandbox/manpage-writer/expected/test.man Modified: trunk/docutils/HISTORY.txt =================================================================== --- trunk/docutils/HISTORY.txt 2012-07-06 07:52:24 UTC (rev 7484) +++ trunk/docutils/HISTORY.txt 2012-07-06 08:17:28 UTC (rev 7485) @@ -29,6 +29,7 @@ * docutils/writers/manpage.py + - Apply [3527401] addmonition's don't preserve indentation - Apply [3527397] Add indentation to literal blocks in manpage writer. Modified: trunk/docutils/docutils/writers/manpage.py =================================================================== --- trunk/docutils/docutils/writers/manpage.py 2012-07-06 07:52:24 UTC (rev 7484) +++ trunk/docutils/docutils/writers/manpage.py 2012-07-06 08:17:28 UTC (rev 7485) @@ -388,12 +388,27 @@ pass def visit_admonition(self, node, name=None): + # + # Make admonitions a simple block quote + # with a strong heading + # + # Using .IP/.RE doesn't preserve indentation + # when admonitions contain bullets, literal, + # and/or block quotes. + # if name: - self.body.append('.IP %s\n' % - self.language.labels.get(name, name)) + # .. admonition:: has no name + self.body.append('.sp\n') + name = '%s%s:%s\n' % ( + self.defs['strong'][0], + self.language.labels.get(name, name).upper(), + self.defs['strong'][1], + ) + self.body.append(name) + self.visit_block_quote(node) def depart_admonition(self, node): - self.body.append('.RE\n') + self.depart_block_quote(node) def visit_attention(self, node): self.visit_admonition(node, 'attention') Modified: trunk/docutils/test/test_writers/test_manpage.py =================================================================== --- trunk/docutils/test/test_writers/test_manpage.py 2012-07-06 07:52:24 UTC (rev 7484) +++ trunk/docutils/test/test_writers/test_manpage.py 2012-07-06 08:17:28 UTC (rev 7485) @@ -150,7 +150,10 @@ .SH OTHER SECTION .sp With mixed case. -.IP Attention! +.sp +\fBATTENTION!:\fP +.INDENT 0.0 +.INDENT 3.5 Admonition with title .INDENT 0.0 .IP \(bu 2 @@ -158,11 +161,15 @@ .IP \(bu 2 bull and list .UNINDENT -.RE +.UNINDENT +.UNINDENT +.INDENT 0.0 +.INDENT 3.5 .IP "homegrown" .sp something important -.RE +.UNINDENT +.UNINDENT .SH AUTHOR so...@so... Modified: trunk/sandbox/manpage-writer/expected/test.latin1 =================================================================== --- trunk/sandbox/manpage-writer/expected/test.latin1 2012-07-06 07:52:24 UTC (rev 7484) +++ trunk/sandbox/manpage-writer/expected/test.latin1 2012-07-06 08:17:28 UTC (rev 7485) @@ -193,42 +193,46 @@ raw input to man AAddmmoonniittiioonnss - Attention! - Directives at large. + AATTTTEENNTTIIOONN!!:: + Directives at large. - Caution! - Don't take any wooden nickels. + CCAAUUTTIIOONN!!:: + Don't take any wooden nickels. - !DANGER! - Mad scientist at work! + !!DDAANNGGEERR!!:: + Mad scientist at work! - Error Does not compute. + EERRRROORR:: + Does not compute. - Hint It's bigger than a bread box. + HHIINNTT:: + It's bigger than a bread box. - Important + IIMMPPOORRTTAANNTT:: - \xB7 Wash behind your ears. + \xB7 Wash behind your ears. - \xB7 Clean up your room. + \xB7 Clean up your room. - \xB7 Call your mother. + \xB7 Call your mother. - \xB7 Back up your data. + \xB7 Back up your data. - Note This is a note. + NNOOTTEE:: + This is a note. - Tip 15% if the service is good. + TTIIPP:: + 15% if the service is good. - Warning - Strong prose may provoke extreme mental exertion. Reader dis- - cretion is strongly advised. + WWAARRNNIINNGG:: + Strong prose may provoke extreme mental exertion. Reader discretion + is strongly advised. - And, by the way... + And, by the way... - You can make up your own admonition too. + You can make up your own admonition too. - With more than one paragraph. + With more than one paragraph. Text after the admonition. Modified: trunk/sandbox/manpage-writer/expected/test.man =================================================================== --- trunk/sandbox/manpage-writer/expected/test.man 2012-07-06 07:52:24 UTC (rev 7484) +++ trunk/sandbox/manpage-writer/expected/test.man 2012-07-06 08:17:28 UTC (rev 7485) @@ -313,23 +313,46 @@ .SS raw raw input to man .SS Admonitions -.IP Attention! +.sp +\fBATTENTION!:\fP +.INDENT 0.0 +.INDENT 3.5 Directives at large. -.RE -.IP Caution! +.UNINDENT +.UNINDENT +.sp +\fBCAUTION!:\fP +.INDENT 0.0 +.INDENT 3.5 Don\(aqt take any wooden nickels. -.RE -.IP !DANGER! +.UNINDENT +.UNINDENT +.sp +\fB!DANGER!:\fP +.INDENT 0.0 +.INDENT 3.5 Mad scientist at work! -.RE -.IP Error +.UNINDENT +.UNINDENT +.sp +\fBERROR:\fP +.INDENT 0.0 +.INDENT 3.5 Does not compute. -.RE -.IP Hint +.UNINDENT +.UNINDENT +.sp +\fBHINT:\fP +.INDENT 0.0 +.INDENT 3.5 It\(aqs bigger than a bread box. -.RE -.IP Important +.UNINDENT +.UNINDENT +.sp +\fBIMPORTANT:\fP .INDENT 0.0 +.INDENT 3.5 +.INDENT 0.0 .IP \(bu 2 Wash behind your ears. .IP \(bu 2 @@ -339,23 +362,39 @@ .IP \(bu 2 Back up your data. .UNINDENT -.RE -.IP Note +.UNINDENT +.UNINDENT +.sp +\fBNOTE:\fP +.INDENT 0.0 +.INDENT 3.5 This is a note. -.RE -.IP Tip +.UNINDENT +.UNINDENT +.sp +\fBTIP:\fP +.INDENT 0.0 +.INDENT 3.5 15% if the service is good. -.RE -.IP Warning +.UNINDENT +.UNINDENT +.sp +\fBWARNING:\fP +.INDENT 0.0 +.INDENT 3.5 Strong prose may provoke extreme mental exertion. Reader discretion is strongly advised. -.RE +.UNINDENT +.UNINDENT +.INDENT 0.0 +.INDENT 3.5 .IP "And, by the way..." .sp You can make up your own admonition too. .sp With more than one paragraph. -.RE +.UNINDENT +.UNINDENT .sp Text after the admonition. .SS other This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <gr...@us...> - 2012-12-16 19:07:59
|
Revision: 7570 http://docutils.svn.sourceforge.net/docutils/?rev=7570&view=rev Author: grubert Date: 2012-12-16 19:07:53 +0000 (Sun, 16 Dec 2012) Log Message: ----------- Add some more to 0.10 release notes change web to 0.10 Modified Paths: -------------- trunk/docutils/RELEASE-NOTES.txt trunk/web/index.txt Modified: trunk/docutils/RELEASE-NOTES.txt =================================================================== --- trunk/docutils/RELEASE-NOTES.txt 2012-12-16 18:29:50 UTC (rev 7569) +++ trunk/docutils/RELEASE-NOTES.txt 2012-12-16 19:07:53 UTC (rev 7570) @@ -56,6 +56,8 @@ except ImportError: import docutils.utils.math as math + - enhanced math and error handling. + * docutils/io.py - FileInput/FileOutput: no system-exit on IOError. @@ -63,7 +65,22 @@ .. _Python 3 compatibility: README.html#python-3-compatibility +* docutils/writers/html4css1/__init__.py + - Use ``<code>`` tag for inline "code", + do not drop nested inline nodes (syntax highlight tokens). + - Customizable MathJax URL (based on patch by Dmitry Shachnev). + - No line break after opening inline math tag. + +* docutils/writers/latex2e/__init__.py, docutils/writers/xetex/__init__.py + + - Fix section numbering by LaTeX. + +* docutils/writers/s5_html/__init__.py + + - Fix [ 3556388 ] Mathjax does not work with rst2s5. + + Release 0.9.1 (2012-06-17) ========================== Modified: trunk/web/index.txt =================================================================== --- trunk/web/index.txt 2012-12-16 18:29:50 UTC (rev 7569) +++ trunk/web/index.txt 2012-12-16 19:07:53 UTC (rev 7570) @@ -59,13 +59,13 @@ repository`_. The snapshots usually contain *more features* and *fewer bugs* than the "official" releases |---| they're not only for developers! -The latest **release package** is `docutils-0.9.1.tgz`__. It was -released on 2012-06-17 and is mostly intended for distributors. See +The latest **release package** is `docutils-0.10.tgz`__. It was +released on 2012-12-16 and is mostly intended for distributors. See the `release notes`_ for a list of changes since the previous release -(0.8.1). +(0.9.1). -__ http://prdownloads.sourceforge.net/docutils/docutils-0.9.1.tar.gz?download -.. _release notes: RELEASE-NOTES.html#release-0-9-1-2012-06-17 +__ http://prdownloads.sourceforge.net/docutils/docutils-0.10.tar.gz?download +.. _release notes: RELEASE-NOTES.html#release-0-10-2012-12-16 The Sandbox_ contains experimental, contributed code. You can download a complete `snapshot of the Sandbox`_ or `browse the Sandbox`_ to download a This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <gr...@us...> - 2013-02-12 21:24:48
|
Revision: 7601 http://docutils.svn.sourceforge.net/docutils/?rev=7601&view=rev Author: grubert Date: 2013-02-12 21:24:37 +0000 (Tue, 12 Feb 2013) Log Message: ----------- manpage Fix option separating comma was bold (thanks to Bill Morris). Modified Paths: -------------- trunk/docutils/HISTORY.txt trunk/docutils/docutils/writers/manpage.py trunk/sandbox/manpage-writer/expected/man-de.1.latin1 trunk/sandbox/manpage-writer/expected/man-de.1.man trunk/sandbox/manpage-writer/expected/man-de.1.utf8 trunk/sandbox/manpage-writer/expected/optionslisttest.latin1 trunk/sandbox/manpage-writer/expected/optionslisttest.man trunk/sandbox/manpage-writer/expected/test.latin1 trunk/sandbox/manpage-writer/expected/test.man Modified: trunk/docutils/HISTORY.txt =================================================================== --- trunk/docutils/HISTORY.txt 2013-02-12 21:09:58 UTC (rev 7600) +++ trunk/docutils/HISTORY.txt 2013-02-12 21:24:37 UTC (rev 7601) @@ -45,6 +45,10 @@ .. _SmartQuotes: docs/user/config.html#smart-quotes +* docutils/writers/manpage.py + + - Fix option separating comma was bold (thanks to Bill Morris). + Release 0.10 (2012-12-16) ========================= Modified: trunk/docutils/docutils/writers/manpage.py =================================================================== --- trunk/docutils/docutils/writers/manpage.py 2013-02-12 21:09:58 UTC (rev 7600) +++ trunk/docutils/docutils/writers/manpage.py 2013-02-12 21:24:37 UTC (rev 7601) @@ -898,7 +898,7 @@ def visit_option(self, node): # each form of the option will be presented separately if self.context[-1] > 0: - self.body.append(', ') + self.body.append('\\fP,\\fB ') if self.context[-3] == '.BI': self.body.append('\\') self.body.append(' ') Modified: trunk/sandbox/manpage-writer/expected/man-de.1.latin1 =================================================================== --- trunk/sandbox/manpage-writer/expected/man-de.1.latin1 2013-02-12 21:09:58 UTC (rev 7600) +++ trunk/sandbox/manpage-writer/expected/man-de.1.latin1 2013-02-12 21:24:37 UTC (rev 7601) @@ -259,7 +259,7 @@ ein Argument ben\xF6tigen, \xFCberschreibt jedes Duplikat den vorhergehenden Wert. - --ll,, ----llooccaall--ffiillee + --ll, ----llooccaall--ffiillee Aktiviert den lokalen Modus. Formatiert und zeigt lokale Manual- dateien an, anstatt die System-Manualsammlung zu durchsuchen. Jedes Manualseiten-Argument wird als nroff-Quelle im richtigen @@ -269,7 +269,7 @@ Es wird keine cat-Datei erzeugt. Wenn eines der Argumente -- ist, wird die Eingabe von der Standardeingabe uebernommen. - --LL _l_o_c_a_l_e_, ----llooccaallee==_l_o_c_a_l_e + --LL _l_o_c_a_l_e,, ----llooccaallee==_l_o_c_a_l_e Normalerweise bestimmt man die aktuelle locale durch einen Aufruf der C Funktion setlocale (3), die diverse Umgebungsvari- ablen, darunter u. U. $LC_MESSAGES und $LANG untersucht. Diese @@ -280,7 +280,7 @@ der Seite in Erscheinung tritt. Daher werden Ausgaben wie die Hilfeseite immer in der urspruenglichen Sprache ausgegeben. - --DD,, ----ddeeffaauulltt + --DD, ----ddeeffaauulltt Diese Option wird normalerweise nur als allererste angegeben und setzt das Verhalten von man in allen Belangen wieder zum Nor- malverhalten zurueck. Der Zweck dieser Option ist es, Optionen @@ -288,18 +288,18 @@ able $MANOPT gesetzt sind. Alle Optionen, die -D folgen, haben wieder ihren gewohnten Effekt. - --MM _P_f_a_d_, ----mmaannppaatthh==_P_f_a_d + --MM _P_f_a_d,, ----mmaannppaatthh==_P_f_a_d Ermoeglicht es, einen alternativen Manualpfad anzugeben. Nor- malerweise verwendet man dieselben Methoden wie in manpath, um den Suchpfad zu ermitteln. Diese Option ueberschreibt die Umge- bungsvariable $$MMAANNPPAATTHH. - --PP _P_a_g_e_r_, ----ppaaggeerr==_P_a_g_e_r + --PP _P_a_g_e_r,, ----ppaaggeerr==_P_a_g_e_r Gibt an, welcher Pager verwendet wird. Die Normaleinstellung ist pager-s. Diese Option ueberschreibt die Umgebungsvariable $$PPAAGGEERR und wird nicht in Zusammenhang mit -f oder -k verwendet. - --rr _P_r_o_m_p_t_, ----pprroommpptt==_P_r_o_m_p_t + --rr _P_r_o_m_p_t,, ----pprroommpptt==_P_r_o_m_p_t Wenn eine hinreichend neue Version von less als Pager verwendet wird, versucht man dort einige sinnvolle Optionen zu setzen. Die Eingabeaufforderung in der letzten Zeile sieht in dem Fall so @@ -329,28 +329,28 @@ gesch\xFCtzten $$ am Ende der Zeichenkette hinzugef\xFCgt werden. Der Default ist hier --iixx88. - --SS _L_i_s_t_e_, ----sseeccttiioonnss==_L_i_s_t_e + --SS _L_i_s_t_e,, ----sseeccttiioonnss==_L_i_s_t_e Eine durch Doppelpunkte getrennte Liste von Abschnitten definiert bei Benutzung dieser Option die Reihenfolge, in der die Abschnitte durchsucht werden. Diese Option ueberschreibt die Umgebungsvariable $MANSECT. - --aa,, ----aallll + --aa, ----aallll Wird eine Manualseite in einem Abschnitt gefunden, so terminiert man nach Anzeige dieser Seite. Wird jedoch diese Option angegeben, so werden alle passenden Manualseiten nacheinander angezeigt. - --cc,, ----ccaattmmaann + --cc, ----ccaattmmaann Diese Option ueberprueft nur, ob die zur angegebenen Manualseite passende cat-Seite aktuell ist und erzeugt ggf. eine neue. Es wird dabei nichts angezeigt. - --dd,, ----ddeebbuugg + --dd, ----ddeebbuugg Bei dieser Option werden keine Manualseiten angezeigt, sondern nur eine Menge von Diagnoseinformation. - --ee _E_r_w_e_i_t_e_r_u_n_g_, ----eexxtteennssiioonn==_E_r_w_e_i_t_e_r_u_n_g + --ee _E_r_w_e_i_t_e_r_u_n_g,, ----eexxtteennssiioonn==_E_r_w_e_i_t_e_r_u_n_g Einige Systeme enthalten grosse Pakete an Manualseiten, wie z.B. in dem Tcl Paket, die in die normalen Manualabschnitte integriert werden. Um beispielsweise das Problem zweier unter- @@ -367,14 +367,14 @@ Seiten mit der Erweiterung **ttccll, wenn es mit --ee ttccll aufgerufen wurde. Die Suche wird dabei in allen Abschnitten durchgef\xFChrt. - --ff,, ----wwhhaattiiss + --ff, ----wwhhaattiiss Diese Option ist das AEquivalent zu whatis. Es wird eine Kurzbeschreibung der gewuenschten Manualseite angezeigt, wenn sie gefunden wurde. Zu Details siehe whatis(1). Mit dieser Option ist nur eine Standardsuche moeglich. Verbesserte Such- moeglichkeiten bieten die Optionen von whatis. - --kk,, ----aapprrooppooss + --kk, ----aapprrooppooss Diese Option ist das AEquivalent zu apropos. Es werden die Kurzbeschreibungen zu allen Manualseiten nach dem angegebenen Stichwort durchsucht. Zu Details siehe apropos(1). Mit dieser @@ -392,7 +392,7 @@ durch den Betriebssystemnamen man angesprochen. Diese Option ueberschreibt die Umgebungsvariable $SYSTEM. - --pp _Z_e_i_c_h_e_n_k_e_t_t_e_, ----pprreepprroocceessssoorr==_Z_e_i_c_h_e_n_k_e_t_t_e + --pp _Z_e_i_c_h_e_n_k_e_t_t_e,, ----pprreepprroocceessssoorr==_Z_e_i_c_h_e_n_k_e_t_t_e Diese Option gibt die Reihenfolge an, in der die Praeprozessoren vor nroff oder troff/groff abgearbeitet werden. Nicht alle Installationen haben notwendigerweise alle Praeprozessoren. @@ -402,7 +402,7 @@ $MANROFFSEQ. Der Praeprozessor zsoelim wird immer als erster gestartet. - --uu,, ----uuppddaattee + --uu, ----uuppddaattee Die Indexdatenbanken werden immer waehrend des laufenden Betriebes auf neuestem Stand gehalten, was insbesondere bedeutet, dass mandb nicht benoetigt wird, um sie konsistent zu @@ -414,7 +414,7 @@ Ebene durchgefuehrt werden soll, muss man die Option -u benutzen. - --tt,, ----ttrrooffff + --tt, ----ttrrooffff Mit dieser Option wird groff -mandoc verwendet, um die Manual- seite zu formatieren und an die Standardausgabe zu liefern. Im Zusammenhang mit -T oder -Z ist diese Option nicht noetig. @@ -425,7 +425,7 @@ die Angabe von -t. Verfuegbare Ausgabeformate (von Groff-1.17) beinhalten dvi, latin1, ps, utf8, X75 und X100. - --ZZ,, ----ddiittrrooffff + --ZZ, ----ddiittrrooffff Das traditionelle troff erzeugt ditroff. groff startet zunaechst troff und leitet danach dessen Ausgabe an einen fuer das gewaehlte Ausgabeformat geeigneten Postprozessor weiter. @@ -433,16 +433,16 @@ traditionelles troff zu emulieren und impliziert -t, andernfalls wird es ignoriert. - --ww,, ----wwhheerree,, ----llooccaattiioonn + --ww, ----wwhheerree, ----llooccaattiioonn Zeigt nicht die Manualseiten, sondern die Position der Dateien im Dateisystem an, die formatiert oder angezeigt wuerden. Wenn die Datei eine cat-Seite ist, wird auch der Ort ihrer nroff- Quelldatei angezeigt. - --hh,, ----hheellpp + --hh, ----hheellpp Zeigt einen Hilfstext an. - --VV,, ----vveerrssiioonn + --VV, ----vveerrssiioonn Zeigt Programmversion und Autor an. UUMMGGEEBBUUNNGG Modified: trunk/sandbox/manpage-writer/expected/man-de.1.man =================================================================== --- trunk/sandbox/manpage-writer/expected/man-de.1.man 2013-02-12 21:09:58 UTC (rev 7600) +++ trunk/sandbox/manpage-writer/expected/man-de.1.man 2013-02-12 21:24:37 UTC (rev 7601) @@ -363,7 +363,7 @@ Argument benötigen, überschreibt jedes Duplikat den vorhergehenden Wert. .INDENT 0.0 .TP -.B \-l, \-\-local\-file +.B \-l\fP,\fB \-\-local\-file Aktiviert den lokalen Modus. Formatiert und zeigt lokale Manualdateien an, anstatt die System\-Manualsammlung zu durchsuchen. Jedes Manualseiten\-Argument wird als nroff\-Quelle im richtigen @@ -373,7 +373,7 @@ Es wird keine cat\-Datei erzeugt. Wenn eines der Argumente \fB\-\fP ist, wird die Eingabe von der Standardeingabe uebernommen. .TP -.BI \-L \ locale, \ \-\-locale\fB= locale +.BI \-L \ locale\fP,\fB \ \-\-locale\fB= locale Normalerweise bestimmt man die aktuelle locale durch einen Aufruf der C Funktion setlocale (3), die diverse Umgebungsvari\- ablen, darunter u. U. $LC_MESSAGES und $LANG untersucht. Diese @@ -384,7 +384,7 @@ der Seite in Erscheinung tritt. Daher werden Ausgaben wie die Hilfeseite immer in der urspruenglichen Sprache ausgegeben. .TP -.B \-D, \-\-default +.B \-D\fP,\fB \-\-default Diese Option wird normalerweise nur als allererste angegeben und setzt das Verhalten von man in allen Belangen wieder zum Nor\- malverhalten zurueck. Der Zweck dieser Option ist es, Optionen @@ -392,18 +392,18 @@ able $MANOPT gesetzt sind. Alle Optionen, die \-D folgen, haben wieder ihren gewohnten Effekt. .TP -.BI \-M \ Pfad, \ \-\-manpath\fB= Pfad +.BI \-M \ Pfad\fP,\fB \ \-\-manpath\fB= Pfad Ermoeglicht es, einen alternativen Manualpfad anzugeben. Normalerweise verwendet man dieselben Methoden wie in manpath, um den Suchpfad zu ermitteln. Diese Option ueberschreibt die Umgebungsvariable \fB$MANPATH\fP. .TP -.BI \-P \ Pager, \ \-\-pager\fB= Pager +.BI \-P \ Pager\fP,\fB \ \-\-pager\fB= Pager Gibt an, welcher Pager verwendet wird. Die Normaleinstellung ist pager\-s. Diese Option ueberschreibt die Umgebungsvariable \fB$PAGER\fP und wird nicht in Zusammenhang mit \-f oder \-k verwendet. .TP -.BI \-r \ Prompt, \ \-\-prompt\fB= Prompt +.BI \-r \ Prompt\fP,\fB \ \-\-prompt\fB= Prompt Wenn eine hinreichend neue Version von less als Pager verwendet wird, versucht man dort einige sinnvolle Optionen zu setzen. Die Eingabeaufforderung in der letzten Zeile sieht in dem Fall so @@ -446,28 +446,28 @@ geschützten \fB$\fP am Ende der Zeichenkette hinzugefügt werden. Der Default ist hier \fB\-ix8\fP. .TP -.BI \-S \ Liste, \ \-\-sections\fB= Liste +.BI \-S \ Liste\fP,\fB \ \-\-sections\fB= Liste Eine durch Doppelpunkte getrennte Liste von Abschnitten definiert bei Benutzung dieser Option die Reihenfolge, in der die Abschnitte durchsucht werden. Diese Option ueberschreibt die Umgebungsvariable $MANSECT. .TP -.B \-a, \-\-all +.B \-a\fP,\fB \-\-all Wird eine Manualseite in einem Abschnitt gefunden, so terminiert man nach Anzeige dieser Seite. Wird jedoch diese Option angegeben, so werden alle passenden Manualseiten nacheinander angezeigt. .TP -.B \-c, \-\-catman +.B \-c\fP,\fB \-\-catman Diese Option ueberprueft nur, ob die zur angegebenen Manualseite passende cat\-Seite aktuell ist und erzeugt ggf. eine neue. Es wird dabei nichts angezeigt. .TP -.B \-d, \-\-debug +.B \-d\fP,\fB \-\-debug Bei dieser Option werden keine Manualseiten angezeigt, sondern nur eine Menge von Diagnoseinformation. .TP -.BI \-e \ Erweiterung, \ \-\-extension\fB= Erweiterung +.BI \-e \ Erweiterung\fP,\fB \ \-\-extension\fB= Erweiterung Einige Systeme enthalten grosse Pakete an Manualseiten, wie z.B. in dem Tcl Paket, die in die normalen Manualabschnitte integriert werden. Um beispielsweise das Problem zweier @@ -485,14 +485,14 @@ \fB\-e tcl\fP aufgerufen wurde. Die Suche wird dabei in allen Abschnitten durchgeführt. .TP -.B \-f, \-\-whatis +.B \-f\fP,\fB \-\-whatis Diese Option ist das AEquivalent zu whatis. Es wird eine Kurzbeschreibung der gewuenschten Manualseite angezeigt, wenn sie gefunden wurde. Zu Details siehe whatis(1). Mit dieser Option ist nur eine Standardsuche moeglich. Verbesserte Such\- moeglichkeiten bieten die Optionen von whatis. .TP -.B \-k, \-\-apropos +.B \-k\fP,\fB \-\-apropos Diese Option ist das AEquivalent zu apropos. Es werden die Kurzbeschreibungen zu allen Manualseiten nach dem angegebenen Stichwort durchsucht. Zu Details siehe apropos(1). Mit dieser @@ -514,7 +514,7 @@ .UNINDENT .INDENT 0.0 .TP -.BI \-p \ Zeichenkette, \ \-\-preprocessor\fB= Zeichenkette +.BI \-p \ Zeichenkette\fP,\fB \ \-\-preprocessor\fB= Zeichenkette Diese Option gibt die Reihenfolge an, in der die Praeprozessoren vor nroff oder troff/groff abgearbeitet werden. Nicht alle Installationen haben notwendigerweise alle Praeprozessoren. @@ -524,7 +524,7 @@ $MANROFFSEQ. Der Praeprozessor zsoelim wird immer als erster gestartet. .TP -.B \-u, \-\-update +.B \-u\fP,\fB \-\-update Die Indexdatenbanken werden immer waehrend des laufenden Betriebes auf neuestem Stand gehalten, was insbesondere bedeutet, dass mandb nicht benoetigt wird, um sie konsistent zu @@ -536,7 +536,7 @@ Ebene durchgefuehrt werden soll, muss man die Option \-u benutzen. .TP -.B \-t, \-\-troff +.B \-t\fP,\fB \-\-troff Mit dieser Option wird groff \-mandoc verwendet, um die Manual\- seite zu formatieren und an die Standardausgabe zu liefern. Im Zusammenhang mit \-T oder \-Z ist diese Option nicht noetig. @@ -551,7 +551,7 @@ .UNINDENT .INDENT 0.0 .TP -.B \-Z, \-\-ditroff +.B \-Z\fP,\fB \-\-ditroff Das traditionelle troff erzeugt ditroff. groff startet zunaechst troff und leitet danach dessen Ausgabe an einen fuer das gewaehlte Ausgabeformat geeigneten Postprozessor weiter. @@ -559,16 +559,16 @@ traditionelles troff zu emulieren und impliziert \-t, andernfalls wird es ignoriert. .TP -.B \-w, \-\-where, \-\-location +.B \-w\fP,\fB \-\-where\fP,\fB \-\-location Zeigt nicht die Manualseiten, sondern die Position der Dateien im Dateisystem an, die formatiert oder angezeigt wuerden. Wenn die Datei eine cat\-Seite ist, wird auch der Ort ihrer nroff\- Quelldatei angezeigt. .TP -.B \-h, \-\-help +.B \-h\fP,\fB \-\-help Zeigt einen Hilfstext an. .TP -.B \-V, \-\-version +.B \-V\fP,\fB \-\-version Zeigt Programmversion und Autor an. .UNINDENT .SH UMGEBUNG Modified: trunk/sandbox/manpage-writer/expected/man-de.1.utf8 =================================================================== --- trunk/sandbox/manpage-writer/expected/man-de.1.utf8 2013-02-12 21:09:58 UTC (rev 7600) +++ trunk/sandbox/manpage-writer/expected/man-de.1.utf8 2013-02-12 21:24:37 UTC (rev 7601) @@ -259,7 +259,7 @@ ein Argument benötigen, überschreibt jedes Duplikat den vorhergehenden Wert. - --ll,, ----llooccaall--ffiillee + --ll, ----llooccaall--ffiillee Aktiviert den lokalen Modus. Formatiert und zeigt lokale Manual‐ dateien an, anstatt die System-Manualsammlung zu durchsuchen. Jedes Manualseiten-Argument wird als nroff-Quelle im richtigen @@ -269,7 +269,7 @@ Es wird keine cat-Datei erzeugt. Wenn eines der Argumente -- ist, wird die Eingabe von der Standardeingabe uebernommen. - --LL _l_o_c_a_l_e_, ----llooccaallee==_l_o_c_a_l_e + --LL _l_o_c_a_l_e,, ----llooccaallee==_l_o_c_a_l_e Normalerweise bestimmt man die aktuelle locale durch einen Aufruf der C Funktion setlocale (3), die diverse Umgebungsvari- ablen, darunter u. U. $LC_MESSAGES und $LANG untersucht. Diese @@ -280,7 +280,7 @@ der Seite in Erscheinung tritt. Daher werden Ausgaben wie die Hilfeseite immer in der urspruenglichen Sprache ausgegeben. - --DD,, ----ddeeffaauulltt + --DD, ----ddeeffaauulltt Diese Option wird normalerweise nur als allererste angegeben und setzt das Verhalten von man in allen Belangen wieder zum Nor- malverhalten zurueck. Der Zweck dieser Option ist es, Optionen @@ -288,18 +288,18 @@ able $MANOPT gesetzt sind. Alle Optionen, die -D folgen, haben wieder ihren gewohnten Effekt. - --MM _P_f_a_d_, ----mmaannppaatthh==_P_f_a_d + --MM _P_f_a_d,, ----mmaannppaatthh==_P_f_a_d Ermoeglicht es, einen alternativen Manualpfad anzugeben. Nor‐ malerweise verwendet man dieselben Methoden wie in manpath, um den Suchpfad zu ermitteln. Diese Option ueberschreibt die Umge‐ bungsvariable $$MMAANNPPAATTHH. - --PP _P_a_g_e_r_, ----ppaaggeerr==_P_a_g_e_r + --PP _P_a_g_e_r,, ----ppaaggeerr==_P_a_g_e_r Gibt an, welcher Pager verwendet wird. Die Normaleinstellung ist pager-s. Diese Option ueberschreibt die Umgebungsvariable $$PPAAGGEERR und wird nicht in Zusammenhang mit -f oder -k verwendet. - --rr _P_r_o_m_p_t_, ----pprroommpptt==_P_r_o_m_p_t + --rr _P_r_o_m_p_t,, ----pprroommpptt==_P_r_o_m_p_t Wenn eine hinreichend neue Version von less als Pager verwendet wird, versucht man dort einige sinnvolle Optionen zu setzen. Die Eingabeaufforderung in der letzten Zeile sieht in dem Fall so @@ -329,28 +329,28 @@ geschützten $$ am Ende der Zeichenkette hinzugefügt werden. Der Default ist hier --iixx88. - --SS _L_i_s_t_e_, ----sseeccttiioonnss==_L_i_s_t_e + --SS _L_i_s_t_e,, ----sseeccttiioonnss==_L_i_s_t_e Eine durch Doppelpunkte getrennte Liste von Abschnitten definiert bei Benutzung dieser Option die Reihenfolge, in der die Abschnitte durchsucht werden. Diese Option ueberschreibt die Umgebungsvariable $MANSECT. - --aa,, ----aallll + --aa, ----aallll Wird eine Manualseite in einem Abschnitt gefunden, so terminiert man nach Anzeige dieser Seite. Wird jedoch diese Option angegeben, so werden alle passenden Manualseiten nacheinander angezeigt. - --cc,, ----ccaattmmaann + --cc, ----ccaattmmaann Diese Option ueberprueft nur, ob die zur angegebenen Manualseite passende cat-Seite aktuell ist und erzeugt ggf. eine neue. Es wird dabei nichts angezeigt. - --dd,, ----ddeebbuugg + --dd, ----ddeebbuugg Bei dieser Option werden keine Manualseiten angezeigt, sondern nur eine Menge von Diagnoseinformation. - --ee _E_r_w_e_i_t_e_r_u_n_g_, ----eexxtteennssiioonn==_E_r_w_e_i_t_e_r_u_n_g + --ee _E_r_w_e_i_t_e_r_u_n_g,, ----eexxtteennssiioonn==_E_r_w_e_i_t_e_r_u_n_g Einige Systeme enthalten grosse Pakete an Manualseiten, wie z.B. in dem Tcl Paket, die in die normalen Manualabschnitte integriert werden. Um beispielsweise das Problem zweier unter‐ @@ -367,14 +367,14 @@ Seiten mit der Erweiterung **ttccll, wenn es mit --ee ttccll aufgerufen wurde. Die Suche wird dabei in allen Abschnitten durchgeführt. - --ff,, ----wwhhaattiiss + --ff, ----wwhhaattiiss Diese Option ist das AEquivalent zu whatis. Es wird eine Kurzbeschreibung der gewuenschten Manualseite angezeigt, wenn sie gefunden wurde. Zu Details siehe whatis(1). Mit dieser Option ist nur eine Standardsuche moeglich. Verbesserte Such- moeglichkeiten bieten die Optionen von whatis. - --kk,, ----aapprrooppooss + --kk, ----aapprrooppooss Diese Option ist das AEquivalent zu apropos. Es werden die Kurzbeschreibungen zu allen Manualseiten nach dem angegebenen Stichwort durchsucht. Zu Details siehe apropos(1). Mit dieser @@ -392,7 +392,7 @@ durch den Betriebssystemnamen man angesprochen. Diese Option ueberschreibt die Umgebungsvariable $SYSTEM. - --pp _Z_e_i_c_h_e_n_k_e_t_t_e_, ----pprreepprroocceessssoorr==_Z_e_i_c_h_e_n_k_e_t_t_e + --pp _Z_e_i_c_h_e_n_k_e_t_t_e,, ----pprreepprroocceessssoorr==_Z_e_i_c_h_e_n_k_e_t_t_e Diese Option gibt die Reihenfolge an, in der die Praeprozessoren vor nroff oder troff/groff abgearbeitet werden. Nicht alle Installationen haben notwendigerweise alle Praeprozessoren. @@ -402,7 +402,7 @@ $MANROFFSEQ. Der Praeprozessor zsoelim wird immer als erster gestartet. - --uu,, ----uuppddaattee + --uu, ----uuppddaattee Die Indexdatenbanken werden immer waehrend des laufenden Betriebes auf neuestem Stand gehalten, was insbesondere bedeutet, dass mandb nicht benoetigt wird, um sie konsistent zu @@ -414,7 +414,7 @@ Ebene durchgefuehrt werden soll, muss man die Option -u benutzen. - --tt,, ----ttrrooffff + --tt, ----ttrrooffff Mit dieser Option wird groff -mandoc verwendet, um die Manual- seite zu formatieren und an die Standardausgabe zu liefern. Im Zusammenhang mit -T oder -Z ist diese Option nicht noetig. @@ -425,7 +425,7 @@ die Angabe von -t. Verfuegbare Ausgabeformate (von Groff-1.17) beinhalten dvi, latin1, ps, utf8, X75 und X100. - --ZZ,, ----ddiittrrooffff + --ZZ, ----ddiittrrooffff Das traditionelle troff erzeugt ditroff. groff startet zunaechst troff und leitet danach dessen Ausgabe an einen fuer das gewaehlte Ausgabeformat geeigneten Postprozessor weiter. @@ -433,16 +433,16 @@ traditionelles troff zu emulieren und impliziert -t, andernfalls wird es ignoriert. - --ww,, ----wwhheerree,, ----llooccaattiioonn + --ww, ----wwhheerree, ----llooccaattiioonn Zeigt nicht die Manualseiten, sondern die Position der Dateien im Dateisystem an, die formatiert oder angezeigt wuerden. Wenn die Datei eine cat-Seite ist, wird auch der Ort ihrer nroff- Quelldatei angezeigt. - --hh,, ----hheellpp + --hh, ----hheellpp Zeigt einen Hilfstext an. - --VV,, ----vveerrssiioonn + --VV, ----vveerrssiioonn Zeigt Programmversion und Autor an. UUMMGGEEBBUUNNGG Modified: trunk/sandbox/manpage-writer/expected/optionslisttest.latin1 =================================================================== --- trunk/sandbox/manpage-writer/expected/optionslisttest.latin1 2013-02-12 21:09:58 UTC (rev 7600) +++ trunk/sandbox/manpage-writer/expected/optionslisttest.latin1 2013-02-12 21:24:37 UTC (rev 7601) @@ -45,7 +45,7 @@ --bb another - --mm _M_E_S_S_A_G_E_, ----mmeessssaaggee==_M_E_S_S_A_G_E + --mm _M_E_S_S_A_G_E,, ----mmeessssaaggee==_M_E_S_S_A_G_E The message to display (beaware of ,,) EEXXAAMMPPLLEESS Modified: trunk/sandbox/manpage-writer/expected/optionslisttest.man =================================================================== --- trunk/sandbox/manpage-writer/expected/optionslisttest.man 2013-02-12 21:09:58 UTC (rev 7600) +++ trunk/sandbox/manpage-writer/expected/optionslisttest.man 2013-02-12 21:24:37 UTC (rev 7601) @@ -95,7 +95,7 @@ .B \-b another .TP -.BI \-m \ MESSAGE, \ \-\-message\fB= MESSAGE +.BI \-m \ MESSAGE\fP,\fB \ \-\-message\fB= MESSAGE The message to display (beaware of \fB,\fP) .UNINDENT .SH EXAMPLES Modified: trunk/sandbox/manpage-writer/expected/test.latin1 =================================================================== --- trunk/sandbox/manpage-writer/expected/test.latin1 2013-02-12 21:09:58 UTC (rev 7600) +++ trunk/sandbox/manpage-writer/expected/test.latin1 2013-02-12 21:24:37 UTC (rev 7601) @@ -18,7 +18,7 @@ --bb another - --ff,, ----ffoorrccee + --ff, ----ffoorrccee really do it For all other options see ----hheellpp. Modified: trunk/sandbox/manpage-writer/expected/test.man =================================================================== --- trunk/sandbox/manpage-writer/expected/test.man 2013-02-12 21:09:58 UTC (rev 7600) +++ trunk/sandbox/manpage-writer/expected/test.man 2013-02-12 21:24:37 UTC (rev 7601) @@ -49,7 +49,7 @@ .B \-b another .TP -.B \-f, \-\-force +.B \-f\fP,\fB \-\-force really do it .UNINDENT .sp This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <gr...@us...> - 2013-02-16 22:01:41
|
Revision: 7605 http://docutils.svn.sourceforge.net/docutils/?rev=7605&view=rev Author: grubert Date: 2013-02-16 22:01:32 +0000 (Sat, 16 Feb 2013) Log Message: ----------- move comment "Man page generated from reStructuredText." to first line (always) Modified Paths: -------------- trunk/docutils/docutils/writers/manpage.py trunk/docutils/test/test_writers/test_manpage.py trunk/sandbox/manpage-writer/expected/characters.man trunk/sandbox/manpage-writer/expected/compact_lists.man Modified: trunk/docutils/docutils/writers/manpage.py =================================================================== --- trunk/docutils/docutils/writers/manpage.py 2013-02-16 19:48:49 UTC (rev 7604) +++ trunk/docutils/docutils/writers/manpage.py 2013-02-16 22:01:32 UTC (rev 7605) @@ -246,7 +246,7 @@ def ensure_eol(self): """Ensure the last line in body is terminated by new line.""" - if self.body[-1][-1] != '\n': + if len(self.body) > 0 and self.body[-1][-1] != '\n': self.body.append('\n') def astext(self): @@ -377,7 +377,7 @@ # .TH title_upper section date source manual if self.header_written: return - self.body.append(self.header()) + self.head.append(self.header()) self.body.append(MACRO_DEF) self.header_written = 1 @@ -573,7 +573,7 @@ def visit_document(self, node): # no blank line between comment and header. - self.body.append(self.comment(self.document_start).rstrip()+'\n') + self.head.append(self.comment(self.document_start).rstrip()+'\n') # writing header is postboned self.header_written = 0 Modified: trunk/docutils/test/test_writers/test_manpage.py =================================================================== --- trunk/docutils/test/test_writers/test_manpage.py 2013-02-16 19:48:49 UTC (rev 7604) +++ trunk/docutils/test/test_writers/test_manpage.py 2013-02-16 22:01:32 UTC (rev 7605) @@ -51,11 +51,11 @@ totest['blank'] = [ ["", - r""".TH "" "" "" + r""".\" Man page generated from reStructuredText. +. +.TH "" "" "" .SH NAME \- -.\" Man page generated from reStructuredText. -. .\" Generated by docutils manpage writer. . """], @@ -191,11 +191,11 @@ ====== ===== """, '''\ +.\\" Man page generated from reStructuredText. +. .TH "" "" "" .SH NAME \\- \n\ -.\\" Man page generated from reStructuredText. -. .INDENT 0.0 .INDENT 3.5 .TS @@ -248,11 +248,11 @@ bla bla bla """, """\ +.\\" Man page generated from reStructuredText. +. .TH "" "" "" .SH NAME \\- \n\ -.\\" Man page generated from reStructuredText. -. optin group with dot as group item .INDENT 0.0 .TP @@ -304,11 +304,11 @@ """, '''\ +.\\" Man page generated from reStructuredText. +. .TH DEFINITION LIST TEST "" "" "" .SH NAME Definition List Test \\- \n\ -.\\" Man page generated from reStructuredText. -. .SS Abstract .sp Docinfo is required. Modified: trunk/sandbox/manpage-writer/expected/characters.man =================================================================== --- trunk/sandbox/manpage-writer/expected/characters.man 2013-02-16 19:48:49 UTC (rev 7604) +++ trunk/sandbox/manpage-writer/expected/characters.man 2013-02-16 22:01:32 UTC (rev 7605) @@ -1,8 +1,8 @@ +.\" Man page generated from reStructuredText. +. .TH SPECIAL CHARACTERS "" "" "" .SH NAME special characters \- test special characters -.\" Man page generated from reStructuredText. -. .SH SEE ALSO .sp In mercurial the following substitutions are in use: Modified: trunk/sandbox/manpage-writer/expected/compact_lists.man =================================================================== --- trunk/sandbox/manpage-writer/expected/compact_lists.man 2013-02-16 19:48:49 UTC (rev 7604) +++ trunk/sandbox/manpage-writer/expected/compact_lists.man 2013-02-16 22:01:32 UTC (rev 7605) @@ -1,8 +1,8 @@ +.\" Man page generated from reStructuredText. +. .TH "" "" "" .SH NAME \- -.\" Man page generated from reStructuredText. -. .INDENT 0.0 .IP \(bu 2 This is an ordinary simple bullet list. This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <gr...@us...> - 2013-02-16 22:22:29
|
Revision: 7607 http://docutils.svn.sourceforge.net/docutils/?rev=7607&view=rev Author: grubert Date: 2013-02-16 22:22:22 +0000 (Sat, 16 Feb 2013) Log Message: ----------- always include macro def Modified Paths: -------------- trunk/docutils/docutils/writers/manpage.py trunk/docutils/test/test_writers/test_manpage.py trunk/sandbox/manpage-writer/expected/characters.ascii trunk/sandbox/manpage-writer/expected/characters.latin1 trunk/sandbox/manpage-writer/expected/characters.man trunk/sandbox/manpage-writer/expected/characters.utf8 trunk/sandbox/manpage-writer/expected/compact_lists.man Modified: trunk/docutils/docutils/writers/manpage.py =================================================================== --- trunk/docutils/docutils/writers/manpage.py 2013-02-16 22:07:15 UTC (rev 7606) +++ trunk/docutils/docutils/writers/manpage.py 2013-02-16 22:22:22 UTC (rev 7607) @@ -253,7 +253,7 @@ """Return the final formatted document as a string.""" if not self.header_written: # ensure we get a ".TH" as viewers require it. - self.head.append(self.header()) + self.append_header() # filter body for i in xrange(len(self.body)-1, 0, -1): # remove superfluous vertical gaps. Modified: trunk/docutils/test/test_writers/test_manpage.py =================================================================== --- trunk/docutils/test/test_writers/test_manpage.py 2013-02-16 22:07:15 UTC (rev 7606) +++ trunk/docutils/test/test_writers/test_manpage.py 2013-02-16 22:22:22 UTC (rev 7607) @@ -56,7 +56,8 @@ .TH "" "" "" .SH NAME \- -.\" Generated by docutils manpage writer. +"""+indend_macros+ +r""".\" Generated by docutils manpage writer. . """], ] @@ -196,7 +197,8 @@ .TH "" "" "" .SH NAME \\- \n\ -.INDENT 0.0 +'''+indend_macros+ +'''.INDENT 0.0 .INDENT 3.5 .TS center; @@ -253,7 +255,8 @@ .TH "" "" "" .SH NAME \\- \n\ -optin group with dot as group item +"""+indend_macros+ +"""optin group with dot as group item .INDENT 0.0 .TP .B $ @@ -309,7 +312,8 @@ .TH DEFINITION LIST TEST "" "" "" .SH NAME Definition List Test \\- \n\ -.SS Abstract +'''+indend_macros+ +'''.SS Abstract .sp Docinfo is required. .SH SECTION Modified: trunk/sandbox/manpage-writer/expected/characters.ascii =================================================================== --- trunk/sandbox/manpage-writer/expected/characters.ascii 2013-02-16 22:07:15 UTC (rev 7606) +++ trunk/sandbox/manpage-writer/expected/characters.ascii 2013-02-16 22:22:22 UTC (rev 7607) @@ -8,9 +8,9 @@ SSEEEE AALLSSOO In mercurial the following substitutions are in use: - .. |hg(1)| replace:: **hg**\ (1) - .. |hgrc(5)| replace:: **hgrc**\ (5) - .. |hgignore(5)| replace:: **hgignore**\ (5) + .. |hg(1)| replace:: **hg**\ (1) + .. |hgrc(5)| replace:: **hgrc**\ (5) + .. |hgignore(5)| replace:: **hgignore**\ (5) resulting in. @@ -21,22 +21,22 @@ +o accents: - +o right: ' + +o right: ' - +o left: ` + +o left: ` +o quotes: - +o straight: ' + +o straight: ' - +o double: " + +o double: " - +o single: ' ' + +o single: ' ' - +o double: " " + +o double: " " - Some text afterwards, test.txt ended with quotes test. Unicode - breaks the man processing chain. The display ends with ssiinnggllee:: . + Some text afterwards, test.txt ended with quotes test. Unicode breaks + the man processing chain. The display ends with ssiinnggllee:: . Modified: trunk/sandbox/manpage-writer/expected/characters.latin1 =================================================================== --- trunk/sandbox/manpage-writer/expected/characters.latin1 2013-02-16 22:07:15 UTC (rev 7606) +++ trunk/sandbox/manpage-writer/expected/characters.latin1 2013-02-16 22:22:22 UTC (rev 7607) @@ -8,9 +8,9 @@ SSEEEE AALLSSOO In mercurial the following substitutions are in use: - .. |hg(1)| replace:: **hg**\ (1) - .. |hgrc(5)| replace:: **hgrc**\ (5) - .. |hgignore(5)| replace:: **hgignore**\ (5) + .. |hg(1)| replace:: **hg**\ (1) + .. |hgrc(5)| replace:: **hgrc**\ (5) + .. |hgignore(5)| replace:: **hgignore**\ (5) resulting in. @@ -21,22 +21,22 @@ \xB7 accents: - \xB7 right: \xB4 + \xB7 right: \xB4 - \xB7 left: ` + \xB7 left: ` \xB7 quotes: - \xB7 straight: ' + \xB7 straight: ' - \xB7 double: " + \xB7 double: " - \xB7 single: ' ' + \xB7 single: ' ' - \xB7 double: " " + \xB7 double: " " - Some text afterwards, test.txt ended with quotes test. Unicode - breaks the man processing chain. The display ends with ssiinnggllee:: . + Some text afterwards, test.txt ended with quotes test. Unicode breaks + the man processing chain. The display ends with ssiinnggllee:: . Modified: trunk/sandbox/manpage-writer/expected/characters.man =================================================================== --- trunk/sandbox/manpage-writer/expected/characters.man 2013-02-16 22:07:15 UTC (rev 7606) +++ trunk/sandbox/manpage-writer/expected/characters.man 2013-02-16 22:22:22 UTC (rev 7607) @@ -3,6 +3,33 @@ .TH SPECIAL CHARACTERS "" "" "" .SH NAME special characters \- test special characters +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. .SH SEE ALSO .sp In mercurial the following substitutions are in use: Modified: trunk/sandbox/manpage-writer/expected/characters.utf8 =================================================================== --- trunk/sandbox/manpage-writer/expected/characters.utf8 2013-02-16 22:07:15 UTC (rev 7606) +++ trunk/sandbox/manpage-writer/expected/characters.utf8 2013-02-16 22:22:22 UTC (rev 7607) @@ -8,9 +8,9 @@ SSEEEE AALLSSOO In mercurial the following substitutions are in use: - .. |hg(1)| replace:: **hg**\ (1) - .. |hgrc(5)| replace:: **hgrc**\ (5) - .. |hgignore(5)| replace:: **hgignore**\ (5) + .. |hg(1)| replace:: **hg**\ (1) + .. |hgrc(5)| replace:: **hgrc**\ (5) + .. |hgignore(5)| replace:: **hgignore**\ (5) resulting in. @@ -21,22 +21,22 @@ · accents: - · right: ´ + · right: ´ - · left: ` + · left: ` · quotes: - · straight: ' + · straight: ' - · double: " + · double: " - · single: ‘ ’ + · single: ‘ ’ - · double: “ ” + · double: “ ” - Some text afterwards, test.txt ended with quotes test. Unicode - breaks the man processing chain. The display ends with ssiinnggllee:: . + Some text afterwards, test.txt ended with quotes test. Unicode breaks + the man processing chain. The display ends with ssiinnggllee:: . Modified: trunk/sandbox/manpage-writer/expected/compact_lists.man =================================================================== --- trunk/sandbox/manpage-writer/expected/compact_lists.man 2013-02-16 22:07:15 UTC (rev 7606) +++ trunk/sandbox/manpage-writer/expected/compact_lists.man 2013-02-16 22:22:22 UTC (rev 7607) @@ -3,6 +3,33 @@ .TH "" "" "" .SH NAME \- +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. .INDENT 0.0 .IP \(bu 2 This is an ordinary simple bullet list. This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <gr...@us...> - 2013-07-13 18:15:46
|
Revision: 7687 http://sourceforge.net/p/docutils/code/7687 Author: grubert Date: 2013-07-13 18:15:43 +0000 (Sat, 13 Jul 2013) Log Message: ----------- testing on ubuntu 10.04 installation broken because of different module directory: revert Modified Paths: -------------- trunk/docutils/HISTORY.txt trunk/docutils/RELEASE-NOTES.txt trunk/docutils/docutils/__init__.py trunk/sandbox/infrastructure/releasing-log.txt Modified: trunk/docutils/HISTORY.txt =================================================================== --- trunk/docutils/HISTORY.txt 2013-07-13 18:14:43 UTC (rev 7686) +++ trunk/docutils/HISTORY.txt 2013-07-13 18:15:43 UTC (rev 7687) @@ -13,8 +13,8 @@ .. contents:: -Release 0.11 (2013-07-13) -========================= +Changes Since 0.10 +================== * General Modified: trunk/docutils/RELEASE-NOTES.txt =================================================================== --- trunk/docutils/RELEASE-NOTES.txt 2013-07-13 18:14:43 UTC (rev 7686) +++ trunk/docutils/RELEASE-NOTES.txt 2013-07-13 18:15:43 UTC (rev 7687) @@ -29,8 +29,8 @@ element with class attribute and auto-generated title. -Release 0.11 (2013-07-13) -========================= +Changes Since 0.10 +================== * General Modified: trunk/docutils/docutils/__init__.py =================================================================== --- trunk/docutils/docutils/__init__.py 2013-07-13 18:14:43 UTC (rev 7686) +++ trunk/docutils/docutils/__init__.py 2013-07-13 18:15:43 UTC (rev 7687) @@ -59,7 +59,7 @@ number will be bumped when the project is feature-complete, and perhaps if there is a major change in the design.""" -__version_details__ = 'release' +__version_details__ = 'repository' """Extra version details (e.g. 'snapshot 2005-05-29, r3410', 'repository', 'release'), modified automatically & manually.""" Modified: trunk/sandbox/infrastructure/releasing-log.txt =================================================================== --- trunk/sandbox/infrastructure/releasing-log.txt 2013-07-13 18:14:43 UTC (rev 7686) +++ trunk/sandbox/infrastructure/releasing-log.txt 2013-07-13 18:15:43 UTC (rev 7687) @@ -26,14 +26,28 @@ python 3.2: roman.py for py3 required. - Release.sh ---------- release.sh does not work on MacOSX. +installation on ubuntu 10.04 breaks test script:: + Working directory: /usr/local/lib/python2.6/site-packages/docutils-test + Docutils package: /usr/local/lib/python2.6/dist-packages/docutils + ====================================================================== + FAIL: test_find_file_in_dirs (test_utils.HelperFunctionsTests) + ---------------------------------------------------------------------- + Traceback (most recent call last): + File "/usr/local/lib/python2.6/site-packages/docutils-test/test_utils.py", line 295, in test_find_file_in_dirs + '../HISTORY.txt') + AssertionError: 'HISTORY.txt' != '../HISTORY.txt' + +Stopping for now. + + + Release 0.10 ============ This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <gr...@us...> - 2013-07-22 08:10:33
|
Revision: 7696 http://sourceforge.net/p/docutils/code/7696 Author: grubert Date: 2013-07-22 08:10:29 +0000 (Mon, 22 Jul 2013) Log Message: ----------- change version number to 0.11 add a reminder fpr 0.12 Modified Paths: -------------- trunk/docutils/README.txt trunk/sandbox/infrastructure/release.sh Modified: trunk/docutils/README.txt =================================================================== --- trunk/docutils/README.txt 2013-07-22 08:07:03 UTC (rev 7695) +++ trunk/docutils/README.txt 2013-07-22 08:10:29 UTC (rev 7696) @@ -1,5 +1,5 @@ ======================= - README: Docutils 0.10 + README: Docutils 0.11 ======================= :Author: David Goodger Modified: trunk/sandbox/infrastructure/release.sh =================================================================== --- trunk/sandbox/infrastructure/release.sh 2013-07-22 08:07:03 UTC (rev 7695) +++ trunk/sandbox/infrastructure/release.sh 2013-07-22 08:10:29 UTC (rev 7696) @@ -330,6 +330,7 @@ echo "Now updating the following files: $history_files" old_string="Changes Since [0-9.]+" new_string="Release $new_ver (`date --utc --iso-8601`)" + echo 'Please change version number in README.txt' echo 'Press enter to replace "'"$old_string"'" with "'"$new_string"\", echo 'or enter anything to skip.' read This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <gr...@us...> - 2013-07-22 08:28:49
|
Revision: 7700 http://sourceforge.net/p/docutils/code/7700 Author: grubert Date: 2013-07-22 08:28:47 +0000 (Mon, 22 Jul 2013) Log Message: ----------- change README to 0.12 and move reminder in release.sh Modified Paths: -------------- trunk/docutils/README.txt trunk/sandbox/infrastructure/release.sh Modified: trunk/docutils/README.txt =================================================================== --- trunk/docutils/README.txt 2013-07-22 08:28:06 UTC (rev 7699) +++ trunk/docutils/README.txt 2013-07-22 08:28:47 UTC (rev 7700) @@ -1,5 +1,5 @@ ======================= - README: Docutils 0.11 + README: Docutils 0.12 ======================= :Author: David Goodger Modified: trunk/sandbox/infrastructure/release.sh =================================================================== --- trunk/sandbox/infrastructure/release.sh 2013-07-22 08:28:06 UTC (rev 7699) +++ trunk/sandbox/infrastructure/release.sh 2013-07-22 08:28:47 UTC (rev 7700) @@ -330,7 +330,6 @@ echo "Now updating the following files: $history_files" old_string="Changes Since [0-9.]+" new_string="Release $new_ver (`date --utc --iso-8601`)" - echo 'Please change version number in README.txt' echo 'Press enter to replace "'"$old_string"'" with "'"$new_string"\", echo 'or enter anything to skip.' read @@ -432,6 +431,7 @@ cd "$working_copy" fi set_ver "$new_ver" "$svn_ver" + echo 'Please change version number in README.txt' echo echo 'Please update the web page now (web/index.txt).' echo 'cd into sandbox/infrastructure' This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <mi...@us...> - 2015-02-21 16:59:32
|
Revision: 7798 http://sourceforge.net/p/docutils/code/7798 Author: milde Date: 2015-02-21 16:59:18 +0000 (Sat, 21 Feb 2015) Log Message: ----------- New HTML writer generating `XHTML1.1`_ styled with CSS2. Moved to the docutils core from sandbox/html4strict. .. _XHTML1.1: http://www.w3.org/TR/xhtml11/ Modified Paths: -------------- trunk/docutils/HISTORY.txt trunk/docutils/RELEASE-NOTES.txt trunk/docutils/docutils/writers/html4css1/__init__.py trunk/docutils/docutils/writers/xhtml11/__init__.py trunk/docutils/setup.py trunk/sandbox/html4strict/README.txt Added Paths: ----------- trunk/docutils/docutils/writers/xhtml11/ trunk/docutils/docutils/writers/xhtml11/xhtml11.css trunk/docutils/test/functional/expected/standalone_rst_xhtml11.xhtml trunk/docutils/test/functional/input/data/xhtml11.css trunk/docutils/test/functional/input/standalone_rst_xhtml11.txt trunk/docutils/test/functional/tests/standalone_rst_xhtml11.py trunk/docutils/tools/rst2xhtml11.py Removed Paths: ------------- trunk/docutils/docutils/writers/xhtml11/html4css2.css trunk/sandbox/html4strict/data/standalone_rst_html4strict.txt trunk/sandbox/html4strict/data/standalone_rst_html4strict.xhtml trunk/sandbox/html4strict/html4strict/ trunk/sandbox/html4strict/tools/ Modified: trunk/docutils/HISTORY.txt =================================================================== --- trunk/docutils/HISTORY.txt 2015-02-19 18:31:56 UTC (rev 7797) +++ trunk/docutils/HISTORY.txt 2015-02-21 16:59:18 UTC (rev 7798) @@ -26,24 +26,32 @@ * docutils/parsers/rst/directives/tables.py - - patch [ 120 ] tables accept option widths: list of relative widths, 'auto' + - patch [ 120 ] tables accept option widths: list of relative widths, 'auto' or 'grid'. * docutils/utils/math/math2html.py - add ``\colon`` macro, fix spacing around colons. Fixes [ 246 ]. - -* docutils/writers/html4css1/__init__.py +* docutils/writers/html4css1/__init__.py + - Add "docutils" to class values for "container" object to address [ 267 ]. - Apply patch [ 119 ] by Anatoly Techtonik: use absolute paths for ``default_stylesheet_path`` and ``default_template_path``. -* docutils/writers/latex2e/__init__.py +* docutils/writers/xhtml11/ + - New HTML writer generating `XHTML1.1`_ styled with CSS2. + + Moved to the docutils core from sandbox/html4strict. + + .. _XHTML1.1: http://www.w3.org/TR/xhtml11/ + +* docutils/writers/latex2e/__init__.py + - use absolute path for ``default_template_path``. -* docutils/writers/odf_odt/__init__.py +* docutils/writers/odf_odt/__init__.py - remove decode.encode of filename stored in zip. @@ -62,7 +70,7 @@ * docutils/parsers/rst/directives/images.py - Fix [ 258 ] figwidth="image" generates unitless width value. - + * docutils/parsers/rst/states.py - Improve error report when a non-ASCII character is specified as Modified: trunk/docutils/RELEASE-NOTES.txt =================================================================== --- trunk/docutils/RELEASE-NOTES.txt 2015-02-19 18:31:56 UTC (rev 7797) +++ trunk/docutils/RELEASE-NOTES.txt 2015-02-21 16:59:18 UTC (rev 7798) @@ -22,6 +22,11 @@ * remove the `handle_io_errors` option from io.FileInput/Output. +* remove deprecated options from the latex2e writer: + + --use-latex-footnotes Alias for --docutils-footnotes (deprecated) + --figure-footnotes Use figure floats for footnote text (deprecated) + * »Prune« the doctree (no change to the reST input syntax): - "doctest" element -> literal block with class argument, @@ -29,7 +34,7 @@ element with class attribute and auto-generated title. * Move to single source for Python 2 and Python 3, slowly. - See `Porting Python 2 Code to Python 3`_ and + See `Porting Python 2 Code to Python 3`_ and `future: clean single-source support for Python 2/3`_ - Drop support for python 2.4 probably after 0.12 release. Modified: trunk/docutils/docutils/writers/html4css1/__init__.py =================================================================== --- trunk/docutils/docutils/writers/html4css1/__init__.py 2015-02-19 18:31:56 UTC (rev 7797) +++ trunk/docutils/docutils/writers/html4css1/__init__.py 2015-02-21 16:59:18 UTC (rev 7798) @@ -42,7 +42,7 @@ supported = ('html', 'html4css1', 'xhtml') """Formats this writer supports.""" - default_stylesheet = 'html4css1.css' + default_stylesheets = ['html4css1.css'] default_stylesheet_dirs = ['.', os.path.abspath(os.path.dirname(__file__))] default_template = 'template.txt' @@ -65,11 +65,11 @@ 'Relative paths are expanded if a matching file is found in ' 'the --stylesheet-dirs. With --link-stylesheet, ' 'the path is rewritten relative to the output HTML file. ' - 'Default: "%s"' % default_stylesheet, + 'Default: "%s"' % ','.join(default_stylesheets), ['--stylesheet-path'], {'metavar': '<file[,file,...]>', 'overrides': 'stylesheet', 'validator': frontend.validate_comma_separated_list, - 'default': [default_stylesheet]}), + 'default': default_stylesheets}), ('Embed the stylesheet(s) in the output HTML file. The stylesheet ' 'files must be accessible during processing. This is the default.', ['--embed-stylesheet'], Modified: trunk/docutils/docutils/writers/xhtml11/__init__.py =================================================================== --- trunk/sandbox/html4strict/html4strict/__init__.py 2015-02-11 12:45:33 UTC (rev 7786) +++ trunk/docutils/docutils/writers/xhtml11/__init__.py 2015-02-21 16:59:18 UTC (rev 7798) @@ -37,29 +37,41 @@ supported = ('html', 'xhtml', 'xhtml1', 'html4strict', 'xhtml1strict', - 'html4css2', 'xhtml1css2') + 'xhtml11', 'xhtml1css2') """Formats this writer supports.""" - default_stylesheets = ['html4css1.css', 'html4css2.css'] + default_stylesheets = ['html4css1.css', 'xhtml11.css'] + default_stylesheet_dirs = ['.', + os.path.abspath(os.path.dirname(__file__)), + os.path.abspath(os.path.join( + os.path.dirname(os.path.dirname(__file__)), 'html4css1')) + ] - default_stylesheet_path = ','.join( - [os.path.join(os.path.dirname(__file__), stylesheet) - for stylesheet in default_stylesheets]) - - config_section = 'html4strict writer' + config_section = 'xhtml11 writer' config_section_dependencies = ('writers', 'html4css1 writer') settings_spec = frontend.filter_settings_spec( html4css1.Writer.settings_spec, - 'field_name_limit', 'option_limit', + 'field_name_limit', 'option_limit', # removed options stylesheet_path = ( - 'Specify comma separated list of stylesheet paths. ' - 'With --link-stylesheet, ' - 'the path is rewritten relative to the output HTML file. ' - 'Default: "%s"' % default_stylesheet_path, - ['--stylesheet-path'], - {'metavar': '<file>', 'overrides': 'stylesheet', - 'default': default_stylesheet_path}), + 'Comma separated list of stylesheet paths. ' + 'Relative paths are expanded if a matching file is found in ' + 'the --stylesheet-dirs. With --link-stylesheet, ' + 'the path is rewritten relative to the output HTML file. ' + 'Default: "%s"' % ','.join(default_stylesheets), + ['--stylesheet-path'], + {'metavar': '<file[,file,...]>', 'overrides': 'stylesheet', + 'validator': frontend.validate_comma_separated_list, + 'default': default_stylesheets}), + + stylesheet_dirs = ( + 'Comma-separated list of directories where stylesheets are found. ' + 'Used by --stylesheet-path when expanding relative path arguments. ' + 'Default: "%s"' % default_stylesheet_dirs, + ['--stylesheet-dirs'], + {'metavar': '<dir[,dir,...]>', + 'validator': frontend.validate_comma_separated_list, + 'default': default_stylesheet_dirs}), math_output = ('Math output format, one of "MathML", "HTML", ' '"MathJax" or "LaTeX". Default: "MathML"', ['--math-output'], @@ -73,7 +85,7 @@ class HTMLTranslator(html4css1.HTMLTranslator): """ This writer generates XHTML 1.1 - without formatting hints that interfere with a CSS stylesheet. + without formatting that interferes with a CSS stylesheet. """ doctype = ('<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" ' '"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\n') Deleted: trunk/docutils/docutils/writers/xhtml11/html4css2.css =================================================================== --- trunk/sandbox/html4strict/html4strict/html4css2.css 2015-02-11 12:45:33 UTC (rev 7786) +++ trunk/docutils/docutils/writers/xhtml11/html4css2.css 2015-02-21 16:59:18 UTC (rev 7798) @@ -1,371 +0,0 @@ -/* html4css2.css: Cascading style sheet for Docutils' html4strict writer. */ -/* */ -/* :Author: Günter Milde */ -/* :Copyright: © 2009 Günter Milde. */ -/* Released without warranties or conditions of any kind */ -/* under the terms of the Apache License, Version 2.0 */ -/* http://www.apache.org/licenses/LICENSE-2.0 */ -/* */ -/* This stylesheet supplements the Docutils standard style 'html4css1.css'. */ -/* It uses CSS 2.1 elements (supported by up-to-date versions of popular */ -/* browsers). */ - -/* General rules */ -/* ============= */ - -body { - padding: 0 5%; - margin: 8px 0; - line-height:1.3; - /* http://ilovetypography.com/2008/02/28/a-guide-to-web-typography/ - recommends "line-spacing that’s at least 140% of your text size" */ - counter-reset: table; - /* counter-reset: figure; */ -} - -/* avoid long lines --> better reading */ -/* OTOH: lines should not be too short because of missing hyphenation, */ -div.document { - max-width: 45em; - margin: auto; -} - -/* separate items except for compact lists */ -dl > dd { - margin-bottom: 1em; -} -.compact li, .compact p, .compact ul, .compact ol -dl.simple > dd, .simple li, .simple p, .simple ul, .simple ol { - margin-top: 0; - margin-bottom: 0; -/* background: magenta; */ -} -dl.simple, dl.compact, dl.simple > dd, dl.compact > dd { - margin-top: 0; - margin-bottom: 0; -/* background: lightgreen; */ -} - -/* space around paragraphs */ -dl > dd p:first-child, td > p { - margin: 0; -} - -/* Sidebar */ -/* ------- */ - -div.sidebar { - margin-right: -5%; -} - -/* Special definition lists */ -/* ======================== */ - -/* bold definition term on the same line as the label */ -dl.field-list > dt, dl.option-list > dt, dl.docinfo > dt, -dl.footnote > dt, dl.citation > dt, dl.description > dt { - clear: left; - float: left; - margin: 0; - padding: 0; - padding-right: 0.5em; - font-weight: bold; -} -/* except for these */ -dl.option-list > dt, dl.footnote > dt { - font-weight: normal; -} - - - -/* Field Lists */ -/* ----------- */ - -/* field names followed by a colon */ -dl.field-list > dt:after, dl.docinfo > dt:after { - content: ":"; -} - -/* Offset for field content (corresponds to the --field-name-limit option) */ -dl.field-list > dd { - margin-left: 9em; /* ca. 14 chars in the test examples */ - padding-left: 0.5em; -} - -/* start field-body on a new line after long field names */ -dl.field-list > dd p { - width: 100%; -/* display: inline-block; */ -/* background: yellow; */ -} - -dl.field-list > dd > p:first-child, -/* dl.field-list > dd > ol:first-child, */ -/* dl.field-list > dd > ul:first-child, */ -dl.field-list > dd > dl:first-child { - display: inline-block; -} - -/* field-list variants:: */ - -/* example for custom field-name width */ -dl.field-list.narrow > dd { - margin-left: 5em; -} - -/* start field-body on same line after long field names */ -dl.field-list.run-in > dd p { - display: block; -} - -/* wrap or truncate long field names */ -dl.field-list.fix-labelwidth > dt { - width: 8em; /* set to dl.field-list > dd margin-left - padding-left */ - overflow: hidden; -} -dl.field-list.fix-labelwidth > dd:after { - /* a "stopper" to prevent next dd floating up too far */ - content: ''; - display: block; - clear: left; -} - -/* docinfo */ - -dl.docinfo > dd { - margin-left: 8em; -/* margin-bottom: 0.5em; */ -} - - -/* option list */ - -dl.option-list { - margin-left: 1em; - padding-left: 0; -} - -dl.option-list > dd { - margin-left: 8em; - /* margin-bottom: 0.5em; */ -} - -/* start description on a new line after long options */ -dl.option-list > dd p { - width: 100%; - display: inline-block; -} - -/* footnotes */ - -a.footnote-reference, a.fn-backref { - text-decoration: inherit; /* do not underline footnote links */ -} - -dl.footnote { - /* line on the left */ - padding-left: 1ex; - border-left: solid; - border-left-width: thin; - /* border-color: black; */ -} - -/* paragraph on same line as backrefs */ -dd > em { -/* background: green; */ - float: left; - margin-right: 1ex -} - - -/* -Ordered List (Enumeration) --------------------------- - -Use counters to replace the deprecated start attribute. Make sure the -resulting list resembles the list-style 'outside' with a hanging indent. -*/ - -/* New ordered list: reset counter, suppress the default label */ -ol, ol.arabic, ol.loweralpha, ol.upperalpha, -ol.lowerroman, ol.upperroman { - counter-reset: item; - list-style: none -} - -/* Set the negative indent of the list label as feature of the list item */ -ol > li { - text-indent: -40px; /* Mozillas default indent */ -} -/* reset for child elements */ -ol > li > * { - text-indent: 0px; - text-indent: 0; - margin-top: 0; - /* background: lightgreen; */ -} - -/* Label */ -ol > li:before { - /* increment and typeset counter(s), */ - counter-increment: item; - content: counter(item) "."; - /* display next to the content (aligned top-right), */ - display: inline-block; - text-align: right; - vertical-align: top; - /* sum must match ol>li {text-indent:} (40px is Mozillas default) */ - width: 35px; - padding-right: 5px; -/* background: yellow; */ -} - -/* The list item's first line starts next to the label, without indent */ -ol > li > p:first-child, -ol > li > ol:first-child, -ol > li > ul:first-child, -ol > li > dl:first-child { - display: inline-block; - /* background: lightblue; */ -} - -/* default separator variants */ -ol.loweralpha > li:before { - content: counter(item, lower-alpha) ")"; -} -ol.upperalpha > li:before { - content: counter(item, upper-alpha) "."; -} -ol.lowerroman > li:before { - content: "(" counter(item, lower-roman) ")"; -} -ol.upperroman > li:before { - content: counter(item, upper-roman) ")"; -} -/* nested counters (1, 1.1, 1.1.1, etc) */ -/* nested enumerated lists "inherit" the class attribute, other lists not */ -ol.nested > li:before, ol.nested ol > li:before { - content: counters(item, ".") " "; -} - -/* lists nested in definition list */ - -dd > ul, dd > ol { - padding-left: 0pt; -} - -/* TODO: prefix, suffix? */ - -/* smaller font for super- and subscripts */ -/* sub, sup {font-size: 70%;} */ /* Mozilla default is `smaller` */ - - -/* Tables */ -/* ====== */ - -/* margins and borders for "normal" tables */ -table { -/* background: magenta; */ - margin-top: 1em ; - margin-bottom: 1em; -/* border-style: outset; */ - border-style: solid; - border-color: silver; - border-width: thin; - border-collapse: collapse; -} -blockquote > table { - margin-top: 0em ; - margin-bottom: 0em; -} - -td, th { - border-style: solid; - border-width: thin; - border-color: silver; - /* text-align: left; */ - padding: 0 1ex; -} - -td > p:first-child, th > p:first-child { - margin-top: 0; -} -td > p, th > p { - margin-bottom: 0; -} - -/* no borders for "borderless" tables */ -table.borderless, table.borderless * { - border-style: none; -} - -/* "booktabs" style (no vertical lines) */ -table.booktabs { - border: 0; - border-top: 2px solid; - border-bottom: 2px solid; - border-collapse: collapse; -} - -table.booktabs * { - border: 0; -} -table.booktabs th { - border-bottom: thin solid; - text-align: left; -} - -table > caption { - text-align: left; - margin-bottom: 0.25em -/* padding: 2em 0 1em 0; */ -} - -/* numbered tables*/ -table.numbered > caption:before { - counter-increment: table; /* defined/re-set in body */ - content: "Table " counter(table) ": "; - font-weight: bold; -} - - -/* literal text - ------------ -*/ -/* whitespace and wrapping in inline literals */ -/* possible values: normal, nowrap, pre, pre-wrap, pre-line */ -tt.literal { - white-space: pre-wrap; -} - -/* /* compensate for initial line-break (which is literal with XHTML 1.1) */ */ -/* pre.literal-block, pre.doctest-block { */ -/* margin-top: 0em ; */ -/* } */ - -/* Table of Contents */ - -/* don't indent like a topic */ -div.topic.contents { - margin: 0; -} -/* div.topic.contents ul { */ -/* list-style: none; */ -/* } */ - -div.topic.contents a { - text-decoration: none; /* no underline for links */ -} - -/* section numbers */ - -span.sectnum { - padding-right: 1ex; -} - -/* admonitions */ - -/* no padding for top and bottom */ -div.admonition, div.attention, div.caution, div.danger, div.error, -div.hint, div.important, div.note, div.tip, div.warning { - padding: 0px 1em } Copied: trunk/docutils/docutils/writers/xhtml11/xhtml11.css (from rev 7786, trunk/sandbox/html4strict/html4strict/html4css2.css) =================================================================== --- trunk/docutils/docutils/writers/xhtml11/xhtml11.css (rev 0) +++ trunk/docutils/docutils/writers/xhtml11/xhtml11.css 2015-02-21 16:59:18 UTC (rev 7798) @@ -0,0 +1,371 @@ +/* html4css2.css: Cascading style sheet for Docutils' html4strict writer. */ +/* */ +/* :Author: Günter Milde */ +/* :Copyright: © 2009 Günter Milde. */ +/* Released without warranties or conditions of any kind */ +/* under the terms of the Apache License, Version 2.0 */ +/* http://www.apache.org/licenses/LICENSE-2.0 */ +/* */ +/* This stylesheet supplements the Docutils standard style 'html4css1.css'. */ +/* It uses CSS 2.1 elements (supported by up-to-date versions of popular */ +/* browsers). */ + +/* General rules */ +/* ============= */ + +body { + padding: 0 5%; + margin: 8px 0; + line-height:1.3; + /* http://ilovetypography.com/2008/02/28/a-guide-to-web-typography/ + recommends "line-spacing that’s at least 140% of your text size" */ + counter-reset: table; + /* counter-reset: figure; */ +} + +/* avoid long lines --> better reading */ +/* OTOH: lines should not be too short because of missing hyphenation, */ +div.document { + max-width: 45em; + margin: auto; +} + +/* separate items except for compact lists */ +dl > dd { + margin-bottom: 1em; +} +.compact li, .compact p, .compact ul, .compact ol +dl.simple > dd, .simple li, .simple p, .simple ul, .simple ol { + margin-top: 0; + margin-bottom: 0; +/* background: magenta; */ +} +dl.simple, dl.compact, dl.simple > dd, dl.compact > dd { + margin-top: 0; + margin-bottom: 0; +/* background: lightgreen; */ +} + +/* space around paragraphs */ +dl > dd p:first-child, td > p { + margin: 0; +} + +/* Sidebar */ +/* ------- */ + +div.sidebar { + margin-right: -5%; +} + +/* Special definition lists */ +/* ======================== */ + +/* bold definition term on the same line as the label */ +dl.field-list > dt, dl.option-list > dt, dl.docinfo > dt, +dl.footnote > dt, dl.citation > dt, dl.description > dt { + clear: left; + float: left; + margin: 0; + padding: 0; + padding-right: 0.5em; + font-weight: bold; +} +/* except for these */ +dl.option-list > dt, dl.footnote > dt { + font-weight: normal; +} + + + +/* Field Lists */ +/* ----------- */ + +/* field names followed by a colon */ +dl.field-list > dt:after, dl.docinfo > dt:after { + content: ":"; +} + +/* Offset for field content (corresponds to the --field-name-limit option) */ +dl.field-list > dd { + margin-left: 9em; /* ca. 14 chars in the test examples */ + padding-left: 0.5em; +} + +/* start field-body on a new line after long field names */ +dl.field-list > dd p { + width: 100%; +/* display: inline-block; */ +/* background: yellow; */ +} + +dl.field-list > dd > p:first-child, +/* dl.field-list > dd > ol:first-child, */ +/* dl.field-list > dd > ul:first-child, */ +dl.field-list > dd > dl:first-child { + display: inline-block; +} + +/* field-list variants:: */ + +/* example for custom field-name width */ +dl.field-list.narrow > dd { + margin-left: 5em; +} + +/* start field-body on same line after long field names */ +dl.field-list.run-in > dd p { + display: block; +} + +/* wrap or truncate long field names */ +dl.field-list.fix-labelwidth > dt { + width: 8em; /* set to dl.field-list > dd margin-left - padding-left */ + overflow: hidden; +} +dl.field-list.fix-labelwidth > dd:after { + /* a "stopper" to prevent next dd floating up too far */ + content: ''; + display: block; + clear: left; +} + +/* docinfo */ + +dl.docinfo > dd { + margin-left: 8em; +/* margin-bottom: 0.5em; */ +} + + +/* option list */ + +dl.option-list { + margin-left: 1em; + padding-left: 0; +} + +dl.option-list > dd { + margin-left: 8em; + /* margin-bottom: 0.5em; */ +} + +/* start description on a new line after long options */ +dl.option-list > dd p { + width: 100%; + display: inline-block; +} + +/* footnotes */ + +a.footnote-reference, a.fn-backref { + text-decoration: inherit; /* do not underline footnote links */ +} + +dl.footnote { + /* line on the left */ + padding-left: 1ex; + border-left: solid; + border-left-width: thin; + /* border-color: black; */ +} + +/* paragraph on same line as backrefs */ +dd > em { +/* background: green; */ + float: left; + margin-right: 1ex +} + + +/* +Ordered List (Enumeration) +-------------------------- + +Use counters to replace the deprecated start attribute. Make sure the +resulting list resembles the list-style 'outside' with a hanging indent. +*/ + +/* New ordered list: reset counter, suppress the default label */ +ol, ol.arabic, ol.loweralpha, ol.upperalpha, +ol.lowerroman, ol.upperroman { + counter-reset: item; + list-style: none +} + +/* Set the negative indent of the list label as feature of the list item */ +ol > li { + text-indent: -40px; /* Mozillas default indent */ +} +/* reset for child elements */ +ol > li > * { + text-indent: 0px; + text-indent: 0; + margin-top: 0; + /* background: lightgreen; */ +} + +/* Label */ +ol > li:before { + /* increment and typeset counter(s), */ + counter-increment: item; + content: counter(item) "."; + /* display next to the content (aligned top-right), */ + display: inline-block; + text-align: right; + vertical-align: top; + /* sum must match ol>li {text-indent:} (40px is Mozillas default) */ + width: 35px; + padding-right: 5px; +/* background: yellow; */ +} + +/* The list item's first line starts next to the label, without indent */ +ol > li > p:first-child, +ol > li > ol:first-child, +ol > li > ul:first-child, +ol > li > dl:first-child { + display: inline-block; + /* background: lightblue; */ +} + +/* default separator variants */ +ol.loweralpha > li:before { + content: counter(item, lower-alpha) ")"; +} +ol.upperalpha > li:before { + content: counter(item, upper-alpha) "."; +} +ol.lowerroman > li:before { + content: "(" counter(item, lower-roman) ")"; +} +ol.upperroman > li:before { + content: counter(item, upper-roman) ")"; +} +/* nested counters (1, 1.1, 1.1.1, etc) */ +/* nested enumerated lists "inherit" the class attribute, other lists not */ +ol.nested > li:before, ol.nested ol > li:before { + content: counters(item, ".") " "; +} + +/* lists nested in definition list */ + +dd > ul, dd > ol { + padding-left: 0pt; +} + +/* TODO: prefix, suffix? */ + +/* smaller font for super- and subscripts */ +/* sub, sup {font-size: 70%;} */ /* Mozilla default is `smaller` */ + + +/* Tables */ +/* ====== */ + +/* margins and borders for "normal" tables */ +table { +/* background: magenta; */ + margin-top: 1em ; + margin-bottom: 1em; +/* border-style: outset; */ + border-style: solid; + border-color: silver; + border-width: thin; + border-collapse: collapse; +} +blockquote > table { + margin-top: 0em ; + margin-bottom: 0em; +} + +td, th { + border-style: solid; + border-width: thin; + border-color: silver; + /* text-align: left; */ + padding: 0 1ex; +} + +td > p:first-child, th > p:first-child { + margin-top: 0; +} +td > p, th > p { + margin-bottom: 0; +} + +/* no borders for "borderless" tables */ +table.borderless, table.borderless * { + border-style: none; +} + +/* "booktabs" style (no vertical lines) */ +table.booktabs { + border: 0; + border-top: 2px solid; + border-bottom: 2px solid; + border-collapse: collapse; +} + +table.booktabs * { + border: 0; +} +table.booktabs th { + border-bottom: thin solid; + text-align: left; +} + +table > caption { + text-align: left; + margin-bottom: 0.25em +/* padding: 2em 0 1em 0; */ +} + +/* numbered tables*/ +table.numbered > caption:before { + counter-increment: table; /* defined/re-set in body */ + content: "Table " counter(table) ": "; + font-weight: bold; +} + + +/* literal text + ------------ +*/ +/* whitespace and wrapping in inline literals */ +/* possible values: normal, nowrap, pre, pre-wrap, pre-line */ +tt.literal { + white-space: pre-wrap; +} + +/* /* compensate for initial line-break (which is literal with XHTML 1.1) */ */ +/* pre.literal-block, pre.doctest-block { */ +/* margin-top: 0em ; */ +/* } */ + +/* Table of Contents */ + +/* don't indent like a topic */ +div.topic.contents { + margin: 0; +} +/* div.topic.contents ul { */ +/* list-style: none; */ +/* } */ + +div.topic.contents a { + text-decoration: none; /* no underline for links */ +} + +/* section numbers */ + +span.sectnum { + padding-right: 1ex; +} + +/* admonitions */ + +/* no padding for top and bottom */ +div.admonition, div.attention, div.caution, div.danger, div.error, +div.hint, div.important, div.note, div.tip, div.warning { + padding: 0px 1em } Modified: trunk/docutils/setup.py =================================================================== --- trunk/docutils/setup.py 2015-02-19 18:31:56 UTC (rev 7797) +++ trunk/docutils/setup.py 2015-02-21 16:59:18 UTC (rev 7798) @@ -135,7 +135,7 @@ 'docutils.utils.math', 'docutils.writers', 'docutils.writers.html4css1', - # 'docutils.writers.html4strict', # in the sandbox! + 'docutils.writers.xhtml11', 'docutils.writers.pep_html', 'docutils.writers.s5_html', 'docutils.writers.latex2e', Copied: trunk/docutils/test/functional/expected/standalone_rst_xhtml11.xhtml (from rev 7786, trunk/sandbox/html4strict/data/standalone_rst_html4strict.xhtml) =================================================================== --- trunk/docutils/test/functional/expected/standalone_rst_xhtml11.xhtml (rev 0) +++ trunk/docutils/test/functional/expected/standalone_rst_xhtml11.xhtml 2015-02-21 16:59:18 UTC (rev 7798) @@ -0,0 +1,1504 @@ +<?xml version="1.0" encoding="utf-8" ?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1 plus MathML 2.0//EN" "http://www.w3.org/Math/DTD/mathml2/xhtml-math11-f.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> +<head> +<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=utf-8" /> +<meta name="generator" content="Docutils 0.13: http://docutils.sourceforge.net/" /> +<title>reStructuredText Test Document</title> +<meta name="author" content="David Goodger" /> +<meta name="authors" content="Me Myself I" /> +<meta name="organization" content="humankind" /> +<meta name="date" content="Now, or yesterday. Or maybe even before yesterday." /> +<meta name="copyright" content="This document has been placed in the public domain. You may do with it as you wish. You may copy, modify, redistribute, reattribute, sell, buy, rent, lease, destroy, or improve it, quote it at length, excerpt, incorporate, collate, fold, staple, or mutilate it, or do anything else to it that your or anyone else's heart desires." /> +<meta content="reStructuredText, test, parser" name="keywords" /> +<meta content="A test document, containing at least one example of each reStructuredText construct." name="description" xml:lang="en" /> +<link rel="stylesheet" href="../input/data/html4css1.css" type="text/css" /> +<link rel="stylesheet" href="../input/data/xhtml11.css" type="text/css" /> +</head> +<body> +<div class="header"> +<p>Document header</p> + +<hr class="header"/> +</div> +<div class="document" id="restructuredtext-test-document"> +<span id="doctitle"></span> +<h1 class="title">reStructuredText Test Document</h1> +<h2 class="subtitle" id="examples-of-syntax-constructs"><span id="subtitle"></span>Examples of Syntax Constructs</h2> + +<dl class="docinfo"> +<dt class="author">Author</dt> +<dd class="author">David Goodger</dd> +<dt class="address">Address</dt> +<dd class="address"><pre class="address"> +123 Example Street +Example, EX Canada +A1B 2C3 +</pre> +</dd> +<dt class="contact">Contact</dt> +<dd class="contact"><a class="reference external" href="mailto:goodger@python.org">goodger@python.org</a></dd> +<dt class="authors">Authors</dt> +<dd class="authors">Me +<br />Myself +<br />I</dd> +<dt class="organization">Organization</dt> +<dd class="organization">humankind</dd> +<dt class="date">Date</dt> +<dd class="date">Now, or yesterday. Or maybe even <em>before</em> yesterday.</dd> +<dt class="status">Status</dt> +<dd class="status">This is a "work in progress"</dd> +<dt class="revision">Revision</dt> +<dd class="revision">is managed by a version control system.</dd> +<dt class="version">Version</dt> +<dd class="version">1</dd> +<dt class="copyright">Copyright</dt> +<dd class="copyright">This document has been placed in the public domain. You +may do with it as you wish. You may copy, modify, +redistribute, reattribute, sell, buy, rent, lease, +destroy, or improve it, quote it at length, excerpt, +incorporate, collate, fold, staple, or mutilate it, or do +anything else to it that your or anyone else's heart +desires.</dd> +<dt>field name</dt> +<dd><p>This is a "generic bibliographic field".</p> +</dd> +<dt>field name "2"</dt> +<dd><p>Generic bibliographic fields may contain multiple body elements.</p> +<p>Like this.</p> +</dd> +</dl> +<div class="dedication topic"> +<p class="topic-title first">Dedication</p> +<p>For Docutils users & co-developers.</p> +</div> +<div class="abstract topic"> +<p class="topic-title first">Abstract</p> +<p>This is a test document, containing at least one example of each +reStructuredText construct.</p> +</div> +<!-- This is a comment. Note how any initial comments are moved by +transforms to after the document title, subtitle, and docinfo. --> +<!-- Above is the document title, and below is the subtitle. +They are transformed from section titles after parsing. --> +<!-- bibliographic fields (which also require a transform): --> +<div class="contents topic" id="table-of-contents"> +<p class="topic-title first">Table of Contents</p> +<ul class="auto-toc simple"> +<li><p><a class="reference internal" href="#structural-elements" id="id38"><span class="sectnum">1</span> Structural Elements</a></p> +<ul class="auto-toc"> +<li><p><a class="reference internal" href="#section-title" id="id39"><span class="sectnum">1.1</span> Section Title</a></p></li> +<li><p><a class="reference internal" href="#empty-section" id="id40"><span class="sectnum">1.2</span> Empty Section</a></p></li> +<li><p><a class="reference internal" href="#transitions" id="id41"><span class="sectnum">1.3</span> Transitions</a></p></li> +</ul> +</li> +<li><p><a class="reference internal" href="#body-elements" id="id42"><span class="sectnum">2</span> Body Elements</a></p> +<ul class="auto-toc"> +<li><p><a class="reference internal" href="#paragraphs" id="id43"><span class="sectnum">2.1</span> Paragraphs</a></p> +<ul class="auto-toc"> +<li><p><a class="reference internal" href="#inline-markup" id="id44"><span class="sectnum">2.1.1</span> Inline Markup</a></p></li> +</ul> +</li> +<li><p><a class="reference internal" href="#bullet-lists" id="id45"><span class="sectnum">2.2</span> Bullet Lists</a></p></li> +<li><p><a class="reference internal" href="#enumerated-lists" id="id46"><span class="sectnum">2.3</span> Enumerated Lists</a></p></li> +<li><p><a class="reference internal" href="#definition-lists" id="id47"><span class="sectnum">2.4</span> Definition Lists</a></p></li> +<li><p><a class="reference internal" href="#field-lists" id="id48"><span class="sectnum">2.5</span> Field Lists</a></p></li> +<li><p><a class="reference internal" href="#option-lists" id="id49"><span class="sectnum">2.6</span> Option Lists</a></p></li> +<li><p><a class="reference internal" href="#literal-blocks" id="id50"><span class="sectnum">2.7</span> Literal Blocks</a></p></li> +<li><p><a class="reference internal" href="#line-blocks" id="id51"><span class="sectnum">2.8</span> Line Blocks</a></p></li> +<li><p><a class="reference internal" href="#block-quotes" id="id52"><span class="sectnum">2.9</span> Block Quotes</a></p></li> +<li><p><a class="reference internal" href="#doctest-blocks" id="id53"><span class="sectnum">2.10</span> Doctest Blocks</a></p></li> +<li><p><a class="reference internal" href="#footnotes" id="id54"><span class="sectnum">2.11</span> Footnotes</a></p></li> +<li><p><a class="reference internal" href="#citations" id="id55"><span class="sectnum">2.12</span> Citations</a></p></li> +<li><p><a class="reference internal" href="#targets" id="id56"><span class="sectnum">2.13</span> Targets</a></p> +<ul class="auto-toc"> +<li><p><a class="reference internal" href="#duplicate-target-names" id="id57"><span class="sectnum">2.13.1</span> Duplicate Target Names</a></p></li> +<li><p><a class="reference internal" href="#id21" id="id58"><span class="sectnum">2.13.2</span> Duplicate Target Names</a></p></li> +</ul> +</li> +<li><p><a class="reference internal" href="#directives" id="id59"><span class="sectnum">2.14</span> Directives</a></p> +<ul class="auto-toc"> +<li><p><a class="reference internal" href="#document-parts" id="id60"><span class="sectnum">2.14.1</span> Document Parts</a></p></li> +<li><p><a class="reference internal" href="#images-and-figures" id="id61"><span class="sectnum">2.14.2</span> Images and Figures</a></p></li> +<li><p><a class="reference internal" href="#admonitions" id="id62"><span class="sectnum">2.14.3</span> Admonitions</a></p></li> +<li><p><a class="reference internal" href="#topics-sidebars-and-rubrics" id="id63"><span class="sectnum">2.14.4</span> Topics, Sidebars, and Rubrics</a></p></li> +<li><p><a class="reference internal" href="#target-footnotes" id="id64"><span class="sectnum">2.14.5</span> Target Footnotes</a></p></li> +<li><p><a class="reference internal" href="#replacement-text" id="id65"><span class="sectnum">2.14.6</span> Replacement Text</a></p></li> +<li><p><a class="reference internal" href="#compound-paragraph" id="id66"><span class="sectnum">2.14.7</span> Compound Paragraph</a></p></li> +<li><p><a class="reference internal" href="#parsed-literal-blocks" id="id67"><span class="sectnum">2.14.8</span> Parsed Literal Blocks</a></p></li> +<li><p><a class="reference internal" href="#code" id="id68"><span class="sectnum">2.14.9</span> Code</a></p></li> +</ul> +</li> +<li><p><a class="reference internal" href="#substitution-definitions" id="id69"><span class="sectnum">2.15</span> Substitution Definitions</a></p></li> +<li><p><a class="reference internal" href="#comments" id="id70"><span class="sectnum">2.16</span> Comments</a></p></li> +<li><p><a class="reference internal" href="#raw-text" id="id71"><span class="sectnum">2.17</span> Raw text</a></p></li> +<li><p><a class="reference internal" href="#container" id="id72"><span class="sectnum">2.18</span> Container</a></p></li> +<li><p><a class="reference internal" href="#colspanning-tables" id="id73"><span class="sectnum">2.19</span> Colspanning tables</a></p></li> +<li><p><a class="reference internal" href="#rowspanning-tables" id="id74"><span class="sectnum">2.20</span> Rowspanning tables</a></p></li> +<li><p><a class="reference internal" href="#complex-tables" id="id75"><span class="sectnum">2.21</span> Complex tables</a></p></li> +<li><p><a class="reference internal" href="#list-tables" id="id76"><span class="sectnum">2.22</span> List Tables</a></p></li> +<li><p><a class="reference internal" href="#custom-roles" id="id77"><span class="sectnum">2.23</span> Custom Roles</a></p></li> +<li><p><a class="reference internal" href="#svg-images" id="id78"><span class="sectnum">2.24</span> SVG Images</a></p></li> +<li><p><a class="reference internal" href="#swf-images" id="id79"><span class="sectnum">2.25</span> SWF Images</a></p></li> +</ul> +</li> +<li><p><a class="reference internal" href="#additional-html4css2-features" id="id80"><span class="sectnum">3</span> Additional html4css2 features</a></p> +<ul class="auto-toc"> +<li><p><a class="reference internal" href="#enumerated-lists-with-nested-counters" id="id81"><span class="sectnum">3.1</span> Enumerated lists with nested counters</a></p></li> +<li><p><a class="reference internal" href="#description-list" id="id82"><span class="sectnum">3.2</span> Description list</a></p></li> +<li><p><a class="reference internal" href="#field-list-handling" id="id83"><span class="sectnum">3.3</span> Field list handling</a></p> +<ul class="auto-toc"> +<li><p><a class="reference internal" href="#styling-with-class-arguments" id="id84"><span class="sectnum">3.3.1</span> Styling with class arguments</a></p></li> +</ul> +</li> +<li><p><a class="reference internal" href="#table-styling-with-class-arguments" id="id85"><span class="sectnum">3.4</span> Table styling with class arguments</a></p></li> +<li><p><a class="reference internal" href="#math" id="id86"><span class="sectnum">3.5</span> Math</a></p></li> +</ul> +</li> +<li><p><a class="reference internal" href="#error-handling" id="id87"><span class="sectnum">4</span> Error Handling</a></p></li> +</ul> +</div> +<div class="section" id="structural-elements"> +<h1><a class="toc-backref" href="#id38"><span class="sectnum">1</span> Structural Elements</a></h1> +<div class="section" id="section-title"> +<h2 class="with-subtitle"><a class="toc-backref" href="#id39"><span class="sectnum">1.1</span> Section Title</a></h2> +<h2 class="section-subtitle" id="section-subtitle"><span class="section-subtitle">Section Subtitle</span></h2> +<p>Lone subsections are converted to a section subtitle by a transform +activated with the <tt class="literal"><span class="pre">--section-subtitles</span></tt> command line option or the +<tt class="literal"><span class="pre">sectsubtitle-xform</span></tt> configuration value.</p> +</div> +<div class="section" id="empty-section"> +<h2><a class="toc-backref" href="#id40"><span class="sectnum">1.2</span> Empty Section</a></h2> +</div> +<div class="section" id="transitions"> +<h2><a class="toc-backref" href="#id41"><span class="sectnum">1.3</span> Transitions</a></h2> +<p>Here's a transition:</p> +<hr class="docutils" /> +<p>It divides the section. Transitions may also occur between sections:</p> +</div> +</div> +<hr class="docutils" /> +<div class="section" id="body-elements"> +<h1><a class="toc-backref" href="#id42"><span class="sectnum">2</span> Body Elements</a></h1> +<div class="section" id="paragraphs"> +<h2><a class="toc-backref" href="#id43"><span class="sectnum">2.1</span> Paragraphs</a></h2> +<p>A paragraph.</p> +<div class="section" id="inline-markup"> +<h3><a class="toc-backref" href="#id44"><span class="sectnum">2.1.1</span> Inline Markup</a></h3> +<p>Paragraphs contain text and may contain inline markup: <em>emphasis</em>, +<strong>strong emphasis</strong>, <tt class="literal">inline literals</tt>, standalone hyperlinks +(<a class="reference external" href="http://www.python.org">http://www.python.org</a>), external hyperlinks (<a class="reference external" href="http://www.python.org/">Python</a> <a class="footnote-reference" href="#id25" id="id26">[5]</a>), internal +cross-references (<a class="reference internal" href="#example">example</a>), external hyperlinks with embedded URIs +(<a class="reference external" href="http://www.python.org">Python web site</a>), <a class="reference external" href="http://www.python.org/">anonymous hyperlink +references</a> <a class="footnote-reference" href="#id25" id="id35">[5]</a> (<a class="reference external" href="http://docutils.sourceforge.net/">a second reference</a> <a class="footnote-reference" href="#id36" id="id37">[9]</a>), footnote references (manually +numbered <a class="footnote-reference" href="#id8" id="id1">[1]</a>, anonymous auto-numbered <a class="footnote-reference" href="#id12" id="id2">[3]</a>, labeled auto-numbered +<a class="footnote-reference" href="#label" id="id3">[2]</a>, or symbolic <a class="footnote-reference" href="#id13" id="id4">[*]</a>), citation references (<a class="citation-reference" href="#cit2002" id="id5">[CIT2002]</a>), +substitution references (<img alt="EXAMPLE" src="../../../docs/user/rst/images/biohazard.png" />), and <span class="target" id="inline-hyperlink-targets">inline hyperlink targets</span> +(see <a class="reference internal" href="#targets">Targets</a> below for a reference back to here). Character-level +inline markup is also possible (although exceedingly ugly!) in <em>re</em><tt class="literal">Structured</tt><em>Text</em>. Problems are indicated by <a href="#id23"><span class="problematic" id="id24">|problematic|</span></a> text +(generated by processing errors; this one is intentional). Here is a +reference to the <a class="reference internal" href="#doctitle">doctitle</a> and the <a class="reference internal" href="#subtitle">subtitle</a>.</p> +<p>The default role for interpreted text is <cite>Title Reference</cite>. Here are +some explicit interpreted text roles: a PEP reference (<a class="reference external" href="http://www.python.org/dev/peps/pep-0287">PEP 287</a>); an +RFC reference (<a class="reference external" href="http://tools.ietf.org/html/rfc2822.html">RFC 2822</a>); an abbreviation (<abbr>abb.</abbr>), an acronym +(<acronym>reST</acronym>), code (<code>print "hello world"</code>); a <sub>subscript</sub>; +a <sup>superscript</sup> and explicit roles for <cite>Docutils</cite>' +<em>standard</em> <strong>inline</strong> <tt class="literal">markup</tt>.</p> +<!-- DO NOT RE-WRAP THE FOLLOWING PARAGRAPH! --> +<p>Let's test wrapping and whitespace significance in inline literals: +<tt class="literal">This is an example of <span class="pre">--inline-literal</span> <span class="pre">--text,</span> <span class="pre">--including</span> <span class="pre">some--</span> <span class="pre">strangely--hyphenated-words.</span> <span class="pre">Adjust-the-width-of-your-browser-window</span> to see how the text is wrapped. <span class="pre">--</span> <span class="pre">----</span> <span class="pre">--------</span> Now note the spacing between the words of this sentence (words should be grouped in pairs).</tt></p> +<p>If the <tt class="literal"><span class="pre">--pep-references</span></tt> option was supplied, there should be a +live link to PEP 258 here.</p> +</div> +</div> +<div class="section" id="bullet-lists"> +<h2><a class="toc-backref" href="#id45"><span class="sectnum">2.2</span> Bullet Lists</a></h2> +<ul> +<li><p>A bullet list</p> +<ul class="simple"> +<li><p>Nested bullet list.</p></li> +<li><p>Nested item 2.</p></li> +</ul> +</li> +<li><p>Item 2.</p> +<p>Paragraph 2 of item 2.</p> +<ul class="simple"> +<li><p>Nested bullet list.</p></li> +<li><p>Nested item 2.</p> +<ul> +<li><p>Third level.</p></li> +<li><p>Item 2.</p></li> +</ul> +</li> +<li><p>Nested item 3.</p></li> +<li><p>This nested list should be compacted by the HTML writer.</p> +<span class="target" id="target"></span><!-- Even if this item contains a target and a comment. --> +</li> +</ul> +</li> +</ul> +</div> +<div class="section" id="enumerated-lists"> +<h2><a class="toc-backref" href="#id46"><span class="sectnum">2.3</span> Enumerated Lists</a></h2> +<ol class="arabic"> +<li><p>Arabic numerals.</p> +<ol class="loweralpha simple"> +<li><p>lower alpha)</p> +<ol class="lowerroman simple"> +<li><p>(lower roman)</p> +<ol class="upperalpha simple"> +<li><p>upper alpha.</p> +<ol class="upperroman simple"> +<li><p>upper roman)</p></li> +</ol> +</li> +</ol> +</li> +</ol> +</li> +</ol> +</li> +<li><p>Lists that don't start at 1:</p> +<ol class="arabic simple" style="counter-reset: item 2;"> +<li><p>Three</p></li> +<li><p>Four</p></li> +</ol> +<ol class="upperalpha simple" style="counter-reset: item 2;"> +<li><p>C</p></li> +<li><p>D</p></li> +</ol> +<ol class="lowerroman simple" style="counter-reset: item 2;"> +<li><p>iii</p></li> +<li><p>iv</p></li> +</ol> +</li> +</ol> +</div> +<div class="section" id="definition-lists"> +<h2><a class="toc-backref" href="#id47"><span class="sectnum">2.4</span> Definition Lists</a></h2> +<dl class="docutils"> +<dt>Term</dt> +<dd><p>Definition</p> +</dd> +<dt>Term <span class="classifier-delimiter">:</span> <span class="classifier">classifier</span></dt> +<dd><p>Definition paragraph 1.</p> +<p>Definition paragraph 2.</p> +</dd> +<dt>Term</dt> +<dd><p>Definition</p> +</dd> +<dt>Term <span class="classifier-delimiter">:</span> <span class="classifier">classifier one</span> <span class="classifier-delimiter">:</span> <span class="classifier">classifier two</span></dt> +<dd><p>Definition</p> +</dd> +</dl> +</div> +<div class="section" id="field-lists"> +<h2><a class="toc-backref" href="#id48"><span class="sectnum">2.5</span> Field Lists</a></h2> +<dl class="field-list"> +<dt>what</dt> +<dd><p>Field lists map field names to field bodies, like database +records. They are often part of an extension syntax. They are +an unambiguous variant of RFC 2822 fields.</p> +</dd> +<dt>how arg1 arg2</dt> +<dd><p>The field marker is a colon, the field name, and a colon.</p> +<p>The field body may contain one or more body elements, indented +relative to the field marker.</p> +</dd> +<dt>credits</dt> +<dd><p class="credits">This paragraph has the <cite>credits</cite> class set. (This is actually not +about credits but just for ensuring that the class attribute +doesn't get stripped away.)</p> +</dd> +</dl> +</div> +<div class="section" id="option-lists"> +<h2><a class="toc-backref" href="#id49"><span class="sectnum">2.6</span> Option Lists</a></h2> +<p>For listing command-line options:</p> +<dl class="option-list"> +<dt><kbd><span class="option">-a</span></kbd></dt> +<dd><p>command-line option "a"</p> +</dd> +<dt><kbd><span class="option">-b <var>file</var></span></kbd></dt> +<dd><p>options can have arguments +and long descriptions</p> +</dd> +<dt><kbd><span class="option">--long</span></kbd></dt> +<dd><p>options can be long also</p> +</dd> +<dt><kbd><span class="option">--input=<var>file</var></span></kbd></dt> +<dd><p>long options can also have +arguments</p> +</dd> +<dt><kbd><span class="option">--very-long-option</span></kbd></dt> +<dd><p>The description can also start on the next line.</p> +<p>The description may contain multiple body elements, +regardless of where it starts.</p> +</dd> +<dt><kbd><span class="option">-x</span>, <span class="option">-y</span>, <span class="option">-z</span></kbd></dt> +<dd><p>Multiple options are an "option group".</p> +</dd> +<dt><kbd><span class="option">-v</span>, <span class="option">--verbose</span></kbd></dt> +<dd><p>Commonly-seen: short & long options.</p> +</dd> +<dt><kbd><span class="option">-1 <var>file</var></span>, <span class="option">--one=<var>file</var></span>, <span class="option">--two <var>file</var></span></kbd></dt> +<dd><p>Multiple options with arguments.</p> +</dd> +<dt><kbd><span class="option">/V</span></kbd></dt> +<dd><p>DOS/VMS-style options too</p> +</dd> +</dl> +<p>There must be at least two spaces between the option and the +description.</p> +</div> +<div class="section" id="literal-blocks"> +<h2><a class="toc-backref" href="#id50"><span class="sectnum">2.7</span> Literal Blocks</a></h2> +<p>Literal blocks are indicated with a double-colon ("::") at the end of +the preceding paragraph (over there <tt class="literal"><span class="pre">--></span></tt>). They can be indented:</p> +<pre class="literal-block">if literal_block: + text = 'is left as-is' + spaces_and_linebreaks = 'are preserved' + markup_processing = None +</pre> +<p>Or they can be quoted without indentation:</p> +<pre class="literal-block">>> Great idea! +> +> Why didn't I think of that? +</pre> +</div> +<div class="section" id="line-blocks"> +<h2><a class="toc-backref" href="#id51"><span class="sectnum">2.8</span> Line Blocks</a></h2> +<p>This section tests line blocks. Line blocks are body elements which +consist of lines and other line blocks. Nested line blocks cause +indentation.</p> +<div class="line-block"> +<div class="line">This is a line block. It ends with a blank line.</div> +<div class="line-block"> +<div class="line">New lines begin with a vertical bar ("|").</div> +<div class="line">Line breaks and initial indent are significant, and preserved.</div> +<div class="line-block"> +<div class="line">Continuation lines are also possible. A long line that is intended +to wrap should begin with a space in place of the vertical bar.</div> +</div> +<div class="line">The left edge of a continuation line need not be aligned with +the left edge of the text above it.</div> +</div> +</div> +<div class="line-block"> +<div class="line">This is a second line block.</div> +<div class="line"><br /></div> +<div class="line">Blank lines are permitted internally, but they must begin with a "|".</div> +</div> +<p>Another line block, surrounded by paragraphs:</p> +<div class="line-block"> +<div class="line">And it's no good waiting by the window</div> +<div class="line">It's no good waiting for the sun</div> +<div class="line">Please believe me, the things you dream of</div> +<div class="line">They don't fall in the lap of no-one</div> +</div> +<p>Take it away, Eric the Orchestra Leader!</p> +<blockquote> +<div class="line-block"> +<div class="line">A one, two, a one two three four</div> +<div class="line"><br /></div> +<div class="line">Half a bee, philosophically,</div> +<div class="line-block"> +<div class="line">must, <em>ipso facto</em>, half not be.</div> +</div> +<div class="line">But half the bee has got to be,</div> +<div class="line-block"> +<div class="line"><em>vis a vis</em> its entity. D'you see?</div> +<div class="line"><br /></div> +</div> +<div class="line">But can a bee be said to be</div> +<div class="line-block"> +<div class="line">or not to be an entire bee,</div> +<div class="line-block"> +<div class="line">when half the bee is not a bee,</div> +<div class="line-block"> +<div class="line">due to some ancient injury?</div> +<div class="line"><br /></div> +</div> +</div> +</div> +<div class="line">Singing...</div> +</div> +</blockquote> +<p>A line block, like the following poem by Christian Morgenstern, can +also be centre-aligned:</p> +<div class="align-center line-block" xml:lang="de"> +<div class="line"><strong>Die Trichter</strong></div> +<div class="line"><br /></div> +<div class="line">Zwei Trichter wandeln durch die Nacht.</div> +<div class="line">Durch ihres Rumpfs verengten Schacht</div> +<div class="line">fließt weißes Mondlicht</div> +<div class="line">still und heiter</div> +<div class="line">auf ihren</div> +<div class="line">Waldweg</div> +<div class="line">u. s.</div> +<div class="line">w.</div> +<div class="line"><br /></div> +</div> +</div> +<div class="section" id="block-quotes"> +<h2><a class="toc-backref" href="#id52"><span class="sectnum">2.9</span> Block Quotes</a></h2> +<p>Block quotes consist of indented body elements:</p> +<blockquote> +<p>My theory by A. Elk. Brackets Miss, brackets. This theory goes +as follows and begins now. All brontosauruses are thin at one +end, much much thicker in the middle and then thin again at the +far end. That is my theory, it is mine, and belongs to me and I +own it, and what it is too.</p> +<p class="attribution">—Anne Elk (Miss)</p> +</blockquote> +<p>The language of a quote (like any other object) can be specified by +a class attribute:</p> +<!-- --> +<blockquote xml:lang="fr"> +<p>ReStructuredText est un langage de balisage léger utilisé +notamment dans la documentation du langage Python.</p> +</blockquote> +</div> +<div class="section" id="doctest-blocks"> +<h2><a class="toc-backref" href="#id53"><span class="sectnum">2.10</span> Doctest Blocks</a></h2> +<pre class="doctest-block">>>> print 'Python-specific usage examples; begun with ">>>"' +Python-specific usage examples; begun with ">>>" +>>> print '(cut and pasted from interactive Python sessions)' +(cut and pasted from interactive Python sessions) +</pre> +</div> +<div class="section" id="footnotes"> +<h2><a class="toc-backref" href="#id54"><span class="sectnum">2.11</span> Footnotes</a></h2> +<dl class="footnote"><dt class="label">[1]</dt> +<dd id="id8"> +<em>(<a class="fn-backref" href="#id1">1</a>, <a class="fn-backref" href="#id9">2</a>, <a class="fn-backref" href="#id22">3</a>)</em> <p>A footnote contains body elements, consistently indented by at +least 3 spaces.</p> +<p class="last">This is the footnote's second paragraph.</p> +</dd> +<dt class="label">[2]</dt> +<dd id="label"> +<em>(<a class="fn-backref" href="#id3">1</a>, <a class="fn-backref" href="#id10">2</a>)</em> <p>Footnotes may be numbered, either manually (as in <a class="footnote-reference" href="#id8" id="id9">[1]</a>) or +automatically using a "#"-prefixed label. This footnote has a +label so it can be referred to from multiple places, both as a +footnote reference (<a class="footnote-reference" href="#label" id="id10">[2]</a>) and as a <a class="reference internal" href="#label">hyperlink reference</a>.</p> +</dd> +<dt class="label"><a class="fn-backref" href="#id2">[3]</a></dt> +<dd id="id12"> +<p class="first">This footnote is numbered automatically and anonymously using a +label of "#" only.</p> +<p>This is the second paragraph.</p> +<p class="last">And this is the third paragraph.</p> +</dd> +<dt class="label"><a class="fn-backref" href="#id4">[*]</a></dt> +<dd id="id13"> +<p class="first last">Footnotes may also use symbols, specified with a "*" label. +Here's a reference to the next footnote: <a class="footnote-reference" href="#id15" id="id14">[†]</a>.</p> +</dd> +<dt class="label"><a class="fn-backref" href="#id14">[†]</a></dt> +<dd id="id15"> +<p class="first last">This footnote shows the next symbol in the sequence.</p> +</dd> +<dt class="label">[4]</dt> +<dd id="id16"> +<p class="first last">Here's an unreferenced footnote, with a reference to a +nonexistent footnote: <a href="#id97"><span class="problematic" id="id98"><span id="id17"></span>[5]_</span></a>.</p> +</dd> +</dl> +</div> +<div class="section" id="citations"> +<h2><a class="toc-backref" href="#id55"><span class="sectnum">2.12</span> Citations</a></h2> +<dl class="citation"><dt class="label">[CIT2002]</dt> +<dd id="cit2002"> +<em>(<a class="fn-backref" href="#id5">1</a>, <a class="fn-backref" href="#id18">2</a>)</em> <p class="last">Citations are text-labeled footnotes. They may be +rendered separately and differently from footnotes.</p> +</dd> +</dl> +<p>Here's a reference to the above, <a class="citation-reference" href="#cit2002" id="id18">[CIT2002]</a>, and a <a href="#id99"><span class="problematic" id="id100"><span id="id19"></span>[nonexistent]_</span></a> +citation.</p> +</div> +<div class="section" id="targets"> +<span id="another-target"></span><h2><a class="toc-backref" href="#id56"><span class="sectnum">2.13</span> Targets</a></h2> +<p id="example">This paragraph is pointed to by the explicit "example" target. A +reference can be found under <a class="reference internal" href="#inline-markup">Inline Markup</a>, above. <a class="reference internal" href="#inline-hyperlink-targets">Inline +hyperlink targets</a> are also possible.</p> +<p>Section headers are implicit targets, referred to by name. See +<a class="reference internal" href="#targets">Targets</a>, which is a subsection of <a class="reference internal" href="#body-elements">Body Elements</a>.</p> +<p>Explicit external targets are interpolated into references such as +"<a class="reference external" href="http://www.python.org/">Python</a> <a class="footnote-reference" href="#id25" id="id27">[5]</a>".</p> +<p>Targets may be indirect and anonymous. Thus <a class="reference internal" href="#targets">this phrase</a> may also +refer to the <a class="reference internal" href="#targets">Targets</a> section.</p> +<p>Here's a <a href="#id101"><span class="problematic" id="id102">`hyperlink reference without a target`_</span></a>, which generates an +error.</p> +<div class="section" id="duplicate-target-names"> +<h3><a class="toc-backref" href="#id57"><span class="sectnum">2.13.1</span> Duplicate Target Names</a></h3> +<p>Duplicate names in section headers or other implicit targets will +generate "info" (level-1) system messages. Duplicate names in +explicit targets will generate "warning" (level-2) system messages.</p> +</div> +<div class="section" id="id21"> +<h3><a class="toc-backref" href="#id58"><span class="sectnum">2.13.2</span> Duplicate Target Names</a></h3> +<p>Since there are two "Duplicate Target Names" section headers, we +cannot uniquely refer to either of them by name. If we try to (like +this: <a href="#id103"><span class="problematic" id="id104">`Duplicate Target Names`_</span></a>), an error is generated.</p> +</div> +</div> +<div class="section" id="directives"> +<h2><a class="toc-backref" href="#id59"><span class="sectnum">2.14</span> Directives</a></h2> +<div class="contents local topic" id="contents"> +<ul class="auto-toc simple"> +<li><p><a class="reference internal" href="#document-parts" id="id88"><span class="sectnum">2.14.1</span> Document Parts</a></p></li> +<li><p><a class="reference internal" href="#images-and-figures" id="id89"><span class="sectnum">2.14.2</span> Images and Figures</a></p></li> +<li><p><a class="reference internal" href="#admonitions" id="id90"><span class="sectnum">2.14.3</span> Admonitions</a></p></li> +<li><p><a class="reference internal" href="#topics-sidebars-and-rubrics" id="id91"><span class="sectnum">2.14.4</span> Topics, Sidebars, and Rubrics</a></p></li> +<li><p><a class="reference internal" href="#target-footnotes" id="id92"><span class="sectnum">2.14.5</span> Target Footnotes</a></p></li> +<li><p><a class="reference internal" href="#replacement-text" id="id93"><span class="sectnum">2.14.6</span> Replacement Text</a></p></li> +<li><p><a class="reference internal" href="#compound-paragraph" id="id94"><span class="sectnum">2.14.7</span> Compound Paragraph</a></p></li> +<li><p><a class="reference internal" href="#parsed-literal-blocks" id="id95"><span class="sectnum">2.14.8</span> Parsed Literal Blocks</a></p></li> +<li><p><a class="reference internal" href="#code" id="id96"><span class="sectnum">2.14.9</span> Code</a></p></li> +</ul> +</div> +<p>These are just a samp... [truncated message content] |
From: <mi...@us...> - 2015-07-16 12:31:15
|
Revision: 7901 http://sourceforge.net/p/docutils/code/7901 Author: milde Date: 2015-07-16 12:31:11 +0000 (Thu, 16 Jul 2015) Log Message: ----------- Rename html_base writer to html_plain, move xhtml11 writer back to sandbox. Modified Paths: -------------- trunk/docutils/HISTORY.txt trunk/docutils/RELEASE-NOTES.txt trunk/docutils/docs/dev/todo.txt trunk/docutils/docs/user/html.txt trunk/docutils/docs/user/links.txt trunk/docutils/docs/user/tools.txt trunk/docutils/docutils/writers/__init__.py trunk/docutils/docutils/writers/html4css1/__init__.py trunk/docutils/setup.py trunk/docutils/test/functional/input/data/minimal.css trunk/docutils/test/functional/input/data/plain.css trunk/docutils/test/functional/tests/math_output_mathml.py trunk/docutils/test/test_writers/test_html4css1_misc.py trunk/sandbox/html4strict/README.txt Added Paths: ----------- trunk/docutils/docutils/writers/html_plain/ trunk/docutils/test/functional/expected/standalone_rst_html_plain.html trunk/docutils/test/functional/input/data/math.css trunk/docutils/test/functional/input/standalone_rst_html_plain.txt trunk/docutils/test/test_writers/test_html_plain_misc.py trunk/sandbox/html4strict/rst2xhtml11.py trunk/sandbox/html4strict/test/ trunk/sandbox/html4strict/test/standalone_rst_xhtml11.py trunk/sandbox/html4strict/test/standalone_rst_xhtml11.txt trunk/sandbox/html4strict/test/standalone_rst_xhtml11.xhtml trunk/sandbox/html4strict/test/xhtml11.css trunk/sandbox/html4strict/xhtml11/ Removed Paths: ------------- trunk/docutils/docutils/writers/html_base/ trunk/docutils/docutils/writers/xhtml11/ trunk/docutils/test/functional/expected/standalone_rst_html_base.html trunk/docutils/test/functional/expected/standalone_rst_xhtml11.xhtml trunk/docutils/test/functional/input/data/math.css trunk/docutils/test/functional/input/data/xhtml11.css trunk/docutils/test/functional/input/standalone_rst_html_base.txt trunk/docutils/test/functional/input/standalone_rst_xhtml11.txt trunk/docutils/test/functional/tests/standalone_rst_xhtml11.py trunk/docutils/test/test_writers/test_html_base_misc.py trunk/docutils/tools/rst2xhtml11.py Modified: trunk/docutils/HISTORY.txt =================================================================== --- trunk/docutils/HISTORY.txt 2015-06-03 22:04:47 UTC (rev 7900) +++ trunk/docutils/HISTORY.txt 2015-07-16 12:31:11 UTC (rev 7901) @@ -43,16 +43,14 @@ - Add ``\colon`` macro, fix spacing around colons. Fixes [ 246 ]. - New upstream version (additional macros, piecewise integrals and sums). -* docutils/writers/html_base/ +* docutils/writers/html_plain/ - New HTML writer generating clean, polyglot_ markup conforming to `HTML 5`_ and compatible with `XHTML 1.0`_ Transitional. - CSS stylesheets ``minimal.css`` and ``plain.css`` with required and - recommended layout rules. + The CSS stylesheets ``minimal.css`` and ``plain.css`` contain required + and recommended layout rules. - Also base for the xhtml11_ writer. - * docutils/writers/html4css1/__init__.py - Add "docutils" to class values for "container" object to address [ 267 ]. @@ -84,16 +82,9 @@ - LuaLaTex compatibility: do not load "xunicode". -* docutils/writers/_`xhtml11`/ - - - New HTML writer generating `XHTML 1.1`_ styled with CSS2.1 - Moved to the docutils core from sandbox/html4strict. - - * tools/ - - New front-ends ``rst2xhtml.py`` and ``rst2html5.py`` for the - corresponding writers. + - New front-end ``rst2html5.py``. * tox.ini @@ -105,7 +96,6 @@ .. _polyglot: http://www.w3.org/TR/html-polyglot/ .. _HTML 5: http://www.w3.org/TR/html5/ .. _XHTML 1.0: http://www.w3.org/TR/xhtml1/ -.. _XHTML 1.1: http://www.w3.org/TR/xhtml11/ Release 0.12 (2014-07-06) Modified: trunk/docutils/RELEASE-NOTES.txt =================================================================== --- trunk/docutils/RELEASE-NOTES.txt 2015-06-03 22:04:47 UTC (rev 7900) +++ trunk/docutils/RELEASE-NOTES.txt 2015-07-16 12:31:11 UTC (rev 7901) @@ -38,19 +38,16 @@ Changes Since 0.12 ================== -* docutils/writers/ +* docutils/writers/html_plain - - New HTML writers generating `HTML 5`_ and `XHTML 1.1`_. + - New HTML writer generating `HTML 5`_. - New stylesheet ``html-base.css`` for default layout using CSS 2.1. * tools/ - - New front-ends ``rst2xhtml.py`` and ``rst2html5.py`` for the - corresponding writers. + - New front-end ``rst2html5.py``. .. _HTML 5: http://www.w3.org/TR/html5/ -.. _XHTML 1.1: http://www.w3.org/TR/xhtml11/ Release 0.12 (2014-07-06) Modified: trunk/docutils/docs/dev/todo.txt =================================================================== --- trunk/docutils/docs/dev/todo.txt 2015-06-03 22:04:47 UTC (rev 7900) +++ trunk/docutils/docs/dev/todo.txt 2015-07-16 12:31:11 UTC (rev 7901) @@ -376,6 +376,44 @@ Especially useful for character entity sets, text transform specs, boilerplate, etc. +* Support "include" as embedded inline-compatible directive in substitution + definitions, e.g. :: + + .. |version| include:: version.txt + + This document describes version |version| of ... + + (cf. Grzegorz Adam Hankiewicz's post from 2014-10-01 in docutils-devel) + +* Add an ``:optional: <replacement text>`` option to the "include" + directive? This would not throw an error for a missing file, instead a + warning is given and ``<replacement text>`` is used instead. It would be + the responsibility of the author to ensure the missing file does not lead + to problems later in the document. + + Use cases: + + + Standard rST syntax to replace Sphinx's "literalinclude":: + + .. include:: blah.cpp + :literal: + :optional: file ``blah.cpp`` not found + + + Variable content taken from a file, e.g. + + version.txt:: + + .. |version| replace:: 3.1 + + optionally used as:: + + .. include:: version.txt + :optional: .. |version| replace:: unknown + + This document describes version |version| of ... + + (cf. Grzegorz Adam Hankiewicz's post from 2014-10-01 in docutils-devel) + * Parameterize the Reporter object or class? See the `2004-02-18 "rest checking and source path"`_ thread. @@ -1725,7 +1763,21 @@ either by running it at the command line with a ``--help`` option or through an exposed API. [Suggestion for Optik.] + - _`body.float`: Generic float that can be used for figures, tables, + code listings, flowcharts, ... + There is a Sphinx extension by Ignacio Fernández Galván <je...@gm...> + + I implemented something for generic floats in sphinx, and submitted a + pull request that is still waiting:: + + .. float:: + :type: figure + :caption: My caption + + https://github.com/sphinx-doc/sphinx/pull/1858 + + Interpreted Text ---------------- @@ -2506,9 +2558,9 @@ + `<../../test/functional/expected/standalone_rst_html4css1.html>`__ + `<../../test/functional/expected/standalone_rst_latex.tex>`__ -* According to the HTML standard - http://www.w3.org/TR/html4/struct/objects.html#adef-align-IMG a right- or - left-aligned image should be floated alongside the paragraph. +* The default CSS styling for HTML output (plain.css, default.css) lets + text following a right- or left-aligned image float to the side of the + image/figure. + Use this default also for LaTeX? Modified: trunk/docutils/docs/user/html.txt =================================================================== --- trunk/docutils/docs/user/html.txt 2015-06-03 22:04:47 UTC (rev 7900) +++ trunk/docutils/docs/user/html.txt 2015-07-16 12:31:11 UTC (rev 7901) @@ -5,98 +5,122 @@ .. note:: This document is a working draft. Naming of writers, aliases, and front-ends may change before the release of Docutils 0.13. - The ⚠ symbol marks suggestions that are still open to - discussion and change. +.. contents:: Overview -------- -Docutils supports +* `Generic HTML writers`_ -* state of the art HTML (html_base_, html5) ⚠ + =========== ============== ============== ================= =========== + name alias(es) `front-end`_ HTML version CSS version + =========== ============== ============== ================= =========== + html4css1_ html4 rst2html4.py `XHTML 1 `CSS 1`_ + Transitional`_ -* state of the art XHTML (xhtml11_) ⚠ + .. html_ rst2html.py `XHTML 1 `CSS 1`_ + Transitional`_ -* older user agents with no/limited support for CSS and XHTML (html4css1_ - and descendants). + html_plain_ html5_ rst2html5.py `HTML 5`_ `CSS 3`_ + =========== ============== ============== ================= =========== -Additionally, there are special purpose writers (pep_html_, s5_html_) in the -Docutils core and others (e.g. html4trans_) in the sandbox. +* `Special HTML writers`_ -=========== ============== ============== ================= =========== -name alias(es) `front-end`_ HTML version(s) CSS version -=========== ============== ============== ================= =========== -[#base]_ HTML5_, (`XHTML 1 `CSS 3`_ - Transitional`_) + =========== ============== ============== ================= =========== + name alias(es) `front-end`_ HTML version CSS version + =========== ============== ============== ================= =========== + pep_html_ .. rstpep2html.py `XHTML 1 `CSS 1`_ + Transitional`_ -[#5]_ html5 [#5]_ rst2html5.py HTML5_, `CSS 3`_ + s5_html_ s5 rst2s5.py `XHTML 1 `CSS 1`_ + Transitional`_ + =========== ============== ============== ================= =========== -xhtml11_ xhtml, rst2xhtml.py `XHTML 1.1`_, `CSS 3`_ - html4strict (HTML5_) +* `HTML writers in the sandbox`_ -html4css1_ html_ [#h]_, rst2html.py `XHTML 1 `CSS 1`_ - html4 Transitional`_ + =========== ============== ============== ================= =========== + name alias(es) `front-end`_ HTML version CSS version + =========== ============== ============== ================= =========== + xhtml11_ xhtml, rst2xhtml.py `XHTML 1.1`_ `CSS 3`_ + html4strict -pep_html_ .. rstpep2html.py `XHTML 1 `CSS 1`_ - Transitional`_ + html4trans_ .. rst2html_trans `XHTML 1 no CSS + Transitional`_ required + =========== ============== ============== ================= =========== -s5_html_ s5 rst2s5.py `XHTML 1 `CSS 1`_ - Transitional`_ -=========== ============== ============== ================= =========== -.. [#base] TODO: Find the right name for the basic html writer. -.. [#5] `html5` may become the name for a specialised `html5 writer`_ in a - future release. +.. _front-end: tools.html -.. There is one more HTML writer in the sandbox: +Generic HTML writers +-------------------- - html4trans_ rst2html_trans `XHTML 1 no CSS - [#sandbox]_ Transitional`_ required +html4css1 +~~~~~~~~~ - .. [#sandbox] in the sandbox +:aliases: html4, html_ +:front-ends: rst2html4.py, rst2html.py_ +:config: `[html4css1 writer]`_ -.. _front-end: tools.html +The HTML Writer module, ``docutils/writers/html4css1.py``, started +as a proof-of-concept reference implementation. It is the first Docutils +writer and was up to release 0.13 the only official HTML writer. -html ----- +The output conforms to the `XHTML 1 Transitional`_ specification. It does +not validate as `HTML 4.01 Transitional`_ due to the closing of empty tags +required in XML but not allowed in HTML 4. However, the output follows the +`HTML Compatibility Guidelines`_ for proper rendering on most HTML user +agents. -Currently, `html` is an alias for the html4css1_ writer. +Correct rendering depends on a CSS_ style sheet. A reference style sheet, +`html4css1.css`_, is provided and used by default. -.. admonition:: suggestion +To support the `Internet Explorer` (with a market share of about 90% around +2002, the time this writer was written), documents contain some hard-coded +formatting hints and are tagged as "text/html" (instead of +"application/xhtml+xml"). [#IE]_ - The writer alias `html` points to the "recommended Docutils HTML writer". - Its meaning may change with the development of HTML, browsers, Docutils, and - the web. +.. [#IE] Conformance to `CSS 2.1`_ has been added in IE 8 (2009), support + for XHTML in IE 9 (2011). - * Use `get_writer_by_name('html') or the ``rst2html.py`` front end, if you - want the output to be up-to-date automatically. +.. TODO: How to name a specific alias/front-end pointing to html4css1? - * Use a more specific writer name or front end, if you depend on stability - of the generated HTML code, e.g. because you use a custom style sheet or - post-processing that may break otherwise. + html4 + | +1 short form of html4css1, + | -1 writer produces XHTML 1, not HTML 4 + xhtml1 + | +1 correct and short description of the output format. + | -1 may be confused with xhtml11 or xhtml (aliases for the + "new" XHTML 1.1. writer inheriting from html_plain). -html_base ------------ -:aliases: html-common, html5 [#5]_ +.. _rst2html.py: tools.html#rst2html-py +.. _[html4css1 writer]: config.html#html4css1-writer +.. _html4css1.css: ../../docutils/writers/html4css1/html4css1.css + + +html_plain +~~~~~~~~~~ + +:aliases: html5_ :front-end: rst2html5.py_ -:config: `[html-base writer]`_ +:config: `[html-plain writer]`_ -The `html_base` module is both, basis for other HTML writers and a -versatile writer for end-users or programmatic use. ⚠ +The `html_plain` module is both, basis for other HTML writers and a +versatile writer for end-users or programmatic use. -It generates `polyglot HTML`_ output (compatible with HTML5_ and `XHTML 1 -Transitional`_). New features and elements will only be used if they are -widely supported to make documents `viewable with any browser`_. +The ``html_plain`` writer generates `polyglot HTML`_ output that is +compatible with `HTML 5`_ and `XHTML 1 Transitional`_. New features and +elements will only be used if they are widely supported to make documents +`viewable with any browser`_. There is no hard-coded formatting information +in the HTML document. Correct rendering of elements not directly supported +by HTML depends on a CSS_ style sheet. The provided style sheets +minimal.css_ and plain.css_ define required and optional styling rules +respectively. Adaption of the layout is possible with `custom style +sheets`_. -Correct rendering depends on a CSS_ style sheet. Leaving out hard-coded -formatting information from the HTML code allows adaption of the layout with -`custom style sheets`_. The provided style sheets minimal.css_ and -plain.css_ define required and optional styling rules respectively. - New in Docutils 0.13 -.. admonition:: TODO +.. TODO Find the right name for this writer. Suggestions: @@ -118,109 +142,53 @@ html-base -1 not only base class but also suited for end-users - .. _rst2html5.py: tools.html#rst2html5-py -.. _[html-base writer]: config.html#html-base-writer -.. _minimal.css: ../../docutils/writers/html_base/minimal.css -.. _plain.css: ../../docutils/writers/html_base/plain.css +.. _[html-plain writer]: config.html#html-plain-writer +.. _minimal.css: ../../docutils/writers/html_plain/minimal.css +.. _plain.css: ../../docutils/writers/html_plain/plain.css .. _custom style sheets: ../howto/html-stylesheets.html .. _viewable with any browser: http://www.anybrowser.org/campaign - -xhtml11 +Aliases ~~~~~~~ -:aliases: xhtml, html4strict -:front-end: rst2xhtml.py_ -:config: `[xhtml11 writer]`_ -`XHTML 1.1`_ is the current version of the XML based `extensible Hypertext -Markup Language`. +html +"""" -The `xhtml11` writer inherits from html_base_ and adds compatibility to the -strict requirements of `XHTML 1.1`_: +Currently, `html` is an alias for the html4css1_ writer. -* There is no attribute "lang" (only "xml:lang"). +Suggestion + The alias `html` points to the "recommended Docutils HTML writer". + Its target may change with the development of HTML, browsers, Docutils, and + the web. -* Enumerated lists don't support the 'start' attribute. + * Use `get_writer_by_name('html') or the ``rst2html.py`` front end, if you + want the output to be up-to-date automatically. - The style sheet xhtml11.css_ adds support for a "start" value for - enumerated lists via a CSS-counter. This allows also nested enumeration. + * Use a specific writer name or front end, if you depend on stability of + the generated HTML code, e.g. because you use a custom style sheet or + post-processing that may break otherwise. -* ``<sup>`` and ``<sub>`` tags are not allowed in preformatted blocks - (``<pre>``). +html4 +""""" -The `math-output` `config setting`_ defaults to "MathML". +The alias `html4` provides a stable shortcut for the html4css1_ writer. New in Docutils 0.13 -.. _rst2xhtml.py: tools.html#rst2html5-py -.. _config setting: -.. _[xhtml11 writer]: config.html#xhtml11-writer -.. _xhtml11.css: ../../docutils/writers/xhtml11/xhtml11.css +html5 +""""" +In Docutils 0.13, html5 is an alias to the html_plain_ writer. -.. _`html5 writer`: - -html5 -~~~~~ - -The writer name `html5` is reserved for a HTML writer that makes use of new -features and objects defined in HTML5 but not (yet) fit for use in -`html_base` because of limited browser support (like <video>, <aside>, or +In future releases, `html5` may become a separate HTML writer that makes use +of new features and objects defined in HTML5 but not (yet) fit for use in +`html_plain`_ because of limited browser support (like <video>, <aside>, or <section>). -In Docutils 0.13, it is an alias to the html_base_ writer. ⚠ +Special HTML writers +-------------------- - -html4css1 ---------- - -:aliases: html4 [#html4]_, html [#h]_ -:front-ends: rst2html.py_, rst2html4.py -:config: `[html4css1 writer]`_ - -.. [#h] `html` may become an alias for html_base in a future release. ⚠ - -The HTML Writer module, ``docutils/writers/html4css1.py``, started -as a proof-of-concept reference implementation. It is the first Docutils -writer and was up to release 0.13 the only official HTML writer. - -The output conforms to the `XHTML 1 Transitional`_ specification. -Correct rendering depends on a CSS_ style sheet. A reference style sheet, -`html4css1.css`_, is provided and used by default. - -Due to the closing of empty tags required in XML but not allowed in HTML 4, -generated documents do not validate as `HTML 4.01 Transitional`_. -However, they follow the `HTML Compatibility Guidelines`_ for proper -rendering on most HTML user agents. - -To support the `Internet Explorer` [#IE]_ (with a market share of about 90% -around 2002, the time this writer was written), documents are tagged as -"text/html" (instead of "application/xhtml+xml") and contain some hard-coded -formatting hints. - -.. [#IE] Conformance to `CSS 2.1`_ has been added in the IE 8 (2009), support - for XHTML in IE 9 (2011). - -.. [#html4] TODO: How to name a specific alias/front-end pointing to html4css1? - - html4 - | +1 short form of html4css1, - | -1 writer produces XHTML 1, not HTML 4 - xhtml1 - | +1 correct and short description of the output format. - | -1 may be confused with xhtml11 or xhtml (aliases for the - "new" XHTML 1.1. writer inheriting from html_base). - - -.. _rst2html.py: tools.html#rst2html-py -.. _[html4css1 writer]: config.html#html4css1-writer -.. _html4css1.css: ../../docutils/writers/html4css1/html4css1.css - --------------------------------------------------------------------------- - -The following three HTML writers inherit from `html4css1`: - pep_html ~~~~~~~~ @@ -228,11 +196,12 @@ :config: `[pep_html writer]`_ This is a special writer for the generation of `Python Enhancement -Proposals`_ (PEPs). It adds some PEP-Specific -Options, a style sheet and template. The front-end uses also a specialised +Proposals`_ (PEPs). It inherits from html4css1_ and adds some `PEP-specific +options`_, a style sheet and template. The front-end uses also a specialised reader. .. _rstpep2html.py: tools.html#rstpep2html-py +.. _PEP-specific options: .. _[pep_html writer]: config.html#pep-html-writer .. _Python Enhancement Proposals: https://www.python.org/dev/peps/ @@ -243,9 +212,9 @@ :front-end: rst2s5.py_ :config: `[s5_html writer]`_ -The `s5` writer is used to prepare `Easy Slide Shows With reST & S5`_. It -produces XHTML for use with S5_, the “Simple Standards-based Slide Show -System” by Eric Meyer. +The `s5` writer inherits from html4css1_. It produces XHTML for use with +S5_, the “Simple Standards-based Slide Show System” by Eric Meyer. See +`Easy Slide Shows With reST & S5`_ for details. .. _rst2s5.py: tools.html#rst2s5-py .. _[s5_html writer]: config.html#s5-html-writer @@ -254,15 +223,47 @@ .. _theme: tools.html#themes +HTML writers in the sandbox +--------------------------- + +There are two more HTML writers in the sandbox_: + +xhtml11 +~~~~~~~ +:aliases: xhtml, html4strict +:front-end: rst2xhtml.py +:config: `[xhtml11 writer]` + +`XHTML 1.1`_ is the current version of the XML based `extensible Hypertext +Markup Language`. + +The `xhtml11` writer inherits from html_plain_ and adds compatibility to the +strict requirements of `XHTML 1.1`_: + +* There is no attribute "lang" (only "xml:lang"). + +* Enumerated lists don't support the 'start' attribute. + + The style sheet xhtml11.css_ adds support for a "start" value for + enumerated lists via a CSS-counter. This allows also nested enumeration. + +* ``<sup>`` and ``<sub>`` tags are not allowed in preformatted blocks + (``<pre>``). + +The `math-output` `config setting`_ defaults to "MathML". + +.. _sandbox: ../dev/policies.html#the-sandbox +.. _rst2xhtml.py: tools.html#rst2html5-py +.. _config setting: +.. _[xhtml11 writer]: config.html#xhtml11-writer +.. _xhtml11.css: ../../docutils/writers/xhtml11/xhtml11.css + + html4trans ~~~~~~~~~~ :front-end: rst2html_trans.py_ -Correct rendering of HTML+CSS requires considerable resources in form of -program code, memory space and computation time. On older machines or in -embedded devices this might pose a serious problem. - The `HTML writer for lightweight browsers`_ lives in the Docutils sandbox (`sandbox/html4trans`_) since 2008. It removes the dependency on CSS. The output conforms to `XHTML 1 Transitional`_ and contains sufficient @@ -277,9 +278,9 @@ HTML and CSS Versions ---------------------- +~~~~~~~~~~~~~~~~~~~~~ -_`HTML5` +_`HTML 5` `HTML5, A vocabulary and associated APIs for HTML and XHTML`, W3C Recommendation, 28 October 2014. http://www.w3.org/TR/html5/ Modified: trunk/docutils/docs/user/links.txt =================================================================== --- trunk/docutils/docs/user/links.txt 2015-06-03 22:04:47 UTC (rev 7900) +++ trunk/docutils/docs/user/links.txt 2015-07-16 12:31:11 UTC (rev 7901) @@ -146,24 +146,41 @@ It can generate complete web sites (interlinked and indexed HTML pages), ePub, PDF, and others [#]_ from a set of rst source files. - + .. [#] see http://sphinx-doc.org/config.html#options-for-epub-output + .. _Sphinx: http://sphinx.pocoo.org/ * Nikola_ static site generator, use restructured text by default. + .. _nikola: http://getnikola.com/ + +* Pelican_ is a static site generator (mainly for blogs). Articles/pages can + be written in reStructuredText or Markdown format. + + .. _pelican: http://docs.getpelican.com + * rst2ht_ by Oliver Rutherfurd, converts reStructuredText to an .ht template, for use with ht2html_. + .. _rst2ht: http://www.rutherfurd.net/articles/rst-ht2html.html + .. _ht2html: http://ht2html.sourceforge.net/ + * htmlnav_ by Gunnar Schwant, is an HTML writer which supports navigation bars. + .. _htmlnav: http://docutils.sf.net/sandbox/gschwant/htmlnav/ + * rest2web_, by Michael Foord, is a tool for creating web sites with reStructuredText. + .. _rest2web: http://www.voidspace.org.uk/python/rest2web/ + * rst2chm_ by Oliver Rutherfurd, generates Microsoft HTML Help files from reStructuredText files. + .. _rst2chm: http://www.rutherfurd.net/software/rst2chm/ + * `html4strict <http://docutils.sf.net/sandbox/html4strict/>`__ produces XHTML that strictly conforms to the XHTML 1.0 specification. @@ -175,22 +192,15 @@ * 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/ + .. _simple HTML writer: http://docutils.sf.net/sandbox/bbum/DocArticle/ ePub ```` - + * The `rst2epub`_ project by Robert Wierschke converts simple - reStructuredText doucments into valid epub files. - - .. simple but well structured with classes/modules for epub components, + reStructuredText doucments into valid epub files. + + .. simple but well structured with classes/modules for epub components, and a standard ``setup.py`` installation file. * rst2epub2_ by Matt Harrison includes the epublib (originally by Tim @@ -262,6 +272,11 @@ * xhtml2rest_, written by Antonios Christofides, is a simple utility to convert XHTML to reStructuredText. +* DashTable_ by Gustav Klopp converts HTML tables into reStructuredText. + Colspan and Rowspan supported! + + .. _DashTable: https://github.com/gustavklopp/DashTable + * Sphinx_ includes a `LaTeX to Rst converter <http://svn.python.org/projects/doctools/converter/>`__ in its source code (trimmed to importing the old Python docs). Modified: trunk/docutils/docs/user/tools.txt =================================================================== --- trunk/docutils/docs/user/tools.txt 2015-06-03 22:04:47 UTC (rev 7900) +++ trunk/docutils/docs/user/tools.txt 2015-07-16 12:31:11 UTC (rev 7901) @@ -101,7 +101,7 @@ :Reader: Standalone :Parser: reStructuredText -:Writer: html (html4css1_; this will change to hmtl-base_ in future) +:Writer: html_ (html4css1_) The ``rst2html.py`` front end reads standalone reStructuredText source files and produces `XHTML 1.0 Transitional`_ output. @@ -129,7 +129,7 @@ option). A stylesheet is required for proper rendering. The default stylesheet (``docutils/writers/html4css1/html4css1.css``, located in the installation directory) is provided for basic use. To use -different stylesheet(s), you must specify the stylesheets' locations +different stylesheet(s), specify the stylesheets' location(s) as comma-separated list with the "``--stylesheet``" (for a URL) or "``--stylesheet-path``" (for a local file) command-line option, or with `configuration file`_ settings (e.g. ``./docutils.conf`` @@ -138,32 +138,24 @@ __ ../howto/html-stylesheets.html .. _html4css1: html.html#html4css1 +.. _html: html.html#html -rst2xhtml.py --------------- -:Reader: Standalone -:Parser: reStructuredText -:Writer: xhtml (xhtml11) - -The ``rst2xhtml11.py`` front end reads standalone reStructuredText -source files and produces clean `XHTML 1.1`_ -output. A CSS 2 stylesheet is required for proper rendering; a complete -stylesheet is installed and used by default. - rst2html5.py ------------ :Reader: Standalone :Parser: reStructuredText -:Writer: html5 (html-base_) +:Writer: html5 (html_plain_) The ``rst2html5.py`` front end reads standalone reStructuredText source files and produces simple `HTML 5`_ output (compatible to `XHTML 1.0 -Transitional`_). A CSS 2 stylesheet is required for proper rendering; a -complete stylesheet is installed and used by default. +Transitional`_). +Correct rendering of elements not directly supported by HTML depends on a +CSS style sheet. The provided style sheets ``minimal.css`` and ``plain.css`` +define required and optional styling rules respectively. -.. _html-base: html.html#html-base +.. _html_plain: html.html#html-plain rstpep2html.py -------------- Modified: trunk/docutils/docutils/writers/__init__.py =================================================================== --- trunk/docutils/docutils/writers/__init__.py 2015-06-03 22:04:47 UTC (rev 7900) +++ trunk/docutils/docutils/writers/__init__.py 2015-07-16 12:31:11 UTC (rev 7901) @@ -120,18 +120,18 @@ _writer_aliases = { - 'html': 'html4css1', # will change to html_base some day + 'html': 'html4css1', # may change to html_plain some day 'html4': 'html4css1', - 'html5': 'html_base', # until a special HTML 5 writer is ready + 'html5': 'html_plain', # until a special HTML 5 writer is ready 'html4strict': 'xhtml11', - 'html-base': 'html_base', + 'html-plain': 'html_plain', 'latex': 'latex2e', 'pprint': 'pseudoxml', 'pformat': 'pseudoxml', 'pdf': 'rlpdf', 's5': 's5_html', 'xelatex': 'xetex', - 'xhtml': 'xhtml11', + 'xhtml': 'html_plain', 'xhtml10': 'html4css1', 'xml': 'docutils_xml'} Modified: trunk/docutils/docutils/writers/html4css1/__init__.py =================================================================== --- trunk/docutils/docutils/writers/html4css1/__init__.py 2015-06-03 22:04:47 UTC (rev 7900) +++ trunk/docutils/docutils/writers/html4css1/__init__.py 2015-07-16 12:31:11 UTC (rev 7901) @@ -47,7 +47,7 @@ os.path.abspath(os.path.dirname(__file__)), # for math.css os.path.abspath(os.path.join( - os.path.dirname(os.path.dirname(__file__)), 'html_base')) + os.path.dirname(os.path.dirname(__file__)), 'html_plain')) ] default_template = 'template.txt' Modified: trunk/docutils/setup.py =================================================================== --- trunk/docutils/setup.py 2015-06-03 22:04:47 UTC (rev 7900) +++ trunk/docutils/setup.py 2015-07-16 12:31:11 UTC (rev 7901) @@ -135,7 +135,7 @@ 'docutils.utils.math', 'docutils.writers', 'docutils.writers.html4css1', - 'docutils.writers.html_base', + 'docutils.writers.html_plain', 'docutils.writers.xhtml11', 'docutils.writers.pep_html', 'docutils.writers.s5_html', @@ -146,11 +146,11 @@ ], 'data_files': ([('docutils/parsers/rst/include', glob.glob('docutils/parsers/rst/include/*.txt')), - ('docutils/writers/html_base', - ['docutils/writers/html_base/minimal.css', - 'docutils/writers/html_base/plain.css', - 'docutils/writers/html_base/math.css', - 'docutils/writers/html_base/template.txt']), + ('docutils/writers/html_plain', + ['docutils/writers/html_plain/minimal.css', + 'docutils/writers/html_plain/plain.css', + 'docutils/writers/html_plain/math.css', + 'docutils/writers/html_plain/template.txt']), ('docutils/writers/html4css1', ['docutils/writers/html4css1/html4css1.css', 'docutils/writers/html4css1/template.txt']), Deleted: trunk/docutils/test/functional/expected/standalone_rst_html_base.html =================================================================== --- trunk/docutils/test/functional/expected/standalone_rst_html_base.html 2015-06-03 22:04:47 UTC (rev 7900) +++ trunk/docutils/test/functional/expected/standalone_rst_html_base.html 2015-07-16 12:31:11 UTC (rev 7901) @@ -1,1467 +0,0 @@ -<!DOCTYPE html> -<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> -<meta name="generator" content="Docutils 0.13: http://docutils.sourceforge.net/" /> -<title>reStructuredText Test Document</title> -<meta name="author" content="David Goodger" /> -<meta content="reStructuredText, test, parser" name="keywords" /> -<meta content="A test document, containing at least one example of each reStructuredText construct." lang="en" name="description" xml:lang="en" /> -<link rel="stylesheet" href="../input/data/minimal.css" type="text/css" /> -<link rel="stylesheet" href="../input/data/plain.css" type="text/css" /> -<link rel="stylesheet" href="../input/data/math.css" type="text/css" /> -</head> -<body> -<div class="header"> -<p>Document header</p> - -<hr class="header"/> -</div> -<div class="document" id="restructuredtext-test-document"> -<span id="doctitle"></span> -<h1 class="title">reStructuredText Test Document</h1> - -<p class="subtitle" id="examples-of-syntax-constructs"><span id="subtitle"></span>Examples of Syntax Constructs</p> -<dl class="docinfo"> -<dt class="author">Author</dt> -<dd class="author"><p>David Goodger</p></dd> -<dt class="address">Address</dt> -<dd class="address"><pre class="address">123 Example Street -Example, EX Canada -A1B 2C3 -</pre> -</dd> -<dt class="contact">Contact</dt> -<dd class="contact"><a class="reference external" href="mailto:goodger@python.org">goodger@python.org</a></dd> -<dt class="authors">Authors</dt> -<dd class="authors"><p>Me</p> -<p>Myself</p> -<p>I</p> -</dd> -<dt class="organization">Organization</dt> -<dd class="organization">humankind</dd> -<dt class="date">Date</dt> -<dd class="date">Now, or yesterday. Or maybe even <em>before</em> yesterday.</dd> -<dt class="status">Status</dt> -<dd class="status">This is a "work in progress"</dd> -<dt class="revision">Revision</dt> -<dd class="revision">is managed by a version control system.</dd> -<dt class="version">Version</dt> -<dd class="version">1</dd> -<dt class="copyright">Copyright</dt> -<dd class="copyright">This document has been placed in the public domain. You -may do with it as you wish. You may copy, modify, -redistribute, reattribute, sell, buy, rent, lease, -destroy, or improve it, quote it at length, excerpt, -incorporate, collate, fold, staple, or mutilate it, or do -anything else to it that your or anyone else's heart -desires.</dd> -<dt class="field-name">field name</dt> -<dd class="field-name"><p>This is a "generic bibliographic field".</p> -</dd> -<dt class="field-name-2">field name "2"</dt> -<dd class="field-name-2"><p>Generic bibliographic fields may contain multiple body elements.</p> -<p>Like this.</p> -</dd> -</dl> -<div class="dedication topic"> -<p class="topic-title first">Dedication</p> -<p>For Docutils users & co-developers.</p> -</div> -<div class="abstract topic"> -<p class="topic-title first">Abstract</p> -<p>This is a test document, containing at least one example of each -reStructuredText construct.</p> -</div> -<!-- This is a comment. Note how any initial comments are moved by -transforms to after the document title, subtitle, and docinfo. --> -<!-- Above is the document title, and below is the subtitle. -They are transformed from section titles after parsing. --> -<!-- bibliographic fields (which also require a transform): --> -<div class="contents topic" id="table-of-contents"> -<p class="topic-title first">Table of Contents</p> -<ul class="auto-toc simple"> -<li><p><a class="reference internal" href="#structural-elements" id="id38"><span class="sectnum">1</span> Structural Elements</a></p> -<ul class="auto-toc"> -<li><p><a class="reference internal" href="#section-title" id="id39"><span class="sectnum">1.1</span> Section Title</a></p></li> -<li><p><a class="reference internal" href="#empty-section" id="id40"><span class="sectnum">1.2</span> Empty Section</a></p></li> -<li><p><a class="reference internal" href="#transitions" id="id41"><span class="sectnum">1.3</span> Transitions</a></p></li> -</ul> -</li> -<li><p><a class="reference internal" href="#body-elements" id="id42"><span class="sectnum">2</span> Body Elements</a></p> -<ul class="auto-toc"> -<li><p><a class="reference internal" href="#paragraphs" id="id43"><span class="sectnum">2.1</span> Paragraphs</a></p> -<ul class="auto-toc"> -<li><p><a class="reference internal" href="#inline-markup" id="id44"><span class="sectnum">2.1.1</span> Inline Markup</a></p></li> -</ul> -</li> -<li><p><a class="reference internal" href="#bullet-lists" id="id45"><span class="sectnum">2.2</span> Bullet Lists</a></p></li> -<li><p><a class="reference internal" href="#enumerated-lists" id="id46"><span class="sectnum">2.3</span> Enumerated Lists</a></p></li> -<li><p><a class="reference internal" href="#definition-lists" id="id47"><span class="sectnum">2.4</span> Definition Lists</a></p></li> -<li><p><a class="reference internal" href="#field-lists" id="id48"><span class="sectnum">2.5</span> Field Lists</a></p></li> -<li><p><a class="reference internal" href="#option-lists" id="id49"><span class="sectnum">2.6</span> Option Lists</a></p></li> -<li><p><a class="reference internal" href="#literal-blocks" id="id50"><span class="sectnum">2.7</span> Literal Blocks</a></p></li> -<li><p><a class="reference internal" href="#line-blocks" id="id51"><span class="sectnum">2.8</span> Line Blocks</a></p></li> -<li><p><a class="reference internal" href="#block-quotes" id="id52"><span class="sectnum">2.9</span> Block Quotes</a></p></li> -<li><p><a class="reference internal" href="#doctest-blocks" id="id53"><span class="sectnum">2.10</span> Doctest Blocks</a></p></li> -<li><p><a class="reference internal" href="#footnotes" id="id54"><span class="sectnum">2.11</span> Footnotes</a></p></li> -<li><p><a class="reference internal" href="#citations" id="id55"><span class="sectnum">2.12</span> Citations</a></p></li> -<li><p><a class="reference internal" href="#targets" id="id56"><span class="sectnum">2.13</span> Targets</a></p> -<ul class="auto-toc"> -<li><p><a class="reference internal" href="#duplicate-target-names" id="id57"><span class="sectnum">2.13.1</span> Duplicate Target Names</a></p></li> -<li><p><a class="reference internal" href="#id21" id="id58"><span class="sectnum">2.13.2</span> Duplicate Target Names</a></p></li> -</ul> -</li> -<li><p><a class="reference internal" href="#directives" id="id59"><span class="sectnum">2.14</span> Directives</a></p> -<ul class="auto-toc"> -<li><p><a class="reference internal" href="#document-parts" id="id60"><span class="sectnum">2.14.1</span> Document Parts</a></p></li> -<li><p><a class="reference internal" href="#images-and-figures" id="id61"><span class="sectnum">2.14.2</span> Images and Figures</a></p></li> -<li><p><a class="reference internal" href="#admonitions" id="id62"><span class="sectnum">2.14.3</span> Admonitions</a></p></li> -<li><p><a class="reference internal" href="#topics-sidebars-and-rubrics" id="id63"><span class="sectnum">2.14.4</span> Topics, Sidebars, and Rubrics</a></p></li> -<li><p><a class="reference internal" href="#target-footnotes" id="id64"><span class="sectnum">2.14.5</span> Target Footnotes</a></p></li> -<li><p><a class="reference internal" href="#replacement-text" id="id65"><span class="sectnum">2.14.6</span> Replacement Text</a></p></li> -<li><p><a class="reference internal" href="#compound-paragraph" id="id66"><span class="sectnum">2.14.7</span> Compound Paragraph</a></p></li> -<li><p><a class="reference internal" href="#parsed-literal-blocks" id="id67"><span class="sectnum">2.14.8</span> Parsed Literal Blocks</a></p></li> -<li><p><a class="reference internal" href="#code" id="id68"><span class="sectnum">2.14.9</span> Code</a></p></li> -</ul> -</li> -<li><p><a class="reference internal" href="#substitution-definitions" id="id69"><span class="sectnum">2.15</span> Substitution Definitions</a></p></li> -<li><p><a class="reference internal" href="#comments" id="id70"><span class="sectnum">2.16</span> Comments</a></p></li> -<li><p><a class="reference internal" href="#raw-text" id="id71"><span class="sectnum">2.17</span> Raw text</a></p></li> -<li><p><a class="reference internal" href="#container" id="id72"><span class="sectnum">2.18</span> Container</a></p></li> -<li><p><a class="reference internal" href="#colspanning-tables" id="id73"><span class="sectnum">2.19</span> Colspanning tables</a></p></li> -<li><p><a class="reference internal" href="#rowspanning-tables" id="id74"><span class="sectnum">2.20</span> Rowspanning tables</a></p></li> -<li><p><a class="reference internal" href="#complex-tables" id="id75"><span class="sectnum">2.21</span> Complex tables</a></p></li> -<li><p><a class="reference internal" href="#list-tables" id="id76"><span class="sectnum">2.22</span> List Tables</a></p></li> -<li><p><a class="reference internal" href="#custom-roles" id="id77"><span class="sectnum">2.23</span> Custom Roles</a></p></li> -<li><p><a class="reference internal" href="#svg-images" id="id78"><span class="sectnum">2.24</span> SVG Images</a></p></li> -<li><p><a class="reference internal" href="#swf-images" id="id79"><span class="sectnum">2.25</span> SWF Images</a></p></li> -</ul> -</li> -<li><p><a class="reference internal" href="#changes-to-the-html4css1-writer" id="id80"><span class="sectnum">3</span> Changes to the html4css1 writer</a></p> -<ul class="auto-toc"> -<li><p><a class="reference internal" href="#field-list-handling" id="id81"><span class="sectnum">3.1</span> Field list handling</a></p></li> -<li><p><a class="reference internal" href="#styling-with-class-arguments" id="id82"><span class="sectnum">3.2</span> Styling with class arguments</a></p> -<ul class="auto-toc"> -<li><p><a class="reference internal" href="#description-lists" id="id83"><span class="sectnum">3.2.1</span> Description lists</a></p></li> -<li><p><a class="reference internal" href="#field-list-variants" id="id84"><span class="sectnum">3.2.2</span> Field list variants</a></p></li> -<li><p><a class="reference internal" href="#table-variants" id="id85"><span class="sectnum">3.2.3</span> Table variants</a></p></li> -</ul> -</li> -</ul> -</li> -<li><p><a class="reference internal" href="#error-handling" id="id86"><span class="sectnum">4</span> Error Handling</a></p></li> -</ul> -</div> -<div class="section" id="structural-elements"> -<h1><a class="toc-backref" href="#id38"><span class="sectnum">1</span> Structural Elements</a></h1> -<div class="section" id="section-title"> -<h2 class="with-subtitle"><a class="toc-backref" href="#id39"><span class="sectnum">1.1</span> Section Title</a></h2> -<p class="section-subtitle" id="section-subtitle">Section Subtitle</p> -<p>Lone subsections are converted to a section subtitle by a transform -activated with the <span class="docutils literal"><span class="pre">--section-subtitles</span></span> command line option or the -<span class="docutils literal"><span class="pre">sectsubtitle-xform</span></span> configuration value.</p> -</div> -<div class="section" id="empty-section"> -<h2><a class="toc-backref" href="#id40"><span class="sectnum">1.2</span> Empty Section</a></h2> -</div> -<div class="section" id="transitions"> -<h2><a class="toc-backref" href="#id41"><span class="sectnum">1.3</span> Transitions</a></h2> -<p>Here's a transition:</p> -<hr class="docutils" /> -<p>It divides the section. Transitions may also occur between sections:</p> -</div> -</div> -<hr class="docutils" /> -<div class="section" id="body-elements"> -<h1><a class="toc-backref" href="#id42"><span class="sectnum">2</span> Body Elements</a></h1> -<div class="section" id="paragraphs"> -<h2><a class="toc-backref" href="#id43"><span class="sectnum">2.1</span> Paragraphs</a></h2> -<p>A paragraph.</p> -<div class="section" id="inline-markup"> -<h3><a class="toc-backref" href="#id44"><span class="sectnum">2.1.1</span> Inline Markup</a></h3> -<p>Paragraphs contain text and may contain inline markup: <em>emphasis</em>, -<strong>strong emphasis</strong>, <span class="docutils literal">inline literals</span>, standalone hyperlinks -(<a class="reference external" href="http://www.python.org">http://www.python.org</a>), external hyperlinks (<a class="reference external" href="http://www.python.org/">Python</a> <a class="footnote-reference" href="#id25" id="id26">[5]</a>), internal -cross-references (<a class="reference internal" href="#example">example</a>), external hyperlinks with embedded URIs -(<a class="reference external" href="http://www.python.org">Python web site</a>), <a class="reference external" href="http://www.python.org/">anonymous hyperlink -references</a> <a class="footnote-reference" href="#id25" id="id35">[5]</a> (<a class="reference external" href="http://docutils.sourceforge.net/">a second reference</a> <a class="footnote-reference" href="#id36" id="id37">[9]</a>), footnote references (manually -numbered <a class="footnote-reference" href="#id8" id="id1">[1]</a>, anonymous auto-numbered <a class="footnote-reference" href="#id12" id="id2">[3]</a>, labeled auto-numbered -<a class="footnote-reference" href="#label" id="id3">[2]</a>, or symbolic <a class="footnote-reference" href="#id13" id="id4">[*]</a>), citation references (<a class="citation-reference" href="#cit2002" id="id5">[CIT2002]</a>), -substitution references (<img alt="EXAMPLE" src="../../../docs/user/rst/images/biohazard.png" />), and <span class="target" id="inline-hyperlink-targets">inline hyperlink targets</span> -(see <a class="reference internal" href="#targets">Targets</a> below for a reference back to here). Character-level -inline markup is also possible (although exceedingly ugly!) in <em>re</em><span class="docutils literal">Structured</span><em>Text</em>. Problems are indicated by <a href="#id23"><span class="problematic" id="id24">|problematic|</span></a> text -(generated by processing errors; this one is intentional). Here is a -reference to the <a class="reference internal" href="#doctitle">doctitle</a> and the <a class="reference internal" href="#subtitle">subtitle</a>.</p> -<p>The default role for interpreted text is <cite>Title Reference</cite>. Here are -some explicit interpreted text roles: a PEP reference (<a class="reference external" href="http://www.python.org/dev/peps/pep-0287">PEP 287</a>); an -RFC reference (<a class="reference external" href="http://tools.ietf.org/html/rfc2822.html">RFC 2822</a>); an abbreviation (<abbr>abb.</abbr>), an acronym -(<abbr>reST</abbr>), code (<code>print "hello world"</code>); a <sub>subscript</sub>; -a <sup>superscript</sup> and explicit roles for <cite>Docutils</cite>' -<em>standard</em> <strong>inline</strong> <span class="docutils literal">markup</span>.</p> -<!-- DO NOT RE-WRAP THE FOLLOWING PARAGRAPH! --> -<p>Let's test wrapping and whitespace significance in inline literals: -<span class="docutils literal">This is an example of <span class="pre">--inline-literal</span> <span class="pre">--text,</span> <span class="pre">--including</span> <span class="pre">some--</span> <span class="pre">strangely--hyphenated-words.</span> <span class="pre">Adjust-the-width-of-your-browser-window</span> to see how the text is wrapped. <span class="pre">--</span> <span class="pre">----</span> <span class="pre">--------</span> Now note the spacing between the words of this sentence (words should be grouped in pairs).</span></p> -<p>If the <span class="docutils literal"><span class="pre">--pep-references</span></span> option was supplied, there should be a -live link to PEP 258 here.</p> -</div> -</div> -<div class="section" id="bullet-lists"> -<h2><a class="toc-backref" href="#id45"><span class="sectnum">2.2</span> Bullet Lists</a></h2> -<ul> -<li><p>A bullet list</p> -<ul class="simple"> -<li><p>Nested bullet list.</p></li> -<li><p>Nested item 2.</p></li> -</ul> -</li> -<li><p>Item 2.</p> -<p>Paragraph 2 of item 2.</p> -<ul class="simple"> -<li><p>Nested bullet list.</p></li> -<li><p>Nested item 2.</p> -<ul> -<li><p>Third level.</p></li> -<li><p>Item 2.</p></li> -</ul> -</li> -<li><p>Nested item 3.</p></li> -<li><p>This nested list should be compacted by the HTML writer.</p> -<span class="target" id="target"></span><!-- Even if this item contains a target and a comment. --> -</li> -</ul> -</li> -</ul> -</div> -<div class="section" id="enumerated-lists"> -<h2><a class="toc-backref" href="#id46"><span class="sectnum">2.3</span> Enumerated Lists</a></h2> -<ol class="arabic"> -<li><p>Arabic numerals.</p> -<ol class="loweralpha simple"> -<li><p>lower alpha)</p> -<ol class="lowerroman simple"> -<li><p>(lower roman)</p> -<ol class="upperalpha simple"> -<li><p>upper alpha.</p> -<ol class="upperroman simple"> -<li><p>upper roman)</p></li> -</ol> -</li> -</ol> -</li> -</ol> -</li> -</ol> -</li> -<li><p>Lists that don't start at 1:</p> -<ol class="arabic simple" start="3"> -<li><p>Three</p></li> -<li><p>Four</p></li> -</ol> -<ol class="upperalpha simple" start="3"> -<li><p>C</p></li> -<li><p>D</p></li> -</ol> -<ol class="lowerroman simple" start="3"> -<li><p>iii</p></li> -<li><p>iv</p></li> -</ol> -</li> -</ol> -</div> -<div class="section" id="definition-lists"> -<h2><a class="toc-backref" href="#id47"><span class="sectnum">2.4</span> Definition Lists</a></h2> -<dl> -<dt>Term</dt> -<dd><p>Definition</p> -</dd> -<dt>Term<span class="classifier">classifier</span></dt> -<dd><p>Definition paragraph 1.</p> -<p>Definition paragraph 2.</p> -</dd> -<dt>Term</dt> -<dd><p>Definition</p> -</dd> -<dt>Term<span class="classifier">classifier one</span><span class="classifier">classifier two</span></dt> -<dd><p>Definition</p> -</dd> -</dl> -</div> -<div class="section" id="field-lists"> -<h2><a class="toc-backref" href="#id48"><span class="sectnum">2.5</span> Field Lists</a></h2> -<dl class="field-list"> -<dt>what</dt> -<dd><p>Field lists map field names to field bodies, like database -records. They are often part of an extension syntax. They are -an unambiguous variant of RFC 2822 fields.</p> -</dd> -<dt>how arg1 arg2</dt> -<dd><p>The field marker is a colon, the field name, and a colon.</p> -<p>The field body may contain one or more body elements, indented -relative to the field marker.</p> -</dd> -<dt>credits</dt> -<dd><p class="credits">This paragraph has the <cite>credits</cite> class set. (This is actually not -about credits but just for ensuring that the class attribute -doesn't get stripped away.)</p> -</dd> -</dl> -</div> -<div class="section" id="option-lists"> -<h2><a class="toc-backref" href="#id49"><span class="sectnum">2.6</span> Option Lists</a></h2> -<p>For listing command-line options:</p> -<dl class="option-list"> -<dt><kbd><span class="option">-a</span></kbd></dt> -<dd><p>command-line option "a"</p> -</dd> -<dt><kbd><span class="option">-b <var>file</var></span></kbd></dt> -<dd><p>options can have arguments -and long descriptions</p> -</dd> -<dt><kbd><span class="option">--long</span></kbd></dt> -<dd><p>options can be long also</p> -</dd> -<dt><kbd><span class="option">--input=<var>file</var></span></kbd></dt> -<dd><p>long options can also have -arguments</p> -</dd> -<dt><kbd><span class="option">--very-long-option</span></kbd></dt> -<dd><p>The description can also start on the next line.</p> -<p>The description may contain multiple body elements, -regardless of where it starts.</p> -</dd> -<dt><kbd><span class="option">-x</span>, <span class="option">-y</span>, <span class="option">-z</span></kbd></dt> -<dd><p>Multiple options are an "option group".</p> -</dd> -<dt><kbd><span class="option">-v</span>, <span class="option">--verbose</span></kbd></dt> -<dd><p>Commonly-seen: short & long options.</p> -</dd> -<dt><kbd><span class="option">-1 <var>file</var></span>, <span class="option">--one=<var>file</var></span>, <span class="option">--two <var>file</var></span></kbd></dt> -<dd><p>Multiple options with arguments.</p> -</dd> -<dt><kbd><span class="option">/V</span></kbd></dt> -<dd><p>DOS/VMS-style options too</p> -</dd> -</dl> -<p>There must be at least two spaces between the option and the -description.</p> -</div> -<div class="section" id="literal-blocks"> -<h2><a class="toc-backref" href="#id50"><span class="sectnum">2.7</span> Literal Blocks</a></h2> -<p>Literal blocks are indicated with a double-colon ("::") at the end of -the preceding paragraph (over there <span class="docutils literal"><span class="pre">--></span></span>). They can be indented:</p> -<pre class="literal-block">if literal_block: - text = 'is left as-is' - spaces_and_linebreaks = 'are preserved' - markup_processing = None</pre> -<p>Or they can be quoted without indentation:</p> -<pre class="literal-block">>> Great idea! -> -> Why didn't I think of that?</pre> -</div> -<div class="section" id="line-blocks"> -<h2><a class="toc-backref" href="#id51"><span class="sectnum">2.8</span> Line Blocks</a></h2> -<p>This section tests line blocks. Line blocks are body elements which -consist of lines and other line blocks. Nested line blocks cause -indentation.</p> -<div class="line-block"> -<div class="line">This is a line block. It ends with a blank line.</div> -<div class="line-block"> -<div class="line">New lines begin with a vertical bar ("|").</div> -<div class="line">Line breaks and initial indent are significant, and preserved.</div> -<div class="line-block"> -<div class="line">Continuation lines are also possible. A long line that is intended -to wrap should begin with a space in place of the vertical bar.</div> -</div> -<div class="line">The left edge of a continuation line need not be aligned with -the left edge of the text above it.</div> -</div> -</div> -<div class="line-block"> -<div class="line">This is a second line block.</div> -<div class="line"><br /></div> -<div class="line">Blank lines are permitted internally, but they must begin with a "|".</div> -</div> -<p>Another line block, surrounded by paragraphs:</p> -<div class="line-block"> -<div class="line">And it's no good waiting by the window</div> -<div class="line">It's no good waiting for the sun</div> -<div class="line">Please believe me, the things you dream of</div> -<div class="line">They don't fall in the lap of no-one</div> -</div> -<p>Take it away, Eric the Orchestra Leader!</p> -<blockquote> -<div class="line-block"> -<div class="line">A one, two, a one two three four</div> -<div class="line"><br /></div> -<div class="line">Half a bee, philosophically,</div> -<div class="line-block"> -<div class="line">must, <em>ipso facto</em>, half not be.</div> -</div> -<div class="line">But half the bee has got to be,</div> -<div class="line-block"> -<div class="line"><em>vis a vis</em> its entity. D'you see?</div> -<div class="line"><br /></div> -</div> -<div class="line">But can a bee be said to be</div> -<div class="line-block"> -<div class="line">or not to be an entire bee,</div> -<div class="line-block"> -<div class="line">when half the bee is not a bee,</div> -<div class="line-block"> -<div class="line">due to some ancient injury?</div> -<div class="line"><br /></div> -</div> -</div> -</div> -<div class="line">Singing...</div> -</div> -</blockquote> -<p>A line block, like the following poem by Christian Morgenstern, can -also be centre-aligned:</p> -<div class="align-center line-block" lang="de"> -<div class="line"><strong>Die Trichter</strong></div> -<div class="line"><br /></div> -<div class="line">Zwei Trichter wandeln durch die Nacht.</div> -<div class="line">Durch ihres Rumpfs verengten Schacht</div> -<div class="line">fließt weißes Mondlicht</div> -<div class="line">still und heiter</div> -<div class="line">auf ihren</div> -<div class="line">Waldweg</div> -<div class="line">u. s.</div> -<div class="line">w.</div> -<div class="line"><br /></div> -</div> -</div> -<div class="section" id="block-quotes"> -<h2><a class="toc-backref" href="#id52"><span class="sectnum">2.9</span> Block Quotes</a></h2> -<p>Block quotes consist of indented body elements:</p> -<blockquote> -<p>My theory by A. Elk. Brackets Miss, brackets. This theory goes -as follows and begins now. All brontosauruses are thin at one -end, much much thicker in the middle and then thin again at the -far end. That is my theory, it is mine, and belongs to me and I -own it, and what it is too.</p> -<p class="attribution">—<cite>Anne Elk (Miss)</cite></p> -</blockquote> -<p>The language of a quote (like any other object) can be specified by -a class attribute:</p> -<!-- --> -<blockquote lang="fr"> -<p>ReStructuredText est un langage de balisage léger utilisé -notamment dans la documentation du langage Python.</p> -</blockquote> -</div> -<div class="section" id="doctest-blocks"> -<h2><a class="toc-backref" href="#id53"><span class="sectnum">2.10</span> Doctest Blocks</a></h2> -<pre class="code python doctest">>>> print 'Python-specific usage examples; begun with ">>>"' -Python-specific usage examples; begun with ">>>" ->>> print '(cut and pasted from interactive Python sessions)' -(cut and pasted from interactive Python sessions) -</pre> -</div> -<div class="section" id="footnotes"> -<h2><a class="toc-backref" href="#id54"><span class="sectnum">2.11</span> Footnotes</a></h2> -<dl class="footnote"> -<dt class="label" id="id8">[1]<span class="fn-backref">(<a href="#id1">1</a>,<a href="#id9">2</a>,<a href="#id22">3</a>)</span></dt> -<dd><p>A footnote contains body elements, consistently indented by at -least 3 spaces.</p> -<p>This is the footnote's second paragraph.</p> -</dd> -<dt class="label" id="label">[2]<span class="fn-backref">(<a href="#id3">1</a>,<a href="#id10">2</a>)</span></dt> -<dd><p>Footnotes may be numbered, either manually (as in <a class="footnote-reference" href="#id8" id="id9">[1]</a>) or -automatically using a "#"-prefixed label. This footnote has a -label so it can be referred to from multiple places, both as a -footnote reference (<a class="footnote-reference" href="#label" id="id10">[2]</a>) and as a <a class="reference internal" href="#label">hyperlink reference</a>.</p> -</dd> -<dt class="label" id="id12"><a class="fn-backref" href="#id2">[3]</a></dt> -<dd><p>This footnote is numbered automatically and anonymously using a -label of "#" only.</p> -<p>This is the second paragraph.</p> -<p>And this is the third paragraph.</p> -</dd> -<dt class="label" id="id13"><a class="fn-backref" href="#id4">[*]</a></dt> -<dd><p>Footnotes may also use symbols, specified with a "*" label. -Here's a reference to the next footnote: <a class="footnote-reference" href="#id15" id="id14">[†]</a>.</p> -</dd> -<dt class="label" id="id15"><a class="fn-backref" href="#id14">[†]</a></dt> -<dd><p>This footnote shows the next symbol in the sequence.</p> -</dd> -<dt class="label" id="id16">[4]</dt> -<dd><p>Here's an unreferenced footnote, with a reference to a -nonexistent footnote: <a href="#id96"><span class="problematic" id="id97"><span id="id17"></span>[5]_</span></a>.</p> -</dd> -</dl> -</div> -<div class="section" id="citations"> -<h2><a class="toc-backref" href="#id55"><span class="sectnum">2.12</span> Citations</a></h2> -<dl class="citation"> -<dt class="label" id="cit2002">[CIT2002]<span class="fn-backref">(<a href="#id5">1</a>,<a href="#id18">2</a>)</span></dt> -<dd><p>Citations are text-labeled footnotes. They may be -rendered separately and differently from footnotes.</p> -</dd> -</dl> -<p>Here's a reference to the above, <a class="citation-reference" href="#cit2002" id="id18">[CIT2002]</a>, and a <a href="#id98"><span class="problematic" id="id99"><span id="id19"></span>[nonexistent]_</span></a> -citation.</p> -</div> -<div class="section" id="targets"> -<span id="another-target"></span><h2><a class="toc-backref" href="#id56"><span class="sectnum">2... [truncated message content] |
From: <mi...@us...> - 2015-08-12 14:26:59
|
Revision: 7901 http://sourceforge.net/p/docutils/code/7901 Author: milde Date: 2015-08-12 14:26:55 +0000 (Wed, 12 Aug 2015) Log Message: ----------- Rename html_base writer to html_plain, move xhtml11 writer back to sandbox. Modified Paths: -------------- trunk/docutils/HISTORY.txt trunk/docutils/RELEASE-NOTES.txt trunk/docutils/docs/dev/todo.txt trunk/docutils/docs/user/html.txt trunk/docutils/docs/user/links.txt trunk/docutils/docs/user/tools.txt trunk/docutils/docutils/writers/__init__.py trunk/docutils/docutils/writers/html4css1/__init__.py trunk/docutils/setup.py trunk/docutils/test/functional/input/data/minimal.css trunk/docutils/test/functional/input/data/plain.css trunk/docutils/test/functional/tests/math_output_mathml.py trunk/docutils/test/test_writers/test_html4css1_misc.py trunk/sandbox/html4strict/README.txt Added Paths: ----------- trunk/docutils/docutils/writers/html_plain/ trunk/docutils/docutils/writers/html_plain/__init__.py trunk/docutils/docutils/writers/html_plain/math.css trunk/docutils/docutils/writers/html_plain/minimal.css trunk/docutils/docutils/writers/html_plain/plain.css trunk/docutils/docutils/writers/html_plain/template.txt trunk/docutils/test/functional/expected/standalone_rst_html_plain.html trunk/docutils/test/functional/input/data/math.css trunk/docutils/test/functional/input/standalone_rst_html_plain.txt trunk/docutils/test/test_writers/test_html_plain_misc.py trunk/sandbox/html4strict/rst2xhtml11.py trunk/sandbox/html4strict/test/ trunk/sandbox/html4strict/test/standalone_rst_xhtml11.py trunk/sandbox/html4strict/test/standalone_rst_xhtml11.txt trunk/sandbox/html4strict/test/standalone_rst_xhtml11.xhtml trunk/sandbox/html4strict/test/xhtml11.css trunk/sandbox/html4strict/xhtml11/ trunk/sandbox/html4strict/xhtml11/__init__.py trunk/sandbox/html4strict/xhtml11/xhtml11.css Removed Paths: ------------- trunk/docutils/docutils/writers/html_base/__init__.py trunk/docutils/docutils/writers/html_base/math.css trunk/docutils/docutils/writers/html_base/minimal.css trunk/docutils/docutils/writers/html_base/plain.css trunk/docutils/docutils/writers/html_base/template.txt trunk/docutils/docutils/writers/xhtml11/__init__.py trunk/docutils/docutils/writers/xhtml11/xhtml11.css trunk/docutils/test/functional/expected/standalone_rst_html_base.html trunk/docutils/test/functional/expected/standalone_rst_xhtml11.xhtml trunk/docutils/test/functional/input/data/math.css trunk/docutils/test/functional/input/data/xhtml11.css trunk/docutils/test/functional/input/standalone_rst_html_base.txt trunk/docutils/test/functional/input/standalone_rst_xhtml11.txt trunk/docutils/test/functional/tests/standalone_rst_xhtml11.py trunk/docutils/test/test_writers/test_html_base_misc.py trunk/docutils/tools/rst2xhtml11.py Property Changed: ---------------- trunk/docutils/test/functional/input/data/minimal.css trunk/docutils/test/functional/input/data/plain.css Modified: trunk/docutils/HISTORY.txt =================================================================== --- trunk/docutils/HISTORY.txt 2015-06-03 22:04:47 UTC (rev 7900) +++ trunk/docutils/HISTORY.txt 2015-08-12 14:26:55 UTC (rev 7901) @@ -43,16 +43,14 @@ - Add ``\colon`` macro, fix spacing around colons. Fixes [ 246 ]. - New upstream version (additional macros, piecewise integrals and sums). -* docutils/writers/html_base/ +* docutils/writers/html_plain/ - New HTML writer generating clean, polyglot_ markup conforming to `HTML 5`_ and compatible with `XHTML 1.0`_ Transitional. - CSS stylesheets ``minimal.css`` and ``plain.css`` with required and - recommended layout rules. + The CSS stylesheets ``minimal.css`` and ``plain.css`` contain required + and recommended layout rules. - Also base for the xhtml11_ writer. - * docutils/writers/html4css1/__init__.py - Add "docutils" to class values for "container" object to address [ 267 ]. @@ -84,16 +82,9 @@ - LuaLaTex compatibility: do not load "xunicode". -* docutils/writers/_`xhtml11`/ - - - New HTML writer generating `XHTML 1.1`_ styled with CSS2.1 - Moved to the docutils core from sandbox/html4strict. - - * tools/ - - New front-ends ``rst2xhtml.py`` and ``rst2html5.py`` for the - corresponding writers. + - New front-end ``rst2html5.py``. * tox.ini @@ -105,7 +96,6 @@ .. _polyglot: http://www.w3.org/TR/html-polyglot/ .. _HTML 5: http://www.w3.org/TR/html5/ .. _XHTML 1.0: http://www.w3.org/TR/xhtml1/ -.. _XHTML 1.1: http://www.w3.org/TR/xhtml11/ Release 0.12 (2014-07-06) Modified: trunk/docutils/RELEASE-NOTES.txt =================================================================== --- trunk/docutils/RELEASE-NOTES.txt 2015-06-03 22:04:47 UTC (rev 7900) +++ trunk/docutils/RELEASE-NOTES.txt 2015-08-12 14:26:55 UTC (rev 7901) @@ -38,19 +38,16 @@ Changes Since 0.12 ================== -* docutils/writers/ +* docutils/writers/html_plain - - New HTML writers generating `HTML 5`_ and `XHTML 1.1`_. + - New HTML writer generating `HTML 5`_. - New stylesheet ``html-base.css`` for default layout using CSS 2.1. * tools/ - - New front-ends ``rst2xhtml.py`` and ``rst2html5.py`` for the - corresponding writers. + - New front-end ``rst2html5.py``. .. _HTML 5: http://www.w3.org/TR/html5/ -.. _XHTML 1.1: http://www.w3.org/TR/xhtml11/ Release 0.12 (2014-07-06) Modified: trunk/docutils/docs/dev/todo.txt =================================================================== --- trunk/docutils/docs/dev/todo.txt 2015-06-03 22:04:47 UTC (rev 7900) +++ trunk/docutils/docs/dev/todo.txt 2015-08-12 14:26:55 UTC (rev 7901) @@ -376,6 +376,44 @@ Especially useful for character entity sets, text transform specs, boilerplate, etc. +* Support "include" as embedded inline-compatible directive in substitution + definitions, e.g. :: + + .. |version| include:: version.txt + + This document describes version |version| of ... + + (cf. Grzegorz Adam Hankiewicz's post from 2014-10-01 in docutils-devel) + +* Add an ``:optional: <replacement text>`` option to the "include" + directive? This would not throw an error for a missing file, instead a + warning is given and ``<replacement text>`` is used instead. It would be + the responsibility of the author to ensure the missing file does not lead + to problems later in the document. + + Use cases: + + + Standard rST syntax to replace Sphinx's "literalinclude":: + + .. include:: blah.cpp + :literal: + :optional: file ``blah.cpp`` not found + + + Variable content taken from a file, e.g. + + version.txt:: + + .. |version| replace:: 3.1 + + optionally used as:: + + .. include:: version.txt + :optional: .. |version| replace:: unknown + + This document describes version |version| of ... + + (cf. Grzegorz Adam Hankiewicz's post from 2014-10-01 in docutils-devel) + * Parameterize the Reporter object or class? See the `2004-02-18 "rest checking and source path"`_ thread. @@ -1725,7 +1763,21 @@ either by running it at the command line with a ``--help`` option or through an exposed API. [Suggestion for Optik.] + - _`body.float`: Generic float that can be used for figures, tables, + code listings, flowcharts, ... + There is a Sphinx extension by Ignacio Fernández Galván <je...@gm...> + + I implemented something for generic floats in sphinx, and submitted a + pull request that is still waiting:: + + .. float:: + :type: figure + :caption: My caption + + https://github.com/sphinx-doc/sphinx/pull/1858 + + Interpreted Text ---------------- @@ -2506,9 +2558,9 @@ + `<../../test/functional/expected/standalone_rst_html4css1.html>`__ + `<../../test/functional/expected/standalone_rst_latex.tex>`__ -* According to the HTML standard - http://www.w3.org/TR/html4/struct/objects.html#adef-align-IMG a right- or - left-aligned image should be floated alongside the paragraph. +* The default CSS styling for HTML output (plain.css, default.css) lets + text following a right- or left-aligned image float to the side of the + image/figure. + Use this default also for LaTeX? Modified: trunk/docutils/docs/user/html.txt =================================================================== --- trunk/docutils/docs/user/html.txt 2015-06-03 22:04:47 UTC (rev 7900) +++ trunk/docutils/docs/user/html.txt 2015-08-12 14:26:55 UTC (rev 7901) @@ -5,98 +5,122 @@ .. note:: This document is a working draft. Naming of writers, aliases, and front-ends may change before the release of Docutils 0.13. - The ⚠ symbol marks suggestions that are still open to - discussion and change. +.. contents:: Overview -------- -Docutils supports +* `Generic HTML writers`_ -* state of the art HTML (html_base_, html5) ⚠ + =========== ============== ============== ================= =========== + name alias(es) `front-end`_ HTML version CSS version + =========== ============== ============== ================= =========== + html4css1_ html4 rst2html4.py `XHTML 1 `CSS 1`_ + Transitional`_ -* state of the art XHTML (xhtml11_) ⚠ + .. html_ rst2html.py `XHTML 1 `CSS 1`_ + Transitional`_ -* older user agents with no/limited support for CSS and XHTML (html4css1_ - and descendants). + html_plain_ html5_ rst2html5.py `HTML 5`_ `CSS 3`_ + =========== ============== ============== ================= =========== -Additionally, there are special purpose writers (pep_html_, s5_html_) in the -Docutils core and others (e.g. html4trans_) in the sandbox. +* `Special HTML writers`_ -=========== ============== ============== ================= =========== -name alias(es) `front-end`_ HTML version(s) CSS version -=========== ============== ============== ================= =========== -[#base]_ HTML5_, (`XHTML 1 `CSS 3`_ - Transitional`_) + =========== ============== ============== ================= =========== + name alias(es) `front-end`_ HTML version CSS version + =========== ============== ============== ================= =========== + pep_html_ .. rstpep2html.py `XHTML 1 `CSS 1`_ + Transitional`_ -[#5]_ html5 [#5]_ rst2html5.py HTML5_, `CSS 3`_ + s5_html_ s5 rst2s5.py `XHTML 1 `CSS 1`_ + Transitional`_ + =========== ============== ============== ================= =========== -xhtml11_ xhtml, rst2xhtml.py `XHTML 1.1`_, `CSS 3`_ - html4strict (HTML5_) +* `HTML writers in the sandbox`_ -html4css1_ html_ [#h]_, rst2html.py `XHTML 1 `CSS 1`_ - html4 Transitional`_ + =========== ============== ============== ================= =========== + name alias(es) `front-end`_ HTML version CSS version + =========== ============== ============== ================= =========== + xhtml11_ xhtml, rst2xhtml.py `XHTML 1.1`_ `CSS 3`_ + html4strict -pep_html_ .. rstpep2html.py `XHTML 1 `CSS 1`_ - Transitional`_ + html4trans_ .. rst2html_trans `XHTML 1 no CSS + Transitional`_ required + =========== ============== ============== ================= =========== -s5_html_ s5 rst2s5.py `XHTML 1 `CSS 1`_ - Transitional`_ -=========== ============== ============== ================= =========== -.. [#base] TODO: Find the right name for the basic html writer. -.. [#5] `html5` may become the name for a specialised `html5 writer`_ in a - future release. +.. _front-end: tools.html -.. There is one more HTML writer in the sandbox: +Generic HTML writers +-------------------- - html4trans_ rst2html_trans `XHTML 1 no CSS - [#sandbox]_ Transitional`_ required +html4css1 +~~~~~~~~~ - .. [#sandbox] in the sandbox +:aliases: html4, html_ +:front-ends: rst2html4.py, rst2html.py_ +:config: `[html4css1 writer]`_ -.. _front-end: tools.html +The HTML Writer module, ``docutils/writers/html4css1.py``, started +as a proof-of-concept reference implementation. It is the first Docutils +writer and was up to release 0.13 the only official HTML writer. -html ----- +The output conforms to the `XHTML 1 Transitional`_ specification. It does +not validate as `HTML 4.01 Transitional`_ due to the closing of empty tags +required in XML but not allowed in HTML 4. However, the output follows the +`HTML Compatibility Guidelines`_ for proper rendering on most HTML user +agents. -Currently, `html` is an alias for the html4css1_ writer. +Correct rendering depends on a CSS_ style sheet. A reference style sheet, +`html4css1.css`_, is provided and used by default. -.. admonition:: suggestion +To support the `Internet Explorer` (with a market share of about 90% around +2002, the time this writer was written), documents contain some hard-coded +formatting hints and are tagged as "text/html" (instead of +"application/xhtml+xml"). [#IE]_ - The writer alias `html` points to the "recommended Docutils HTML writer". - Its meaning may change with the development of HTML, browsers, Docutils, and - the web. +.. [#IE] Conformance to `CSS 2.1`_ has been added in IE 8 (2009), support + for XHTML in IE 9 (2011). - * Use `get_writer_by_name('html') or the ``rst2html.py`` front end, if you - want the output to be up-to-date automatically. +.. TODO: How to name a specific alias/front-end pointing to html4css1? - * Use a more specific writer name or front end, if you depend on stability - of the generated HTML code, e.g. because you use a custom style sheet or - post-processing that may break otherwise. + html4 + | +1 short form of html4css1, + | -1 writer produces XHTML 1, not HTML 4 + xhtml1 + | +1 correct and short description of the output format. + | -1 may be confused with xhtml11 or xhtml (aliases for the + "new" XHTML 1.1. writer inheriting from html_plain). -html_base ------------ -:aliases: html-common, html5 [#5]_ +.. _rst2html.py: tools.html#rst2html-py +.. _[html4css1 writer]: config.html#html4css1-writer +.. _html4css1.css: ../../docutils/writers/html4css1/html4css1.css + + +html_plain +~~~~~~~~~~ + +:aliases: html5_ :front-end: rst2html5.py_ -:config: `[html-base writer]`_ +:config: `[html-plain writer]`_ -The `html_base` module is both, basis for other HTML writers and a -versatile writer for end-users or programmatic use. ⚠ +The `html_plain` module is both, basis for other HTML writers and a +versatile writer for end-users or programmatic use. -It generates `polyglot HTML`_ output (compatible with HTML5_ and `XHTML 1 -Transitional`_). New features and elements will only be used if they are -widely supported to make documents `viewable with any browser`_. +The ``html_plain`` writer generates `polyglot HTML`_ output that is +compatible with `HTML 5`_ and `XHTML 1 Transitional`_. New features and +elements will only be used if they are widely supported to make documents +`viewable with any browser`_. There is no hard-coded formatting information +in the HTML document. Correct rendering of elements not directly supported +by HTML depends on a CSS_ style sheet. The provided style sheets +minimal.css_ and plain.css_ define required and optional styling rules +respectively. Adaption of the layout is possible with `custom style +sheets`_. -Correct rendering depends on a CSS_ style sheet. Leaving out hard-coded -formatting information from the HTML code allows adaption of the layout with -`custom style sheets`_. The provided style sheets minimal.css_ and -plain.css_ define required and optional styling rules respectively. - New in Docutils 0.13 -.. admonition:: TODO +.. TODO Find the right name for this writer. Suggestions: @@ -118,109 +142,53 @@ html-base -1 not only base class but also suited for end-users - .. _rst2html5.py: tools.html#rst2html5-py -.. _[html-base writer]: config.html#html-base-writer -.. _minimal.css: ../../docutils/writers/html_base/minimal.css -.. _plain.css: ../../docutils/writers/html_base/plain.css +.. _[html-plain writer]: config.html#html-plain-writer +.. _minimal.css: ../../docutils/writers/html_plain/minimal.css +.. _plain.css: ../../docutils/writers/html_plain/plain.css .. _custom style sheets: ../howto/html-stylesheets.html .. _viewable with any browser: http://www.anybrowser.org/campaign - -xhtml11 +Aliases ~~~~~~~ -:aliases: xhtml, html4strict -:front-end: rst2xhtml.py_ -:config: `[xhtml11 writer]`_ -`XHTML 1.1`_ is the current version of the XML based `extensible Hypertext -Markup Language`. +html +"""" -The `xhtml11` writer inherits from html_base_ and adds compatibility to the -strict requirements of `XHTML 1.1`_: +Currently, `html` is an alias for the html4css1_ writer. -* There is no attribute "lang" (only "xml:lang"). +Suggestion + The alias `html` points to the "recommended Docutils HTML writer". + Its target may change with the development of HTML, browsers, Docutils, and + the web. -* Enumerated lists don't support the 'start' attribute. + * Use `get_writer_by_name('html') or the ``rst2html.py`` front end, if you + want the output to be up-to-date automatically. - The style sheet xhtml11.css_ adds support for a "start" value for - enumerated lists via a CSS-counter. This allows also nested enumeration. + * Use a specific writer name or front end, if you depend on stability of + the generated HTML code, e.g. because you use a custom style sheet or + post-processing that may break otherwise. -* ``<sup>`` and ``<sub>`` tags are not allowed in preformatted blocks - (``<pre>``). +html4 +""""" -The `math-output` `config setting`_ defaults to "MathML". +The alias `html4` provides a stable shortcut for the html4css1_ writer. New in Docutils 0.13 -.. _rst2xhtml.py: tools.html#rst2html5-py -.. _config setting: -.. _[xhtml11 writer]: config.html#xhtml11-writer -.. _xhtml11.css: ../../docutils/writers/xhtml11/xhtml11.css +html5 +""""" +In Docutils 0.13, html5 is an alias to the html_plain_ writer. -.. _`html5 writer`: - -html5 -~~~~~ - -The writer name `html5` is reserved for a HTML writer that makes use of new -features and objects defined in HTML5 but not (yet) fit for use in -`html_base` because of limited browser support (like <video>, <aside>, or +In future releases, `html5` may become a separate HTML writer that makes use +of new features and objects defined in HTML5 but not (yet) fit for use in +`html_plain`_ because of limited browser support (like <video>, <aside>, or <section>). -In Docutils 0.13, it is an alias to the html_base_ writer. ⚠ +Special HTML writers +-------------------- - -html4css1 ---------- - -:aliases: html4 [#html4]_, html [#h]_ -:front-ends: rst2html.py_, rst2html4.py -:config: `[html4css1 writer]`_ - -.. [#h] `html` may become an alias for html_base in a future release. ⚠ - -The HTML Writer module, ``docutils/writers/html4css1.py``, started -as a proof-of-concept reference implementation. It is the first Docutils -writer and was up to release 0.13 the only official HTML writer. - -The output conforms to the `XHTML 1 Transitional`_ specification. -Correct rendering depends on a CSS_ style sheet. A reference style sheet, -`html4css1.css`_, is provided and used by default. - -Due to the closing of empty tags required in XML but not allowed in HTML 4, -generated documents do not validate as `HTML 4.01 Transitional`_. -However, they follow the `HTML Compatibility Guidelines`_ for proper -rendering on most HTML user agents. - -To support the `Internet Explorer` [#IE]_ (with a market share of about 90% -around 2002, the time this writer was written), documents are tagged as -"text/html" (instead of "application/xhtml+xml") and contain some hard-coded -formatting hints. - -.. [#IE] Conformance to `CSS 2.1`_ has been added in the IE 8 (2009), support - for XHTML in IE 9 (2011). - -.. [#html4] TODO: How to name a specific alias/front-end pointing to html4css1? - - html4 - | +1 short form of html4css1, - | -1 writer produces XHTML 1, not HTML 4 - xhtml1 - | +1 correct and short description of the output format. - | -1 may be confused with xhtml11 or xhtml (aliases for the - "new" XHTML 1.1. writer inheriting from html_base). - - -.. _rst2html.py: tools.html#rst2html-py -.. _[html4css1 writer]: config.html#html4css1-writer -.. _html4css1.css: ../../docutils/writers/html4css1/html4css1.css - --------------------------------------------------------------------------- - -The following three HTML writers inherit from `html4css1`: - pep_html ~~~~~~~~ @@ -228,11 +196,12 @@ :config: `[pep_html writer]`_ This is a special writer for the generation of `Python Enhancement -Proposals`_ (PEPs). It adds some PEP-Specific -Options, a style sheet and template. The front-end uses also a specialised +Proposals`_ (PEPs). It inherits from html4css1_ and adds some `PEP-specific +options`_, a style sheet and template. The front-end uses also a specialised reader. .. _rstpep2html.py: tools.html#rstpep2html-py +.. _PEP-specific options: .. _[pep_html writer]: config.html#pep-html-writer .. _Python Enhancement Proposals: https://www.python.org/dev/peps/ @@ -243,9 +212,9 @@ :front-end: rst2s5.py_ :config: `[s5_html writer]`_ -The `s5` writer is used to prepare `Easy Slide Shows With reST & S5`_. It -produces XHTML for use with S5_, the “Simple Standards-based Slide Show -System” by Eric Meyer. +The `s5` writer inherits from html4css1_. It produces XHTML for use with +S5_, the “Simple Standards-based Slide Show System” by Eric Meyer. See +`Easy Slide Shows With reST & S5`_ for details. .. _rst2s5.py: tools.html#rst2s5-py .. _[s5_html writer]: config.html#s5-html-writer @@ -254,15 +223,47 @@ .. _theme: tools.html#themes +HTML writers in the sandbox +--------------------------- + +There are two more HTML writers in the sandbox_: + +xhtml11 +~~~~~~~ +:aliases: xhtml, html4strict +:front-end: rst2xhtml.py +:config: `[xhtml11 writer]` + +`XHTML 1.1`_ is the current version of the XML based `extensible Hypertext +Markup Language`. + +The `xhtml11` writer inherits from html_plain_ and adds compatibility to the +strict requirements of `XHTML 1.1`_: + +* There is no attribute "lang" (only "xml:lang"). + +* Enumerated lists don't support the 'start' attribute. + + The style sheet xhtml11.css_ adds support for a "start" value for + enumerated lists via a CSS-counter. This allows also nested enumeration. + +* ``<sup>`` and ``<sub>`` tags are not allowed in preformatted blocks + (``<pre>``). + +The `math-output` `config setting`_ defaults to "MathML". + +.. _sandbox: ../dev/policies.html#the-sandbox +.. _rst2xhtml.py: tools.html#rst2html5-py +.. _config setting: +.. _[xhtml11 writer]: config.html#xhtml11-writer +.. _xhtml11.css: ../../docutils/writers/xhtml11/xhtml11.css + + html4trans ~~~~~~~~~~ :front-end: rst2html_trans.py_ -Correct rendering of HTML+CSS requires considerable resources in form of -program code, memory space and computation time. On older machines or in -embedded devices this might pose a serious problem. - The `HTML writer for lightweight browsers`_ lives in the Docutils sandbox (`sandbox/html4trans`_) since 2008. It removes the dependency on CSS. The output conforms to `XHTML 1 Transitional`_ and contains sufficient @@ -277,9 +278,9 @@ HTML and CSS Versions ---------------------- +~~~~~~~~~~~~~~~~~~~~~ -_`HTML5` +_`HTML 5` `HTML5, A vocabulary and associated APIs for HTML and XHTML`, W3C Recommendation, 28 October 2014. http://www.w3.org/TR/html5/ Modified: trunk/docutils/docs/user/links.txt =================================================================== --- trunk/docutils/docs/user/links.txt 2015-06-03 22:04:47 UTC (rev 7900) +++ trunk/docutils/docs/user/links.txt 2015-08-12 14:26:55 UTC (rev 7901) @@ -146,24 +146,41 @@ It can generate complete web sites (interlinked and indexed HTML pages), ePub, PDF, and others [#]_ from a set of rst source files. - + .. [#] see http://sphinx-doc.org/config.html#options-for-epub-output + .. _Sphinx: http://sphinx.pocoo.org/ * Nikola_ static site generator, use restructured text by default. + .. _nikola: http://getnikola.com/ + +* Pelican_ is a static site generator (mainly for blogs). Articles/pages can + be written in reStructuredText or Markdown format. + + .. _pelican: http://docs.getpelican.com + * rst2ht_ by Oliver Rutherfurd, converts reStructuredText to an .ht template, for use with ht2html_. + .. _rst2ht: http://www.rutherfurd.net/articles/rst-ht2html.html + .. _ht2html: http://ht2html.sourceforge.net/ + * htmlnav_ by Gunnar Schwant, is an HTML writer which supports navigation bars. + .. _htmlnav: http://docutils.sf.net/sandbox/gschwant/htmlnav/ + * rest2web_, by Michael Foord, is a tool for creating web sites with reStructuredText. + .. _rest2web: http://www.voidspace.org.uk/python/rest2web/ + * rst2chm_ by Oliver Rutherfurd, generates Microsoft HTML Help files from reStructuredText files. + .. _rst2chm: http://www.rutherfurd.net/software/rst2chm/ + * `html4strict <http://docutils.sf.net/sandbox/html4strict/>`__ produces XHTML that strictly conforms to the XHTML 1.0 specification. @@ -175,22 +192,15 @@ * 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/ + .. _simple HTML writer: http://docutils.sf.net/sandbox/bbum/DocArticle/ ePub ```` - + * The `rst2epub`_ project by Robert Wierschke converts simple - reStructuredText doucments into valid epub files. - - .. simple but well structured with classes/modules for epub components, + reStructuredText doucments into valid epub files. + + .. simple but well structured with classes/modules for epub components, and a standard ``setup.py`` installation file. * rst2epub2_ by Matt Harrison includes the epublib (originally by Tim @@ -262,6 +272,11 @@ * xhtml2rest_, written by Antonios Christofides, is a simple utility to convert XHTML to reStructuredText. +* DashTable_ by Gustav Klopp converts HTML tables into reStructuredText. + Colspan and Rowspan supported! + + .. _DashTable: https://github.com/gustavklopp/DashTable + * Sphinx_ includes a `LaTeX to Rst converter <http://svn.python.org/projects/doctools/converter/>`__ in its source code (trimmed to importing the old Python docs). Modified: trunk/docutils/docs/user/tools.txt =================================================================== --- trunk/docutils/docs/user/tools.txt 2015-06-03 22:04:47 UTC (rev 7900) +++ trunk/docutils/docs/user/tools.txt 2015-08-12 14:26:55 UTC (rev 7901) @@ -101,7 +101,7 @@ :Reader: Standalone :Parser: reStructuredText -:Writer: html (html4css1_; this will change to hmtl-base_ in future) +:Writer: html_ (html4css1_) The ``rst2html.py`` front end reads standalone reStructuredText source files and produces `XHTML 1.0 Transitional`_ output. @@ -129,7 +129,7 @@ option). A stylesheet is required for proper rendering. The default stylesheet (``docutils/writers/html4css1/html4css1.css``, located in the installation directory) is provided for basic use. To use -different stylesheet(s), you must specify the stylesheets' locations +different stylesheet(s), specify the stylesheets' location(s) as comma-separated list with the "``--stylesheet``" (for a URL) or "``--stylesheet-path``" (for a local file) command-line option, or with `configuration file`_ settings (e.g. ``./docutils.conf`` @@ -138,32 +138,24 @@ __ ../howto/html-stylesheets.html .. _html4css1: html.html#html4css1 +.. _html: html.html#html -rst2xhtml.py --------------- -:Reader: Standalone -:Parser: reStructuredText -:Writer: xhtml (xhtml11) - -The ``rst2xhtml11.py`` front end reads standalone reStructuredText -source files and produces clean `XHTML 1.1`_ -output. A CSS 2 stylesheet is required for proper rendering; a complete -stylesheet is installed and used by default. - rst2html5.py ------------ :Reader: Standalone :Parser: reStructuredText -:Writer: html5 (html-base_) +:Writer: html5 (html_plain_) The ``rst2html5.py`` front end reads standalone reStructuredText source files and produces simple `HTML 5`_ output (compatible to `XHTML 1.0 -Transitional`_). A CSS 2 stylesheet is required for proper rendering; a -complete stylesheet is installed and used by default. +Transitional`_). +Correct rendering of elements not directly supported by HTML depends on a +CSS style sheet. The provided style sheets ``minimal.css`` and ``plain.css`` +define required and optional styling rules respectively. -.. _html-base: html.html#html-base +.. _html_plain: html.html#html-plain rstpep2html.py -------------- Modified: trunk/docutils/docutils/writers/__init__.py =================================================================== --- trunk/docutils/docutils/writers/__init__.py 2015-06-03 22:04:47 UTC (rev 7900) +++ trunk/docutils/docutils/writers/__init__.py 2015-08-12 14:26:55 UTC (rev 7901) @@ -120,18 +120,18 @@ _writer_aliases = { - 'html': 'html4css1', # will change to html_base some day + 'html': 'html4css1', # may change to html_plain some day 'html4': 'html4css1', - 'html5': 'html_base', # until a special HTML 5 writer is ready + 'html5': 'html_plain', # until a special HTML 5 writer is ready 'html4strict': 'xhtml11', - 'html-base': 'html_base', + 'html-plain': 'html_plain', 'latex': 'latex2e', 'pprint': 'pseudoxml', 'pformat': 'pseudoxml', 'pdf': 'rlpdf', 's5': 's5_html', 'xelatex': 'xetex', - 'xhtml': 'xhtml11', + 'xhtml': 'html_plain', 'xhtml10': 'html4css1', 'xml': 'docutils_xml'} Modified: trunk/docutils/docutils/writers/html4css1/__init__.py =================================================================== --- trunk/docutils/docutils/writers/html4css1/__init__.py 2015-06-03 22:04:47 UTC (rev 7900) +++ trunk/docutils/docutils/writers/html4css1/__init__.py 2015-08-12 14:26:55 UTC (rev 7901) @@ -47,7 +47,7 @@ os.path.abspath(os.path.dirname(__file__)), # for math.css os.path.abspath(os.path.join( - os.path.dirname(os.path.dirname(__file__)), 'html_base')) + os.path.dirname(os.path.dirname(__file__)), 'html_plain')) ] default_template = 'template.txt' Deleted: trunk/docutils/docutils/writers/html_base/__init__.py =================================================================== --- trunk/docutils/docutils/writers/html_base/__init__.py 2015-06-03 22:04:47 UTC (rev 7900) +++ trunk/docutils/docutils/writers/html_base/__init__.py 2015-08-12 14:26:55 UTC (rev 7901) @@ -1,1747 +0,0 @@ -# .. coding: utf8 -# :Author: Günter Milde <mi...@us...> -# :Revision: $Revision$ -# :Date: $Date: 2005-06-28$ -# :Copyright: © 2005, 2009 Günter Milde. -# :License: Released under the terms of the `2-Clause BSD license`_, in short: -# -# Copying and distribution of this file, with or without modification, -# are permitted in any medium without royalty provided the copyright -# notice and this notice are preserved. -# This file is offered as-is, without any warranty. -# -# .. _2-Clause BSD license: http://www.spdx.org/licenses/BSD-2-Clause - -# Use "best practice" as recommended by the W3C: -# http://www.w3.org/2009/cheatsheet/ - - -""" -Basic HyperText Markup Language document tree Writer. - -The output conforms to the `HTML 5` specification as well as -to `XHTML 1.0 transitional`. - -The cascading style sheet "minimal.css" is required for proper viewing, -the style sheet "plain.css" provides a better reading experience. -""" -__docformat__ = 'reStructuredText' - -import sys -import os -import os.path -import re -import urllib -try: # check for the Python Imaging Library - import PIL.Image -except ImportError: - try: # sometimes PIL modules are put in PYTHONPATH's root - import Image - class PIL(object): pass # dummy wrapper - PIL.Image = Image - except ImportError: - PIL = None -import docutils -from docutils import frontend, nodes, utils, writers, languages, io -from docutils.utils.error_reporting import SafeString -from docutils.transforms import writer_aux -from docutils.utils.math import (unichar2tex, pick_math_environment, - math2html, latex2mathml, tex2mathml_extern) - -class Writer(writers.Writer): - - supported = ('html', 'html5', 'html4', 'xhtml', 'xhtml10') - """Formats this writer supports.""" - - default_stylesheets = ['minimal.css','plain.css'] - default_stylesheet_dirs = ['.', os.path.abspath(os.path.dirname(__file__))] - - default_template = 'template.txt' - default_template_path = os.path.join( - os.path.dirname(os.path.abspath(__file__)), default_template) - - settings_spec = ( - 'HTML-Specific Options', - None, - (('Specify the template file (UTF-8 encoded). Default is "%s".' - % default_template_path, - ['--template'], - {'default': default_template_path, 'metavar': '<file>'}), - ('Comma separated list of stylesheet URLs. ' - 'Overrides previous --stylesheet and --stylesheet-path settings.', - ['--stylesheet'], - {'metavar': '<URL[,URL,...]>', 'overrides': 'stylesheet_path', - 'validator': frontend.validate_comma_separated_list}), - ('Comma separated list of stylesheet paths. ' - 'Relative paths are expanded if a matching file is found in ' - 'the --stylesheet-dirs. With --link-stylesheet, ' - 'the path is rewritten relative to the output HTML file. ' - 'Default: "%s"' % ','.join(default_stylesheets), - ['--stylesheet-path'], - {'metavar': '<file[,file,...]>', 'overrides': 'stylesheet', - 'validator': frontend.validate_comma_separated_list, - 'default': default_stylesheets}), - ('Embed the stylesheet(s) in the output HTML file. The stylesheet ' - 'files must be accessible during processing. This is the default.', - ['--embed-stylesheet'], - {'default': 1, 'action': 'store_true', - 'validator': frontend.validate_boolean}), - ('Link to the stylesheet(s) in the output HTML file. ' - 'Default: embed stylesheets.', - ['--link-stylesheet'], - {'dest': 'embed_stylesheet', 'action': 'store_false'}), - ('Comma-separated list of directories where stylesheets are found. ' - 'Used by --stylesheet-path when expanding relative path arguments. ' - 'Default: "%s"' % default_stylesheet_dirs, - ['--stylesheet-dirs'], - {'metavar': '<dir[,dir,...]>', - 'validator': frontend.validate_comma_separated_list, - 'default': default_stylesheet_dirs}), - ('Specify the initial header level. Default is 1 for "<h1>". ' - 'Does not affect document title & subtitle (see --no-doc-title).', - ['--initial-header-level'], - {'choices': '1 2 3 4 5 6'.split(), 'default': '1', - 'metavar': '<level>'}), - ('Format for footnote references: one of "superscript" or ' - '"brackets". Default is "brackets".', - ['--footnote-references'], - {'choices': ['superscript', 'brackets'], 'default': 'brackets', - 'metavar': '<format>', - 'overrides': 'trim_footnote_reference_space'}), - ('Format for block quote attributions: one of "dash" (em-dash ' - 'prefix), "parentheses"/"parens", or "none". Default is "dash".', - ['--attribution'], - {'choices': ['dash', 'parentheses', 'parens', 'none'], - 'default': 'dash', 'metavar': '<format>'}), - ('Remove extra vertical whitespace between items of "simple" bullet ' - 'lists and enumerated lists. Default: enabled.', - ['--compact-lists'], - {'default': True, 'action': 'store_true', - 'validator': frontend.validate_boolean}), - ('Disable compact simple bullet and enumerated lists.', - ['--no-compact-lists'], - {'dest': 'compact_lists', 'action': 'store_false'}), - ('Remove extra vertical whitespace between items of simple field ' - 'lists. Default: enabled.', - ['--compact-field-lists'], - {'default': True, 'action': 'store_true', - 'validator': frontend.validate_boolean}), - ('Disable compact simple field lists.', - ['--no-compact-field-lists'], - {'dest': 'compact_field_lists', 'action': 'store_false'}), - ('Added to standard table classes. ' - 'Defined styles: "borderless". Default: ""', - ['--table-style'], - {'default': ''}), - ('Math output format (one of "MathML", "HTML", "MathJax", ' - 'or "LaTeX") and option(s). ' - 'Default: "HTML math.css"', - ['--math-output'], - {'default': 'HTML math.css'}), - ('Prepend an XML declaration. (Thwarts HTML5 conformance.) ' - 'Default: False', - ['--xml-declaration'], - {'default': False, 'action': 'store_true', - 'validator': frontend.validate_boolean}), - ('Omit the XML declaration.', - ['--no-xml-declaration'], - {'dest': 'xml_declaration', 'action': 'store_false'}), - ('Obfuscate email addresses to confuse harvesters while still ' - 'keeping email links usable with standards-compliant browsers.', - ['--cloak-email-addresses'], - {'action': 'store_true', 'validator': frontend.validate_boolean}),)) - - settings_defaults = {'output_encoding_error_handler': 'xmlcharrefreplace'} - - config_section = 'html-base writer' - config_section_dependencies = ('writers',) - - visitor_attributes = ( - 'head_prefix', 'head', 'stylesheet', 'body_prefix', - 'body_pre_docinfo', 'docinfo', 'body', 'body_suffix', - 'title', 'subtitle', 'header', 'footer', 'meta', 'fragment', - 'html_prolog', 'html_head', 'html_title', 'html_subtitle', - 'html_body') - - def get_transforms(self): - return writers.Writer.get_transforms(self) + [writer_aux.Admonitions] - - def __init__(self): - writers.Writer.__init__(self) - self.translator_class = HTMLTranslator - - def translate(self): - self.visitor = visitor = self.translator_class(self.document) - self.document.walkabout(visitor) - for attr in self.visitor_attributes: - setattr(self, attr, getattr(visitor, attr)) - self.output = self.apply_template() - - def apply_template(self): - template_file = open(self.document.settings.template, 'rb') - template = unicode(template_file.read(), 'utf-8') - template_file.close() - subs = self.interpolation_dict() - return template % subs - - def interpolation_dict(self): - subs = {} - settings = self.document.settings - for attr in self.visitor_attributes: - subs[attr] = ''.join(getattr(self, attr)).rstrip('\n') - subs['encoding'] = settings.output_encoding - subs['version'] = docutils.__version__ - return subs - - def assemble_parts(self): - writers.Writer.assemble_parts(self) - for part in self.visitor_attributes: - self.parts[part] = ''.join(getattr(self, part)) - - -class HTMLTranslator(nodes.NodeVisitor): - - """ - This writer generates `polyglott markup`: HTML 5 that is also valid XML. - """ - - xml_declaration = '<?xml version="1.0" encoding="%s" ?>\n' - doctype = ( - '<!DOCTYPE html>\n') - doctype_mathml = doctype - - head_prefix_template = ('<html xmlns="http://www.w3.org/1999/xhtml"' - ' xml:lang="%(lang)s" lang="%(lang)s">\n<head>\n') - content_type = ('<meta http-equiv="Content-Type"' - ' content="text/html; charset=%s" />\n') - content_type_xml = ('<meta http-equiv="Content-Type"' - ' content="application/xhtml+xml; charset=%s" />\n') - - generator = ('<meta name="generator" content="Docutils %s: ' - 'http://docutils.sourceforge.net/" />\n') - - # Template for the MathJax script in the header: - mathjax_script = '<script type="text/javascript" src="%s"></script>\n' - # The latest version of MathJax from the distributed server: - # avaliable to the public under the `MathJax CDN Terms of Service`__ - # __http://www.mathjax.org/download/mathjax-cdn-terms-of-service/ - mathjax_url = ('http://cdn.mathjax.org/mathjax/latest/MathJax.js?' - 'config=TeX-AMS-MML_HTMLorMML') - # may be overwritten by custom URL appended to "mathjax" - - stylesheet_link = '<link rel="stylesheet" href="%s" type="text/css" />\n' - embedded_stylesheet = '<style type="text/css">\n\n%s\n</style>\n' - words_and_spaces = re.compile(r'\S+| +|\n') - sollbruchstelle = re.compile(r'.+\W\W.+|[-?].+', re.U) # wrap point inside word - lang_attribute = 'lang' # name changes to 'xml:lang' in XHTML 1.1 - - def __init__(self, document): - nodes.NodeVisitor.__init__(self, document) - self.settings = settings = document.settings - lcode = settings.language_code - self.language = languages.get_language(lcode, document.reporter) - self.meta = [self.generator % docutils.__version__] - self.head_prefix = [] - self.html_prolog = [] - if settings.xml_declaration: - self.head_prefix.append(self.xml_declaration - % settings.output_encoding) - self.content_type = self.content_type_xml - # encoding not interpolated: - self.html_prolog.append(self.xml_declaration) - self.head = self.meta[:] - self.stylesheet = [self.stylesheet_call(path) - for path in utils.get_stylesheet_list(settings)] - self.body_prefix = ['</head>\n<body>\n'] - # document title, subtitle display - self.body_pre_docinfo = [] - # author, date, etc. - self.docinfo = [] - self.body = [] - self.fragment = [] - self.body_suffix = ['</body>\n</html>\n'] - self.section_level = 0 - self.initial_header_level = int(settings.initial_header_level) - - self.math_output = settings.math_output.split() - self.math_output_options = self.math_output[1:] - self.math_output = self.math_output[0].lower() - - # A heterogenous stack used in conjunction with the tree traversal. - # Make sure that the pops correspond to the pushes: - self.context = [] - - self.topic_classes = [] # TODO: replace with self_in_contents - self.colspecs = [] - self.compact_p = True - self.compact_simple = False - self.compact_field_list = False - self.in_docinfo = False - self.in_sidebar = False - self.in_footnote_list = False - self.title = [] - self.subtitle = [] - self.header = [] - self.footer = [] - self.html_head = [self.content_type] # charset not interpolated - self.html_title = [] - self.html_subtitle = [] - self.html_body = [] - self.in_document_title = 0 # len(self.body) or 0 - self.in_mailto = False - self.author_in_authors = False - self.math_header = [] - - def astext(self): - return ''.join(self.head_prefix + self.head - + self.stylesheet + self.body_prefix - + self.body_pre_docinfo + self.docinfo - + self.body + self.body_suffix) - - def encode(self, text): - """Encode special characters in `text` & return.""" - # Use only named entities known in both XML and HTML - # other characters are automatically encoded "by number" if required. - text = unicode(text) - return text.translate({ - ord('&'): u'&', - ord('<'): u'<', - ord('"'): u'"', - ord('>'): u'>', - ord('@'): u'@', # may thwart some address harvesters - }) - - def cloak_mailto(self, uri): - """Try to hide a mailto: URL from harvesters.""" - # Encode "@" using a URL octet reference (see RFC 1738). - # Further cloaking with HTML entities will be done in the - # `attval` function. - return uri.replace('@', '%40') - - def cloak_email(self, addr): - """Try to hide the link text of a email link from harversters.""" - # Surround at-signs and periods with <span> tags. ("@" has - # already been encoded to "@" by the `encode` method.) - addr = addr.replace('@', '<span>@</span>') - addr = addr.replace('.', '<span>.</span>') - return addr - - def attval(self, text, - whitespace=re.compile('[\n\r\t\v\f]')): - """Cleanse, HTML encode, and return attribute value text.""" - encoded = self.encode(whitespace.sub(' ', text)) - if self.in_mailto and self.settings.cloak_email_addresses: - # Cloak at-signs ("%40") and periods with HTML entities. - encoded = encoded.replace('%40', '%40') - encoded = encoded.replace('.', '.') - return encoded - - def stylesheet_call(self, path): - """Return code to reference or embed stylesheet file `path`""" - if self.settings.embed_stylesheet: - try: - content = io.FileInput(source_path=path, - encoding='utf-8').read() - self.settings.record_dependencies.add(path) - except IOError, err: - msg = u"Cannot embed stylesheet '%s': %s." % ( - path, SafeString(err.strerror)) - self.document.reporter.error(msg) - return '<--- %s --->\n' % msg - return self.embedded_stylesheet % content - # else link to style file: - if self.settings.stylesheet_path: - # adapt path relative to output (cf. config.html#stylesheet-path) - path = utils.relative_path(self.settings._destination, path) - return self.stylesheet_link % self.encode(path) - - def starttag(self, node, tagname, suffix='\n', empty=False, **attributes): - """ - Construct and return a start tag given a node (id & class attributes - are extracted), tag name, and optional attributes. - """ - tagname = tagname.lower() - prefix = [] - atts = {} - ids = [] - for (name, value) in attributes.items(): - atts[name.lower()] = value - classes = [] - languages = [] - # unify class arguments and move language specification - for cls in node.get('classes', []) + atts.pop('class', '').split() : - if cls.startswith('language-'): - languages.append(cls[9:]) - elif cls.strip() and cls not in classes: - classes.append(cls) - if languages: - # attribute name is 'lang' in XHTML 1.0 but 'xml:lang' in 1.1 - atts[self.lang_attribute] = languages[0] - if classes: - atts['class'] = ' '.join(classes) - assert 'id' not in atts - ids.extend(node.get('ids', [])) - if 'ids' in atts: - ids.extend(atts['ids']) - del atts['ids'] - if ids: - atts['id'] = ids[0] - for id in ids[1:]: - # Add empty "span" elements for additional IDs. Note - # that we cannot use empty "a" elements because there - # may be targets inside of references, but nested "a" - # elements aren't allowed in XHTML (even if they do - # not all have a "href" attribute). - if empty: - # Empty tag. Insert target right in front of element. - prefix.append('<span id="%s"></span>' % id) - else: - # Non-empty tag. Place the auxiliary <span> tag - # *inside* the element, as the first child. - suffix += '<span id="%s"></span>' % id - attlist = atts.items() - attlist.sort() - parts = [tagname] - for name, value in attlist: - # value=None was used for boolean attributes without - # value, but this isn't supported by XHTML. - assert value is not None - if isinstance(value, list): - values = [unicode(v) for v in value] - parts.append('%s="%s"' % (name.lower(), - self.attval(' '.join(values)))) - else: - parts.append('%s="%s"' % (name.lower(), - self.attval(unicode(value)))) - if empty: - infix = ' /' - else: - infix = '' - return ''.join(prefix) + '<%s%s>' % (' '.join(parts), infix) + suffix - - def emptytag(self, node, tagname, suffix='\n', **attributes): - """Construct and return an XML-compatible empty tag.""" - return self.starttag(node, tagname, suffix, empty=True, **attributes) - - def set_class_on_child(self, node, class_, index=0): - """ - Set class `class_` on the visible child no. index of `node`. - Do nothing if node has fewer children than `index`. - """ - children = [n for n in node if not isinstance(n, nodes.Invisible)] - try: - child = children[index] - except IndexError: - return - child['classes'].append(class_) - - def visit_Text(self, node): - text = node.astext() - encoded = self.encode(text) - if self.in_mailto and self.settings.cloak_email_addresses: - encoded = self.cloak_email(encoded) - self.body.append(encoded) - - def depart_Text(self, node): - pass - - def visit_abbreviation(self, node): - # @@@ implementation incomplete ("title" attribute) - self.body.append(self.starttag(node, 'abbr', '')) - - def depart_abbreviation(self, node): - self.body.append('</abbr>') - - def visit_acronym(self, node): - # @@@ implementation incomplete ("title" attribute) - self.body.append(self.starttag(node, 'abbr', '')) - - def depart_acronym(self, node): - self.body.append('</abbr>') - - def visit_address(self, node): - self.visit_docinfo_item(node, 'address', meta=False) - self.body.append(self.starttag(node, 'pre', '', CLASS='address')) - - def depart_address(self, node): - self.body.append('\n</pre>\n') - self.depart_docinfo_item() - - def visit_admonition(self, node): - node['classes'].insert(0, 'admonition') - self.body.append(self.starttag(node, 'div')) - - def depart_admonition(self, node=None): - self.body.append('</div>\n') - - attribution_formats = {'dash': (u'\u2014', ''), - 'parentheses': ('(', ')'), - 'parens': ('(', ')'), - 'none': ('', '')} - - def visit_attribution(self, node): - prefix, suffix = self.attribution_formats[self.settings.attribution] - self.context.append(suffix) - self.body.append( - self.starttag(node, 'p', prefix, CLASS='attribution')) - self.body.append(self.starttag(node, 'cite', '')) - - def depart_attribution(self, node): - self.body.append('</cite>' + self.context.pop() + '</p>\n') - - # author, authors - # --------------- - # Use paragraphs instead of hard-coded linebreaks. - - def visit_author(self, node): - if not(isinstance(node.parent, nodes.authors)): - self.visit_docinfo_item(node, 'author') - self.body.append('<p>') - - def depart_author(self, node): - self.body.append('</p>') - if isinstance(node.parent, nodes.authors): - self.body.append('\n') - else: - self.depart_docinfo_item() - - def visit_authors(self, node): - self.visit_docinfo_item(node, 'authors', meta=False) - - def depart_authors(self, node): - self.depart_docinfo_item() - - def visit_block_quote(self, node): - self.body.append(self.starttag(node, 'blockquote')) - - def depart_block_quote(self, node): - self.body.append('</blockquote>\n') - - def check_simple_list(self, node): - """Check for a simple list that can be rendered compactly.""" - visitor = SimpleListChecker(self.document) - try: - node.walk(visitor) - except nodes.NodeFound: - return None - else: - return 1 - - # Compact lists - # ------------ - # Include definition lists and field lists (in addition to ordered - # and unordered lists) in the test if a list is "simple" (cf. the - # html4css1.HTMLTranslator docstring and the SimpleListChecker class at - # the end of this file). - - def is_compactable(self, node): - # print "is_compactable %s ?" % node.__class__, - # explicite class arguments have precedence - if 'compact' in node['classes']: - # print "explicitely compact" - return True - if 'open' in node['classes']: - # print "explicitely open" - return False - # check config setting: - if (isinstance(node, nodes.field_list) or - isinstance(node, nodes.definition_list) - ) and not self.settings.compact_field_lists: - # print "`compact-field-lists` is False" - return False - if (isinstance(node, nodes.enumerated_list) or - isinstance(node, nodes.bullet_list) - ) and not self.settings.compact_lists: - # print "`compact-lists` is False" - return False - # more special cases: - if (self.topic_classes == ['contents']): # TODO: self.in_contents - return True - # check the list items: - visitor = SimpleListChecker(self.document) - try: - node.walk(visitor) - except nodes.NodeFound: - # print "complex node" - return False - else: - # print "simple list" - return True - - def visit_bullet_list(self, node): - atts = {} - old_compact_simple = self.compact_simple - self.context.append((self.compact_simple, self.compact_p)) - self.compact_p = None - self.compact_simple = self.is_compactable(node) - if self.compact_simple and not old_compact_simple: - atts['class'] = 'simple' - self.body.append(self.starttag(node, 'ul', **atts)) - - def depart_bullet_list(self, node): - self.compact_simple, self.compact_p = self.context.pop() - self.body.append('</ul>\n') - - def visit_caption(self, node): - self.body.append(self.starttag(node, 'p', '', CLASS='caption')) - - def depart_caption(self, node): - self.body.append('</p>\n') - - # citations - # --------- - # Use definition list instead of table for bibliographic references. - # Join adjacent citation entries. - - def visit_citation(self, node): - if not self.in_footnote_list: - self.body.append('<dl class="citation">\n') - self.in_footnote_list = True - - def depart_citation(self, node): - self.body.append('</dd>\n') - if not isinstance(node.next_node(descend=False, siblings=True), - nodes.citation): - self.body.append('</dl>\n') - self.in_footnote_list = False - - def visit_citation_reference(self, node): - href = '#' - if 'refid' in node: - href += node['refid'] - elif 'refname' in node: - href += self.document.nameids[node['refname']] - # else: # TODO system message (or already in the transform)? - # 'Citation reference missing.' - self.body.append(self.starttag( - node, 'a', '[', CLASS='citation-reference', href=href)) - - def depart_citation_reference(self, node): - self.body.append(']</a>') - - # classifier - # ---------- - # don't insert classifier-delimiter here (done by CSS) - - def visit_classifier(self, node): - self.body.append(self.starttag(node, 'span', '', CLASS='classifier')) - - def depart_classifier(self, node): - self.body.append('</span>') - - def visit_colspec(self, node): - self.colspecs.append(node) - # "stubs" list is an attribute of the tgroup element: - node.parent.stubs.append(node.attributes.get('stub')) - - def depart_colspec(self, node): - pass - - def write_colspecs(self): - width = 0 - for node in self.colspecs: - width += node['colwidth'] - for node in self.colspecs: - colwidth = int(node['colwidth'] * 100.0 / width + 0.5) - self.body.append(self.emptytag(node, 'col', - style='width: %i%%' % colwidth)) - self.colspecs = [] - - def visit_comment(self, node, - sub=re.compile('-(?=-)').sub): - """Escape double-dashes in comment text.""" - self.body.append('<!-- %s -->\n' % sub('- ', node.astext())) - # Content already processed: - raise nodes.SkipNode - - def visit_compound(self, node): - self.body.append(self.starttag(node, 'div', CLASS='compound')) - if len(node) > 1: - node[0]['classes'].append('compound-first') - node[-1]['classes'].append('compound-last') - for child in node[1:-1]: - child['classes'].append('compound-middle') - - def depart_compound(self, node): - self.body.append('</div>\n') - - def visit_container(self, node): - self.body.append(self.starttag(node, 'div', CLASS='docutils container')) - - def depart_container(self, node): - self.body.append('</div>\n') - - def visit_contact(self, node): - self.visit_docinfo_item(node, 'contact', meta=False) - - def depart_contact(self, node): - self.depart_docinfo_item() - - def visit_copyright(self, node): - self.visit_docinfo_item(node, 'copyright', meta=False) - - def depart_copyright(self, node): - self.depart_docinfo_item() - - def visit_date(self, node): - self.visit_docinfo_item(node, 'date', meta=False) - - def depart_date(self, node): - self.depart_docinfo_item() - - def visit_decoration(self, node): - pass - - def depart_decoration(self, node): - pass - - def visit_definition(self, node): - self.body.append('</dt>\n') - self.body.append(self.starttag(node, 'dd', '')) - - def depart_definition(self, node): - self.body.append('</dd>\n') - - def visit_definition_list(self, node): - classes = node.setdefault('classes', []) - if self.is_compactable(node): - classes.append('simple') - self.body.append(self.s... [truncated message content] |
From: <mi...@us...> - 2017-06-01 13:20:56
|
Revision: 8099 http://sourceforge.net/p/docutils/code/8099 Author: milde Date: 2017-06-01 13:20:54 +0000 (Thu, 01 Jun 2017) Log Message: ----------- Compile "smartquotes.txt" with --smartquotes=true. Modified Paths: -------------- trunk/docutils/docs/user/Makefile.docutils-update trunk/sandbox/infrastructure/docutils-update.local Modified: trunk/docutils/docs/user/Makefile.docutils-update =================================================================== --- trunk/docutils/docs/user/Makefile.docutils-update 2017-05-31 21:34:55 UTC (rev 8098) +++ trunk/docutils/docs/user/Makefile.docutils-update 2017-06-01 13:20:54 UTC (rev 8099) @@ -4,3 +4,6 @@ --overwrite-theme-files \ --link-stylesheet \ --no-generator --no-datestamp --no-source-link + +smartquotes.html: smartquotes.txt + rst2html.py smartquotes.txt smartquotes.html --smart-quotes=true Modified: trunk/sandbox/infrastructure/docutils-update.local =================================================================== --- trunk/sandbox/infrastructure/docutils-update.local 2017-05-31 21:34:55 UTC (rev 8098) +++ trunk/sandbox/infrastructure/docutils-update.local 2017-06-01 13:20:54 UTC (rev 8099) @@ -30,7 +30,8 @@ # ATTENTION # # Directories might contain Makefile.docutils-update files with -# special instructions. only used in docs/user to call rst2s5. +# special instructions. Used in docs/user to call rst2s5 +# add --smartquotes=true to convert smartquotes. # Maybe add special treatment and remove this general solution. # # Options: This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <dku...@us...> - 2017-07-03 22:06:56
|
Revision: 8131 http://sourceforge.net/p/docutils/code/8131 Author: dkuhlman Date: 2017-07-03 22:06:53 +0000 (Mon, 03 Jul 2017) Log Message: ----------- Various fixes for ODT writer Modified Paths: -------------- trunk/docutils/docutils/writers/odf_odt/__init__.py trunk/docutils/setup.py trunk/sandbox/OpenDocument/README.txt trunk/sandbox/OpenDocument/docs/odtwriter.txt Removed Paths: ------------- trunk/sandbox/OpenDocument/LICENSE trunk/sandbox/OpenDocument/MANIFEST trunk/sandbox/OpenDocument/docs/rst2odt.1 trunk/sandbox/OpenDocument/odtwriter/ trunk/sandbox/OpenDocument/tools/ Modified: trunk/docutils/docutils/writers/odf_odt/__init__.py =================================================================== --- trunk/docutils/docutils/writers/odf_odt/__init__.py 2017-06-28 22:29:06 UTC (rev 8130) +++ trunk/docutils/docutils/writers/odf_odt/__init__.py 2017-07-03 22:06:53 UTC (rev 8131) @@ -23,6 +23,7 @@ import StringIO import copy import urllib2 +import itertools import docutils try: import locale # module missing in Jython @@ -33,6 +34,7 @@ from docutils.transforms import references +IMAGE_NAME_COUNTER = itertools.count() WhichElementTree = '' try: # 1. Try to use lxml. @@ -902,7 +904,8 @@ self.document.reporter.warning( 'Style "%s" is not a style used by odtwriter.' % ( rststyle, )) - self.format_map[rststyle] = format.decode('utf-8') + if sys.version_info.major == 2: + self.format_map[rststyle] = format.decode('utf-8') self.section_level = 0 self.section_count = 0 # Create ElementTree content and styles documents. @@ -2405,6 +2408,7 @@ el2 = SubElement(el1, 'style:text-properties', attrib=attrib, nsdict=SNSD) style_name = 'rstframestyle%d' % self.image_style_count + draw_name = 'graphics%d' % IMAGE_NAME_COUNTER.next() # Add the styles attrib = { 'style:name': style_name, @@ -2435,7 +2439,7 @@ 'style:graphic-properties', attrib=attrib, nsdict=SNSD) attrib = { 'draw:style-name': style_name, - 'draw:name': 'Frame1', + 'draw:name': draw_name, 'text:anchor-type': 'paragraph', 'draw:z-index': '0', } @@ -2509,12 +2513,13 @@ attrib['style:wrap'] = 'none' el2 = SubElement(el1, 'style:graphic-properties', attrib=attrib, nsdict=SNSD) + draw_name = 'graphics%d' % IMAGE_NAME_COUNTER.next() # Add the content. #el = SubElement(current_element, 'text:p', # attrib={'text:style-name': self.rststyle('textbody')}) attrib={ 'draw:style-name': style_name, - 'draw:name': 'graphics2', + 'draw:name': draw_name, 'draw:z-index': '1', } if isinstance(node.parent, nodes.TextElement): Modified: trunk/docutils/setup.py =================================================================== --- trunk/docutils/setup.py 2017-06-28 22:29:06 UTC (rev 8130) +++ trunk/docutils/setup.py 2017-07-03 22:06:53 UTC (rev 8131) @@ -44,6 +44,8 @@ prune */*/*/*/*/.svn """ def run(self): + # fix + print("build_py_2to3") build_py_2to3.run(self) print("copy/convert test suite") loglevel = log.set_threshold(log.ERROR) Deleted: trunk/sandbox/OpenDocument/LICENSE =================================================================== --- trunk/sandbox/OpenDocument/LICENSE 2017-06-28 22:29:06 UTC (rev 8130) +++ trunk/sandbox/OpenDocument/LICENSE 2017-07-03 22:06:53 UTC (rev 8131) @@ -1,24 +0,0 @@ -License agreement for odtwriter -=============================== - -Copyright (c) 2006 Dave Kuhlman - -Permission is hereby granted, free of charge, to any person -obtaining a copy of this software and associated documentation -files (the "Software"), to deal in the Software without -restriction, including without limitation the rights to use, copy, -modify, merge, publish, distribute, sublicense, and/or sell copies -of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT -HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, -WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER -DEALINGS IN THE SOFTWARE. Deleted: trunk/sandbox/OpenDocument/MANIFEST =================================================================== --- trunk/sandbox/OpenDocument/MANIFEST 2017-06-28 22:29:06 UTC (rev 8130) +++ trunk/sandbox/OpenDocument/MANIFEST 2017-07-03 22:06:53 UTC (rev 8131) @@ -1,11 +0,0 @@ -README.txt -LICENSE -setup.py -MANIFEST -odtwriter/__init__.py -odtwriter/styles.odt -tools/rst2odt.py -tools/rst2odt_prepstyles.py -docs/odtwriter.txt -docs/odtwriter.html -docs/odtwriter.odt Modified: trunk/sandbox/OpenDocument/README.txt =================================================================== --- trunk/sandbox/OpenDocument/README.txt 2017-06-28 22:29:06 UTC (rev 8130) +++ trunk/sandbox/OpenDocument/README.txt 2017-07-03 22:06:53 UTC (rev 8131) @@ -2,383 +2,22 @@ OdtWriter ========= +ODT writer has moved +==================== -What is odtwriter? -================== +The ODT writer is now part of the main branch of the +``docutils`` distribution and repository. You can find ``docutils`` +here: http://docutils.sourceforge.net/ -odtwriter is a back-end, writer for Docutils. odtwriter produces -a .odt file that obeys the standards for ODF (Open Document -Format). These files are usable in oowriter which is part of -OpenOffice. +You can find the documentation for the ``docutils`` ODT writer here: +http://docutils.sourceforge.net/docs/user/odt.html -Where to Find It -================ +What is odtwriter? +================== -odtwriter is available through SVN (Subversion). It is under -sandbox/OpenDocument. See: +ODT writer is a back-end, writer for Docutils. ODT writer generates +a .odt file that obeys the standards for ODF (Open Document Format). +The generated files are usable in LibreOffice Writer. -- http://docutils.sourceforge.net/docs/dev/repository.html - -- http://svn.berlios.de/viewcvs/docutils/trunk/ - - -Documentation -============= - -Documentation is in docs/odtwriter.txt/html. - - -Additional Information -====================== - -For more information on Docutils, see: http://docutils.sourceforge.net/ - - -History -======= - -2009/03/01 ---------------- - -Improvements to images and figures -- (1) Images and figures not -text wrapped by default. (2) Added Docutils class "wrap" to force -wrapping of images and figures. - - -2008/10/28 -- Version 1.3d --------------------------- - -Added command line flags --endnotes-end-doc and ---no-endnotes-end-doc to place footnotes and citations at the end -of the document instead of at the end of the page. Generates -endnotes instead of footnotes. - -A fix to table generation. - - -2008/10/23 -- Version 1.3c --------------------------- - -Fixes for line blocks. These are now indented correctly, I -believe, even when inside a block quote. There are new styles for -line blocks (rststyle-lineblock1, ...). See the doc. - -Fixes to footnotes. Auto-numbered and auto-symbol footnotes seem -to work correctly now. There is a constant (footnote_chars) -containing the symbols (\*, \**, \***, ++, etc). - -Added support for citations. - -Fixed sections -- Now start at correct level. - -Added styles rststyle-title and rststyle-subtitle. - -Various source code clean-ups. - -Added style rststyle-footnote and rststyle-citation. - - -2008/07/08 -- Version 1.3b --------------------------- - -Added support for sub-script and super-script (:sub: and :sup:). - -Added support for classifier on definition list terms. - - -2008/07/03 -- Version 1.3a --------------------------- - -Added support for the meta directive. See docs. - -Added support for additional ``visit_``/``depart_`` methods. - -Regularized some of the methods that generated fields: revision, -version, date, address, contact, copyright, organization, etc. - -Added more control for control of paper size, thanks to Michael -Schutte: - -1. __init__.py attempts to run paperconf. If paperconf succeeds - and if the styles.odt file does not contain paper size, the size - is inserted into the styles.xml in the generated document. - -2. Added rst2odt_prepstyles.py script -- Drop page size - specifications from styles.xml in STYLE_FILE.odt. - -Added tools/rst2odt_prepstyles.py to the distribution. - - - -2008/04/18 -- Version 1.2b --------------------------- - -Increased maximum header levels. Added new header styles -rststyle-heading6 and rststyle-heading7 to styles.odt. - -Fixed bug related to lists inside of definition of a definition -list. Fixed handling of indentation levels. Thanks to Stefan -Merten for help with this. - - -2008/03/20 -- Version 1.2a, again ---------------------------------- - -Fix for footnotes -- Removed extra space between footnote reference -and preceding text. - -Added support for the Docutils raw directive. Raw XML content is -now parsed to produce an ElementTree subtree which is inserted -into the ODF content tree. See the doc (section "The raw -directive") for a few notes on using the raw directive with -odtwriter. - - -2008/01/06 -- Version 1.2a --------------------------- - -Added Stefan Merten's implementation of custom style names. - -A few miscellaneous fixes, e.g. some related to the Pygments -source code highlighting. - -Added an empty/do-nothing implementation for the raw directive. - - -2008/01/06 -- Version 1.1a, again ---------------------------------- - -Fixes to figures and images -- The caption on a figure is -displayed below the image in a space that is the same width as the -image. Also did some clean-up to the code that determines the -size of images and the code that generates them. - - -2007/12/20 -- Version 1.1a, again ---------------------------------- - -Removed extra numbers in table of contents and section titles when -the sectnum directive is used. - - -2007/12/20 -- Version 1.1a --------------------------- - -Another image fix -- If PIL is installed and if the height and -width of an image are not specified in an image directive and if -the scale is specified in an image, then odtwriter attempts to use -PIL/Image to determine the size (height, width) of the image before -scaling. - -Document title: (1) The document title and top level section -headings were both being given style rststyle-heading1. Now, -document title gets rststyle-heading1 and top level sections get -rststyle-heading2. Basically, section heading levels are bumped up -by 1. (2) The command line flag --title is now implemented. It -overrides the document title in the source document if present. - - -2007/12/19 -- Version 1.1a --------------------------- - -Minor fixes for images. But, we still cannot position an image -correctly *within* a paragraph. - - -2007/12/07 -- Version 1.1a --------------------------- - -Fixes to sourcecode highlighting. - -Fixes to images: - -- Eliminated storing the same image multiple times in the .odt file. - -- Fix to images defined in image substitution definitions. - - -2007/10/05 -- Version 1.1a --------------------------- - -Adapted odtwriter to the stronger XML namespace handling in lxml 2.0. - - -2007/10/01 -- Version 1.0e, again ---------------------------------- - -A significant improvement to the content generated for literal -blocks thanks to a patch from Johan Holmberg. - - -2007/03/14 -- Version 1.0e --------------------------- - -Fix so that rst.Directive class is not used for older versions of -Docutils. They do not implement that class. - -Fix so that if ElementTree is in the standard Python library, -odtwriter will also look for it there. - - -2007/03/14 -- Version 1.0d --------------------------- - -Added support for highlights block/directive. - -Fixed styles in highlights, epigraphs, and blockquotes. Bullet and -enum lists now have their own styles in each of these block types. - - -2007/03/12 -- Version 1.0d --------------------------- - -Added support for epigraph and the associated attribution. Added -and fixed styles for epigraph, attribution, and block-quote. - -Added support for line-block. Added style for line blocks. - -Added support for substitution (replace directive). Actually, the -substitution is done before odtwriter starts walking the tree. -But, I added the visit/depart methods so as to eliminate the error -messages. - -Fixed visit_Text so that it can add *multiple* text nodes that are -all children of the same node. - - -2007/03/09 -- Version 1.0d --------------------------- - -Fix for non-utf-8 character sets, e.g. Russian. - - -2007/03/08 -- Version 1.0d --------------------------- - -Added support for footnotes. - - -2007/02/21 -- Version 1.0c --------------------------- - -Fixed headers and footers. Added support for references/URLs. - - -2007/02/20 -- Version 1.0c --------------------------- - -Renamed directive "syntaxhighlight" to "sourcecode". Also changed -to a single argument, which can be "on" or "off" or <lexer-name>. - - -2007/01/15 -- Version 1.0c --------------------------- - -Fix for footers -- Error traceback occurred when there is no -footer, i.e. no .. footer:: directive and none of ---generator, --date, --time, --source-link, --source-url=URL. - -Another fix for titles, headers, and footers -- The title of the -document was being shoved to the bottom of the document. - -Enhancement to table of contents -- Now there are separate list -styles for list inside the table of contents and lists outside the -table of contents. See styles rststyle-bulletlist, -rststyle-tocbulletlist, rststyle-enumlist, and -rststyle-tocenumlist. - -2007/01/08 -- Version 1.0c --------------------------- - -Added support for ..header:: and ..footer:: directives. Added -styles rststyle-header and rststyle-footer. The generator, -date/time, and generated-by decorations are now combined with the -content from the ..footer:: directive. - -Made fix to literal_blocks so that interior spaces in a line are -preserved. - - -2007/01/05 -- Version 1.0c --------------------------- - -Added support for the "table" directive. Insert title into output -with new rststyle-table-title style. - -Added limited support for "container" directive. Limitations: (1) -Only the first class in the list of classes (arguments) is used -and (2) that class/style must be a paragraph style and not (for -example) a character style. - - -2006/12/31 -- Version 1.0b --------------------------- - -Fixed imports to match latest version of Pygments. - - -2006/12/29 -- Version 1.0b --------------------------- - -Added a separate lexer for LaTeX syntax highlighting. - - -2006/12/27 -- Version 1.0b --------------------------- - -Added a Docutils directive which enables user (1) to turn syntax -highlighting in literal code blocks on and off and (2) to specify -which lexer (language) to use during syntax highlighing. - -Updated the documentation to describe the syntax highlighting -directive. - - -2006/12/22 -- Version 1.0b --------------------------- - -Implemented visit_line, depart_line, visit_line_block, -depart_line_block. - -Implemented visit_subtitle and visit_subtitle as references to -visit_title and depart_title. - - -2006/12/19 -- Version 1.0b --------------------------- - -Added syntax highlighting for literal code blocks. Syntax -highlighting is applied only if Pygments is installed and the ---add-syntax-highlighting command line flag is used. Pygments can -be found here: http://pygments.pocoo.org/. See the odtwriter -documentation for information about the styles used for syntax -highlighting. - - -2006/12/18 -- Version 1.0b --------------------------- - -Fixed zipfile so that members of .odt have UNIX access permissions -and are stored deflated. - - -2006/12/07 ----------- - -Fix for ElementTree getparent() and fixed zip DEFLATE. - - ElementTree does not implement getparent(). Created wrapper - class to support this. - - Use of ZipInfo instances prevented compression. Remove it. - -Removed references to IPShell - - -2006/10/18 ----------- - -Added support for images and figures. - - - - +.. vim:ft=rst: Modified: trunk/sandbox/OpenDocument/docs/odtwriter.txt =================================================================== --- trunk/sandbox/OpenDocument/docs/odtwriter.txt 2017-06-28 22:29:06 UTC (rev 8130) +++ trunk/sandbox/OpenDocument/docs/odtwriter.txt 2017-07-03 22:06:53 UTC (rev 8131) @@ -5,8 +5,8 @@ ====================== :Author: Dave Kuhlman -:address: dku...@re... - http://www.rexx.com/~dkuhlman +:address: dkuhlman (at) davekuhlman (dot) org + http://www.davekuhlman.org :revision: 1.3d :date: |date| @@ -19,7 +19,7 @@ http://www.opensource.org/licenses/mit-license.php, an Open Source license. -:abstract: This document describes the Docutils odtwriter. +:abstract: This document describes the Docutils ODT writer. .. sectnum:: @@ -26,1052 +26,22 @@ .. contents:: +ODT writer has moved +==================== -Introduction -============ +The ODT writer is now part of the main branch of the +``docutils`` distribution and repository. You can find ``docutils`` +here: http://docutils.sourceforge.net/ -What it does -- ``rst2odt.py/odtwriter.py`` translates reST -(reStructuredText) into a Open Document Format ``.odt`` file. You -can learn more about the ODF format here: +You can find the documentation for the ``docutils`` ODT writer here: +http://docutils.sourceforge.net/docs/user/odt.html -- `OASIS Open Document Format for Office Applications - (OpenDocument) TC`_ -- `Open Document at Wikipedia`_ +What is odtwriter? +================== -You should be able to open documents (.odt files) generated with -``rst2odt.py`` in ``OpenOffice/oowriter``. I use OpenOffice version -2.3 in my testing. +ODT writer is a back-end, writer for Docutils. ODT writer generates +a .odt file that obeys the standards for ODF (Open Document Format). +The generated files are usable in LibreOffice Writer. -You can learn more about Docutils and reST here: `Docutils`_ - -How to Install It -================= - -Where to get it ---------------- - -The source distribution of -ODF/ODT writer for Docutils -is here: -`http://www.rexx.com/~dkuhlman/odtwriter-1.3d.tar.gz -<http://www.rexx.com/~dkuhlman/odtwriter-1.3d.tar.gz>`_. - -``odtwriter`` is also available via Subversion from -the Docutils repository under -``docutils/sandbox/OpenDocument/``. The following will -download Docutils including ``odtwriter`` and associated files into -your current directory:: - - $ svn checkout svn://svn.berlios.de/docutils/trunk docutils - -For more information about access to the Docutils Subversion -repository, see: -http://docutils.sourceforge.net/docs/dev/repository.html. - - -Requirements ------------- - -``odtwriter`` requires: - -- Python - -- A sufficiently recent version of `Docutils`_. - -- One of the following: - - - Lxml -- See: http://codespeak.net/lxml/. - - - ElementTree -- See: http://effbot.org/zone/element-index.htm. - - - ElementTree from that Python standard library -- Python 2.5 and - later comes with ElementTree included. - - ``odtwriter`` will try first to use Lxml; if that fails, it will - try to use a separately installed version of ElementTree; and if - that fails, it will try to use ElementTree from the standard - library. - -- Optional -- `Pygments`_ is required if you want syntax - highlighting of code in literal blocks. See section `Syntax - highlighting`_. - -- Optional -- `Python Imaging Library`_ (PIL) is required if on an - image or figure directive, you specify ``scale`` but not ``width`` - and ``height``. See section `Images and figures`_. - - -Installation ------------- - -Install ``odtwriter`` with the standard Python installation -commands:: - - $ python setup.py build - $ python setup.py install # possibly as root - -This will install ``rst2odt.py`` in your ``bin`` directory and the -odtwriter and the styles file under ``docutils/writers/odtwriter`` -within your Docutils installation. - - -How to Use It -============= - -Run it from the command line as follows:: - - $ rst2odt.py myinput.txt myoutput.odt - -To see usage information and to learn about command line flags -that you can use, run the following:: - - $ rst2odt.py --help - -Examples:: - - $ rst2odt.py -s -g python_comments.txt python_comments.odt - - $ rst2odt.py --source-url=odtwriter.txt --generator --stylesheet-path=/myconfigs/styles.odt odtwriter.txt odtwriter.odt - - -Command line flags ------------------- - -The following command line flags are specific to ``odtwriter``: - ---stylesheet=<URL> Specify a stylesheet URL, used verbatim. Overrides - --stylesheet-path. ---stylesheet-path=<file> - Specify a stylesheet file, relative to the current - working directory. The path is adjusted relative to - the output ODF file. Overrides --stylesheet. - Default: "/usr/local/lib/python2.6/site- - packages/docutils/writers/odtwriter/styles.odt" ---odf-config-file=<file> - Specify a configuration/mapping file relative to the - current working directory for additional ODF options. - In particular, this file may contain a section named - "Formats" that maps default style names to names to be - used in the resulting output file allowing for - adhering to external standards. For more info and the - format of the configuration/mapping file, see the - odtwriter doc. ---cloak-email-addresses - Obfuscate email addresses to confuse harvesters while - still keeping email links usable with standards- - compliant browsers. ---no-cloak-email-addresses - Do not obfuscate email addresses. ---table-border-thickness=TABLE_BORDER_THICKNESS - Specify the thickness of table borders in thousands of - a cm. Default is 35. ---add-syntax-highlighting - Add syntax highlighting in literal code blocks. ---no-add-syntax-highlighting - Do not add syntax highlighting in literal code blocks. - (default) ---create-sections Create sections for headers. (default) ---no-create-sections Do not create sections for headers. ---create-links Create links. ---no-create-links Do not create links. (default) ---endnotes-end-doc Generate endnotes at end of document, not footnotes at - bottom of page. ---no-endnotes-end-doc Generate footnotes at bottom of page, not endnotes at - end of document. (default) - - -Styles -====== - -``odtwriter`` uses a number of styles that are defined in the -default ``styles.xml``. This section describes those styles. - -You can modify the look of documents generated by ``odtwriter`` in -several ways: - -- Open (a copy of) ``styles.odt`` in ``OpenOffice/oowriter`` and - modify the style you wish to change. Now, save this document, - then generate your documents using this modified copy of - ``styles.odt``. - - In my version of ``oowriter``, to modify styles, either (1) - press F11 or (2) use menu item "Format/Styles and Formatting", - then right-click on the relevant style and select "Modify". - Modify the style, then save your document. - -- Open a document generated by ``odtwriter`` in `oowriter``. Now, - edit the style you are interested in modifying. Now, you - can extract the styles.xml file from your document and either - (1) use this as your default styles file or (2) copy and paste - the relevant style definition into your styles.xml. - -- Extract ``styles.xml`` from ``styles.odt`` using your favorite - ``zip/unzip`` tool. Then modify ``styles.xml`` with a text - editor. Now re-zip it back into your own ``styles.odt``, or use - it directly by specifying it with a command line flag. - **Hint:** If you intend to extract ``styles.xml`` from an - ``.odt`` file (and then "re-zip" it), you should turn off XML - optimization/compression in ``oowriter``. In order to this in - ``oowriter``, use Tools --> Options... --> Load-Save --> General - and turn off "Size optimization for XML format". - -- Open an empty (or new) document in ``oowriter``. Define the - styles described in this section. Then, use that document (a - .odt file) as your stylesheet. ``odtwriter`` will extract the - ``styles.xml`` file from that document and insert it into the - output document. - -- Some combination of the above. - - -Styles used by odtwriter ------------------------- - -This section describes the styles used by ``odtwriter``. - -Note that we do not describe the "look" of these styles. That can -be easily changed by using ``oowriter`` to edit the document -``styles.odt`` (or a copy of it), and modifying any of the styles -described here. - -To change the definition and appearance of these styles, open -``styles.odt`` in ``oowriter`` and open the Styles and Formatting -window by using the following menu item:: - - Format --> Styles and Formatting - -Then, click on the Paragraph Styles button or the Character Styles -button at the top of the Styles and Formatting window. You may -also need to select "All Styles" from the drop-down selection list -at the bottom of the Styles and Formatting window in order to see -the styles used by ``odtwriter``. - -Notice that you can make a copy of file ``styles.odt``, modify it -using ``oowriter``, and then use your copy with the -``--stylesheet-path=<file>`` command line option. Example:: - - $ rst2odt.py --stylesheet-path=mystyles.odt test2.txt test2.odt - - -Paragraph styles -~~~~~~~~~~~~~~~~ - -rststyle-attribution - The style for attributions, for example, the attribution in a - ``.. epigraph::`` directive. Derived from - ``rststyle-blockquote``. - -rststyle-blockindent - An indented block. - -rststyle-blockquote - A block quote. - -rststyle-blockquote-bulletitem - The style for bullet list items inside block quote. - -rststyle-blockquote-enumitem - The style for enumerated list items inside block quote. - -rststyle-bodyindent - An indented block. - -rststyle-bulletitem - An item in an bullet list. - -rststyle-codeblock - Literal code blocks -- A block of example code. Created with - double colon ("::") followed by an indented block or with the - ``.. parsed-literal::`` directive. Derived from the - ``Preformatted Text`` style in ``oowriter``. - -rststyle-enumitem - An item in an enumerated list. - -rststyle-epigraph - The style for epigraphs, for example, the body of an - ``.. epigraph::`` directive. Derived from - ``rststyle-blockquote``. - -rststyle-epigraph-bulletitem - The style for bullet list items inside epigraphs. - -rststyle-epigraph-enumitem - The style for enumerated list items inside epigraphs. - -rststyle-footer - The style for footers. The footer content originates from the - ``..footer::`` directive and in response to the command line - flags for generator (``--generator``), date/time generated - (``--date`` and ``--time``), and view source link - (``--source-link`` and ``--source-url=URL``). - -rststyle-header - The style for headers. The header content originates from the - ``..header::`` directive. - -rststyle-highlights - The style for highlightss, for example, the body of an - ``.. highlights::`` directive. Derived from - ``rststyle-blockquote``. - -rststyle-highlights-bulletitem - The style for bullet list items inside highlights. - -rststyle-highlights-enumitem - The style for enumerated list items inside highlights. - -rststyle-horizontalline - A horizontal line, e.g. used for transitions. - -rststyle-table-title - The style for titles of tables. See section `The table - directive`_. - -rststyle-textbody - Normal text. The style for paragraphs. Derived from the ``Text - body`` style in ``oowriter``. - - -Character styles -~~~~~~~~~~~~~~~~ - -rststyle-emphasis - Emphasis. Normally rendered as italics. - -rststyle-inlineliteral - An inline literal. - -rststyle-strong - Strong emphasis. Normally rendered as boldface. - -rststyle-quotation - In-line quoted material. - -rststyle-codeblock-classname - Syntax highlighting in literal code blocks -- class names. - -rststyle-codeblock-comment - Syntax highlighting in literal code blocks -- comments. - -rststyle-codeblock-functionname - Syntax highlighting in literal code blocks -- function names. - -rststyle-codeblock-keyword - Syntax highlighting in literal code blocks -- Python language - keywords. - -rststyle-codeblock-name - Syntax highlighting in literal code blocks -- other names, for - example, variables. - -rststyle-codeblock-number - Syntax highlighting in literal code blocks -- literal numbers, - including integers, floats, hex numbers, and octal numbers. - -rststyle-codeblock-operator - Syntax highlighting in literal code blocks -- Python operators. - -rststyle-codeblock-string - Syntax highlighting in literal code blocks -- literal strings. - - -List styles -~~~~~~~~~~~ - -rststyle-bulletlist - Bullet lists (but not in the table of contents) - -rststyle-blockquote-bulletlist - Bullet lists in block quotes. - -rststyle-blockquote-enumlist - Enumerated lists in block quotes. - -rststyle-enumlist - Enumerated lists (but not in the table of contents) - -rststyle-epigraph-bulletlist - Bullet lists in epigraphs. See the ``.. epigraph::`` - directive. - -rststyle-epigraph-enumlist - Enumerated lists in epigraphs. See the ``.. epigraph::`` - directive. - -rststyle-highlights-bulletlist - Bullet lists in highlights blocks. See the ``.. highlights::`` - directive. - -rststyle-highlights-enumlist - Enumerated lists in highlights blocks. See the ``.. highlights::`` - directive. - -rststyle-tocbulletlist - Lists in the table of contents when section numbering is off. - -rststyle-tocenumlist - Lists in the table of contents when section numbering is on. - - -Admonition styles -~~~~~~~~~~~~~~~~~ - -rststyle-admon-attention-hdr - The style for the attention admonition header/title. - -rststyle-admon-attention-body - The style for the attention admonition body/paragraph. - -rststyle-admon-caution-hdr - The style for the caution admonition header/title. - -rststyle-admon-caution-body - The style for the caution admonition body/paragraph. - -rststyle-admon-danger-hdr - The style for the admonition header/title. - -rststyle-admon-danger-body - The style for the danger admonition body/paragraph. - -rststyle-admon-error-hdr - The style for the error admonition header/title. - -rststyle-admon-error-body - The style for the error admonition body/paragraph. - -rststyle-admon-hint-hdr - The style for the hint admonition header/title. - -rststyle-admon-hint-body - The style for the hint admonition body/paragraph. - -rststyle-admon-hint-hdr - The style for the hint admonition header/title. - -rststyle-admon-hint-body - The style for the hint admonition body/paragraph. - -rststyle-admon-important-hdr - The style for the important admonition header/title. - -rststyle-admon-important-body - The style for the important admonition body/paragraph. - -rststyle-admon-note-hdr - The style for the note admonition header/title. - -rststyle-admon-note-hdr - The style for the note admonition header/title. - -rststyle-admon-tip-body - The style for the tip admonition body/paragraph. - -rststyle-admon-tip-hdr - The style for the tip admonition header/title. - -rststyle-admon-warning-body - The style for the warning admonition body/paragraph. - -rststyle-admon-warning-hdr - The style for the warning admonition header/title. - -rststyle-admon-generic-body - The style for the generic admonition body/paragraph. - -rststyle-admon-generic-hdr - The style for the generic admonition header/title. - - -Rubric style -~~~~~~~~~~~~ - -rststyle-rubric - The style for the text in a rubric directive. - -The rubric directive recognizes a "class" option. If entered, -odtwriter uses the value of that option instead of the -``rststyle-rubric`` style. Here is an example which which attaches -the ``rststyle-heading1`` style to the generated rubric:: - - .. rubric:: This is my first rubric - :class: rststyle-heading1 - - -Table styles -~~~~~~~~~~~~ - -Table styles are generated by ``oowriter`` for each table that you -create. Therefore, ``odtwriter`` attempts to do something -similar. These styles are created in the ``content.xml`` document -in the generated ``.odt``. These styles have names prefixed with -"rststyle-Table". - - - -.. _`Open Document at Wikipedia`: - http://en.wikipedia.org/wiki/OpenDocument - -.. _`OASIS Open Document Format for Office Applications (OpenDocument) TC`: - http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=office - - -Line block styles -~~~~~~~~~~~~~~~~~~ - -The line block styles wrap the various nested levels of line -blocks. There is one line block style for each indent level. - -rststyle-lineblock1 - Line block style for line block with no indent. - -rststyle-lineblock2 - Line block style for line block indented 1 level. - -rststyle-lineblock3 - Line block style for line block indented 2 levels. - -rststyle-lineblock4 - Line block style for line block indented 3 levels. - -rststyle-lineblock5 - Line block style for line block indented 4 levels. - -rststyle-lineblock6 - Line block style for line block indented 5 levels. - -Notes: - -- ``odtwriter`` does not check for a maximum level of indents - within line blocks. Therefore, you can define additional line - block styles for additional levels if you need them. Define - these styles with the names ``rststyle-lineblock7``, - ``rststyle-lineblock8``, ... - -- Since the line block style is used to create indentation, a line - block that is inside a block quote will use - ``rststyle-lineblock2`` as its first level of indentation. - - -Footnote and citation styles -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -rststyle-footnote - The style for footnotes. This style affects the footnote - content, *not* the footnote reference in the body of the document. - -rststyle-citation - The style for citations. This style affects the citation - content, *not* the citation reference in the body of the document. - You might need to adjust the indentation in this style - depending on the length of the label used in your citations. - - -Heading and title styles -~~~~~~~~~~~~~~~~~~~~~~~~~ - -rststyle-heading{1|2|3|4|5} - The styles for headings (section titles and sub-titles). Five - levels of sub-headings are provided: rststyle-heading1 through - rststyle-heading5. - -rststyle-title - The style for the document title. - -rststyle-subtitle - The style for the document sub-title. - - - - -Defining and using a custom stylesheet ---------------------------------------- - -You can create your own custom stylesheet. Here is how: - -1. Make a copy of ``styles.xml``, which is in the distribution. - -2. Open your copy of ``styles.xml`` in ``oowriter``. Modify styles - in that document. Then, save it. - -3. When you run ``rst2odt.py``, use the ``--stylesheet=<URL>`` or - ``--stylesheet-path=<file>`` to use your custom stylesheet. Run - ``rst2odt.py --help`` to learn more about these options. - - -Why custom stylesheets -~~~~~~~~~~~~~~~~~~~~~~~ - -Here are a few reasons and ideas: - -- The page size is stored in the style sheet. The default page - size is ``Letter``. You can change the page size (for example, - to ``A4``) in your custom stylesheet by opening it in - ``oowriter``, then clicking on menu: ``Format/Page...``, then - clicking on the ``Page`` tab. - - - -Defining and using custom style names -------------------------------------- - -[Credits: Stefan Merten designed and implemented the custom style names -capability. Thank you, Stefan.] - -You can also instruct ``odtwriter`` to use style names of your own -choice. - - -Why custom style names -~~~~~~~~~~~~~~~~~~~~~~ - -Here are a few reasons and ideas: - -- Suppose that your organization has a standard set of styles in - OOo ``oowriter`` and suppose that the use of these styles is - required. You would like to generate ODF documents from - reST text files, and you want the generated documents to contain - these styles. - -- Suppose that your company or organization has a policy of using a - certain MS Word template for some set of documents. You would - like to generate ODF documents that use these custom style names, - so that you can export these documents from ODF ``oowriter`` to MS - Word documents that use these style names. - -- Suppose that your documents are written in a language other than - English. You would like the style names visible in the "Styles - and Formatting" window in OOo ``oowriter`` (menu item - ``Format/Styles and Formatting``) to be understandable in the - language of your users. - -- ``odtwriter`` maps single asterisks/stars (for example, \*stuff\*) - to emphasis and double stars to strong. You'd like to reverse - these. Or, you would like to generate headings level 3 and 4 - where headings level 1 and 2 would normally be produced. - - -How to use custom style names -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -In order to define custom style names and to generate documents that -contain them, do the following: - - -1. Create a configuration file containing a "Formats" section. The - configuration file obeys the file format supported by the Python - ConfigParser module: - `ConfigParser -- Configuration file parser -- - http://docs.python.org/lib/module-ConfigParser.html - <http://docs.python.org/lib/module-ConfigParser.html>`_. - -2. In the "Formats" section of the configuration file, create one - option (a name-value pair) for each custom style name that you - wish to define. The option name is the standard ``odtwriter`` - style name (without "rststyle-"), and the value is your custom - style name. Here is an example:: - - [Formats] - textbody: mytextbody - bulletitem: mybulletitem - heading1: myheading1 - o - o - o - -3. Create a styles document that defines the styles generated by - ``odtwriter``. You can create and edit the styles in OOo - ``oowriter``. It may be helpful to begin by making a copy of the - styles document that is part of the ``odtwriter`` distribution - (``styles.odt``). - -4. When you run ``odtwriter``, specify the ``--odf-config-file`` - option. You might also want to specify your styles document - using the ``--stylesheet-path`` option in order to include your - custom style definitions. For example:: - - rst2odt.py --odf-config-file=mymappingfile.ini --stylesheet-path=mystyles.odt mydoc.txt mydoc.odt - - - -Hints and Suggestions and Features -================================== - -Table of contents ------------------ - -``odtwriter`` can generate an outline style table of contents. -However, if you want an ``oowriter`` style table of contents along -with the formatting control that ``oowriter`` gives you, then you -may want to omit the ``.. contents::`` directive and, after -generating your document, open it in ``oowriter`` and insert a -table of contents. That feature is under menu item:: - - Insert --> Indexes and Tables --> Indexes and Tables - - -Syntax highlighting -------------------- - -**Note:** Syntax highlighting uses the Docutils class -``docutils.parsers.rst.Directive``. Therefore, it requires a very -recent version of Docutils, specifically version 0.5 or later. - -``odtwriter`` can add syntax highlighting to code in code -blocks. In order to activate this, do all of the following: - -1. Install Pygments_ and ... - -2. Use the command line flag ``--add-syntax-highlighting``. - Example:: - - $ rst2odt.py -g --add-syntax-highlight test.txt test.odt - - and ... - -3. In your reST (.txt) file, include code to which syntax - highlighting is to be applied inside a ``sourcecode`` directive, - for example: - - .. parsed-literal:: - - .. sourcecode:: *language* - - def test(): - print 'hi' - return 'something' - - where *language* is the programming language, for example - "python", "java", etc. See the - `Pygments documentation`_ for a list of - `languages supported by Pygments`_. - -The following styles are defined in styles.odt and are used for -literal code blocks and syntax highlighting: - -- Paragraph styles: - - - rststyle-codeblock -- The style for the code block as a whole. - -- Character styles: - - - rststyle-codeblock-classname -- class names. - - - rststyle-codeblock-comment -- comments. - - - rststyle-codeblock-functionname -- function names. - - - rststyle-codeblock-keyword -- Python language keywords. - - - rststyle-codeblock-name -- other names, for example, - variables. - - - rststyle-codeblock-number -- literal numbers, including - integers, floats, hex numbers, and octal numbers. - - - rststyle-codeblock-operator -- Python operators. - - - rststyle-codeblock-string -- literal strings. - -Each of the above styles has a default appearance that is defined -in ``styles.odt``. To change that definition and appearance, open -``styles.odt`` in ``oowriter`` and use menu item:: - - Format --> Styles and Formatting - -Then, click on the Paragraph Styles button or the Character Styles -button at the top of the Styles and Formatting window. You may -also need to select "All Styles" from the drop-down selection list -at the bottom of the Styles and Formatting window. - - -Controlling syntax highlighting within a document -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -By default, when you use the ``--add-syntax-highlighting`` command -line flag, syntax highlighting in literal blocks is on and the -Python lexer is used. You can change this within your reST document -with the following directive: - -.. parsed-literal:: - - .. sourcecode:: *newstate* - -or: - -.. parsed-literal:: - - .. sourcecode:: *language* - -where: - -- *newstate* is either "on" or "off", which makes highlighting - active or inactive. - -- *language* is the language in literal code blocks. It should be - one of the *"short names"* listed at Pygments' `Available - Lexers`_, for example "python", "pycon", "java", "cpp", "c", - "perl", "javascript", etc. - -Examples:: - - .. sourcecode:: on - .. sourcecode:: python - .. sourcecode:: off - .. sourcecode:: java - .. sourcecode:: on - -A few additional notes and hints: - -- The syntax highlighting state and language set by this - directive remain in effect until the next ``sourcecode`` directive - is encountered in the reST document. - -- In order to turn syntax highlighting on (or off) and set the - language, you will need to use this directive twice. - -- Special note to Pythonistas: there is a separate lexer for - examples of code from the Python interactive prompt and console - output or doctests. The alias for that lexer is "pycon". - -.. _`Pygments documentation`: - http://pygments.org/docs/ - -.. _`languages supported by Pygments`: - http://pygments.org/languages/ - -.. _`Available Lexers`: - http://pygments.org/docs/lexers/ - - -The container directive ------------------------ - -There is limited support for the ``container`` directive. The -limitations are the following: - -- Only the first class in the list of classes (arguments) is used - and - -- That class/style must be a paragraph style and not (for example) a - character style. - -So, for example:: - - .. container:: style-1 style-2 style-3 - - a block of text - -Only ``style-1`` is used; ``style-2`` and ``style-3`` are ignored. -And, ``style-1`` must be a paragraph style. - -To define a paragraph style, use the following menu item:: - - Format --> Styles and Formatting - -Then, click on the Paragraph Styles button. - -The following example attaches the ``rststyle-heading2`` style (a -predefined style) to each paragraph/line in the container:: - - .. container:: rststyle-heading2 - - Line 1 of container. - - Line 2 of container. - -You could also define a new style (for example, in your -``styles.odt``) and reference that in a ``container`` directive. - - - -The table directive -------------------- - -The ``table`` directive can be used to add a title to a table. -Example:: - - .. table:: A little test table - - =========== ============= - Name Value - =========== ============= - Dave Cute - Mona Smart - =========== ============= - -The above will insert the title "A little test table" at the top of the -table. You can modify the appearance of the title by modifying the -paragraph style ``rststyle-table-title``. - - -Footnotes and citations ------------------------ - -Footnotes and citations are supported. - -There are additional styles ``rststyle-footnote`` and -``rststyle-citation`` for footnotes and citations. See -`Footnote and citation styles`_. - -You may need to modify the citation style to fit the length of your -citation references. - -Endnotes -- There are command line flags that control whether -``odtwriter`` creates endnotes instead of footnotes. Endnotes -appear at the end of the document instead of at the bottom of the -page. See flags ``--endnotes-end-doc`` and -``--no-endnotes-end-doc`` in section `Command line flags`_. - - -Images and figures ------------------- - -If on the image or the figure directive you provide the scale option -but do not provide the width and height options, then ``odtwriter`` -will attempt to determine the size of the image using the `Python -Imaging Library`_ (PIL). If ``odtwriter`` cannot find and import -Python Imaging Library, it will raise an exception. If this -ocurrs, you can fix it by doing one of the following: - -- Install the Python Imaging Library or - -- Remove the ``scale`` option or - -- Add both the ``width`` and the ``height`` options. - -So, the rule is: if on any image or figure, you specify scale but -not both width and height, you must install the `Python Imaging -Library`_ library. - -For more information about PIL, see: `Python Imaging Library`_. - - -The raw directive ------------------ - -The ``raw`` directive is supported. Use output format type "odt". - -You will need to be careful about the formatting of the raw -content. In particular, introduced whitespace might be a problem. - -In order to produce content for the raw directive for use by -``odtwriter``, you might want to extract the file ``content.xml`` -from a ``.odt`` file (using some Zip tool), and then clip, paste, -and modify a selected bit of it. - -Here is an example:: - - .. raw:: odt - - <text:p text:style-name="rststyle-textbody">Determining <text:span text:style-name="rststyle-emphasis">which</text:span> namespace a name is in is static. It can be - determined by a lexical scan of the code. If a variable is assigned a - value <text:span text:style-name="rststyle-emphasis">anywhere</text:span> in a scope (specifically within a function or method - body), then that variable is local to that scope. If Python does not - find a variable in the local scope, then it looks next in the global - scope (also sometimes called the module scope) and then in the - built-ins scope. But, the <text:span text:style-name="rststyle-inlineliteral">global</text:span> statement can be used to force - Python to find and use a global variable (a variable defined at top - level in a module) rather than create a local one.</text:p> - - -The meta directive ------------------- - -``odtwriter`` supports the ``meta`` directive. Two fields are -recognized: "keywords" and "description". Here is an example:: - - .. meta:: - :keywords: reStructuredText, docutils, formatting - :description lang=en: A reST document, contains formatted - text in a formatted style. - -To see the results of the ``meta`` directive in ``oowriter``, -select menu item "File/Properties...", then click on the -"Description" tab. - - -Footnote references inside footnotes ------------------------------------- - -Not supported. - -Get a grip. Be serious. Try a dose of reality. - -``odtwriter`` ignores them. - -They cause ``oowriter`` to croak. - - -Page size ---------- - -The default page size, in documents generated by ``odtwriter`` is -``Letter``. You can change this (for example to ``A4``) by using a -custom stylesheet. See `Defining and using a custom stylesheet`_ -for instructions on how to do this. - -On machines which support ``paperconf``, ``odtwriter`` can insert -the default page size for your locale. In order for this to work, -the following conditions must be met: - -1. The program ``paperconf`` must be available on your system. - ``odtwriter`` uses ``paperconf -s`` to obtain the paper size. - See ``man paperconf`` for more information. - -2. The default page height and width must be removed from the - ``styles.odt`` used to generate the document. A Python script - ``rst2odt_prepstyles.py`` is distributed with ``odtwriter`` and - is installed in the ``bin`` directory. You can remove the page - height and width with something like the following:: - - $ rst2odt_prepstyles.py styles.odt - -.. warning:: If you edit your stylesheet in ``oowriter`` and then - save it, ``oowriter`` automatically inserts a page height and - width in the styles for that (stylesheet) document. If that is - not the page size that you want and you want ``odtwriter`` to - insert a default page size using ``paperconf``, then you will - need to strip the page size from your stylesheet each time you - edit that stylesheet with ``oowriter``. - - -Credits -======= - -Stefan Merten designed and implemented the custom style names -capability. Thank you, Stefan. - -Michael Schutte supports the Debian GNU/Linux distribution of -``odtwriter``. Thank you, Michael, for providing and supporting -the Debian package. - -Michael Schutte implemented the fix that enables ``odtwriter`` to -pick up the default paper size on platforms where the program -``paperconf`` is available. Thank you. - - - - -.. _`Pygments`: - http://pygments.pocoo.org/ - -.. _`Docutils`: - http://docutils.sourceforge.net/ - -.. _`Python Imaging Library`: - http://www.pythonware.com/products/pil/ - - -.. Configuration for Emacs -.. - Local Variables: - mode: rst - indent-tabs-mode: nil - sentence-end-double-space: t - fill-column: 68 - End: - - +.. vim:ft=rst: Deleted: trunk/sandbox/OpenDocument/docs/rst2odt.1 =================================================================== --- trunk/sandbox/OpenDocument/docs/rst2odt.1 2017-06-28 22:29:06 UTC (rev 8130) +++ trunk/sandbox/OpenDocument/docs/rst2odt.1 2017-07-03 22:06:53 UTC (rev 8131) @@ -1,281 +0,0 @@ -.TH RST2ODT "1" "January 2008" "docutils" "User Commands" -.SH NAME -rst2odt \- convert reST documents to ODT -.SH SYNOPSIS -.B rst2odt -[\fIoptions\fR] [\fIsource\fR [\fIdestination\fR]] -.SH DESCRIPTION -.PP -Generates OpenDocument Text (ODT) documents from reStructuredText sources. -Reads from \fIsource\fR (default is stdin) and writes to \fIdestination\fR -(default is stdout). -.SH OPTIONS - -.SS -\fBGeneral Docutils Options\fR -.TP -\fB\-\-title\fR=\fITITLE\fR -Specify the document title as metadata (not part of -the document body). Overrides a document-provided -title. There is no default. -.TP -\fB\-\-generator\fR, \fB\-g\fR -Include a "Generated by Docutils" credit and link at -the end of the document. -.TP -\fB\-\-no\-generator\fR -Do not include a generator credit. -.TP -\fB\-\-date\fR, \fB\-d\fR -Include the date at the end of the document (UTC). -.TP -\fB\-\-time\fR, \fB\-t\fR -Include the time & date at the end of the document -(UTC). -.TP -\fB\-\-no\-datestamp\fR -Do not include a datestamp of any kind. -.TP -\fB\-\-source\-link\fR, \fB\-s\fR -Include a "View document source" link (relative to -destination). -.TP -\fB\-\-source\-url\fR=\fI<URL>\fR -Use the supplied <URL> verbatim for a "View document -source" link; implies \-\-source-link. -.TP -\fB\-\-no\-source\-link\fR -Do not include a "View document source" link. -.TP -\fB\-\-toc\-entry\-backlinks\fR -Enable backlinks from section headers to table of -contents entries. This is the default. -.TP -\fB\-\-toc\-top\-backlinks\fR -Enable backlinks from section headers to the top of -the table of contents. -.TP -\fB\-\-no\-toc\-backlinks\fR -Disable backlinks to the table of contents. -.TP -\fB\-\-footnote\-backlinks\fR -Enable backlinks from footnotes and citations to their -references. This is the default. -.TP -\fB\-\-no\-footnote\-backlinks\fR -Disable backlinks from footnotes and citations. -.TP -\fB\-\-section\-numbering\fR -Enable Docutils section numbering (default: enabled). -.TP -\fB\-\-no\-section\-numbering\fR -Disable Docutils section numbering (default: enabled). -.TP -\fB\-\-strip\-comments\fR -Remove comment elements from the document tree -(default: leave them). -.TP -\fB\-\-leave\-comments\fR -Leave comment elements in the document tree (this is -the default). -.TP -\fB\-\-report\fR=\fI<level>\fR, \fB\-r\fR \fI<level>\fR -Set verbosity threshold; report system messages at or -higher than <level> (by name or number: "info" or "1", -warning/2, error/3, severe/4; also, "none" or "5"). -Default is 2 (warning). -.TP -\fB\-\-verbose\fR, \fB\-v\fR -Report all system messages, info-level and higher. -(Same as "\-\-report=info".) -.TP -\fB\-\-quiet\fR, \fB\-q\fR -Do not report any system messages. (Same as -"\-\-report=none".) -.TP -\fB\-\-halt\fR=\fI<level>\fR -Set the threshold (<level>) at or above which system -messages are converted to exceptions, halting -execution immediately by exiting (or propagating the -exception if \-\-traceback set). Levels as in \-\-report. -Default is 4 (severe). -.TP -\fB\-\-strict\fR -Same as "\-\-halt=info": halt processing at the -slightest problem. -.TP -\fB\-\-exit\-status\fR=\fI<level>\fR -Enable a non-zero exit status for normal exit if -non-halting system messages (at or above <level>) were -generated. Levels as in \-\-report. Default is 5 -(disabled). Exit status is the maximum system message -level plus 10 (11 for INFO, etc.). -.TP -\fB\-\-debug\fR -Report debug-level system messages and generate -diagnostic output. -.TP -\fB\-\-no\-debug\fR -Do not report debug-level system messages or generate -diagnostic output. -.TP -\fB\-\-warnings\fR=\fI<file>\fR -Send the output of system messages (warnings) to -<file>. -.TP -\fB\-\-traceback\fR -Enable Python tracebacks when halt-level system -messages and other exceptions occur. Useful for -debugging, and essential for issue reports. -.TP -\fB\-\-no\-traceback\fR -Disable Python tracebacks when errors occur; report -just the error instead. This is the default. -.TP -\fB\-\-input\-encoding\fR=\fI<name[:handler]>\fR, \fB\-i\fR \fI<name[:handler]>\fR -Specify the encoding of input text. Default is -locale-dependent. Optionally also specify the error -handler for undecodable characters, after a colon -(":"); default is "strict". -(See "\-\-input-encoding-error-handler".) -.TP -\fB\-\-input\-encoding\-error\-handler\fR=\fIINPUT_ENCODING_ERROR_HANDLER\fR -Specify the error handler for undecodable characters -in the input. Acceptable values include "strict", -"ignore", and "replace". Default is "strict". -Usually specified as part of \-\-input-encoding. -.TP -\fB\-\-output\-encoding\fR=\fI<name[:handler]>\fR, \fB\-o\fR \fI<name[:handler]>\fR -Specify the text encoding for output. Default is -UTF-8. Optionally also specify the error handler for -unencodable characters, after a colon (":"); default -is "strict". (See "\-\-output-encoding-error-handler".) -.TP -\fB\-\-output\-encoding\-error\-handler\fR=\fIOUTPUT_ENCODING_ERROR_HANDLER\fR -Specify the error handler for unencodable characters -in the output. Acceptable values include "strict", -"ignore", "replace", "xmlcharrefreplace", and -"backslashreplace" (in Python 2.3+). Default is -"strict". Usually specified as part of -\-\-output-encoding. -.TP -\fB\-\-error\-encoding\fR=\fI<name[:handler]>\fR, \fB\-e\fR \fI<name[:handler]>\fR -Specify the text encoding for error output. Default -is ASCII. Optionally also specify the error handler -for unencodable characters, after a colon (":"); -default is "backslashreplace". -(See "\-\-output-encoding-error-handler".) -.TP -\fB\-\-error\-encoding\-error\-handler\fR=\fIERROR_ENCODING_ERROR_HANDLER\fR -Specify the error handler for unencodable characters -in error output. See \-\-output-encoding-error-handler -for acceptable values. Default is "backslashreplace". -Usually specified as part of \-\-error-encoding. -.TP -\fB\-\-language\fR=\fI<name>\fR, \fB\-l\fR \fI<name>\fR -Specify the language of input text (ISO 639 2-letter -identifier). Default is "en" (English). -.TP -\fB\-\-record\-dependencies\fR=\fI<file>\fR -Write dependencies (caused e.g. by file inclusions) to -<file>. Useful in conjunction with programs like -"make". -.TP -\fB\-\-config\fR=\fI<file>\fR -Read configuration settings from <file>, if it exists. -.TP -\fB\-\-version\fR, \fB\-V\fR -Show this program's version number and exit. -.TP -\fB\-\-help\fR, \fB\-h\fR -Show this help message and exit. - -.SS -\fBreStructuredText Parser Options\fR -.TP -\fB\-\-pep\-references\fR -Recognize and link to standalone PEP references (like -"PEP 258"). -.TP -\fB\-\-pep\-base\-url\fR=\fI<URL>\fR -Base URL for PEP references (default -"http://www.python.org/peps/"). -.TP -\fB\-\-rfc\-references\fR -Recognize and link to standalone RFC references (like -"RFC 822"). -.TP -\fB\-\-rfc\-base\-url\fR=\fI<URL>\fR -Base URL for RFC references (default -"http://www.faqs.org/rfcs/"). -.TP -\fB\-\-tab\-width\fR=\fI<width>\fR -Set number of spaces for tab expansion (default 8). -.TP -\fB\-\-trim\-footnote\-reference\-space\fR -Remove spaces before footnote references. -.TP -\fB\-\-leave\-footnote\-reference\-space\fR -Leave spaces before footnote references. -.TP -\fB\-\-no\-file\-insertion\fR -Disable directives that insert the contents of -external file ("include" & "raw"); replaced with a -"warning" system message. -.TP -\fB\-\-file\-insertion\-enabled\fR -Enable directives that insert the contents of external -file ("include" & "raw"). Enabled by default. -.TP -\fB\-\-no\-raw\fR -Disable the "raw" directives; replaced with a -"warning" system message. -.TP -\fB\-\-raw\-enabled\fR -Enable the "raw" directive. Enabled by default. - -.SS -\fBStandalone Reader\fR -.TP -\fB\-\-no\-doc\-title\fR -Disable the promotion of a lone top-level section -title to document title (and subsequent section title -to document subtitle promotion; enabled by default). -.TP -\fB\-\-no\-doc\-info\fR -Disable the bibliographic field list transform -(enabled by default). -.TP -\fB\-\-section\-subtitles\fR -Activate the promotion of lone subsection titles to -section subtitles (disabled by default). -.TP -\fB\-\-no\-section\-subtitles\fR -Deactivate the promotion of lone subsection titles. - -.SS -\fBODF-Specific Options\fR -.TP -\fB\-\-stylesheet\fR=\fI<URL>\fR -Specify a styleshe... [truncated message content] |
From: <gr...@us...> - 2017-08-08 09:41:29
|
Revision: 8159 http://sourceforge.net/p/docutils/code/8159 Author: grubert Date: 2017-08-08 09:41:26 +0000 (Tue, 08 Aug 2017) Log Message: ----------- change version to 0.15b.dev Modified Paths: -------------- trunk/docutils/docs/dev/release.txt trunk/docutils/docutils/__init__.py trunk/docutils/setup.py trunk/docutils/test/functional/expected/compact_lists.html trunk/docutils/test/functional/expected/dangerous.html trunk/docutils/test/functional/expected/field_name_limit.html trunk/docutils/test/functional/expected/footnotes_html5.html trunk/docutils/test/functional/expected/math_output_html.html trunk/docutils/test/functional/expected/math_output_latex.html trunk/docutils/test/functional/expected/math_output_mathjax.html trunk/docutils/test/functional/expected/math_output_mathml.xhtml trunk/docutils/test/functional/expected/misc_rst_html4css1.html trunk/docutils/test/functional/expected/pep_html.html trunk/docutils/test/functional/expected/standalone_rst_docutils_xml.xml trunk/docutils/test/functional/expected/standalone_rst_html4css1.html trunk/docutils/test/functional/expected/standalone_rst_html5.html trunk/docutils/test/functional/expected/standalone_rst_s5_html_1.html trunk/docutils/test/functional/expected/standalone_rst_s5_html_2.html trunk/sandbox/infrastructure/releasing-log.txt Modified: trunk/docutils/docs/dev/release.txt =================================================================== --- trunk/docutils/docs/dev/release.txt 2017-08-03 10:54:44 UTC (rev 8158) +++ trunk/docutils/docs/dev/release.txt 2017-08-08 09:41:26 UTC (rev 8159) @@ -53,7 +53,7 @@ | prerelease 0.14rc1, | [prereleases 0.14rc2, ...] | release 0.14, -| repo/snapshots 0.15.dev +| repo/snapshots 0.15b.dev # immediate after releasing 0.14, no alpha. | [bugfix relases 0.14.1, ...] # branches off of the 0.14 release. The repository version number is always equal to the last released Modified: trunk/docutils/docutils/__init__.py =================================================================== --- trunk/docutils/docutils/__init__.py 2017-08-03 10:54:44 UTC (rev 8158) +++ trunk/docutils/docutils/__init__.py 2017-08-08 09:41:26 UTC (rev 8159) @@ -55,7 +55,7 @@ __docformat__ = 'reStructuredText' -__version__ = '0.15.dev' +__version__ = '0.15b.dev' """Docutils version identifier (complies with PEP 440):: major.minor[.micro][releaselevel[serial]][.dev] @@ -75,8 +75,8 @@ """ # workaround for Python < 2.6: -__version_info__ = (0, 15, 0, 'final', 0, False) -# NOTE: (0, 15, 0, 'final', 0, False) means 0.15.dev +__version_info__ = (0, 15, 0, 'beta', 0, False) +# NOTE: (0, 15, 0, 'beta', 0, False) means 0.15b.dev # To add in Docutils 0.15, replacing the line above: """ from collections import namedtuple Modified: trunk/docutils/setup.py =================================================================== --- trunk/docutils/setup.py 2017-08-03 10:54:44 UTC (rev 8158) +++ trunk/docutils/setup.py 2017-08-08 09:41:26 UTC (rev 8159) @@ -115,7 +115,7 @@ input Docutils supports reStructuredText, an easy-to-read, what-you-see-is-what-you-get plaintext markup syntax.""", # wrap at col 60 'url': 'http://docutils.sourceforge.net/', - 'version': '0.15.dev', + 'version': '0.15b.dev', 'author': 'David Goodger', 'author_email': 'go...@py...', 'maintainer': 'docutils-develop list', Modified: trunk/docutils/test/functional/expected/compact_lists.html =================================================================== --- trunk/docutils/test/functional/expected/compact_lists.html 2017-08-03 10:54:44 UTC (rev 8158) +++ trunk/docutils/test/functional/expected/compact_lists.html 2017-08-08 09:41:26 UTC (rev 8159) @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> -<meta name="generator" content="Docutils 0.15.dev: http://docutils.sourceforge.net/" /> +<meta name="generator" content="Docutils 0.15b.dev: http://docutils.sourceforge.net/" /> <title>compact_lists.txt</title> <link rel="stylesheet" href="../input/data/html4css1.css" type="text/css" /> </head> Modified: trunk/docutils/test/functional/expected/dangerous.html =================================================================== --- trunk/docutils/test/functional/expected/dangerous.html 2017-08-03 10:54:44 UTC (rev 8158) +++ trunk/docutils/test/functional/expected/dangerous.html 2017-08-08 09:41:26 UTC (rev 8159) @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> -<meta name="generator" content="Docutils 0.15.dev: http://docutils.sourceforge.net/" /> +<meta name="generator" content="Docutils 0.15b.dev: http://docutils.sourceforge.net/" /> <title>dangerous.txt</title> <link rel="stylesheet" href="../input/data/html4css1.css" type="text/css" /> </head> Modified: trunk/docutils/test/functional/expected/field_name_limit.html =================================================================== --- trunk/docutils/test/functional/expected/field_name_limit.html 2017-08-03 10:54:44 UTC (rev 8158) +++ trunk/docutils/test/functional/expected/field_name_limit.html 2017-08-08 09:41:26 UTC (rev 8159) @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> -<meta name="generator" content="Docutils 0.15.dev: http://docutils.sourceforge.net/" /> +<meta name="generator" content="Docutils 0.15b.dev: http://docutils.sourceforge.net/" /> <title>field_list.txt</title> <link rel="stylesheet" href="../input/data/html4css1.css" type="text/css" /> </head> Modified: trunk/docutils/test/functional/expected/footnotes_html5.html =================================================================== --- trunk/docutils/test/functional/expected/footnotes_html5.html 2017-08-03 10:54:44 UTC (rev 8158) +++ trunk/docutils/test/functional/expected/footnotes_html5.html 2017-08-08 09:41:26 UTC (rev 8159) @@ -2,7 +2,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta charset="utf-8"/> -<meta name="generator" content="Docutils 0.15.dev: http://docutils.sourceforge.net/" /> +<meta name="generator" content="Docutils 0.15b.dev: http://docutils.sourceforge.net/" /> <title>Test footnote and citation rendering</title> <link rel="stylesheet" href="../input/data/minimal.css" type="text/css" /> <link rel="stylesheet" href="../input/data/plain.css" type="text/css" /> Modified: trunk/docutils/test/functional/expected/math_output_html.html =================================================================== --- trunk/docutils/test/functional/expected/math_output_html.html 2017-08-03 10:54:44 UTC (rev 8158) +++ trunk/docutils/test/functional/expected/math_output_html.html 2017-08-08 09:41:26 UTC (rev 8159) @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> -<meta name="generator" content="Docutils 0.15.dev: http://docutils.sourceforge.net/" /> +<meta name="generator" content="Docutils 0.15b.dev: http://docutils.sourceforge.net/" /> <title>Mathematics</title> <link rel="stylesheet" href="../input/data/html4css1.css" type="text/css" /> <link rel="stylesheet" href="../input/data/math.css" type="text/css" /> Modified: trunk/docutils/test/functional/expected/math_output_latex.html =================================================================== --- trunk/docutils/test/functional/expected/math_output_latex.html 2017-08-03 10:54:44 UTC (rev 8158) +++ trunk/docutils/test/functional/expected/math_output_latex.html 2017-08-08 09:41:26 UTC (rev 8159) @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> -<meta name="generator" content="Docutils 0.15.dev: http://docutils.sourceforge.net/" /> +<meta name="generator" content="Docutils 0.15b.dev: http://docutils.sourceforge.net/" /> <title>Mathematics</title> <link rel="stylesheet" href="../input/data/html4css1.css" type="text/css" /> </head> Modified: trunk/docutils/test/functional/expected/math_output_mathjax.html =================================================================== --- trunk/docutils/test/functional/expected/math_output_mathjax.html 2017-08-03 10:54:44 UTC (rev 8158) +++ trunk/docutils/test/functional/expected/math_output_mathjax.html 2017-08-08 09:41:26 UTC (rev 8159) @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> -<meta name="generator" content="Docutils 0.15.dev: http://docutils.sourceforge.net/" /> +<meta name="generator" content="Docutils 0.15b.dev: http://docutils.sourceforge.net/" /> <title>Mathematics</title> <script type="text/javascript" src="/usr/share/javascript/mathjax/MathJax.js?config=TeX-AMS_CHTML"></script> <link rel="stylesheet" href="../input/data/html4css1.css" type="text/css" /> Modified: trunk/docutils/test/functional/expected/math_output_mathml.xhtml =================================================================== --- trunk/docutils/test/functional/expected/math_output_mathml.xhtml 2017-08-03 10:54:44 UTC (rev 8158) +++ trunk/docutils/test/functional/expected/math_output_mathml.xhtml 2017-08-08 09:41:26 UTC (rev 8159) @@ -2,7 +2,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta charset="utf-8"/> -<meta name="generator" content="Docutils 0.15.dev: http://docutils.sourceforge.net/" /> +<meta name="generator" content="Docutils 0.15b.dev: http://docutils.sourceforge.net/" /> <title>Mathematics</title> <link rel="stylesheet" href="../input/data/minimal.css" type="text/css" /> <link rel="stylesheet" href="../input/data/plain.css" type="text/css" /> Modified: trunk/docutils/test/functional/expected/misc_rst_html4css1.html =================================================================== --- trunk/docutils/test/functional/expected/misc_rst_html4css1.html 2017-08-03 10:54:44 UTC (rev 8158) +++ trunk/docutils/test/functional/expected/misc_rst_html4css1.html 2017-08-08 09:41:26 UTC (rev 8159) @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> -<meta name="generator" content="Docutils 0.15.dev: http://docutils.sourceforge.net/" /> +<meta name="generator" content="Docutils 0.15b.dev: http://docutils.sourceforge.net/" /> <title>link_in_substitution.txt</title> <link rel="stylesheet" href="foo&bar.css" type="text/css" /> </head> Modified: trunk/docutils/test/functional/expected/pep_html.html =================================================================== --- trunk/docutils/test/functional/expected/pep_html.html 2017-08-03 10:54:44 UTC (rev 8158) +++ trunk/docutils/test/functional/expected/pep_html.html 2017-08-08 09:41:26 UTC (rev 8159) @@ -8,7 +8,7 @@ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <meta name="generator" content="Docutils 0.15.dev: http://docutils.sourceforge.net/" /> + <meta name="generator" content="Docutils 0.15b.dev: http://docutils.sourceforge.net/" /> <title>PEP 100 -- Test PEP</title> <link rel="stylesheet" href="../input/data/html4css1.css" type="text/css" /> </head> Modified: trunk/docutils/test/functional/expected/standalone_rst_docutils_xml.xml =================================================================== --- trunk/docutils/test/functional/expected/standalone_rst_docutils_xml.xml 2017-08-03 10:54:44 UTC (rev 8158) +++ trunk/docutils/test/functional/expected/standalone_rst_docutils_xml.xml 2017-08-08 09:41:26 UTC (rev 8159) @@ -1,6 +1,6 @@ <?xml version="1.0" encoding="utf-8"?> <!DOCTYPE document PUBLIC "+//IDN docutils.sourceforge.net//DTD Docutils Generic//EN//XML" "http://docutils.sourceforge.net/docs/ref/docutils.dtd"> -<!-- Generated by Docutils 0.15.dev --> +<!-- Generated by Docutils 0.15b.dev --> <document ids="restructuredtext-test-document doctitle" names="restructuredtext\ test\ document doctitle" source="functional/input/standalone_rst_docutils_xml.txt" title="reStructuredText Test Document"> <title>reStructuredText Test Document</title> <subtitle ids="examples-of-syntax-constructs subtitle" names="examples\ of\ syntax\ constructs subtitle">Examples of Syntax Constructs</subtitle> Modified: trunk/docutils/test/functional/expected/standalone_rst_html4css1.html =================================================================== --- trunk/docutils/test/functional/expected/standalone_rst_html4css1.html 2017-08-03 10:54:44 UTC (rev 8158) +++ trunk/docutils/test/functional/expected/standalone_rst_html4css1.html 2017-08-08 09:41:26 UTC (rev 8159) @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> -<meta name="generator" content="Docutils 0.15.dev: http://docutils.sourceforge.net/" /> +<meta name="generator" content="Docutils 0.15b.dev: http://docutils.sourceforge.net/" /> <title>reStructuredText Test Document</title> <meta name="author" content="David Goodger" /> <meta name="authors" content="Me Myself I" /> Modified: trunk/docutils/test/functional/expected/standalone_rst_html5.html =================================================================== --- trunk/docutils/test/functional/expected/standalone_rst_html5.html 2017-08-03 10:54:44 UTC (rev 8158) +++ trunk/docutils/test/functional/expected/standalone_rst_html5.html 2017-08-08 09:41:26 UTC (rev 8159) @@ -2,7 +2,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta charset="utf-8"/> -<meta name="generator" content="Docutils 0.15.dev: http://docutils.sourceforge.net/" /> +<meta name="generator" content="Docutils 0.15b.dev: http://docutils.sourceforge.net/" /> <title>reStructuredText Test Document</title> <meta name="author" content="David Goodger" /> <meta content="reStructuredText, test, parser" name="keywords" /> Modified: trunk/docutils/test/functional/expected/standalone_rst_s5_html_1.html =================================================================== --- trunk/docutils/test/functional/expected/standalone_rst_s5_html_1.html 2017-08-03 10:54:44 UTC (rev 8158) +++ trunk/docutils/test/functional/expected/standalone_rst_s5_html_1.html 2017-08-08 09:41:26 UTC (rev 8159) @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> -<meta name="generator" content="Docutils 0.15.dev: http://docutils.sourceforge.net/" /> +<meta name="generator" content="Docutils 0.15b.dev: http://docutils.sourceforge.net/" /> <meta name="version" content="S5 1.1" /> <title>Slide Shows</title> <meta name="author" content="David Goodger" /> Modified: trunk/docutils/test/functional/expected/standalone_rst_s5_html_2.html =================================================================== --- trunk/docutils/test/functional/expected/standalone_rst_s5_html_2.html 2017-08-03 10:54:44 UTC (rev 8158) +++ trunk/docutils/test/functional/expected/standalone_rst_s5_html_2.html 2017-08-08 09:41:26 UTC (rev 8159) @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> -<meta name="generator" content="Docutils 0.15.dev: http://docutils.sourceforge.net/" /> +<meta name="generator" content="Docutils 0.15b.dev: http://docutils.sourceforge.net/" /> <meta name="version" content="S5 1.1" /> <title>Slide Shows</title> <meta name="author" content="David Goodger" /> Modified: trunk/sandbox/infrastructure/releasing-log.txt =================================================================== --- trunk/sandbox/infrastructure/releasing-log.txt 2017-08-03 10:54:44 UTC (rev 8158) +++ trunk/sandbox/infrastructure/releasing-log.txt 2017-08-08 09:41:26 UTC (rev 8159) @@ -8,6 +8,12 @@ Notes on what happend while releasing. +Release 0.14 +============ + +svn revision: 8145 - start of release + + Prerelease 0.14a0 ================= This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <mi...@us...> - 2017-08-08 20:26:15
|
Revision: 8160 http://sourceforge.net/p/docutils/code/8160 Author: milde Date: 2017-08-08 20:26:12 +0000 (Tue, 08 Aug 2017) Log Message: ----------- Update documentation of the version identification. Document the consensus reached about version identifier and version info tuple in the discussion on docutils-devel in Mai and June 2017. Modified Paths: -------------- trunk/docutils/README.txt trunk/docutils/docs/dev/release.txt trunk/docutils/docutils/__init__.py trunk/web/index.txt Modified: trunk/docutils/README.txt =================================================================== --- trunk/docutils/README.txt 2017-08-08 09:41:26 UTC (rev 8159) +++ trunk/docutils/README.txt 2017-08-08 20:26:12 UTC (rev 8160) @@ -1,6 +1,6 @@ -======================= - README: Docutils 0.14 -======================= +============================ + README: Docutils 0.15b.dev +============================ :Author: David Goodger :Contact: go...@py... Modified: trunk/docutils/docs/dev/release.txt =================================================================== --- trunk/docutils/docs/dev/release.txt 2017-08-08 09:41:26 UTC (rev 8159) +++ trunk/docutils/docs/dev/release.txt 2017-08-08 20:26:12 UTC (rev 8160) @@ -39,32 +39,86 @@ Releasing --------- -Version numbers -~~~~~~~~~~~~~~~ +Version identifier +~~~~~~~~~~~~~~~~~~ -Version numbers shall follow the `Docutils Project Policies`_ and comply -with `PEP 440`_. +The version identifier ``docutils.__version__`` is a concise, +`PEP 440`_-conforming representation of the namedtuple +``docutils.__version_info__``. -Especially, mark pre-releases and the repository version/snapshots as -"between" releases (cf. `Feature Request #50`_ and the discussion on -docutils-devel on May 28 2017), e.g. +* The `release segment` (``<major>.<minor>[.<micro>]``) + is set according to the `Docutils Project Policies`_. -| prev. release 0.13.1, -| prerelease 0.14rc1, -| [prereleases 0.14rc2, ...] -| release 0.14, -| repo/snapshots 0.15b.dev # immediate after releasing 0.14, no alpha. -| [bugfix relases 0.14.1, ...] # branches off of the 0.14 release. +* The `pre-release segment` (``[{a|b|rc}N]``) corresponds to the + `development status`_ of the repository or release. + It matches ``__version_info__.releaselevel``: -The repository version number is always equal to the last released -version + 1, with a .dev suffix: ``<major>.<minor+1>.dev``. -(Exception: during "feature freeze" between pre-release and release it may -point to the next pre-release.) + ======= ============ ========================================== + .. releaselevel comment + ======= ============ ========================================== + ``a`` alpha only after major experimental changes + ``b`` beta default state of the repository + ``rcN`` candidate ready to release unless significant bugs + emerge (N is ``__version_info__.serial``) + .. final no pre-release segment + ======= ============ ========================================== +* The `development release segment` (``.dev``) is omitted for official + releases and pre-releases, i.e. if ``__version_info__.release`` is True. + +See also `Feature Request #50`_ and the `discussion on +docutils-devel`__ from May 28 to June 20 2017. + +Examples: + + ============ ============== ============= + releaselevel repository release + ============ ============== ============= + final … 0.14 + beta 0.15b.dev 0.15b¹ + candidate 0.15rc1.dev 0.15rc1 + candidate 0.15rc2.dev¹ 0.15rc2¹ + final 0.15.dev 0.15 + beta 0.16b.dev … + ============ ============== ============= + + ¹may be skipped + + .. _Docutils Project Policies: policies.html#version-numbers -.. _Feature Request #50: https://sourceforge.net/p/docutils/feature-requests/50/ +.. _Feature Request #50: + https://sourceforge.net/p/docutils/feature-requests/50/ .. _PEP 440: https://www.python.org/dev/peps/pep-0440/ +.. _development status: + https://en.wikipedia.org/wiki/Software_release_life_cycle +__ https://sourceforge.net/p/docutils/mailman/message/35903816/ +How to change the version identifier +"""""""""""""""""""""""""""""""""""" + +The `version identifier` ``docutils.__version__`` is defined in +``docutils/docutils/__init__.py`` and used in in the following files:: + + docutils/setup.py + docutils/test/functional/expected/* ("Generator: Docutils X.Y[.Z]") + docutils/README.txt + web/index.txt + +You can use the script ``set_release.sh``: + +#. ``cd`` to the "docutils" subdirectory in the repository checkout, + + +#. call :: + + ../sandbox/infrastructure/set_release.sh <new_version> + + where ``<new_version>`` is major.minor[.micro][<pre>][.dev]. + +Finally change ``__version_info__`` in ``docutils/docutils/__init__.py`` +"by hand" to ensure it matches the `version identifier`_. + + Release steps ~~~~~~~~~~~~~ @@ -84,62 +138,52 @@ .. _ReleaseForge: http://releaseforge.sourceforge.net/ -* **On the Docutils-develop mailing list, announce that the release is - going to be made, update the release notes and ask for additions.** +* **Announce** - **Announce the date of the feature freeze, at least a week away.** + On the Docutils-develop mailing list, announce that the release is + going to be made, update the release notes (consult HISTORY.TXT for + changes) and ask for additions. - Consult HISTORY.TXT for changes. + Announce the upcoming release at the Sphinx-devel mailing list + and ask for testing with Sphinx. + (This step can be skipped for bugfix releases and pre-releases.) -* **Announce a check-in freeze on Docutils-develop.** + Announce the date of the feature freeze – at least a week ahead! -* **Announce the upcoming release at the Sphinx-devel mailing list - and ask for testing with Sphinx.** - (This step can be skipped for bugfix releases.) +* **Feature freeze** From now on, only bug-fix commits are allowed. -* update `version numbers`_: + Update the `pre-release segment` of the `version identifier`_ + (``b``, ``rcN`` or empty) to match the level of the upcoming release + (beta, candidate or final). Ensure ``docutils.__version_info__`` matches + the version identifier. (See also `How to change the version + identifier`_.) - We want pre-release tags ``rcN`` for pre-releases, development release tag - ``.dev`` for snapshots and installs from the repository. +* **Announce** the check-in freeze date on Docutils-develop – at least a + week ahead. - For a prerelease +* **Check-in freeze** - 0. before release ``<next-release-number>.dev`` - 1. set this to ``<next-release-number>.rc1`` - 2. release - 3. increase prerelease number in the repository + **Update the version identifier**: + Remove the `development release segment` (``.dev``) from the `version + identifier`_ and set ``docutils.__version_info__.release`` to True. - For a release + Check the `version identifier` in the following files (should be + already correct if set according to `How to change the version + identifier`_): - 0. before release ``<next-release-number>.dev`` or - ``<next-release-number>.rc<N>`` - 1. set this to ``<next-release-number>`` without prerelease character. - 2. release - 3. set to ``<major>.<minor+1>.dev`` in the repository (trunk). + + docutils/setup.py + + docutils/docutils/__init__.py + + docutils/test/functional/expected/* ("Generator: Docutils X.Y[.Z]") + + docutils/README.txt + + web/index.txt - see what ``sandbox/infrastructure/release.sh`` can aid +* See what ``sandbox/infrastructure/release.sh`` can aid - Call ``sandbox/infrastructure/set_release.sh new_version``. - For details see the script. - - ``new_version`` is major.minor[.micro][<pre>][.dev] - .. Note:: *BUG* test tarball requires root password, but it is possible to skip this stage interactively, and testing should be done before release. -* Change ``__version_details__`` in docutils/docutils/__init__.py to - "release" (from "repository"). -* Check the _`version number` in the following files, should be already - correct: - - + docutils/setup.py - + docutils/docutils/__init__.py - + docutils/test/functional/expected/* ("Generator: Docutils X.Y[.Z]") - + docutils/README.txt - + web/index.txt - * Close the "Changes Since ..." section in docutils/HISTORY.txt. * Clear/unset the PYTHONPATH environment variable. @@ -241,12 +285,15 @@ twine upload docultils-<VERSION>-py2-none-any.whl twine upload wheelhouse/docultils-<VERSION>-py3-none-any.whl -* Restore ``__version_info`` in docutils/docutils/__init__.py to - "repository" (from "release"). +* **Lift the freeze** -* Bump the `version number`_ again. + Set the `version identifier`_ and ``__version_info__.releaselevel`` in + docutils/docutils/__init__.py to mark the repository version as + "in development", usually ``<major>.<minor+1>b.dev`` (cf. `How to change + the version identifier`_). -* Add a new empty section "Changes Since ..." in HISTORY.txt. +* After a final release, add a new empty section "Changes Since ..." in + HISTORY.txt. * Update the web page (web/index.txt). @@ -253,6 +300,7 @@ * Run docutils-update on the server. * **Run alltests.py with svn version** + * **Send announcement email to:** * doc...@li... (also announcing the end of @@ -261,12 +309,16 @@ * do...@py... * pyt...@py... -* **Add a `SourceForge News item`__, with title "Docutils X.Y.Z released"** +* **Add a** `SourceForge News item`__, **with title "Docutils X.Y.Z released"** __ https://sourceforge.net/p/docutils/news **Mark as default download for all platforms.** +.. _wheels: https://packaging.python.org/en/latest/distributing.html#wheels +.. _pure Python wheels: + https://packaging.python.org/en/latest/distributing.html#pure-python-wheels + .. Local Variables: Modified: trunk/docutils/docutils/__init__.py =================================================================== --- trunk/docutils/docutils/__init__.py 2017-08-08 09:41:26 UTC (rev 8159) +++ trunk/docutils/docutils/__init__.py 2017-08-08 20:26:12 UTC (rev 8160) @@ -86,8 +86,9 @@ major=0, minor=15, micro=0, - releaselevel='alpha', # development status: + releaselevel='alpha', # `development status`__: # one of 'alpha', 'beta', 'candidate', 'final' + # __ https://en.wikipedia.org/wiki/Software_release_life_cycle serial=0, # pre-release number (0 for final releases) release=False # True for official releases and pre-releases ) Modified: trunk/web/index.txt =================================================================== --- trunk/web/index.txt 2017-08-08 09:41:26 UTC (rev 8159) +++ trunk/web/index.txt 2017-08-08 20:26:12 UTC (rev 8160) @@ -82,12 +82,11 @@ The latest **release package** is `docutils-0.14.tar.gz`__. It was released on 2017-08-03 and is mostly intended for distributors. See -the `release notes`_ for a list of changes since the previous release -(0.12). +the `release notes`_ for a list of changes since the previous release. __ https://sourceforge.net/projects/docutils/files/docutils/0.14/docutils-0.14.tar.gz/download -.. _release notes: RELEASE-NOTES.html#id38 +.. _release notes: RELEASE-NOTES.html The Sandbox_ contains experimental, contributed code. You can download a complete `snapshot of the Sandbox`_ or `browse the Sandbox`_ to download a This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <mi...@us...> - 2017-09-08 16:09:16
|
Revision: 8177 http://sourceforge.net/p/docutils/code/8177 Author: milde Date: 2017-09-08 16:09:13 +0000 (Fri, 08 Sep 2017) Log Message: ----------- Automatically update version_info when changing __version__ per script. Modified Paths: -------------- trunk/docutils/docs/dev/release.txt trunk/sandbox/infrastructure/set_version.sh Added Paths: ----------- trunk/sandbox/infrastructure/version_identifier_parsing.py Modified: trunk/docutils/docs/dev/release.txt =================================================================== --- trunk/docutils/docs/dev/release.txt 2017-09-07 20:00:57 UTC (rev 8176) +++ trunk/docutils/docs/dev/release.txt 2017-09-08 16:09:13 UTC (rev 8177) @@ -69,8 +69,8 @@ where ``<new_version>`` is major.minor[.micro][<pre>][.dev]. -Finally change ``__version_info__`` in ``docutils/docutils/__init__.py`` -**by hand** to ensure it matches the `version identifier`_. + This also changes ``__version_info__`` in + ``docutils/docutils/__init__.py``. Run the test suite after changing the codebase version to ensure accuracy and consistency. Modified: trunk/sandbox/infrastructure/set_version.sh =================================================================== --- trunk/sandbox/infrastructure/set_version.sh 2017-09-07 20:00:57 UTC (rev 8176) +++ trunk/sandbox/infrastructure/set_version.sh 2017-09-08 16:09:13 UTC (rev 8177) @@ -42,9 +42,10 @@ echo Determining list of files to be changed... # BUG ls lists directories but does not descend # (try ls --recursive) - files="docutils/__init__.py setup.py `$svn ls test/functional/expected/ | sed 's|^|test/functional/expected/|'`" - echo "Now I'll change the version number to ${new_ver} in the following files:" + files="docutils/__init__.py setup.py README.txt `$svn ls test/functional/expected/ | sed 's|^|test/functional/expected/|'`" + echo "Now I'll change the version identifier to ${new_ver} in the following files:" echo $files + echo 'and update the version_info in docutils/__init__.py.' echo echo 'Press enter to proceed (or enter anything to skip)...' read @@ -58,8 +59,9 @@ (echo ",s/$old_ver_regex/${new_ver}/g"; echo 'wq') | ed "$F" done set -e + echo 'Modifying docutils/__init__.py with version_identifier_parsing.py' + python ../sandbox/infrastructure/version_identifier_parsing.py --change-version-info=docutils/__init__.py fi - echo echo 'CAUTION: please look at the diffs carefully, for wrongly' echo ' replaced embedded numbers.' # checkin "set version number to $2" $files @@ -66,5 +68,6 @@ } set_ver "$old_ver" "$new_ver" -echo "VERIFY: major, minor, micro, releaselevel (candidate,rinal), prerelease number, pre/release or checkout" -python -c 'import docutils; print "__version_info__ =", docutils.__version_info__' + +#echo "VERIFY: major, minor, micro, releaselevel (candidate,final), prerelease serial, pre/release or checkout" +#python -c 'import docutils; print "__version_info__ =", docutils.__version_info__' Added: trunk/sandbox/infrastructure/version_identifier_parsing.py =================================================================== --- trunk/sandbox/infrastructure/version_identifier_parsing.py (rev 0) +++ trunk/sandbox/infrastructure/version_identifier_parsing.py 2017-09-08 16:09:13 UTC (rev 8177) @@ -0,0 +1,228 @@ +#!/usr/bin/env python +# version_identifier_parsing.py: parse and sort Docutils version indentifiers +# =========================================================================== + +# Parse a Docutils version identifier +# (adapted from the `PEP 440 example regexp`__) +# +# __https://www.python.org/dev/peps/pep-0440/#appendix-b-parsing-version-strings-with-regular-expressions + + +import re, argparse + +from docutils import VersionInfo, __version__, __version_info__ + + +_version_regexp = re.compile(r""" + (?P<release> + (?P<major>[0-9]+) + \.(?P<minor>[0-9]+) + (\.(?P<micro>[0-9]+))? + ) + (?P<pre> # pre-release segment + (?P<pre_l>(a|b|rc)) + (?P<pre_n>[0-9]+)? + )? + (\.(?P<dev>dev))? # dev segment + $ + """, re.VERBOSE) + +def parse_version_identifier(identifier): + """Parse a Docutils version identifier according to PEP 440.""" + return _version_regexp.match(identifier).groupdict() + + +releaselevels = {'a': 'alpha', + 'b': 'beta', + 'rc': 'candidate', + '': 'final', + } + + +def identifier2version_info(identifier): + """Convert Docutils version identifier to a `version_info` namedtuple. + """ + try: + segments = _version_regexp.match(identifier).groupdict() + except AttributeError: + raise ValueError('non-supported version identifier "%s"' % identifier) + + if segments['pre']: + releaselevel = releaselevels[segments['pre_l']] + else: + # .dev without pre-release segment sorts before pre-releases, see + # https://www.python.org/dev/peps/pep-0440/#summary-of-permitted-suffixes-and-relative-ordering + if segments['dev']: + releaselevel = None + else: + releaselevel = 'final' + + return VersionInfo( + major=int(segments['major']), + minor=int(segments['minor']), + micro=int(segments['micro']) if segments['micro'] else 0, + releaselevel=releaselevel, + serial=segments['pre_n'] and int(segments['pre_n']) or 0, + release=not segments['dev']) + + +def version_info2identifier(version_info): + """Return version identifier matching the given `docutils.version_info`.""" + release_level_abbreviations = dict((level, abbr) + for abbr, level in releaselevels.items()) + identifier = '%s.%s%s' % (version_info.major, version_info.minor, + '.%s' % version_info.micro if version_info.micro else '') + try: + identifier += release_level_abbreviations[version_info.releaselevel] + except KeyError: + if version_info.releaselevel is not None or version_info.release: + raise ValueError('releaselevel "%s" not supported. ' + 'Must be one of %s' + % (version_info.releaselevel, + ', '.join(releaselevels.values()))) + if version_info.releaselevel and version_info.serial: + identifier += str(version_info.serial) + if not version_info.release: + identifier += '.dev' + return identifier + +version_info_def_template = """\ +__version_info__ = VersionInfo( + major=%d, + minor=%d, + micro=%d, + releaselevel='%s', # one of 'alpha', 'beta', 'candidate', 'final' + # pre-release serial number (0 for final releases and active development): + serial=%d, + release=%s # True for official releases and pre-releases + ) +""" + +version_info_def_pattern = version_info_def_template.replace('%d', '[0-9]+') +version_info_def_pattern = version_info_def_pattern.replace('%s', '.*') +version_info_def_pattern = version_info_def_pattern.replace('(', r'\(') +version_info_def_pattern = version_info_def_pattern.replace(')', r'\)') + +def version_info_definition(version_identifier): + """Return __version_info__ definition code matching `version_identifier`. + """ + versioninfo = identifier2version_info(version_identifier) + return version_info_def_template % versioninfo + + +def change_version_info_definition(version, source): + """Replace the __version_info__ definition in file "source" with + a version matching the version identifer `version`.""" + version_info_def = version_info_definition(version) + sourcefile = open(source) + old = sourcefile.read() + sourcefile.close() + new = re.sub(version_info_def_pattern, version_info_def, old) + if old == new: + return "nothing to change (or parsing error)" + sourcefile = open(source, 'w') + sourcefile.write(new) + sourcefile.close() + return "changed %s" % source + + +# ----------------------------------------------------------------------- + +def test_parse(identifier): + + segments = parse_version_identifier(identifier) + print identifier + print 'release:', segments['release'] + print ' major:', segments['major'] + print ' minor:', segments['minor'] + print ' micro:', segments['micro'] + print ' pre:', segments['pre'] + print ' pre_l:', segments['pre_l'] + print ' pre_n:', segments['pre_n'] + print ' dev:', segments['dev'] + print + +def selftest(version=__version__): + """Run a test on version identification parsing and transforming.""" + + # example: series of release identifiers in version-order. + identifiers = ['0.13.1', + '0.14.dev', + '0.14a.dev', + '0.14b.dev', + '0.14b', + '0.14rc1', + '0.14rc2.dev', + '0.14rc2', + '0.14', + '0.14.1rc1.dev', + '0.14.1rc1', + '0.14.1.dev', + '0.14.1', + ] + + for identifier in identifiers: + test_parse(identifier) + + version_infos = [identifier2version_info(identifier) + for identifier in identifiers] + + for vi in version_infos: + print vi + print + + # test sort order: + + sorted_version_infos = sorted(version_infos) + + if sorted_version_infos == version_infos: + print "Version order preserved by sorting." + else: + print "Version order changed by sorting." + for vi in sorted_version_infos: + print vi + print + + # (re)convert version_info to PEP 440 version identifier: + + ids = [version_info2identifier(vi) for vi in version_infos] + + if ids == identifiers: + print "Round trip conversion OK." + else: + print ids + + + print version_info_definition(version) + + +if __name__ == '__main__': + parser = argparse.ArgumentParser() + + parser.add_argument('-i', '--version-info', + help='print version-info definition', + action='store_true') + parser.add_argument('--change-version-info', + dest='source', metavar='SOURCE', + help='change version-info def in file "source"') + parser.add_argument('-v', '--version', + help='version identifier ' + '(default docutils.__version__)') + parser.add_argument('-t', '--test', + help='test version indentification conversion', + action='store_true') + parser.add_argument('--debug', + help='print result of version identifier parsing', + action='store_true') + args = parser.parse_args() + + version_identifier = args.version or __version__ + if args.test: + selftest(version_identifier) + elif args.debug: + from pprint import pprint + pprint(_version_regexp.match(version_identifier).groupdict()) + elif args.version_info: + print version_info_definition(version_identifier) + elif args.source: + print change_version_info_definition(version_identifier, args.source) Property changes on: trunk/sandbox/infrastructure/version_identifier_parsing.py ___________________________________________________________________ Added: svn:eol-style ## -0,0 +1 ## +native \ No newline at end of property Added: svn:executable ## -0,0 +1 ## +* \ No newline at end of property Added: svn:keywords ## -0,0 +1 ## +Author Date Id Revision \ No newline at end of property This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <gr...@us...> - 2019-07-20 14:03:06
|
Revision: 8263 http://sourceforge.net/p/docutils/code/8263 Author: grubert Date: 2019-07-20 14:03:04 +0000 (Sat, 20 Jul 2019) Log Message: ----------- set version 0.15rc1.dev Modified Paths: -------------- trunk/docutils/README.txt trunk/docutils/docutils/__init__.py trunk/docutils/setup.py trunk/docutils/test/functional/expected/compact_lists.html trunk/docutils/test/functional/expected/dangerous.html trunk/docutils/test/functional/expected/field_name_limit.html trunk/docutils/test/functional/expected/footnotes_html5.html trunk/docutils/test/functional/expected/math_output_html.html trunk/docutils/test/functional/expected/math_output_latex.html trunk/docutils/test/functional/expected/math_output_mathjax.html trunk/docutils/test/functional/expected/math_output_mathml.xhtml trunk/docutils/test/functional/expected/misc_rst_html4css1.html trunk/docutils/test/functional/expected/pep_html.html trunk/docutils/test/functional/expected/standalone_rst_docutils_xml.xml trunk/docutils/test/functional/expected/standalone_rst_html4css1.html trunk/docutils/test/functional/expected/standalone_rst_html5.html trunk/docutils/test/functional/expected/standalone_rst_s5_html_1.html trunk/docutils/test/functional/expected/standalone_rst_s5_html_2.html trunk/sandbox/infrastructure/releasing-log.txt Modified: trunk/docutils/README.txt =================================================================== --- trunk/docutils/README.txt 2019-07-18 16:20:00 UTC (rev 8262) +++ trunk/docutils/README.txt 2019-07-20 14:03:04 UTC (rev 8263) @@ -1,6 +1,6 @@ -============================ - README: Docutils 0.15b.dev -============================ +============================== + README: Docutils 0.15rc1.dev +============================== :Author: David Goodger :Contact: go...@py... Modified: trunk/docutils/docutils/__init__.py =================================================================== --- trunk/docutils/docutils/__init__.py 2019-07-18 16:20:00 UTC (rev 8262) +++ trunk/docutils/docutils/__init__.py 2019-07-20 14:03:04 UTC (rev 8263) @@ -56,7 +56,7 @@ __docformat__ = 'reStructuredText' -__version__ = '0.15b.dev' +__version__ = '0.15rc1.dev' """Docutils version identifier (complies with PEP 440):: major.minor[.micro][releaselevel[serial]][.dev] @@ -74,9 +74,9 @@ major=0, minor=15, micro=0, - releaselevel='beta', # one of 'alpha', 'beta', 'candidate', 'final' + releaselevel='candidate', # one of 'alpha', 'beta', 'candidate', 'final' # pre-release serial number (0 for final releases and active development): - serial=0, + serial=1, release=False # True for official releases and pre-releases ) """Comprehensive version information tuple. See 'Version Numbering' in Modified: trunk/docutils/setup.py =================================================================== --- trunk/docutils/setup.py 2019-07-18 16:20:00 UTC (rev 8262) +++ trunk/docutils/setup.py 2019-07-20 14:03:04 UTC (rev 8263) @@ -115,7 +115,7 @@ input Docutils supports reStructuredText, an easy-to-read, what-you-see-is-what-you-get plaintext markup syntax.""", # wrap at col 60 'url': 'http://docutils.sourceforge.net/', - 'version': '0.15b.dev', + 'version': '0.15rc1.dev', 'author': 'David Goodger', 'author_email': 'go...@py...', 'maintainer': 'docutils-develop list', Modified: trunk/docutils/test/functional/expected/compact_lists.html =================================================================== --- trunk/docutils/test/functional/expected/compact_lists.html 2019-07-18 16:20:00 UTC (rev 8262) +++ trunk/docutils/test/functional/expected/compact_lists.html 2019-07-20 14:03:04 UTC (rev 8263) @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> -<meta name="generator" content="Docutils 0.15b.dev: http://docutils.sourceforge.net/" /> +<meta name="generator" content="Docutils 0.15rc1.dev: http://docutils.sourceforge.net/" /> <title>compact_lists.txt</title> <link rel="stylesheet" href="../input/data/html4css1.css" type="text/css" /> </head> Modified: trunk/docutils/test/functional/expected/dangerous.html =================================================================== --- trunk/docutils/test/functional/expected/dangerous.html 2019-07-18 16:20:00 UTC (rev 8262) +++ trunk/docutils/test/functional/expected/dangerous.html 2019-07-20 14:03:04 UTC (rev 8263) @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> -<meta name="generator" content="Docutils 0.15b.dev: http://docutils.sourceforge.net/" /> +<meta name="generator" content="Docutils 0.15rc1.dev: http://docutils.sourceforge.net/" /> <title>dangerous.txt</title> <link rel="stylesheet" href="../input/data/html4css1.css" type="text/css" /> </head> Modified: trunk/docutils/test/functional/expected/field_name_limit.html =================================================================== --- trunk/docutils/test/functional/expected/field_name_limit.html 2019-07-18 16:20:00 UTC (rev 8262) +++ trunk/docutils/test/functional/expected/field_name_limit.html 2019-07-20 14:03:04 UTC (rev 8263) @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> -<meta name="generator" content="Docutils 0.15b.dev: http://docutils.sourceforge.net/" /> +<meta name="generator" content="Docutils 0.15rc1.dev: http://docutils.sourceforge.net/" /> <title>field_list.txt</title> <link rel="stylesheet" href="../input/data/html4css1.css" type="text/css" /> </head> Modified: trunk/docutils/test/functional/expected/footnotes_html5.html =================================================================== --- trunk/docutils/test/functional/expected/footnotes_html5.html 2019-07-18 16:20:00 UTC (rev 8262) +++ trunk/docutils/test/functional/expected/footnotes_html5.html 2019-07-20 14:03:04 UTC (rev 8263) @@ -2,7 +2,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta charset="utf-8"/> -<meta name="generator" content="Docutils 0.15b.dev: http://docutils.sourceforge.net/" /> +<meta name="generator" content="Docutils 0.15rc1.dev: http://docutils.sourceforge.net/" /> <title>Test footnote and citation rendering</title> <link rel="stylesheet" href="../input/data/minimal.css" type="text/css" /> <link rel="stylesheet" href="../input/data/plain.css" type="text/css" /> Modified: trunk/docutils/test/functional/expected/math_output_html.html =================================================================== --- trunk/docutils/test/functional/expected/math_output_html.html 2019-07-18 16:20:00 UTC (rev 8262) +++ trunk/docutils/test/functional/expected/math_output_html.html 2019-07-20 14:03:04 UTC (rev 8263) @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> -<meta name="generator" content="Docutils 0.15b.dev: http://docutils.sourceforge.net/" /> +<meta name="generator" content="Docutils 0.15rc1.dev: http://docutils.sourceforge.net/" /> <title>Mathematics</title> <link rel="stylesheet" href="../input/data/html4css1.css" type="text/css" /> <link rel="stylesheet" href="../input/data/math.css" type="text/css" /> Modified: trunk/docutils/test/functional/expected/math_output_latex.html =================================================================== --- trunk/docutils/test/functional/expected/math_output_latex.html 2019-07-18 16:20:00 UTC (rev 8262) +++ trunk/docutils/test/functional/expected/math_output_latex.html 2019-07-20 14:03:04 UTC (rev 8263) @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> -<meta name="generator" content="Docutils 0.15b.dev: http://docutils.sourceforge.net/" /> +<meta name="generator" content="Docutils 0.15rc1.dev: http://docutils.sourceforge.net/" /> <title>Mathematics</title> <link rel="stylesheet" href="../input/data/html4css1.css" type="text/css" /> </head> Modified: trunk/docutils/test/functional/expected/math_output_mathjax.html =================================================================== --- trunk/docutils/test/functional/expected/math_output_mathjax.html 2019-07-18 16:20:00 UTC (rev 8262) +++ trunk/docutils/test/functional/expected/math_output_mathjax.html 2019-07-20 14:03:04 UTC (rev 8263) @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> -<meta name="generator" content="Docutils 0.15b.dev: http://docutils.sourceforge.net/" /> +<meta name="generator" content="Docutils 0.15rc1.dev: http://docutils.sourceforge.net/" /> <title>Mathematics</title> <script type="text/javascript" src="/usr/share/javascript/mathjax/MathJax.js?config=TeX-AMS_CHTML"></script> <link rel="stylesheet" href="../input/data/html4css1.css" type="text/css" /> Modified: trunk/docutils/test/functional/expected/math_output_mathml.xhtml =================================================================== --- trunk/docutils/test/functional/expected/math_output_mathml.xhtml 2019-07-18 16:20:00 UTC (rev 8262) +++ trunk/docutils/test/functional/expected/math_output_mathml.xhtml 2019-07-20 14:03:04 UTC (rev 8263) @@ -2,7 +2,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta charset="utf-8"/> -<meta name="generator" content="Docutils 0.15b.dev: http://docutils.sourceforge.net/" /> +<meta name="generator" content="Docutils 0.15rc1.dev: http://docutils.sourceforge.net/" /> <title>Mathematics</title> <link rel="stylesheet" href="../input/data/minimal.css" type="text/css" /> <link rel="stylesheet" href="../input/data/plain.css" type="text/css" /> Modified: trunk/docutils/test/functional/expected/misc_rst_html4css1.html =================================================================== --- trunk/docutils/test/functional/expected/misc_rst_html4css1.html 2019-07-18 16:20:00 UTC (rev 8262) +++ trunk/docutils/test/functional/expected/misc_rst_html4css1.html 2019-07-20 14:03:04 UTC (rev 8263) @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> -<meta name="generator" content="Docutils 0.15b.dev: http://docutils.sourceforge.net/" /> +<meta name="generator" content="Docutils 0.15rc1.dev: http://docutils.sourceforge.net/" /> <title>link_in_substitution.txt</title> <link rel="stylesheet" href="foo&bar.css" type="text/css" /> </head> Modified: trunk/docutils/test/functional/expected/pep_html.html =================================================================== --- trunk/docutils/test/functional/expected/pep_html.html 2019-07-18 16:20:00 UTC (rev 8262) +++ trunk/docutils/test/functional/expected/pep_html.html 2019-07-20 14:03:04 UTC (rev 8263) @@ -8,7 +8,7 @@ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <meta name="generator" content="Docutils 0.15b.dev: http://docutils.sourceforge.net/" /> + <meta name="generator" content="Docutils 0.15rc1.dev: http://docutils.sourceforge.net/" /> <title>PEP 100 -- Test PEP</title> <link rel="stylesheet" href="../input/data/html4css1.css" type="text/css" /> </head> Modified: trunk/docutils/test/functional/expected/standalone_rst_docutils_xml.xml =================================================================== --- trunk/docutils/test/functional/expected/standalone_rst_docutils_xml.xml 2019-07-18 16:20:00 UTC (rev 8262) +++ trunk/docutils/test/functional/expected/standalone_rst_docutils_xml.xml 2019-07-20 14:03:04 UTC (rev 8263) @@ -1,6 +1,6 @@ <?xml version="1.0" encoding="utf-8"?> <!DOCTYPE document PUBLIC "+//IDN docutils.sourceforge.net//DTD Docutils Generic//EN//XML" "http://docutils.sourceforge.net/docs/ref/docutils.dtd"> -<!-- Generated by Docutils 0.15b.dev --> +<!-- Generated by Docutils 0.15rc1.dev --> <document ids="restructuredtext-test-document doctitle" names="restructuredtext\ test\ document doctitle" source="functional/input/standalone_rst_docutils_xml.txt" title="reStructuredText Test Document"> <title>reStructuredText Test Document</title> <subtitle ids="examples-of-syntax-constructs subtitle" names="examples\ of\ syntax\ constructs subtitle">Examples of Syntax Constructs</subtitle> Modified: trunk/docutils/test/functional/expected/standalone_rst_html4css1.html =================================================================== --- trunk/docutils/test/functional/expected/standalone_rst_html4css1.html 2019-07-18 16:20:00 UTC (rev 8262) +++ trunk/docutils/test/functional/expected/standalone_rst_html4css1.html 2019-07-20 14:03:04 UTC (rev 8263) @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> -<meta name="generator" content="Docutils 0.15b.dev: http://docutils.sourceforge.net/" /> +<meta name="generator" content="Docutils 0.15rc1.dev: http://docutils.sourceforge.net/" /> <title>reStructuredText Test Document</title> <meta name="author" content="David Goodger" /> <meta name="authors" content="Me Myself I" /> Modified: trunk/docutils/test/functional/expected/standalone_rst_html5.html =================================================================== --- trunk/docutils/test/functional/expected/standalone_rst_html5.html 2019-07-18 16:20:00 UTC (rev 8262) +++ trunk/docutils/test/functional/expected/standalone_rst_html5.html 2019-07-20 14:03:04 UTC (rev 8263) @@ -2,7 +2,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta charset="utf-8"/> -<meta name="generator" content="Docutils 0.15b.dev: http://docutils.sourceforge.net/" /> +<meta name="generator" content="Docutils 0.15rc1.dev: http://docutils.sourceforge.net/" /> <title>reStructuredText Test Document</title> <meta name="author" content="David Goodger" /> <meta name="author" content="Me" /> Modified: trunk/docutils/test/functional/expected/standalone_rst_s5_html_1.html =================================================================== --- trunk/docutils/test/functional/expected/standalone_rst_s5_html_1.html 2019-07-18 16:20:00 UTC (rev 8262) +++ trunk/docutils/test/functional/expected/standalone_rst_s5_html_1.html 2019-07-20 14:03:04 UTC (rev 8263) @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> -<meta name="generator" content="Docutils 0.15b.dev: http://docutils.sourceforge.net/" /> +<meta name="generator" content="Docutils 0.15rc1.dev: http://docutils.sourceforge.net/" /> <meta name="version" content="S5 1.1" /> <title>Slide Shows</title> <meta name="author" content="David Goodger" /> Modified: trunk/docutils/test/functional/expected/standalone_rst_s5_html_2.html =================================================================== --- trunk/docutils/test/functional/expected/standalone_rst_s5_html_2.html 2019-07-18 16:20:00 UTC (rev 8262) +++ trunk/docutils/test/functional/expected/standalone_rst_s5_html_2.html 2019-07-20 14:03:04 UTC (rev 8263) @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> -<meta name="generator" content="Docutils 0.15b.dev: http://docutils.sourceforge.net/" /> +<meta name="generator" content="Docutils 0.15rc1.dev: http://docutils.sourceforge.net/" /> <meta name="version" content="S5 1.1" /> <title>Slide Shows</title> <meta name="author" content="David Goodger" /> Modified: trunk/sandbox/infrastructure/releasing-log.txt =================================================================== --- trunk/sandbox/infrastructure/releasing-log.txt 2019-07-18 16:20:00 UTC (rev 8262) +++ trunk/sandbox/infrastructure/releasing-log.txt 2019-07-20 14:03:04 UTC (rev 8263) @@ -21,7 +21,10 @@ FIXED: revision 8260 * test on macosx 2.7 3.4 3.6 3.7 : passed -o change version to : 0.15.0 candidate, serial: 1 +* change version to : 0.15rc1.dev + + - run tests: python 2.7 and 3.7 + o merge changes from HISTORY.txt to RELEASE-NOTES.txt o extract release number description setting from release.sh o rename headings in HISTORY.txt and RELEASE-NOTES.txt This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <gr...@us...> - 2019-07-20 19:21:09
|
Revision: 8265 http://sourceforge.net/p/docutils/code/8265 Author: grubert Date: 2019-07-20 19:21:07 +0000 (Sat, 20 Jul 2019) Log Message: ----------- extract "some" info on changes from history to release-notes Modified Paths: -------------- trunk/docutils/RELEASE-NOTES.txt trunk/sandbox/infrastructure/releasing-log.txt Modified: trunk/docutils/RELEASE-NOTES.txt =================================================================== --- trunk/docutils/RELEASE-NOTES.txt 2019-07-20 14:05:34 UTC (rev 8264) +++ trunk/docutils/RELEASE-NOTES.txt 2019-07-20 19:21:07 UTC (rev 8265) @@ -81,8 +81,13 @@ - Fixed a bug with the "trim" options of the "unicode" directive. -* languages: Added Korean (ko) mappings. +* languages: Added Korean (ko) mappings and latin. +* Several fixes to keep mor information on source in parsed elements, + isolate documents roles from other documents parsed, smartquotes, + table gets width and latex table multicolumn cells, ... + + Release 0.14 (2017-08-03) ========================= Modified: trunk/sandbox/infrastructure/releasing-log.txt =================================================================== --- trunk/sandbox/infrastructure/releasing-log.txt 2019-07-20 14:05:34 UTC (rev 8264) +++ trunk/sandbox/infrastructure/releasing-log.txt 2019-07-20 19:21:07 UTC (rev 8265) @@ -25,8 +25,7 @@ - run tests: python 2.7 and 3.7 -o merge changes from HISTORY.txt to RELEASE-NOTES.txt -o extract release number description setting from release.sh +* extract changes from HISTORY.txt to RELEASE-NOTES.txt o rename headings in HISTORY.txt and RELEASE-NOTES.txt o run release.sh stage 2: do a clean checkout and packing o run local test with python 2.6 2.7 3.4 3.5 3.6 3.7 This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <gr...@us...> - 2019-07-20 19:50:53
|
Revision: 8267 http://sourceforge.net/p/docutils/code/8267 Author: grubert Date: 2019-07-20 19:50:51 +0000 (Sat, 20 Jul 2019) Log Message: ----------- Change to 0.15 final Modified Paths: -------------- trunk/docutils/HISTORY.txt trunk/docutils/RELEASE-NOTES.txt trunk/docutils/docutils/__init__.py trunk/docutils/setup.py trunk/docutils/test/functional/expected/compact_lists.html trunk/docutils/test/functional/expected/dangerous.html trunk/docutils/test/functional/expected/field_name_limit.html trunk/docutils/test/functional/expected/footnotes_html5.html trunk/docutils/test/functional/expected/math_output_html.html trunk/docutils/test/functional/expected/math_output_latex.html trunk/docutils/test/functional/expected/math_output_mathjax.html trunk/docutils/test/functional/expected/math_output_mathml.xhtml trunk/docutils/test/functional/expected/misc_rst_html4css1.html trunk/docutils/test/functional/expected/pep_html.html trunk/docutils/test/functional/expected/standalone_rst_docutils_xml.xml trunk/docutils/test/functional/expected/standalone_rst_html4css1.html trunk/docutils/test/functional/expected/standalone_rst_html5.html trunk/docutils/test/functional/expected/standalone_rst_s5_html_1.html trunk/docutils/test/functional/expected/standalone_rst_s5_html_2.html trunk/sandbox/infrastructure/releasing-log.txt Modified: trunk/docutils/HISTORY.txt =================================================================== --- trunk/docutils/HISTORY.txt 2019-07-20 19:47:09 UTC (rev 8266) +++ trunk/docutils/HISTORY.txt 2019-07-20 19:50:51 UTC (rev 8267) @@ -13,9 +13,13 @@ .. contents:: -Changes Since 0.14 +Changes Since 0.15 ================== + +Release 0.15 (2019-07-20) +========================= + * General - Dropped support for Python 2.4, 2.5, 3.1, and 3.2. Modified: trunk/docutils/RELEASE-NOTES.txt =================================================================== --- trunk/docutils/RELEASE-NOTES.txt 2019-07-20 19:47:09 UTC (rev 8266) +++ trunk/docutils/RELEASE-NOTES.txt 2019-07-20 19:50:51 UTC (rev 8267) @@ -63,8 +63,8 @@ __ docs/ref/rst/restructuredtext.html#bibliographic-fields -Release 0.15b.dev -================= +Release 0.15 +============ .. Note:: Modified: trunk/docutils/docutils/__init__.py =================================================================== --- trunk/docutils/docutils/__init__.py 2019-07-20 19:47:09 UTC (rev 8266) +++ trunk/docutils/docutils/__init__.py 2019-07-20 19:50:51 UTC (rev 8267) @@ -56,7 +56,7 @@ __docformat__ = 'reStructuredText' -__version__ = '0.15rc1.dev' +__version__ = '0.15' """Docutils version identifier (complies with PEP 440):: major.minor[.micro][releaselevel[serial]][.dev] @@ -74,15 +74,15 @@ major=0, minor=15, micro=0, - releaselevel='candidate', # one of 'alpha', 'beta', 'candidate', 'final' + releaselevel='final', # one of 'alpha', 'beta', 'candidate', 'final' # pre-release serial number (0 for final releases and active development): - serial=1, - release=False # True for official releases and pre-releases + serial=0, + release=True # True for official releases and pre-releases ) """Comprehensive version information tuple. See 'Version Numbering' in docs/dev/policies.txt.""" -__version_details__ = '' +__version_details__ = 'release' """Optional extra version details (e.g. 'snapshot 2005-05-29, r3410'). (For development and release status see `__version_info__`.) """ Modified: trunk/docutils/setup.py =================================================================== --- trunk/docutils/setup.py 2019-07-20 19:47:09 UTC (rev 8266) +++ trunk/docutils/setup.py 2019-07-20 19:50:51 UTC (rev 8267) @@ -115,7 +115,7 @@ input Docutils supports reStructuredText, an easy-to-read, what-you-see-is-what-you-get plaintext markup syntax.""", # wrap at col 60 'url': 'http://docutils.sourceforge.net/', - 'version': '0.15rc1.dev', + 'version': '0.15', 'author': 'David Goodger', 'author_email': 'go...@py...', 'maintainer': 'docutils-develop list', Modified: trunk/docutils/test/functional/expected/compact_lists.html =================================================================== --- trunk/docutils/test/functional/expected/compact_lists.html 2019-07-20 19:47:09 UTC (rev 8266) +++ trunk/docutils/test/functional/expected/compact_lists.html 2019-07-20 19:50:51 UTC (rev 8267) @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> -<meta name="generator" content="Docutils 0.15rc1.dev: http://docutils.sourceforge.net/" /> +<meta name="generator" content="Docutils 0.15: http://docutils.sourceforge.net/" /> <title>compact_lists.txt</title> <link rel="stylesheet" href="../input/data/html4css1.css" type="text/css" /> </head> Modified: trunk/docutils/test/functional/expected/dangerous.html =================================================================== --- trunk/docutils/test/functional/expected/dangerous.html 2019-07-20 19:47:09 UTC (rev 8266) +++ trunk/docutils/test/functional/expected/dangerous.html 2019-07-20 19:50:51 UTC (rev 8267) @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> -<meta name="generator" content="Docutils 0.15rc1.dev: http://docutils.sourceforge.net/" /> +<meta name="generator" content="Docutils 0.15: http://docutils.sourceforge.net/" /> <title>dangerous.txt</title> <link rel="stylesheet" href="../input/data/html4css1.css" type="text/css" /> </head> Modified: trunk/docutils/test/functional/expected/field_name_limit.html =================================================================== --- trunk/docutils/test/functional/expected/field_name_limit.html 2019-07-20 19:47:09 UTC (rev 8266) +++ trunk/docutils/test/functional/expected/field_name_limit.html 2019-07-20 19:50:51 UTC (rev 8267) @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> -<meta name="generator" content="Docutils 0.15rc1.dev: http://docutils.sourceforge.net/" /> +<meta name="generator" content="Docutils 0.15: http://docutils.sourceforge.net/" /> <title>field_list.txt</title> <link rel="stylesheet" href="../input/data/html4css1.css" type="text/css" /> </head> Modified: trunk/docutils/test/functional/expected/footnotes_html5.html =================================================================== --- trunk/docutils/test/functional/expected/footnotes_html5.html 2019-07-20 19:47:09 UTC (rev 8266) +++ trunk/docutils/test/functional/expected/footnotes_html5.html 2019-07-20 19:50:51 UTC (rev 8267) @@ -2,7 +2,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta charset="utf-8"/> -<meta name="generator" content="Docutils 0.15rc1.dev: http://docutils.sourceforge.net/" /> +<meta name="generator" content="Docutils 0.15: http://docutils.sourceforge.net/" /> <title>Test footnote and citation rendering</title> <link rel="stylesheet" href="../input/data/minimal.css" type="text/css" /> <link rel="stylesheet" href="../input/data/plain.css" type="text/css" /> Modified: trunk/docutils/test/functional/expected/math_output_html.html =================================================================== --- trunk/docutils/test/functional/expected/math_output_html.html 2019-07-20 19:47:09 UTC (rev 8266) +++ trunk/docutils/test/functional/expected/math_output_html.html 2019-07-20 19:50:51 UTC (rev 8267) @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> -<meta name="generator" content="Docutils 0.15rc1.dev: http://docutils.sourceforge.net/" /> +<meta name="generator" content="Docutils 0.15: http://docutils.sourceforge.net/" /> <title>Mathematics</title> <link rel="stylesheet" href="../input/data/html4css1.css" type="text/css" /> <link rel="stylesheet" href="../input/data/math.css" type="text/css" /> Modified: trunk/docutils/test/functional/expected/math_output_latex.html =================================================================== --- trunk/docutils/test/functional/expected/math_output_latex.html 2019-07-20 19:47:09 UTC (rev 8266) +++ trunk/docutils/test/functional/expected/math_output_latex.html 2019-07-20 19:50:51 UTC (rev 8267) @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> -<meta name="generator" content="Docutils 0.15rc1.dev: http://docutils.sourceforge.net/" /> +<meta name="generator" content="Docutils 0.15: http://docutils.sourceforge.net/" /> <title>Mathematics</title> <link rel="stylesheet" href="../input/data/html4css1.css" type="text/css" /> </head> Modified: trunk/docutils/test/functional/expected/math_output_mathjax.html =================================================================== --- trunk/docutils/test/functional/expected/math_output_mathjax.html 2019-07-20 19:47:09 UTC (rev 8266) +++ trunk/docutils/test/functional/expected/math_output_mathjax.html 2019-07-20 19:50:51 UTC (rev 8267) @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> -<meta name="generator" content="Docutils 0.15rc1.dev: http://docutils.sourceforge.net/" /> +<meta name="generator" content="Docutils 0.15: http://docutils.sourceforge.net/" /> <title>Mathematics</title> <script type="text/javascript" src="/usr/share/javascript/mathjax/MathJax.js?config=TeX-AMS_CHTML"></script> <link rel="stylesheet" href="../input/data/html4css1.css" type="text/css" /> Modified: trunk/docutils/test/functional/expected/math_output_mathml.xhtml =================================================================== --- trunk/docutils/test/functional/expected/math_output_mathml.xhtml 2019-07-20 19:47:09 UTC (rev 8266) +++ trunk/docutils/test/functional/expected/math_output_mathml.xhtml 2019-07-20 19:50:51 UTC (rev 8267) @@ -2,7 +2,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta charset="utf-8"/> -<meta name="generator" content="Docutils 0.15rc1.dev: http://docutils.sourceforge.net/" /> +<meta name="generator" content="Docutils 0.15: http://docutils.sourceforge.net/" /> <title>Mathematics</title> <link rel="stylesheet" href="../input/data/minimal.css" type="text/css" /> <link rel="stylesheet" href="../input/data/plain.css" type="text/css" /> Modified: trunk/docutils/test/functional/expected/misc_rst_html4css1.html =================================================================== --- trunk/docutils/test/functional/expected/misc_rst_html4css1.html 2019-07-20 19:47:09 UTC (rev 8266) +++ trunk/docutils/test/functional/expected/misc_rst_html4css1.html 2019-07-20 19:50:51 UTC (rev 8267) @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> -<meta name="generator" content="Docutils 0.15rc1.dev: http://docutils.sourceforge.net/" /> +<meta name="generator" content="Docutils 0.15: http://docutils.sourceforge.net/" /> <title>link_in_substitution.txt</title> <link rel="stylesheet" href="foo&bar.css" type="text/css" /> </head> Modified: trunk/docutils/test/functional/expected/pep_html.html =================================================================== --- trunk/docutils/test/functional/expected/pep_html.html 2019-07-20 19:47:09 UTC (rev 8266) +++ trunk/docutils/test/functional/expected/pep_html.html 2019-07-20 19:50:51 UTC (rev 8267) @@ -8,7 +8,7 @@ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <meta name="generator" content="Docutils 0.15rc1.dev: http://docutils.sourceforge.net/" /> + <meta name="generator" content="Docutils 0.15: http://docutils.sourceforge.net/" /> <title>PEP 100 -- Test PEP</title> <link rel="stylesheet" href="../input/data/html4css1.css" type="text/css" /> </head> Modified: trunk/docutils/test/functional/expected/standalone_rst_docutils_xml.xml =================================================================== --- trunk/docutils/test/functional/expected/standalone_rst_docutils_xml.xml 2019-07-20 19:47:09 UTC (rev 8266) +++ trunk/docutils/test/functional/expected/standalone_rst_docutils_xml.xml 2019-07-20 19:50:51 UTC (rev 8267) @@ -1,6 +1,6 @@ <?xml version="1.0" encoding="utf-8"?> <!DOCTYPE document PUBLIC "+//IDN docutils.sourceforge.net//DTD Docutils Generic//EN//XML" "http://docutils.sourceforge.net/docs/ref/docutils.dtd"> -<!-- Generated by Docutils 0.15rc1.dev --> +<!-- Generated by Docutils 0.15 --> <document ids="restructuredtext-test-document doctitle" names="restructuredtext\ test\ document doctitle" source="functional/input/standalone_rst_docutils_xml.txt" title="reStructuredText Test Document"> <title>reStructuredText Test Document</title> <subtitle ids="examples-of-syntax-constructs subtitle" names="examples\ of\ syntax\ constructs subtitle">Examples of Syntax Constructs</subtitle> Modified: trunk/docutils/test/functional/expected/standalone_rst_html4css1.html =================================================================== --- trunk/docutils/test/functional/expected/standalone_rst_html4css1.html 2019-07-20 19:47:09 UTC (rev 8266) +++ trunk/docutils/test/functional/expected/standalone_rst_html4css1.html 2019-07-20 19:50:51 UTC (rev 8267) @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> -<meta name="generator" content="Docutils 0.15rc1.dev: http://docutils.sourceforge.net/" /> +<meta name="generator" content="Docutils 0.15: http://docutils.sourceforge.net/" /> <title>reStructuredText Test Document</title> <meta name="author" content="David Goodger" /> <meta name="authors" content="Me Myself I" /> Modified: trunk/docutils/test/functional/expected/standalone_rst_html5.html =================================================================== --- trunk/docutils/test/functional/expected/standalone_rst_html5.html 2019-07-20 19:47:09 UTC (rev 8266) +++ trunk/docutils/test/functional/expected/standalone_rst_html5.html 2019-07-20 19:50:51 UTC (rev 8267) @@ -2,7 +2,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta charset="utf-8"/> -<meta name="generator" content="Docutils 0.15rc1.dev: http://docutils.sourceforge.net/" /> +<meta name="generator" content="Docutils 0.15: http://docutils.sourceforge.net/" /> <title>reStructuredText Test Document</title> <meta name="author" content="David Goodger" /> <meta name="author" content="Me" /> Modified: trunk/docutils/test/functional/expected/standalone_rst_s5_html_1.html =================================================================== --- trunk/docutils/test/functional/expected/standalone_rst_s5_html_1.html 2019-07-20 19:47:09 UTC (rev 8266) +++ trunk/docutils/test/functional/expected/standalone_rst_s5_html_1.html 2019-07-20 19:50:51 UTC (rev 8267) @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> -<meta name="generator" content="Docutils 0.15rc1.dev: http://docutils.sourceforge.net/" /> +<meta name="generator" content="Docutils 0.15: http://docutils.sourceforge.net/" /> <meta name="version" content="S5 1.1" /> <title>Slide Shows</title> <meta name="author" content="David Goodger" /> Modified: trunk/docutils/test/functional/expected/standalone_rst_s5_html_2.html =================================================================== --- trunk/docutils/test/functional/expected/standalone_rst_s5_html_2.html 2019-07-20 19:47:09 UTC (rev 8266) +++ trunk/docutils/test/functional/expected/standalone_rst_s5_html_2.html 2019-07-20 19:50:51 UTC (rev 8267) @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> -<meta name="generator" content="Docutils 0.15rc1.dev: http://docutils.sourceforge.net/" /> +<meta name="generator" content="Docutils 0.15: http://docutils.sourceforge.net/" /> <meta name="version" content="S5 1.1" /> <title>Slide Shows</title> <meta name="author" content="David Goodger" /> Modified: trunk/sandbox/infrastructure/releasing-log.txt =================================================================== --- trunk/sandbox/infrastructure/releasing-log.txt 2019-07-20 19:47:09 UTC (rev 8266) +++ trunk/sandbox/infrastructure/releasing-log.txt 2019-07-20 19:50:51 UTC (rev 8267) @@ -26,7 +26,7 @@ - run tests: python 2.7 and 3.7 * extract changes from HISTORY.txt to RELEASE-NOTES.txt -o rename headings in HISTORY.txt and RELEASE-NOTES.txt +* rename headings in HISTORY.txt and RELEASE-NOTES.txt o run release.sh stage 2: do a clean checkout and packing o run local test with python 2.6 2.7 3.4 3.5 3.6 3.7 o upload to sourceforge.net. Keep 0.14 as lattest, stable. This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <mi...@us...> - 2019-08-27 15:30:42
|
Revision: 8375 http://sourceforge.net/p/docutils/code/8375 Author: milde Date: 2019-08-27 15:30:40 +0000 (Tue, 27 Aug 2019) Log Message: ----------- Remove autoconversion code. Conversion with 2to3 is no longer required. The documentation and 'tox.ini' file are updated accordingly. Based on a patch by Stephen Finucane <st...@th...ru>. Modified Paths: -------------- trunk/.gitignore trunk/docutils/README.txt trunk/docutils/RELEASE-NOTES.txt trunk/docutils/docs/dev/testing.txt trunk/docutils/docs/dev/todo.txt trunk/docutils/setup.py trunk/docutils/tox.ini Modified: trunk/.gitignore =================================================================== --- trunk/.gitignore 2019-08-27 12:11:40 UTC (rev 8374) +++ trunk/.gitignore 2019-08-27 15:30:40 UTC (rev 8375) @@ -1,16 +1,15 @@ MANIFEST build +.venv +.tox + +*~ *.pyc *.egg-info __pycache__ -*~ docutils/docs/**/*.html -.venv -.tox - -/docutils/test3 /docutils/test/alltests.out /docutils/test/record.txt /docutils/test/functional/output Modified: trunk/docutils/README.txt =================================================================== --- trunk/docutils/README.txt 2019-08-27 12:11:40 UTC (rev 8374) +++ trunk/docutils/README.txt 2019-08-27 15:30:40 UTC (rev 8375) @@ -123,25 +123,11 @@ Python 3 compatibility ---------------------- -The Docutils codebase is written for Python 2 and uses "on-demand" -translation for `porting to Python 3`_. +Up to version 0.15, the Docutils codebase was translated "on-demand" using +the 2to3 tool. Starting with Docutils 0.16, the code base supports both +Python 2.7 and 3.4+ natively. -* The `setup.py` script generates Python 3 compatible sources in - ``build/`` and tests in ``tests3/`` sub-directories during - installation_ with Python 3. -* The scripts in the ``tools/`` sub-directory work with all supported - Python versions without conversion. - -* To convert the sources without installing (e.g. for testing), run - ``python3 setup.py build``. - -* When editing the source, do changes on the Python 2 versions of the - files and re-run the build command. - -.. _porting to Python 3: http://docs.python.org/py3k/howto/pyporting.html - - Project Files & Directories =========================== @@ -194,13 +180,7 @@ if you're planning to modify it. See `Running the Test Suite`_ below. -Generated directories when installing under Python 3: -* build: Converted sources. - -* test3: Converted tests. - - Installation ============ @@ -232,7 +212,7 @@ To install for a specific Python version, use this version in the setup call, e.g. :: - python3.1 setup.py install + python3.7 setup.py install To install for different Python versions, repeat step 3 for every required version. The last installed version will be used in the @@ -332,12 +312,7 @@ cd <archive_directory_path>\test python alltests.py -For testing with Python 3 use the converted test suite:: - cd <archive_directory_path>/test3 - python3 alltests.py - - You should see a long line of periods, one for each test, and then a summary like this:: Modified: trunk/docutils/RELEASE-NOTES.txt =================================================================== --- trunk/docutils/RELEASE-NOTES.txt 2019-08-27 12:11:40 UTC (rev 8374) +++ trunk/docutils/RELEASE-NOTES.txt 2019-08-27 15:30:40 UTC (rev 8375) @@ -61,8 +61,15 @@ Docutils 0.16 is compatible with Python versions 2.7 and 3.5 to 3.7. (cf. `Python 3 compatibility`_). -* Keep `backslash escapes`__ in the document tree. +* General: + - Docutils now supports Python 2.7 and Python 3.5+ natively, + without the use of the ``2to3`` tool. + +* reStructuredText: + + - Keep `backslash escapes`__ in the document tree. + __ http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#escaping-mechanism Modified: trunk/docutils/docs/dev/testing.txt =================================================================== --- trunk/docutils/docs/dev/testing.txt 2019-08-27 12:11:40 UTC (rev 8374) +++ trunk/docutils/docs/dev/testing.txt 2019-08-27 15:30:40 UTC (rev 8375) @@ -29,12 +29,7 @@ cd docutils/test ./alltests.py -For Python 3, the tests must be converted with 2to3. To run the tests with -Python 3, ``cd`` to the package's root directory and do:: - python3 setup.py build - python3 test3/alltests.py - Python Versions =============== @@ -41,11 +36,12 @@ A docutils release has a commitment to support a minimum version and beyond. Before a release is cut, tests must pass in all supported Python versions. -The Docutils 0.15 release supports Python 2.7 and Python 3.5 or later. +Docutils 0.16 supports Python 2.7 and Python 3.5 or later. Therefore, you should install Python 2.7 as well as 3.5 up to the latest Python (3.7 at the time of this writing) and always run the tests on all of -them. In a pinch, the edge cases (2.7, and 3.7) should cover most of it. +them (see `Testing across multiple python versions`_). +In a pinch, the edge cases (2.7, and 3.7) should cover most of it. Good resources covering the differences between Python versions: @@ -64,8 +60,7 @@ .. _Python Check-in Policies: http://www.python.org/dev/tools.html .. _sandbox directory: http://docutils.svn.sourceforge.net/svnroot/docutils/trunk/sandbox/ -.. _nightly repository tarball: - http://svn.berlios.de/svndumps/docutils-repos.gz + Testing across multiple python versions --------------------------------------- Modified: trunk/docutils/docs/dev/todo.txt =================================================================== --- trunk/docutils/docs/dev/todo.txt 2019-08-27 12:11:40 UTC (rev 8374) +++ trunk/docutils/docs/dev/todo.txt 2019-08-27 15:30:40 UTC (rev 8375) @@ -71,15 +71,6 @@ General ======= -* Move to single source for Python 2 and Python 3. - (Cf. `Porting Python 2 Code to Python 3`_ and - `clean single-source support for Python 2/3`_.) - - .. _Porting Python 2 Code to Python 3: - https://docs.python.org/3/howto/pyporting.html - .. _clean single-source support for Python 2/3: - http://python-future.org - * Encoding of command line arguments can only be guessed: * try UTF-8/strict first, then try the locale's encoding with Modified: trunk/docutils/setup.py =================================================================== --- trunk/docutils/setup.py 2019-08-27 12:11:40 UTC (rev 8374) +++ trunk/docutils/setup.py 2019-08-27 15:30:40 UTC (rev 8375) @@ -13,9 +13,6 @@ from distutils.core import setup, Command from distutils.command.build import build from distutils.command.build_py import build_py - if sys.version_info >= (3, 0): - from distutils.command.build_py import build_py_2to3 - from distutils.util import copydir_run_2to3 from distutils.command.install_data import install_data from distutils.util import convert_path from distutils import log @@ -27,36 +24,6 @@ sys.exit(1) -if sys.version_info >= (3, 0): - # copy-convert auxiliary python sources - class copy_build_py_2to3(build_py_2to3): - """Copy/convert Python source files in given directories recursively. - - Build py3k versions of the modules and packages. - Also copy 'test/' suite and run 2to3 on *.py files. - """ - manifest_in = """\ - exclude *.pyc *~ .DS_Store - recursive-exclude * *.pyc *~ .DS_Store - recursive-exclude functional/output * - include functional/output/README.txt - prune .svn - prune */.svn - prune */*/.svn - prune */*/*/.svn - prune */*/*/*/.svn - prune */*/*/*/*/.svn - """ - def run(self): - # fix - print("build_py_2to3") - build_py_2to3.run(self) - print("copy/convert test suite") - loglevel = log.set_threshold(log.ERROR) - copydir_run_2to3('test', 'test3', template=self.manifest_in) - log.set_threshold(loglevel) - - class smart_install_data(install_data): # From <http://wiki.python.org/moin/DistutilsInstallDataScattered>, # by Pete Shinners. @@ -96,11 +63,6 @@ # Install data files properly. kwargs['cmdclass'] = {'build_data': build_data, 'install_data': smart_install_data} - # Auto-convert source code for Python 3 - if sys.version_info >= (3, 0): - kwargs['cmdclass']['build_py'] = copy_build_py_2to3 - else: - kwargs['cmdclass']['build_py'] = build_py dist = setup(**kwargs) return dist Modified: trunk/docutils/tox.ini =================================================================== --- trunk/docutils/tox.ini 2019-08-27 12:11:40 UTC (rev 8374) +++ trunk/docutils/tox.ini 2019-08-27 15:30:40 UTC (rev 8375) @@ -13,14 +13,6 @@ rm commands = find . -type f -name "*.pyc" -delete - rm -rf build test3 - python setup.py build - python setup.py install - python test3/alltests.py - -[testenv:py27] -commands = - find . -type f -name "*.pyc" -delete rm -rf build python setup.py build python setup.py install This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |