Thread: [Docutils-checkins] SF.net SVN: docutils:[7855] trunk/docutils (Page 7)

SourceForge Headquarters 1320 Columbia Street Suite 310 San Diego, CA 92101 +1 (858) 422-6466

Revision: 7855
          http://sourceforge.net/p/docutils/code/7855
Author:   milde
Date:     2015-03-26 13:38:51 +0000 (Thu, 26 Mar 2015)
Log Message:
-----------
HTML4 writer: Wrap literal blocks in a <span> to support sub- and superscript 

(not allowed in <pre> but possible in parsed-literal).

Modified Paths:
--------------
    trunk/docutils/HISTORY.txt
    trunk/docutils/docutils/writers/html4css1/__init__.py
    trunk/docutils/docutils/writers/xhtml11/__init__.py
    trunk/docutils/test/functional/expected/dangerous.html
    trunk/docutils/test/functional/expected/standalone_rst_html4css1.html
    trunk/docutils/test/functional/expected/standalone_rst_xhtml11.xhtml

Modified: trunk/docutils/HISTORY.txt
===================================================================

--- trunk/docutils/HISTORY.txt	2015-03-23 08:18:25 UTC (rev 7854)
+++ trunk/docutils/HISTORY.txt	2015-03-26 13:38:51 UTC (rev 7855)
@@ -53,6 +53,8 @@
   - Apply patch [ 119 ] by Anatoly Techtonik: use absolute paths for
     ``default_stylesheet_path`` and ``default_template_path``.
   - Fix [ 266 ] creating labels/class values in description list items.
+  - Wrap literal blocks in a <span> to support sub- and superscript (not
+    allowed in <pre> but possible in parsed-literal).
 
 * docutils/writers/latex2e/__init__.py
 

Modified: trunk/docutils/docutils/writers/html4css1/__init__.py
===================================================================
--- trunk/docutils/docutils/writers/html4css1/__init__.py	2015-03-23 08:18:25 UTC (rev 7854)
+++ trunk/docutils/docutils/writers/html4css1/__init__.py	2015-03-26 13:38:51 UTC (rev 7855)
@@ -1180,8 +1180,10 @@
 
     def visit_literal_block(self, node):
         self.body.append(self.starttag(node, 'pre', CLASS='literal-block'))
+        self.body.append('<span>') # allow <sup> and <sub> (parsed-literal)
 
     def depart_literal_block(self, node):
+        self.body.append('</span>') # allow <sup> and <sub> (parsed-literal)
         self.body.append('\n</pre>\n')
 
     def visit_math(self, node, math_env=''):

Modified: trunk/docutils/docutils/writers/xhtml11/__init__.py
===================================================================
--- trunk/docutils/docutils/writers/xhtml11/__init__.py	2015-03-23 08:18:25 UTC (rev 7854)
+++ trunk/docutils/docutils/writers/xhtml11/__init__.py	2015-03-26 13:38:51 UTC (rev 7855)
@@ -118,6 +118,24 @@
         self.body.append(self.starttag(node, 'ol', **atts))
 
 
+# <sup> and <sub> tags (possible with parsed-literal) are not allowed directly
+# in <pre> -- wrap in <span> ::
+
+    def visit_literal_block(self, node):
+        self.body.append(self.starttag(node, 'pre', '', CLASS='literal-block'))
+        if 'code' in node.get('classes', []):
+            self.body.append('<code>')
+        else:
+            self.body.append('<span>')
+
+    def depart_literal_block(self, node):
+        if 'code' in node.get('classes', []):
+            self.body.append('</code>')
+        else:
+            self.body.append('</span>')
+        self.body.append('</pre>\n')
+
+
     # Meta tags: 'lang' attribute replaced by 'xml:lang' in XHTML 1.1
     # HTML5/polyglott recommends using both
 

Modified: trunk/docutils/test/functional/expected/dangerous.html
===================================================================
--- trunk/docutils/test/functional/expected/dangerous.html	2015-03-23 08:18:25 UTC (rev 7854)
+++ trunk/docutils/test/functional/expected/dangerous.html	2015-03-26 13:38:51 UTC (rev 7855)
@@ -16,48 +16,48 @@
 <p class="system-message-title">System Message: WARNING/2 (<tt class="docutils">functional/input/dangerous.txt</tt>, line 3)</p>
 <p>&quot;include&quot; directive disabled.</p>
 <pre class="literal-block">
