|
|
@@ -0,0 +1,136 @@
|
|
|
+#!/usr/bin/env python
|
|
|
+# -*- coding: utf-8 -*-
|
|
|
+
|
|
|
+############################################################################
|
|
|
+#
|
|
|
+# MODULE: build_graphical_index
|
|
|
+# AUTHOR(S): Vaclav Petras <wenzeslaus gmail com>
|
|
|
+# PURPOSE: Build index from images from all HTML files
|
|
|
+# COPYRIGHT: (C) 2015 by Vaclav Petras 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 os
|
|
|
+import sys
|
|
|
+import fnmatch
|
|
|
+import re
|
|
|
+
|
|
|
+from build_html import write_html_footer, grass_version, header1_tmpl
|
|
|
+
|
|
|
+
|
|
|
+output_name = 'graphical_index.html'
|
|
|
+
|
|
|
+img_extensions = ['png', 'jpg', 'gif']
|
|
|
+img_patterns = ['*.' + extension for extension in img_extensions]
|
|
|
+
|
|
|
+# we don't want some images to show up
|
|
|
+# logos
|
|
|
+img_blacklist = ['grass_logo.png', 'grass_icon.png']
|
|
|
+# circles with numbers from helptext.html (unfortunate we have to list it here)
|
|
|
+# perhaps some general name ending would be good, like *_noindex.png
|
|
|
+img_blacklist.extend(['circle_{}.png'.format(num) for num in range(1, 6)])
|
|
|
+
|
|
|
+year = os.getenv("VERSION_DATE")
|
|
|
+
|
|
|
+# other similar strings are in a different file
|
|
|
+# TODO: all HTML manual building needs refactoring (perhaps grass.tools?)
|
|
|
+header_graphical_index_tmpl = """\
|
|
|
+<link rel="stylesheet" href="grassdocs.css" type="text/css">
|
|
|
+<style>
|
|
|
+img.linkimg {
|
|
|
+ max-width: 20%;
|
|
|
+ padding: 1%;
|
|
|
+}
|
|
|
+img.linkimg:hover {
|
|
|
+ background-color: #eee;
|
|
|
+}
|
|
|
+</style>
|
|
|
+</head>
|
|
|
+<body style="width: 99%">
|
|
|
+<div id="container">
|
|
|
+
|
|
|
+<a href="index.html"><img src="grass_logo.png" alt="GRASS logo"></a>
|
|
|
+<hr class="header">
|
|
|
+<h2>Graphical index of GRASS GIS modules</h2>
|
|
|
+"""
|
|
|
+
|
|
|
+
|
|
|
+def img_in_html(filename, imagename):
|
|
|
+ # for some reason, calling search just once is much faster
|
|
|
+ # than calling it on every line (time is spent in _compile)
|
|
|
+ pattern = re.compile('<img .*src=.{}.*>'.format(imagename))
|
|
|
+ with open(filename) as file:
|
|
|
+ if re.search(pattern, file.read()):
|
|
|
+ return True
|
|
|
+ return False
|
|
|
+
|
|
|
+
|
|
|
+def file_matches(filename, patterns):
|
|
|
+ for pattern in patterns:
|
|
|
+ if fnmatch.fnmatch(filename, pattern):
|
|
|
+ return True
|
|
|
+ return False
|
|
|
+
|
|
|
+
|
|
|
+def get_files(directory, patterns, exclude_name):
|
|
|
+ files = []
|
|
|
+ for filename in os.listdir(directory):
|
|
|
+ if file_matches(filename, patterns):
|
|
|
+ if filename != exclude_name:
|
|
|
+ files.append(filename)
|
|
|
+ return files
|
|
|
+
|
|
|
+
|
|
|
+def title_form_names(html_name, img_name):
|
|
|
+ # we ignore the possibility of having extension at the end of image
|
|
|
+ # so possibly r.out.png fails but image name should use _ anyway
|
|
|
+ # strictly speaking, it could be also, e.g., index name
|
|
|
+ module_name = html_name.replace('.html', '')
|
|
|
+ for extension in img_extensions:
|
|
|
+ img_name = img_name.replace('.' + extension, '')
|
|
|
+ img_name = img_name.replace(module_name.replace('.', '_'), '') # using _
|
|
|
+ img_name = img_name.replace(module_name.replace('.', ''), '') # using nothing
|
|
|
+ img_name = img_name.replace(module_name, '') # using original dots
|
|
|
+ img_name = img_name.replace('_', ' ')
|
|
|
+ img_name = img_name.strip()
|
|
|
+ if img_name:
|
|
|
+ return "{name} ({desc})".format(name=module_name, desc=img_name)
|
|
|
+ else:
|
|
|
+ return "{name}".format(name=module_name)
|
|
|
+
|
|
|
+
|
|
|
+def main():
|
|
|
+ html_dir = sys.argv[1]
|
|
|
+
|
|
|
+ html_files = get_files(html_dir, ['*.html'], output_name)
|
|
|
+ img_html_files = {}
|
|
|
+
|
|
|
+ for filename in os.listdir(html_dir):
|
|
|
+ if filename in img_blacklist:
|
|
|
+ continue
|
|
|
+ if file_matches(filename, img_patterns):
|
|
|
+ for html_file in html_files:
|
|
|
+ if img_in_html(os.path.join(html_dir, html_file), filename):
|
|
|
+ img_html_files[filename] = html_file
|
|
|
+ # for now suppose one image per html
|
|
|
+
|
|
|
+ with open(os.path.join(html_dir, output_name), 'w') as output:
|
|
|
+ output.write(header1_tmpl.substitute(title="GRASS GIS %s Reference "
|
|
|
+ "Manual: Graphical index" % grass_version))
|
|
|
+ output.write(header_graphical_index_tmpl)
|
|
|
+ for image, html_file in img_html_files.iteritems():
|
|
|
+ title = title_form_names(html_file, image)
|
|
|
+ output.write(
|
|
|
+ '<a href="{html}" title="{title}">'
|
|
|
+ '<img class="linkimg" src="{img}">'
|
|
|
+ '</a>'
|
|
|
+ .format(html=html_file, img=image, title=title))
|
|
|
+ write_html_footer(output, "index.html", year)
|
|
|
+
|
|
|
+
|
|
|
+if __name__ == '__main__':
|
|
|
+ main()
|
Vaclav Petras