Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 1 | #LaTeX2HTML Version 96.1 : dot.latex2html-init -*- perl -*- |
| 2 | # |
Fred Drake | 13210ed | 1998-03-17 06:28:05 +0000 | [diff] [blame] | 3 | # Significantly revised by Fred L. Drake, Jr. <fdrake@acm.org> for use |
| 4 | # with the Python documentation. |
| 5 | # |
| 6 | # New name to avoid distributing "dot" files with the Python documentation. |
| 7 | # |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 8 | |
Fred Drake | 41814bc | 1998-05-11 18:23:35 +0000 | [diff] [blame] | 9 | package Override; |
| 10 | |
| 11 | use Cwd qw(getcwd); |
| 12 | |
| 13 | |
| 14 | package main; |
| 15 | |
Fred Drake | 28e7b4c | 1998-10-20 18:14:20 +0000 | [diff] [blame] | 16 | $HTML_VERSION = 4.0; |
| 17 | |
Fred Drake | 6aa5d48 | 1998-08-11 03:14:50 +0000 | [diff] [blame] | 18 | $MAX_LINK_DEPTH = 2; |
Fred Drake | d757165 | 1998-04-23 20:06:24 +0000 | [diff] [blame] | 19 | $ADDRESS = ''; |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 20 | |
Fred Drake | e194beb | 1998-05-19 19:38:49 +0000 | [diff] [blame] | 21 | $NO_FOOTNODE = 1; |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 22 | $NUMBERED_FOOTNOTES = 1; |
| 23 | |
| 24 | # Python documentation uses section numbers to support references to match |
| 25 | # in the printed and online versions. |
| 26 | # |
| 27 | $SHOW_SECTION_NUMBERS = 1; |
| 28 | |
| 29 | $ICONSERVER = '../icons'; |
| 30 | |
Fred Drake | 6aa5d48 | 1998-08-11 03:14:50 +0000 | [diff] [blame] | 31 | # Control where the navigation bars should show up: |
| 32 | $TOP_NAVIGATION = 1; |
| 33 | $BOTTOM_NAVIGATION = 1; |
| 34 | $AUTO_NAVIGATION = 0; |
| 35 | |
Fred Drake | 0cb7620 | 1998-08-07 16:43:29 +0000 | [diff] [blame] | 36 | $BODYTEXT = 'bgcolor="#ffffff"'; |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 37 | $CHILDLINE = "\n<p><hr>\n"; |
| 38 | $VERBOSITY = 0; |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 39 | |
Fred Drake | 4d10b43 | 1998-08-07 20:51:58 +0000 | [diff] [blame] | 40 | # default # of columns for the indexes |
Fred Drake | aa3f9fb | 1998-08-07 19:52:37 +0000 | [diff] [blame] | 41 | $INDEX_COLUMNS = 2; |
Fred Drake | 4d10b43 | 1998-08-07 20:51:58 +0000 | [diff] [blame] | 42 | $MODULE_INDEX_COLUMNS = 5; |
Fred Drake | aa3f9fb | 1998-08-07 19:52:37 +0000 | [diff] [blame] | 43 | |
Fred Drake | c9f2c14 | 1998-03-11 12:08:21 +0000 | [diff] [blame] | 44 | |
Fred Drake | db34a1e | 1998-03-10 23:02:57 +0000 | [diff] [blame] | 45 | # A little painful, but lets us clean up the top level directory a little, |
| 46 | # and not be tied to the current directory (as far as I can tell). |
| 47 | # |
Fred Drake | c9f2c14 | 1998-03-11 12:08:21 +0000 | [diff] [blame] | 48 | use Cwd; |
| 49 | use File::Basename; |
| 50 | ($myname, $mydir, $myext) = fileparse(__FILE__, '\..*'); |
| 51 | chop $mydir; # remove trailing '/' |
| 52 | $mydir = getcwd() . "$dd$mydir" |
| 53 | unless $mydir =~ s|^/|/|; |
Fred Drake | db34a1e | 1998-03-10 23:02:57 +0000 | [diff] [blame] | 54 | $LATEX2HTMLSTYLES = "$mydir$envkey$LATEX2HTMLSTYLES"; |
Fred Drake | b3a3ed8 | 1998-07-24 22:17:34 +0000 | [diff] [blame] | 55 | push (@INC, $mydir); |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 56 | |
Fred Drake | 235e6b1 | 1998-03-27 05:19:43 +0000 | [diff] [blame] | 57 | ($myrootname, $myrootdir, $myext) = fileparse($mydir, '\..*'); |
| 58 | chop $myrootdir; |
| 59 | |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 60 | |
Fred Drake | a4565b0 | 1998-05-15 17:14:17 +0000 | [diff] [blame] | 61 | # Hackish way to get the appropriate paper-*/ directory into $TEXINPUTS; |
| 62 | # pass in the paper size (a4 or letter) as the environment variable PAPER |
| 63 | # to add the right directory. If not given, the current directory is |
| 64 | # added instead for use with HOWTO processing. |
| 65 | # |
| 66 | if (defined $ENV{'PAPER'}) { |
| 67 | $mytexinputs = "$myrootdir${dd}paper-$ENV{'PAPER'}$envkey"; |
| 68 | } |
| 69 | else { |
| 70 | $mytexinputs = getcwd() . $envkey; |
| 71 | } |
| 72 | $mytexinputs .= "$myrootdir${dd}texinputs"; |
| 73 | |
| 74 | |
| 75 | sub custom_driver_hook{ |
| 76 | # |
| 77 | # This adds the directory of the main input file to $TEXINPUTS; it |
| 78 | # seems to be sufficiently general that it should be fine for HOWTO |
| 79 | # processing. |
| 80 | # |
| 81 | my $file = @_[0]; |
| 82 | my($jobname,$dir,$ext) = fileparse($file, '\..*'); |
| 83 | $dir = make_directory_absolute($dir); |
| 84 | $dir =~ s/$dd$//; |
| 85 | $TEXINPUTS = "$dir$envkey$mytexinputs"; |
| 86 | print "\nadding $dir to \$TEXINPUTS\n"; |
| 87 | } |
| 88 | |
| 89 | |
Fred Drake | 062bc6e | 1998-08-13 22:03:46 +0000 | [diff] [blame] | 90 | sub set_icon_size{ |
| 91 | my($name, $w, $h) = @_; |
| 92 | $iconsizes{$name} = "width=$w height=$h"; |
| 93 | } |
| 94 | |
Fred Drake | 95474f9 | 1999-02-09 18:45:50 +0000 | [diff] [blame] | 95 | foreach $name (split(/ /, 'up next previous contents index modules blank')) { |
Fred Drake | 062bc6e | 1998-08-13 22:03:46 +0000 | [diff] [blame] | 96 | set_icon_size($name, 32, 32); |
| 97 | } |
| 98 | # The '_motif' is really annoying, and makes the HTML larger with no value |
| 99 | # added, so strip it off: |
| 100 | foreach $name (keys %icons) { |
| 101 | my $icon = $icons{$name}; |
Fred Drake | 95474f9 | 1999-02-09 18:45:50 +0000 | [diff] [blame] | 102 | # Strip off the wasteful '_motif': |
Fred Drake | 062bc6e | 1998-08-13 22:03:46 +0000 | [diff] [blame] | 103 | $icon =~ s/_motif//; |
Fred Drake | 95474f9 | 1999-02-09 18:45:50 +0000 | [diff] [blame] | 104 | # Change the greyed-out icons to be blank: |
| 105 | $icon =~ s/[a-z]*_gr/blank/; |
Fred Drake | 062bc6e | 1998-08-13 22:03:46 +0000 | [diff] [blame] | 106 | $icons{$name} = $icon; |
| 107 | } |
Fred Drake | 95474f9 | 1999-02-09 18:45:50 +0000 | [diff] [blame] | 108 | $icons{'blank'} = 'blank.' . $IMAGE_TYPE; |
Fred Drake | 9f7adc4 | 1998-08-11 19:33:38 +0000 | [diff] [blame] | 109 | |
Fred Drake | 6aa5d48 | 1998-08-11 03:14:50 +0000 | [diff] [blame] | 110 | $CUSTOM_BUTTONS = ''; |
Fred Drake | 95474f9 | 1999-02-09 18:45:50 +0000 | [diff] [blame] | 111 | $BLANK_ICON = "\n<td>" . img_tag('blank.' . $IMAGE_TYPE) . "</td>"; |
Fred Drake | 6aa5d48 | 1998-08-11 03:14:50 +0000 | [diff] [blame] | 112 | |
Fred Drake | 13210ed | 1998-03-17 06:28:05 +0000 | [diff] [blame] | 113 | sub make_nav_panel{ |
Fred Drake | 95474f9 | 1999-02-09 18:45:50 +0000 | [diff] [blame] | 114 | ("<table width=\"100%\" cellpadding=0 cellspacing=0>\n<tr>" |
| 115 | . "\n<td>$NEXT</td>" |
| 116 | . "\n<td>$UP</td>" |
| 117 | . "\n<td>$PREVIOUS</td>" |
| 118 | . "\n<td align=center bgcolor=\"#99CCFF\" width=\"100%\">" |
| 119 | . "\n <b>$t_title</b></td>" |
| 120 | . ($CONTENTS ? "\n<td>$CONTENTS</td>" : $BLANK_ICON) |
| 121 | . "\n<td>$CUSTOM_BUTTONS</td>" # module index |
| 122 | . ($INDEX ? "\n<td>$INDEX</td>" : $BLANK_ICON) |
| 123 | . "\n</tr></table><hr>\n" |
Fred Drake | 062bc6e | 1998-08-13 22:03:46 +0000 | [diff] [blame] | 124 | . ($NEXT_TITLE ? "<b>Next:</b> $NEXT_TITLE\n" : '') |
| 125 | . ($UP_TITLE ? "<b>Up:</b> $UP_TITLE\n" : '') |
| 126 | . ($PREVIOUS_TITLE ? "<b>Previous:</b> $PREVIOUS_TITLE\n" : '')); |
Fred Drake | 13210ed | 1998-03-17 06:28:05 +0000 | [diff] [blame] | 127 | } |
| 128 | |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 129 | sub top_navigation_panel { |
Fred Drake | 13210ed | 1998-03-17 06:28:05 +0000 | [diff] [blame] | 130 | "<div class=navigation>\n" |
Fred Drake | 64bdc24 | 1998-04-17 02:14:12 +0000 | [diff] [blame] | 131 | . make_nav_panel() |
| 132 | . '<br><hr><p></div>'; |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 133 | } |
| 134 | |
| 135 | sub bot_navigation_panel { |
Fred Drake | 9d4b6c5 | 1998-04-11 05:21:14 +0000 | [diff] [blame] | 136 | "<p>\n<div class=navigation><hr>" |
Fred Drake | 64bdc24 | 1998-04-17 02:14:12 +0000 | [diff] [blame] | 137 | . make_nav_panel() |
| 138 | . '</div>'; |
| 139 | } |
| 140 | |
| 141 | sub add_link { |
| 142 | # Returns a pair (iconic link, textual link) |
| 143 | my($icon, $current_file, @link) = @_; |
| 144 | my($dummy, $file, $title) = split($delim, |
Fred Drake | 28e7b4c | 1998-10-20 18:14:20 +0000 | [diff] [blame] | 145 | $section_info{join(' ',@link)}); |
Fred Drake | 64bdc24 | 1998-04-17 02:14:12 +0000 | [diff] [blame] | 146 | if ($title && ($file ne $current_file)) { |
| 147 | $title = purify($title); |
| 148 | $title = get_first_words($title, $WORDS_IN_NAVIGATION_PANEL_TITLES); |
| 149 | return (make_href($file, $icon), make_href($file, "$title")) |
| 150 | } |
| 151 | elsif ($icon eq $up_visible_mark && $EXTERNAL_UP_LINK) { |
| 152 | return (make_href($EXTERNAL_UP_LINK, $icon), |
| 153 | make_href($EXTERNAL_UP_LINK, "$EXTERNAL_UP_TITLE")) |
| 154 | } |
| 155 | elsif (($icon eq $previous_visible_mark |
| 156 | || $icon eq $previous_page_visible_mark) |
| 157 | && $EXTERNAL_PREV_LINK && $EXTERNAL_PREV_TITLE) { |
| 158 | return (make_href($EXTERNAL_PREV_LINK, $icon), |
| 159 | make_href($EXTERNAL_PREV_LINK, "$EXTERNAL_PREV_TITLE")) |
| 160 | } |
| 161 | elsif (($icon eq $next_visible_mark |
| 162 | || $icon eq $next_page_visible_mark) |
| 163 | && $EXTERNAL_DOWN_LINK && $EXTERNAL_DOWN_TITLE) { |
| 164 | return (make_href($EXTERNAL_DOWN_LINK, $icon), |
| 165 | make_href($EXTERNAL_DOWN_LINK, "$EXTERNAL_DOWN_TITLE")) |
| 166 | } |
| 167 | (&inactive_img($icon), ""); |
| 168 | } |
| 169 | |
| 170 | sub add_special_link { |
| 171 | my($icon, $file, $current_file) = @_; |
| 172 | (($file && ($file ne $current_file)) ? make_href($file, $icon) : undef) |
| 173 | } |
| 174 | |
| 175 | sub img_tag { |
| 176 | local($icon) = @_; |
| 177 | my $alt; |
| 178 | my $align = " align=bottom "; |
| 179 | |
Fred Drake | 062bc6e | 1998-08-13 22:03:46 +0000 | [diff] [blame] | 180 | # having this list hardcoded here is really bogus.... |
Fred Drake | 64bdc24 | 1998-04-17 02:14:12 +0000 | [diff] [blame] | 181 | $alt = join('|', 'up', 'next_group', 'previous_group' |
| 182 | , 'next', 'previous', 'change_begin_right', 'change_begin' |
| 183 | , 'change_end_right', 'change_end', 'change_delete_right' |
Fred Drake | 95474f9 | 1999-02-09 18:45:50 +0000 | [diff] [blame] | 184 | , 'change_delete', 'contents', 'index', 'modules', 'blank'); |
Fred Drake | 64bdc24 | 1998-04-17 02:14:12 +0000 | [diff] [blame] | 185 | |
| 186 | if ($icon =~ /(gif|png)$/) { |
| 187 | $used_icons{$icon} = 1; |
| 188 | if ($icon =~ /change_(begin|end|delete)_right/) { $align = ' ' }; |
| 189 | my $nav_border = "$NAV_BORDER"; |
| 190 | if ($icon =~ /($alt)/) { |
| 191 | $alt = $1; |
| 192 | } |
| 193 | else { |
| 194 | $nav_border = '1'; |
| 195 | $alt = '[*]'; |
| 196 | }; |
| 197 | if ($LOCAL_ICONS) { |
| 198 | return join('', '<img ', $iconsizes{$1}, $align |
| 199 | ,'border=', $nav_border, ' alt="', $alt |
| 200 | ,'" src="', $icon, '">' ); |
| 201 | } |
| 202 | return join('', '<img ', $iconsizes{$1}, $align |
Fred Drake | a0e4b78 | 1998-08-14 15:03:48 +0000 | [diff] [blame] | 203 | ,'border=', $nav_border, ' alt="', $alt, "\"\n" |
Fred Drake | 64bdc24 | 1998-04-17 02:14:12 +0000 | [diff] [blame] | 204 | ,' src="', $ICONSERVER, "/$icon", '">' ); |
| 205 | } |
| 206 | else { |
| 207 | return $icon; |
| 208 | } |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 209 | } |
| 210 | |
| 211 | |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 212 | sub gen_index_id { |
| 213 | # this is used to ensure common index key generation and a stable sort |
Fred Drake | 235e6b1 | 1998-03-27 05:19:43 +0000 | [diff] [blame] | 214 | my($str,$extra) = @_; |
Fred Drake | 64bdc24 | 1998-04-17 02:14:12 +0000 | [diff] [blame] | 215 | sprintf('%s###%s%010d', $str, $extra, ++$global{'max_id'}); |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 216 | } |
| 217 | |
Fred Drake | 13210ed | 1998-03-17 06:28:05 +0000 | [diff] [blame] | 218 | sub make_index_entry { |
Fred Drake | 1191692 | 1998-04-02 22:30:57 +0000 | [diff] [blame] | 219 | my($br_id,$str) = @_; |
Fred Drake | 13210ed | 1998-03-17 06:28:05 +0000 | [diff] [blame] | 220 | # If TITLE is not yet available (i.e the \index command is in the title of the |
| 221 | # current section), use $ref_before. |
| 222 | $TITLE = $ref_before unless $TITLE; |
| 223 | # Save the reference |
| 224 | $str = gen_index_id($str, ''); |
Fred Drake | 64bdc24 | 1998-04-17 02:14:12 +0000 | [diff] [blame] | 225 | $index{$str} .= make_half_href("$CURRENT_FILE#$br_id"); |
Fred Drake | 13210ed | 1998-03-17 06:28:05 +0000 | [diff] [blame] | 226 | "<a name=\"$br_id\">$anchor_invisible_mark<\/a>"; |
| 227 | } |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 228 | |
Fred Drake | 64bdc24 | 1998-04-17 02:14:12 +0000 | [diff] [blame] | 229 | |
| 230 | sub insert_index{ |
Fred Drake | 4d10b43 | 1998-08-07 20:51:58 +0000 | [diff] [blame] | 231 | my($mark,$datafile,$columns,$letters) = @_; |
| 232 | my $prog = "$myrootdir/tools/buildindex.py"; |
| 233 | my $index; |
| 234 | if ($letters) { |
| 235 | $index = `$prog --columns $columns --letters $datafile`; |
| 236 | } |
| 237 | else { |
| 238 | $index = `$prog --columns $columns $datafile`; |
| 239 | } |
Fred Drake | 64bdc24 | 1998-04-17 02:14:12 +0000 | [diff] [blame] | 240 | s/$mark/$index/; |
| 241 | } |
| 242 | |
Fred Drake | 235e6b1 | 1998-03-27 05:19:43 +0000 | [diff] [blame] | 243 | sub add_idx{ |
Fred Drake | 9bbdce5 | 1999-01-19 16:30:10 +0000 | [diff] [blame] | 244 | print "\nBuilding HTML for the index ..."; |
Fred Drake | 235e6b1 | 1998-03-27 05:19:43 +0000 | [diff] [blame] | 245 | close(IDXFILE); |
Fred Drake | 4d10b43 | 1998-08-07 20:51:58 +0000 | [diff] [blame] | 246 | insert_index($idx_mark, 'index.dat', $INDEX_COLUMNS, 1); |
Fred Drake | 13210ed | 1998-03-17 06:28:05 +0000 | [diff] [blame] | 247 | } |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 248 | |
| 249 | |
| 250 | $idx_module_mark = '<tex2html_idx_module_mark>'; |
| 251 | $idx_module_title = 'Module Index'; |
| 252 | |
Fred Drake | 13210ed | 1998-03-17 06:28:05 +0000 | [diff] [blame] | 253 | sub add_module_idx{ |
Fred Drake | 9bbdce5 | 1999-01-19 16:30:10 +0000 | [diff] [blame] | 254 | print "\nBuilding HTML for the module index ..."; |
Fred Drake | 235e6b1 | 1998-03-27 05:19:43 +0000 | [diff] [blame] | 255 | my $key; |
Fred Drake | 64bdc24 | 1998-04-17 02:14:12 +0000 | [diff] [blame] | 256 | open(MODIDXFILE, '>modindex.dat') || die "\n$!\n"; |
Fred Drake | 235e6b1 | 1998-03-27 05:19:43 +0000 | [diff] [blame] | 257 | foreach $key (keys %Modules) { |
| 258 | # dump the line in the data file; just use a dummy seqno field |
Fred Drake | 9d4b6c5 | 1998-04-11 05:21:14 +0000 | [diff] [blame] | 259 | print MODIDXFILE "$Modules{$key}" . $IDXFILE_FIELD_SEP . "$key###\n"; |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 260 | } |
Fred Drake | 235e6b1 | 1998-03-27 05:19:43 +0000 | [diff] [blame] | 261 | close(MODIDXFILE); |
Fred Drake | 4d10b43 | 1998-08-07 20:51:58 +0000 | [diff] [blame] | 262 | insert_index($idx_module_mark, 'modindex.dat', $MODULE_INDEX_COLUMNS, 0); |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 263 | } |
| 264 | |
Fred Drake | 235e6b1 | 1998-03-27 05:19:43 +0000 | [diff] [blame] | 265 | # replace both indexes as needed: |
| 266 | sub add_idx_hook{ |
Fred Drake | b3a3ed8 | 1998-07-24 22:17:34 +0000 | [diff] [blame] | 267 | add_idx() if (/$idx_mark/); |
| 268 | add_module_idx() if (/$idx_module_mark/); |
| 269 | process_all_localmoduletables(); |
Fred Drake | 235e6b1 | 1998-03-27 05:19:43 +0000 | [diff] [blame] | 270 | } |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 271 | |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 272 | |
| 273 | # In addition to the standard stuff, add label to allow named node files. |
| 274 | sub do_cmd_tableofcontents { |
| 275 | local($_) = @_; |
| 276 | $TITLE = $toc_title; |
| 277 | $tocfile = $CURRENT_FILE; |
Fred Drake | 64bdc24 | 1998-04-17 02:14:12 +0000 | [diff] [blame] | 278 | my($closures,$reopens) = preserve_open_tags(); |
| 279 | anchor_label('contents', $CURRENT_FILE, $_); # this is added |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 280 | join('', "<BR>\n", $closures |
Fred Drake | 64bdc24 | 1998-04-17 02:14:12 +0000 | [diff] [blame] | 281 | , make_section_heading($toc_title, 'H2'), $toc_mark |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 282 | , $reopens, $_); |
| 283 | } |
| 284 | # In addition to the standard stuff, add label to allow named node files. |
| 285 | sub do_cmd_listoffigures { |
| 286 | local($_) = @_; |
| 287 | $TITLE = $lof_title; |
| 288 | $loffile = $CURRENT_FILE; |
Fred Drake | 64bdc24 | 1998-04-17 02:14:12 +0000 | [diff] [blame] | 289 | my($closures,$reopens) = preserve_open_tags(); |
| 290 | anchor_label('lof', $CURRENT_FILE, $_); # this is added |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 291 | join('', "<BR>\n", $closures |
Fred Drake | 64bdc24 | 1998-04-17 02:14:12 +0000 | [diff] [blame] | 292 | , make_section_heading($lof_title, 'H2'), $lof_mark |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 293 | , $reopens, $_); |
| 294 | } |
| 295 | # In addition to the standard stuff, add label to allow named node files. |
| 296 | sub do_cmd_listoftables { |
| 297 | local($_) = @_; |
| 298 | $TITLE = $lot_title; |
| 299 | $lotfile = $CURRENT_FILE; |
Fred Drake | 64bdc24 | 1998-04-17 02:14:12 +0000 | [diff] [blame] | 300 | my($closures,$reopens) = preserve_open_tags(); |
| 301 | anchor_label('lot', $CURRENT_FILE, $_); # this is added |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 302 | join('', "<BR>\n", $closures |
Fred Drake | 64bdc24 | 1998-04-17 02:14:12 +0000 | [diff] [blame] | 303 | , make_section_heading($lot_title, 'H2'), $lot_mark |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 304 | , $reopens, $_); |
| 305 | } |
| 306 | # In addition to the standard stuff, add label to allow named node files. |
| 307 | sub do_cmd_textohtmlinfopage { |
| 308 | local($_) = @_; |
| 309 | if ($INFO) { # |
Fred Drake | 64bdc24 | 1998-04-17 02:14:12 +0000 | [diff] [blame] | 310 | anchor_label("about",$CURRENT_FILE,$_); # this is added |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 311 | } # |
Fred Drake | 15796f7 | 1998-11-30 19:25:47 +0000 | [diff] [blame] | 312 | my $the_version = ''; # and the rest is |
| 313 | if ($t_date) { # mostly ours |
| 314 | $the_version = ",\n$t_date"; |
| 315 | if ($PYTHON_VERSION) { |
| 316 | $the_version .= ", Release $PYTHON_VERSION"; |
| 317 | } |
| 318 | } |
| 319 | $_ = (($INFO == 1) |
| 320 | ? join('', $close_all |
| 321 | , "<strong>$t_title</strong>$the_version\n" |
| 322 | , `cat $myrootdir${dd}html${dd}about.dat` |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 323 | , $open_all, $_) |
Fred Drake | 15796f7 | 1998-11-30 19:25:47 +0000 | [diff] [blame] | 324 | : join('', $close_all, $INFO,"\n", $open_all, $_)); |
| 325 | $_; |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 326 | } |
| 327 | |
| 328 | # $idx_mark will be replaced with the real index at the end |
| 329 | sub do_cmd_textohtmlindex { |
| 330 | local($_) = @_; |
| 331 | $TITLE = $idx_title; |
| 332 | $idxfile = $CURRENT_FILE; |
Fred Drake | 235e6b1 | 1998-03-27 05:19:43 +0000 | [diff] [blame] | 333 | if (%index_labels) { make_index_labels(); } |
| 334 | if (($SHORT_INDEX) && (%index_segment)) { make_preindex(); } |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 335 | else { $preindex = ''; } |
Fred Drake | 235e6b1 | 1998-03-27 05:19:43 +0000 | [diff] [blame] | 336 | my $heading = make_section_heading($idx_title, 'h2') . $idx_mark; |
Fred Drake | 1191692 | 1998-04-02 22:30:57 +0000 | [diff] [blame] | 337 | my($pre,$post) = minimize_open_tags($heading); |
Fred Drake | 235e6b1 | 1998-03-27 05:19:43 +0000 | [diff] [blame] | 338 | anchor_label('genindex',$CURRENT_FILE,$_); # this is added |
| 339 | '<br>\n' . $pre . $_; |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 340 | } |
| 341 | |
| 342 | # $idx_module_mark will be replaced with the real index at the end |
| 343 | sub do_cmd_textohtmlmoduleindex { |
| 344 | local($_) = @_; |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 345 | $TITLE = $idx_module_title; |
Fred Drake | 64bdc24 | 1998-04-17 02:14:12 +0000 | [diff] [blame] | 346 | anchor_label("modindex",$CURRENT_FILE,$_); |
Fred Drake | 235e6b1 | 1998-03-27 05:19:43 +0000 | [diff] [blame] | 347 | '<p>' . make_section_heading($idx_module_title, "h2") |
| 348 | . $idx_module_mark . $_; |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 349 | } |
| 350 | |
| 351 | # The bibliography and the index should be treated as separate sections |
| 352 | # in their own HTML files. The \bibliography{} command acts as a sectioning command |
| 353 | # that has the desired effect. But when the bibliography is constructed |
| 354 | # manually using the thebibliography environment, or when using the |
| 355 | # theindex environment it is not possible to use the normal sectioning |
| 356 | # mechanism. This subroutine inserts a \bibliography{} or a dummy |
| 357 | # \textohtmlindex command just before the appropriate environments |
| 358 | # to force sectioning. |
| 359 | |
| 360 | # XXX This *assumes* that if there are two {theindex} environments, the |
| 361 | # first is the module index and the second is the standard index. This |
| 362 | # is sufficient for the current Python documentation, but that's about |
| 363 | # it. |
| 364 | |
| 365 | sub add_bbl_and_idx_dummy_commands { |
Fred Drake | 1191692 | 1998-04-02 22:30:57 +0000 | [diff] [blame] | 366 | my $id = $global{'max_id'}; |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 367 | |
| 368 | s/([\\]begin\s*$O\d+$C\s*thebibliography)/$bbl_cnt++; $1/eg; |
| 369 | s/([\\]begin\s*$O\d+$C\s*thebibliography)/$id++; "\\bibliography$O$id$C$O$id$C $1"/geo |
| 370 | #if ($bbl_cnt == 1) |
| 371 | ; |
| 372 | #} |
Fred Drake | 1191692 | 1998-04-02 22:30:57 +0000 | [diff] [blame] | 373 | #---------------------------------------------------------------------- |
| 374 | # (FLD) This was added |
| 375 | my(@parts) = split(/\\begin\s*$O\d+$C\s*theindex/); |
| 376 | if (scalar(@parts) == 3) { |
| 377 | # Be careful to re-write the string in place, since $_ is *not* |
| 378 | # returned explicity; *** nasty side-effect dependency! *** |
| 379 | print "\nadd_bbl_and_idx_dummy_commands ==> adding module index"; |
| 380 | my $rx = "([\\\\]begin\\s*$O\\d+$C\\s*theindex[\\s\\S]*)" |
| 381 | . "([\\\\]begin\\s*$O\\d+$C\\s*theindex)"; |
| 382 | s/$rx/\\textohtmlmoduleindex \1 \\textohtmlindex \2/o; |
Fred Drake | 6aa5d48 | 1998-08-11 03:14:50 +0000 | [diff] [blame] | 383 | # Add a button to the navigation areas: |
Fred Drake | 062bc6e | 1998-08-13 22:03:46 +0000 | [diff] [blame] | 384 | $CUSTOM_BUTTONS .= ("<a\n href=\"modindex.html\">" |
| 385 | . img_tag('modules.'.$IMAGE_TYPE) . "</a>"); |
Fred Drake | 1191692 | 1998-04-02 22:30:57 +0000 | [diff] [blame] | 386 | } |
| 387 | else { |
Fred Drake | 95474f9 | 1999-02-09 18:45:50 +0000 | [diff] [blame] | 388 | $CUSTOM_BUTTONS .= img_tag('blank.' . $IMAGE_TYPE); |
Fred Drake | 1191692 | 1998-04-02 22:30:57 +0000 | [diff] [blame] | 389 | $global{'max_id'} = $id; # not sure why.... |
| 390 | s/([\\]begin\s*$O\d+$C\s*theindex)/\\textohtmlindex $1/o; |
| 391 | s/[\\]printindex/\\textohtmlindex /o; |
| 392 | } |
| 393 | #---------------------------------------------------------------------- |
Fred Drake | 64bdc24 | 1998-04-17 02:14:12 +0000 | [diff] [blame] | 394 | lib_add_bbl_and_idx_dummy_commands() |
Fred Drake | 1191692 | 1998-04-02 22:30:57 +0000 | [diff] [blame] | 395 | if defined(&lib_add_bbl_and_idx_dummy_commands); |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 396 | } |
| 397 | |
| 398 | # The bibliographic references, the appendices, the lists of figures and tables |
| 399 | # etc. must appear in the contents table at the same level as the outermost |
| 400 | # sectioning command. This subroutine finds what is the outermost level and |
| 401 | # sets the above to the same level; |
| 402 | |
Fred Drake | 13210ed | 1998-03-17 06:28:05 +0000 | [diff] [blame] | 403 | sub set_depth_levels { |
| 404 | # Sets $outermost_level |
Fred Drake | 1191692 | 1998-04-02 22:30:57 +0000 | [diff] [blame] | 405 | my $level; |
Fred Drake | 13210ed | 1998-03-17 06:28:05 +0000 | [diff] [blame] | 406 | #RRM: do not alter user-set value for $MAX_SPLIT_DEPTH |
| 407 | foreach $level ("part", "chapter", "section", "subsection", |
| 408 | "subsubsection", "paragraph") { |
| 409 | last if (($outermost_level) = /\\($level)$delimiter_rx/); |
| 410 | } |
| 411 | $level = ($outermost_level ? $section_commands{$outermost_level} : |
| 412 | do {$outermost_level = 'section'; 3;}); |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 413 | |
Fred Drake | 13210ed | 1998-03-17 06:28:05 +0000 | [diff] [blame] | 414 | #RRM: but calculate value for $MAX_SPLIT_DEPTH when a $REL_DEPTH was given |
| 415 | if ($REL_DEPTH && $MAX_SPLIT_DEPTH) { |
| 416 | $MAX_SPLIT_DEPTH = $level + $MAX_SPLIT_DEPTH; |
| 417 | } elsif (!($MAX_SPLIT_DEPTH)) { $MAX_SPLIT_DEPTH = 1 }; |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 418 | |
Fred Drake | 64bdc24 | 1998-04-17 02:14:12 +0000 | [diff] [blame] | 419 | %unnumbered_section_commands = ('tableofcontents' => $level, |
| 420 | 'listoffigures' => $level, |
| 421 | 'listoftables' => $level, |
| 422 | 'bibliography' => $level, |
| 423 | 'textohtmlindex' => $level, |
| 424 | 'textohtmlmoduleindex' => $level); |
| 425 | $section_headings{'textohtmlmoduleindex'} = 'h1'; |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 426 | |
Fred Drake | 64bdc24 | 1998-04-17 02:14:12 +0000 | [diff] [blame] | 427 | %section_commands = (%unnumbered_section_commands, |
| 428 | %section_commands); |
Fred Drake | 1191692 | 1998-04-02 22:30:57 +0000 | [diff] [blame] | 429 | |
| 430 | make_sections_rx(); |
Fred Drake | 13210ed | 1998-03-17 06:28:05 +0000 | [diff] [blame] | 431 | } |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 432 | |
| 433 | |
| 434 | # Fix from Ross Moore for ']' in \item[...]; this can be removed once the next |
Fred Drake | 235e6b1 | 1998-03-27 05:19:43 +0000 | [diff] [blame] | 435 | # patch to LaTeX2HTML is released and tested ... if the patch gets included. |
| 436 | # Be very careful to keep this around, just in case things break again! |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 437 | # |
| 438 | sub protect_useritems { |
| 439 | local(*_) = @_; |
Fred Drake | 1191692 | 1998-04-02 22:30:57 +0000 | [diff] [blame] | 440 | local($preitems,$thisitem); |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 441 | while (/\\item\s*\[/) { |
Fred Drake | 1191692 | 1998-04-02 22:30:57 +0000 | [diff] [blame] | 442 | $preitems .= $`; |
| 443 | $_ = $'; |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 444 | $thisitem = $&.'<<'.++$global{'max_id'}.'>>'; |
| 445 | s/^(((($O|$OP)\d+($C|$CP)).*\3|<[^<>]*>|[^\]<]+)*)\]/$thisitem.=$1;''/e; |
Fred Drake | 1191692 | 1998-04-02 22:30:57 +0000 | [diff] [blame] | 446 | $preitems .= $thisitem . '<<' . $global{'max_id'} . '>>]'; |
| 447 | s/^]//; |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 448 | } |
| 449 | $_ = $preitems . $_; |
| 450 | } |
| 451 | |
Fred Drake | 1072e46 | 1998-04-12 02:16:34 +0000 | [diff] [blame] | 452 | # This changes the markup used for {verbatim} environments, and is the |
Fred Drake | 95474f9 | 1999-02-09 18:45:50 +0000 | [diff] [blame] | 453 | # best way I've found that ensures the <dl> goes on the outside of the |
Fred Drake | 1072e46 | 1998-04-12 02:16:34 +0000 | [diff] [blame] | 454 | # <pre>...</pre>. |
| 455 | # |
| 456 | # Note that this *must* be done in the init file, not the python.perl |
| 457 | # style support file. The %declarations must be set before initialize() |
| 458 | # is called in the main script. |
| 459 | # |
Fred Drake | 64bdc24 | 1998-04-17 02:14:12 +0000 | [diff] [blame] | 460 | %declarations = ('preform' => '<dl><dd><pre></pre></dl>', |
Fred Drake | 1072e46 | 1998-04-12 02:16:34 +0000 | [diff] [blame] | 461 | %declarations); |
| 462 | |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 463 | 1; # This must be the last line |