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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
#
# FILE $Id: HTMLFormatter.py,v 1.6 1998/02/04 20:13:19 dlarsson Exp $
#
# DESCRIPTION Formatters for MIF and HTML manual formats.
#
# AUTHOR SEISY/LKSB Daniel Larsson
#
# Permission to use, copy, modify, and distribute this software and its
# documentation for any purpose and without fee is hereby granted,
# provided that the above copyright notice appear in all copies and that
# both that copyright notice and this permission notice appear in
# supporting documentation, and that the name of ABB Industrial Systems
# not be used in advertising or publicity pertaining to
# distribution of the software without specific, written prior permission.
#
# ABB INDUSTRIAL SYSTEMS DISCLAIMS ALL WARRANTIES WITH REGARD TO
# THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
# FITNESS, IN NO EVENT SHALL ABB INDUSTRIAL SYSTEMS BE LIABLE
# FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
# OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
#
# Copyright (C) ABB Industrial Systems AB, 1996
# Unpublished work. All Rights Reserved.
#
# HISTORY:
# $Log: HTMLFormatter.py,v $
# Revision 1.6 1998/02/04 20:13:19 dlarsson
# Fixed definition list rendering.
# Removed " from _escape_chars, since it made links not working.
# Hopefully this is ok (HTMLgen doesn't escape " either).
#
# Revision 1.5 1998/02/04 19:15:57 dlarsson
# Removed the obsolete routine 'render_ordered_list'
#
# Revision 1.4 1998/02/04 18:19:58 dlarsson
# Removed ni features.
#
# Revision 1.3 1997/01/23 20:42:11 omfadmin
# Fixed nested lists.
#
# Revision 1.2 1996/07/08 05:32:13 omfadmin
# Added dummy render_navigation.
#
# Revision 1.1 1996/06/24 10:07:57 omfadmin
# Initial revision
#
#
__author__ = "Daniel Larsson"
__version__ = "$Revision: 1.6 $"
import time
import regsub
# Rename imported objects.
# The underscore is to hide the names
_gsub = regsub.gsub
# Header and footer for HTML pages
_HTML_HEADER = """<HTML>
<HEADER>
<TITLE>%s</TITLE>
</HEADER>
<BODY>
<H1>%s</H1>
"""
_HTML_FOOTER = """
<HR>
<ADDRESS>Generated by HTMLFormatter at %s</ADDRESS>
</BODY>
</HTML>
""" % time.asctime(time.localtime(time.time()))
def _wrap(tag, txt):
return '<%s>%s</%s>' % (tag, txt, tag)
_escape_chars = {
'&': '&', # This one must come first!!!
'<': '<',
'>': '>'
}
class HTML:
"""Manual formatter generating HTML files."""
file_ext = '.html'
def __init__(self):
"""Initialize object."""
self._text_ = ''
def _add_(self, txt):
self._text_ = self._text_ + txt
def render_title(self, manpage, title, marker):
"Write document title"
self._add_(_HTML_HEADER % (title, title))
def render_navigation(self, top, prev, next):
"""Render navigation buttons.
~top~, ~prev~ and ~next~ are ManualPage instances."""
pass
def render_section(self, manpage, lvl, section, marker):
"Print the section 'section'"
code = 'H%d' % (lvl+1)
code = _wrap(code, section)
if marker:
code = '<A NAME="%s">%s</A>' % (section, code)
self._add_(code+'\n')
def render_paragraph(self, manpage, para):
"Print a paragraph"
self._add_(_wrap('P', _gsub('\n\n', '</P>\n<P>\n', para))+'\n')
def render_code(self, manpage, code):
"Print code"
self._add_(_wrap('PRE', code)+'\n')
def render_list(self, manpage, list):
"Print an unordered list. 'list' is a list of strings."
def emit_list((listtype, list), recursive):
from gendoc.ManualPage import UN_LIST, OR_LIST
if listtype == UN_LIST:
tag='UL'
else:
tag='OL'
code = '<%s>\n' % tag
for i in list:
if type(i) == type(''):
code = code + '<LI>%s\n' % i
else:
code = code + recursive(i, recursive)
return code + '</%s>\n' % tag
code = emit_list(list, emit_list)
self._add_(code)
def render_deflist(self, manpage, list):
code = ''
for word, definition in list:
code = code + _wrap('DT', word)
code = code + _wrap('DD', definition)
self._add_(_wrap('DL', code))
def render_bold(self, text):
return _wrap('STRONG', text)
def render_italic(self, text):
return _wrap('EM', text)
def render_underline(self, text):
return _wrap('STRONG', text)
def render_internal_link(self, link, link_text):
return '<A HREF=#"'+link+'">'+link_text+'</A>'
def render_external_link(self, link, link_text):
import urllib
t, rest = urllib.splittype(link)
host, path = urllib.splithost(rest)
import posixpath
base = posixpath.basename(path)
root, ext = posixpath.splitext(base)
if ext == '' and base:
ext = '.html'
return '<A HREF="'+link+ext+'">'+link_text+'</A>'
def end(self):
"""Document is ready.
Returns the resulting document as a string."""
self._add_(_HTML_FOOTER)
text = self._text_
self._text_ = ''
return text
def convert_text(self, txt):
# Translate HTML special characters.
for char in _escape_chars.keys():
txt = _gsub(char, _escape_chars[char], txt)
return txt
|
