Mercurial > cpython-lru_cache-weakref

annotate Doc/perl/python.perl @ 20113:12a787fb71df legacy-trunk

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