-.. include:: /etc/passwd
+<span>.. include:: /etc/passwd</span>
 </pre>
 </div>
 <div class="system-message">
 <p class="system-message-title">System Message: WARNING/2 (<tt class="docutils">functional/input/dangerous.txt</tt>, line 4)</p>
 <p>&quot;raw&quot; directive disabled.</p>
 <pre class="literal-block">
-.. raw:: html
-   :file: /etc/passwd
+<span>.. raw:: html
+   :file: /etc/passwd</span>
 </pre>
 </div>
 <div class="system-message">
 <p class="system-message-title">System Message: WARNING/2 (<tt class="docutils">functional/input/dangerous.txt</tt>, line 6)</p>
 <p>&quot;raw&quot; directive disabled.</p>
 <pre class="literal-block">
-.. raw:: html
-   :url: file:///etc/passwd
+<span>.. raw:: html
+   :url: file:///etc/passwd</span>
 </pre>
 </div>
 <div class="system-message">
 <p class="system-message-title">System Message: WARNING/2 (<tt class="docutils">functional/input/dangerous.txt</tt>, line 8)</p>
 <p>&quot;raw&quot; directive disabled.</p>
 <pre class="literal-block">
-.. raw:: html
+<span>.. raw:: html
 
    &lt;script&gt;
        that does something really nasty
-   &lt;/script&gt;
+   &lt;/script&gt;</span>
 </pre>
 </div>
 <div class="system-message">
 <p class="system-message-title">System Message: WARNING/2 (<tt class="docutils">functional/input/dangerous.txt</tt>, line 13)</p>
 <p>File and URL access deactivated; ignoring &quot;csv-table&quot; directive.</p>
 <pre class="literal-block">
-.. csv-table:: :file: /etc/passwd
+<span>.. csv-table:: :file: /etc/passwd</span>
 </pre>
 </div>
 <div class="system-message">
 <p class="system-message-title">System Message: WARNING/2 (<tt class="docutils">functional/input/dangerous.txt</tt>, line 14)</p>
 <p>File and URL access deactivated; ignoring &quot;csv-table&quot; directive.</p>
 <pre class="literal-block">
-.. csv-table:: :url: file:///etc/passwd
+<span>.. csv-table:: :url: file:///etc/passwd</span>
 </pre>
 </div>
 <div class="figure">

Modified: trunk/docutils/test/functional/expected/standalone_rst_html4css1.html
===================================================================
--- trunk/docutils/test/functional/expected/standalone_rst_html4css1.html	2015-03-23 08:18:25 UTC (rev 7854)
+++ trunk/docutils/test/functional/expected/standalone_rst_html4css1.html	2015-03-26 13:38:51 UTC (rev 7855)
@@ -346,16 +346,16 @@
 <p>Literal blocks are indicated with a double-colon (&quot;::&quot;) at the end of
 the preceding paragraph (over there <tt class="docutils literal"><span class="pre">--&gt;</span></tt>).  They can be indented:</p>
 <pre class="literal-block">
-if literal_block:
+<span>if literal_block:
     text = 'is left as-is'
     spaces_and_linebreaks = 'are preserved'
-    markup_processing = None
+    markup_processing = None</span>
 </pre>
 <p>Or they can be quoted without indentation:</p>
 <pre class="literal-block">
-&gt;&gt; Great idea!
+<span>&gt;&gt; Great idea!
 &gt;
-&gt; Why didn't I think of that?
+&gt; Why didn't I think of that?</span>
 </pre>
 </div>
 <div class="section" id="line-blocks">
@@ -775,7 +775,7 @@
 <div class="compound">
 <p class="compound-first">Compound 2, a literal block:</p>
 <pre class="compound-middle literal-block">
-Compound 2, literal.
+<span>Compound 2, literal.</span>
 </pre>
 <p class="compound-last">Compound 2, this is a test.</p>
 </div>
@@ -784,8 +784,8 @@
 </div>
 <div class="compound">
 <pre class="compound-first literal-block">
-Compound 4.
-This one starts with a literal block.
+<span>Compound 4.
+This one starts with a literal block.</span>
 </pre>
 <p class="compound-last">Compound 4, a paragraph.</p>
 </div>
@@ -832,13 +832,13 @@
 <div class="section" id="parsed-literal-blocks">
 <h3><a class="toc-backref" href="#id84">2.14.8&nbsp;&nbsp;&nbsp;Parsed Literal Blocks</a></h3>
 <pre class="literal-block">
-This is a parsed literal block.
+<span>This is a parsed literal block.
     This line is indented.  The next line is blank.
 
 Inline markup is supported, e.g. <em>emphasis</em>, <strong>strong</strong>, <tt class="docutils literal">literal
 text</tt>, <sub>sub-</sub> and <sup>super</sup>scripts,
 inline formulas: <span class="formula"><i>A</i> = 2<i>π</i><i>r</i><sup>2</sup></span>,
