/usr/lib/grass70/tools/mkhtml.py is in grass-dev 7.0.3-1build1.
This file is owned by root:root, with mode 0o755.
The actual contents of the file can be viewed below.
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 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 | #!/usr/bin/env python
############################################################################
#
# MODULE: Builds manual pages
# AUTHOR(S): Markus Neteler
# Glynn Clements
# Martin Landa <landa.martin gmail.com>
# PURPOSE: Create HTML manual page snippets
# COPYRIGHT: (C) 2007-2014 by Glynn Clements
# and the GRASS Development Team
#
# This program is free software under the GNU General
# Public License (>=v2). Read the file COPYING that
# comes with GRASS for details.
#
#############################################################################
import sys
import os
import string
import re
from datetime import datetime
from HTMLParser import HTMLParser
pgm = sys.argv[1]
src_file = "%s.html" % pgm
tmp_file = "%s.tmp.html" % pgm
header_base = """<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>GRASS GIS Manual: ${PGM}</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link rel="stylesheet" href="grassdocs.css" type="text/css">
</head>
<body bgcolor="white">
<div id="container">
<a href="index.html"><img src="grass_logo.png" alt="GRASS logo"></a>
<hr class="header">
"""
header_nopgm = """<h2>${PGM}</h2>
"""
header_pgm = """<h2>NAME</h2>
<em><b>${PGM}</b></em>
"""
header_pgm_desc = """<h2>NAME</h2>
<em><b>${PGM}</b></em> - ${PGM_DESC}
"""
footer_index = string.Template(\
"""<hr class="header">
<p>
<a href="index.html">Main index</a> |
<a href="${INDEXNAME}.html">${INDEXNAMECAP} index</a> |
<a href="topics.html">Topics index</a> |
<a href="keywords.html">Keywords index</a> |
<a href="full_index.html">Full index</a>
</p>
<p>
© 2003-${YEAR}
<a href="http://grass.osgeo.org">GRASS Development Team</a>,
GRASS GIS ${GRASS_VERSION} Reference Manual
</p>
</div>
</body>
</html>
""")
footer_noindex = string.Template(\
"""<hr class="header">
<p>
<a href="index.html">Main index</a> |
<a href="topics.html">Topics index</a> |
<a href="keywords.html">Keywords index</a> |
<a href="full_index.html">Full index</a>
</p>
<p>
© 2003-${YEAR}
<a href="http://grass.osgeo.org">GRASS Development Team</a>,
GRASS GIS ${GRASS_VERSION} Reference Manual
</p>
</div>
</body>
</html>
""")
def read_file(name):
try:
f = open(name, 'rb')
s = f.read()
f.close()
return s
except IOError:
return ""
def create_toc(src_data):
class MyHTMLParser(HTMLParser):
def __init__(self):
self.reset()
self.idx = 1
self.tag_curr = ''
self.tag_last = ''
self.process_text = False
self.data = []
self.tags_allowed = ('h1', 'h2', 'h3')
self.tags_ignored = ('img')
self.text = ''
def handle_starttag(self, tag, attrs):
if tag in self.tags_allowed:
self.process_text = True
self.tag_last = self.tag_curr
self.tag_curr = tag
def handle_endtag(self, tag):
if tag in self.tags_allowed:
self.data.append((tag, '%s_%d' % (tag, self.idx),
self.text))
self.idx += 1
self.process_text = False
self.text = ''
self.tag_curr = self.tag_last
def handle_data(self, data):
if not self.process_text:
return
if self.tag_curr in self.tags_allowed or self.tag_curr in self.tags_ignored:
self.text += data
else:
self.text += '<%s>%s</%s>' % (self.tag_curr, data, self.tag_curr)
# instantiate the parser and fed it some HTML
parser = MyHTMLParser()
parser.feed(src_data)
return parser.data
def escape_href(label):
# remove html tags
label = re.sub('<[^<]+?>', '', label)
# fix
label = label.replace(' ', '')
# fix "
label = label.replace('"', '')
# replace space with underscore + lower
return label.replace(' ', '-').lower()
def write_toc(data):
if not data:
return
fd = sys.stdout
fd.write('<div class="toc">\n')
fd.write('<h4 class="toc">Table of contents</h4>\n')
fd.write('<ul class="toc">\n')
first = True
has_h2 = False
in_h3 = False
indent = 4
for tag, href, text in data:
if tag == 'h3' and not in_h3 and has_h2:
fd.write('\n%s<ul class="toc">\n' % (' ' * indent))
indent += 4
in_h3 = True
elif not first:
fd.write('</li>\n')
if tag == 'h2':
has_h2 = True
if in_h3:
indent -= 4
fd.write('%s</ul></li>\n' % (' ' * indent))
in_h3 = False
fd.write('%s<li class="toc"><a href="#%s" class="toc">%s</a>' % \
(' ' * indent, escape_href(text), text))
first = False
fd.write('</li>\n</ul>\n')
fd.write('</div>\n')
def update_toc(data):
ret_data = []
pat = re.compile(r'(<(h[2|3])>)(.+)(</h[2|3]>)')
idx = 1
for line in data.splitlines():
if pat.search(line):
xline = pat.split(line)
line = xline[1] + '<a name="%s">' % escape_href(xline[3]) + xline[3] + '</a>' + xline[4]
idx += 1
ret_data.append(line)
return '\n'.join(ret_data)
# process header
src_data = read_file(src_file)
name = re.search('(<!-- meta page name:)(.*)(-->)', src_data, re.IGNORECASE)
pgm_desc = None
if name:
pgm = name.group(2).strip().split('-', 1)[0].strip()
name_desc = re.search('(<!-- meta page name description:)(.*)(-->)', src_data, re.IGNORECASE)
if name_desc:
pgm_desc = name_desc.group(2).strip()
desc = re.search('(<!-- meta page description:)(.*)(-->)', src_data,
re.IGNORECASE)
if desc:
pgm = desc.group(2).strip()
header_tmpl = string.Template(header_base + header_nopgm)
else:
if not pgm_desc:
header_tmpl = string.Template(header_base + header_pgm)
else:
header_tmpl = string.Template(header_base + header_pgm_desc)
if not re.search('<html>', src_data, re.IGNORECASE):
tmp_data = read_file(tmp_file)
if not re.search('<html>', tmp_data, re.IGNORECASE):
sys.stdout.write(header_tmpl.substitute(PGM=pgm, PGM_DESC=pgm_desc))
if tmp_data:
for line in tmp_data.splitlines(True):
if not re.search('</body>|</html>', line, re.IGNORECASE):
sys.stdout.write(line)
# create TOC
write_toc(create_toc(src_data))
# process body
sys.stdout.write(update_toc(src_data))
# if </html> is found, suppose a complete html is provided.
# otherwise, generate module class reference:
if re.search('</html>', src_data, re.IGNORECASE):
sys.exit()
index_names = {
'd' : 'display',
'db': 'database',
'g' : 'general',
'i' : 'imagery',
'm' : 'misc',
'ps': 'postscript',
'p' : 'paint',
'r' : 'raster',
'r3': 'raster3d',
's' : 'sites',
't' : 'temporal',
'v' : 'vector'
}
def to_title(name):
"""Convert name of command class/family to form suitable for title"""
return name.capitalize()
index_titles = {}
for key, name in index_names.iteritems():
if key == 'r3':
index_titles[key] = '3D raster'
else:
index_titles[key] = to_title(name)
# process footer
index = re.search('(<!-- meta page index:)(.*)(-->)', src_data, re.IGNORECASE)
if index:
index_name = index.group(2).strip()
if '|' in index_name:
index_name, index_name_cap = index_name.split('|', 1)
else:
index_name_cap = index_name
else:
mod_class = pgm.split('.', 1)[0]
index_name = index_names.get(mod_class, '')
index_name_cap = index_titles.get(mod_class, '')
grass_version = os.getenv("VERSION_NUMBER", "unknown")
year = os.getenv("VERSION_DATE")
if not year:
year = str(datetime.now().year)
if index_name:
sys.stdout.write(footer_index.substitute(INDEXNAME=index_name,
INDEXNAMECAP=index_name_cap,
YEAR=year,
GRASS_VERSION=grass_version))
else:
sys.stdout.write(footer_noindex.substitute(YEAR=year,
GRASS_VERSION=grass_version))
|