Mercurial > cpython-lru_cache-weakref

annotate Doc/perl/python.perl @ 17581:c1937faabb23 2.1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added support for optional explanation parameter to the \versionadded macro. Refactored do_cmd_versionadded() and do_cmd_versionchanged() to do most of the work in a helper function, with the do_cmd_*() wrappers just supplying a portion of the replacement text.
author Fred Drake <fdrake@acm.org>
date Wed, 18 Apr 2001 17:29:14 +0000
parents c2fb2d476bd3
children f63f749364ef
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1 # python.perl by Fred L. Drake, Jr. <fdrake@acm.org> -*- perl -*-
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
2 #
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
3 # Heavily based on Guido van Rossum's myformat.perl (now obsolete).
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
4 #
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
5 # Extension to LaTeX2HTML for documents using myformat.sty.
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
6 # Subroutines of the form do_cmd_<name> here define translations
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
7 # for LaTeX commands \<name> defined in the corresponding .sty file.
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
8
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
9 package main;
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
10
14970
6af9aa15647f make_icon_filename(): Convenience function to turn a partial filename
Fred Drake <fdrake@acm.org>
parents: 14766
diff changeset
11 use File::Basename;
6af9aa15647f make_icon_filename(): Convenience function to turn a partial filename
Fred Drake <fdrake@acm.org>
parents: 14766
diff changeset
12
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
13
9775
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
14 sub next_argument{
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
15 my $param;
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
16 $param = missing_braces()
9775
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
17 unless ((s/$next_pair_pr_rx/$param=$2;''/eo)
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
18 ||(s/$next_pair_rx/$param=$2;''/eo));
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
19 return $param;
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
20 }
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
21
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
22 sub next_optional_argument{
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
23 my($param,$rx) = ('', "^\\s*(\\[([^]]*)\\])?");
8086
692be123f547 next_optional_argument(): Don't include the square brackets in the return
Fred Drake <fdrake@acm.org>
parents: 8074
diff changeset
24 s/$rx/$param=$2;''/eo;
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
25 return $param;
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
26 }
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
27
14970
6af9aa15647f make_icon_filename(): Convenience function to turn a partial filename
Fred Drake <fdrake@acm.org>
parents: 14766
diff changeset
28 sub make_icon_filename($){
6af9aa15647f make_icon_filename(): Convenience function to turn a partial filename
Fred Drake <fdrake@acm.org>
parents: 14766
diff changeset
29 my($myname, $mydir, $myext) = fileparse(@_[0], '\..*');
6af9aa15647f make_icon_filename(): Convenience function to turn a partial filename
Fred Drake <fdrake@acm.org>
parents: 14766
diff changeset
30 chop $mydir;
6af9aa15647f make_icon_filename(): Convenience function to turn a partial filename
Fred Drake <fdrake@acm.org>
parents: 14766
diff changeset
31 if ($mydir eq '.') {
6af9aa15647f make_icon_filename(): Convenience function to turn a partial filename
Fred Drake <fdrake@acm.org>
parents: 14766
diff changeset
32 $mydir = $ICONSERVER;
6af9aa15647f make_icon_filename(): Convenience function to turn a partial filename
Fred Drake <fdrake@acm.org>
parents: 14766
diff changeset
33 }
6af9aa15647f make_icon_filename(): Convenience function to turn a partial filename
Fred Drake <fdrake@acm.org>
parents: 14766
diff changeset
34 $myext = ".$IMAGE_TYPE"
6af9aa15647f make_icon_filename(): Convenience function to turn a partial filename
Fred Drake <fdrake@acm.org>
parents: 14766
diff changeset
35 unless $myext;
6af9aa15647f make_icon_filename(): Convenience function to turn a partial filename
Fred Drake <fdrake@acm.org>
parents: 14766
diff changeset
36 return "$mydir$dd$myname$myext";
6af9aa15647f make_icon_filename(): Convenience function to turn a partial filename
Fred Drake <fdrake@acm.org>
parents: 14766
diff changeset
37 }
6af9aa15647f make_icon_filename(): Convenience function to turn a partial filename
Fred Drake <fdrake@acm.org>
parents: 14766
diff changeset
38
6af9aa15647f make_icon_filename(): Convenience function to turn a partial filename
Fred Drake <fdrake@acm.org>
parents: 14766
diff changeset
39 sub get_link_icon($){
6af9aa15647f make_icon_filename(): Convenience function to turn a partial filename
Fred Drake <fdrake@acm.org>
parents: 14766
diff changeset
40 my $url = @_[0];
6af9aa15647f make_icon_filename(): Convenience function to turn a partial filename
Fred Drake <fdrake@acm.org>
parents: 14766
diff changeset
41 if ($OFF_SITE_LINK_ICON && ($url =~ /^[-a-zA-Z0-9.]+:/)) {
6af9aa15647f make_icon_filename(): Convenience function to turn a partial filename
Fred Drake <fdrake@acm.org>
parents: 14766
diff changeset
42 # absolute URL; assume it points off-site
6af9aa15647f make_icon_filename(): Convenience function to turn a partial filename
Fred Drake <fdrake@acm.org>
parents: 14766
diff changeset
43 my $icon = make_icon_filename($OFF_SITE_LINK_ICON);
6af9aa15647f make_icon_filename(): Convenience function to turn a partial filename
Fred Drake <fdrake@acm.org>
parents: 14766
diff changeset
44 return (" <img src='$icon'\n"
14987
bbe09cccb49b $OFF_SITE_LINK_ICON: Don't define here; simply defining it overrides a
Fred Drake <fdrake@acm.org>
parents: 14970
diff changeset
45 . " border='0' class='offsitelink'"
bbe09cccb49b $OFF_SITE_LINK_ICON: Don't define here; simply defining it overrides a
Fred Drake <fdrake@acm.org>
parents: 14970
diff changeset
46 . ($OFF_SITE_LINK_ICON_HEIGHT
bbe09cccb49b $OFF_SITE_LINK_ICON: Don't define here; simply defining it overrides a
Fred Drake <fdrake@acm.org>
parents: 14970
diff changeset
47 ? " height='$OFF_SITE_LINK_ICON_HEIGHT'"
bbe09cccb49b $OFF_SITE_LINK_ICON: Don't define here; simply defining it overrides a
Fred Drake <fdrake@acm.org>
parents: 14970
diff changeset
48 : '')
bbe09cccb49b $OFF_SITE_LINK_ICON: Don't define here; simply defining it overrides a
Fred Drake <fdrake@acm.org>
parents: 14970
diff changeset
49 . ($OFF_SITE_LINK_ICON_WIDTH
bbe09cccb49b $OFF_SITE_LINK_ICON: Don't define here; simply defining it overrides a
Fred Drake <fdrake@acm.org>
parents: 14970
diff changeset
50 ? " width='$OFF_SITE_LINK_ICON_WIDTH'"
bbe09cccb49b $OFF_SITE_LINK_ICON: Don't define here; simply defining it overrides a
Fred Drake <fdrake@acm.org>
parents: 14970
diff changeset
51 : '')
bbe09cccb49b $OFF_SITE_LINK_ICON: Don't define here; simply defining it overrides a
Fred Drake <fdrake@acm.org>
parents: 14970
diff changeset
52 . " alt='[off-site link]'\n"
14970
6af9aa15647f make_icon_filename(): Convenience function to turn a partial filename
Fred Drake <fdrake@acm.org>
parents: 14766
diff changeset
53 . " >");
6af9aa15647f make_icon_filename(): Convenience function to turn a partial filename
Fred Drake <fdrake@acm.org>
parents: 14766
diff changeset
54 }
6af9aa15647f make_icon_filename(): Convenience function to turn a partial filename
Fred Drake <fdrake@acm.org>
parents: 14766
diff changeset
55 return '';
6af9aa15647f make_icon_filename(): Convenience function to turn a partial filename
Fred Drake <fdrake@acm.org>
parents: 14766
diff changeset
56 }
8344
d2d82f7b419a do_cmd_let(): Simple implementation to allow \let to be used to establish
Fred Drake <fdrake@acm.org>
parents: 8342
diff changeset
57
d2d82f7b419a do_cmd_let(): Simple implementation to allow \let to be used to establish
Fred Drake <fdrake@acm.org>
parents: 8342
diff changeset
58 # This is a fairly simple hack; it supports \let when it is used to create
d2d82f7b419a do_cmd_let(): Simple implementation to allow \let to be used to establish
Fred Drake <fdrake@acm.org>
parents: 8342
diff changeset
59 # (or redefine) a macro to exactly be some other macro: \let\newname=\oldname.
8349
4172da91441a Revise comment about \let support a little to more accurately reflect the
Fred Drake <fdrake@acm.org>
parents: 8346
diff changeset
60 # Many possible uses of \let aren't supported or aren't supported correctly.
8344
d2d82f7b419a do_cmd_let(): Simple implementation to allow \let to be used to establish
Fred Drake <fdrake@acm.org>
parents: 8342
diff changeset
61 #
d2d82f7b419a do_cmd_let(): Simple implementation to allow \let to be used to establish
Fred Drake <fdrake@acm.org>
parents: 8342
diff changeset
62 sub do_cmd_let{
d2d82f7b419a do_cmd_let(): Simple implementation to allow \let to be used to establish
Fred Drake <fdrake@acm.org>
parents: 8342
diff changeset
63 local($_) = @_;
d2d82f7b419a do_cmd_let(): Simple implementation to allow \let to be used to establish
Fred Drake <fdrake@acm.org>
parents: 8342
diff changeset
64 my $matched = 0;
8346
1b393db00b1a Extend handling for \let a bit, to also allow \let\something=<character>. We
Fred Drake <fdrake@acm.org>
parents: 8344
diff changeset
65 s/[\\]([a-zA-Z]+)\s*(=\s*)?[\\]([a-zA-Z]*)/$matched=1; ''/e;
8344
d2d82f7b419a do_cmd_let(): Simple implementation to allow \let to be used to establish
Fred Drake <fdrake@acm.org>
parents: 8342
diff changeset
66 if ($matched) {
d2d82f7b419a do_cmd_let(): Simple implementation to allow \let to be used to establish
Fred Drake <fdrake@acm.org>
parents: 8342
diff changeset
67 my($new, $old) = ($1, $3);
d2d82f7b419a do_cmd_let(): Simple implementation to allow \let to be used to establish
Fred Drake <fdrake@acm.org>
parents: 8342
diff changeset
68 eval "sub do_cmd_$new { do_cmd_$old" . '(@_); }';
d2d82f7b419a do_cmd_let(): Simple implementation to allow \let to be used to establish
Fred Drake <fdrake@acm.org>
parents: 8342
diff changeset
69 print "\ndefining handler for \\$new using \\$old\n";
d2d82f7b419a do_cmd_let(): Simple implementation to allow \let to be used to establish
Fred Drake <fdrake@acm.org>
parents: 8342
diff changeset
70 }
8346
1b393db00b1a Extend handling for \let a bit, to also allow \let\something=<character>. We
Fred Drake <fdrake@acm.org>
parents: 8344
diff changeset
71 else {
1b393db00b1a Extend handling for \let a bit, to also allow \let\something=<character>. We
Fred Drake <fdrake@acm.org>
parents: 8344
diff changeset
72 s/[\\]([a-zA-Z]+)\s*(=\s*)?([^\\])/$matched=1; ''/es;
1b393db00b1a Extend handling for \let a bit, to also allow \let\something=<character>. We
Fred Drake <fdrake@acm.org>
parents: 8344
diff changeset
73 if ($matched) {
1b393db00b1a Extend handling for \let a bit, to also allow \let\something=<character>. We
Fred Drake <fdrake@acm.org>
parents: 8344
diff changeset
74 my($new, $char) = ($1, $3);
1b393db00b1a Extend handling for \let a bit, to also allow \let\something=<character>. We
Fred Drake <fdrake@acm.org>
parents: 8344
diff changeset
75 eval "sub do_cmd_$new { \"\\$char\" . \@_[0]; }";
1b393db00b1a Extend handling for \let a bit, to also allow \let\something=<character>. We
Fred Drake <fdrake@acm.org>
parents: 8344
diff changeset
76 print "\ndefining handler for \\$new to insert '$char'\n";
1b393db00b1a Extend handling for \let a bit, to also allow \let\something=<character>. We
Fred Drake <fdrake@acm.org>
parents: 8344
diff changeset
77 }
1b393db00b1a Extend handling for \let a bit, to also allow \let\something=<character>. We
Fred Drake <fdrake@acm.org>
parents: 8344
diff changeset
78 else {
1b393db00b1a Extend handling for \let a bit, to also allow \let\something=<character>. We
Fred Drake <fdrake@acm.org>
parents: 8344
diff changeset
79 write_warnings("Could not interpret \\let construct...");
1b393db00b1a Extend handling for \let a bit, to also allow \let\something=<character>. We
Fred Drake <fdrake@acm.org>
parents: 8344
diff changeset
80 }
1b393db00b1a Extend handling for \let a bit, to also allow \let\something=<character>. We
Fred Drake <fdrake@acm.org>
parents: 8344
diff changeset
81 }
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
82 return $_;
8344
d2d82f7b419a do_cmd_let(): Simple implementation to allow \let to be used to establish
Fred Drake <fdrake@acm.org>
parents: 8342
diff changeset
83 }
d2d82f7b419a do_cmd_let(): Simple implementation to allow \let to be used to establish
Fred Drake <fdrake@acm.org>
parents: 8342
diff changeset
84
d2d82f7b419a do_cmd_let(): Simple implementation to allow \let to be used to establish
Fred Drake <fdrake@acm.org>
parents: 8342
diff changeset
85
12928
59e494c0802f do_cmd_textasciitilde(): New function.
Fred Drake <fdrake@acm.org>
parents: 12637
diff changeset
86 # the older version of LaTeX2HTML we use doesn't support this, but we use it:
59e494c0802f do_cmd_textasciitilde(): New function.
Fred Drake <fdrake@acm.org>
parents: 12637
diff changeset
87
59e494c0802f do_cmd_textasciitilde(): New function.
Fred Drake <fdrake@acm.org>
parents: 12637
diff changeset
88 sub do_cmd_textasciitilde{ '~' . @_[0]; }
59e494c0802f do_cmd_textasciitilde(): New function.
Fred Drake <fdrake@acm.org>
parents: 12637
diff changeset
89
59e494c0802f do_cmd_textasciitilde(): New function.
Fred Drake <fdrake@acm.org>
parents: 12637
diff changeset
90
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
91 # words typeset in a special way (not in HTML though)
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
92
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
93 sub do_cmd_ABC{ 'ABC' . @_[0]; }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
94 sub do_cmd_UNIX{ 'Unix'. @_[0]; }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
95 sub do_cmd_ASCII{ 'ASCII' . @_[0]; }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
96 sub do_cmd_POSIX{ 'POSIX' . @_[0]; }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
97 sub do_cmd_C{ 'C' . @_[0]; }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
98 sub do_cmd_Cpp{ 'C++' . @_[0]; }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
99 sub do_cmd_EOF{ 'EOF' . @_[0]; }
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
100 sub do_cmd_NULL{ '<tt class="constant">NULL</tt>' . @_[0]; }
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
101
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
102 sub do_cmd_e{ '&#92;' . @_[0]; }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
103
8342
22815a0b1267 Added support for \developer, \developers, \developersaddress.
Fred Drake <fdrake@acm.org>
parents: 8294
diff changeset
104 $DEVELOPER_ADDRESS = '';
14556
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
105 $SHORT_VERSION = '';
15322
d17ba141480a Rename $PYTHON_VERSION to $PACKAGE_VERSION; this is the version number for
Fred Drake <fdrake@acm.org>
parents: 14987
diff changeset
106 $PACKAGE_VERSION = '';
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
107
15322
d17ba141480a Rename $PYTHON_VERSION to $PACKAGE_VERSION; this is the version number for
Fred Drake <fdrake@acm.org>
parents: 14987
diff changeset
108 sub do_cmd_version{ $PACKAGE_VERSION . @_[0]; }
14556
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
109 sub do_cmd_shortversion{ $SHORT_VERSION . @_[0]; }
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
110 sub do_cmd_release{
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
111 local($_) = @_;
15322
d17ba141480a Rename $PYTHON_VERSION to $PACKAGE_VERSION; this is the version number for
Fred Drake <fdrake@acm.org>
parents: 14987
diff changeset
112 $PACKAGE_VERSION = next_argument();
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
113 return $_;
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
114 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
115
14556
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
116 sub do_cmd_setshortversion{
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
117 local($_) = @_;
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
118 $SHORT_VERSION = next_argument();
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
119 return $_;
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
120 }
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
121
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
122 sub do_cmd_authoraddress{
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
123 local($_) = @_;
8342
22815a0b1267 Added support for \developer, \developers, \developersaddress.
Fred Drake <fdrake@acm.org>
parents: 8294
diff changeset
124 $DEVELOPER_ADDRESS = next_argument();
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
125 return $_;
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
126 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
127
8344
d2d82f7b419a do_cmd_let(): Simple implementation to allow \let to be used to establish
Fred Drake <fdrake@acm.org>
parents: 8342
diff changeset
128 #sub do_cmd_developer{ do_cmd_author(@_[0]); }
d2d82f7b419a do_cmd_let(): Simple implementation to allow \let to be used to establish
Fred Drake <fdrake@acm.org>
parents: 8342
diff changeset
129 #sub do_cmd_developers{ do_cmd_author(@_[0]); }
d2d82f7b419a do_cmd_let(): Simple implementation to allow \let to be used to establish
Fred Drake <fdrake@acm.org>
parents: 8342
diff changeset
130 #sub do_cmd_developersaddress{ do_cmd_authoraddress(@_[0]); }
8342
22815a0b1267 Added support for \developer, \developers, \developersaddress.
Fred Drake <fdrake@acm.org>
parents: 8294
diff changeset
131
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
132 sub do_cmd_hackscore{
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
133 local($_) = @_;
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
134 next_argument();
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
135 return '_' . $_;
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
136 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
137
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
138 sub use_wrappers{
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
139 local($_,$before,$after) = @_;
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
140 my $stuff = next_argument();
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
141 return $before . $stuff . $after . $_;
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
142 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
143
14556
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
144 $IN_DESC_HANDLER = 0;
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
145 sub do_cmd_optional{
14556
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
146 if ($IN_DESC_HANDLER) {
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
147 return use_wrappers(@_[0], "</var><big>\[</big><var>",
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
148 "</var><big>\]</big><var>");
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
149 }
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
150 else {
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
151 return use_wrappers(@_[0], "<big>\[</big>", "<big>\]</big>");
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
152 }
7802
dffe1e470e6c Match python.sty a little better.
Fred Drake <fdrake@acm.org>
parents: 7798
diff changeset
153 }
dffe1e470e6c Match python.sty a little better.
Fred Drake <fdrake@acm.org>
parents: 7798
diff changeset
154
7711
56dcfc27710a Coding cleanups.
Fred Drake <fdrake@acm.org>
parents: 7671
diff changeset
155 # Logical formatting (some based on texinfo), needs to be converted to
56dcfc27710a Coding cleanups.
Fred Drake <fdrake@acm.org>
parents: 7671
diff changeset
156 # minimalist HTML. The "minimalist" is primarily to reduce the size of
56dcfc27710a Coding cleanups.
Fred Drake <fdrake@acm.org>
parents: 7671
diff changeset
157 # output files for users that read them over the network rather than
56dcfc27710a Coding cleanups.
Fred Drake <fdrake@acm.org>
parents: 7671
diff changeset
158 # from local repositories.
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
159
10464
f74ef1971bd1 Remove \platformof support, since it's been removed from the LaTeX
Fred Drake <fdrake@acm.org>
parents: 10327
diff changeset
160 # \file and \samp are at the end of this file since they screw up fontlock.
f74ef1971bd1 Remove \platformof support, since it's been removed from the LaTeX
Fred Drake <fdrake@acm.org>
parents: 10327
diff changeset
161
10100
9184862bd8d1 More magic to tighten up a little of the formatting.
Fred Drake <fdrake@acm.org>
parents: 10077
diff changeset
162 sub do_cmd_pytype{ return @_[0]; }
13831
c3783a33f84b do_cmd_moreargs(),
Fred Drake <fdrake@acm.org>
parents: 13077
diff changeset
163 sub do_cmd_makevar{
c3783a33f84b do_cmd_moreargs(),
Fred Drake <fdrake@acm.org>
parents: 13077
diff changeset
164 return use_wrappers(@_[0], '<span class="makevar">', '</span>'); }
10197
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
165 sub do_cmd_code{
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
166 return use_wrappers(@_[0], '<code>', '</code>'); }
10197
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
167 sub do_cmd_module{
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
168 return use_wrappers(@_[0], '<tt class="module">', '</tt>'); }
10197
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
169 sub do_cmd_keyword{
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
170 return use_wrappers(@_[0], '<tt class="keyword">', '</tt>'); }
10197
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
171 sub do_cmd_exception{
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
172 return use_wrappers(@_[0], '<tt class="exception">', '</tt>'); }
10197
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
173 sub do_cmd_class{
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
174 return use_wrappers(@_[0], '<tt class="class">', '</tt>'); }
10197
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
175 sub do_cmd_function{
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
176 return use_wrappers(@_[0], '<tt class="function">', '</tt>'); }
10197
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
177 sub do_cmd_constant{
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
178 return use_wrappers(@_[0], '<tt class="constant">', '</tt>'); }
10197
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
179 sub do_cmd_member{
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
180 return use_wrappers(@_[0], '<tt class="member">', '</tt>'); }
10197
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
181 sub do_cmd_method{
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
182 return use_wrappers(@_[0], '<tt class="method">', '</tt>'); }
10197
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
183 sub do_cmd_cfunction{
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
184 return use_wrappers(@_[0], '<tt class="cfunction">', '</tt>'); }
10197
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
185 sub do_cmd_cdata{
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
186 return use_wrappers(@_[0], '<tt class="cdata">', '</tt>'); }
10197
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
187 sub do_cmd_ctype{
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
188 return use_wrappers(@_[0], '<tt class="ctype">', '</tt>'); }
10197
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
189 sub do_cmd_regexp{
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
190 return use_wrappers(@_[0], '<tt class="regexp">', '</tt>'); }
10197
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
191 sub do_cmd_character{
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
192 return use_wrappers(@_[0], '"<tt class="character">', '</tt>"'); }
10197
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
193 sub do_cmd_program{
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
194 return use_wrappers(@_[0], '<b class="program">', '</b>'); }
11449
e0fe4c7a9eff do_cmd_programopt(): New function, similar to do_cmd_program().
Fred Drake <fdrake@acm.org>
parents: 11316
diff changeset
195 sub do_cmd_programopt{
e0fe4c7a9eff do_cmd_programopt(): New function, similar to do_cmd_program().
Fred Drake <fdrake@acm.org>
parents: 11316
diff changeset
196 return use_wrappers(@_[0], '<b class="programopt">', '</b>'); }
12376
6ce6c23acd14 do_cmd_longprogramopt(): New function.
Fred Drake <fdrake@acm.org>
parents: 12350
diff changeset
197 sub do_cmd_longprogramopt{
6ce6c23acd14 do_cmd_longprogramopt(): New function.
Fred Drake <fdrake@acm.org>
parents: 12350
diff changeset
198 # note that the --- will be later converted to -- by LaTeX2HTML
6ce6c23acd14 do_cmd_longprogramopt(): New function.
Fred Drake <fdrake@acm.org>
parents: 12350
diff changeset
199 return use_wrappers(@_[0], '<b class="programopt">---', '</b>'); }
10197
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
200 sub do_cmd_email{
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
201 return use_wrappers(@_[0], '<span class="email">', '</span>'); }
10197
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
202 sub do_cmd_mimetype{
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
203 return use_wrappers(@_[0], '<span class="mimetype">', '</span>'); }
10197
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
204 sub do_cmd_var{
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
205 return use_wrappers(@_[0], "<var>", "</var>"); }
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
206 sub do_cmd_dfn{
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
207 return use_wrappers(@_[0], '<i class="dfn">', '</i>'); }
10197
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
208 sub do_cmd_emph{
14766
72860ef03171 use_sans_serif(),
Fred Drake <fdrake@acm.org>
parents: 14722
diff changeset
209 return use_wrappers(@_[0], '<i>', '</i>'); }
10197
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
210 sub do_cmd_file{
13831
c3783a33f84b do_cmd_moreargs(),
Fred Drake <fdrake@acm.org>
parents: 13077
diff changeset
211 return use_wrappers(@_[0], '<span class="file">', '</span>'); }
10769
1af7a1467088 Control the layout of output tables a little better so they're easier
Fred Drake <fdrake@acm.org>
parents: 10767
diff changeset
212 sub do_cmd_filenq{
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
213 return do_cmd_file(@_[0]); }
10197
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
214 sub do_cmd_samp{
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
215 return use_wrappers(@_[0], '"<tt class="samp">', '</tt>"'); }
10197
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
216 sub do_cmd_kbd{
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
217 return use_wrappers(@_[0], '<kbd>', '</kbd>'); }
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
218 sub do_cmd_strong{
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
219 return use_wrappers(@_[0], '<b>', '</b>'); }
10464
f74ef1971bd1 Remove \platformof support, since it's been removed from the LaTeX
Fred Drake <fdrake@acm.org>
parents: 10327
diff changeset
220 sub do_cmd_textbf{
f74ef1971bd1 Remove \platformof support, since it's been removed from the LaTeX
Fred Drake <fdrake@acm.org>
parents: 10327
diff changeset
221 return use_wrappers(@_[0], '<b>', '</b>'); }
f74ef1971bd1 Remove \platformof support, since it's been removed from the LaTeX
Fred Drake <fdrake@acm.org>
parents: 10327
diff changeset
222 sub do_cmd_textit{
f74ef1971bd1 Remove \platformof support, since it's been removed from the LaTeX
Fred Drake <fdrake@acm.org>
parents: 10327
diff changeset
223 return use_wrappers(@_[0], '<i>', '</i>'); }
f74ef1971bd1 Remove \platformof support, since it's been removed from the LaTeX
Fred Drake <fdrake@acm.org>
parents: 10327
diff changeset
224
13831
c3783a33f84b do_cmd_moreargs(),
Fred Drake <fdrake@acm.org>
parents: 13077
diff changeset
225 sub do_cmd_moreargs{
c3783a33f84b do_cmd_moreargs(),
Fred Drake <fdrake@acm.org>
parents: 13077
diff changeset
226 return '...' . @_[0]; }
c3783a33f84b do_cmd_moreargs(),
Fred Drake <fdrake@acm.org>
parents: 13077
diff changeset
227 sub do_cmd_unspecified{
c3783a33f84b do_cmd_moreargs(),
Fred Drake <fdrake@acm.org>
parents: 13077
diff changeset
228 return '...' . @_[0]; }
c3783a33f84b do_cmd_moreargs(),
Fred Drake <fdrake@acm.org>
parents: 13077
diff changeset
229
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
230
9867
c95fff8f180a do_cmd_refmodule(): New function to support new \refmodule macro.
Fred Drake <fdrake@acm.org>
parents: 9848
diff changeset
231 sub do_cmd_refmodule{
c95fff8f180a do_cmd_refmodule(): New function to support new \refmodule macro.
Fred Drake <fdrake@acm.org>
parents: 9848
diff changeset
232 # Insert the right magic to jump to the module definition.
c95fff8f180a do_cmd_refmodule(): New function to support new \refmodule macro.
Fred Drake <fdrake@acm.org>
parents: 9848
diff changeset
233 local($_) = @_;
c95fff8f180a do_cmd_refmodule(): New function to support new \refmodule macro.
Fred Drake <fdrake@acm.org>
parents: 9848
diff changeset
234 my $key = next_optional_argument();
c95fff8f180a do_cmd_refmodule(): New function to support new \refmodule macro.
Fred Drake <fdrake@acm.org>
parents: 9848
diff changeset
235 my $module = next_argument();
c95fff8f180a do_cmd_refmodule(): New function to support new \refmodule macro.
Fred Drake <fdrake@acm.org>
parents: 9848
diff changeset
236 $key = $module
c95fff8f180a do_cmd_refmodule(): New function to support new \refmodule macro.
Fred Drake <fdrake@acm.org>
parents: 9848
diff changeset
237 unless $key;
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
238 return "<tt class='module'><a href='module-$key.html'>$module</a></tt>"
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
239 . $_;
9867
c95fff8f180a do_cmd_refmodule(): New function to support new \refmodule macro.
Fred Drake <fdrake@acm.org>
parents: 9848
diff changeset
240 }
c95fff8f180a do_cmd_refmodule(): New function to support new \refmodule macro.
Fred Drake <fdrake@acm.org>
parents: 9848
diff changeset
241
7779
1c420699d58a Implemented one more special markup item.
Fred Drake <fdrake@acm.org>
parents: 7760
diff changeset
242 sub do_cmd_newsgroup{
1c420699d58a Implemented one more special markup item.
Fred Drake <fdrake@acm.org>
parents: 7760
diff changeset
243 local($_) = @_;
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
244 my $newsgroup = next_argument();
14970
6af9aa15647f make_icon_filename(): Convenience function to turn a partial filename
Fred Drake <fdrake@acm.org>
parents: 14766
diff changeset
245 my $icon = get_link_icon("news:$newsgroup");
16114
44fd1a7cb279 Fix \seepep handling -- correct URL to the online PEP repository on SF is
Fred Drake <fdrake@acm.org>
parents: 15567
diff changeset
246 my $stuff = "<a class='newsgroup' href='news:$newsgroup'>"
44fd1a7cb279 Fix \seepep handling -- correct URL to the online PEP repository on SF is
Fred Drake <fdrake@acm.org>
parents: 15567
diff changeset
247 . "$newsgroup$icon</a>";
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
248 return $stuff . $_;
7779
1c420699d58a Implemented one more special markup item.
Fred Drake <fdrake@acm.org>
parents: 7760
diff changeset
249 }
7671
0cf2ffaf4bd7 Bring this up to date. Some things still don't work right.
Fred Drake <fdrake@acm.org>
parents: 7581
diff changeset
250
0cf2ffaf4bd7 Bring this up to date. Some things still don't work right.
Fred Drake <fdrake@acm.org>
parents: 7581
diff changeset
251 sub do_cmd_envvar{
0cf2ffaf4bd7 Bring this up to date. Some things still don't work right.
Fred Drake <fdrake@acm.org>
parents: 7581
diff changeset
252 local($_) = @_;
9775
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
253 my $envvar = next_argument();
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
254 my($name,$aname,$ahref) = new_link_info();
7909
5eafd3eda0af Remove option to strip out <tt>...</tt> from index entry text; this is now
Fred Drake <fdrake@acm.org>
parents: 7906
diff changeset
255 # The <tt> here is really to keep buildindex.py from making
5eafd3eda0af Remove option to strip out <tt>...</tt> from index entry text; this is now
Fred Drake <fdrake@acm.org>
parents: 7906
diff changeset
256 # the variable name case-insensitive.
16114
44fd1a7cb279 Fix \seepep handling -- correct URL to the online PEP repository on SF is
Fred Drake <fdrake@acm.org>
parents: 15567
diff changeset
257 add_index_entry("environment variables!$envvar@<tt>$envvar</tt>",
7909
5eafd3eda0af Remove option to strip out <tt>...</tt> from index entry text; this is now
Fred Drake <fdrake@acm.org>
parents: 7906
diff changeset
258 $ahref);
16114
44fd1a7cb279 Fix \seepep handling -- correct URL to the online PEP repository on SF is
Fred Drake <fdrake@acm.org>
parents: 15567
diff changeset
259 add_index_entry("$envvar (environment variable)", $ahref);
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
260 $aname =~ s/<a/<a class="envvar"/;
16114
44fd1a7cb279 Fix \seepep handling -- correct URL to the online PEP repository on SF is
Fred Drake <fdrake@acm.org>
parents: 15567
diff changeset
261 return "$aname$envvar</a>" . $_;
7671
0cf2ffaf4bd7 Bring this up to date. Some things still don't work right.
Fred Drake <fdrake@acm.org>
parents: 7581
diff changeset
262 }
0cf2ffaf4bd7 Bring this up to date. Some things still don't work right.
Fred Drake <fdrake@acm.org>
parents: 7581
diff changeset
263
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
264 sub do_cmd_url{
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
265 # use the URL as both text and hyperlink
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
266 local($_) = @_;
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
267 my $url = next_argument();
14970
6af9aa15647f make_icon_filename(): Convenience function to turn a partial filename
Fred Drake <fdrake@acm.org>
parents: 14766
diff changeset
268 my $icon = get_link_icon($url);
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
269 $url =~ s/~/&#126;/g;
14970
6af9aa15647f make_icon_filename(): Convenience function to turn a partial filename
Fred Drake <fdrake@acm.org>
parents: 14766
diff changeset
270 return "<a class=\"url\" href=\"$url\">$url$icon</a>" . $_;
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
271 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
272
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
273 sub do_cmd_manpage{
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
274 # two parameters: \manpage{name}{section}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
275 local($_) = @_;
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
276 my $page = next_argument();
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
277 my $section = next_argument();
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
278 return "<span class='manpage'><i>$page</i>($section)</span>" . $_;
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
279 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
280
16114
44fd1a7cb279 Fix \seepep handling -- correct URL to the online PEP repository on SF is
Fred Drake <fdrake@acm.org>
parents: 15567
diff changeset
281 $PEP_FORMAT = "http://python.sourceforge.net/peps/pep-XXXX.html";
44fd1a7cb279 Fix \seepep handling -- correct URL to the online PEP repository on SF is
Fred Drake <fdrake@acm.org>
parents: 15567
diff changeset
282 $RFC_FORMAT = "http://www.ietf.org/rfc/rfcXXXX.txt";
44fd1a7cb279 Fix \seepep handling -- correct URL to the online PEP repository on SF is
Fred Drake <fdrake@acm.org>
parents: 15567
diff changeset
283
44fd1a7cb279 Fix \seepep handling -- correct URL to the online PEP repository on SF is
Fred Drake <fdrake@acm.org>
parents: 15567
diff changeset
284 sub get_rfc_url($$){
44fd1a7cb279 Fix \seepep handling -- correct URL to the online PEP repository on SF is
Fred Drake <fdrake@acm.org>
parents: 15567
diff changeset
285 my($rfcnum, $format) = @_;
44fd1a7cb279 Fix \seepep handling -- correct URL to the online PEP repository on SF is
Fred Drake <fdrake@acm.org>
parents: 15567
diff changeset
286 $rfcnum = sprintf("%04d", $rfcnum);
44fd1a7cb279 Fix \seepep handling -- correct URL to the online PEP repository on SF is
Fred Drake <fdrake@acm.org>
parents: 15567
diff changeset
287 $format = "$format";
44fd1a7cb279 Fix \seepep handling -- correct URL to the online PEP repository on SF is
Fred Drake <fdrake@acm.org>
parents: 15567
diff changeset
288 $format =~ s/XXXX/$rfcnum/;
44fd1a7cb279 Fix \seepep handling -- correct URL to the online PEP repository on SF is
Fred Drake <fdrake@acm.org>
parents: 15567
diff changeset
289 return $format;
14491
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
290 }
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
291
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
292 sub do_cmd_pep{
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
293 local($_) = @_;
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
294 my $rfcnumber = next_argument();
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
295 my $id = "rfcref-" . ++$global{'max_id'};
16114
44fd1a7cb279 Fix \seepep handling -- correct URL to the online PEP repository on SF is
Fred Drake <fdrake@acm.org>
parents: 15567
diff changeset
296 my $href = get_rfc_url($rfcnumber, $PEP_FORMAT);
14970
6af9aa15647f make_icon_filename(): Convenience function to turn a partial filename
Fred Drake <fdrake@acm.org>
parents: 14766
diff changeset
297 my $icon = get_link_icon($href);
14491
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
298 # Save the reference
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
299 my $nstr = gen_index_id("Python Enhancement Proposals!PEP $rfcnumber", '');
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
300 $index{$nstr} .= make_half_href("$CURRENT_FILE#$id");
14970
6af9aa15647f make_icon_filename(): Convenience function to turn a partial filename
Fred Drake <fdrake@acm.org>
parents: 14766
diff changeset
301 return ("<a class=\"rfc\" name=\"$id\"\nhref=\"$href\">PEP $rfcnumber"
6af9aa15647f make_icon_filename(): Convenience function to turn a partial filename
Fred Drake <fdrake@acm.org>
parents: 14766
diff changeset
302 . "$icon</a>" . $_);
14491
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
303 }
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
304
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
305 sub do_cmd_rfc{
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
306 local($_) = @_;
9775
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
307 my $rfcnumber = next_argument();
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
308 my $id = "rfcref-" . ++$global{'max_id'};
16114
44fd1a7cb279 Fix \seepep handling -- correct URL to the online PEP repository on SF is
Fred Drake <fdrake@acm.org>
parents: 15567
diff changeset
309 my $href = get_rfc_url($rfcnumber, $RFC_FORMAT);
14970
6af9aa15647f make_icon_filename(): Convenience function to turn a partial filename
Fred Drake <fdrake@acm.org>
parents: 14766
diff changeset
310 my $icon = get_link_icon($href);
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
311 # Save the reference
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
312 my $nstr = gen_index_id("RFC!RFC $rfcnumber", '');
9775
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
313 $index{$nstr} .= make_half_href("$CURRENT_FILE#$id");
14970
6af9aa15647f make_icon_filename(): Convenience function to turn a partial filename
Fred Drake <fdrake@acm.org>
parents: 14766
diff changeset
314 return ("<a class=\"rfc\" name=\"$id\"\nhref=\"$href\">RFC $rfcnumber"
6af9aa15647f make_icon_filename(): Convenience function to turn a partial filename
Fred Drake <fdrake@acm.org>
parents: 14766
diff changeset
315 . "$icon</a>" . $_);
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
316 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
317
11449
e0fe4c7a9eff do_cmd_programopt(): New function, similar to do_cmd_program().
Fred Drake <fdrake@acm.org>
parents: 11316
diff changeset
318 sub do_cmd_citetitle{
e0fe4c7a9eff do_cmd_programopt(): New function, similar to do_cmd_program().
Fred Drake <fdrake@acm.org>
parents: 11316
diff changeset
319 local($_) = @_;
e0fe4c7a9eff do_cmd_programopt(): New function, similar to do_cmd_program().
Fred Drake <fdrake@acm.org>
parents: 11316
diff changeset
320 my $url = next_optional_argument();
e0fe4c7a9eff do_cmd_programopt(): New function, similar to do_cmd_program().
Fred Drake <fdrake@acm.org>
parents: 11316
diff changeset
321 my $title = next_argument();
14970
6af9aa15647f make_icon_filename(): Convenience function to turn a partial filename
Fred Drake <fdrake@acm.org>
parents: 14766
diff changeset
322 my $icon = get_link_icon($url);
11449
e0fe4c7a9eff do_cmd_programopt(): New function, similar to do_cmd_program().
Fred Drake <fdrake@acm.org>
parents: 11316
diff changeset
323 my $repl = '';
e0fe4c7a9eff do_cmd_programopt(): New function, similar to do_cmd_program().
Fred Drake <fdrake@acm.org>
parents: 11316
diff changeset
324 if ($url) {
e0fe4c7a9eff do_cmd_programopt(): New function, similar to do_cmd_program().
Fred Drake <fdrake@acm.org>
parents: 11316
diff changeset
325 $repl = ("<em class='citetitle'><a\n"
e0fe4c7a9eff do_cmd_programopt(): New function, similar to do_cmd_program().
Fred Drake <fdrake@acm.org>
parents: 11316
diff changeset
326 . " href='$url'\n"
e0fe4c7a9eff do_cmd_programopt(): New function, similar to do_cmd_program().
Fred Drake <fdrake@acm.org>
parents: 11316
diff changeset
327 . " title='$title'\n"
14970
6af9aa15647f make_icon_filename(): Convenience function to turn a partial filename
Fred Drake <fdrake@acm.org>
parents: 14766
diff changeset
328 . " >$title$icon</a></em>");
11449
e0fe4c7a9eff do_cmd_programopt(): New function, similar to do_cmd_program().
Fred Drake <fdrake@acm.org>
parents: 11316
diff changeset
329 }
e0fe4c7a9eff do_cmd_programopt(): New function, similar to do_cmd_program().
Fred Drake <fdrake@acm.org>
parents: 11316
diff changeset
330 else {
e0fe4c7a9eff do_cmd_programopt(): New function, similar to do_cmd_program().
Fred Drake <fdrake@acm.org>
parents: 11316
diff changeset
331 $repl = "<em class='citetitle'\n >$title</em>";
e0fe4c7a9eff do_cmd_programopt(): New function, similar to do_cmd_program().
Fred Drake <fdrake@acm.org>
parents: 11316
diff changeset
332 }
e0fe4c7a9eff do_cmd_programopt(): New function, similar to do_cmd_program().
Fred Drake <fdrake@acm.org>
parents: 11316
diff changeset
333 return $repl . $_;
e0fe4c7a9eff do_cmd_programopt(): New function, similar to do_cmd_program().
Fred Drake <fdrake@acm.org>
parents: 11316
diff changeset
334 }
e0fe4c7a9eff do_cmd_programopt(): New function, similar to do_cmd_program().
Fred Drake <fdrake@acm.org>
parents: 11316
diff changeset
335
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
336 sub do_cmd_deprecated{
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
337 # two parameters: \deprecated{version}{whattodo}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
338 local($_) = @_;
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
339 my $release = next_argument();
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
340 my $reason = next_argument();
16114
44fd1a7cb279 Fix \seepep handling -- correct URL to the online PEP repository on SF is
Fred Drake <fdrake@acm.org>
parents: 15567
diff changeset
341 return ('<div class="versionnote">'
44fd1a7cb279 Fix \seepep handling -- correct URL to the online PEP repository on SF is
Fred Drake <fdrake@acm.org>
parents: 15567
diff changeset
342 . "<b>Deprecated since release $release.</b>"
44fd1a7cb279 Fix \seepep handling -- correct URL to the online PEP repository on SF is
Fred Drake <fdrake@acm.org>
parents: 15567
diff changeset
343 . "\n$reason</div><p>"
44fd1a7cb279 Fix \seepep handling -- correct URL to the online PEP repository on SF is
Fred Drake <fdrake@acm.org>
parents: 15567
diff changeset
344 . $_);
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
345 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
346
17581
c1937faabb23 Added support for optional explanation parameter to the \versionadded
Fred Drake <fdrake@acm.org>
parents: 17429
diff changeset
347 sub versionnote{
c1937faabb23 Added support for optional explanation parameter to the \versionadded
Fred Drake <fdrake@acm.org>
parents: 17429
diff changeset
348 # one or two parameters: \versionnote[explanation]{version}
c1937faabb23 Added support for optional explanation parameter to the \versionadded
Fred Drake <fdrake@acm.org>
parents: 17429
diff changeset
349 my $type = @_[0];
c1937faabb23 Added support for optional explanation parameter to the \versionadded
Fred Drake <fdrake@acm.org>
parents: 17429
diff changeset
350 local $_ = @_[1];
c1937faabb23 Added support for optional explanation parameter to the \versionadded
Fred Drake <fdrake@acm.org>
parents: 17429
diff changeset
351 my $explanation = next_optional_argument();
c1937faabb23 Added support for optional explanation parameter to the \versionadded
Fred Drake <fdrake@acm.org>
parents: 17429
diff changeset
352 my $release = next_argument();
c1937faabb23 Added support for optional explanation parameter to the \versionadded
Fred Drake <fdrake@acm.org>
parents: 17429
diff changeset
353 my $text = "$type in version $release.";
c1937faabb23 Added support for optional explanation parameter to the \versionadded
Fred Drake <fdrake@acm.org>
parents: 17429
diff changeset
354 if ($explanation) {
c1937faabb23 Added support for optional explanation parameter to the \versionadded
Fred Drake <fdrake@acm.org>
parents: 17429
diff changeset
355 $text = "$type in version $release:\n$explanation.";
c1937faabb23 Added support for optional explanation parameter to the \versionadded
Fred Drake <fdrake@acm.org>
parents: 17429
diff changeset
356 }
c1937faabb23 Added support for optional explanation parameter to the \versionadded
Fred Drake <fdrake@acm.org>
parents: 17429
diff changeset
357 return "\n<span class='versionnote'>$text</span>\n" . $_;
c1937faabb23 Added support for optional explanation parameter to the \versionadded
Fred Drake <fdrake@acm.org>
parents: 17429
diff changeset
358 }
c1937faabb23 Added support for optional explanation parameter to the \versionadded
Fred Drake <fdrake@acm.org>
parents: 17429
diff changeset
359
8763
55f790a5f64b do_cmd_versionadded(),
Fred Drake <fdrake@acm.org>
parents: 8756
diff changeset
360 sub do_cmd_versionadded{
17581
c1937faabb23 Added support for optional explanation parameter to the \versionadded
Fred Drake <fdrake@acm.org>
parents: 17429
diff changeset
361 return versionnote('New', @_);
8763
55f790a5f64b do_cmd_versionadded(),
Fred Drake <fdrake@acm.org>
parents: 8756
diff changeset
362 }
55f790a5f64b do_cmd_versionadded(),
Fred Drake <fdrake@acm.org>
parents: 8756
diff changeset
363
55f790a5f64b do_cmd_versionadded(),
Fred Drake <fdrake@acm.org>
parents: 8756
diff changeset
364 sub do_cmd_versionchanged{
17581
c1937faabb23 Added support for optional explanation parameter to the \versionadded
Fred Drake <fdrake@acm.org>
parents: 17429
diff changeset
365 return versionnote('Changed', @_);
8763
55f790a5f64b do_cmd_versionadded(),
Fred Drake <fdrake@acm.org>
parents: 8756
diff changeset
366 }
55f790a5f64b do_cmd_versionadded(),
Fred Drake <fdrake@acm.org>
parents: 8756
diff changeset
367
10327
66a7d61cfd84 swallow_newline(): Removed function; not really needed. Modified all call
Fred Drake <fdrake@acm.org>
parents: 10197
diff changeset
368 #
10464
f74ef1971bd1 Remove \platformof support, since it's been removed from the LaTeX
Fred Drake <fdrake@acm.org>
parents: 10327
diff changeset
369 # These function handle platform dependency tracking.
10327
66a7d61cfd84 swallow_newline(): Removed function; not really needed. Modified all call
Fred Drake <fdrake@acm.org>
parents: 10197
diff changeset
370 #
66a7d61cfd84 swallow_newline(): Removed function; not really needed. Modified all call
Fred Drake <fdrake@acm.org>
parents: 10197
diff changeset
371 sub do_cmd_platform{
66a7d61cfd84 swallow_newline(): Removed function; not really needed. Modified all call
Fred Drake <fdrake@acm.org>
parents: 10197
diff changeset
372 local($_) = @_;
66a7d61cfd84 swallow_newline(): Removed function; not really needed. Modified all call
Fred Drake <fdrake@acm.org>
parents: 10197
diff changeset
373 my $platform = next_argument();
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
374 $ModulePlatforms{"<tt class='module'>$THIS_MODULE</tt>"} = $platform;
10327
66a7d61cfd84 swallow_newline(): Removed function; not really needed. Modified all call
Fred Drake <fdrake@acm.org>
parents: 10197
diff changeset
375 $platform = "Macintosh"
10637
bed15a015c1c Fix some remaining index & consistency nits. (Many data member
Fred Drake <fdrake@acm.org>
parents: 10598
diff changeset
376 if $platform eq 'Mac';
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
377 return "\n<p class='availability'>Availability: <span"
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
378 . "\n class='platform'>$platform</span>.</p>\n" . $_;
10327
66a7d61cfd84 swallow_newline(): Removed function; not really needed. Modified all call
Fred Drake <fdrake@acm.org>
parents: 10197
diff changeset
379 }
66a7d61cfd84 swallow_newline(): Removed function; not really needed. Modified all call
Fred Drake <fdrake@acm.org>
parents: 10197
diff changeset
380
66a7d61cfd84 swallow_newline(): Removed function; not really needed. Modified all call
Fred Drake <fdrake@acm.org>
parents: 10197
diff changeset
381 $IGNORE_PLATFORM_ANNOTATION = '';
66a7d61cfd84 swallow_newline(): Removed function; not really needed. Modified all call
Fred Drake <fdrake@acm.org>
parents: 10197
diff changeset
382 sub do_cmd_ignorePlatformAnnotation{
66a7d61cfd84 swallow_newline(): Removed function; not really needed. Modified all call
Fred Drake <fdrake@acm.org>
parents: 10197
diff changeset
383 local($_) = @_;
66a7d61cfd84 swallow_newline(): Removed function; not really needed. Modified all call
Fred Drake <fdrake@acm.org>
parents: 10197
diff changeset
384 $IGNORE_PLATFORM_ANNOTATION = next_argument();
66a7d61cfd84 swallow_newline(): Removed function; not really needed. Modified all call
Fred Drake <fdrake@acm.org>
parents: 10197
diff changeset
385 return $_;
66a7d61cfd84 swallow_newline(): Removed function; not really needed. Modified all call
Fred Drake <fdrake@acm.org>
parents: 10197
diff changeset
386 }
66a7d61cfd84 swallow_newline(): Removed function; not really needed. Modified all call
Fred Drake <fdrake@acm.org>
parents: 10197
diff changeset
387
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
388
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
389 # index commands
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
390
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
391 $INDEX_SUBITEM = "";
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
392
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
393 sub get_indexsubitem{
9769
e1508f72c610 do_cmd_methodline(): New function, implements indexing version of
Fred Drake <fdrake@acm.org>
parents: 9718
diff changeset
394 return $INDEX_SUBITEM ? " $INDEX_SUBITEM" : '';
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
395 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
396
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
397 sub do_cmd_setindexsubitem{
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
398 local($_) = @_;
10138
b21915e6589e Fix up some routines to coordinate the "indexsubitem" stuff so that
Fred Drake <fdrake@acm.org>
parents: 10128
diff changeset
399 $INDEX_SUBITEM = next_argument();
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
400 return $_;
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
401 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
402
7671
0cf2ffaf4bd7 Bring this up to date. Some things still don't work right.
Fred Drake <fdrake@acm.org>
parents: 7581
diff changeset
403 sub do_cmd_withsubitem{
9769
e1508f72c610 do_cmd_methodline(): New function, implements indexing version of
Fred Drake <fdrake@acm.org>
parents: 9718
diff changeset
404 # We can't really do the right thing, because LaTeX2HTML doesn't
7671
0cf2ffaf4bd7 Bring this up to date. Some things still don't work right.
Fred Drake <fdrake@acm.org>
parents: 7581
diff changeset
405 # do things in the right order, but we need to at least strip this stuff
0cf2ffaf4bd7 Bring this up to date. Some things still don't work right.
Fred Drake <fdrake@acm.org>
parents: 7581
diff changeset
406 # out, and leave anything that the second argument expanded out to.
0cf2ffaf4bd7 Bring this up to date. Some things still don't work right.
Fred Drake <fdrake@acm.org>
parents: 7581
diff changeset
407 #
0cf2ffaf4bd7 Bring this up to date. Some things still don't work right.
Fred Drake <fdrake@acm.org>
parents: 7581
diff changeset
408 local($_) = @_;
9769
e1508f72c610 do_cmd_methodline(): New function, implements indexing version of
Fred Drake <fdrake@acm.org>
parents: 9718
diff changeset
409 my $oldsubitem = $INDEX_SUBITEM;
e1508f72c610 do_cmd_methodline(): New function, implements indexing version of
Fred Drake <fdrake@acm.org>
parents: 9718
diff changeset
410 $INDEX_SUBITEM = next_argument();
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
411 my $stuff = next_argument();
9775
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
412 my $br_id = ++$globals{'max_id'};
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
413 my $marker = "$O$br_id$C";
9769
e1508f72c610 do_cmd_methodline(): New function, implements indexing version of
Fred Drake <fdrake@acm.org>
parents: 9718
diff changeset
414 return
e1508f72c610 do_cmd_methodline(): New function, implements indexing version of
Fred Drake <fdrake@acm.org>
parents: 9718
diff changeset
415 $stuff
9775
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
416 . "\\setindexsubitem$marker$oldsubitem$marker"
9769
e1508f72c610 do_cmd_methodline(): New function, implements indexing version of
Fred Drake <fdrake@acm.org>
parents: 9718
diff changeset
417 . $_;
7671
0cf2ffaf4bd7 Bring this up to date. Some things still don't work right.
Fred Drake <fdrake@acm.org>
parents: 7581
diff changeset
418 }
0cf2ffaf4bd7 Bring this up to date. Some things still don't work right.
Fred Drake <fdrake@acm.org>
parents: 7581
diff changeset
419
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
420 # This is the prologue macro which is required to start writing the
10849
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
421 # mod\jobname.idx file; we can just ignore it. (Defining this suppresses
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
422 # a warning that \makemodindex is unknown.)
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
423 #
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
424 sub do_cmd_makemodindex{ return @_[0]; }
7671
0cf2ffaf4bd7 Bring this up to date. Some things still don't work right.
Fred Drake <fdrake@acm.org>
parents: 7581
diff changeset
425
7760
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
426 # We're in the document subdirectory when this happens!
7909
5eafd3eda0af Remove option to strip out <tt>...</tt> from index entry text; this is now
Fred Drake <fdrake@acm.org>
parents: 7906
diff changeset
427 #
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
428 open(IDXFILE, '>index.dat') || die "\n$!\n";
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
429 open(INTLABELS, '>intlabels.pl') || die "\n$!\n";
7909
5eafd3eda0af Remove option to strip out <tt>...</tt> from index entry text; this is now
Fred Drake <fdrake@acm.org>
parents: 7906
diff changeset
430 print INTLABELS "%internal_labels = ();\n";
5eafd3eda0af Remove option to strip out <tt>...</tt> from index entry text; this is now
Fred Drake <fdrake@acm.org>
parents: 7906
diff changeset
431 print INTLABELS "1; # hack in case there are no entries\n\n";
5eafd3eda0af Remove option to strip out <tt>...</tt> from index entry text; this is now
Fred Drake <fdrake@acm.org>
parents: 7906
diff changeset
432
5eafd3eda0af Remove option to strip out <tt>...</tt> from index entry text; this is now
Fred Drake <fdrake@acm.org>
parents: 7906
diff changeset
433 # Using \0 for this is bad because we can't use common tools to work with the
5eafd3eda0af Remove option to strip out <tt>...</tt> from index entry text; this is now
Fred Drake <fdrake@acm.org>
parents: 7906
diff changeset
434 # resulting files. Things like grep can be useful with this stuff!
5eafd3eda0af Remove option to strip out <tt>...</tt> from index entry text; this is now
Fred Drake <fdrake@acm.org>
parents: 7906
diff changeset
435 #
5eafd3eda0af Remove option to strip out <tt>...</tt> from index entry text; this is now
Fred Drake <fdrake@acm.org>
parents: 7906
diff changeset
436 $IDXFILE_FIELD_SEP = "\1";
5eafd3eda0af Remove option to strip out <tt>...</tt> from index entry text; this is now
Fred Drake <fdrake@acm.org>
parents: 7906
diff changeset
437
9775
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
438 sub write_idxfile{
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
439 my ($ahref, $str) = @_;
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
440 print IDXFILE $ahref, $IDXFILE_FIELD_SEP, $str, "\n";
7760
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
441 }
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
442
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
443
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
444 sub gen_link{
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
445 my($node,$target) = @_;
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
446 print INTLABELS "\$internal_labels{\"$target\"} = \"$URL/$node\";\n";
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
447 return "<a href='$node#$target'>";
7760
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
448 }
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
449
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
450 sub add_index_entry{
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
451 # add an entry to the index structures; ignore the return value
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
452 my($str,$ahref) = @_;
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
453 $str = gen_index_id($str, '');
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
454 $index{$str} .= $ahref;
9775
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
455 write_idxfile($ahref, $str);
7760
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
456 }
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
457
9775
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
458 sub new_link_info{
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
459 my $name = "l2h-" . ++$globals{'max_id'};
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
460 my $aname = "<a name='$name'>";
7760
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
461 my $ahref = gen_link($CURRENT_FILE, $name);
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
462 return ($name, $aname, $ahref);
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
463 }
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
464
10849
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
465 $IndexMacroPattern = '';
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
466 sub define_indexing_macro{
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
467 my $count = @_;
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
468 my $i = 0;
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
469 for (; $i < $count; ++$i) {
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
470 my $name = @_[$i];
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
471 my $cmd = "idx_cmd_$name";
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
472 die "\nNo function $cmd() defined!\n"
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
473 if (!defined &$cmd);
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
474 eval ("sub do_cmd_$name { return process_index_macros("
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
475 . "\@_[0], '$name'); }");
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
476 if (length($IndexMacroPattern) == 0) {
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
477 $IndexMacroPattern = "$name";
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
478 }
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
479 else {
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
480 $IndexMacroPattern .= "|$name";
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
481 }
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
482 }
7760
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
483 }
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
484
10849
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
485 $DEBUG_INDEXING = 0;
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
486 sub process_index_macros{
8294
35ea0c073ea3 do_cmd_kwindex(): Re-implement now that \kwindex is used again (ref man).
Fred Drake <fdrake@acm.org>
parents: 8194
diff changeset
487 local($_) = @_;
10849
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
488 my $cmdname = @_[1]; # This is what triggered us in the first place;
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
489 # we know it's real, so just process it.
9775
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
490 my($name,$aname,$ahref) = new_link_info();
10849
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
491 my $cmd = "idx_cmd_$cmdname";
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
492 print "\nIndexing: \\$cmdname"
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
493 if $DEBUG_INDEXING;
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
494 &$cmd($ahref); # modifies $_ and adds index entries
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
495 while (/^[\s\n]*\\($IndexMacroPattern)</) {
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
496 $cmdname = "$1";
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
497 print " \\$cmdname"
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
498 if $DEBUG_INDEXING;
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
499 $cmd = "idx_cmd_$cmdname";
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
500 if (!defined &$cmd) {
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
501 last;
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
502 }
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
503 else {
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
504 s/^[\s\n]*\\$cmdname//;
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
505 &$cmd($ahref);
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
506 }
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
507 }
16114
44fd1a7cb279 Fix \seepep handling -- correct URL to the online PEP repository on SF is
Fred Drake <fdrake@acm.org>
parents: 15567
diff changeset
508 if (/^[ \t\r\n]/) {
44fd1a7cb279 Fix \seepep handling -- correct URL to the online PEP repository on SF is
Fred Drake <fdrake@acm.org>
parents: 15567
diff changeset
509 $_ = substr($_, 1);
44fd1a7cb279 Fix \seepep handling -- correct URL to the online PEP repository on SF is
Fred Drake <fdrake@acm.org>
parents: 15567
diff changeset
510 }
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
511 return "$aname$anchor_invisible_mark</a>" . $_;
8294
35ea0c073ea3 do_cmd_kwindex(): Re-implement now that \kwindex is used again (ref man).
Fred Drake <fdrake@acm.org>
parents: 8194
diff changeset
512 }
35ea0c073ea3 do_cmd_kwindex(): Re-implement now that \kwindex is used again (ref man).
Fred Drake <fdrake@acm.org>
parents: 8194
diff changeset
513
10849
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
514 define_indexing_macro('index');
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
515 sub idx_cmd_index{
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
516 my $str = next_argument();
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
517 add_index_entry("$str", @_[0]);
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
518 }
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
519
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
520 define_indexing_macro('kwindex');
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
521 sub idx_cmd_kwindex{
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
522 my $str = next_argument();
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
523 add_index_entry("<tt>$str</tt>!keyword", @_[0]);
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
524 add_index_entry("keyword!<tt>$str</tt>", @_[0]);
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
525 }
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
526
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
527 define_indexing_macro('indexii');
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
528 sub idx_cmd_indexii{
9775
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
529 my $str1 = next_argument();
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
530 my $str2 = next_argument();
10849
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
531 add_index_entry("$str1!$str2", @_[0]);
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
532 add_index_entry("$str2!$str1", @_[0]);
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
533 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
534
10849
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
535 define_indexing_macro('indexiii');
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
536 sub idx_cmd_indexiii{
9775
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
537 my $str1 = next_argument();
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
538 my $str2 = next_argument();
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
539 my $str3 = next_argument();
10849
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
540 add_index_entry("$str1!$str2 $str3", @_[0]);
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
541 add_index_entry("$str2!$str3, $str1", @_[0]);
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
542 add_index_entry("$str3!$str1 $str2", @_[0]);
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
543 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
544
10849
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
545 define_indexing_macro('indexiv');
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
546 sub idx_cmd_indexiv{
9775
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
547 my $str1 = next_argument();
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
548 my $str2 = next_argument();
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
549 my $str3 = next_argument();
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
550 my $str4 = next_argument();
10849
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
551 add_index_entry("$str1!$str2 $str3 $str4", @_[0]);
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
552 add_index_entry("$str2!$str3 $str4, $str1", @_[0]);
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
553 add_index_entry("$str3!$str4, $str1 $str2", @_[0]);
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
554 add_index_entry("$str4!$$str1 $str2 $str3", @_[0]);
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
555 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
556
10849
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
557 define_indexing_macro('ttindex');
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
558 sub idx_cmd_ttindex{
9775
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
559 my $str = next_argument();
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
560 my $entry = $str . get_indexsubitem();
10849
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
561 add_index_entry($entry, @_[0]);
7711
56dcfc27710a Coding cleanups.
Fred Drake <fdrake@acm.org>
parents: 7671
diff changeset
562 }
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
563
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
564 sub my_typed_index_helper{
10849
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
565 my($word,$ahref) = @_;
9775
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
566 my $str = next_argument();
7760
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
567 add_index_entry("$str $word", $ahref);
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
568 add_index_entry("$word!$str", $ahref);
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
569 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
570
10849
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
571 define_indexing_macro('stindex', 'opindex', 'exindex', 'obindex');
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
572 sub idx_cmd_stindex{ my_typed_index_helper('statement', @_[0]); }
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
573 sub idx_cmd_opindex{ my_typed_index_helper('operator', @_[0]); }
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
574 sub idx_cmd_exindex{ my_typed_index_helper('exception', @_[0]); }
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
575 sub idx_cmd_obindex{ my_typed_index_helper('object', @_[0]); }
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
576
10849
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
577 define_indexing_macro('bifuncindex');
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
578 sub idx_cmd_bifuncindex{
9775
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
579 my $str = next_argument();
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
580 add_index_entry("<tt class='function'>$str()</tt> (built-in function)",
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
581 @_[0]);
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
582 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
583
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
584
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
585 sub make_mod_index_entry{
9775
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
586 my($str,$define) = @_;
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
587 my($name,$aname,$ahref) = new_link_info();
7760
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
588 # equivalent of add_index_entry() using $define instead of ''
10138
b21915e6589e Fix up some routines to coordinate the "indexsubitem" stuff so that
Fred Drake <fdrake@acm.org>
parents: 10128
diff changeset
589 $ahref =~ s/\#[-_a-zA-Z0-9]*\"/\"/
b21915e6589e Fix up some routines to coordinate the "indexsubitem" stuff so that
Fred Drake <fdrake@acm.org>
parents: 10128
diff changeset
590 if ($define eq 'DEF');
7760
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
591 $str = gen_index_id($str, $define);
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
592 $index{$str} .= $ahref;
9775
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
593 write_idxfile($ahref, $str);
7760
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
594
7711
56dcfc27710a Coding cleanups.
Fred Drake <fdrake@acm.org>
parents: 7671
diff changeset
595 if ($define eq 'DEF') {
7760
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
596 # add to the module index
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
597 $str =~ /(<tt.*<\/tt>)/;
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
598 my $nstr = $1;
7760
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
599 $Modules{$nstr} .= $ahref;
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
600 }
16114
44fd1a7cb279 Fix \seepep handling -- correct URL to the online PEP repository on SF is
Fred Drake <fdrake@acm.org>
parents: 15567
diff changeset
601 return "$aname$anchor_invisible_mark2</a>";
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
602 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
603
10327
66a7d61cfd84 swallow_newline(): Removed function; not really needed. Modified all call
Fred Drake <fdrake@acm.org>
parents: 10197
diff changeset
604
7711
56dcfc27710a Coding cleanups.
Fred Drake <fdrake@acm.org>
parents: 7671
diff changeset
605 $THIS_MODULE = '';
7760
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
606 $THIS_CLASS = '';
7711
56dcfc27710a Coding cleanups.
Fred Drake <fdrake@acm.org>
parents: 7671
diff changeset
607
8754
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
608 sub define_module{
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
609 my($word,$name) = @_;
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
610 my $section_tag = join('', @curr_sec_id);
10857
1aa80f5bf9ac define_module(): Check the module type for validity before using.
Fred Drake <fdrake@acm.org>
parents: 10849
diff changeset
611 if ($word ne "built-in" && $word ne "extension"
1aa80f5bf9ac define_module(): Check the module type for validity before using.
Fred Drake <fdrake@acm.org>
parents: 10849
diff changeset
612 && $word ne "standard" && $word ne "") {
1aa80f5bf9ac define_module(): Check the module type for validity before using.
Fred Drake <fdrake@acm.org>
parents: 10849
diff changeset
613 write_warnings("Bad module type '$word'"
1aa80f5bf9ac define_module(): Check the module type for validity before using.
Fred Drake <fdrake@acm.org>
parents: 10849
diff changeset
614 . " for \\declaremodule (module $name)");
1aa80f5bf9ac define_module(): Check the module type for validity before using.
Fred Drake <fdrake@acm.org>
parents: 10849
diff changeset
615 $word = "";
1aa80f5bf9ac define_module(): Check the module type for validity before using.
Fred Drake <fdrake@acm.org>
parents: 10849
diff changeset
616 }
8754
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
617 $word = "$word " if $word;
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
618 $THIS_MODULE = "$name";
15363
47d9fbe6537c define_module(): Change the "index sub-item" for definitions at module
Fred Drake <fdrake@acm.org>
parents: 15349
diff changeset
619 $INDEX_SUBITEM = "(in module $name)";
10138
b21915e6589e Fix up some routines to coordinate the "indexsubitem" stuff so that
Fred Drake <fdrake@acm.org>
parents: 10128
diff changeset
620 print "[$name]";
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
621 return make_mod_index_entry(
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
622 "<tt class='module'>$name</tt> (${word}module)", 'DEF');
8754
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
623 }
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
624
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
625 sub my_module_index_helper{
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
626 local($word, $_) = @_;
8754
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
627 my $name = next_argument();
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
628 return define_module($word, $name) . $_;
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
629 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
630
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
631 sub do_cmd_modindex{ return my_module_index_helper('', @_); }
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
632 sub do_cmd_bimodindex{ return my_module_index_helper('built-in', @_); }
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
633 sub do_cmd_exmodindex{ return my_module_index_helper('extension', @_); }
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
634 sub do_cmd_stmodindex{ return my_module_index_helper('standard', @_); }
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
635
10849
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
636 sub ref_module_index_helper{
12499
0780aba97898 ref_module_index_helper(): Use "my" instead of "local".
Fred Drake <fdrake@acm.org>
parents: 12376
diff changeset
637 my($word, $ahref) = @_;
10849
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
638 my $str = next_argument();
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
639 $word = "$word " if $word;
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
640 $str = "<tt class='module'>$str</tt> (${word}module)";
10849
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
641 # can't use add_index_entry() since the 2nd arg to gen_index_id() is used;
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
642 # just inline it all here
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
643 $str = gen_index_id($str, 'REF');
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
644 $index{$str} .= $ahref;
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
645 write_idxfile($ahref, $str);
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
646 }
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
647
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
648 # these should be adjusted a bit....
10849
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
649 define_indexing_macro('refmodindex', 'refbimodindex',
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
650 'refexmodindex', 'refstmodindex');
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
651 sub idx_cmd_refmodindex{ return ref_module_index_helper('', @_); }
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
652 sub idx_cmd_refbimodindex{ return ref_module_index_helper('built-in', @_); }
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
653 sub idx_cmd_refexmodindex{ return ref_module_index_helper('extension', @_); }
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
654 sub idx_cmd_refstmodindex{ return ref_module_index_helper('standard', @_); }
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
655
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
656 sub do_cmd_nodename{ return do_cmd_label(@_); }
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
657
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
658 sub init_myformat{
16114
44fd1a7cb279 Fix \seepep handling -- correct URL to the online PEP repository on SF is
Fred Drake <fdrake@acm.org>
parents: 15567
diff changeset
659 $anchor_invisible_mark = '&nbsp;';
44fd1a7cb279 Fix \seepep handling -- correct URL to the online PEP repository on SF is
Fred Drake <fdrake@acm.org>
parents: 15567
diff changeset
660 $anchor_invisible_mark2 = '';
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
661 $anchor_mark = '';
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
662 $icons{'anchor_mark'} = '';
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
663 }
7760
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
664 init_myformat();
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
665
10849
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
666 # Create an index entry, but include the string in the target anchor
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
667 # instead of the dummy filler.
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
668 #
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
669 sub make_str_index_entry{
9775
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
670 my($str) = @_;
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
671 my($name,$aname,$ahref) = new_link_info();
7760
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
672 add_index_entry($str, $ahref);
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
673 return "$aname$str</a>";
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
674 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
675
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
676 $REFCOUNTS_LOADED = 0;
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
677
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
678 sub load_refcounts{
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
679 $REFCOUNTS_LOADED = 1;
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
680
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
681 my $myname, $mydir, $myext;
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
682 ($myname, $mydir, $myext) = fileparse(__FILE__, '\..*');
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
683 chop $mydir; # remove trailing '/'
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
684 ($myname, $mydir, $myext) = fileparse($mydir, '\..*');
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
685 chop $mydir; # remove trailing '/'
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
686 $mydir = getcwd() . "$dd$mydir"
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
687 unless $mydir =~ s|^/|/|;
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
688 local $_;
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
689 my $filename = "$mydir${dd}api${dd}refcounts.dat";
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
690 open(REFCOUNT_FILE, "<$filename") || die "\n$!\n";
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
691 print "[loading API refcount data]";
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
692 while (<REFCOUNT_FILE>) {
12350
c59bdc7fd8a6 load_refcounts(),
Fred Drake <fdrake@acm.org>
parents: 12343
diff changeset
693 if (/([a-zA-Z0-9_]+):PyObject\*:([a-zA-Z0-9_]*):(0|[-+]1|null):(.*)$/) {
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
694 my($func, $param, $count, $comment) = ($1, $2, $3, $4);
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
695 #print "\n$func($param) --> $count";
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
696 $REFCOUNTS{"$func:$param"} = $count;
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
697 }
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
698 }
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
699 }
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
700
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
701 sub get_refcount{
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
702 my ($func, $param) = @_;
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
703 load_refcounts()
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
704 unless $REFCOUNTS_LOADED;
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
705 return $REFCOUNTS{"$func:$param"};
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
706 }
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
707
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
708 sub do_env_cfuncdesc{
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
709 local($_) = @_;
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
710 my $return_type = next_argument();
9775
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
711 my $function_name = next_argument();
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
712 my $arg_list = next_argument();
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
713 my $idx = make_str_index_entry(
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
714 "<tt class='cfunction'>$function_name()</tt>" . get_indexsubitem());
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
715 $idx =~ s/ \(.*\)//;
13926
b6e07c272487 do_env_cfuncdesc(): Push as much of the generated HTML into one place
Fred Drake <fdrake@acm.org>
parents: 13899
diff changeset
716 $idx =~ s/\(\)//; # ???? - why both of these?
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
717 my $result_rc = get_refcount($function_name, '');
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
718 my $rcinfo = '';
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
719 if ($result_rc eq '+1') {
13926
b6e07c272487 do_env_cfuncdesc(): Push as much of the generated HTML into one place
Fred Drake <fdrake@acm.org>
parents: 13899
diff changeset
720 $rcinfo = 'New reference';
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
721 }
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
722 elsif ($result_rc eq '0') {
13926
b6e07c272487 do_env_cfuncdesc(): Push as much of the generated HTML into one place
Fred Drake <fdrake@acm.org>
parents: 13899
diff changeset
723 $rcinfo = 'Borrowed reference';
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
724 }
12350
c59bdc7fd8a6 load_refcounts(),
Fred Drake <fdrake@acm.org>
parents: 12343
diff changeset
725 elsif ($result_rc eq 'null') {
13926
b6e07c272487 do_env_cfuncdesc(): Push as much of the generated HTML into one place
Fred Drake <fdrake@acm.org>
parents: 13899
diff changeset
726 $rcinfo = 'Always <tt class="constant">NULL</tt>';
12350
c59bdc7fd8a6 load_refcounts(),
Fred Drake <fdrake@acm.org>
parents: 12343
diff changeset
727 }
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
728 if ($rcinfo ne '') {
13926
b6e07c272487 do_env_cfuncdesc(): Push as much of the generated HTML into one place
Fred Drake <fdrake@acm.org>
parents: 13899
diff changeset
729 $rcinfo = ( "\n<div class=\"refcount-info\">"
b6e07c272487 do_env_cfuncdesc(): Push as much of the generated HTML into one place
Fred Drake <fdrake@acm.org>
parents: 13899
diff changeset
730 . "\n <span class=\"label\">Return value:</span>"
b6e07c272487 do_env_cfuncdesc(): Push as much of the generated HTML into one place
Fred Drake <fdrake@acm.org>
parents: 13899
diff changeset
731 . "\n <span class=\"value\">$rcinfo.</span>"
b6e07c272487 do_env_cfuncdesc(): Push as much of the generated HTML into one place
Fred Drake <fdrake@acm.org>
parents: 13899
diff changeset
732 . "\n</div>");
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
733 }
17249
6d30552cb4f9 Remove the spurious space of uncertain origin from the output for function,
Fred Drake <fdrake@acm.org>
parents: 16966
diff changeset
734 return "<dl><dt>$return_type <b>$idx</b>(<var>$arg_list</var>)\n<dd>"
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
735 . $rcinfo
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
736 . $_
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
737 . '</dl>';
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
738 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
739
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
740 sub do_env_csimplemacrodesc{
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
741 local($_) = @_;
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
742 my $name = next_argument();
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
743 my $idx = make_str_index_entry("<tt class='macro'>$name</tt>");
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
744 return "<dl><dt><b>$idx</b>\n<dd>"
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
745 . $_
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
746 . '</dl>'
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
747 }
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
748
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
749 sub do_env_ctypedesc{
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
750 local($_) = @_;
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
751 my $index_name = next_optional_argument();
9775
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
752 my $type_name = next_argument();
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
753 $index_name = $type_name
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
754 unless $index_name;
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
755 my($name,$aname,$ahref) = new_link_info();
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
756 add_index_entry("<tt class='ctype'>$index_name</tt> (C type)", $ahref);
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
757 return "<dl><dt><b><tt class='ctype'>$aname$type_name</a></tt></b>\n<dd>"
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
758 . $_
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
759 . '</dl>'
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
760 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
761
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
762 sub do_env_cvardesc{
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
763 local($_) = @_;
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
764 my $var_type = next_argument();
9775
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
765 my $var_name = next_argument();
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
766 my $idx = make_str_index_entry("<tt class='cdata'>$var_name</tt>"
10197
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
767 . get_indexsubitem());
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
768 $idx =~ s/ \(.*\)//;
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
769 return "<dl><dt>$var_type <b>$idx</b>\n"
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
770 . '<dd>'
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
771 . $_
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
772 . '</dl>';
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
773 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
774
14556
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
775 sub convert_args($){
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
776 local($IN_DESC_HANDLER) = 1;
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
777 local($_) = @_;
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
778 return translate_commands($_);
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
779 }
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
780
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
781 sub do_env_funcdesc{
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
782 local($_) = @_;
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
783 my $function_name = next_argument();
14556
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
784 my $arg_list = convert_args(next_argument());
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
785 my $idx = make_str_index_entry("<tt class='function'>$function_name()</tt>"
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
786 . get_indexsubitem());
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
787 $idx =~ s/ \(.*\)//;
9775
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
788 $idx =~ s/\(\)<\/tt>/<\/tt>/;
17249
6d30552cb4f9 Remove the spurious space of uncertain origin from the output for function,
Fred Drake <fdrake@acm.org>
parents: 16966
diff changeset
789 return "<dl><dt><b>$idx</b>(<var>$arg_list</var>)\n<dd>" . $_ . '</dl>';
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
790 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
791
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
792 sub do_env_funcdescni{
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
793 local($_) = @_;
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
794 my $function_name = next_argument();
14556
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
795 my $arg_list = convert_args(next_argument());
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
796 return "<dl><dt><b><tt class='function'>$function_name</tt></b>"
17249
6d30552cb4f9 Remove the spurious space of uncertain origin from the output for function,
Fred Drake <fdrake@acm.org>
parents: 16966
diff changeset
797 . "(<var>$arg_list</var>)\n"
10197
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
798 . '<dd>'
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
799 . $_
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
800 . '</dl>';
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
801 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
802
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
803 sub do_cmd_funcline{
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
804 local($_) = @_;
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
805 my $function_name = next_argument();
14556
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
806 my $arg_list = convert_args(next_argument());
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
807 my $prefix = "<tt class='function'>$function_name()</tt>";
10641
f6ec4a9cb0b3 do_cmd_funcline(): Remove some bogus generated stuff from the output
Fred Drake <fdrake@acm.org>
parents: 10637
diff changeset
808 my $idx = make_str_index_entry($prefix . get_indexsubitem());
f6ec4a9cb0b3 do_cmd_funcline(): Remove some bogus generated stuff from the output
Fred Drake <fdrake@acm.org>
parents: 10637
diff changeset
809 $prefix =~ s/\(\)//;
f6ec4a9cb0b3 do_cmd_funcline(): Remove some bogus generated stuff from the output
Fred Drake <fdrake@acm.org>
parents: 10637
diff changeset
810
17249
6d30552cb4f9 Remove the spurious space of uncertain origin from the output for function,
Fred Drake <fdrake@acm.org>
parents: 16966
diff changeset
811 return "<dt><b>$prefix</b>(<var>$arg_list</var>)\n<dd>" . $_;
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
812 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
813
11123
2eb2879d567f do_cmd_funclineni(): New function; non-indexing form of \funcline.
Fred Drake <fdrake@acm.org>
parents: 10857
diff changeset
814 sub do_cmd_funclineni{
2eb2879d567f do_cmd_funclineni(): New function; non-indexing form of \funcline.
Fred Drake <fdrake@acm.org>
parents: 10857
diff changeset
815 local($_) = @_;
2eb2879d567f do_cmd_funclineni(): New function; non-indexing form of \funcline.
Fred Drake <fdrake@acm.org>
parents: 10857
diff changeset
816 my $function_name = next_argument();
14556
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
817 my $arg_list = convert_args(next_argument());
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
818 my $prefix = "<tt class='function'>$function_name</tt>";
11123
2eb2879d567f do_cmd_funclineni(): New function; non-indexing form of \funcline.
Fred Drake <fdrake@acm.org>
parents: 10857
diff changeset
819
17249
6d30552cb4f9 Remove the spurious space of uncertain origin from the output for function,
Fred Drake <fdrake@acm.org>
parents: 16966
diff changeset
820 return "<dt><b>$prefix</b>(<var>$arg_list</var>)\n<dd>" . $_;
11123
2eb2879d567f do_cmd_funclineni(): New function; non-indexing form of \funcline.
Fred Drake <fdrake@acm.org>
parents: 10857
diff changeset
821 }
2eb2879d567f do_cmd_funclineni(): New function; non-indexing form of \funcline.
Fred Drake <fdrake@acm.org>
parents: 10857
diff changeset
822
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
823 # Change this flag to index the opcode entries. I don't think it's very
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
824 # useful to index them, since they're only presented to describe the dis
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
825 # module.
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
826 #
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
827 $INDEX_OPCODES = 0;
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
828
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
829 sub do_env_opcodedesc{
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
830 local($_) = @_;
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
831 my $opcode_name = next_argument();
9775
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
832 my $arg_list = next_argument();
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
833 my $idx;
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
834 if ($INDEX_OPCODES) {
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
835 $idx = make_str_index_entry("<tt class='opcode'>$opcode_name</tt>"
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
836 . " (byte code instruction)");
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
837 $idx =~ s/ \(byte code instruction\)//;
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
838 }
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
839 else {
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
840 $idx = "<tt class='opcode'>$opcode_name</tt>";
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
841 }
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
842 my $stuff = "<dl><dt><b>$idx</b>";
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
843 if ($arg_list) {
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
844 $stuff .= "&nbsp;&nbsp;&nbsp;&nbsp;<var>$arg_list</var>";
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
845 }
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
846 return $stuff . "\n<dd>" . $_ . '</dl>';
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
847 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
848
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
849 sub do_env_datadesc{
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
850 local($_) = @_;
9775
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
851 my $dataname = next_argument();
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
852 my $idx = make_str_index_entry("<tt>$dataname</tt>" . get_indexsubitem());
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
853 $idx =~ s/ \(.*\)//;
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
854 return "<dl><dt><b>$idx</b>\n<dd>"
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
855 . $_
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
856 . '</dl>';
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
857 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
858
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
859 sub do_env_datadescni{
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
860 local($_) = @_;
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
861 my $idx = next_argument();
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
862 if (! $STRING_INDEX_TT) {
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
863 $idx = "<tt>$idx</tt>";
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
864 }
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
865 return "<dl><dt><b>$idx</b>\n<dd>" . $_ . '</dl>';
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
866 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
867
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
868 sub do_cmd_dataline{
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
869 local($_) = @_;
9775
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
870 my $data_name = next_argument();
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
871 my $idx = make_str_index_entry("<tt>$data_name</tt>" . get_indexsubitem());
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
872 $idx =~ s/ \(.*\)//;
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
873 return "<dt><b>$idx</b><dd>" . $_;
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
874 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
875
12343
be5100afa1b7 do_cmd_datalineni(): New function, to implement the non-indexing form
Fred Drake <fdrake@acm.org>
parents: 12217
diff changeset
876 sub do_cmd_datalineni{
be5100afa1b7 do_cmd_datalineni(): New function, to implement the non-indexing form
Fred Drake <fdrake@acm.org>
parents: 12217
diff changeset
877 local($_) = @_;
be5100afa1b7 do_cmd_datalineni(): New function, to implement the non-indexing form
Fred Drake <fdrake@acm.org>
parents: 12217
diff changeset
878 my $data_name = next_argument();
be5100afa1b7 do_cmd_datalineni(): New function, to implement the non-indexing form
Fred Drake <fdrake@acm.org>
parents: 12217
diff changeset
879 return "<dt><b><tt>$data_name</tt></b><dd>" . $_;
be5100afa1b7 do_cmd_datalineni(): New function, to implement the non-indexing form
Fred Drake <fdrake@acm.org>
parents: 12217
diff changeset
880 }
be5100afa1b7 do_cmd_datalineni(): New function, to implement the non-indexing form
Fred Drake <fdrake@acm.org>
parents: 12217
diff changeset
881
7760
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
882 sub do_env_excdesc{
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
883 local($_) = @_;
9775
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
884 my $excname = next_argument();
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
885 my $idx = make_str_index_entry("<tt class='exception'>$excname</tt>");
16966
38e17a089492 Label classes and exceptions explicitly in the documentation (for their
Fred Drake <fdrake@acm.org>
parents: 16114
diff changeset
886 return "<dl><dt><b>exception $idx</b>\n<dd>" . $_ . '</dl>'
7760
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
887 }
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
888
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
889 sub do_env_fulllineitems{ return do_env_itemize(@_); }
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
890
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
891
14491
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
892 sub handle_classlike_descriptor{
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
893 local($_, $what) = @_;
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
894 $THIS_CLASS = next_argument();
14556
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
895 my $arg_list = convert_args(next_argument());
9775
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
896 $idx = make_str_index_entry(
14491
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
897 "<tt class='$what'>$THIS_CLASS</tt> ($what in $THIS_MODULE)" );
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
898 $idx =~ s/ \(.*\)//;
17249
6d30552cb4f9 Remove the spurious space of uncertain origin from the output for function,
Fred Drake <fdrake@acm.org>
parents: 16966
diff changeset
899 return ("<dl><dt><b>$what $idx</b>(<var>$arg_list</var>)\n<dd>"
16966
38e17a089492 Label classes and exceptions explicitly in the documentation (for their
Fred Drake <fdrake@acm.org>
parents: 16114
diff changeset
900 . $_
38e17a089492 Label classes and exceptions explicitly in the documentation (for their
Fred Drake <fdrake@acm.org>
parents: 16114
diff changeset
901 . '</dl>');
7760
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
902 }
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
903
14491
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
904 sub do_env_classdesc{
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
905 return handle_classlike_descriptor(@_[0], "class");
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
906 }
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
907
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
908 sub do_env_excclassdesc{
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
909 return handle_classlike_descriptor(@_[0], "exception");
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
910 }
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
911
7760
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
912
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
913 sub do_env_methoddesc{
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
914 local($_) = @_;
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
915 my $class_name = next_optional_argument();
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
916 $class_name = $THIS_CLASS
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
917 unless $class_name;
9848
e19cd8ec20a2 do_cmd_methodline(): Fixed reference to method name when generating
Fred Drake <fdrake@acm.org>
parents: 9775
diff changeset
918 my $method = next_argument();
14556
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
919 my $arg_list = convert_args(next_argument());
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
920 my $extra = '';
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
921 if ($class_name) {
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
922 $extra = " ($class_name method)";
7760
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
923 }
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
924 my $idx = make_str_index_entry("<tt class='method'>$method()</tt>$extra");
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
925 $idx =~ s/ \(.*\)//;
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
926 $idx =~ s/\(\)//;
17249
6d30552cb4f9 Remove the spurious space of uncertain origin from the output for function,
Fred Drake <fdrake@acm.org>
parents: 16966
diff changeset
927 return "<dl><dt><b>$idx</b>(<var>$arg_list</var>)\n<dd>" . $_ . '</dl>';
7711
56dcfc27710a Coding cleanups.
Fred Drake <fdrake@acm.org>
parents: 7671
diff changeset
928 }
56dcfc27710a Coding cleanups.
Fred Drake <fdrake@acm.org>
parents: 7671
diff changeset
929
7760
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
930
9769
e1508f72c610 do_cmd_methodline(): New function, implements indexing version of
Fred Drake <fdrake@acm.org>
parents: 9718
diff changeset
931 sub do_cmd_methodline{
e1508f72c610 do_cmd_methodline(): New function, implements indexing version of
Fred Drake <fdrake@acm.org>
parents: 9718
diff changeset
932 local($_) = @_;
e1508f72c610 do_cmd_methodline(): New function, implements indexing version of
Fred Drake <fdrake@acm.org>
parents: 9718
diff changeset
933 my $class_name = next_optional_argument();
e1508f72c610 do_cmd_methodline(): New function, implements indexing version of
Fred Drake <fdrake@acm.org>
parents: 9718
diff changeset
934 $class_name = $THIS_CLASS
e1508f72c610 do_cmd_methodline(): New function, implements indexing version of
Fred Drake <fdrake@acm.org>
parents: 9718
diff changeset
935 unless $class_name;
e1508f72c610 do_cmd_methodline(): New function, implements indexing version of
Fred Drake <fdrake@acm.org>
parents: 9718
diff changeset
936 my $method = next_argument();
14556
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
937 my $arg_list = convert_args(next_argument());
9769
e1508f72c610 do_cmd_methodline(): New function, implements indexing version of
Fred Drake <fdrake@acm.org>
parents: 9718
diff changeset
938 my $extra = '';
e1508f72c610 do_cmd_methodline(): New function, implements indexing version of
Fred Drake <fdrake@acm.org>
parents: 9718
diff changeset
939 if ($class_name) {
e1508f72c610 do_cmd_methodline(): New function, implements indexing version of
Fred Drake <fdrake@acm.org>
parents: 9718
diff changeset
940 $extra = " ($class_name method)";
e1508f72c610 do_cmd_methodline(): New function, implements indexing version of
Fred Drake <fdrake@acm.org>
parents: 9718
diff changeset
941 }
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
942 my $idx = make_str_index_entry("<tt class='method'>$method()</tt>$extra");
9769
e1508f72c610 do_cmd_methodline(): New function, implements indexing version of
Fred Drake <fdrake@acm.org>
parents: 9718
diff changeset
943 $idx =~ s/ \(.*\)//;
e1508f72c610 do_cmd_methodline(): New function, implements indexing version of
Fred Drake <fdrake@acm.org>
parents: 9718
diff changeset
944 $idx =~ s/\(\)//;
17249
6d30552cb4f9 Remove the spurious space of uncertain origin from the output for function,
Fred Drake <fdrake@acm.org>
parents: 16966
diff changeset
945 return "<dt><b>$idx</b>(<var>$arg_list</var>)\n<dd>"
9769
e1508f72c610 do_cmd_methodline(): New function, implements indexing version of
Fred Drake <fdrake@acm.org>
parents: 9718
diff changeset
946 . $_;
e1508f72c610 do_cmd_methodline(): New function, implements indexing version of
Fred Drake <fdrake@acm.org>
parents: 9718
diff changeset
947 }
e1508f72c610 do_cmd_methodline(): New function, implements indexing version of
Fred Drake <fdrake@acm.org>
parents: 9718
diff changeset
948
e1508f72c610 do_cmd_methodline(): New function, implements indexing version of
Fred Drake <fdrake@acm.org>
parents: 9718
diff changeset
949
9085
e943f9c09901 do_cmd_methodlineni(): New function, needed because the ref. manual now
Fred Drake <fdrake@acm.org>
parents: 8917
diff changeset
950 sub do_cmd_methodlineni{
e943f9c09901 do_cmd_methodlineni(): New function, needed because the ref. manual now
Fred Drake <fdrake@acm.org>
parents: 8917
diff changeset
951 local($_) = @_;
e943f9c09901 do_cmd_methodlineni(): New function, needed because the ref. manual now
Fred Drake <fdrake@acm.org>
parents: 8917
diff changeset
952 next_optional_argument();
e943f9c09901 do_cmd_methodlineni(): New function, needed because the ref. manual now
Fred Drake <fdrake@acm.org>
parents: 8917
diff changeset
953 my $method = next_argument();
14556
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
954 my $arg_list = convert_args(next_argument());
17249
6d30552cb4f9 Remove the spurious space of uncertain origin from the output for function,
Fred Drake <fdrake@acm.org>
parents: 16966
diff changeset
955 return "<dt><b>$method</b>(<var>$arg_list</var>)\n<dd>"
9085
e943f9c09901 do_cmd_methodlineni(): New function, needed because the ref. manual now
Fred Drake <fdrake@acm.org>
parents: 8917
diff changeset
956 . $_;
e943f9c09901 do_cmd_methodlineni(): New function, needed because the ref. manual now
Fred Drake <fdrake@acm.org>
parents: 8917
diff changeset
957 }
e943f9c09901 do_cmd_methodlineni(): New function, needed because the ref. manual now
Fred Drake <fdrake@acm.org>
parents: 8917
diff changeset
958
7760
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
959 sub do_env_methoddescni{
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
960 local($_) = @_;
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
961 next_optional_argument();
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
962 my $method = next_argument();
14556
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
963 my $arg_list = convert_args(next_argument());
17249
6d30552cb4f9 Remove the spurious space of uncertain origin from the output for function,
Fred Drake <fdrake@acm.org>
parents: 16966
diff changeset
964 return "<dl><dt><b>$method</b>(<var>$arg_list</var>)\n<dd>"
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
965 . $_
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
966 . '</dl>';
7760
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
967 }
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
968
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
969
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
970 sub do_env_memberdesc{
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
971 local($_) = @_;
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
972 my $class = next_optional_argument();
9775
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
973 my $member = next_argument();
7760
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
974 $class = $THIS_CLASS
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
975 unless $class;
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
976 my $extra = '';
10637
bed15a015c1c Fix some remaining index & consistency nits. (Many data member
Fred Drake <fdrake@acm.org>
parents: 10598
diff changeset
977 $extra = " ($class attribute)"
bed15a015c1c Fix some remaining index & consistency nits. (Many data member
Fred Drake <fdrake@acm.org>
parents: 10598
diff changeset
978 if ($class ne '');
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
979 my $idx = make_str_index_entry("<tt class='member'>$member</tt>$extra");
7760
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
980 $idx =~ s/ \(.*\)//;
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
981 $idx =~ s/\(\)//;
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
982 return "<dl><dt><b>$idx</b>\n<dd>" . $_ . '</dl>';
7760
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
983 }
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
984
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
985
8086
692be123f547 next_optional_argument(): Don't include the square brackets in the return
Fred Drake <fdrake@acm.org>
parents: 8074
diff changeset
986 sub do_cmd_memberline{
692be123f547 next_optional_argument(): Don't include the square brackets in the return
Fred Drake <fdrake@acm.org>
parents: 8074
diff changeset
987 local($_) = @_;
692be123f547 next_optional_argument(): Don't include the square brackets in the return
Fred Drake <fdrake@acm.org>
parents: 8074
diff changeset
988 my $class = next_optional_argument();
9775
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
989 my $member = next_argument();
8086
692be123f547 next_optional_argument(): Don't include the square brackets in the return
Fred Drake <fdrake@acm.org>
parents: 8074
diff changeset
990 $class = $THIS_CLASS
692be123f547 next_optional_argument(): Don't include the square brackets in the return
Fred Drake <fdrake@acm.org>
parents: 8074
diff changeset
991 unless $class;
692be123f547 next_optional_argument(): Don't include the square brackets in the return
Fred Drake <fdrake@acm.org>
parents: 8074
diff changeset
992 my $extra = '';
10637
bed15a015c1c Fix some remaining index & consistency nits. (Many data member
Fred Drake <fdrake@acm.org>
parents: 10598
diff changeset
993 $extra = " ($class attribute)"
bed15a015c1c Fix some remaining index & consistency nits. (Many data member
Fred Drake <fdrake@acm.org>
parents: 10598
diff changeset
994 if ($class ne '');
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
995 my $idx = make_str_index_entry("<tt class='member'>$member</tt>$extra");
8086
692be123f547 next_optional_argument(): Don't include the square brackets in the return
Fred Drake <fdrake@acm.org>
parents: 8074
diff changeset
996 $idx =~ s/ \(.*\)//;
692be123f547 next_optional_argument(): Don't include the square brackets in the return
Fred Drake <fdrake@acm.org>
parents: 8074
diff changeset
997 $idx =~ s/\(\)//;
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
998 return "<dt><b>$idx</b><dd>" . $_;
8086
692be123f547 next_optional_argument(): Don't include the square brackets in the return
Fred Drake <fdrake@acm.org>
parents: 8074
diff changeset
999 }
692be123f547 next_optional_argument(): Don't include the square brackets in the return
Fred Drake <fdrake@acm.org>
parents: 8074
diff changeset
1000
7760
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
1001 sub do_env_memberdescni{
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
1002 local($_) = @_;
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
1003 next_optional_argument();
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
1004 my $member = next_argument();
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1005 return "<dl><dt><b><tt class='member'>$member</tt></b>\n<dd>"
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1006 . $_
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1007 . '</dl>';
7760
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
1008 }
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
1009
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
1010
8086
692be123f547 next_optional_argument(): Don't include the square brackets in the return
Fred Drake <fdrake@acm.org>
parents: 8074
diff changeset
1011 sub do_cmd_memberlineni{
692be123f547 next_optional_argument(): Don't include the square brackets in the return
Fred Drake <fdrake@acm.org>
parents: 8074
diff changeset
1012 local($_) = @_;
692be123f547 next_optional_argument(): Don't include the square brackets in the return
Fred Drake <fdrake@acm.org>
parents: 8074
diff changeset
1013 next_optional_argument();
692be123f547 next_optional_argument(): Don't include the square brackets in the return
Fred Drake <fdrake@acm.org>
parents: 8074
diff changeset
1014 my $member = next_argument();
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1015 return "<dt><b><tt class='member'>$member</tt></b><dd>" . $_;
8086
692be123f547 next_optional_argument(): Don't include the square brackets in the return
Fred Drake <fdrake@acm.org>
parents: 8074
diff changeset
1016 }
692be123f547 next_optional_argument(): Don't include the square brackets in the return
Fred Drake <fdrake@acm.org>
parents: 8074
diff changeset
1017
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1018 @col_aligns = ('<td>', '<td>', '<td>', '<td>');
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1019
10769
1af7a1467088 Control the layout of output tables a little better so they're easier
Fred Drake <fdrake@acm.org>
parents: 10767
diff changeset
1020 sub fix_font{
1af7a1467088 Control the layout of output tables a little better so they're easier
Fred Drake <fdrake@acm.org>
parents: 10767
diff changeset
1021 # do a little magic on a font name to get the right behavior in the first
1af7a1467088 Control the layout of output tables a little better so they're easier
Fred Drake <fdrake@acm.org>
parents: 10767
diff changeset
1022 # column of the output table
1af7a1467088 Control the layout of output tables a little better so they're easier
Fred Drake <fdrake@acm.org>
parents: 10767
diff changeset
1023 my $font = @_[0];
1af7a1467088 Control the layout of output tables a little better so they're easier
Fred Drake <fdrake@acm.org>
parents: 10767
diff changeset
1024 if ($font eq 'textrm') {
1af7a1467088 Control the layout of output tables a little better so they're easier
Fred Drake <fdrake@acm.org>
parents: 10767
diff changeset
1025 $font = '';
1af7a1467088 Control the layout of output tables a little better so they're easier
Fred Drake <fdrake@acm.org>
parents: 10767
diff changeset
1026 }
1af7a1467088 Control the layout of output tables a little better so they're easier
Fred Drake <fdrake@acm.org>
parents: 10767
diff changeset
1027 elsif ($font eq 'file' || $font eq 'filenq') {
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1028 $font = 'tt class="file"';
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1029 }
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1030 elsif ($font eq 'member') {
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1031 $font = 'tt class="member"';
10769
1af7a1467088 Control the layout of output tables a little better so they're easier
Fred Drake <fdrake@acm.org>
parents: 10767
diff changeset
1032 }
15459
a79d3624f845 A few small refinements to the table building code.
Fred Drake <fdrake@acm.org>
parents: 15363
diff changeset
1033 elsif ($font eq 'class') {
a79d3624f845 A few small refinements to the table building code.
Fred Drake <fdrake@acm.org>
parents: 15363
diff changeset
1034 $font = 'tt class="class"';
a79d3624f845 A few small refinements to the table building code.
Fred Drake <fdrake@acm.org>
parents: 15363
diff changeset
1035 }
13077
03b1cc47a86d Support constant as a font name for the first column of a table using the
Fred Drake <fdrake@acm.org>
parents: 12928
diff changeset
1036 elsif ($font eq 'constant') {
03b1cc47a86d Support constant as a font name for the first column of a table using the
Fred Drake <fdrake@acm.org>
parents: 12928
diff changeset
1037 $font = 'tt class="constant"';
03b1cc47a86d Support constant as a font name for the first column of a table using the
Fred Drake <fdrake@acm.org>
parents: 12928
diff changeset
1038 }
13899
25de7193f9fc fix_font(): Handle one more case for the magical first column of tables.
Fred Drake <fdrake@acm.org>
parents: 13831
diff changeset
1039 elsif ($font eq 'kbd') {
25de7193f9fc fix_font(): Handle one more case for the magical first column of tables.
Fred Drake <fdrake@acm.org>
parents: 13831
diff changeset
1040 $font = 'kbd';
25de7193f9fc fix_font(): Handle one more case for the magical first column of tables.
Fred Drake <fdrake@acm.org>
parents: 13831
diff changeset
1041 }
15322
d17ba141480a Rename $PYTHON_VERSION to $PACKAGE_VERSION; this is the version number for
Fred Drake <fdrake@acm.org>
parents: 14987
diff changeset
1042 elsif ($font eq 'programopt') {
d17ba141480a Rename $PYTHON_VERSION to $PACKAGE_VERSION; this is the version number for
Fred Drake <fdrake@acm.org>
parents: 14987
diff changeset
1043 $font = 'b';
d17ba141480a Rename $PYTHON_VERSION to $PACKAGE_VERSION; this is the version number for
Fred Drake <fdrake@acm.org>
parents: 14987
diff changeset
1044 }
16114
44fd1a7cb279 Fix \seepep handling -- correct URL to the online PEP repository on SF is
Fred Drake <fdrake@acm.org>
parents: 15567
diff changeset
1045 elsif ($font eq 'exception') {
44fd1a7cb279 Fix \seepep handling -- correct URL to the online PEP repository on SF is
Fred Drake <fdrake@acm.org>
parents: 15567
diff changeset
1046 $font = 'tt class="exception"';
44fd1a7cb279 Fix \seepep handling -- correct URL to the online PEP repository on SF is
Fred Drake <fdrake@acm.org>
parents: 15567
diff changeset
1047 }
10769
1af7a1467088 Control the layout of output tables a little better so they're easier
Fred Drake <fdrake@acm.org>
parents: 10767
diff changeset
1048 return $font;
1af7a1467088 Control the layout of output tables a little better so they're easier
Fred Drake <fdrake@acm.org>
parents: 10767
diff changeset
1049 }
1af7a1467088 Control the layout of output tables a little better so they're easier
Fred Drake <fdrake@acm.org>
parents: 10767
diff changeset
1050
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1051 sub figure_column_alignment{
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1052 my $a = @_[0];
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1053 my $mark = substr($a, 0, 1);
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1054 my $r = '';
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1055 if ($mark eq 'c')
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1056 { $r = ' align="center"'; }
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1057 elsif ($mark eq 'r')
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1058 { $r = ' align="right"'; }
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1059 elsif ($mark eq 'l')
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1060 { $r = ' align="left"'; }
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1061 elsif ($mark eq 'p')
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1062 { $r = ' align="left"'; }
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1063 return $r;
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1064 }
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1065
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1066 sub setup_column_alignments{
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1067 local($_) = @_;
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1068 my($s1,$s2,$s3,$s4) = split(/[|]/,$_);
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1069 my $a1 = figure_column_alignment($s1);
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1070 my $a2 = figure_column_alignment($s2);
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1071 my $a3 = figure_column_alignment($s3);
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1072 my $a4 = figure_column_alignment($s4);
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1073 $col_aligns[0] = "<td$a1 valign=\"baseline\">";
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1074 $col_aligns[1] = "<td$a2>";
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1075 $col_aligns[2] = "<td$a3>";
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1076 $col_aligns[3] = "<td$a4>";
10767
e37074b6e78c do_cmd_seetext(): Clean up so we get proper nesting of <div>s. This
Fred Drake <fdrake@acm.org>
parents: 10641
diff changeset
1077 # return the aligned header start tags
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1078 return ("<th$a1>", "<th$a2>", "<th$a3>", "<th$a4>");
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1079 }
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1080
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1081 sub get_table_col1_fonts{
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1082 my $font = $globals{'lineifont'};
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1083 my ($sfont,$efont) = ('', '');
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1084 if ($font) {
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1085 $sfont = "<$font>";
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1086 $efont = "</$font>";
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1087 $efont =~ s/ .*>/>/;
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1088 }
15459
a79d3624f845 A few small refinements to the table building code.
Fred Drake <fdrake@acm.org>
parents: 15363
diff changeset
1089 return ($sfont, $efont);
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1090 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1091
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1092 sub do_env_tableii{
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1093 local($_) = @_;
8754
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1094 my($th1,$th2,$th3,$th4) = setup_column_alignments(next_argument());
10769
1af7a1467088 Control the layout of output tables a little better so they're easier
Fred Drake <fdrake@acm.org>
parents: 10767
diff changeset
1095 my $font = fix_font(next_argument());
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
1096 my $h1 = next_argument();
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
1097 my $h2 = next_argument();
10769
1af7a1467088 Control the layout of output tables a little better so they're easier
Fred Drake <fdrake@acm.org>
parents: 10767
diff changeset
1098 s/[\s\n]+//;
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
1099 $globals{'lineifont'} = $font;
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1100 my $a1 = $col_aligns[0];
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1101 my $a2 = $col_aligns[1];
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1102 s/\\lineii</\\lineii[$a1|$a2]</g;
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1103 return '<table border align="center" style="border-collapse: collapse">'
15349
0c19672d47bb Normalize the HTML generated for table headers.
Fred Drake <fdrake@acm.org>
parents: 15322
diff changeset
1104 . "\n <thead>"
0c19672d47bb Normalize the HTML generated for table headers.
Fred Drake <fdrake@acm.org>
parents: 15322
diff changeset
1105 . "\n <tr class=\"tableheader\">"
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1106 . "\n $th1<b>$h1</b>\&nbsp;</th>"
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1107 . "\n $th2<b>$h2</b>\&nbsp;</th>"
15349
0c19672d47bb Normalize the HTML generated for table headers.
Fred Drake <fdrake@acm.org>
parents: 15322
diff changeset
1108 . "\n </tr>"
10769
1af7a1467088 Control the layout of output tables a little better so they're easier
Fred Drake <fdrake@acm.org>
parents: 10767
diff changeset
1109 . "\n </thead>"
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1110 . "\n <tbody valign='baseline'>"
15349
0c19672d47bb Normalize the HTML generated for table headers.
Fred Drake <fdrake@acm.org>
parents: 15322
diff changeset
1111 . $_
10769
1af7a1467088 Control the layout of output tables a little better so they're easier
Fred Drake <fdrake@acm.org>
parents: 10767
diff changeset
1112 . "\n </tbody>"
1af7a1467088 Control the layout of output tables a little better so they're easier
Fred Drake <fdrake@acm.org>
parents: 10767
diff changeset
1113 . "\n</table>";
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1114 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1115
14722
4d2e9cf1eb20 Add new environments: longtableii, longtableiii, and longtableiv, to
Fred Drake <fdrake@acm.org>
parents: 14556
diff changeset
1116 sub do_env_longtableii{
4d2e9cf1eb20 Add new environments: longtableii, longtableiii, and longtableiv, to
Fred Drake <fdrake@acm.org>
parents: 14556
diff changeset
1117 return do_env_tableii(@_);
4d2e9cf1eb20 Add new environments: longtableii, longtableiii, and longtableiv, to
Fred Drake <fdrake@acm.org>
parents: 14556
diff changeset
1118 }
4d2e9cf1eb20 Add new environments: longtableii, longtableiii, and longtableiv, to
Fred Drake <fdrake@acm.org>
parents: 14556
diff changeset
1119
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1120 sub do_cmd_lineii{
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1121 local($_) = @_;
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1122 my $aligns = next_optional_argument();
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
1123 my $c1 = next_argument();
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
1124 my $c2 = next_argument();
10769
1af7a1467088 Control the layout of output tables a little better so they're easier
Fred Drake <fdrake@acm.org>
parents: 10767
diff changeset
1125 s/[\s\n]+//;
15459
a79d3624f845 A few small refinements to the table building code.
Fred Drake <fdrake@acm.org>
parents: 15363
diff changeset
1126 my($sfont,$efont) = get_table_col1_fonts();
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1127 $c2 = '&nbsp;' if ($c2 eq '');
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1128 my($c1align,$c2align) = split('\|', $aligns);
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1129 my $padding = '';
15459
a79d3624f845 A few small refinements to the table building code.
Fred Drake <fdrake@acm.org>
parents: 15363
diff changeset
1130 if ($c1align =~ /align="right"/ || $c1 eq '') {
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1131 $padding = '&nbsp;';
7798
49f11eb4eb9a This fixes a (minor) problem discovered by AMK when you don't want any
Fred Drake <fdrake@acm.org>
parents: 7779
diff changeset
1132 }
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1133 return "\n <tr>$c1align$sfont$c1$efont$padding</td>\n"
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1134 . " $c2align$c2</td>"
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1135 . $_;
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1136 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1137
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1138 sub do_env_tableiii{
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1139 local($_) = @_;
8754
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1140 my($th1,$th2,$th3,$th4) = setup_column_alignments(next_argument());
10769
1af7a1467088 Control the layout of output tables a little better so they're easier
Fred Drake <fdrake@acm.org>
parents: 10767
diff changeset
1141 my $font = fix_font(next_argument());
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
1142 my $h1 = next_argument();
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
1143 my $h2 = next_argument();
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
1144 my $h3 = next_argument();
10769
1af7a1467088 Control the layout of output tables a little better so they're easier
Fred Drake <fdrake@acm.org>
parents: 10767
diff changeset
1145 s/[\s\n]+//;
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
1146 $globals{'lineifont'} = $font;
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1147 my $a1 = $col_aligns[0];
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1148 my $a2 = $col_aligns[1];
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1149 my $a3 = $col_aligns[2];
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1150 s/\\lineiii</\\lineiii[$a1|$a2|$a3]</g;
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1151 return '<table border align="center" style="border-collapse: collapse">'
15349
0c19672d47bb Normalize the HTML generated for table headers.
Fred Drake <fdrake@acm.org>
parents: 15322
diff changeset
1152 . "\n <thead>"
0c19672d47bb Normalize the HTML generated for table headers.
Fred Drake <fdrake@acm.org>
parents: 15322
diff changeset
1153 . "\n <tr class=\"tableheader\">"
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1154 . "\n $th1<b>$h1</b>\&nbsp;</th>"
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1155 . "\n $th2<b>$h2</b>\&nbsp;</th>"
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1156 . "\n $th3<b>$h3</b>\&nbsp;</th>"
15349
0c19672d47bb Normalize the HTML generated for table headers.
Fred Drake <fdrake@acm.org>
parents: 15322
diff changeset
1157 . "\n </tr>"
10769
1af7a1467088 Control the layout of output tables a little better so they're easier
Fred Drake <fdrake@acm.org>
parents: 10767
diff changeset
1158 . "\n </thead>"
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1159 . "\n <tbody valign='baseline'>"
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1160 . $_
10769
1af7a1467088 Control the layout of output tables a little better so they're easier
Fred Drake <fdrake@acm.org>
parents: 10767
diff changeset
1161 . "\n </tbody>"
1af7a1467088 Control the layout of output tables a little better so they're easier
Fred Drake <fdrake@acm.org>
parents: 10767
diff changeset
1162 . "\n</table>";
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1163 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1164
14722
4d2e9cf1eb20 Add new environments: longtableii, longtableiii, and longtableiv, to
Fred Drake <fdrake@acm.org>
parents: 14556
diff changeset
1165 sub do_env_longtableiii{
4d2e9cf1eb20 Add new environments: longtableii, longtableiii, and longtableiv, to
Fred Drake <fdrake@acm.org>
parents: 14556
diff changeset
1166 return do_env_tableiii(@_);
4d2e9cf1eb20 Add new environments: longtableii, longtableiii, and longtableiv, to
Fred Drake <fdrake@acm.org>
parents: 14556
diff changeset
1167 }
4d2e9cf1eb20 Add new environments: longtableii, longtableiii, and longtableiv, to
Fred Drake <fdrake@acm.org>
parents: 14556
diff changeset
1168
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1169 sub do_cmd_lineiii{
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1170 local($_) = @_;
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1171 my $aligns = next_optional_argument();
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
1172 my $c1 = next_argument();
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
1173 my $c2 = next_argument();
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
1174 my $c3 = next_argument();
10769
1af7a1467088 Control the layout of output tables a little better so they're easier
Fred Drake <fdrake@acm.org>
parents: 10767
diff changeset
1175 s/[\s\n]+//;
15459
a79d3624f845 A few small refinements to the table building code.
Fred Drake <fdrake@acm.org>
parents: 15363
diff changeset
1176 my($sfont,$efont) = get_table_col1_fonts();
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1177 $c3 = '&nbsp;' if ($c3 eq '');
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1178 my($c1align,$c2align,$c3align) = split('\|', $aligns);
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1179 my $padding = '';
15459
a79d3624f845 A few small refinements to the table building code.
Fred Drake <fdrake@acm.org>
parents: 15363
diff changeset
1180 if ($c1align =~ /align="right"/ || $c1 eq '') {
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1181 $padding = '&nbsp;';
7798
49f11eb4eb9a This fixes a (minor) problem discovered by AMK when you don't want any
Fred Drake <fdrake@acm.org>
parents: 7779
diff changeset
1182 }
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1183 return "\n <tr>$c1align$sfont$c1$efont$padding</td>\n"
10769
1af7a1467088 Control the layout of output tables a little better so they're easier
Fred Drake <fdrake@acm.org>
parents: 10767
diff changeset
1184 . " $c2align$c2</td>\n"
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1185 . " $c3align$c3</td>"
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1186 . $_;
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1187 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1188
8754
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1189 sub do_env_tableiv{
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1190 local($_) = @_;
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1191 my($th1,$th2,$th3,$th4) = setup_column_alignments(next_argument());
10769
1af7a1467088 Control the layout of output tables a little better so they're easier
Fred Drake <fdrake@acm.org>
parents: 10767
diff changeset
1192 my $font = fix_font(next_argument());
8754
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1193 my $h1 = next_argument();
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1194 my $h2 = next_argument();
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1195 my $h3 = next_argument();
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1196 my $h4 = next_argument();
10769
1af7a1467088 Control the layout of output tables a little better so they're easier
Fred Drake <fdrake@acm.org>
parents: 10767
diff changeset
1197 s/[\s\n]+//;
8754
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1198 $globals{'lineifont'} = $font;
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1199 my $a1 = $col_aligns[0];
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1200 my $a2 = $col_aligns[1];
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1201 my $a3 = $col_aligns[2];
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1202 my $a4 = $col_aligns[3];
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1203 s/\\lineiv</\\lineiv[$a1|$a2|$a3|$a4]</g;
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1204 return '<table border align="center" style="border-collapse: collapse">'
15349
0c19672d47bb Normalize the HTML generated for table headers.
Fred Drake <fdrake@acm.org>
parents: 15322
diff changeset
1205 . "\n <thead>"
0c19672d47bb Normalize the HTML generated for table headers.
Fred Drake <fdrake@acm.org>
parents: 15322
diff changeset
1206 . "\n <tr class=\"tableheader\">"
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1207 . "\n $th1<b>$h1</b>\&nbsp;</th>"
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1208 . "\n $th2<b>$h2</b>\&nbsp;</th>"
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1209 . "\n $th3<b>$h3</b>\&nbsp;</th>"
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1210 . "\n $th4<b>$h4</b>\&nbsp;</th>"
15349
0c19672d47bb Normalize the HTML generated for table headers.
Fred Drake <fdrake@acm.org>
parents: 15322
diff changeset
1211 . "\n </tr>"
10769
1af7a1467088 Control the layout of output tables a little better so they're easier
Fred Drake <fdrake@acm.org>
parents: 10767
diff changeset
1212 . "\n </thead>"
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1213 . "\n <tbody valign='baseline'>"
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1214 . $_
10769
1af7a1467088 Control the layout of output tables a little better so they're easier
Fred Drake <fdrake@acm.org>
parents: 10767
diff changeset
1215 . "\n </tbody>"
1af7a1467088 Control the layout of output tables a little better so they're easier
Fred Drake <fdrake@acm.org>
parents: 10767
diff changeset
1216 . "\n</table>";
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1217 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1218
14722
4d2e9cf1eb20 Add new environments: longtableii, longtableiii, and longtableiv, to
Fred Drake <fdrake@acm.org>
parents: 14556
diff changeset
1219 sub do_env_longtableiv{
4d2e9cf1eb20 Add new environments: longtableii, longtableiii, and longtableiv, to
Fred Drake <fdrake@acm.org>
parents: 14556
diff changeset
1220 return do_env_tableiv(@_);
4d2e9cf1eb20 Add new environments: longtableii, longtableiii, and longtableiv, to
Fred Drake <fdrake@acm.org>
parents: 14556
diff changeset
1221 }
4d2e9cf1eb20 Add new environments: longtableii, longtableiii, and longtableiv, to
Fred Drake <fdrake@acm.org>
parents: 14556
diff changeset
1222
8754
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1223 sub do_cmd_lineiv{
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1224 local($_) = @_;
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1225 my $aligns = next_optional_argument();
8754
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1226 my $c1 = next_argument();
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1227 my $c2 = next_argument();
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1228 my $c3 = next_argument();
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1229 my $c4 = next_argument();
10769
1af7a1467088 Control the layout of output tables a little better so they're easier
Fred Drake <fdrake@acm.org>
parents: 10767
diff changeset
1230 s/[\s\n]+//;
15459
a79d3624f845 A few small refinements to the table building code.
Fred Drake <fdrake@acm.org>
parents: 15363
diff changeset
1231 my($sfont,$efont) = get_table_col1_fonts();
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1232 $c4 = '&nbsp;' if ($c4 eq '');
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1233 my($c1align,$c2align,$c3align,$c4align) = split('\|', $aligns);
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1234 my $padding = '';
15459
a79d3624f845 A few small refinements to the table building code.
Fred Drake <fdrake@acm.org>
parents: 15363
diff changeset
1235 if ($c1align =~ /align="right"/ || $c1 eq '') {
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1236 $padding = '&nbsp;';
8754
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1237 }
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1238 return "\n <tr>$c1align$sfont$c1$efont$padding</td>\n"
10769
1af7a1467088 Control the layout of output tables a little better so they're easier
Fred Drake <fdrake@acm.org>
parents: 10767
diff changeset
1239 . " $c2align$c2</td>\n"
1af7a1467088 Control the layout of output tables a little better so they're easier
Fred Drake <fdrake@acm.org>
parents: 10767
diff changeset
1240 . " $c3align$c3</td>\n"
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1241 . " $c4align$c4</td>"
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1242 . $_;
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1243 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1244
14285
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1245
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1246 # These can be used to control the title page appearance;
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1247 # they need a little bit of documentation.
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1248 #
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1249 # If $TITLE_PAGE_GRAPHIC is set, it should be the name of a file in the
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1250 # $ICONSERVER directory, or include path information (other than "./"). The
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1251 # default image type will be assumed if an extension is not provided.
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1252 #
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1253 # If specified, the "title page" will contain two colums: one containing the
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1254 # title/author/etc., and the other containing the graphic. Use the other
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1255 # four variables listed here to control specific details of the layout; all
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1256 # are optional.
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1257 #
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1258 # $TITLE_PAGE_GRAPHIC = "my-company-logo";
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1259 # $TITLE_PAGE_GRAPHIC_COLWIDTH = "30%";
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1260 # $TITLE_PAGE_GRAPHIC_WIDTH = 150;
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1261 # $TITLE_PAGE_GRAPHIC_HEIGHT = 150;
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1262 # $TITLE_PAGE_GRAPHIC_ON_RIGHT = 0;
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1263
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1264 sub make_my_titlepage() {
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1265 my $the_title = "";
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1266 if ($t_title) {
10197
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
1267 $the_title .= "\n<h1>$t_title</h1>";
14285
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1268 }
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1269 else {
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1270 write_warnings("\nThis document has no title.");
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1271 }
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1272 if ($t_author) {
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1273 if ($t_authorURL) {
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
1274 my $href = translate_commands($t_authorURL);
10128
0dd4fafefd6c do_cmd_maketitle(): Small nit in creating the "title page".
Fred Drake <fdrake@acm.org>
parents: 10127
diff changeset
1275 $href = make_named_href('author', $href,
0dd4fafefd6c do_cmd_maketitle(): Small nit in creating the "title page".
Fred Drake <fdrake@acm.org>
parents: 10127
diff changeset
1276 "<b><font size='+2'>$t_author</font></b>");
7711
56dcfc27710a Coding cleanups.
Fred Drake <fdrake@acm.org>
parents: 7671
diff changeset
1277 $the_title .= "\n<p>$href</p>";
14285
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1278 }
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1279 else {
10128
0dd4fafefd6c do_cmd_maketitle(): Small nit in creating the "title page".
Fred Drake <fdrake@acm.org>
parents: 10127
diff changeset
1280 $the_title .= ("\n<p><b><font size='+2'>$t_author</font></b></p>");
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1281 }
14285
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1282 }
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1283 else {
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1284 write_warnings("\nThere is no author for this document.");
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1285 }
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1286 if ($t_institute) {
14285
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1287 $the_title .= "\n<p>$t_institute</p>";
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1288 }
8342
22815a0b1267 Added support for \developer, \developers, \developersaddress.
Fred Drake <fdrake@acm.org>
parents: 8294
diff changeset
1289 if ($DEVELOPER_ADDRESS) {
14285
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1290 $the_title .= "\n<p>$DEVELOPER_ADDRESS</p>";
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1291 }
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1292 if ($t_affil) {
14285
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1293 $the_title .= "\n<p><i>$t_affil</i></p>";
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1294 }
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1295 if ($t_date) {
15567
d38516ce6f14 For the title page, insert the package version number before the date.
Fred Drake <fdrake@acm.org>
parents: 15459
diff changeset
1296 $the_title .= "\n<p>";
15322
d17ba141480a Rename $PYTHON_VERSION to $PACKAGE_VERSION; this is the version number for
Fred Drake <fdrake@acm.org>
parents: 14987
diff changeset
1297 if ($PACKAGE_VERSION) {
15567
d38516ce6f14 For the title page, insert the package version number before the date.
Fred Drake <fdrake@acm.org>
parents: 15459
diff changeset
1298 $the_title .= "<strong>Release $PACKAGE_VERSION</strong><br>\n";
14285
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1299 }
15567
d38516ce6f14 For the title page, insert the package version number before the date.
Fred Drake <fdrake@acm.org>
parents: 15459
diff changeset
1300 $the_title .= "<strong>$t_date</strong></p>"
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1301 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1302 if ($t_address) {
7711
56dcfc27710a Coding cleanups.
Fred Drake <fdrake@acm.org>
parents: 7671
diff changeset
1303 $the_title .= "\n<p>$t_address</p>";
14285
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1304 }
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1305 else {
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1306 $the_title .= "\n<p>";
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1307 }
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1308 if ($t_email) {
7711
56dcfc27710a Coding cleanups.
Fred Drake <fdrake@acm.org>
parents: 7671
diff changeset
1309 $the_title .= "\n<p>$t_email</p>";
14285
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1310 }
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1311 return $the_title;
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1312 }
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1313
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1314 sub make_my_titlegraphic() {
14970
6af9aa15647f make_icon_filename(): Convenience function to turn a partial filename
Fred Drake <fdrake@acm.org>
parents: 14766
diff changeset
1315 my $filename = make_icon_filename($TITLE_PAGE_GRAPHIC);
14285
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1316 my $graphic = "<td class=\"titlegraphic\"";
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1317 $graphic .= " width=\"$TITLE_PAGE_GRAPHIC_COLWIDTH\""
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1318 if ($TITLE_PAGE_GRAPHIC_COLWIDTH);
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1319 $graphic .= "><img";
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1320 $graphic .= " width=\"$TITLE_PAGE_GRAPHIC_WIDTH\""
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1321 if ($TITLE_PAGE_GRAPHIC_WIDTH);
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1322 $graphic .= " height=\"$TITLE_PAGE_GRAPHIC_HEIGHT\""
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1323 if ($TITLE_PAGE_GRAPHIC_HEIGHT);
14987
bbe09cccb49b $OFF_SITE_LINK_ICON: Don't define here; simply defining it overrides a
Fred Drake <fdrake@acm.org>
parents: 14970
diff changeset
1324 $graphic .= "\n src=\"$filename\"></td>\n";
14285
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1325 return $graphic;
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1326 }
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1327
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1328 sub do_cmd_maketitle {
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1329 local($_) = @_;
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1330 my $the_title = "\n<div class=\"titlepage\">";
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1331 if ($TITLE_PAGE_GRAPHIC) {
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1332 if ($TITLE_PAGE_GRAPHIC_ON_RIGHT) {
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1333 $the_title .= ("\n<table border=\"0\" width=\"100%\">"
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1334 . "<tr align=\"right\">\n<td>"
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1335 . make_my_titlepage()
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1336 . "</td>\n"
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1337 . make_my_titlegraphic()
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1338 . "</tr>\n</table>");
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1339 }
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1340 else {
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1341 $the_title .= ("\n<table border=\"0\" width=\"100%\"><tr>\n"
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1342 . make_my_titlegraphic()
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1343 . "<td>"
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1344 . make_my_titlepage()
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1345 . "</td></tr>\n</table>");
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1346 }
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1347 }
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1348 else {
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1349 $the_title .= ("\n<center>"
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1350 . make_my_titlepage()
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1351 . "\n</center>");
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1352 }
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1353 $the_title .= "\n</div>";
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1354 return $the_title . $_;
10197
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
1355 $the_title .= "\n</center></div>";
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1356 return $the_title . $_ ;
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1357 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1358
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1359
8397
c9b7e926fd86 Added support for AMK's {definitions} environment; thanks for the reminder!
Fred Drake <fdrake@acm.org>
parents: 8349
diff changeset
1360 #
8754
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1361 # Module synopsis support
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1362 #
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1363
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1364 require SynopsisTable;
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1365
8756
fba8455dcb54 Fix up the synopsis table stuff so it gets things right at each chapter,
Fred Drake <fdrake@acm.org>
parents: 8754
diff changeset
1366 sub get_chapter_id(){
fba8455dcb54 Fix up the synopsis table stuff so it gets things right at each chapter,
Fred Drake <fdrake@acm.org>
parents: 8754
diff changeset
1367 my $id = do_cmd_thechapter('');
8820
9b0dda9a558b get_chapter_id(): Separate two aspects of string replacement to allow the
Fred Drake <fdrake@acm.org>
parents: 8780
diff changeset
1368 $id =~ s/<SPAN CLASS="arabic">(\d+)<\/SPAN>/\1/;
9b0dda9a558b get_chapter_id(): Separate two aspects of string replacement to allow the
Fred Drake <fdrake@acm.org>
parents: 8780
diff changeset
1369 $id =~ s/\.//;
8756
fba8455dcb54 Fix up the synopsis table stuff so it gets things right at each chapter,
Fred Drake <fdrake@acm.org>
parents: 8754
diff changeset
1370 return $id;
8754
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1371 }
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1372
14491
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1373 # 'chapter' => 'SynopsisTable instance'
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1374 %ModuleSynopses = ();
8756
fba8455dcb54 Fix up the synopsis table stuff so it gets things right at each chapter,
Fred Drake <fdrake@acm.org>
parents: 8754
diff changeset
1375
fba8455dcb54 Fix up the synopsis table stuff so it gets things right at each chapter,
Fred Drake <fdrake@acm.org>
parents: 8754
diff changeset
1376 sub get_synopsis_table($){
fba8455dcb54 Fix up the synopsis table stuff so it gets things right at each chapter,
Fred Drake <fdrake@acm.org>
parents: 8754
diff changeset
1377 my($chap) = @_;
fba8455dcb54 Fix up the synopsis table stuff so it gets things right at each chapter,
Fred Drake <fdrake@acm.org>
parents: 8754
diff changeset
1378 my $key;
fba8455dcb54 Fix up the synopsis table stuff so it gets things right at each chapter,
Fred Drake <fdrake@acm.org>
parents: 8754
diff changeset
1379 foreach $key (keys %ModuleSynopses) {
fba8455dcb54 Fix up the synopsis table stuff so it gets things right at each chapter,
Fred Drake <fdrake@acm.org>
parents: 8754
diff changeset
1380 if ($key eq $chap) {
fba8455dcb54 Fix up the synopsis table stuff so it gets things right at each chapter,
Fred Drake <fdrake@acm.org>
parents: 8754
diff changeset
1381 return $ModuleSynopses{$chap};
fba8455dcb54 Fix up the synopsis table stuff so it gets things right at each chapter,
Fred Drake <fdrake@acm.org>
parents: 8754
diff changeset
1382 }
8754
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1383 }
14491
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1384 my $st = SynopsisTable->new();
8756
fba8455dcb54 Fix up the synopsis table stuff so it gets things right at each chapter,
Fred Drake <fdrake@acm.org>
parents: 8754
diff changeset
1385 $ModuleSynopses{$chap} = $st;
8754
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1386 return $st;
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1387 }
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1388
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1389 sub do_cmd_moduleauthor{
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1390 local($_) = @_;
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1391 next_argument();
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1392 next_argument();
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1393 return $_;
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1394 }
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1395
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1396 sub do_cmd_sectionauthor{
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1397 local($_) = @_;
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1398 next_argument();
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1399 next_argument();
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1400 return $_;
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1401 }
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1402
8754
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1403 sub do_cmd_declaremodule{
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1404 local($_) = @_;
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1405 my $key = next_optional_argument();
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1406 my $type = next_argument();
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1407 my $name = next_argument();
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1408 my $st = get_synopsis_table(get_chapter_id());
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1409 #
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1410 $key = $name unless $key;
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1411 $type = 'built-in' if $type eq 'builtin';
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1412 $st->declare($name, $key, $type);
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1413 define_module($type, $name);
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1414 return anchor_label("module-$key",$CURRENT_FILE,$_)
8754
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1415 }
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1416
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1417 sub do_cmd_modulesynopsis{
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1418 local($_) = @_;
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1419 my $st = get_synopsis_table(get_chapter_id());
10598
c8759ba83552 Fix problem of LaTeX leakage in the module synopsis tables at the
Fred Drake <fdrake@acm.org>
parents: 10464
diff changeset
1420 $st->set_synopsis($THIS_MODULE, translate_commands(next_argument()));
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1421 return $_;
8754
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1422 }
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1423
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1424 sub do_cmd_localmoduletable{
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1425 local($_) = @_;
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1426 my $chap = get_chapter_id();
14491
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1427 my $st = get_synopsis_table($chap);
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1428 $st->set_file("$CURRENT_FILE");
10327
66a7d61cfd84 swallow_newline(): Removed function; not really needed. Modified all call
Fred Drake <fdrake@acm.org>
parents: 10197
diff changeset
1429 return "<tex2html-localmoduletable><$chap>\\tableofchildlinks[off]" . $_;
8754
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1430 }
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1431
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1432 sub process_all_localmoduletables{
14491
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1433 my $key;
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1434 my $st, $file;
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1435 foreach $key (keys %ModuleSynopses) {
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1436 $st = $ModuleSynopses{$key};
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1437 $file = $st->get_file();
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1438 if ($file) {
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1439 process_localmoduletables_in_file($file);
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1440 }
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1441 else {
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1442 print "\nsynopsis table $key has no file association";
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1443 }
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1444 }
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1445 }
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1446
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1447 sub process_localmoduletables_in_file{
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1448 my $file = @_[0];
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1449 open(MYFILE, "<$file");
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1450 local($_);
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1451 sysread(MYFILE, $_, 1024*1024);
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1452 close(MYFILE);
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1453 # need to get contents of file in $_
10327
66a7d61cfd84 swallow_newline(): Removed function; not really needed. Modified all call
Fred Drake <fdrake@acm.org>
parents: 10197
diff changeset
1454 while (/<tex2html-localmoduletable><(\d+)>/) {
8756
fba8455dcb54 Fix up the synopsis table stuff so it gets things right at each chapter,
Fred Drake <fdrake@acm.org>
parents: 8754
diff changeset
1455 my $match = $&;
8754
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1456 my $chap = $1;
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1457 my $st = get_synopsis_table($chap);
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1458 my $data = $st->tohtml();
8756
fba8455dcb54 Fix up the synopsis table stuff so it gets things right at each chapter,
Fred Drake <fdrake@acm.org>
parents: 8754
diff changeset
1459 s/$match/$data/;
8754
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1460 }
14491
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1461 open(MYFILE,">$file");
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1462 print MYFILE $_;
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1463 close(MYFILE);
8754
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1464 }
10327
66a7d61cfd84 swallow_newline(): Removed function; not really needed. Modified all call
Fred Drake <fdrake@acm.org>
parents: 10197
diff changeset
1465 sub process_python_state{
66a7d61cfd84 swallow_newline(): Removed function; not really needed. Modified all call
Fred Drake <fdrake@acm.org>
parents: 10197
diff changeset
1466 process_all_localmoduletables();
66a7d61cfd84 swallow_newline(): Removed function; not really needed. Modified all call
Fred Drake <fdrake@acm.org>
parents: 10197
diff changeset
1467 }
8754
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1468
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1469
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1470 #
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1471 # "See also:" -- references placed at the end of a \section
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1472 #
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1473
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1474 sub do_env_seealso{
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1475 return "<div class='seealso'>\n "
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1476 . "<p class='heading'><b>See Also:</b></p>\n"
10197
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
1477 . @_[0]
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
1478 . '</div>';
8754
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1479 }
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1480
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1481 sub do_cmd_seemodule{
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1482 # Insert the right magic to jump to the module definition. This should
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1483 # work most of the time, at least for repeat builds....
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1484 local($_) = @_;
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1485 my $key = next_optional_argument();
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1486 my $module = next_argument();
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1487 my $text = next_argument();
10846
b7378df3db56 Change the look of \seemodule output to fit in better.
Fred Drake <fdrake@acm.org>
parents: 10777
diff changeset
1488 my $period = '.';
8754
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1489 $key = $module
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1490 unless $key;
10846
b7378df3db56 Change the look of \seemodule output to fit in better.
Fred Drake <fdrake@acm.org>
parents: 10777
diff changeset
1491 if ($text =~ /\.$/) {
b7378df3db56 Change the look of \seemodule output to fit in better.
Fred Drake <fdrake@acm.org>
parents: 10777
diff changeset
1492 $period = '';
b7378df3db56 Change the look of \seemodule output to fit in better.
Fred Drake <fdrake@acm.org>
parents: 10777
diff changeset
1493 }
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1494 return '<dl compact class="seemodule">'
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1495 . "\n <dt>Module <b><tt class='module'><a href='module-$key.html'>"
10846
b7378df3db56 Change the look of \seemodule output to fit in better.
Fred Drake <fdrake@acm.org>
parents: 10777
diff changeset
1496 . "$module</a></tt>:</b>"
b7378df3db56 Change the look of \seemodule output to fit in better.
Fred Drake <fdrake@acm.org>
parents: 10777
diff changeset
1497 . "\n <dd>$text$period\n </dl>"
10197
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
1498 . $_;
8754
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1499 }
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1500
17429
c2fb2d476bd3 When forming the <A> tag for a \seepep or \seerfc, make sure we strip
Fred Drake <fdrake@acm.org>
parents: 17381
diff changeset
1501 sub strip_html_markup($){
c2fb2d476bd3 When forming the <A> tag for a \seepep or \seerfc, make sure we strip
Fred Drake <fdrake@acm.org>
parents: 17381
diff changeset
1502 my $str = @_[0];
c2fb2d476bd3 When forming the <A> tag for a \seepep or \seerfc, make sure we strip
Fred Drake <fdrake@acm.org>
parents: 17381
diff changeset
1503 my $s = "$str";
c2fb2d476bd3 When forming the <A> tag for a \seepep or \seerfc, make sure we strip
Fred Drake <fdrake@acm.org>
parents: 17381
diff changeset
1504 $s =~ s/<[a-zA-Z0-9]+(\s+[a-zA-Z0-9]+(\s*=\s*(\'[^\']*\'|\"[^\"]*\"|[a-zA-Z0-9]+))?)*\s*>//g;
c2fb2d476bd3 When forming the <A> tag for a \seepep or \seerfc, make sure we strip
Fred Drake <fdrake@acm.org>
parents: 17381
diff changeset
1505 $s =~ s/<\/[a-zA-Z0-9]+>//g;
c2fb2d476bd3 When forming the <A> tag for a \seepep or \seerfc, make sure we strip
Fred Drake <fdrake@acm.org>
parents: 17381
diff changeset
1506 return $s;
c2fb2d476bd3 When forming the <A> tag for a \seepep or \seerfc, make sure we strip
Fred Drake <fdrake@acm.org>
parents: 17381
diff changeset
1507 }
c2fb2d476bd3 When forming the <A> tag for a \seepep or \seerfc, make sure we strip
Fred Drake <fdrake@acm.org>
parents: 17381
diff changeset
1508
14491
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1509 sub handle_rfclike_reference{
16114
44fd1a7cb279 Fix \seepep handling -- correct URL to the online PEP repository on SF is
Fred Drake <fdrake@acm.org>
parents: 15567
diff changeset
1510 local($_, $what, $format) = @_;
12499
0780aba97898 ref_module_index_helper(): Use "my" instead of "local".
Fred Drake <fdrake@acm.org>
parents: 12376
diff changeset
1511 my $rfcnum = next_argument();
0780aba97898 ref_module_index_helper(): Use "my" instead of "local".
Fred Drake <fdrake@acm.org>
parents: 12376
diff changeset
1512 my $title = next_argument();
0780aba97898 ref_module_index_helper(): Use "my" instead of "local".
Fred Drake <fdrake@acm.org>
parents: 12376
diff changeset
1513 my $text = next_argument();
16114
44fd1a7cb279 Fix \seepep handling -- correct URL to the online PEP repository on SF is
Fred Drake <fdrake@acm.org>
parents: 15567
diff changeset
1514 my $url = get_rfc_url($rfcnum, $format);
14970
6af9aa15647f make_icon_filename(): Convenience function to turn a partial filename
Fred Drake <fdrake@acm.org>
parents: 14766
diff changeset
1515 my $icon = get_link_icon($url);
17429
c2fb2d476bd3 When forming the <A> tag for a \seepep or \seerfc, make sure we strip
Fred Drake <fdrake@acm.org>
parents: 17381
diff changeset
1516 my $attrtitle = strip_html_markup($title);
12499
0780aba97898 ref_module_index_helper(): Use "my" instead of "local".
Fred Drake <fdrake@acm.org>
parents: 12376
diff changeset
1517 return '<dl compact class="seerfc">'
0780aba97898 ref_module_index_helper(): Use "my" instead of "local".
Fred Drake <fdrake@acm.org>
parents: 12376
diff changeset
1518 . "\n <dt><a href=\"$url\""
17429
c2fb2d476bd3 When forming the <A> tag for a \seepep or \seerfc, make sure we strip
Fred Drake <fdrake@acm.org>
parents: 17381
diff changeset
1519 . "\n title=\"$attrtitle\""
14987
bbe09cccb49b $OFF_SITE_LINK_ICON: Don't define here; simply defining it overrides a
Fred Drake <fdrake@acm.org>
parents: 14970
diff changeset
1520 . "\n >$what $rfcnum, <em>$title</em>$icon</a>"
12499
0780aba97898 ref_module_index_helper(): Use "my" instead of "local".
Fred Drake <fdrake@acm.org>
parents: 12376
diff changeset
1521 . "\n <dd>$text\n </dl>"
0780aba97898 ref_module_index_helper(): Use "my" instead of "local".
Fred Drake <fdrake@acm.org>
parents: 12376
diff changeset
1522 . $_;
0780aba97898 ref_module_index_helper(): Use "my" instead of "local".
Fred Drake <fdrake@acm.org>
parents: 12376
diff changeset
1523 }
0780aba97898 ref_module_index_helper(): Use "my" instead of "local".
Fred Drake <fdrake@acm.org>
parents: 12376
diff changeset
1524
14491
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1525 sub do_cmd_seepep{
16114
44fd1a7cb279 Fix \seepep handling -- correct URL to the online PEP repository on SF is
Fred Drake <fdrake@acm.org>
parents: 15567
diff changeset
1526 return handle_rfclike_reference(@_[0], "PEP", $PEP_FORMAT);
14491
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1527 }
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1528
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1529 sub do_cmd_seerfc{
16114
44fd1a7cb279 Fix \seepep handling -- correct URL to the online PEP repository on SF is
Fred Drake <fdrake@acm.org>
parents: 15567
diff changeset
1530 return handle_rfclike_reference(@_[0], "RFC", $RFC_FORMAT);
14491
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1531 }
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1532
14521
9fed4eebc586 \seetitle: New macro for building reference list content.
Fred Drake <fdrake@acm.org>
parents: 14491
diff changeset
1533 sub do_cmd_seetitle{
9fed4eebc586 \seetitle: New macro for building reference list content.
Fred Drake <fdrake@acm.org>
parents: 14491
diff changeset
1534 local($_) = @_;
9fed4eebc586 \seetitle: New macro for building reference list content.
Fred Drake <fdrake@acm.org>
parents: 14491
diff changeset
1535 my $url = next_optional_argument();
9fed4eebc586 \seetitle: New macro for building reference list content.
Fred Drake <fdrake@acm.org>
parents: 14491
diff changeset
1536 my $title = next_argument();
9fed4eebc586 \seetitle: New macro for building reference list content.
Fred Drake <fdrake@acm.org>
parents: 14491
diff changeset
1537 my $text = next_argument();
9fed4eebc586 \seetitle: New macro for building reference list content.
Fred Drake <fdrake@acm.org>
parents: 14491
diff changeset
1538 if ($url) {
14987
bbe09cccb49b $OFF_SITE_LINK_ICON: Don't define here; simply defining it overrides a
Fred Drake <fdrake@acm.org>
parents: 14970
diff changeset
1539 my $icon = get_link_icon($url);
14521
9fed4eebc586 \seetitle: New macro for building reference list content.
Fred Drake <fdrake@acm.org>
parents: 14491
diff changeset
1540 return '<dl compact class="seetitle">'
9fed4eebc586 \seetitle: New macro for building reference list content.
Fred Drake <fdrake@acm.org>
parents: 14491
diff changeset
1541 . "\n <dt><em class=\"citetitle\"><a href=\"$url\""
14970
6af9aa15647f make_icon_filename(): Convenience function to turn a partial filename
Fred Drake <fdrake@acm.org>
parents: 14766
diff changeset
1542 . "\n >$title$icon</a></em>"
14521
9fed4eebc586 \seetitle: New macro for building reference list content.
Fred Drake <fdrake@acm.org>
parents: 14491
diff changeset
1543 . "\n <dd>$text\n </dl>"
9fed4eebc586 \seetitle: New macro for building reference list content.
Fred Drake <fdrake@acm.org>
parents: 14491
diff changeset
1544 . $_;
9fed4eebc586 \seetitle: New macro for building reference list content.
Fred Drake <fdrake@acm.org>
parents: 14491
diff changeset
1545 }
9fed4eebc586 \seetitle: New macro for building reference list content.
Fred Drake <fdrake@acm.org>
parents: 14491
diff changeset
1546 return '<dl compact class="seetitle">'
9fed4eebc586 \seetitle: New macro for building reference list content.
Fred Drake <fdrake@acm.org>
parents: 14491
diff changeset
1547 . "\n <dt><em class=\"citetitle\""
9fed4eebc586 \seetitle: New macro for building reference list content.
Fred Drake <fdrake@acm.org>
parents: 14491
diff changeset
1548 . "\n >$title</em>"
9fed4eebc586 \seetitle: New macro for building reference list content.
Fred Drake <fdrake@acm.org>
parents: 14491
diff changeset
1549 . "\n <dd>$text\n </dl>"
9fed4eebc586 \seetitle: New macro for building reference list content.
Fred Drake <fdrake@acm.org>
parents: 14491
diff changeset
1550 . $_;
9fed4eebc586 \seetitle: New macro for building reference list content.
Fred Drake <fdrake@acm.org>
parents: 14491
diff changeset
1551 }
9fed4eebc586 \seetitle: New macro for building reference list content.
Fred Drake <fdrake@acm.org>
parents: 14491
diff changeset
1552
12637
69481cde511d do_cmd_seeurl(): New function.
Fred Drake <fdrake@acm.org>
parents: 12551
diff changeset
1553 sub do_cmd_seeurl{
69481cde511d do_cmd_seeurl(): New function.
Fred Drake <fdrake@acm.org>
parents: 12551
diff changeset
1554 local($_) = @_;
69481cde511d do_cmd_seeurl(): New function.
Fred Drake <fdrake@acm.org>
parents: 12551
diff changeset
1555 my $url = next_argument();
69481cde511d do_cmd_seeurl(): New function.
Fred Drake <fdrake@acm.org>
parents: 12551
diff changeset
1556 my $text = next_argument();
14970
6af9aa15647f make_icon_filename(): Convenience function to turn a partial filename
Fred Drake <fdrake@acm.org>
parents: 14766
diff changeset
1557 my $icon = get_link_icon($url);
12637
69481cde511d do_cmd_seeurl(): New function.
Fred Drake <fdrake@acm.org>
parents: 12551
diff changeset
1558 return '<dl compact class="seeurl">'
69481cde511d do_cmd_seeurl(): New function.
Fred Drake <fdrake@acm.org>
parents: 12551
diff changeset
1559 . "\n <dt><a href=\"$url\""
14970
6af9aa15647f make_icon_filename(): Convenience function to turn a partial filename
Fred Drake <fdrake@acm.org>
parents: 14766
diff changeset
1560 . "\n class=\"url\">$url$icon</a>"
12637
69481cde511d do_cmd_seeurl(): New function.
Fred Drake <fdrake@acm.org>
parents: 12551
diff changeset
1561 . "\n <dd>$text\n </dl>"
69481cde511d do_cmd_seeurl(): New function.
Fred Drake <fdrake@acm.org>
parents: 12551
diff changeset
1562 . $_;
69481cde511d do_cmd_seeurl(): New function.
Fred Drake <fdrake@acm.org>
parents: 12551
diff changeset
1563 }
69481cde511d do_cmd_seeurl(): New function.
Fred Drake <fdrake@acm.org>
parents: 12551
diff changeset
1564
8754
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1565 sub do_cmd_seetext{
10767
e37074b6e78c do_cmd_seetext(): Clean up so we get proper nesting of <div>s. This
Fred Drake <fdrake@acm.org>
parents: 10641
diff changeset
1566 local($_) = @_;
e37074b6e78c do_cmd_seetext(): Clean up so we get proper nesting of <div>s. This
Fred Drake <fdrake@acm.org>
parents: 10641
diff changeset
1567 my $content = next_argument();
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1568 return '<div class="seetext"><p>' . $content . '</div>' . $_;
8754
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1569 }
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1570
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1571
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1572 #
8397
c9b7e926fd86 Added support for AMK's {definitions} environment; thanks for the reminder!
Fred Drake <fdrake@acm.org>
parents: 8349
diff changeset
1573 # Definition list support.
c9b7e926fd86 Added support for AMK's {definitions} environment; thanks for the reminder!
Fred Drake <fdrake@acm.org>
parents: 8349
diff changeset
1574 #
c9b7e926fd86 Added support for AMK's {definitions} environment; thanks for the reminder!
Fred Drake <fdrake@acm.org>
parents: 8349
diff changeset
1575
c9b7e926fd86 Added support for AMK's {definitions} environment; thanks for the reminder!
Fred Drake <fdrake@acm.org>
parents: 8349
diff changeset
1576 sub do_env_definitions{
12499
0780aba97898 ref_module_index_helper(): Use "my" instead of "local".
Fred Drake <fdrake@acm.org>
parents: 12376
diff changeset
1577 return "<dl class='definitions'>" . @_[0] . "</dl>\n";
8397
c9b7e926fd86 Added support for AMK's {definitions} environment; thanks for the reminder!
Fred Drake <fdrake@acm.org>
parents: 8349
diff changeset
1578 }
c9b7e926fd86 Added support for AMK's {definitions} environment; thanks for the reminder!
Fred Drake <fdrake@acm.org>
parents: 8349
diff changeset
1579
c9b7e926fd86 Added support for AMK's {definitions} environment; thanks for the reminder!
Fred Drake <fdrake@acm.org>
parents: 8349
diff changeset
1580 sub do_cmd_term{
c9b7e926fd86 Added support for AMK's {definitions} environment; thanks for the reminder!
Fred Drake <fdrake@acm.org>
parents: 8349
diff changeset
1581 local($_) = @_;
9775
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
1582 my $term = next_argument();
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
1583 my($name,$aname,$ahref) = new_link_info();
8397
c9b7e926fd86 Added support for AMK's {definitions} environment; thanks for the reminder!
Fred Drake <fdrake@acm.org>
parents: 8349
diff changeset
1584 # could easily add an index entry here...
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1585 return "<dt><b>$aname" . $term . "</a></b>\n<dd>" . $_;
8397
c9b7e926fd86 Added support for AMK's {definitions} environment; thanks for the reminder!
Fred Drake <fdrake@acm.org>
parents: 8349
diff changeset
1586 }
c9b7e926fd86 Added support for AMK's {definitions} environment; thanks for the reminder!
Fred Drake <fdrake@acm.org>
parents: 8349
diff changeset
1587
c9b7e926fd86 Added support for AMK's {definitions} environment; thanks for the reminder!
Fred Drake <fdrake@acm.org>
parents: 8349
diff changeset
1588
14766
72860ef03171 use_sans_serif(),
Fred Drake <fdrake@acm.org>
parents: 14722
diff changeset
1589 # I don't recall exactly why this was needed, but it was very much needed.
72860ef03171 use_sans_serif(),
Fred Drake <fdrake@acm.org>
parents: 14722
diff changeset
1590 # We'll see if anything breaks when I move the "code" line out -- some
72860ef03171 use_sans_serif(),
Fred Drake <fdrake@acm.org>
parents: 14722
diff changeset
1591 # things broke with it in.
72860ef03171 use_sans_serif(),
Fred Drake <fdrake@acm.org>
parents: 14722
diff changeset
1592
72860ef03171 use_sans_serif(),
Fred Drake <fdrake@acm.org>
parents: 14722
diff changeset
1593 #code # {}
10100
9184862bd8d1 More magic to tighten up a little of the formatting.
Fred Drake <fdrake@acm.org>
parents: 10077
diff changeset
1594 process_commands_wrap_deferred(<<_RAW_ARG_DEFERRED_CMDS_);
10138
b21915e6589e Fix up some routines to coordinate the "indexsubitem" stuff so that
Fred Drake <fdrake@acm.org>
parents: 10128
diff changeset
1595 declaremodule # [] # {} # {}
b21915e6589e Fix up some routines to coordinate the "indexsubitem" stuff so that
Fred Drake <fdrake@acm.org>
parents: 10128
diff changeset
1596 memberline # [] # {}
b21915e6589e Fix up some routines to coordinate the "indexsubitem" stuff so that
Fred Drake <fdrake@acm.org>
parents: 10128
diff changeset
1597 methodline # [] # {} # {}
b21915e6589e Fix up some routines to coordinate the "indexsubitem" stuff so that
Fred Drake <fdrake@acm.org>
parents: 10128
diff changeset
1598 modulesynopsis # {}
10327
66a7d61cfd84 swallow_newline(): Removed function; not really needed. Modified all call
Fred Drake <fdrake@acm.org>
parents: 10197
diff changeset
1599 platform # {}
10100
9184862bd8d1 More magic to tighten up a little of the formatting.
Fred Drake <fdrake@acm.org>
parents: 10077
diff changeset
1600 samp # {}
10138
b21915e6589e Fix up some routines to coordinate the "indexsubitem" stuff so that
Fred Drake <fdrake@acm.org>
parents: 10128
diff changeset
1601 setindexsubitem # {}
10157
13239b48c469 Minor fix that helps out with the index.
Fred Drake <fdrake@acm.org>
parents: 10149
diff changeset
1602 withsubitem # {} # {}
10100
9184862bd8d1 More magic to tighten up a little of the formatting.
Fred Drake <fdrake@acm.org>
parents: 10077
diff changeset
1603 _RAW_ARG_DEFERRED_CMDS_
9184862bd8d1 More magic to tighten up a little of the formatting.
Fred Drake <fdrake@acm.org>
parents: 10077
diff changeset
1604
9184862bd8d1 More magic to tighten up a little of the formatting.
Fred Drake <fdrake@acm.org>
parents: 10077
diff changeset
1605
17381
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1606 $alltt_start = '<dl><dd><pre class="verbatim">';
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1607 $alltt_end = '</pre></dl>';
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1608
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1609 sub do_env_alltt {
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1610 local ($_) = @_;
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1611 local($closures,$reopens,@open_block_tags);
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1612
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1613 # get the tag-strings for all open tags
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1614 local(@keep_open_tags) = @$open_tags_R;
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1615 ($closures,$reopens) = &preserve_open_tags() if (@$open_tags_R);
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1616
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1617 # get the tags for text-level tags only
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1618 $open_tags_R = [ @keep_open_tags ];
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1619 local($local_closures, $local_reopens);
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1620 ($local_closures, $local_reopens,@open_block_tags)
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1621 = &preserve_open_block_tags
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1622 if (@$open_tags_R);
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1623
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1624 $open_tags_R = [ @open_block_tags ];
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1625
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1626 do {
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1627 local($open_tags_R) = [ @open_block_tags ];
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1628 local(@save_open_tags) = ();
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1629
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1630 local($cnt) = ++$global{'max_id'};
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1631 $_ = join('',"$O$cnt$C\\tt$O", ++$global{'max_id'}, $C
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1632 , $_ , $O, $global{'max_id'}, "$C$O$cnt$C");
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1633
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1634 $_ = &translate_environments($_);
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1635 $_ = &translate_commands($_) if (/\\/);
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1636
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1637 # preserve space-runs, using &nbsp;
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1638 while (s/(\S) ( +)/$1$2;SPMnbsp;/g){};
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1639 s/(<BR>) /$1;SPMnbsp;/g;
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1640
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1641 $_ = join('', $closures, $alltt_start, $local_reopens
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1642 , $_
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1643 , &balance_tags() #, $local_closures
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1644 , $alltt_end, $reopens);
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1645 undef $open_tags_R; undef @save_open_tags;
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1646 };
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1647 $open_tags_R = [ @keep_open_tags ];
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1648 $_;
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1649 }
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1650
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1651
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1652 1; # This must be the last line