annotate Doc/perl/python.perl @ 21356:c67046ef5385 legacy-trunk

Remove crufty whitespace in a block of index entries. Minor, but generates slightly smaller HTML & makes it easier to see what's happening when debugging the HTML.
author Fred Drake <fdrake@acm.org>
date Tue, 11 Dec 2001 20:49:23 +0000
parents 0a67463f8b7d
children fdc0cf56ba9c
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);
18185
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
44 return (" <img src=\"$icon\"\n"
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
45 . ' border="0" class="offsitelink"'
14987
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
18185
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
47 ? " height=\"$OFF_SITE_LINK_ICON_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
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
18185
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
50 ? " width=\"$OFF_SITE_LINK_ICON_WIDTH\""
14987
bbe09cccb49b $OFF_SITE_LINK_ICON: Don't define here; simply defining it overrides a
Fred Drake <fdrake@acm.org>
parents: 14970
diff changeset
51 : '')
18185
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
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]; }
17602
f63f749364ef The (fairly recent) \textasciicircum is not supported by LaTeX2HTML; add
Fred Drake <fdrake@acm.org>
parents: 17561
diff changeset
89 sub do_cmd_textasciicircum{ '^' . @_[0]; }
18231
f9261904cebb Added support for our new \infinity and \plusminus macros, and the
Fred Drake <fdrake@acm.org>
parents: 18185
diff changeset
90 sub do_cmd_textbar{ '|' . @_[0]; }
f9261904cebb Added support for our new \infinity and \plusminus macros, and the
Fred Drake <fdrake@acm.org>
parents: 18185
diff changeset
91 sub do_cmd_infinity{ '&infin;' . @_[0]; }
f9261904cebb Added support for our new \infinity and \plusminus macros, and the
Fred Drake <fdrake@acm.org>
parents: 18185
diff changeset
92 sub do_cmd_plusminus{ '&plusmn;' . @_[0]; }
18426
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
93 sub do_cmd_menuselection{ @_[0]; }
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
94 sub do_cmd_sub{ ' > ' . @_[0]; }
12928
59e494c0802f do_cmd_textasciitilde(): New function.
Fred Drake <fdrake@acm.org>
parents: 12637
diff changeset
95
59e494c0802f do_cmd_textasciitilde(): New function.
Fred Drake <fdrake@acm.org>
parents: 12637
diff changeset
96
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
97 # 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
98
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_ABC{ 'ABC' . @_[0]; }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
100 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
101 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
102 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
103 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
104 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
105 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
106 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
107
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
108 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
109
8342
22815a0b1267 Added support for \developer, \developers, \developersaddress.
Fred Drake <fdrake@acm.org>
parents: 8294
diff changeset
110 $DEVELOPER_ADDRESS = '';
14556
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
111 $SHORT_VERSION = '';
18185
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
112 $RELEASE_INFO = '';
15322
d17ba141480a Rename $PYTHON_VERSION to $PACKAGE_VERSION; this is the version number for
Fred Drake <fdrake@acm.org>
parents: 14987
diff changeset
113 $PACKAGE_VERSION = '';
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
114
15322
d17ba141480a Rename $PYTHON_VERSION to $PACKAGE_VERSION; this is the version number for
Fred Drake <fdrake@acm.org>
parents: 14987
diff changeset
115 sub do_cmd_version{ $PACKAGE_VERSION . @_[0]; }
14556
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
116 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
117 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
118 local($_) = @_;
15322
d17ba141480a Rename $PYTHON_VERSION to $PACKAGE_VERSION; this is the version number for
Fred Drake <fdrake@acm.org>
parents: 14987
diff changeset
119 $PACKAGE_VERSION = next_argument();
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
120 return $_;
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
121 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
122
18185
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
123 sub do_cmd_setreleaseinfo{
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
124 local($_) = @_;
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
125 $RELEASE_INFO = next_argument();
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
126 return $_;
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
127 }
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
128
14556
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
129 sub do_cmd_setshortversion{
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
130 local($_) = @_;
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
131 $SHORT_VERSION = next_argument();
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
132 return $_;
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
133 }
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
134
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
135 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
136 local($_) = @_;
8342
22815a0b1267 Added support for \developer, \developers, \developersaddress.
Fred Drake <fdrake@acm.org>
parents: 8294
diff changeset
137 $DEVELOPER_ADDRESS = next_argument();
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
138 return $_;
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
139 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
140
8344
d2d82f7b419a do_cmd_let(): Simple implementation to allow \let to be used to establish
Fred Drake <fdrake@acm.org>
parents: 8342
diff changeset
141 #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
142 #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
143 #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
144
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
145 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
146 local($_) = @_;
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
147 next_argument();
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
148 return '_' . $_;
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
149 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
150
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
151 sub use_wrappers{
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
152 local($_,$before,$after) = @_;
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
153 my $stuff = next_argument();
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
154 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
155 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
156
14556
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
157 $IN_DESC_HANDLER = 0;
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
158 sub do_cmd_optional{
14556
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
159 if ($IN_DESC_HANDLER) {
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
160 return use_wrappers(@_[0], "</var><big>\[</big><var>",
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
161 "</var><big>\]</big><var>");
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
162 }
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
163 else {
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
164 return use_wrappers(@_[0], "<big>\[</big>", "<big>\]</big>");
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
165 }
7802
dffe1e470e6c Match python.sty a little better.
Fred Drake <fdrake@acm.org>
parents: 7798
diff changeset
166 }
dffe1e470e6c Match python.sty a little better.
Fred Drake <fdrake@acm.org>
parents: 7798
diff changeset
167
7711
56dcfc27710a Coding cleanups.
Fred Drake <fdrake@acm.org>
parents: 7671
diff changeset
168 # Logical formatting (some based on texinfo), needs to be converted to
56dcfc27710a Coding cleanups.
Fred Drake <fdrake@acm.org>
parents: 7671
diff changeset
169 # minimalist HTML. The "minimalist" is primarily to reduce the size of
56dcfc27710a Coding cleanups.
Fred Drake <fdrake@acm.org>
parents: 7671
diff changeset
170 # output files for users that read them over the network rather than
56dcfc27710a Coding cleanups.
Fred Drake <fdrake@acm.org>
parents: 7671
diff changeset
171 # 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
172
10464
f74ef1971bd1 Remove \platformof support, since it's been removed from the LaTeX
Fred Drake <fdrake@acm.org>
parents: 10327
diff changeset
173 # \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
174
10100
9184862bd8d1 More magic to tighten up a little of the formatting.
Fred Drake <fdrake@acm.org>
parents: 10077
diff changeset
175 sub do_cmd_pytype{ return @_[0]; }
13831
c3783a33f84b do_cmd_moreargs(),
Fred Drake <fdrake@acm.org>
parents: 13077
diff changeset
176 sub do_cmd_makevar{
c3783a33f84b do_cmd_moreargs(),
Fred Drake <fdrake@acm.org>
parents: 13077
diff changeset
177 return use_wrappers(@_[0], '<span class="makevar">', '</span>'); }
10197
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
178 sub do_cmd_code{
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
179 return use_wrappers(@_[0], '<code>', '</code>'); }
10197
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
180 sub do_cmd_module{
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
181 return use_wrappers(@_[0], '<tt class="module">', '</tt>'); }
10197
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
182 sub do_cmd_keyword{
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
183 return use_wrappers(@_[0], '<tt class="keyword">', '</tt>'); }
10197
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
184 sub do_cmd_exception{
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
185 return use_wrappers(@_[0], '<tt class="exception">', '</tt>'); }
10197
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
186 sub do_cmd_class{
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
187 return use_wrappers(@_[0], '<tt class="class">', '</tt>'); }
10197
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
188 sub do_cmd_function{
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
189 return use_wrappers(@_[0], '<tt class="function">', '</tt>'); }
10197
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
190 sub do_cmd_constant{
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
191 return use_wrappers(@_[0], '<tt class="constant">', '</tt>'); }
10197
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
192 sub do_cmd_member{
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
193 return use_wrappers(@_[0], '<tt class="member">', '</tt>'); }
10197
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
194 sub do_cmd_method{
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
195 return use_wrappers(@_[0], '<tt class="method">', '</tt>'); }
10197
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
196 sub do_cmd_cfunction{
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
197 return use_wrappers(@_[0], '<tt class="cfunction">', '</tt>'); }
10197
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
198 sub do_cmd_cdata{
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
199 return use_wrappers(@_[0], '<tt class="cdata">', '</tt>'); }
10197
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
200 sub do_cmd_ctype{
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
201 return use_wrappers(@_[0], '<tt class="ctype">', '</tt>'); }
10197
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
202 sub do_cmd_regexp{
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
203 return use_wrappers(@_[0], '<tt class="regexp">', '</tt>'); }
10197
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
204 sub do_cmd_character{
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
205 return use_wrappers(@_[0], '"<tt class="character">', '</tt>"'); }
10197
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
206 sub do_cmd_program{
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
207 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
208 sub do_cmd_programopt{
e0fe4c7a9eff do_cmd_programopt(): New function, similar to do_cmd_program().
Fred Drake <fdrake@acm.org>
parents: 11316
diff changeset
209 return use_wrappers(@_[0], '<b class="programopt">', '</b>'); }
12376
6ce6c23acd14 do_cmd_longprogramopt(): New function.
Fred Drake <fdrake@acm.org>
parents: 12350
diff changeset
210 sub do_cmd_longprogramopt{
6ce6c23acd14 do_cmd_longprogramopt(): New function.
Fred Drake <fdrake@acm.org>
parents: 12350
diff changeset
211 # 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
212 return use_wrappers(@_[0], '<b class="programopt">---', '</b>'); }
10197
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
213 sub do_cmd_email{
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
214 return use_wrappers(@_[0], '<span class="email">', '</span>'); }
18981
dac9cca49012 Define the \mailheader macro and document conventions for using it.
Fred Drake <fdrake@acm.org>
parents: 18683
diff changeset
215 sub do_cmd_mailheader{
20113
12a787fb71df Move the styling for the HTML version of \mailheader into the CSS file.
Fred Drake <fdrake@acm.org>
parents: 19412
diff changeset
216 return use_wrappers(@_[0], '<span class="mailheader">', ':</span>'); }
10197
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
217 sub do_cmd_mimetype{
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
218 return use_wrappers(@_[0], '<span class="mimetype">', '</span>'); }
10197
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
219 sub do_cmd_var{
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
220 return use_wrappers(@_[0], "<var>", "</var>"); }
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
221 sub do_cmd_dfn{
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
222 return use_wrappers(@_[0], '<i class="dfn">', '</i>'); }
10197
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
223 sub do_cmd_emph{
14766
72860ef03171 use_sans_serif(),
Fred Drake <fdrake@acm.org>
parents: 14722
diff changeset
224 return use_wrappers(@_[0], '<i>', '</i>'); }
10197
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
225 sub do_cmd_file{
13831
c3783a33f84b do_cmd_moreargs(),
Fred Drake <fdrake@acm.org>
parents: 13077
diff changeset
226 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
227 sub do_cmd_filenq{
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
228 return do_cmd_file(@_[0]); }
10197
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
229 sub do_cmd_samp{
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
230 return use_wrappers(@_[0], '"<tt class="samp">', '</tt>"'); }
10197
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
231 sub do_cmd_kbd{
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
232 return use_wrappers(@_[0], '<kbd>', '</kbd>'); }
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
233 sub do_cmd_strong{
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
234 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
235 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
236 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
237 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
238 return use_wrappers(@_[0], '<i>', '</i>'); }
20336
1b3ffdf12150 New markup: \note{...} and \warning{...}
Fred Drake <fdrake@acm.org>
parents: 20113
diff changeset
239 sub do_cmd_note{
1b3ffdf12150 New markup: \note{...} and \warning{...}
Fred Drake <fdrake@acm.org>
parents: 20113
diff changeset
240 return use_wrappers(
1b3ffdf12150 New markup: \note{...} and \warning{...}
Fred Drake <fdrake@acm.org>
parents: 20113
diff changeset
241 @_[0],
1b3ffdf12150 New markup: \note{...} and \warning{...}
Fred Drake <fdrake@acm.org>
parents: 20113
diff changeset
242 "<span class=\"note\"><b class=\"label\">Note:</b>\n",
1b3ffdf12150 New markup: \note{...} and \warning{...}
Fred Drake <fdrake@acm.org>
parents: 20113
diff changeset
243 '</span>'); }
1b3ffdf12150 New markup: \note{...} and \warning{...}
Fred Drake <fdrake@acm.org>
parents: 20113
diff changeset
244 sub do_cmd_warning{
1b3ffdf12150 New markup: \note{...} and \warning{...}
Fred Drake <fdrake@acm.org>
parents: 20113
diff changeset
245 return use_wrappers(
1b3ffdf12150 New markup: \note{...} and \warning{...}
Fred Drake <fdrake@acm.org>
parents: 20113
diff changeset
246 @_[0],
1b3ffdf12150 New markup: \note{...} and \warning{...}
Fred Drake <fdrake@acm.org>
parents: 20113
diff changeset
247 "<span class=\"warning\"><b class=\"label\">Warning:</b>\n",
1b3ffdf12150 New markup: \note{...} and \warning{...}
Fred Drake <fdrake@acm.org>
parents: 20113
diff changeset
248 '</span>'); }
10464
f74ef1971bd1 Remove \platformof support, since it's been removed from the LaTeX
Fred Drake <fdrake@acm.org>
parents: 10327
diff changeset
249
13831
c3783a33f84b do_cmd_moreargs(),
Fred Drake <fdrake@acm.org>
parents: 13077
diff changeset
250 sub do_cmd_moreargs{
c3783a33f84b do_cmd_moreargs(),
Fred Drake <fdrake@acm.org>
parents: 13077
diff changeset
251 return '...' . @_[0]; }
c3783a33f84b do_cmd_moreargs(),
Fred Drake <fdrake@acm.org>
parents: 13077
diff changeset
252 sub do_cmd_unspecified{
c3783a33f84b do_cmd_moreargs(),
Fred Drake <fdrake@acm.org>
parents: 13077
diff changeset
253 return '...' . @_[0]; }
c3783a33f84b do_cmd_moreargs(),
Fred Drake <fdrake@acm.org>
parents: 13077
diff changeset
254
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
255
9867
c95fff8f180a do_cmd_refmodule(): New function to support new \refmodule macro.
Fred Drake <fdrake@acm.org>
parents: 9848
diff changeset
256 sub do_cmd_refmodule{
c95fff8f180a do_cmd_refmodule(): New function to support new \refmodule macro.
Fred Drake <fdrake@acm.org>
parents: 9848
diff changeset
257 # 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
258 local($_) = @_;
c95fff8f180a do_cmd_refmodule(): New function to support new \refmodule macro.
Fred Drake <fdrake@acm.org>
parents: 9848
diff changeset
259 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
260 my $module = next_argument();
c95fff8f180a do_cmd_refmodule(): New function to support new \refmodule macro.
Fred Drake <fdrake@acm.org>
parents: 9848
diff changeset
261 $key = $module
c95fff8f180a do_cmd_refmodule(): New function to support new \refmodule macro.
Fred Drake <fdrake@acm.org>
parents: 9848
diff changeset
262 unless $key;
18185
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
263 return "<tt class=\"module\"><a href=\"module-$key.html\">$module</a></tt>"
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
264 . $_;
9867
c95fff8f180a do_cmd_refmodule(): New function to support new \refmodule macro.
Fred Drake <fdrake@acm.org>
parents: 9848
diff changeset
265 }
c95fff8f180a do_cmd_refmodule(): New function to support new \refmodule macro.
Fred Drake <fdrake@acm.org>
parents: 9848
diff changeset
266
7779
1c420699d58a Implemented one more special markup item.
Fred Drake <fdrake@acm.org>
parents: 7760
diff changeset
267 sub do_cmd_newsgroup{
1c420699d58a Implemented one more special markup item.
Fred Drake <fdrake@acm.org>
parents: 7760
diff changeset
268 local($_) = @_;
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
269 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
270 my $icon = get_link_icon("news:$newsgroup");
18185
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
271 my $stuff = ("<a class=\"newsgroup\" href=\"news:$newsgroup\">"
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
272 . "$newsgroup$icon</a>");
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
273 return $stuff . $_;
7779
1c420699d58a Implemented one more special markup item.
Fred Drake <fdrake@acm.org>
parents: 7760
diff changeset
274 }
7671
0cf2ffaf4bd7 Bring this up to date. Some things still don't work right.
Fred Drake <fdrake@acm.org>
parents: 7581
diff changeset
275
0cf2ffaf4bd7 Bring this up to date. Some things still don't work right.
Fred Drake <fdrake@acm.org>
parents: 7581
diff changeset
276 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
277 local($_) = @_;
9775
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
278 my $envvar = next_argument();
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
279 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
280 # 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
281 # 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
282 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
283 $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
284 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
285 $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
286 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
287 }
0cf2ffaf4bd7 Bring this up to date. Some things still don't work right.
Fred Drake <fdrake@acm.org>
parents: 7581
diff changeset
288
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
289 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
290 # 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
291 local($_) = @_;
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
292 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
293 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
294 $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
295 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
296 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
297
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
298 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
299 # 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
300 local($_) = @_;
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
301 my $page = next_argument();
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
302 my $section = next_argument();
18185
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
303 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
304 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
305
18185
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
306 $PEP_FORMAT = "http://python.sourceforge.net/peps/pep-%04d.html";
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
307 #$RFC_FORMAT = "http://www.ietf.org/rfc/rfc%04d.txt";
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
308 $RFC_FORMAT = "http://www.faqs.org/rfcs/rfc%d.html";
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
44fd1a7cb279 Fix \seepep handling -- correct URL to the online PEP repository on SF is
Fred Drake <fdrake@acm.org>
parents: 15567
diff changeset
310 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
311 my($rfcnum, $format) = @_;
18185
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
312 return sprintf($format, $rfcnum);
14491
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
313 }
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
314
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
315 sub do_cmd_pep{
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
316 local($_) = @_;
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
317 my $rfcnumber = next_argument();
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
318 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
319 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
320 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
321 # Save the reference
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
322 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
323 $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
324 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
325 . "$icon</a>" . $_);
14491
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
326 }
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
327
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
328 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
329 local($_) = @_;
9775
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
330 my $rfcnumber = next_argument();
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
331 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
332 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
333 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
334 # Save the reference
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
335 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
336 $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
337 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
338 . "$icon</a>" . $_);
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
339 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
340
18426
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
341 sub do_cmd_ulink{
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
342 local($_) = @_;
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
343 my $text = next_argument();
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
344 my $url = next_argument();
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
345 return "<a class=\"ulink\" href=\"$url\"\n >$text</a>" . $_;
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
346 }
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
347
11449
e0fe4c7a9eff do_cmd_programopt(): New function, similar to do_cmd_program().
Fred Drake <fdrake@acm.org>
parents: 11316
diff changeset
348 sub do_cmd_citetitle{
e0fe4c7a9eff do_cmd_programopt(): New function, similar to do_cmd_program().
Fred Drake <fdrake@acm.org>
parents: 11316
diff changeset
349 local($_) = @_;
e0fe4c7a9eff do_cmd_programopt(): New function, similar to do_cmd_program().
Fred Drake <fdrake@acm.org>
parents: 11316
diff changeset
350 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
351 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
352 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
353 my $repl = '';
e0fe4c7a9eff do_cmd_programopt(): New function, similar to do_cmd_program().
Fred Drake <fdrake@acm.org>
parents: 11316
diff changeset
354 if ($url) {
18185
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
355 $repl = ("<em class=\"citetitle\"><a\n"
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
356 . " href=\"$url\"\n"
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
357 . " title=\"$title\"\n"
14970
6af9aa15647f make_icon_filename(): Convenience function to turn a partial filename
Fred Drake <fdrake@acm.org>
parents: 14766
diff changeset
358 . " >$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
359 }
e0fe4c7a9eff do_cmd_programopt(): New function, similar to do_cmd_program().
Fred Drake <fdrake@acm.org>
parents: 11316
diff changeset
360 else {
18185
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
361 $repl = "<em class=\"citetitle\"\n >$title</em>";
11449
e0fe4c7a9eff do_cmd_programopt(): New function, similar to do_cmd_program().
Fred Drake <fdrake@acm.org>
parents: 11316
diff changeset
362 }
e0fe4c7a9eff do_cmd_programopt(): New function, similar to do_cmd_program().
Fred Drake <fdrake@acm.org>
parents: 11316
diff changeset
363 return $repl . $_;
e0fe4c7a9eff do_cmd_programopt(): New function, similar to do_cmd_program().
Fred Drake <fdrake@acm.org>
parents: 11316
diff changeset
364 }
e0fe4c7a9eff do_cmd_programopt(): New function, similar to do_cmd_program().
Fred Drake <fdrake@acm.org>
parents: 11316
diff changeset
365
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
366 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
367 # 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
368 local($_) = @_;
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
369 my $release = next_argument();
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
370 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
371 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
372 . "<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
373 . "\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
374 . $_);
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
375 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
376
17561
36232f543220 Added support for optional explanation parameter to the \versionadded
Fred Drake <fdrake@acm.org>
parents: 17429
diff changeset
377 sub versionnote{
36232f543220 Added support for optional explanation parameter to the \versionadded
Fred Drake <fdrake@acm.org>
parents: 17429
diff changeset
378 # one or two parameters: \versionnote[explanation]{version}
36232f543220 Added support for optional explanation parameter to the \versionadded
Fred Drake <fdrake@acm.org>
parents: 17429
diff changeset
379 my $type = @_[0];
36232f543220 Added support for optional explanation parameter to the \versionadded
Fred Drake <fdrake@acm.org>
parents: 17429
diff changeset
380 local $_ = @_[1];
36232f543220 Added support for optional explanation parameter to the \versionadded
Fred Drake <fdrake@acm.org>
parents: 17429
diff changeset
381 my $explanation = next_optional_argument();
36232f543220 Added support for optional explanation parameter to the \versionadded
Fred Drake <fdrake@acm.org>
parents: 17429
diff changeset
382 my $release = next_argument();
36232f543220 Added support for optional explanation parameter to the \versionadded
Fred Drake <fdrake@acm.org>
parents: 17429
diff changeset
383 my $text = "$type in version $release.";
36232f543220 Added support for optional explanation parameter to the \versionadded
Fred Drake <fdrake@acm.org>
parents: 17429
diff changeset
384 if ($explanation) {
36232f543220 Added support for optional explanation parameter to the \versionadded
Fred Drake <fdrake@acm.org>
parents: 17429
diff changeset
385 $text = "$type in version $release:\n$explanation.";
36232f543220 Added support for optional explanation parameter to the \versionadded
Fred Drake <fdrake@acm.org>
parents: 17429
diff changeset
386 }
18185
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
387 return "\n<span class=\"versionnote\">$text</span>\n" . $_;
17561
36232f543220 Added support for optional explanation parameter to the \versionadded
Fred Drake <fdrake@acm.org>
parents: 17429
diff changeset
388 }
36232f543220 Added support for optional explanation parameter to the \versionadded
Fred Drake <fdrake@acm.org>
parents: 17429
diff changeset
389
8763
55f790a5f64b do_cmd_versionadded(),
Fred Drake <fdrake@acm.org>
parents: 8756
diff changeset
390 sub do_cmd_versionadded{
17561
36232f543220 Added support for optional explanation parameter to the \versionadded
Fred Drake <fdrake@acm.org>
parents: 17429
diff changeset
391 return versionnote('New', @_);
8763
55f790a5f64b do_cmd_versionadded(),
Fred Drake <fdrake@acm.org>
parents: 8756
diff changeset
392 }
55f790a5f64b do_cmd_versionadded(),
Fred Drake <fdrake@acm.org>
parents: 8756
diff changeset
393
55f790a5f64b do_cmd_versionadded(),
Fred Drake <fdrake@acm.org>
parents: 8756
diff changeset
394 sub do_cmd_versionchanged{
17561
36232f543220 Added support for optional explanation parameter to the \versionadded
Fred Drake <fdrake@acm.org>
parents: 17429
diff changeset
395 return versionnote('Changed', @_);
8763
55f790a5f64b do_cmd_versionadded(),
Fred Drake <fdrake@acm.org>
parents: 8756
diff changeset
396 }
55f790a5f64b do_cmd_versionadded(),
Fred Drake <fdrake@acm.org>
parents: 8756
diff changeset
397
10327
66a7d61cfd84 swallow_newline(): Removed function; not really needed. Modified all call
Fred Drake <fdrake@acm.org>
parents: 10197
diff changeset
398 #
10464
f74ef1971bd1 Remove \platformof support, since it's been removed from the LaTeX
Fred Drake <fdrake@acm.org>
parents: 10327
diff changeset
399 # 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
400 #
66a7d61cfd84 swallow_newline(): Removed function; not really needed. Modified all call
Fred Drake <fdrake@acm.org>
parents: 10197
diff changeset
401 sub do_cmd_platform{
66a7d61cfd84 swallow_newline(): Removed function; not really needed. Modified all call
Fred Drake <fdrake@acm.org>
parents: 10197
diff changeset
402 local($_) = @_;
66a7d61cfd84 swallow_newline(): Removed function; not really needed. Modified all call
Fred Drake <fdrake@acm.org>
parents: 10197
diff changeset
403 my $platform = next_argument();
18185
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
404 $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
405 $platform = "Macintosh"
10637
bed15a015c1c Fix some remaining index & consistency nits. (Many data member
Fred Drake <fdrake@acm.org>
parents: 10598
diff changeset
406 if $platform eq 'Mac';
18185
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
407 return "\n<p class=\"availability\">Availability: <span"
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
408 . "\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
409 }
66a7d61cfd84 swallow_newline(): Removed function; not really needed. Modified all call
Fred Drake <fdrake@acm.org>
parents: 10197
diff changeset
410
66a7d61cfd84 swallow_newline(): Removed function; not really needed. Modified all call
Fred Drake <fdrake@acm.org>
parents: 10197
diff changeset
411 $IGNORE_PLATFORM_ANNOTATION = '';
66a7d61cfd84 swallow_newline(): Removed function; not really needed. Modified all call
Fred Drake <fdrake@acm.org>
parents: 10197
diff changeset
412 sub do_cmd_ignorePlatformAnnotation{
66a7d61cfd84 swallow_newline(): Removed function; not really needed. Modified all call
Fred Drake <fdrake@acm.org>
parents: 10197
diff changeset
413 local($_) = @_;
66a7d61cfd84 swallow_newline(): Removed function; not really needed. Modified all call
Fred Drake <fdrake@acm.org>
parents: 10197
diff changeset
414 $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
415 return $_;
66a7d61cfd84 swallow_newline(): Removed function; not really needed. Modified all call
Fred Drake <fdrake@acm.org>
parents: 10197
diff changeset
416 }
66a7d61cfd84 swallow_newline(): Removed function; not really needed. Modified all call
Fred Drake <fdrake@acm.org>
parents: 10197
diff changeset
417
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
418
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
419 # index commands
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
420
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
421 $INDEX_SUBITEM = "";
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
422
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
423 sub get_indexsubitem{
9769
e1508f72c610 do_cmd_methodline(): New function, implements indexing version of
Fred Drake <fdrake@acm.org>
parents: 9718
diff changeset
424 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
425 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
426
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
427 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
428 local($_) = @_;
10138
b21915e6589e Fix up some routines to coordinate the "indexsubitem" stuff so that
Fred Drake <fdrake@acm.org>
parents: 10128
diff changeset
429 $INDEX_SUBITEM = next_argument();
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
430 return $_;
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
431 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
432
7671
0cf2ffaf4bd7 Bring this up to date. Some things still don't work right.
Fred Drake <fdrake@acm.org>
parents: 7581
diff changeset
433 sub do_cmd_withsubitem{
9769
e1508f72c610 do_cmd_methodline(): New function, implements indexing version of
Fred Drake <fdrake@acm.org>
parents: 9718
diff changeset
434 # 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
435 # 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
436 # 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
437 #
0cf2ffaf4bd7 Bring this up to date. Some things still don't work right.
Fred Drake <fdrake@acm.org>
parents: 7581
diff changeset
438 local($_) = @_;
9769
e1508f72c610 do_cmd_methodline(): New function, implements indexing version of
Fred Drake <fdrake@acm.org>
parents: 9718
diff changeset
439 my $oldsubitem = $INDEX_SUBITEM;
e1508f72c610 do_cmd_methodline(): New function, implements indexing version of
Fred Drake <fdrake@acm.org>
parents: 9718
diff changeset
440 $INDEX_SUBITEM = next_argument();
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
441 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
442 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
443 my $marker = "$O$br_id$C";
21356
c67046ef5385 Remove crufty whitespace in a block of index entries.
Fred Drake <fdrake@acm.org>
parents: 21116
diff changeset
444 $stuff =~ s/^\s+//;
9769
e1508f72c610 do_cmd_methodline(): New function, implements indexing version of
Fred Drake <fdrake@acm.org>
parents: 9718
diff changeset
445 return
e1508f72c610 do_cmd_methodline(): New function, implements indexing version of
Fred Drake <fdrake@acm.org>
parents: 9718
diff changeset
446 $stuff
9775
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
447 . "\\setindexsubitem$marker$oldsubitem$marker"
9769
e1508f72c610 do_cmd_methodline(): New function, implements indexing version of
Fred Drake <fdrake@acm.org>
parents: 9718
diff changeset
448 . $_;
7671
0cf2ffaf4bd7 Bring this up to date. Some things still don't work right.
Fred Drake <fdrake@acm.org>
parents: 7581
diff changeset
449 }
0cf2ffaf4bd7 Bring this up to date. Some things still don't work right.
Fred Drake <fdrake@acm.org>
parents: 7581
diff changeset
450
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
451 # 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
452 # 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
453 # 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
454 #
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
455 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
456
7760
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
457 # 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
458 #
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
459 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
460 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
461 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
462 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
463
5eafd3eda0af Remove option to strip out <tt>...</tt> from index entry text; this is now
Fred Drake <fdrake@acm.org>
parents: 7906
diff changeset
464 # 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
465 # 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
466 #
5eafd3eda0af Remove option to strip out <tt>...</tt> from index entry text; this is now
Fred Drake <fdrake@acm.org>
parents: 7906
diff changeset
467 $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
468
9775
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
469 sub write_idxfile{
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
470 my ($ahref, $str) = @_;
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
471 print IDXFILE $ahref, $IDXFILE_FIELD_SEP, $str, "\n";
7760
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
472 }
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
473
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
474
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
475 sub gen_link{
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
476 my($node,$target) = @_;
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
477 print INTLABELS "\$internal_labels{\"$target\"} = \"$URL/$node\";\n";
18185
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
478 return "<a href=\"$node#$target\">";
7760
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
479 }
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
480
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
481 sub add_index_entry{
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
482 # 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
483 my($str,$ahref) = @_;
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
484 $str = gen_index_id($str, '');
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
485 $index{$str} .= $ahref;
9775
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
486 write_idxfile($ahref, $str);
7760
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
487 }
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
488
9775
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
489 sub new_link_info{
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
490 my $name = "l2h-" . ++$globals{'max_id'};
18185
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
491 my $aname = "<a name=\"$name\">";
7760
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
492 my $ahref = gen_link($CURRENT_FILE, $name);
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
493 return ($name, $aname, $ahref);
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
494 }
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
495
10849
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
496 $IndexMacroPattern = '';
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
497 sub define_indexing_macro{
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
498 my $count = @_;
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
499 my $i = 0;
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
500 for (; $i < $count; ++$i) {
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
501 my $name = @_[$i];
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
502 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
503 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
504 if (!defined &$cmd);
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
505 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
506 . "\@_[0], '$name'); }");
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
507 if (length($IndexMacroPattern) == 0) {
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
508 $IndexMacroPattern = "$name";
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
509 }
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
510 else {
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
511 $IndexMacroPattern .= "|$name";
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
512 }
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
513 }
7760
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
514 }
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
515
10849
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
516 $DEBUG_INDEXING = 0;
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
517 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
518 local($_) = @_;
10849
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
519 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
520 # 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
521 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
522 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
523 print "\nIndexing: \\$cmdname"
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
524 if $DEBUG_INDEXING;
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
525 &$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
526 while (/^[\s\n]*\\($IndexMacroPattern)</) {
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
527 $cmdname = "$1";
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
528 print " \\$cmdname"
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
529 if $DEBUG_INDEXING;
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
530 $cmd = "idx_cmd_$cmdname";
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
531 if (!defined &$cmd) {
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
532 last;
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
533 }
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
534 else {
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
535 s/^[\s\n]*\\$cmdname//;
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
536 &$cmd($ahref);
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
537 }
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
538 }
16114
44fd1a7cb279 Fix \seepep handling -- correct URL to the online PEP repository on SF is
Fred Drake <fdrake@acm.org>
parents: 15567
diff changeset
539 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
540 $_ = 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
541 }
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
542 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
543 }
35ea0c073ea3 do_cmd_kwindex(): Re-implement now that \kwindex is used again (ref man).
Fred Drake <fdrake@acm.org>
parents: 8194
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('index');
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
546 sub idx_cmd_index{
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
547 my $str = next_argument();
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
548 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
549 }
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
550
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
551 define_indexing_macro('kwindex');
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
552 sub idx_cmd_kwindex{
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
553 my $str = next_argument();
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
554 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
555 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
556 }
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
557
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
558 define_indexing_macro('indexii');
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
559 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
560 my $str1 = next_argument();
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
561 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
562 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
563 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
564 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
565
10849
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
566 define_indexing_macro('indexiii');
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
567 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
568 my $str1 = next_argument();
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
569 my $str2 = next_argument();
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
570 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
571 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
572 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
573 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
574 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
575
10849
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
576 define_indexing_macro('indexiv');
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
577 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
578 my $str1 = next_argument();
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
579 my $str2 = next_argument();
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
580 my $str3 = next_argument();
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
581 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
582 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
583 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
584 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
585 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
586 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
587
10849
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
588 define_indexing_macro('ttindex');
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
589 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
590 my $str = next_argument();
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
591 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
592 add_index_entry($entry, @_[0]);
7711
56dcfc27710a Coding cleanups.
Fred Drake <fdrake@acm.org>
parents: 7671
diff changeset
593 }
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
594
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
595 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
596 my($word,$ahref) = @_;
9775
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
597 my $str = next_argument();
7760
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
598 add_index_entry("$str $word", $ahref);
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
599 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
600 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
601
10849
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
602 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
603 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
604 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
605 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
606 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
607
10849
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
608 define_indexing_macro('bifuncindex');
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
609 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
610 my $str = next_argument();
18185
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
611 add_index_entry("<tt class=\"function\">$str()</tt> (built-in function)",
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
612 @_[0]);
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
613 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
614
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
615
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
616 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
617 my($str,$define) = @_;
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
618 my($name,$aname,$ahref) = new_link_info();
7760
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
619 # 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
620 $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
621 if ($define eq 'DEF');
7760
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
622 $str = gen_index_id($str, $define);
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
623 $index{$str} .= $ahref;
9775
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
624 write_idxfile($ahref, $str);
7760
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
625
7711
56dcfc27710a Coding cleanups.
Fred Drake <fdrake@acm.org>
parents: 7671
diff changeset
626 if ($define eq 'DEF') {
7760
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
627 # add to the module index
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
628 $str =~ /(<tt.*<\/tt>)/;
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
629 my $nstr = $1;
7760
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
630 $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
631 }
16114
44fd1a7cb279 Fix \seepep handling -- correct URL to the online PEP repository on SF is
Fred Drake <fdrake@acm.org>
parents: 15567
diff changeset
632 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
633 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
634
10327
66a7d61cfd84 swallow_newline(): Removed function; not really needed. Modified all call
Fred Drake <fdrake@acm.org>
parents: 10197
diff changeset
635
7711
56dcfc27710a Coding cleanups.
Fred Drake <fdrake@acm.org>
parents: 7671
diff changeset
636 $THIS_MODULE = '';
7760
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
637 $THIS_CLASS = '';
7711
56dcfc27710a Coding cleanups.
Fred Drake <fdrake@acm.org>
parents: 7671
diff changeset
638
8754
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
639 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
640 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
641 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
642 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
643 && $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
644 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
645 . " for \\declaremodule (module $name)");
1aa80f5bf9ac define_module(): Check the module type for validity before using.
Fred Drake <fdrake@acm.org>
parents: 10849
diff changeset
646 $word = "";
1aa80f5bf9ac define_module(): Check the module type for validity before using.
Fred Drake <fdrake@acm.org>
parents: 10849
diff changeset
647 }
8754
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
648 $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
649 $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
650 $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
651 print "[$name]";
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
652 return make_mod_index_entry(
18185
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
653 "<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
654 }
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
655
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
656 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
657 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
658 my $name = next_argument();
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
659 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
660 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
661
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
662 sub do_cmd_modindex{ return my_module_index_helper('', @_); }
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
663 sub do_cmd_bimodindex{ return my_module_index_helper('built-in', @_); }
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
664 sub do_cmd_exmodindex{ return my_module_index_helper('extension', @_); }
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
665 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
666
10849
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
667 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
668 my($word, $ahref) = @_;
10849
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
669 my $str = next_argument();
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
670 $word = "$word " if $word;
18185
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
671 $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
672 # 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
673 # 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
674 $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
675 $index{$str} .= $ahref;
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
676 write_idxfile($ahref, $str);
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
677 }
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
678
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
679 # 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
680 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
681 'refexmodindex', 'refstmodindex');
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
682 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
683 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
684 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
685 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
686
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
687 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
688
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
689 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
690 $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
691 $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
692 $anchor_mark = '';
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
693 $icons{'anchor_mark'} = '';
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
694 }
7760
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
695 init_myformat();
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
696
10849
4da76f838a5e make_index_entry(): Remove. Not only did this override the
Fred Drake <fdrake@acm.org>
parents: 10846
diff changeset
697 # 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
698 # 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
699 #
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
700 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
701 my($str) = @_;
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
702 my($name,$aname,$ahref) = new_link_info();
7760
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
703 add_index_entry($str, $ahref);
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
704 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
705 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
706
18426
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
707
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
708 %TokenToTargetMapping = ();
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
709 %DefinedGrammars = ();
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
710 %BackpatchGrammarFiles = ();
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
711
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
712 sub do_cmd_token{
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
713 local($_) = @_;
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
714 my $token = next_argument();
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
715 my $target = $TokenToTargetMapping{"$CURRENT_GRAMMAR:$token"};
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
716 if ($token eq $CURRENT_TOKEN || $CURRENT_GRAMMAR eq '*') {
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
717 # recursive definition or display-only productionlist
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
718 return "$token";
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
719 }
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
720 if ($target eq '') {
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
721 $target = "<pyGrammarToken><$CURRENT_GRAMMAR><$token>";
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
722 if (! $BackpatchGrammarFiles{"$CURRENT_FILE"}) {
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
723 print "Adding '$CURRENT_FILE' to back-patch list.\n";
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
724 }
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
725 $BackpatchGrammarFiles{"$CURRENT_FILE"} = 1;
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
726 }
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
727 return "<a href=\"$target\">$token</a>" . $_;
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
728 }
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
729
19412
d4ba6e2aaae3 New \grammartoken markup, similar to \token but allowed everywhere.
Fred Drake <fdrake@acm.org>
parents: 19327
diff changeset
730 sub do_cmd_grammartoken{
d4ba6e2aaae3 New \grammartoken markup, similar to \token but allowed everywhere.
Fred Drake <fdrake@acm.org>
parents: 19327
diff changeset
731 return do_cmd_token(@_);
d4ba6e2aaae3 New \grammartoken markup, similar to \token but allowed everywhere.
Fred Drake <fdrake@acm.org>
parents: 19327
diff changeset
732 }
d4ba6e2aaae3 New \grammartoken markup, similar to \token but allowed everywhere.
Fred Drake <fdrake@acm.org>
parents: 19327
diff changeset
733
18426
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
734 sub do_env_productionlist{
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
735 local($_) = @_;
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
736 my $lang = next_optional_argument();
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
737 my $filename = "grammar-$lang.txt";
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
738 if ($lang eq '') {
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
739 $filename = 'grammar.txt';
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
740 }
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
741 local($CURRENT_GRAMMAR) = $lang;
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
742 $DefinedGrammars{$lang} .= $_;
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
743 return ("<dl><dd class=\"grammar\">\n"
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
744 . "<div class=\"productions\">\n"
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
745 . "<table cellpadding=\"2\" valign=\"baseline\">\n"
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
746 . translate_commands(translate_environments($_))
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
747 . "</table>\n"
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
748 . "</div>\n"
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
749 . (($lang eq '*')
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
750 ? ''
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
751 : ("<a class=\"grammar-footer\"\n"
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
752 . " href=\"$filename\" type=\"text/plain\"\n"
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
753 . " >Download entire grammar as text.</a>\n"))
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
754 . "</dd></dl>");
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
755 }
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
756
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
757 sub do_cmd_production{
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
758 local($_) = @_;
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
759 my $token = next_argument();
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
760 my $defn = next_argument();
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
761 my $lang = $CURRENT_GRAMMAR;
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
762 local($CURRENT_TOKEN) = $token;
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
763 if ($lang eq '*') {
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
764 return ("<tr>\n"
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
765 . " <td><code>$token</code></td>\n"
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
766 . " <td>&nbsp;::=&nbsp;</td>\n"
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
767 . " <td><code>"
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
768 . translate_commands($defn)
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
769 . "</code></td></tr>"
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
770 . $_);
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
771 }
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
772 my $target;
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
773 if ($lang eq '') {
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
774 $target = "$CURRENT_FILE\#tok-$token";
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
775 }
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
776 else {
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
777 $target = "$CURRENT_FILE\#tok-$lang-$token";
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
778 }
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
779 $TokenToTargetMapping{"$CURRENT_GRAMMAR:$token"} = $target;
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
780 return ("<tr>\n"
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
781 . " <td><code><a name=\"tok-$token\">$token</a></code></td>\n"
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
782 . " <td>&nbsp;::=&nbsp;</td>\n"
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
783 . " <td><code>"
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
784 . translate_commands($defn)
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
785 . "</code></td></tr>"
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
786 . $_);
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
787 }
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
788
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
789 sub process_grammar_files{
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
790 my $lang;
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
791 my $filename;
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
792 local($_);
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
793 print "process_grammar_files()\n";
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
794 foreach $lang (keys %DefinedGrammars) {
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
795 $filename = "grammar-$lang.txt";
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
796 if ($lang eq '*') {
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
797 next;
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
798 }
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
799 if ($lang eq '') {
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
800 $filename = 'grammar.txt';
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
801 }
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
802 open(GRAMMAR, ">$filename") || die "\n$!\n";
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
803 print GRAMMAR strip_grammar_markup($DefinedGrammars{$lang});
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
804 close(GRAMMAR);
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
805 print "Wrote grammar file $filename\n";
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
806 }
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
807 my $PATTERN = '<pyGrammarToken><([^>]*)><([^>]*)>';
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
808 foreach $filename (keys %BackpatchGrammarFiles) {
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
809 print "\nBack-patching grammar links in $filename\n";
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
810 my $buffer;
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
811 open(GRAMMAR, "<$filename") || die "\n$!\n";
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
812 # read all of the file into the buffer
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
813 sysread(GRAMMAR, $buffer, 1024*1024);
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
814 close(GRAMMAR);
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
815 while ($buffer =~ /$PATTERN/) {
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
816 my($lang, $token) = ($1, $2);
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
817 my $target = $TokenToTargetMapping{"$lang:$token"};
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
818 my $source = "<pyGrammarToken><$lang><$token>";
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
819 $buffer =~ s/$source/$target/g;
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
820 }
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
821 open(GRAMMAR, ">$filename") || die "\n$!\n";
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
822 print GRAMMAR $buffer;
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
823 close(GRAMMAR);
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
824 }
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
825 }
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
826
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
827 sub strip_grammar_markup{
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
828 local($_) = @_;
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
829 s/\\production(<<\d+>>)(.+)\1/\n\2 ::= /g;
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
830 s/\\token(<<\d+>>)(.+)\1/\2/g;
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
831 s/\\e([^a-zA-Z])/\\\1/g;
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
832 s/<<\d+>>//g;
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
833 s/;SPMgt;/>/g;
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
834 s/;SPMlt;/</g;
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
835 s/;SPMquot;/\"/g;
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
836 return $_;
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
837 }
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
838
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
839
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
840 $REFCOUNTS_LOADED = 0;
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
841
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
842 sub load_refcounts{
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
843 $REFCOUNTS_LOADED = 1;
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
844
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
845 my $myname, $mydir, $myext;
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
846 ($myname, $mydir, $myext) = fileparse(__FILE__, '\..*');
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
847 chop $mydir; # remove trailing '/'
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
848 ($myname, $mydir, $myext) = fileparse($mydir, '\..*');
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
849 chop $mydir; # remove trailing '/'
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
850 $mydir = getcwd() . "$dd$mydir"
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
851 unless $mydir =~ s|^/|/|;
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
852 local $_;
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
853 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
854 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
855 print "[loading API refcount data]";
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
856 while (<REFCOUNT_FILE>) {
12350
c59bdc7fd8a6 load_refcounts(),
Fred Drake <fdrake@acm.org>
parents: 12343
diff changeset
857 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
858 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
859 #print "\n$func($param) --> $count";
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
860 $REFCOUNTS{"$func:$param"} = $count;
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
861 }
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
862 }
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
863 }
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
864
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
865 sub get_refcount{
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
866 my ($func, $param) = @_;
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
867 load_refcounts()
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
868 unless $REFCOUNTS_LOADED;
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
869 return $REFCOUNTS{"$func:$param"};
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
870 }
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
871
20678
61e8f01de821 Add yet more markup that let's a stylesheet pick out a small bit of the
Fred Drake <fdrake@acm.org>
parents: 20336
diff changeset
872
61e8f01de821 Add yet more markup that let's a stylesheet pick out a small bit of the
Fred Drake <fdrake@acm.org>
parents: 20336
diff changeset
873 $TLSTART = '<span class="typelabel">';
61e8f01de821 Add yet more markup that let's a stylesheet pick out a small bit of the
Fred Drake <fdrake@acm.org>
parents: 20336
diff changeset
874 $TLEND = '</span>';
61e8f01de821 Add yet more markup that let's a stylesheet pick out a small bit of the
Fred Drake <fdrake@acm.org>
parents: 20336
diff changeset
875
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
876 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
877 local($_) = @_;
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
878 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
879 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
880 my $arg_list = next_argument();
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
881 my $idx = make_str_index_entry(
18185
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
882 "<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
883 $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
884 $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
885 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
886 my $rcinfo = '';
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
887 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
888 $rcinfo = 'New reference';
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
889 }
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
890 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
891 $rcinfo = 'Borrowed reference';
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
892 }
12350
c59bdc7fd8a6 load_refcounts(),
Fred Drake <fdrake@acm.org>
parents: 12343
diff changeset
893 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
894 $rcinfo = 'Always <tt class="constant">NULL</tt>';
12350
c59bdc7fd8a6 load_refcounts(),
Fred Drake <fdrake@acm.org>
parents: 12343
diff changeset
895 }
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
896 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
897 $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
898 . "\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
899 . "\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
900 . "\n</div>");
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
901 }
17249
6d30552cb4f9 Remove the spurious space of uncertain origin from the output for function,
Fred Drake <fdrake@acm.org>
parents: 16966
diff changeset
902 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
903 . $rcinfo
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
904 . $_
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
905 . '</dl>';
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
906 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
907
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
908 sub do_env_csimplemacrodesc{
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
909 local($_) = @_;
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
910 my $name = next_argument();
18185
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
911 my $idx = make_str_index_entry("<tt class=\"macro\">$name</tt>");
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
912 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
913 . $_
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
914 . '</dl>'
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
915 }
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
916
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
917 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
918 local($_) = @_;
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
919 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
920 my $type_name = next_argument();
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
921 $index_name = $type_name
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
922 unless $index_name;
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
923 my($name,$aname,$ahref) = new_link_info();
18185
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
924 add_index_entry("<tt class=\"ctype\">$index_name</tt> (C type)", $ahref);
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
925 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
926 . $_
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
927 . '</dl>'
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
928 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
929
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
930 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
931 local($_) = @_;
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
932 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
933 my $var_name = next_argument();
18185
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
934 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
935 . get_indexsubitem());
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
936 $idx =~ s/ \(.*\)//;
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
937 return "<dl><dt>$var_type <b>$idx</b>\n"
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
938 . '<dd>'
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
939 . $_
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
940 . '</dl>';
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
941 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
942
14556
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
943 sub convert_args($){
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
944 local($IN_DESC_HANDLER) = 1;
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
945 local($_) = @_;
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
946 return translate_commands($_);
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
947 }
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
948
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
949 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
950 local($_) = @_;
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
951 my $function_name = next_argument();
14556
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
952 my $arg_list = convert_args(next_argument());
18185
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
953 my $idx = make_str_index_entry("<tt class=\"function\">$function_name()"
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
954 . '</tt>'
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
955 . get_indexsubitem());
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
956 $idx =~ s/ \(.*\)//;
9775
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
957 $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
958 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
959 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
960
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
961 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
962 local($_) = @_;
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
963 my $function_name = next_argument();
14556
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
964 my $arg_list = convert_args(next_argument());
18185
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
965 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
966 . "(<var>$arg_list</var>)\n"
10197
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
967 . '<dd>'
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
968 . $_
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
969 . '</dl>';
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
970 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
971
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
972 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
973 local($_) = @_;
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
974 my $function_name = next_argument();
14556
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
975 my $arg_list = convert_args(next_argument());
18185
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
976 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
977 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
978 $prefix =~ s/\(\)//;
f6ec4a9cb0b3 do_cmd_funcline(): Remove some bogus generated stuff from the output
Fred Drake <fdrake@acm.org>
parents: 10637
diff changeset
979
17249
6d30552cb4f9 Remove the spurious space of uncertain origin from the output for function,
Fred Drake <fdrake@acm.org>
parents: 16966
diff changeset
980 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
981 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
982
11123
2eb2879d567f do_cmd_funclineni(): New function; non-indexing form of \funcline.
Fred Drake <fdrake@acm.org>
parents: 10857
diff changeset
983 sub do_cmd_funclineni{
2eb2879d567f do_cmd_funclineni(): New function; non-indexing form of \funcline.
Fred Drake <fdrake@acm.org>
parents: 10857
diff changeset
984 local($_) = @_;
2eb2879d567f do_cmd_funclineni(): New function; non-indexing form of \funcline.
Fred Drake <fdrake@acm.org>
parents: 10857
diff changeset
985 my $function_name = next_argument();
14556
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
986 my $arg_list = convert_args(next_argument());
18185
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
987 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
988
17249
6d30552cb4f9 Remove the spurious space of uncertain origin from the output for function,
Fred Drake <fdrake@acm.org>
parents: 16966
diff changeset
989 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
990 }
2eb2879d567f do_cmd_funclineni(): New function; non-indexing form of \funcline.
Fred Drake <fdrake@acm.org>
parents: 10857
diff changeset
991
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
992 # 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
993 # 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
994 # module.
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
995 #
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
996 $INDEX_OPCODES = 0;
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
997
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
998 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
999 local($_) = @_;
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
1000 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
1001 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
1002 my $idx;
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
1003 if ($INDEX_OPCODES) {
18185
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
1004 $idx = make_str_index_entry("<tt class=\"opcode\">$opcode_name</tt>"
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
1005 . ' (byte code instruction)');
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
1006 $idx =~ s/ \(byte code instruction\)//;
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
1007 }
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
1008 else {
18185
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
1009 $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
1010 }
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
1011 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
1012 if ($arg_list) {
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1013 $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
1014 }
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1015 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
1016 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1017
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1018 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
1019 local($_) = @_;
9775
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
1020 my $dataname = next_argument();
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
1021 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
1022 $idx =~ s/ \(.*\)//;
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1023 return "<dl><dt><b>$idx</b>\n<dd>"
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1024 . $_
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1025 . '</dl>';
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1026 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1027
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1028 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
1029 local($_) = @_;
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
1030 my $idx = next_argument();
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
1031 if (! $STRING_INDEX_TT) {
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
1032 $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
1033 }
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1034 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
1035 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1036
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1037 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
1038 local($_) = @_;
9775
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
1039 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
1040 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
1041 $idx =~ s/ \(.*\)//;
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1042 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
1043 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1044
12343
be5100afa1b7 do_cmd_datalineni(): New function, to implement the non-indexing form
Fred Drake <fdrake@acm.org>
parents: 12217
diff changeset
1045 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
1046 local($_) = @_;
be5100afa1b7 do_cmd_datalineni(): New function, to implement the non-indexing form
Fred Drake <fdrake@acm.org>
parents: 12217
diff changeset
1047 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
1048 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
1049 }
be5100afa1b7 do_cmd_datalineni(): New function, to implement the non-indexing form
Fred Drake <fdrake@acm.org>
parents: 12217
diff changeset
1050
7760
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
1051 sub do_env_excdesc{
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
1052 local($_) = @_;
9775
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
1053 my $excname = next_argument();
18185
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
1054 my $idx = make_str_index_entry("<tt class=\"exception\">$excname</tt>");
20678
61e8f01de821 Add yet more markup that let's a stylesheet pick out a small bit of the
Fred Drake <fdrake@acm.org>
parents: 20336
diff changeset
1055 return ("<dl><dt><b>${TLSTART}exception$TLEND $idx</b>"
61e8f01de821 Add yet more markup that let's a stylesheet pick out a small bit of the
Fred Drake <fdrake@acm.org>
parents: 20336
diff changeset
1056 . "\n<dd>"
61e8f01de821 Add yet more markup that let's a stylesheet pick out a small bit of the
Fred Drake <fdrake@acm.org>
parents: 20336
diff changeset
1057 . $_
61e8f01de821 Add yet more markup that let's a stylesheet pick out a small bit of the
Fred Drake <fdrake@acm.org>
parents: 20336
diff changeset
1058 . '</dl>');
7760
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
1059 }
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
1060
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1061 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
1062
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1063
14491
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1064 sub handle_classlike_descriptor{
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1065 local($_, $what) = @_;
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
1066 $THIS_CLASS = next_argument();
14556
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
1067 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
1068 $idx = make_str_index_entry(
18185
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
1069 "<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
1070 $idx =~ s/ \(.*\)//;
20678
61e8f01de821 Add yet more markup that let's a stylesheet pick out a small bit of the
Fred Drake <fdrake@acm.org>
parents: 20336
diff changeset
1071 return ("<dl><dt><b>$TLSTART$what$TLEND $idx</b>"
61e8f01de821 Add yet more markup that let's a stylesheet pick out a small bit of the
Fred Drake <fdrake@acm.org>
parents: 20336
diff changeset
1072 . "(<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
1073 . $_
38e17a089492 Label classes and exceptions explicitly in the documentation (for their
Fred Drake <fdrake@acm.org>
parents: 16114
diff changeset
1074 . '</dl>');
7760
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
1075 }
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
1076
14491
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1077 sub do_env_classdesc{
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1078 return handle_classlike_descriptor(@_[0], "class");
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1079 }
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1080
17778
b4b3657cb1fa Define a new environment, classdesc*, which can be used to document a
Fred Drake <fdrake@acm.org>
parents: 17602
diff changeset
1081 sub do_env_classdescstar{
b4b3657cb1fa Define a new environment, classdesc*, which can be used to document a
Fred Drake <fdrake@acm.org>
parents: 17602
diff changeset
1082 local($_) = @_;
b4b3657cb1fa Define a new environment, classdesc*, which can be used to document a
Fred Drake <fdrake@acm.org>
parents: 17602
diff changeset
1083 $THIS_CLASS = next_argument();
b4b3657cb1fa Define a new environment, classdesc*, which can be used to document a
Fred Drake <fdrake@acm.org>
parents: 17602
diff changeset
1084 $idx = make_str_index_entry(
18185
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
1085 "<tt class=\"class\">$THIS_CLASS</tt> (class in $THIS_MODULE)");
17778
b4b3657cb1fa Define a new environment, classdesc*, which can be used to document a
Fred Drake <fdrake@acm.org>
parents: 17602
diff changeset
1086 $idx =~ s/ \(.*\)//;
20678
61e8f01de821 Add yet more markup that let's a stylesheet pick out a small bit of the
Fred Drake <fdrake@acm.org>
parents: 20336
diff changeset
1087 return ("<dl><dt><b>${TLSTART}class$TLEND $idx</b>\n<dd>"
17778
b4b3657cb1fa Define a new environment, classdesc*, which can be used to document a
Fred Drake <fdrake@acm.org>
parents: 17602
diff changeset
1088 . $_
b4b3657cb1fa Define a new environment, classdesc*, which can be used to document a
Fred Drake <fdrake@acm.org>
parents: 17602
diff changeset
1089 . '</dl>');
b4b3657cb1fa Define a new environment, classdesc*, which can be used to document a
Fred Drake <fdrake@acm.org>
parents: 17602
diff changeset
1090 }
b4b3657cb1fa Define a new environment, classdesc*, which can be used to document a
Fred Drake <fdrake@acm.org>
parents: 17602
diff changeset
1091
14491
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1092 sub do_env_excclassdesc{
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1093 return handle_classlike_descriptor(@_[0], "exception");
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1094 }
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1095
7760
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
1096
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
1097 sub do_env_methoddesc{
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
1098 local($_) = @_;
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
1099 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
1100 $class_name = $THIS_CLASS
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
1101 unless $class_name;
9848
e19cd8ec20a2 do_cmd_methodline(): Fixed reference to method name when generating
Fred Drake <fdrake@acm.org>
parents: 9775
diff changeset
1102 my $method = next_argument();
14556
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
1103 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
1104 my $extra = '';
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
1105 if ($class_name) {
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
1106 $extra = " ($class_name method)";
7760
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
1107 }
18185
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
1108 my $idx = make_str_index_entry(
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
1109 "<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
1110 $idx =~ s/ \(.*\)//;
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
1111 $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
1112 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
1113 }
56dcfc27710a Coding cleanups.
Fred Drake <fdrake@acm.org>
parents: 7671
diff changeset
1114
7760
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
1115
9769
e1508f72c610 do_cmd_methodline(): New function, implements indexing version of
Fred Drake <fdrake@acm.org>
parents: 9718
diff changeset
1116 sub do_cmd_methodline{
e1508f72c610 do_cmd_methodline(): New function, implements indexing version of
Fred Drake <fdrake@acm.org>
parents: 9718
diff changeset
1117 local($_) = @_;
e1508f72c610 do_cmd_methodline(): New function, implements indexing version of
Fred Drake <fdrake@acm.org>
parents: 9718
diff changeset
1118 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
1119 $class_name = $THIS_CLASS
e1508f72c610 do_cmd_methodline(): New function, implements indexing version of
Fred Drake <fdrake@acm.org>
parents: 9718
diff changeset
1120 unless $class_name;
e1508f72c610 do_cmd_methodline(): New function, implements indexing version of
Fred Drake <fdrake@acm.org>
parents: 9718
diff changeset
1121 my $method = next_argument();
14556
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
1122 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
1123 my $extra = '';
e1508f72c610 do_cmd_methodline(): New function, implements indexing version of
Fred Drake <fdrake@acm.org>
parents: 9718
diff changeset
1124 if ($class_name) {
e1508f72c610 do_cmd_methodline(): New function, implements indexing version of
Fred Drake <fdrake@acm.org>
parents: 9718
diff changeset
1125 $extra = " ($class_name method)";
e1508f72c610 do_cmd_methodline(): New function, implements indexing version of
Fred Drake <fdrake@acm.org>
parents: 9718
diff changeset
1126 }
18185
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
1127 my $idx = make_str_index_entry(
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
1128 "<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
1129 $idx =~ s/ \(.*\)//;
e1508f72c610 do_cmd_methodline(): New function, implements indexing version of
Fred Drake <fdrake@acm.org>
parents: 9718
diff changeset
1130 $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
1131 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
1132 . $_;
e1508f72c610 do_cmd_methodline(): New function, implements indexing version of
Fred Drake <fdrake@acm.org>
parents: 9718
diff changeset
1133 }
e1508f72c610 do_cmd_methodline(): New function, implements indexing version of
Fred Drake <fdrake@acm.org>
parents: 9718
diff changeset
1134
e1508f72c610 do_cmd_methodline(): New function, implements indexing version of
Fred Drake <fdrake@acm.org>
parents: 9718
diff changeset
1135
9085
e943f9c09901 do_cmd_methodlineni(): New function, needed because the ref. manual now
Fred Drake <fdrake@acm.org>
parents: 8917
diff changeset
1136 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
1137 local($_) = @_;
e943f9c09901 do_cmd_methodlineni(): New function, needed because the ref. manual now
Fred Drake <fdrake@acm.org>
parents: 8917
diff changeset
1138 next_optional_argument();
e943f9c09901 do_cmd_methodlineni(): New function, needed because the ref. manual now
Fred Drake <fdrake@acm.org>
parents: 8917
diff changeset
1139 my $method = next_argument();
14556
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
1140 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
1141 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
1142 . $_;
e943f9c09901 do_cmd_methodlineni(): New function, needed because the ref. manual now
Fred Drake <fdrake@acm.org>
parents: 8917
diff changeset
1143 }
e943f9c09901 do_cmd_methodlineni(): New function, needed because the ref. manual now
Fred Drake <fdrake@acm.org>
parents: 8917
diff changeset
1144
7760
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
1145 sub do_env_methoddescni{
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
1146 local($_) = @_;
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
1147 next_optional_argument();
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
1148 my $method = next_argument();
14556
4ac09e970828 do_cmd_shortversion(),
Fred Drake <fdrake@acm.org>
parents: 14521
diff changeset
1149 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
1150 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
1151 . $_
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1152 . '</dl>';
7760
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
1153 }
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
1154
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
1155
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
1156 sub do_env_memberdesc{
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
1157 local($_) = @_;
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
1158 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
1159 my $member = next_argument();
7760
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
1160 $class = $THIS_CLASS
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
1161 unless $class;
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
1162 my $extra = '';
10637
bed15a015c1c Fix some remaining index & consistency nits. (Many data member
Fred Drake <fdrake@acm.org>
parents: 10598
diff changeset
1163 $extra = " ($class attribute)"
bed15a015c1c Fix some remaining index & consistency nits. (Many data member
Fred Drake <fdrake@acm.org>
parents: 10598
diff changeset
1164 if ($class ne '');
18185
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
1165 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
1166 $idx =~ s/ \(.*\)//;
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
1167 $idx =~ s/\(\)//;
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1168 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
1169 }
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
1170
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
1171
8086
692be123f547 next_optional_argument(): Don't include the square brackets in the return
Fred Drake <fdrake@acm.org>
parents: 8074
diff changeset
1172 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
1173 local($_) = @_;
692be123f547 next_optional_argument(): Don't include the square brackets in the return
Fred Drake <fdrake@acm.org>
parents: 8074
diff changeset
1174 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
1175 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
1176 $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
1177 unless $class;
692be123f547 next_optional_argument(): Don't include the square brackets in the return
Fred Drake <fdrake@acm.org>
parents: 8074
diff changeset
1178 my $extra = '';
10637
bed15a015c1c Fix some remaining index & consistency nits. (Many data member
Fred Drake <fdrake@acm.org>
parents: 10598
diff changeset
1179 $extra = " ($class attribute)"
bed15a015c1c Fix some remaining index & consistency nits. (Many data member
Fred Drake <fdrake@acm.org>
parents: 10598
diff changeset
1180 if ($class ne '');
18185
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
1181 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
1182 $idx =~ s/ \(.*\)//;
692be123f547 next_optional_argument(): Don't include the square brackets in the return
Fred Drake <fdrake@acm.org>
parents: 8074
diff changeset
1183 $idx =~ s/\(\)//;
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1184 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
1185 }
692be123f547 next_optional_argument(): Don't include the square brackets in the return
Fred Drake <fdrake@acm.org>
parents: 8074
diff changeset
1186
18683
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1187
7760
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
1188 sub do_env_memberdescni{
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
1189 local($_) = @_;
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
1190 next_optional_argument();
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
1191 my $member = next_argument();
18185
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
1192 return "<dl><dt><b><tt class=\"member\">$member</tt></b>\n<dd>"
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1193 . $_
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1194 . '</dl>';
7760
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
1195 }
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
1196
6bfa650f311d Lots and lots and lots.....
Fred Drake <fdrake@acm.org>
parents: 7711
diff changeset
1197
8086
692be123f547 next_optional_argument(): Don't include the square brackets in the return
Fred Drake <fdrake@acm.org>
parents: 8074
diff changeset
1198 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
1199 local($_) = @_;
692be123f547 next_optional_argument(): Don't include the square brackets in the return
Fred Drake <fdrake@acm.org>
parents: 8074
diff changeset
1200 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
1201 my $member = next_argument();
18185
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
1202 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
1203 }
692be123f547 next_optional_argument(): Don't include the square brackets in the return
Fred Drake <fdrake@acm.org>
parents: 8074
diff changeset
1204
18683
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1205
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1206 @col_aligns = ('<td>', '<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
1207
19327
73f685db8c0c fix_font(): Instead of using a long if/elsif cluster, use a bloody
Fred Drake <fdrake@acm.org>
parents: 18981
diff changeset
1208 %FontConversions = ('cdata' => 'tt class="cdata"',
73f685db8c0c fix_font(): Instead of using a long if/elsif cluster, use a bloody
Fred Drake <fdrake@acm.org>
parents: 18981
diff changeset
1209 'character' => 'tt class="character"',
73f685db8c0c fix_font(): Instead of using a long if/elsif cluster, use a bloody
Fred Drake <fdrake@acm.org>
parents: 18981
diff changeset
1210 'class' => 'tt class="class"',
73f685db8c0c fix_font(): Instead of using a long if/elsif cluster, use a bloody
Fred Drake <fdrake@acm.org>
parents: 18981
diff changeset
1211 'command' => 'code',
73f685db8c0c fix_font(): Instead of using a long if/elsif cluster, use a bloody
Fred Drake <fdrake@acm.org>
parents: 18981
diff changeset
1212 'constant' => 'tt class="constant"',
73f685db8c0c fix_font(): Instead of using a long if/elsif cluster, use a bloody
Fred Drake <fdrake@acm.org>
parents: 18981
diff changeset
1213 'exception' => 'tt class="exception"',
73f685db8c0c fix_font(): Instead of using a long if/elsif cluster, use a bloody
Fred Drake <fdrake@acm.org>
parents: 18981
diff changeset
1214 'file' => 'tt class="file"',
73f685db8c0c fix_font(): Instead of using a long if/elsif cluster, use a bloody
Fred Drake <fdrake@acm.org>
parents: 18981
diff changeset
1215 'filenq' => 'tt class="file"',
73f685db8c0c fix_font(): Instead of using a long if/elsif cluster, use a bloody
Fred Drake <fdrake@acm.org>
parents: 18981
diff changeset
1216 'kbd' => 'kbd',
73f685db8c0c fix_font(): Instead of using a long if/elsif cluster, use a bloody
Fred Drake <fdrake@acm.org>
parents: 18981
diff changeset
1217 'member' => 'tt class="member"',
73f685db8c0c fix_font(): Instead of using a long if/elsif cluster, use a bloody
Fred Drake <fdrake@acm.org>
parents: 18981
diff changeset
1218 'programopt' => 'b',
73f685db8c0c fix_font(): Instead of using a long if/elsif cluster, use a bloody
Fred Drake <fdrake@acm.org>
parents: 18981
diff changeset
1219 'textrm' => '',
73f685db8c0c fix_font(): Instead of using a long if/elsif cluster, use a bloody
Fred Drake <fdrake@acm.org>
parents: 18981
diff changeset
1220 );
73f685db8c0c fix_font(): Instead of using a long if/elsif cluster, use a bloody
Fred Drake <fdrake@acm.org>
parents: 18981
diff changeset
1221
10769
1af7a1467088 Control the layout of output tables a little better so they're easier
Fred Drake <fdrake@acm.org>
parents: 10767
diff changeset
1222 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
1223 # 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
1224 # 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
1225 my $font = @_[0];
19327
73f685db8c0c fix_font(): Instead of using a long if/elsif cluster, use a bloody
Fred Drake <fdrake@acm.org>
parents: 18981
diff changeset
1226 if (defined $FontConversions{$font}) {
73f685db8c0c fix_font(): Instead of using a long if/elsif cluster, use a bloody
Fred Drake <fdrake@acm.org>
parents: 18981
diff changeset
1227 $font = $FontConversions{$font};
16114
44fd1a7cb279 Fix \seepep handling -- correct URL to the online PEP repository on SF is
Fred Drake <fdrake@acm.org>
parents: 15567
diff changeset
1228 }
10769
1af7a1467088 Control the layout of output tables a little better so they're easier
Fred Drake <fdrake@acm.org>
parents: 10767
diff changeset
1229 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
1230 }
1af7a1467088 Control the layout of output tables a little better so they're easier
Fred Drake <fdrake@acm.org>
parents: 10767
diff changeset
1231
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1232 sub figure_column_alignment{
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1233 my $a = @_[0];
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1234 my $mark = substr($a, 0, 1);
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1235 my $r = '';
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1236 if ($mark eq 'c')
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1237 { $r = ' align="center"'; }
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1238 elsif ($mark eq 'r')
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1239 { $r = ' align="right"'; }
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1240 elsif ($mark eq 'l')
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1241 { $r = ' align="left"'; }
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1242 elsif ($mark eq 'p')
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1243 { $r = ' align="left"'; }
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1244 return $r;
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1245 }
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1246
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1247 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
1248 local($_) = @_;
18683
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1249 my($s1,$s2,$s3,$s4,$a5) = split(/[|]/,$_);
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1250 my $a1 = figure_column_alignment($s1);
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1251 my $a2 = figure_column_alignment($s2);
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1252 my $a3 = figure_column_alignment($s3);
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1253 my $a4 = figure_column_alignment($s4);
18683
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1254 my $a5 = figure_column_alignment($s5);
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1255 $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
1256 $col_aligns[1] = "<td$a2>";
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1257 $col_aligns[2] = "<td$a3>";
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1258 $col_aligns[3] = "<td$a4>";
18683
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1259 $col_aligns[4] = "<td$a5>";
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
1260 # return the aligned header start tags
18683
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1261 return ("<th$a1>", "<th$a2>", "<th$a3>", "<th$a4>", "<th$a5>");
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1262 }
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1263
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1264 sub get_table_col1_fonts{
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1265 my $font = $globals{'lineifont'};
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1266 my ($sfont,$efont) = ('', '');
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1267 if ($font) {
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1268 $sfont = "<$font>";
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1269 $efont = "</$font>";
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1270 $efont =~ s/ .*>/>/;
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1271 }
15459
a79d3624f845 A few small refinements to the table building code.
Fred Drake <fdrake@acm.org>
parents: 15363
diff changeset
1272 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
1273 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1274
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1275 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
1276 local($_) = @_;
18683
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1277 my($th1,$th2,$th3,$th4,$th5) = 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
1278 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
1279 my $h1 = next_argument();
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
1280 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
1281 s/[\s\n]+//;
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
1282 $globals{'lineifont'} = $font;
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1283 my $a1 = $col_aligns[0];
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1284 my $a2 = $col_aligns[1];
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1285 s/\\lineii</\\lineii[$a1|$a2]</g;
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1286 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
1287 . "\n <thead>"
0c19672d47bb Normalize the HTML generated for table headers.
Fred Drake <fdrake@acm.org>
parents: 15322
diff changeset
1288 . "\n <tr class=\"tableheader\">"
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1289 . "\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
1290 . "\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
1291 . "\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
1292 . "\n </thead>"
18185
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
1293 . "\n <tbody valign=\"baseline\">"
15349
0c19672d47bb Normalize the HTML generated for table headers.
Fred Drake <fdrake@acm.org>
parents: 15322
diff changeset
1294 . $_
10769
1af7a1467088 Control the layout of output tables a little better so they're easier
Fred Drake <fdrake@acm.org>
parents: 10767
diff changeset
1295 . "\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
1296 . "\n</table>";
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1297 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1298
14722
4d2e9cf1eb20 Add new environments: longtableii, longtableiii, and longtableiv, to
Fred Drake <fdrake@acm.org>
parents: 14556
diff changeset
1299 sub do_env_longtableii{
4d2e9cf1eb20 Add new environments: longtableii, longtableiii, and longtableiv, to
Fred Drake <fdrake@acm.org>
parents: 14556
diff changeset
1300 return do_env_tableii(@_);
4d2e9cf1eb20 Add new environments: longtableii, longtableiii, and longtableiv, to
Fred Drake <fdrake@acm.org>
parents: 14556
diff changeset
1301 }
4d2e9cf1eb20 Add new environments: longtableii, longtableiii, and longtableiv, to
Fred Drake <fdrake@acm.org>
parents: 14556
diff changeset
1302
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1303 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
1304 local($_) = @_;
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1305 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
1306 my $c1 = next_argument();
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
1307 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
1308 s/[\s\n]+//;
15459
a79d3624f845 A few small refinements to the table building code.
Fred Drake <fdrake@acm.org>
parents: 15363
diff changeset
1309 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
1310 $c2 = '&nbsp;' if ($c2 eq '');
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1311 my($c1align,$c2align) = split('\|', $aligns);
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1312 my $padding = '';
15459
a79d3624f845 A few small refinements to the table building code.
Fred Drake <fdrake@acm.org>
parents: 15363
diff changeset
1313 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
1314 $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
1315 }
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1316 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
1317 . " $c2align$c2</td>"
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1318 . $_;
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1319 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1320
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1321 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
1322 local($_) = @_;
18683
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1323 my($th1,$th2,$th3,$th4,$th5) = 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
1324 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
1325 my $h1 = next_argument();
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
1326 my $h2 = next_argument();
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
1327 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
1328 s/[\s\n]+//;
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
1329 $globals{'lineifont'} = $font;
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1330 my $a1 = $col_aligns[0];
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1331 my $a2 = $col_aligns[1];
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1332 my $a3 = $col_aligns[2];
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1333 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
1334 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
1335 . "\n <thead>"
0c19672d47bb Normalize the HTML generated for table headers.
Fred Drake <fdrake@acm.org>
parents: 15322
diff changeset
1336 . "\n <tr class=\"tableheader\">"
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1337 . "\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
1338 . "\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
1339 . "\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
1340 . "\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
1341 . "\n </thead>"
18185
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
1342 . "\n <tbody valign=\"baseline\">"
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1343 . $_
10769
1af7a1467088 Control the layout of output tables a little better so they're easier
Fred Drake <fdrake@acm.org>
parents: 10767
diff changeset
1344 . "\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
1345 . "\n</table>";
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1346 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1347
14722
4d2e9cf1eb20 Add new environments: longtableii, longtableiii, and longtableiv, to
Fred Drake <fdrake@acm.org>
parents: 14556
diff changeset
1348 sub do_env_longtableiii{
4d2e9cf1eb20 Add new environments: longtableii, longtableiii, and longtableiv, to
Fred Drake <fdrake@acm.org>
parents: 14556
diff changeset
1349 return do_env_tableiii(@_);
4d2e9cf1eb20 Add new environments: longtableii, longtableiii, and longtableiv, to
Fred Drake <fdrake@acm.org>
parents: 14556
diff changeset
1350 }
4d2e9cf1eb20 Add new environments: longtableii, longtableiii, and longtableiv, to
Fred Drake <fdrake@acm.org>
parents: 14556
diff changeset
1351
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1352 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
1353 local($_) = @_;
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1354 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
1355 my $c1 = next_argument();
18683
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1356 my $c2 = next_argument();
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
1357 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
1358 s/[\s\n]+//;
15459
a79d3624f845 A few small refinements to the table building code.
Fred Drake <fdrake@acm.org>
parents: 15363
diff changeset
1359 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
1360 $c3 = '&nbsp;' if ($c3 eq '');
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1361 my($c1align,$c2align,$c3align) = split('\|', $aligns);
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1362 my $padding = '';
15459
a79d3624f845 A few small refinements to the table building code.
Fred Drake <fdrake@acm.org>
parents: 15363
diff changeset
1363 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
1364 $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
1365 }
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1366 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
1367 . " $c2align$c2</td>\n"
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1368 . " $c3align$c3</td>"
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1369 . $_;
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1370 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1371
8754
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1372 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
1373 local($_) = @_;
18683
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1374 my($th1,$th2,$th3,$th4,$th5) = 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
1375 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
1376 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
1377 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
1378 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
1379 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
1380 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
1381 $globals{'lineifont'} = $font;
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1382 my $a1 = $col_aligns[0];
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1383 my $a2 = $col_aligns[1];
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1384 my $a3 = $col_aligns[2];
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1385 my $a4 = $col_aligns[3];
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1386 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
1387 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
1388 . "\n <thead>"
0c19672d47bb Normalize the HTML generated for table headers.
Fred Drake <fdrake@acm.org>
parents: 15322
diff changeset
1389 . "\n <tr class=\"tableheader\">"
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1390 . "\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
1391 . "\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
1392 . "\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
1393 . "\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
1394 . "\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
1395 . "\n </thead>"
18185
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
1396 . "\n <tbody valign=\"baseline\">"
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1397 . $_
10769
1af7a1467088 Control the layout of output tables a little better so they're easier
Fred Drake <fdrake@acm.org>
parents: 10767
diff changeset
1398 . "\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
1399 . "\n</table>";
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1400 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1401
14722
4d2e9cf1eb20 Add new environments: longtableii, longtableiii, and longtableiv, to
Fred Drake <fdrake@acm.org>
parents: 14556
diff changeset
1402 sub do_env_longtableiv{
4d2e9cf1eb20 Add new environments: longtableii, longtableiii, and longtableiv, to
Fred Drake <fdrake@acm.org>
parents: 14556
diff changeset
1403 return do_env_tableiv(@_);
4d2e9cf1eb20 Add new environments: longtableii, longtableiii, and longtableiv, to
Fred Drake <fdrake@acm.org>
parents: 14556
diff changeset
1404 }
4d2e9cf1eb20 Add new environments: longtableii, longtableiii, and longtableiv, to
Fred Drake <fdrake@acm.org>
parents: 14556
diff changeset
1405
8754
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1406 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
1407 local($_) = @_;
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1408 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
1409 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
1410 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
1411 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
1412 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
1413 s/[\s\n]+//;
15459
a79d3624f845 A few small refinements to the table building code.
Fred Drake <fdrake@acm.org>
parents: 15363
diff changeset
1414 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
1415 $c4 = '&nbsp;' if ($c4 eq '');
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1416 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
1417 my $padding = '';
15459
a79d3624f845 A few small refinements to the table building code.
Fred Drake <fdrake@acm.org>
parents: 15363
diff changeset
1418 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
1419 $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
1420 }
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1421 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
1422 . " $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
1423 . " $c3align$c3</td>\n"
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1424 . " $c4align$c4</td>"
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1425 . $_;
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1426 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1427
18683
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1428 sub do_env_tablev{
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1429 local($_) = @_;
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1430 my($th1,$th2,$th3,$th4,$th5) = setup_column_alignments(next_argument());
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1431 my $font = fix_font(next_argument());
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1432 my $h1 = next_argument();
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1433 my $h2 = next_argument();
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1434 my $h3 = next_argument();
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1435 my $h4 = next_argument();
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1436 my $h5 = next_argument();
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1437 s/[\s\n]+//;
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1438 $globals{'lineifont'} = $font;
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1439 my $a1 = $col_aligns[0];
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1440 my $a2 = $col_aligns[1];
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1441 my $a3 = $col_aligns[2];
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1442 my $a4 = $col_aligns[3];
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1443 my $a5 = $col_aligns[4];
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1444 s/\\linev</\\linev[$a1|$a2|$a3|$a4|$a5]</g;
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1445 return '<table border align="center" style="border-collapse: collapse">'
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1446 . "\n <thead>"
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1447 . "\n <tr class=\"tableheader\">"
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1448 . "\n $th1<b>$h1</b>\&nbsp;</th>"
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1449 . "\n $th2<b>$h2</b>\&nbsp;</th>"
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1450 . "\n $th3<b>$h3</b>\&nbsp;</th>"
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1451 . "\n $th4<b>$h4</b>\&nbsp;</th>"
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1452 . "\n $th5<b>$h5</b>\&nbsp;</th>"
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1453 . "\n </tr>"
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1454 . "\n </thead>"
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1455 . "\n <tbody valign=\"baseline\">"
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1456 . $_
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1457 . "\n </tbody>"
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1458 . "\n</table>";
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1459 }
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1460
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1461 sub do_env_longtablev{
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1462 return do_env_tablev(@_);
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1463 }
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1464
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1465 sub do_cmd_linev{
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1466 local($_) = @_;
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1467 my $aligns = next_optional_argument();
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1468 my $c1 = next_argument();
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1469 my $c2 = next_argument();
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1470 my $c3 = next_argument();
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1471 my $c4 = next_argument();
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1472 my $c5 = next_argument();
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1473 s/[\s\n]+//;
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1474 my($sfont,$efont) = get_table_col1_fonts();
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1475 $c5 = '&nbsp;' if ($c5 eq '');
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1476 my($c1align,$c2align,$c3align,$c4align,$c5align) = split('\|', $aligns);
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1477 my $padding = '';
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1478 if ($c1align =~ /align="right"/ || $c1 eq '') {
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1479 $padding = '&nbsp;';
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1480 }
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1481 return "\n <tr>$c1align$sfont$c1$efont$padding</td>\n"
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1482 . " $c2align$c2</td>\n"
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1483 . " $c3align$c3</td>\n"
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1484 . " $c4align$c4</td>\n"
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1485 . " $c5align$c5</td>"
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1486 . $_;
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1487 }
8ca70c9c1971 Define new markup for 5-column tables.
Fred Drake <fdrake@acm.org>
parents: 18426
diff changeset
1488
14285
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1489
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1490 # 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
1491 # 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
1492 #
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1493 # 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
1494 # $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
1495 # 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
1496 #
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1497 # 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
1498 # 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
1499 # 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
1500 # are optional.
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1501 #
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1502 # $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
1503 # $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
1504 # $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
1505 # $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
1506 # $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
1507
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1508 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
1509 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
1510 if ($t_title) {
10197
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
1511 $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
1512 }
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1513 else {
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1514 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
1515 }
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1516 if ($t_author) {
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1517 if ($t_authorURL) {
8074
d0ff41746a26 New helper functions to help deal with parameter parsing.
Fred Drake <fdrake@acm.org>
parents: 8031
diff changeset
1518 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
1519 $href = make_named_href('author', $href,
18185
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
1520 "<b><font size=\"+2\">$t_author"
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
1521 . '</font></b>');
7711
56dcfc27710a Coding cleanups.
Fred Drake <fdrake@acm.org>
parents: 7671
diff changeset
1522 $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
1523 }
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1524 else {
18185
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
1525 $the_title .= ("\n<p><b><font size=\"+2\">$t_author"
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
1526 . '</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
1527 }
14285
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1528 }
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1529 else {
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1530 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
1531 }
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1532 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
1533 $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
1534 }
8342
22815a0b1267 Added support for \developer, \developers, \developersaddress.
Fred Drake <fdrake@acm.org>
parents: 8294
diff changeset
1535 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
1536 $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
1537 }
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1538 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
1539 $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
1540 }
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1541 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
1542 $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
1543 if ($PACKAGE_VERSION) {
18185
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
1544 $the_title .= ('<strong>Release '
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
1545 . "$PACKAGE_VERSION$RELEASE_INFO</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
1546 }
15567
d38516ce6f14 For the title page, insert the package version number before the date.
Fred Drake <fdrake@acm.org>
parents: 15459
diff changeset
1547 $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
1548 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1549 if ($t_address) {
7711
56dcfc27710a Coding cleanups.
Fred Drake <fdrake@acm.org>
parents: 7671
diff changeset
1550 $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
1551 }
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1552 else {
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1553 $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
1554 }
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1555 if ($t_email) {
7711
56dcfc27710a Coding cleanups.
Fred Drake <fdrake@acm.org>
parents: 7671
diff changeset
1556 $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
1557 }
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1558 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
1559 }
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1560
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1561 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
1562 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
1563 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
1564 $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
1565 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
1566 $graphic .= "><img";
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1567 $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
1568 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
1569 $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
1570 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
1571 $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
1572 return $graphic;
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1573 }
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1574
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1575 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
1576 local($_) = @_;
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1577 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
1578 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
1579 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
1580 $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
1581 . "<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
1582 . 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
1583 . "</td>\n"
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1584 . 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
1585 . "</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
1586 }
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1587 else {
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1588 $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
1589 . 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
1590 . "<td>"
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1591 . 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
1592 . "</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
1593 }
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1594 }
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1595 else {
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1596 $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
1597 . 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
1598 . "\n</center>");
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1599 }
d357ad367f26 Push some table header formatting to the style sheet; this also helps
Fred Drake <fdrake@acm.org>
parents: 13926
diff changeset
1600 $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
1601 return $the_title . $_;
10197
de7c0003578f Become more stylesheet-friendly.
Fred Drake <fdrake@acm.org>
parents: 10157
diff changeset
1602 $the_title .= "\n</center></div>";
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1603 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
1604 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1605
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1606
8397
c9b7e926fd86 Added support for AMK's {definitions} environment; thanks for the reminder!
Fred Drake <fdrake@acm.org>
parents: 8349
diff changeset
1607 #
8754
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1608 # 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
1609 #
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1610
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1611 require SynopsisTable;
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1612
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
1613 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
1614 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
1615 $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
1616 $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
1617 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
1618 }
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1619
14491
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1620 # 'chapter' => 'SynopsisTable instance'
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1621 %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
1622
fba8455dcb54 Fix up the synopsis table stuff so it gets things right at each chapter,
Fred Drake <fdrake@acm.org>
parents: 8754
diff changeset
1623 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
1624 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
1625 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
1626 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
1627 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
1628 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
1629 }
8754
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1630 }
14491
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1631 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
1632 $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
1633 return $st;
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1634 }
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1635
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1636 sub do_cmd_moduleauthor{
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1637 local($_) = @_;
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1638 next_argument();
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1639 next_argument();
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1640 return $_;
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1641 }
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1642
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1643 sub do_cmd_sectionauthor{
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1644 local($_) = @_;
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1645 next_argument();
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1646 next_argument();
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1647 return $_;
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1648 }
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1649
8754
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1650 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
1651 local($_) = @_;
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1652 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
1653 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
1654 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
1655 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
1656 #
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1657 $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
1658 $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
1659 $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
1660 define_module($type, $name);
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1661 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
1662 }
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1663
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1664 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
1665 local($_) = @_;
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1666 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
1667 $st->set_synopsis($THIS_MODULE, translate_commands(next_argument()));
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1668 return $_;
8754
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1669 }
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1670
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1671 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
1672 local($_) = @_;
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1673 my $chap = get_chapter_id();
14491
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1674 my $st = get_synopsis_table($chap);
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1675 $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
1676 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
1677 }
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1678
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1679 sub process_all_localmoduletables{
14491
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1680 my $key;
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1681 my $st, $file;
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1682 foreach $key (keys %ModuleSynopses) {
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1683 $st = $ModuleSynopses{$key};
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1684 $file = $st->get_file();
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1685 if ($file) {
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1686 process_localmoduletables_in_file($file);
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1687 }
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1688 else {
18231
f9261904cebb Added support for our new \infinity and \plusminus macros, and the
Fred Drake <fdrake@acm.org>
parents: 18185
diff changeset
1689 print "\nsynopsis table $key has no file association\n";
14491
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1690 }
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1691 }
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1692 }
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1693
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1694 sub process_localmoduletables_in_file{
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1695 my $file = @_[0];
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1696 open(MYFILE, "<$file");
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1697 local($_);
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1698 sysread(MYFILE, $_, 1024*1024);
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1699 close(MYFILE);
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1700 # 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
1701 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
1702 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
1703 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
1704 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
1705 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
1706 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
1707 }
14491
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1708 open(MYFILE,">$file");
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1709 print MYFILE $_;
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1710 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
1711 }
10327
66a7d61cfd84 swallow_newline(): Removed function; not really needed. Modified all call
Fred Drake <fdrake@acm.org>
parents: 10197
diff changeset
1712 sub process_python_state{
66a7d61cfd84 swallow_newline(): Removed function; not really needed. Modified all call
Fred Drake <fdrake@acm.org>
parents: 10197
diff changeset
1713 process_all_localmoduletables();
18426
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
1714 process_grammar_files();
10327
66a7d61cfd84 swallow_newline(): Removed function; not really needed. Modified all call
Fred Drake <fdrake@acm.org>
parents: 10197
diff changeset
1715 }
8754
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1716
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1717
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1718 #
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1719 # "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
1720 #
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1721
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1722 sub do_env_seealso{
18185
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
1723 return ("<div class=\"seealso\">\n "
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
1724 . "<p class=\"heading\"><b>See Also:</b></p>\n"
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
1725 . @_[0]
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
1726 . '</div>');
8754
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1727 }
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1728
21116
0a67463f8b7d Add a new environment in the Python docs markup: seealso*. This is similar
Fred Drake <fdrake@acm.org>
parents: 20678
diff changeset
1729 sub do_env_seealsostar{
0a67463f8b7d Add a new environment in the Python docs markup: seealso*. This is similar
Fred Drake <fdrake@acm.org>
parents: 20678
diff changeset
1730 return ("<div class=\"seealso-simple\">\n "
0a67463f8b7d Add a new environment in the Python docs markup: seealso*. This is similar
Fred Drake <fdrake@acm.org>
parents: 20678
diff changeset
1731 . @_[0]
0a67463f8b7d Add a new environment in the Python docs markup: seealso*. This is similar
Fred Drake <fdrake@acm.org>
parents: 20678
diff changeset
1732 . '</div>');
0a67463f8b7d Add a new environment in the Python docs markup: seealso*. This is similar
Fred Drake <fdrake@acm.org>
parents: 20678
diff changeset
1733 }
0a67463f8b7d Add a new environment in the Python docs markup: seealso*. This is similar
Fred Drake <fdrake@acm.org>
parents: 20678
diff changeset
1734
8754
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1735 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
1736 # 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
1737 # 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
1738 local($_) = @_;
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1739 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
1740 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
1741 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
1742 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
1743 $key = $module
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1744 unless $key;
10846
b7378df3db56 Change the look of \seemodule output to fit in better.
Fred Drake <fdrake@acm.org>
parents: 10777
diff changeset
1745 if ($text =~ /\.$/) {
b7378df3db56 Change the look of \seemodule output to fit in better.
Fred Drake <fdrake@acm.org>
parents: 10777
diff changeset
1746 $period = '';
b7378df3db56 Change the look of \seemodule output to fit in better.
Fred Drake <fdrake@acm.org>
parents: 10777
diff changeset
1747 }
18185
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
1748 return ('<dl compact class="seemodule">'
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
1749 . "\n <dt>Module <b><tt class=\"module\">"
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
1750 . "<a href=\"module-$key.html\">$module</a></tt>:</b>"
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
1751 . "\n <dd>$text$period\n </dl>"
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
1752 . $_);
8754
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1753 }
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1754
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
1755 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
1756 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
1757 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
1758 $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
1759 $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
1760 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
1761 }
c2fb2d476bd3 When forming the <A> tag for a \seepep or \seerfc, make sure we strip
Fred Drake <fdrake@acm.org>
parents: 17381
diff changeset
1762
14491
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1763 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
1764 local($_, $what, $format) = @_;
12499
0780aba97898 ref_module_index_helper(): Use "my" instead of "local".
Fred Drake <fdrake@acm.org>
parents: 12376
diff changeset
1765 my $rfcnum = next_argument();
0780aba97898 ref_module_index_helper(): Use "my" instead of "local".
Fred Drake <fdrake@acm.org>
parents: 12376
diff changeset
1766 my $title = next_argument();
0780aba97898 ref_module_index_helper(): Use "my" instead of "local".
Fred Drake <fdrake@acm.org>
parents: 12376
diff changeset
1767 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
1768 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
1769 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
1770 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
1771 return '<dl compact class="seerfc">'
0780aba97898 ref_module_index_helper(): Use "my" instead of "local".
Fred Drake <fdrake@acm.org>
parents: 12376
diff changeset
1772 . "\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
1773 . "\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
1774 . "\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
1775 . "\n <dd>$text\n </dl>"
0780aba97898 ref_module_index_helper(): Use "my" instead of "local".
Fred Drake <fdrake@acm.org>
parents: 12376
diff changeset
1776 . $_;
0780aba97898 ref_module_index_helper(): Use "my" instead of "local".
Fred Drake <fdrake@acm.org>
parents: 12376
diff changeset
1777 }
0780aba97898 ref_module_index_helper(): Use "my" instead of "local".
Fred Drake <fdrake@acm.org>
parents: 12376
diff changeset
1778
14491
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1779 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
1780 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
1781 }
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1782
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1783 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
1784 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
1785 }
334d9aebaaf1 Add support for new \pep, \seepep, excclassdesc markup.
Fred Drake <fdrake@acm.org>
parents: 14285
diff changeset
1786
14521
9fed4eebc586 \seetitle: New macro for building reference list content.
Fred Drake <fdrake@acm.org>
parents: 14491
diff changeset
1787 sub do_cmd_seetitle{
9fed4eebc586 \seetitle: New macro for building reference list content.
Fred Drake <fdrake@acm.org>
parents: 14491
diff changeset
1788 local($_) = @_;
9fed4eebc586 \seetitle: New macro for building reference list content.
Fred Drake <fdrake@acm.org>
parents: 14491
diff changeset
1789 my $url = next_optional_argument();
9fed4eebc586 \seetitle: New macro for building reference list content.
Fred Drake <fdrake@acm.org>
parents: 14491
diff changeset
1790 my $title = next_argument();
9fed4eebc586 \seetitle: New macro for building reference list content.
Fred Drake <fdrake@acm.org>
parents: 14491
diff changeset
1791 my $text = next_argument();
9fed4eebc586 \seetitle: New macro for building reference list content.
Fred Drake <fdrake@acm.org>
parents: 14491
diff changeset
1792 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
1793 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
1794 return '<dl compact class="seetitle">'
9fed4eebc586 \seetitle: New macro for building reference list content.
Fred Drake <fdrake@acm.org>
parents: 14491
diff changeset
1795 . "\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
1796 . "\n >$title$icon</a></em>"
14521
9fed4eebc586 \seetitle: New macro for building reference list content.
Fred Drake <fdrake@acm.org>
parents: 14491
diff changeset
1797 . "\n <dd>$text\n </dl>"
9fed4eebc586 \seetitle: New macro for building reference list content.
Fred Drake <fdrake@acm.org>
parents: 14491
diff changeset
1798 . $_;
9fed4eebc586 \seetitle: New macro for building reference list content.
Fred Drake <fdrake@acm.org>
parents: 14491
diff changeset
1799 }
9fed4eebc586 \seetitle: New macro for building reference list content.
Fred Drake <fdrake@acm.org>
parents: 14491
diff changeset
1800 return '<dl compact class="seetitle">'
9fed4eebc586 \seetitle: New macro for building reference list content.
Fred Drake <fdrake@acm.org>
parents: 14491
diff changeset
1801 . "\n <dt><em class=\"citetitle\""
9fed4eebc586 \seetitle: New macro for building reference list content.
Fred Drake <fdrake@acm.org>
parents: 14491
diff changeset
1802 . "\n >$title</em>"
9fed4eebc586 \seetitle: New macro for building reference list content.
Fred Drake <fdrake@acm.org>
parents: 14491
diff changeset
1803 . "\n <dd>$text\n </dl>"
9fed4eebc586 \seetitle: New macro for building reference list content.
Fred Drake <fdrake@acm.org>
parents: 14491
diff changeset
1804 . $_;
9fed4eebc586 \seetitle: New macro for building reference list content.
Fred Drake <fdrake@acm.org>
parents: 14491
diff changeset
1805 }
9fed4eebc586 \seetitle: New macro for building reference list content.
Fred Drake <fdrake@acm.org>
parents: 14491
diff changeset
1806
12637
69481cde511d do_cmd_seeurl(): New function.
Fred Drake <fdrake@acm.org>
parents: 12551
diff changeset
1807 sub do_cmd_seeurl{
69481cde511d do_cmd_seeurl(): New function.
Fred Drake <fdrake@acm.org>
parents: 12551
diff changeset
1808 local($_) = @_;
69481cde511d do_cmd_seeurl(): New function.
Fred Drake <fdrake@acm.org>
parents: 12551
diff changeset
1809 my $url = next_argument();
69481cde511d do_cmd_seeurl(): New function.
Fred Drake <fdrake@acm.org>
parents: 12551
diff changeset
1810 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
1811 my $icon = get_link_icon($url);
12637
69481cde511d do_cmd_seeurl(): New function.
Fred Drake <fdrake@acm.org>
parents: 12551
diff changeset
1812 return '<dl compact class="seeurl">'
69481cde511d do_cmd_seeurl(): New function.
Fred Drake <fdrake@acm.org>
parents: 12551
diff changeset
1813 . "\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
1814 . "\n class=\"url\">$url$icon</a>"
12637
69481cde511d do_cmd_seeurl(): New function.
Fred Drake <fdrake@acm.org>
parents: 12551
diff changeset
1815 . "\n <dd>$text\n </dl>"
69481cde511d do_cmd_seeurl(): New function.
Fred Drake <fdrake@acm.org>
parents: 12551
diff changeset
1816 . $_;
69481cde511d do_cmd_seeurl(): New function.
Fred Drake <fdrake@acm.org>
parents: 12551
diff changeset
1817 }
69481cde511d do_cmd_seeurl(): New function.
Fred Drake <fdrake@acm.org>
parents: 12551
diff changeset
1818
8754
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1819 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
1820 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
1821 my $content = next_argument();
12217
5ea773413531 Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11449
diff changeset
1822 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
1823 }
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1824
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1825
e88d4e6e4622 Added module synopsis support with one (big) caveat: All the modules are
Fred Drake <fdrake@acm.org>
parents: 8397
diff changeset
1826 #
8397
c9b7e926fd86 Added support for AMK's {definitions} environment; thanks for the reminder!
Fred Drake <fdrake@acm.org>
parents: 8349
diff changeset
1827 # Definition list support.
c9b7e926fd86 Added support for AMK's {definitions} environment; thanks for the reminder!
Fred Drake <fdrake@acm.org>
parents: 8349
diff changeset
1828 #
c9b7e926fd86 Added support for AMK's {definitions} environment; thanks for the reminder!
Fred Drake <fdrake@acm.org>
parents: 8349
diff changeset
1829
c9b7e926fd86 Added support for AMK's {definitions} environment; thanks for the reminder!
Fred Drake <fdrake@acm.org>
parents: 8349
diff changeset
1830 sub do_env_definitions{
18185
d3b1956e3de0 Added support for new \setreleaseinfo macro.
Fred Drake <fdrake@acm.org>
parents: 18127
diff changeset
1831 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
1832 }
c9b7e926fd86 Added support for AMK's {definitions} environment; thanks for the reminder!
Fred Drake <fdrake@acm.org>
parents: 8349
diff changeset
1833
c9b7e926fd86 Added support for AMK's {definitions} environment; thanks for the reminder!
Fred Drake <fdrake@acm.org>
parents: 8349
diff changeset
1834 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
1835 local($_) = @_;
9775
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
1836 my $term = next_argument();
b116afb81732 write_idxfile(): New function. Isolate format of the external index
Fred Drake <fdrake@acm.org>
parents: 9769
diff changeset
1837 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
1838 # could easily add an index entry here...
8917
e55a79ff8228 do_cmd_moduleauthor(),
Fred Drake <fdrake@acm.org>
parents: 8820
diff changeset
1839 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
1840 }
c9b7e926fd86 Added support for AMK's {definitions} environment; thanks for the reminder!
Fred Drake <fdrake@acm.org>
parents: 8349
diff changeset
1841
c9b7e926fd86 Added support for AMK's {definitions} environment; thanks for the reminder!
Fred Drake <fdrake@acm.org>
parents: 8349
diff changeset
1842
14766
72860ef03171 use_sans_serif(),
Fred Drake <fdrake@acm.org>
parents: 14722
diff changeset
1843 # 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
1844 # 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
1845 # things broke with it in.
72860ef03171 use_sans_serif(),
Fred Drake <fdrake@acm.org>
parents: 14722
diff changeset
1846
72860ef03171 use_sans_serif(),
Fred Drake <fdrake@acm.org>
parents: 14722
diff changeset
1847 #code # {}
10100
9184862bd8d1 More magic to tighten up a little of the formatting.
Fred Drake <fdrake@acm.org>
parents: 10077
diff changeset
1848 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
1849 declaremodule # [] # {} # {}
b21915e6589e Fix up some routines to coordinate the "indexsubitem" stuff so that
Fred Drake <fdrake@acm.org>
parents: 10128
diff changeset
1850 memberline # [] # {}
b21915e6589e Fix up some routines to coordinate the "indexsubitem" stuff so that
Fred Drake <fdrake@acm.org>
parents: 10128
diff changeset
1851 methodline # [] # {} # {}
b21915e6589e Fix up some routines to coordinate the "indexsubitem" stuff so that
Fred Drake <fdrake@acm.org>
parents: 10128
diff changeset
1852 modulesynopsis # {}
10327
66a7d61cfd84 swallow_newline(): Removed function; not really needed. Modified all call
Fred Drake <fdrake@acm.org>
parents: 10197
diff changeset
1853 platform # {}
10100
9184862bd8d1 More magic to tighten up a little of the formatting.
Fred Drake <fdrake@acm.org>
parents: 10077
diff changeset
1854 samp # {}
10138
b21915e6589e Fix up some routines to coordinate the "indexsubitem" stuff so that
Fred Drake <fdrake@acm.org>
parents: 10128
diff changeset
1855 setindexsubitem # {}
10157
13239b48c469 Minor fix that helps out with the index.
Fred Drake <fdrake@acm.org>
parents: 10149
diff changeset
1856 withsubitem # {} # {}
10100
9184862bd8d1 More magic to tighten up a little of the formatting.
Fred Drake <fdrake@acm.org>
parents: 10077
diff changeset
1857 _RAW_ARG_DEFERRED_CMDS_
9184862bd8d1 More magic to tighten up a little of the formatting.
Fred Drake <fdrake@acm.org>
parents: 10077
diff changeset
1858
9184862bd8d1 More magic to tighten up a little of the formatting.
Fred Drake <fdrake@acm.org>
parents: 10077
diff changeset
1859
17381
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1860 $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
1861 $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
1862
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1863 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
1864 local ($_) = @_;
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1865 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
1866
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1867 # 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
1868 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
1869 ($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
1870
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1871 # 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
1872 $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
1873 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
1874 ($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
1875 = &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
1876 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
1877
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1878 $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
1879
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1880 do {
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1881 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
1882 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
1883
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1884 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
1885 $_ = 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
1886 , $_ , $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
1887
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1888 $_ = &translate_environments($_);
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1889 $_ = &translate_commands($_) if (/\\/);
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1890
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1891 # 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
1892 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
1893 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
1894
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1895 $_ = 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
1896 , $_
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1897 , &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
1898 , $alltt_end, $reopens);
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1899 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
1900 };
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1901 $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
1902 $_;
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1903 }
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1904
18127
e328218546b5 Implement the \verbatiminput LaTeX macro; this contains more magic than
Fred Drake <fdrake@acm.org>
parents: 17778
diff changeset
1905 sub do_cmd_verbatiminput{
e328218546b5 Implement the \verbatiminput LaTeX macro; this contains more magic than
Fred Drake <fdrake@acm.org>
parents: 17778
diff changeset
1906 local($_) = @_;
e328218546b5 Implement the \verbatiminput LaTeX macro; this contains more magic than
Fred Drake <fdrake@acm.org>
parents: 17778
diff changeset
1907 my $fname = next_argument();
e328218546b5 Implement the \verbatiminput LaTeX macro; this contains more magic than
Fred Drake <fdrake@acm.org>
parents: 17778
diff changeset
1908 my $file;
e328218546b5 Implement the \verbatiminput LaTeX macro; this contains more magic than
Fred Drake <fdrake@acm.org>
parents: 17778
diff changeset
1909 my $found = 0;
e328218546b5 Implement the \verbatiminput LaTeX macro; this contains more magic than
Fred Drake <fdrake@acm.org>
parents: 17778
diff changeset
1910 my $texpath;
e328218546b5 Implement the \verbatiminput LaTeX macro; this contains more magic than
Fred Drake <fdrake@acm.org>
parents: 17778
diff changeset
1911 # Search TEXINPUTS for the input file, the way we're supposed to:
e328218546b5 Implement the \verbatiminput LaTeX macro; this contains more magic than
Fred Drake <fdrake@acm.org>
parents: 17778
diff changeset
1912 foreach $texpath (split /$envkey/, $TEXINPUTS) {
e328218546b5 Implement the \verbatiminput LaTeX macro; this contains more magic than
Fred Drake <fdrake@acm.org>
parents: 17778
diff changeset
1913 $file = "$texpath$dd$fname";
e328218546b5 Implement the \verbatiminput LaTeX macro; this contains more magic than
Fred Drake <fdrake@acm.org>
parents: 17778
diff changeset
1914 last if ($found = (-f $file));
e328218546b5 Implement the \verbatiminput LaTeX macro; this contains more magic than
Fred Drake <fdrake@acm.org>
parents: 17778
diff changeset
1915 }
18426
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
1916 my $srcname;
18127
e328218546b5 Implement the \verbatiminput LaTeX macro; this contains more magic than
Fred Drake <fdrake@acm.org>
parents: 17778
diff changeset
1917 my $text;
e328218546b5 Implement the \verbatiminput LaTeX macro; this contains more magic than
Fred Drake <fdrake@acm.org>
parents: 17778
diff changeset
1918 if ($found) {
e328218546b5 Implement the \verbatiminput LaTeX macro; this contains more magic than
Fred Drake <fdrake@acm.org>
parents: 17778
diff changeset
1919 open(MYFILE, "<$file") || die "\n$!\n";
e328218546b5 Implement the \verbatiminput LaTeX macro; this contains more magic than
Fred Drake <fdrake@acm.org>
parents: 17778
diff changeset
1920 read(MYFILE, $text, 1024*1024);
e328218546b5 Implement the \verbatiminput LaTeX macro; this contains more magic than
Fred Drake <fdrake@acm.org>
parents: 17778
diff changeset
1921 close(MYFILE);
18426
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
1922 use File::Basename;
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
1923 my $srcdir, $srcext;
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
1924 ($srcname, $srcdir, $srcext) = fileparse($file, '\..*');
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
1925 open(MYFILE, ">$srcname.txt");
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
1926 print MYFILE $text;
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
1927 close(MYFILE);
18127
e328218546b5 Implement the \verbatiminput LaTeX macro; this contains more magic than
Fred Drake <fdrake@acm.org>
parents: 17778
diff changeset
1928 #
e328218546b5 Implement the \verbatiminput LaTeX macro; this contains more magic than
Fred Drake <fdrake@acm.org>
parents: 17778
diff changeset
1929 # These rewrites convert the raw text to something that will
e328218546b5 Implement the \verbatiminput LaTeX macro; this contains more magic than
Fred Drake <fdrake@acm.org>
parents: 17778
diff changeset
1930 # be properly visible as HTML and also will pass through the
e328218546b5 Implement the \verbatiminput LaTeX macro; this contains more magic than
Fred Drake <fdrake@acm.org>
parents: 17778
diff changeset
1931 # vagaries of conversion through LaTeX2HTML. The order in
e328218546b5 Implement the \verbatiminput LaTeX macro; this contains more magic than
Fred Drake <fdrake@acm.org>
parents: 17778
diff changeset
1932 # which the specific rewrites are performed is significant.
e328218546b5 Implement the \verbatiminput LaTeX macro; this contains more magic than
Fred Drake <fdrake@acm.org>
parents: 17778
diff changeset
1933 #
e328218546b5 Implement the \verbatiminput LaTeX macro; this contains more magic than
Fred Drake <fdrake@acm.org>
parents: 17778
diff changeset
1934 $text =~ s/\&/\&amp;/g;
e328218546b5 Implement the \verbatiminput LaTeX macro; this contains more magic than
Fred Drake <fdrake@acm.org>
parents: 17778
diff changeset
1935 # These need to happen before the normal < and > re-writes,
e328218546b5 Implement the \verbatiminput LaTeX macro; this contains more magic than
Fred Drake <fdrake@acm.org>
parents: 17778
diff changeset
1936 # since we need to avoid LaTeX2HTML's attempt to perform
e328218546b5 Implement the \verbatiminput LaTeX macro; this contains more magic than
Fred Drake <fdrake@acm.org>
parents: 17778
diff changeset
1937 # ligature processing without regard to context (since it
e328218546b5 Implement the \verbatiminput LaTeX macro; this contains more magic than
Fred Drake <fdrake@acm.org>
parents: 17778
diff changeset
1938 # doesn't have font information).
e328218546b5 Implement the \verbatiminput LaTeX macro; this contains more magic than
Fred Drake <fdrake@acm.org>
parents: 17778
diff changeset
1939 $text =~ s/--/-&\#45;/g;
e328218546b5 Implement the \verbatiminput LaTeX macro; this contains more magic than
Fred Drake <fdrake@acm.org>
parents: 17778
diff changeset
1940 $text =~ s/<</\&lt;\&\#60;/g;
e328218546b5 Implement the \verbatiminput LaTeX macro; this contains more magic than
Fred Drake <fdrake@acm.org>
parents: 17778
diff changeset
1941 $text =~ s/>>/\&gt;\&\#62;/g;
e328218546b5 Implement the \verbatiminput LaTeX macro; this contains more magic than
Fred Drake <fdrake@acm.org>
parents: 17778
diff changeset
1942 # Just normal re-writes...
e328218546b5 Implement the \verbatiminput LaTeX macro; this contains more magic than
Fred Drake <fdrake@acm.org>
parents: 17778
diff changeset
1943 $text =~ s/</\&lt;/g;
e328218546b5 Implement the \verbatiminput LaTeX macro; this contains more magic than
Fred Drake <fdrake@acm.org>
parents: 17778
diff changeset
1944 $text =~ s/>/\&gt;/g;
e328218546b5 Implement the \verbatiminput LaTeX macro; this contains more magic than
Fred Drake <fdrake@acm.org>
parents: 17778
diff changeset
1945 # These last isn't needed for the HTML, but is needed to get
e328218546b5 Implement the \verbatiminput LaTeX macro; this contains more magic than
Fred Drake <fdrake@acm.org>
parents: 17778
diff changeset
1946 # past LaTeX2HTML processing TeX macros. We use &#92; instead
e328218546b5 Implement the \verbatiminput LaTeX macro; this contains more magic than
Fred Drake <fdrake@acm.org>
parents: 17778
diff changeset
1947 # of &sol; since many browsers don't support that.
e328218546b5 Implement the \verbatiminput LaTeX macro; this contains more magic than
Fred Drake <fdrake@acm.org>
parents: 17778
diff changeset
1948 $text =~ s/\\/\&\#92;/g;
e328218546b5 Implement the \verbatiminput LaTeX macro; this contains more magic than
Fred Drake <fdrake@acm.org>
parents: 17778
diff changeset
1949 }
e328218546b5 Implement the \verbatiminput LaTeX macro; this contains more magic than
Fred Drake <fdrake@acm.org>
parents: 17778
diff changeset
1950 else {
e328218546b5 Implement the \verbatiminput LaTeX macro; this contains more magic than
Fred Drake <fdrake@acm.org>
parents: 17778
diff changeset
1951 $text = '<b>Could not locate requested file <i>$fname</i>!</b>\n';
e328218546b5 Implement the \verbatiminput LaTeX macro; this contains more magic than
Fred Drake <fdrake@acm.org>
parents: 17778
diff changeset
1952 }
18426
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
1953 return ('<dl><dd><pre class="verbatim">'
18127
e328218546b5 Implement the \verbatiminput LaTeX macro; this contains more magic than
Fred Drake <fdrake@acm.org>
parents: 17778
diff changeset
1954 . $text
18426
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
1955 . "</pre>\n<div class=\"verbatiminput-footer\">\n"
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
1956 . "<a href=\"$srcname.txt\" type=\"text/plain\""
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
1957 . ">Download as text.</a>"
a83ff7739992 Add support for \ulink and hyperlink grammars.
Fred Drake <fdrake@acm.org>
parents: 18231
diff changeset
1958 . "\n</div>\n</dd></dl>"
18127
e328218546b5 Implement the \verbatiminput LaTeX macro; this contains more magic than
Fred Drake <fdrake@acm.org>
parents: 17778
diff changeset
1959 . $_);
e328218546b5 Implement the \verbatiminput LaTeX macro; this contains more magic than
Fred Drake <fdrake@acm.org>
parents: 17778
diff changeset
1960 }
17381
8a2dd97873f2 Add corresponding support for the alltt environment to the HTML generator.
Fred Drake <fdrake@acm.org>
parents: 17249
diff changeset
1961
7527
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1962 1; # This must be the last line