summaryrefslogtreecommitdiffstats
path: root/Doc/perl/l2hinit.perl
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>2001-01-09 22:02:10 (GMT)
committerFred Drake <fdrake@acm.org>2001-01-09 22:02:10 (GMT)
commit42181dba8ecf9736ae0ec2384aa4307533c835e1 (patch)
tree957090d36ed7fea73d8aff5a392c80bcb5fe25f5 /Doc/perl/l2hinit.perl
parente07d5cf9663c69d4656249df65543fdca7d6966c (diff)
downloadcpython-42181dba8ecf9736ae0ec2384aa4307533c835e1.zip
cpython-42181dba8ecf9736ae0ec2384aa4307533c835e1.tar.gz
cpython-42181dba8ecf9736ae0ec2384aa4307533c835e1.tar.bz2
Added a --global-module-index option to specify a (possibly relative) URL
to the Global Module Index for a set of documents. This is used to include a reference to the global index from the per-document module indexes, so that it is just a little easier to find. (Someone suggested this, but I do not remember who. Please let me know if it was you -- thanks!)
Diffstat (limited to 'Doc/perl/l2hinit.perl')
-rw-r--r--Doc/perl/l2hinit.perl10
1 files changed, 10 insertions, 0 deletions
diff --git a/Doc/perl/l2hinit.perl b/Doc/perl/l2hinit.perl
index 4ffcc58..d3720d9 100644
--- a/Doc/perl/l2hinit.perl
+++ b/Doc/perl/l2hinit.perl
@@ -332,6 +332,16 @@ sub add_module_idx {
. "<tt class='module'>$key</tt>$plat###\n";
}
close(MODIDXFILE);
+
+ if ($GLOBAL_MODULE_INDEX) {
+ $prefix = <<MODULE_INDEX_PREFIX;
+
+<p> This index only lists modules documented in this manual.
+ The <em class="citetitle"><a href="$GLOBAL_MODULE_INDEX">Global Module
+ Index</a></em> lists all modules that are documented in this set
+ of manuals.</p>
+MODULE_INDEX_PREFIX
+ }
if (!$allthesame) {
$prefix .= <<PLAT_DISCUSS;