1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
|
from lxml import etree
import re
modules = {'miareadxml' : [0, '', 'none://miareadxml.py' ]}
from miareadxml import get_text_node_simple
from miareadxml import get_dict_table
from miareadxml import make_sec_ancor
from miareadxml import xml_namespace
from miareadxml import xmlns
NSMAP={"xml" : xml_namespace }
def make_section_root_node(tag, name):
secid = make_sec_ancor("Sec", name)
section = etree.Element(tag)
section.set(xmlns + "id", secid)
section.set("xreflabel", name)
title = etree.Element("title")
title.text = name
section.append(title)
return section
def get_text_node(tag, renderas, text):
node = etree.Element(tag)
node.set("renderas", renderas)
node.text = text
return node
def get_bridgehead(text):
return get_text_node("bridgehead", "sect3", text)
def get_synopsis(program):
synopsis = etree.Element("cmdsynopsis")
synopsis.append(get_text_node_simple("command", program.name))
# add required options
for g in program.option_groups:
for o in g.options:
if o.required:
node = etree.Element("arg", choice="req")
node.text = "-" + o.short + " "
node.append(get_text_node_simple("replaceable", o.type))
synopsis.append(node)
# add standard option hint
node = etree.SubElement(synopsis, "arg", rep="repeat")
node.append(get_text_node_simple("replaceable", "options"))
#add free parameter if exists
if not program.FreeParams is None:
node = etree.SubElement(synopsis, "arg", rep="repeat")
plugin = etree.SubElement(node, "replaceable")
etree.SubElement(plugin, "xref", linkend=make_sec_ancor("SecPlugintype", program.FreeParams))
return synopsis
def get_option_descr(option):
entry = etree.Element("varlistentry")
option.write_xml(entry)
return entry
def get_program(program):
section = make_section_root_node("section", program.name)
section.append(get_bridgehead("Sysnopis:"))
section.append(get_synopsis(program))
section.append(get_bridgehead("Description:"))
section.append(get_text_node_simple("para", program.description))
section.append(get_bridgehead("Options:"))
for g in program.option_groups:
if len(g.name) > 0:
section.append(get_bridgehead(g.name))
if len(g.options) > 0:
varlist = etree.Element("variablelist", spacing="compact")
for o in g.options:
varlist.append(get_option_descr(o))
section.append(varlist)
if not program.Example is None:
if not program.Example.text is None:
section.append(get_bridgehead("Example:"))
section.append(get_text_node_simple("para", program.Example.text))
for c in program.Example.code:
if not c.text is None:
screen = etree.SubElement(section, "screen")
screen.text = program.name + " " + c.text
else:
print "Warning: %s doesn't provide example text" % (program.name)
else:
print "Warning: %s doesn't provide an example" % (program.name)
section.append(get_bridgehead("Author(s):"))
section.append(get_text_node_simple("para", program.author))
return section
def translate_descr(section, description):
descrpara = etree.SubElement(section, "para", role="sectiondescr")
for d in description:
para = etree.SubElement(descrpara, "para", role="sectiondescr")
para.text = d.text
for l in d.iter("link"):
link = etree.SubElement(para, "xref", linkend=make_sec_ancor(l.get("key"), l.text))
link.tail = l.tail
return descrpara
def get_section(name, sect):
section = make_section_root_node("section", name)
if sect.description is not None:
descr = translate_descr(section, sect.description)
else:
print "Warning: Section ", name, " doesn't have a description"
para = etree.SubElement(section, "para", role="sectiontoc")
sect = sorted(sect.programs, key=lambda p: p.name )
for program in sect:
subpara = etree.SubElement(para, "para", role="sectiontoc")
etree.SubElement(subpara, "xref", linkend=program.anchor)
descr = etree.SubElement(subpara, "para", role="progdescr")
descr.text = program.description
section.append(get_program(program))
return section
def get_plugin(plugin):
result = etree.Element("para", role="plugin")
plugin.write_xml(result)
return result
def get_plugins(name, handler):
# print name
section = make_section_root_node("section", "Plugin type: " + name)
para = etree.SubElement(section, "para", role="plugdescr")
para.text = handler.description
head = get_bridgehead("Plugins:")
section.append(head)
plugshort = etree.SubElement(section, "para", role="pluginlist")
for p in handler.plugins:
etree.SubElement(plugshort, "xref", linkend=p.ancor, endterm=p.altancor )
section.append(get_plugin(p))
head = get_bridgehead("Plugin consumers:")
section.append(head)
para = etree.SubElement(section, "para", role="consumer")
handler_users = []
for u in handler.users:
handler_users.append(u)
handler_users.sort()
for u in handler_users:
etree.SubElement(para, "xref", linkend=u)
return section
|
