mir/ovs
2
0
Fork 0
mirror of https://github.com/openvswitch/ovs synced 2025-09-04 16:25:17 +00:00
Code Issues Releases Wiki Activity

nroff: Support inline XML inside <pre> blocks.

Browse Source 
This is useful so that one can write, e.g.

<p>The following shows how to add 1 to variable <var>x</var>:</p>
<pre>
<var>x</var> = <var>x</var> + 1;
</pre>

Signed-off-by: Ben Pfaff <blp@nicira.com>
Acked-by: Justin Pettit <jpettit@nicira.com>
This commit is contained in:
Ben Pfaff
2015-09-29 16:53:44 -07:00
parent a634c5317a
commit 41f17e52e0
1 changed files with 14 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
python/build/nroff.py
View File

@@ -58,17 +58,18 @@ def text_to_nroff(s, font=r'\fR'):
def escape_nroff_literal(s, font=r'\fB'): def escape_nroff_literal(s, font=r'\fB'):
return font + r'%s\fR' % text_to_nroff(s, font) return font + r'%s\fR' % text_to_nroff(s, font)
def inline_xml_to_nroff(node, font, to_upper=False): def inline_xml_to_nroff(node, font, to_upper=False, newline='\n'):
if node.nodeType == node.TEXT_NODE: if node.nodeType == node.TEXT_NODE:
if to_upper: if to_upper:
return text_to_nroff(node.data.upper(), font) s = text_to_nroff(node.data.upper(), font)
else: else:
return text_to_nroff(node.data, font) s = text_to_nroff(node.data, font)
return s.replace('\n', newline)
elif node.nodeType == node.ELEMENT_NODE: elif node.nodeType == node.ELEMENT_NODE:
if node.tagName in ['code', 'em', 'option', 'env']: if node.tagName in ['code', 'em', 'option', 'env']:
s = r'\fB' s = r'\fB'
for child in node.childNodes: for child in node.childNodes:
s += inline_xml_to_nroff(child, r'\fB') s += inline_xml_to_nroff(child, r'\fB', to_upper, newline)
return s + font return s + font
elif node.tagName == 'ref': elif node.tagName == 'ref':
s = r'\fB' s = r'\fB'
@@ -88,22 +89,23 @@ def inline_xml_to_nroff(node, font, to_upper=False):
elif node.tagName == 'var' or node.tagName == 'dfn': elif node.tagName == 'var' or node.tagName == 'dfn':
s = r'\fI' s = r'\fI'
for child in node.childNodes: for child in node.childNodes:
s += inline_xml_to_nroff(child, r'\fI') s += inline_xml_to_nroff(child, r'\fI', to_upper, newline)
return s + font return s + font
else: else:
raise error.Error("element <%s> unknown or invalid here" % node.tagName) raise error.Error("element <%s> unknown or invalid here" % node.tagName)
elif node.nodeType == node.COMMENT_NODE:
return ''
else: else:
raise error.Error("unknown node %s in inline xml" % node) raise error.Error("unknown node %s in inline xml" % node)
def pre_to_nroff(nodes, para, font): def pre_to_nroff(nodes, para, font):
s = para + '\n.nf\n' # This puts 'font' at the beginning of each line so that leading and
# trailing whitespace stripping later doesn't removed leading spaces
# from preformatted text.
s = para + '\n.nf\n' + font
for node in nodes: for node in nodes:
if node.nodeType == node.TEXT_NODE: s += inline_xml_to_nroff(node, font, False, '\n.br\n' + font)
for line in node.data.split('\n'): s += '\n.fi\n'
s += escape_nroff_literal(line, font) + '\n.br\n'
elif node.nodeType != node.COMMENT_NODE:
fatal("<pre> element may only have text children")
s += '.fi\n'
return s return s
def diagram_header_to_nroff(header_node): def diagram_header_to_nroff(header_node):