-footnotes <a class="footnote-reference" href="#id8" id="id22">[1]</a>, <span class="target" id="hyperlink-targets">hyperlink targets</span>, and <a class="reference external" href="http://www.python.org/">references</a>.
+footnotes <a class="footnote-reference" href="#id8" id="id22">[1]</a>, <span class="target" id="hyperlink-targets">hyperlink targets</span>, and <a class="reference external" href="http://www.python.org/">references</a>.</span>
 </pre>
 </div>
 <div class="section" id="code">
@@ -850,14 +850,14 @@
 conversions in order to get identical results with/without installed
 Pygments highlighter.)</p>
 <pre class="code python literal-block">
-print 'This is Python code.'
+<span>print 'This is Python code.'</span>
 </pre>
 <p>The <tt class="docutils literal"><span class="pre">:number-lines:</span></tt> option (with optional start value) generates line
 numbers:</p>
 <pre class="code python literal-block">
-<span class="ln"> 8 </span># print integers from 0 to 9:
+<span><span class="ln"> 8 </span># print integers from 0 to 9:
 <span class="ln"> 9 </span>for i in range(10):
-<span class="ln">10 </span>    print i
+<span class="ln">10 </span>    print i</span>
 </pre>
 <p>For inline code snippets, there is the <cite>code</cite> role, which can be used
 directly (the code will not be parsed/tagged, as the language is not known)
@@ -868,8 +868,8 @@
 <p>The <tt class="docutils literal">:code:</tt> option of the <cite>include</cite> directive sets the included content
 as a code block, here the rst file <tt class="docutils literal">header_footer.txt</tt> with line numbers:</p>
 <pre class="code rst literal-block">
-<span class="ln">1 </span>.. header:: Document header
-<span class="ln">2 </span>.. footer:: Document footer
+<span><span class="ln">1 </span>.. header:: Document header
+<span class="ln">2 </span>.. footer:: Document footer</span>
 </pre>
 </div>
 </div>
@@ -1075,12 +1075,12 @@
 <p>The following works in most browsers but does not validate
 (<tt class="docutils literal">&lt;style&gt;</tt> is only allowed in the document head):</p>
 <pre class="literal-block">
-.. raw:: html
+<span>.. raw:: html
 
   &lt;style type=&quot;text/css&quot;&gt;&lt;!--
    .green {color: green;}
    .sc {font-variant: small-caps;}
-   --&gt;&lt;/style&gt;
+   --&gt;&lt;/style&gt;</span>
 </pre>
 <p><span class="green sc" lang="en-gb">British colourful text in small-caps</span>.</p>
 </li>
@@ -1098,9 +1098,9 @@
 <ol class="loweralpha">
 <li><p class="first">The SVG image itself, e.g. fixed-size vs. scaling:</p>
 <pre class="literal-block">
-width=&quot;280&quot;              viewBox=&quot;0 0 280 27&quot;
+<span>width=&quot;280&quot;              viewBox=&quot;0 0 280 27&quot;
 height=&quot;27&quot;              width=&quot;100%&quot;
-                         height=&quot;100%&quot;
+                         height=&quot;100%&quot;</span>
 </pre>
 </li>
 <li><p class="first">The method used to put the image in the document.</p>

Modified: trunk/docutils/test/functional/expected/standalone_rst_xhtml11.xhtml
===================================================================
--- trunk/docutils/test/functional/expected/standalone_rst_xhtml11.xhtml	2015-03-23 08:18:25 UTC (rev 7854)
+++ trunk/docutils/test/functional/expected/standalone_rst_xhtml11.xhtml	2015-03-26 13:38:51 UTC (rev 7855)
@@ -351,14 +351,14 @@
 <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 (&quot;::&quot;) at the end of
 the preceding paragraph (over there <span class="docutils literal"><span class="pre">--&gt;</span></span>).  They can be indented:</p>
-<pre class="literal-block">if literal_block:
+<pre class="literal-block"><span>if literal_block:
     text = 'is left as-is'
     spaces_and_linebreaks = 'are preserved'
-    markup_processing = None</pre>
+    markup_processing = None</span></pre>
 <p>Or they can be quoted without indentation:</p>
-<pre class="literal-block">&gt;&gt; Great idea!
+<pre class="literal-block"><span>&gt;&gt; Great idea!
 &gt;
