From 5f7832d125fff511a7b51111c3f8cb43d1887867 Mon Sep 17 00:00:00 2001 From: Fred Drake Date: Thu, 4 Mar 1999 21:19:57 +0000 Subject: [PATCH] Allow many more aspects of the generated page to be parameterized, and add a useful usage message. Use 'mkmodindex --help' to display it. --- Doc/tools/mkmodindex | 179 ++++++++++++++++++++++++++++--------------- 1 file changed, 116 insertions(+), 63 deletions(-) diff --git a/Doc/tools/mkmodindex b/Doc/tools/mkmodindex index 16aa109e656..20c6416abd1 100755 --- a/Doc/tools/mkmodindex +++ b/Doc/tools/mkmodindex @@ -1,6 +1,30 @@ #! /usr/bin/env python # -*- Python -*- +"""usage: %(program)s [options] file... + +Supported options: + + --address addr + -a addr Set the address text to include at the end of the generated + HTML; this should be used for contact information. + --columns cols + -c cols Set the number of columns each index section should be + displayed in. The default is 1. + --help + -h Display this help message. + --letters + -l Split the output into sections by letter. + --output file + -o file Write output to 'file' instead of standard out. + --iconserver is Use 'is' as the directory containing icons for the + navigation bar. The default is 'icons'. + --title str Set the page title to 'str'. The default is 'Global + Module Index'. + --uplink url Set the upward link URL. The default is './'. + --uptitle str Set the upward link title. The default is 'Python + Documentation Index'. +""" import buildindex import getopt import os @@ -9,6 +33,19 @@ import string import sys +def usage(): + program = os.path.basename(sys.argv[0]) + print __doc__ % {"program": program} + + +def error(msg, rc=2): + sys.stdout = sys.stderr + print msg + print + usage() + sys.exit(rc) + + _rx = re.compile( '
' '([a-zA-Z_][a-zA-Z0-9_.]*(\s*\(.*\))?)') @@ -17,15 +54,53 @@ def main(): outputfile = "-" columns = 1 letters = 0 - opts, args = getopt.getopt(sys.argv[1:], "c:lo:", - ["columns=", "letters", "output="]) + uplink = "./" + uptitle = "Python Documentation Index" + variables = {"address": "", + "iconserver": "icons", + "imgtype": "gif", + "title": "Global Module Index", + "uplinkalt": "up", + "uplinkicon": "up", + } + try: + opts, args = getopt.getopt(sys.argv[1:], "a:c:hlo:", + [# script controls: + "columns=", "help", "letters", "output=", + # content components: + "address=", "iconserver=", + "title=", "uplink=", "uptitle="]) + except getopt.error, msg: + error(msg) for opt, val in opts: - if opt in ("-o", "--output"): + if opt in ("-a", "--address"): + val = string.strip(val) + variables["address"] = val and "
\n%s\n
\n" % val + elif opt in ("-h", "--help"): + usage() + sys.exit() + elif opt in ("-o", "--output"): outputfile = val elif opt in ("-c", "--columns"): columns = string.atoi(val) elif opt in ("-l", "--letters"): letters = 1 + elif opt == "--title": + variables["title"] = string.strip(val) + elif opt == "--uplink": + uplink = string.strip(val) + elif opt == "--uptitle": + uptitle = string.strip(val) + elif opt == "--iconserver": + variables["iconserver"] = string.strip(val) or "." + if uplink and uptitle: + variables["uplinkalt"] = "up" + variables["uplinkicon"] = "up" + else: + variables["uplinkalt"] = "" + variables["uplinkicon"] = "blank" + variables["uplink"] = uplink + variables["uptitle"] = uptitle if not args: args = ["-"] # @@ -62,7 +137,10 @@ def main(): # num_nodes = len(nodes) # Here's the HTML generation: - parts = [HEAD, buildindex.process_nodes(nodes, columns, letters), TAIL] + parts = [HEAD % variables, + buildindex.process_nodes(nodes, columns, letters), + TAIL % variables, + ] if has_plat_flag: parts.insert(1, PLAT_DISCUSS) html = string.join(parts, '') @@ -76,81 +154,56 @@ def main(): print "%s: %d index nodes" % (program, num_nodes) -HEAD = """\ - - - -Global Module Index - - - - - - -
- - - - - - - - - -
blankupblank - Global Module Indexblankblankblank
-Up: Python Documentation Index -
- -

Global Module Index

- -""" - PLAT_DISCUSS = """

Some module names are followed by an annotation indicating what platform they are available on.

""" -TAIL = """ +NAVIGATION = """\
-
- +
- - - + src="%(iconserver)s/blank.%(imgtype)s"> + + src="%(iconserver)s/blank.%(imgtype)s"> + + src="%(iconserver)s/blank.%(imgtype)s"> + src="%(iconserver)s/blank.%(imgtype)s"> +
blankup - Global Module Index%(uplinkalt)s + %(title)s
Up: Python Documentation Index -
- -
-
Send comments to -python-docs@python.org. -
- - + href="%(uplink)s">%(uptitle)s +
""" +HEAD = """\ + + + +Global Module Index + + + + + +""" + NAVIGATION + """\ + +

%(title)s

+ +""" + +TAIL = NAVIGATION + """\ +%(address)s + +""" if __name__ == "__main__": main()