-&gt; Why didn't I think of that?</pre>
+&gt; Why didn't I think of that?</span></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>
@@ -756,15 +756,15 @@
 <p>Another compound statement:</p>
 <div class="compound">
 <p class="compound-first">Compound 2, a literal block:</p>
-<pre class="compound-middle literal-block">Compound 2, literal.</pre>
+<pre class="compound-middle literal-block"><span>Compound 2, literal.</span></pre>
 <p class="compound-last">Compound 2, this is a test.</p>
 </div>
 <div class="compound">
 <p>Compound 3, only consisting of one paragraph.</p>
 </div>
 <div class="compound">
-<pre class="compound-first literal-block">Compound 4.
-This one starts with a literal block.</pre>
+<pre class="compound-first literal-block"><span>Compound 4.
+This one starts with a literal block.</span></pre>
 <p class="compound-last">Compound 4, a paragraph.</p>
 </div>
 <p>Now something <em>really</em> perverted -- a nested compound block.  This is
@@ -809,14 +809,14 @@
 </div>
 <div class="section" id="parsed-literal-blocks">
 <h3><a class="toc-backref" href="#id95"><span class="sectnum">2.14.8</span> Parsed Literal Blocks</a></h3>
-<pre class="literal-block">This is a parsed literal block.
+<pre class="literal-block"><span>This is a parsed literal block.
     This line is indented.  The next line is blank.
 
 Inline markup is supported, e.g. <em>emphasis</em>, <strong>strong</strong>, <span class="docutils literal">literal
 text</span>, <sub>sub-</sub> and <sup>super</sup>scripts,
 inline formulas: <math xmlns="http://www.w3.org/1998/Math/MathML">
 <mrow><mi>A</mi><mo>=</mo><mn>2</mn><mi>π</mi><msup><mi>r</mi><mn>2</mn></msup></mrow></math>,
-footnotes <a class="footnote-reference" href="#id8" id="id22">[1]</a>, <span class="target" id="hyperlink-targets">hyperlink targets</span>, and <a class="reference external" href="http://www.python.org/">references</a>.</pre>
+footnotes <a class="footnote-reference" href="#id8" id="id22">[1]</a>, <span class="target" id="hyperlink-targets">hyperlink targets</span>, and <a class="reference external" href="http://www.python.org/">references</a>.</span></pre>
 </div>
 <div class="section" id="code">
 <h3><a class="toc-backref" href="#id96"><span class="sectnum">2.14.9</span> Code</a></h3>
@@ -1046,12 +1046,12 @@
 <li><p>A role with multiple class attributes, styled with raw directives:</p>
 <p>The following works in most browsers but does not validate
 (<span class="docutils literal">&lt;style&gt;</span> is only allowed in the document head):</p>
-<pre class="literal-block">.. raw:: html
+<pre class="literal-block"><span>.. raw:: html
 
   &lt;style type=&quot;text/css&quot;&gt;&lt;!--
    .green {color: green;}
    .sc {font-variant: small-caps;}
-   --&gt;&lt;/style&gt;</pre>
+   --&gt;&lt;/style&gt;</span></pre>
 <p><span class="green sc" xml:lang="en-gb">British colourful text in small-caps</span>.</p>
 </li>
 </ul>
@@ -1066,9 +1066,9 @@
 <p>Rendering behaviour varies, depending on</p>
 <ol class="loweralpha">
 <li><p>The SVG image itself, e.g. fixed-size vs. scaling:</p>
-<pre class="literal-block">width=&quot;280&quot;              viewBox=&quot;0 0 280 27&quot;
+<pre class="literal-block"><span>width=&quot;280&quot;              viewBox=&quot;0 0 280 27&quot;
 height=&quot;27&quot;              width=&quot;100%&quot;
-                         height=&quot;100%&quot;</pre>
+                         height=&quot;100%&quot;</span></pre>
 </li>
 <li><p>The method used to put the image in the document.</p>
 <p>For HTML, there are several alternatives including:</p>
@@ -1235,7 +1235,7 @@
 <dd><p>of the field name width is possible with CSS instead
 of the <cite>field-name-limit</cite> configuration setting, for
 example:</p>
-<pre class="literal-block">dl.field-list &gt; dd { margin-left: 6em; }</pre>
+<pre class="literal-block"><span>dl.field-list &gt; dd { margin-left: 6em; }</span></pre>
 </dd>
 </dl>
 <div class="section" id="styling-with-class-arguments">

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





Thread: [Docutils-checkins] SF.net SVN: docutils:[7855] trunk/docutils (Page 7)

docutils-checkins