Fred Drake | 85d14c9 | 2000-07-31 17:53:45 +0000 | [diff] [blame] | 1 | # LaTeX2HTML support base for use with Python documentation. |
Fred Drake | 41814bc | 1998-05-11 18:23:35 +0000 | [diff] [blame] | 2 | |
| 3 | package main; |
| 4 | |
Fred Drake | 85d14c9 | 2000-07-31 17:53:45 +0000 | [diff] [blame] | 5 | use L2hos; |
| 6 | |
Fred Drake | 28e7b4c | 1998-10-20 18:14:20 +0000 | [diff] [blame] | 7 | $HTML_VERSION = 4.0; |
| 8 | |
Fred Drake | 6aa5d48 | 1998-08-11 03:14:50 +0000 | [diff] [blame] | 9 | $MAX_LINK_DEPTH = 2; |
Fred Drake | d757165 | 1998-04-23 20:06:24 +0000 | [diff] [blame] | 10 | $ADDRESS = ''; |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 11 | |
Fred Drake | e194beb | 1998-05-19 19:38:49 +0000 | [diff] [blame] | 12 | $NO_FOOTNODE = 1; |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 13 | $NUMBERED_FOOTNOTES = 1; |
| 14 | |
| 15 | # Python documentation uses section numbers to support references to match |
| 16 | # in the printed and online versions. |
| 17 | # |
| 18 | $SHOW_SECTION_NUMBERS = 1; |
| 19 | |
| 20 | $ICONSERVER = '../icons'; |
Fred Drake | f730fc3 | 2000-08-31 07:19:07 +0000 | [diff] [blame] | 21 | $IMAGE_TYPE = 'gif'; |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 22 | |
Fred Drake | 6aa5d48 | 1998-08-11 03:14:50 +0000 | [diff] [blame] | 23 | # Control where the navigation bars should show up: |
| 24 | $TOP_NAVIGATION = 1; |
| 25 | $BOTTOM_NAVIGATION = 1; |
| 26 | $AUTO_NAVIGATION = 0; |
| 27 | |
Fred Drake | 1681627 | 2000-09-16 20:40:44 +0000 | [diff] [blame] | 28 | $BODYTEXT = ''; |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 29 | $CHILDLINE = "\n<p><hr>\n"; |
| 30 | $VERBOSITY = 0; |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 31 | |
Fred Drake | 4d10b43 | 1998-08-07 20:51:58 +0000 | [diff] [blame] | 32 | # default # of columns for the indexes |
Fred Drake | aa3f9fb | 1998-08-07 19:52:37 +0000 | [diff] [blame] | 33 | $INDEX_COLUMNS = 2; |
Fred Drake | 2383f6d | 1999-03-02 16:00:37 +0000 | [diff] [blame] | 34 | $MODULE_INDEX_COLUMNS = 4; |
Fred Drake | aa3f9fb | 1998-08-07 19:52:37 +0000 | [diff] [blame] | 35 | |
Fred Drake | a219b41 | 2001-10-22 16:57:49 +0000 | [diff] [blame] | 36 | $HAVE_MODULE_INDEX = 0; |
| 37 | $HAVE_GENERAL_INDEX = 0; |
| 38 | $HAVE_TABLE_OF_CONTENTS = 0; |
| 39 | |
Fred Drake | e03e1fe | 2002-04-05 17:34:50 +0000 | [diff] [blame^] | 40 | $AESOP_META_TYPE = 'information'; |
| 41 | |
Fred Drake | c9f2c14 | 1998-03-11 12:08:21 +0000 | [diff] [blame] | 42 | |
Fred Drake | db34a1e | 1998-03-10 23:02:57 +0000 | [diff] [blame] | 43 | # A little painful, but lets us clean up the top level directory a little, |
Fred Drake | 85d14c9 | 2000-07-31 17:53:45 +0000 | [diff] [blame] | 44 | # and not be tied to the current directory (as far as I can tell). Testing |
| 45 | # an existing definition of $mydir is needed since it cannot be computed when |
| 46 | # run under mkhowto with recent versions of LaTeX2HTML, since this file is |
| 47 | # not read directly by LaTeX2HTML any more. mkhowto is required to prepend |
| 48 | # the required definition at the top of the actual input file. |
Fred Drake | db34a1e | 1998-03-10 23:02:57 +0000 | [diff] [blame] | 49 | # |
Fred Drake | 85d14c9 | 2000-07-31 17:53:45 +0000 | [diff] [blame] | 50 | if (!defined $mydir) { |
| 51 | use Cwd; |
| 52 | use File::Basename; |
| 53 | ($myname, $mydir, $myext) = fileparse(__FILE__, '\..*'); |
| 54 | chop $mydir; # remove trailing '/' |
| 55 | $mydir = getcwd() . "$dd$mydir" |
| 56 | unless $mydir =~ s|^/|/|; |
| 57 | } |
Fred Drake | db34a1e | 1998-03-10 23:02:57 +0000 | [diff] [blame] | 58 | $LATEX2HTMLSTYLES = "$mydir$envkey$LATEX2HTMLSTYLES"; |
Fred Drake | b3a3ed8 | 1998-07-24 22:17:34 +0000 | [diff] [blame] | 59 | push (@INC, $mydir); |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 60 | |
Fred Drake | 235e6b1 | 1998-03-27 05:19:43 +0000 | [diff] [blame] | 61 | ($myrootname, $myrootdir, $myext) = fileparse($mydir, '\..*'); |
| 62 | chop $myrootdir; |
| 63 | |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 64 | |
Fred Drake | a4565b0 | 1998-05-15 17:14:17 +0000 | [diff] [blame] | 65 | # Hackish way to get the appropriate paper-*/ directory into $TEXINPUTS; |
| 66 | # pass in the paper size (a4 or letter) as the environment variable PAPER |
| 67 | # to add the right directory. If not given, the current directory is |
| 68 | # added instead for use with HOWTO processing. |
| 69 | # |
| 70 | if (defined $ENV{'PAPER'}) { |
| 71 | $mytexinputs = "$myrootdir${dd}paper-$ENV{'PAPER'}$envkey"; |
| 72 | } |
| 73 | else { |
| 74 | $mytexinputs = getcwd() . $envkey; |
| 75 | } |
| 76 | $mytexinputs .= "$myrootdir${dd}texinputs"; |
| 77 | |
| 78 | |
Fred Drake | b35f2b7 | 1999-09-23 16:53:09 +0000 | [diff] [blame] | 79 | # Change this variable to change the text added in "About this document..."; |
| 80 | # this should be an absolute pathname to get it right. |
| 81 | # |
| 82 | $ABOUT_FILE = "$myrootdir${dd}html${dd}stdabout.dat"; |
| 83 | |
| 84 | |
Fred Drake | 85d14c9 | 2000-07-31 17:53:45 +0000 | [diff] [blame] | 85 | sub custom_driver_hook { |
Fred Drake | a4565b0 | 1998-05-15 17:14:17 +0000 | [diff] [blame] | 86 | # |
| 87 | # This adds the directory of the main input file to $TEXINPUTS; it |
| 88 | # seems to be sufficiently general that it should be fine for HOWTO |
| 89 | # processing. |
| 90 | # |
| 91 | my $file = @_[0]; |
Fred Drake | 85d14c9 | 2000-07-31 17:53:45 +0000 | [diff] [blame] | 92 | my($jobname, $dir, $ext) = fileparse($file, '\..*'); |
| 93 | $dir = L2hos->Make_directory_absolute($dir); |
Fred Drake | a4565b0 | 1998-05-15 17:14:17 +0000 | [diff] [blame] | 94 | $dir =~ s/$dd$//; |
| 95 | $TEXINPUTS = "$dir$envkey$mytexinputs"; |
Fred Drake | 85d14c9 | 2000-07-31 17:53:45 +0000 | [diff] [blame] | 96 | print "\nAdding $dir to \$TEXINPUTS\n"; |
Fred Drake | 191439a | 1999-09-22 19:50:51 +0000 | [diff] [blame] | 97 | } |
| 98 | |
Fred Drake | a4565b0 | 1998-05-15 17:14:17 +0000 | [diff] [blame] | 99 | |
Fred Drake | 85d14c9 | 2000-07-31 17:53:45 +0000 | [diff] [blame] | 100 | $CUSTOM_BUTTONS = ''; |
Fred Drake | 062bc6e | 1998-08-13 22:03:46 +0000 | [diff] [blame] | 101 | |
Fred Drake | 85d14c9 | 2000-07-31 17:53:45 +0000 | [diff] [blame] | 102 | sub make_nav_sectref { |
Fred Drake | beb27bf | 1999-02-16 17:22:32 +0000 | [diff] [blame] | 103 | my($label,$title) = @_; |
| 104 | if ($title) { |
Fred Drake | 02c7082 | 2000-09-19 15:36:19 +0000 | [diff] [blame] | 105 | if ($title =~ /\<[aA] /) { |
| 106 | $title =~ s/\<[aA] /<a class="sectref" /; |
| 107 | } |
| 108 | else { |
| 109 | $title = "<span class=\"sectref\">$title</span>"; |
| 110 | } |
| 111 | return "<b class=\"navlabel\">$label:</b> $title\n"; |
Fred Drake | beb27bf | 1999-02-16 17:22:32 +0000 | [diff] [blame] | 112 | } |
| 113 | return ''; |
| 114 | } |
| 115 | |
Fred Drake | d18722b | 2001-01-02 22:08:48 +0000 | [diff] [blame] | 116 | @my_icon_tags = (); |
| 117 | $my_icon_tags{'next'} = 'Next Page'; |
| 118 | $my_icon_tags{'next_page'} = 'Next Page'; |
| 119 | $my_icon_tags{'previous'} = 'Previous Page'; |
| 120 | $my_icon_tags{'previous_page'} = 'Previous Page'; |
| 121 | $my_icon_tags{'up'} = 'Up One Level'; |
| 122 | $my_icon_tags{'contents'} = 'Contents'; |
| 123 | $my_icon_tags{'index'} = 'Index'; |
| 124 | $my_icon_tags{'modules'} = 'Module Index'; |
| 125 | |
Fred Drake | b31d36c | 2001-01-04 15:16:01 +0000 | [diff] [blame] | 126 | @my_icon_names = (); |
| 127 | $my_icon_names{'previous_page'} = 'previous'; |
| 128 | $my_icon_names{'next_page'} = 'next'; |
| 129 | |
Fred Drake | d18722b | 2001-01-02 22:08:48 +0000 | [diff] [blame] | 130 | sub get_my_icon { |
| 131 | my $name = @_[0]; |
| 132 | my $text = $my_icon_tags{$name}; |
Fred Drake | b31d36c | 2001-01-04 15:16:01 +0000 | [diff] [blame] | 133 | if ($my_icon_names{$name}) { |
| 134 | $name = $my_icon_names{$name}; |
| 135 | } |
Fred Drake | d18722b | 2001-01-02 22:08:48 +0000 | [diff] [blame] | 136 | if ($text eq '') { |
| 137 | $name = 'blank'; |
| 138 | } |
Fred Drake | 85d14c9 | 2000-07-31 17:53:45 +0000 | [diff] [blame] | 139 | my $iconserver = ($ICONSERVER eq '.') ? '' : "$ICONSERVER/"; |
Fred Drake | d18722b | 2001-01-02 22:08:48 +0000 | [diff] [blame] | 140 | return "<img src=\"$iconserver$name.$IMAGE_TYPE\"\n border=\"0\"" |
Fred Drake | 85d14c9 | 2000-07-31 17:53:45 +0000 | [diff] [blame] | 141 | . " height=\"32\"\n alt=\"$text\" width=\"32\">"; |
| 142 | } |
| 143 | |
Fred Drake | 85d14c9 | 2000-07-31 17:53:45 +0000 | [diff] [blame] | 144 | sub use_my_icon { |
| 145 | my $s = @_[0]; |
Fred Drake | d18722b | 2001-01-02 22:08:48 +0000 | [diff] [blame] | 146 | if ($s =~ /\<tex2html_([a-z_]+)_visible_mark\>/) { |
| 147 | my $r = get_my_icon($1); |
| 148 | $s =~ s/\<tex2html_[a-z_]+_visible_mark\>/$r/; |
| 149 | } |
Fred Drake | a007544 | 1999-04-29 19:06:56 +0000 | [diff] [blame] | 150 | return $s; |
Fred Drake | 13210ed | 1998-03-17 06:28:05 +0000 | [diff] [blame] | 151 | } |
| 152 | |
Fred Drake | 85d14c9 | 2000-07-31 17:53:45 +0000 | [diff] [blame] | 153 | sub make_nav_panel { |
| 154 | my $s; |
Fred Drake | d18722b | 2001-01-02 22:08:48 +0000 | [diff] [blame] | 155 | my $BLANK_ICON = get_my_icon('blank'); |
Fred Drake | f730fc3 | 2000-08-31 07:19:07 +0000 | [diff] [blame] | 156 | $NEXT = $NEXT_TITLE ? use_my_icon("$NEXT") : $BLANK_ICON; |
| 157 | $UP = $UP_TITLE ? use_my_icon("$UP") : $BLANK_ICON; |
| 158 | $PREVIOUS = $PREVIOUS_TITLE ? use_my_icon("$PREVIOUS") : $BLANK_ICON; |
Fred Drake | 85d14c9 | 2000-07-31 17:53:45 +0000 | [diff] [blame] | 159 | $CONTENTS = use_my_icon("$CONTENTS"); |
| 160 | $INDEX = $INDEX ? use_my_icon("$INDEX") : $BLANK_ICON; |
| 161 | if (!$CUSTOM_BUTTONS) { |
| 162 | $CUSTOM_BUTTONS = $BLANK_ICON; |
| 163 | } |
| 164 | $s = ('<table align="center" width="100%" cellpadding="0" cellspacing="2">' |
| 165 | . "\n<tr>" |
| 166 | # left-hand side |
Fred Drake | 85d14c9 | 2000-07-31 17:53:45 +0000 | [diff] [blame] | 167 | . "\n<td>$PREVIOUS</td>" |
Fred Drake | 4640e13 | 2000-07-31 20:13:23 +0000 | [diff] [blame] | 168 | . "\n<td>$UP</td>" |
| 169 | . "\n<td>$NEXT</td>" |
Fred Drake | 85d14c9 | 2000-07-31 17:53:45 +0000 | [diff] [blame] | 170 | # title box |
Fred Drake | f730fc3 | 2000-08-31 07:19:07 +0000 | [diff] [blame] | 171 | . "\n<td align=\"center\" width=\"100%\">$t_title</td>" |
Fred Drake | 85d14c9 | 2000-07-31 17:53:45 +0000 | [diff] [blame] | 172 | # right-hand side |
| 173 | . "\n<td>$CONTENTS</td>" |
| 174 | . "\n<td>$CUSTOM_BUTTONS</td>" # module index |
| 175 | . "\n<td>$INDEX</td>" |
| 176 | . "\n</tr></table>\n" |
| 177 | # textual navigation |
Fred Drake | 4640e13 | 2000-07-31 20:13:23 +0000 | [diff] [blame] | 178 | . make_nav_sectref("Previous", $PREVIOUS_TITLE) |
Fred Drake | 85d14c9 | 2000-07-31 17:53:45 +0000 | [diff] [blame] | 179 | . make_nav_sectref("Up", $UP_TITLE) |
Fred Drake | 4640e13 | 2000-07-31 20:13:23 +0000 | [diff] [blame] | 180 | . make_nav_sectref("Next", $NEXT_TITLE) |
| 181 | ); |
Fred Drake | 85d14c9 | 2000-07-31 17:53:45 +0000 | [diff] [blame] | 182 | # remove these; they are unnecessary and cause errors from validation |
| 183 | $s =~ s/ NAME="tex2html\d+"\n */ /g; |
| 184 | return $s; |
| 185 | } |
| 186 | |
Fred Drake | fb6499f | 2001-10-26 14:16:23 +0000 | [diff] [blame] | 187 | sub add_child_links { |
| 188 | my $toc = add_real_child_links(@_); |
| 189 | $toc =~ s|\s*</[aA]>|</a>|g; |
| 190 | $toc =~ s/ NAME=\"tex2html\d+\"\s*href=/ href=/gi; |
| 191 | $toc =~ s|</UL>(\s*<BR>)?|</ul>|gi; |
| 192 | return $toc; |
| 193 | } |
| 194 | |
Fred Drake | 7497bd3 | 2000-10-25 16:18:10 +0000 | [diff] [blame] | 195 | sub get_version_text { |
| 196 | if ($PACKAGE_VERSION ne '' && $t_date) { |
| 197 | return ("<span class=\"release-info\">" |
Fred Drake | dce975c | 2001-06-20 21:31:36 +0000 | [diff] [blame] | 198 | . "Release $PACKAGE_VERSION$RELEASE_INFO," |
Fred Drake | 7497bd3 | 2000-10-25 16:18:10 +0000 | [diff] [blame] | 199 | . " documentation updated on $t_date.</span>"); |
| 200 | } |
| 201 | if ($PACKAGE_VERSION ne '') { |
| 202 | return ("<span class=\"release-info\">" |
Fred Drake | dce975c | 2001-06-20 21:31:36 +0000 | [diff] [blame] | 203 | . "Release $PACKAGE_VERSION$RELEASE_INFO.</span>"); |
Fred Drake | 7497bd3 | 2000-10-25 16:18:10 +0000 | [diff] [blame] | 204 | } |
| 205 | if ($t_date) { |
| 206 | return ("<span class=\"release-info\">Documentation released on " |
| 207 | . "$t_date.</span>"); |
| 208 | } |
| 209 | return ''; |
| 210 | } |
| 211 | |
Fred Drake | 85d14c9 | 2000-07-31 17:53:45 +0000 | [diff] [blame] | 212 | |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 213 | sub top_navigation_panel { |
Fred Drake | 7497bd3 | 2000-10-25 16:18:10 +0000 | [diff] [blame] | 214 | return "\n" |
| 215 | . make_nav_panel() |
| 216 | . "<br><hr>\n"; |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 217 | } |
| 218 | |
| 219 | sub bot_navigation_panel { |
Fred Drake | 7497bd3 | 2000-10-25 16:18:10 +0000 | [diff] [blame] | 220 | return "\n<p><hr>\n" |
| 221 | . make_nav_panel() |
| 222 | . "<hr>\n" |
| 223 | . get_version_text() |
| 224 | . "\n"; |
Fred Drake | 64bdc24 | 1998-04-17 02:14:12 +0000 | [diff] [blame] | 225 | } |
| 226 | |
| 227 | sub add_link { |
| 228 | # Returns a pair (iconic link, textual link) |
| 229 | my($icon, $current_file, @link) = @_; |
| 230 | my($dummy, $file, $title) = split($delim, |
Fred Drake | 28e7b4c | 1998-10-20 18:14:20 +0000 | [diff] [blame] | 231 | $section_info{join(' ',@link)}); |
Fred Drake | d18722b | 2001-01-02 22:08:48 +0000 | [diff] [blame] | 232 | if ($icon =~ /\<tex2html_([_a-z]+)_visible_mark\>/) { |
| 233 | my $r = get_my_icon($1); |
| 234 | $icon =~ s/\<tex2html_[_a-z]+_visible_mark\>/$r/; |
| 235 | } |
Fred Drake | 64bdc24 | 1998-04-17 02:14:12 +0000 | [diff] [blame] | 236 | if ($title && ($file ne $current_file)) { |
| 237 | $title = purify($title); |
| 238 | $title = get_first_words($title, $WORDS_IN_NAVIGATION_PANEL_TITLES); |
| 239 | return (make_href($file, $icon), make_href($file, "$title")) |
| 240 | } |
Fred Drake | d18722b | 2001-01-02 22:08:48 +0000 | [diff] [blame] | 241 | elsif ($icon eq get_my_icon('up') && $EXTERNAL_UP_LINK) { |
Fred Drake | 64bdc24 | 1998-04-17 02:14:12 +0000 | [diff] [blame] | 242 | return (make_href($EXTERNAL_UP_LINK, $icon), |
| 243 | make_href($EXTERNAL_UP_LINK, "$EXTERNAL_UP_TITLE")) |
| 244 | } |
Fred Drake | d18722b | 2001-01-02 22:08:48 +0000 | [diff] [blame] | 245 | elsif ($icon eq get_my_icon('previous') |
Fred Drake | 64bdc24 | 1998-04-17 02:14:12 +0000 | [diff] [blame] | 246 | && $EXTERNAL_PREV_LINK && $EXTERNAL_PREV_TITLE) { |
| 247 | return (make_href($EXTERNAL_PREV_LINK, $icon), |
| 248 | make_href($EXTERNAL_PREV_LINK, "$EXTERNAL_PREV_TITLE")) |
| 249 | } |
Fred Drake | d18722b | 2001-01-02 22:08:48 +0000 | [diff] [blame] | 250 | elsif ($icon eq get_my_icon('next') |
Fred Drake | 64bdc24 | 1998-04-17 02:14:12 +0000 | [diff] [blame] | 251 | && $EXTERNAL_DOWN_LINK && $EXTERNAL_DOWN_TITLE) { |
| 252 | return (make_href($EXTERNAL_DOWN_LINK, $icon), |
| 253 | make_href($EXTERNAL_DOWN_LINK, "$EXTERNAL_DOWN_TITLE")) |
| 254 | } |
Fred Drake | 85d14c9 | 2000-07-31 17:53:45 +0000 | [diff] [blame] | 255 | return (&inactive_img($icon), ""); |
Fred Drake | 64bdc24 | 1998-04-17 02:14:12 +0000 | [diff] [blame] | 256 | } |
| 257 | |
| 258 | sub add_special_link { |
| 259 | my($icon, $file, $current_file) = @_; |
Fred Drake | d18722b | 2001-01-02 22:08:48 +0000 | [diff] [blame] | 260 | if ($icon =~ /\<tex2html_([_a-z]+)_visible_mark\>/) { |
| 261 | my $r = get_my_icon($1); |
| 262 | $icon =~ s/\<tex2html_[_a-z]+_visible_mark\>/$r/; |
| 263 | } |
Fred Drake | 85d14c9 | 2000-07-31 17:53:45 +0000 | [diff] [blame] | 264 | return (($file && ($file ne $current_file)) |
| 265 | ? make_href($file, $icon) |
| 266 | : undef) |
Fred Drake | 64bdc24 | 1998-04-17 02:14:12 +0000 | [diff] [blame] | 267 | } |
| 268 | |
Fred Drake | 85d14c9 | 2000-07-31 17:53:45 +0000 | [diff] [blame] | 269 | # The img_tag() function seems only to be called with the parameter |
| 270 | # 'anchor_invisible_mark', which we want to turn into ''. Since |
| 271 | # replace_icon_marks() is the only interesting caller, and all it really |
| 272 | # does is call img_tag(), we can just define the hook alternative to be |
| 273 | # a no-op instead. |
| 274 | # |
| 275 | sub replace_icons_hook {} |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 276 | |
Fred Drake | 50cdd97 | 1999-02-19 23:04:59 +0000 | [diff] [blame] | 277 | sub do_cmd_arabic { |
| 278 | # get rid of that nasty <SPAN CLASS="arabic">...</SPAN> |
Fred Drake | 85d14c9 | 2000-07-31 17:53:45 +0000 | [diff] [blame] | 279 | my($ctr, $val, $id, $text) = &read_counter_value(@_[0]); |
| 280 | return ($val ? farabic($val) : "0") . $text; |
Fred Drake | 50cdd97 | 1999-02-19 23:04:59 +0000 | [diff] [blame] | 281 | } |
| 282 | |
| 283 | |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 284 | sub gen_index_id { |
| 285 | # 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] | 286 | my($str,$extra) = @_; |
Fred Drake | 64bdc24 | 1998-04-17 02:14:12 +0000 | [diff] [blame] | 287 | sprintf('%s###%s%010d', $str, $extra, ++$global{'max_id'}); |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 288 | } |
| 289 | |
Fred Drake | 85d14c9 | 2000-07-31 17:53:45 +0000 | [diff] [blame] | 290 | sub insert_index { |
Fred Drake | 2383f6d | 1999-03-02 16:00:37 +0000 | [diff] [blame] | 291 | my($mark,$datafile,$columns,$letters,$prefix) = @_; |
Fred Drake | 4d10b43 | 1998-08-07 20:51:58 +0000 | [diff] [blame] | 292 | my $prog = "$myrootdir/tools/buildindex.py"; |
| 293 | my $index; |
| 294 | if ($letters) { |
| 295 | $index = `$prog --columns $columns --letters $datafile`; |
| 296 | } |
| 297 | else { |
| 298 | $index = `$prog --columns $columns $datafile`; |
| 299 | } |
Fred Drake | c568173 | 2000-09-12 20:13:04 +0000 | [diff] [blame] | 300 | if (!s/$mark/$prefix$index/) { |
| 301 | print "\nCould not locate index mark: $mark"; |
| 302 | } |
Fred Drake | 64bdc24 | 1998-04-17 02:14:12 +0000 | [diff] [blame] | 303 | } |
| 304 | |
Fred Drake | 85d14c9 | 2000-07-31 17:53:45 +0000 | [diff] [blame] | 305 | sub add_idx { |
Fred Drake | 9bbdce5 | 1999-01-19 16:30:10 +0000 | [diff] [blame] | 306 | print "\nBuilding HTML for the index ..."; |
Fred Drake | 235e6b1 | 1998-03-27 05:19:43 +0000 | [diff] [blame] | 307 | close(IDXFILE); |
Fred Drake | 2383f6d | 1999-03-02 16:00:37 +0000 | [diff] [blame] | 308 | insert_index($idx_mark, 'index.dat', $INDEX_COLUMNS, 1, ''); |
Fred Drake | 13210ed | 1998-03-17 06:28:05 +0000 | [diff] [blame] | 309 | } |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 310 | |
| 311 | |
| 312 | $idx_module_mark = '<tex2html_idx_module_mark>'; |
| 313 | $idx_module_title = 'Module Index'; |
| 314 | |
Fred Drake | 85d14c9 | 2000-07-31 17:53:45 +0000 | [diff] [blame] | 315 | sub add_module_idx { |
Fred Drake | 9bbdce5 | 1999-01-19 16:30:10 +0000 | [diff] [blame] | 316 | print "\nBuilding HTML for the module index ..."; |
Fred Drake | 235e6b1 | 1998-03-27 05:19:43 +0000 | [diff] [blame] | 317 | my $key; |
Fred Drake | 2383f6d | 1999-03-02 16:00:37 +0000 | [diff] [blame] | 318 | my $first = 1; |
| 319 | my $prevplat = ''; |
| 320 | my $allthesame = 1; |
| 321 | my $prefix = ''; |
| 322 | foreach $key (keys %Modules) { |
| 323 | $key =~ s/<tt>([a-zA-Z0-9._]*)<\/tt>/\1/; |
| 324 | my $plat = "$ModulePlatforms{$key}"; |
| 325 | $plat = '' |
Fred Drake | 62cc360 | 1999-03-04 18:41:17 +0000 | [diff] [blame] | 326 | if ($plat eq $IGNORE_PLATFORM_ANNOTATION); |
Fred Drake | 2383f6d | 1999-03-02 16:00:37 +0000 | [diff] [blame] | 327 | if (!$first) { |
| 328 | $allthesame = 0 |
| 329 | if ($prevplat ne $plat); |
| 330 | } |
| 331 | else { $first = 0; } |
| 332 | $prevplat = $plat; |
| 333 | } |
Fred Drake | 64bdc24 | 1998-04-17 02:14:12 +0000 | [diff] [blame] | 334 | open(MODIDXFILE, '>modindex.dat') || die "\n$!\n"; |
Fred Drake | 235e6b1 | 1998-03-27 05:19:43 +0000 | [diff] [blame] | 335 | foreach $key (keys %Modules) { |
| 336 | # dump the line in the data file; just use a dummy seqno field |
Fred Drake | 2383f6d | 1999-03-02 16:00:37 +0000 | [diff] [blame] | 337 | my $nkey = $1; |
| 338 | my $moditem = "$Modules{$key}"; |
| 339 | my $plat = ''; |
| 340 | $key =~ s/<tt>([a-zA-Z0-9._]*)<\/tt>/\1/; |
| 341 | if ($ModulePlatforms{$key} && !$allthesame) { |
Fred Drake | dce975c | 2001-06-20 21:31:36 +0000 | [diff] [blame] | 342 | $plat = (" <em>(<span class=\"platform\">$ModulePlatforms{$key}" |
Fred Drake | bb584d3 | 1999-03-25 22:18:30 +0000 | [diff] [blame] | 343 | . '</span>)</em>'); |
Fred Drake | 2383f6d | 1999-03-02 16:00:37 +0000 | [diff] [blame] | 344 | } |
Fred Drake | e15956b | 2000-04-03 04:51:13 +0000 | [diff] [blame] | 345 | print MODIDXFILE $moditem . $IDXFILE_FIELD_SEP |
Fred Drake | dce975c | 2001-06-20 21:31:36 +0000 | [diff] [blame] | 346 | . "<tt class=\"module\">$key</tt>$plat###\n"; |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 347 | } |
Fred Drake | 235e6b1 | 1998-03-27 05:19:43 +0000 | [diff] [blame] | 348 | close(MODIDXFILE); |
Fred Drake | 42181db | 2001-01-09 22:02:10 +0000 | [diff] [blame] | 349 | |
| 350 | if ($GLOBAL_MODULE_INDEX) { |
| 351 | $prefix = <<MODULE_INDEX_PREFIX; |
| 352 | |
| 353 | <p> This index only lists modules documented in this manual. |
| 354 | The <em class="citetitle"><a href="$GLOBAL_MODULE_INDEX">Global Module |
| 355 | Index</a></em> lists all modules that are documented in this set |
| 356 | of manuals.</p> |
| 357 | MODULE_INDEX_PREFIX |
| 358 | } |
Fred Drake | 2383f6d | 1999-03-02 16:00:37 +0000 | [diff] [blame] | 359 | if (!$allthesame) { |
Fred Drake | d18722b | 2001-01-02 22:08:48 +0000 | [diff] [blame] | 360 | $prefix .= <<PLAT_DISCUSS; |
Fred Drake | 2383f6d | 1999-03-02 16:00:37 +0000 | [diff] [blame] | 361 | |
| 362 | <p> Some module names are followed by an annotation indicating what |
| 363 | platform they are available on.</p> |
| 364 | |
| 365 | PLAT_DISCUSS |
| 366 | } |
| 367 | insert_index($idx_module_mark, 'modindex.dat', $MODULE_INDEX_COLUMNS, 0, |
| 368 | $prefix); |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 369 | } |
| 370 | |
Fred Drake | 235e6b1 | 1998-03-27 05:19:43 +0000 | [diff] [blame] | 371 | # replace both indexes as needed: |
Fred Drake | 85d14c9 | 2000-07-31 17:53:45 +0000 | [diff] [blame] | 372 | sub add_idx_hook { |
Fred Drake | b3a3ed8 | 1998-07-24 22:17:34 +0000 | [diff] [blame] | 373 | add_idx() if (/$idx_mark/); |
Fred Drake | 2383f6d | 1999-03-02 16:00:37 +0000 | [diff] [blame] | 374 | process_python_state(); |
Fred Drake | c568173 | 2000-09-12 20:13:04 +0000 | [diff] [blame] | 375 | if ($MODULE_INDEX_FILE) { |
| 376 | local ($_); |
| 377 | open(MYFILE, "<$MODULE_INDEX_FILE"); |
| 378 | sysread(MYFILE, $_, 1024*1024); |
| 379 | close(MYFILE); |
| 380 | add_module_idx(); |
| 381 | open(MYFILE,">$MODULE_INDEX_FILE"); |
| 382 | print MYFILE $_; |
| 383 | close(MYFILE); |
| 384 | } |
Fred Drake | 235e6b1 | 1998-03-27 05:19:43 +0000 | [diff] [blame] | 385 | } |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 386 | |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 387 | |
Fred Drake | 191439a | 1999-09-22 19:50:51 +0000 | [diff] [blame] | 388 | # In addition to the standard stuff, add label to allow named node files and |
| 389 | # support suppression of the page complete (for HTML Help use). |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 390 | sub do_cmd_tableofcontents { |
| 391 | local($_) = @_; |
| 392 | $TITLE = $toc_title; |
| 393 | $tocfile = $CURRENT_FILE; |
Fred Drake | 64bdc24 | 1998-04-17 02:14:12 +0000 | [diff] [blame] | 394 | my($closures,$reopens) = preserve_open_tags(); |
| 395 | anchor_label('contents', $CURRENT_FILE, $_); # this is added |
Fred Drake | beb27bf | 1999-02-16 17:22:32 +0000 | [diff] [blame] | 396 | join('', "<BR>\n\\tableofchildlinks[off]", $closures |
Fred Drake | 64bdc24 | 1998-04-17 02:14:12 +0000 | [diff] [blame] | 397 | , make_section_heading($toc_title, 'H2'), $toc_mark |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 398 | , $reopens, $_); |
| 399 | } |
| 400 | # In addition to the standard stuff, add label to allow named node files. |
| 401 | sub do_cmd_listoffigures { |
| 402 | local($_) = @_; |
| 403 | $TITLE = $lof_title; |
| 404 | $loffile = $CURRENT_FILE; |
Fred Drake | 64bdc24 | 1998-04-17 02:14:12 +0000 | [diff] [blame] | 405 | my($closures,$reopens) = preserve_open_tags(); |
| 406 | anchor_label('lof', $CURRENT_FILE, $_); # this is added |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 407 | join('', "<BR>\n", $closures |
Fred Drake | 64bdc24 | 1998-04-17 02:14:12 +0000 | [diff] [blame] | 408 | , make_section_heading($lof_title, 'H2'), $lof_mark |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 409 | , $reopens, $_); |
| 410 | } |
| 411 | # In addition to the standard stuff, add label to allow named node files. |
| 412 | sub do_cmd_listoftables { |
| 413 | local($_) = @_; |
| 414 | $TITLE = $lot_title; |
| 415 | $lotfile = $CURRENT_FILE; |
Fred Drake | 64bdc24 | 1998-04-17 02:14:12 +0000 | [diff] [blame] | 416 | my($closures,$reopens) = preserve_open_tags(); |
| 417 | anchor_label('lot', $CURRENT_FILE, $_); # this is added |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 418 | join('', "<BR>\n", $closures |
Fred Drake | 64bdc24 | 1998-04-17 02:14:12 +0000 | [diff] [blame] | 419 | , make_section_heading($lot_title, 'H2'), $lot_mark |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 420 | , $reopens, $_); |
| 421 | } |
| 422 | # In addition to the standard stuff, add label to allow named node files. |
| 423 | sub do_cmd_textohtmlinfopage { |
| 424 | local($_) = @_; |
| 425 | if ($INFO) { # |
Fred Drake | 64bdc24 | 1998-04-17 02:14:12 +0000 | [diff] [blame] | 426 | anchor_label("about",$CURRENT_FILE,$_); # this is added |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 427 | } # |
Fred Drake | 15796f7 | 1998-11-30 19:25:47 +0000 | [diff] [blame] | 428 | my $the_version = ''; # and the rest is |
| 429 | if ($t_date) { # mostly ours |
| 430 | $the_version = ",\n$t_date"; |
Fred Drake | 7497bd3 | 2000-10-25 16:18:10 +0000 | [diff] [blame] | 431 | if ($PACKAGE_VERSION) { |
Fred Drake | dce975c | 2001-06-20 21:31:36 +0000 | [diff] [blame] | 432 | $the_version .= ", Release $PACKAGE_VERSION$RELEASE_INFO"; |
Fred Drake | 15796f7 | 1998-11-30 19:25:47 +0000 | [diff] [blame] | 433 | } |
| 434 | } |
Fred Drake | 9443dc3 | 2001-08-10 20:12:09 +0000 | [diff] [blame] | 435 | my $about; |
| 436 | open(ABOUT, "<$ABOUT_FILE") || die "\n$!\n"; |
| 437 | sysread(ABOUT, $about, 1024*1024); |
| 438 | close(ABOUT); |
Fred Drake | 15796f7 | 1998-11-30 19:25:47 +0000 | [diff] [blame] | 439 | $_ = (($INFO == 1) |
Fred Drake | b35f2b7 | 1999-09-23 16:53:09 +0000 | [diff] [blame] | 440 | ? join('', |
| 441 | $close_all, |
| 442 | "<strong>$t_title</strong>$the_version\n", |
Fred Drake | 9443dc3 | 2001-08-10 20:12:09 +0000 | [diff] [blame] | 443 | $about, |
Fred Drake | b35f2b7 | 1999-09-23 16:53:09 +0000 | [diff] [blame] | 444 | $open_all, $_) |
| 445 | : join('', $close_all, $INFO,"\n", $open_all, $_)); |
Fred Drake | 15796f7 | 1998-11-30 19:25:47 +0000 | [diff] [blame] | 446 | $_; |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 447 | } |
| 448 | |
| 449 | # $idx_mark will be replaced with the real index at the end |
| 450 | sub do_cmd_textohtmlindex { |
| 451 | local($_) = @_; |
| 452 | $TITLE = $idx_title; |
| 453 | $idxfile = $CURRENT_FILE; |
Fred Drake | 235e6b1 | 1998-03-27 05:19:43 +0000 | [diff] [blame] | 454 | if (%index_labels) { make_index_labels(); } |
| 455 | if (($SHORT_INDEX) && (%index_segment)) { make_preindex(); } |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 456 | else { $preindex = ''; } |
Fred Drake | 235e6b1 | 1998-03-27 05:19:43 +0000 | [diff] [blame] | 457 | my $heading = make_section_heading($idx_title, 'h2') . $idx_mark; |
Fred Drake | 1191692 | 1998-04-02 22:30:57 +0000 | [diff] [blame] | 458 | my($pre,$post) = minimize_open_tags($heading); |
Fred Drake | 235e6b1 | 1998-03-27 05:19:43 +0000 | [diff] [blame] | 459 | anchor_label('genindex',$CURRENT_FILE,$_); # this is added |
Fred Drake | c568173 | 2000-09-12 20:13:04 +0000 | [diff] [blame] | 460 | return "<br>\n" . $pre . $_; |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 461 | } |
| 462 | |
Fred Drake | c568173 | 2000-09-12 20:13:04 +0000 | [diff] [blame] | 463 | $MODULE_INDEX_FILE = ''; |
| 464 | |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 465 | # $idx_module_mark will be replaced with the real index at the end |
| 466 | sub do_cmd_textohtmlmoduleindex { |
| 467 | local($_) = @_; |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 468 | $TITLE = $idx_module_title; |
Fred Drake | c568173 | 2000-09-12 20:13:04 +0000 | [diff] [blame] | 469 | anchor_label('modindex', $CURRENT_FILE, $_); |
| 470 | $MODULE_INDEX_FILE = "$CURRENT_FILE"; |
| 471 | $_ = ('<p>' . make_section_heading($idx_module_title, 'h2') |
| 472 | . $idx_module_mark . $_); |
| 473 | return $_; |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 474 | } |
| 475 | |
Fred Drake | c568173 | 2000-09-12 20:13:04 +0000 | [diff] [blame] | 476 | # The bibliography and the index should be treated as separate |
| 477 | # sections in their own HTML files. The \bibliography{} command acts |
| 478 | # as a sectioning command that has the desired effect. But when the |
| 479 | # bibliography is constructed manually using the thebibliography |
| 480 | # environment, or when using the theindex environment it is not |
| 481 | # possible to use the normal sectioning mechanism. This subroutine |
| 482 | # inserts a \bibliography{} or a dummy \textohtmlindex command just |
| 483 | # before the appropriate environments to force sectioning. |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 484 | |
Fred Drake | c568173 | 2000-09-12 20:13:04 +0000 | [diff] [blame] | 485 | # XXX This *assumes* that if there are two {theindex} environments, |
| 486 | # the first is the module index and the second is the standard |
| 487 | # index. This is sufficient for the current Python documentation, |
| 488 | # but that's about it. |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 489 | |
| 490 | sub add_bbl_and_idx_dummy_commands { |
Fred Drake | 1191692 | 1998-04-02 22:30:57 +0000 | [diff] [blame] | 491 | my $id = $global{'max_id'}; |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 492 | |
Fred Drake | a219b41 | 2001-10-22 16:57:49 +0000 | [diff] [blame] | 493 | if (/[\\]tableofcontents/) { |
| 494 | $HAVE_TABLE_OF_CONTENTS = 1; |
| 495 | } |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 496 | s/([\\]begin\s*$O\d+$C\s*thebibliography)/$bbl_cnt++; $1/eg; |
Fred Drake | 191439a | 1999-09-22 19:50:51 +0000 | [diff] [blame] | 497 | s/([\\]begin\s*$O\d+$C\s*thebibliography)/$id++; "\\bibliography$O$id$C$O$id$C $1"/geo; |
Fred Drake | 85d14c9 | 2000-07-31 17:53:45 +0000 | [diff] [blame] | 498 | my(@parts) = split(/\\begin\s*$O\d+$C\s*theindex/); |
| 499 | if (scalar(@parts) == 3) { |
| 500 | # Be careful to re-write the string in place, since $_ is *not* |
| 501 | # returned explicity; *** nasty side-effect dependency! *** |
Fred Drake | bb7775a | 2001-12-04 17:03:54 +0000 | [diff] [blame] | 502 | print "\nadd_bbl_and_idx_dummy_commands ==> adding general index"; |
Fred Drake | 85d14c9 | 2000-07-31 17:53:45 +0000 | [diff] [blame] | 503 | print "\nadd_bbl_and_idx_dummy_commands ==> adding module index"; |
| 504 | my $rx = "([\\\\]begin\\s*$O\\d+$C\\s*theindex[\\s\\S]*)" |
| 505 | . "([\\\\]begin\\s*$O\\d+$C\\s*theindex)"; |
| 506 | s/$rx/\\textohtmlmoduleindex \1 \\textohtmlindex \2/o; |
| 507 | # Add a button to the navigation areas: |
Fred Drake | aaa2385 | 2000-09-14 22:20:41 +0000 | [diff] [blame] | 508 | $CUSTOM_BUTTONS .= ('<a href="modindex.html" title="Module Index">' |
Fred Drake | d18722b | 2001-01-02 22:08:48 +0000 | [diff] [blame] | 509 | . get_my_icon('modules') |
Fred Drake | aaa2385 | 2000-09-14 22:20:41 +0000 | [diff] [blame] | 510 | . '</a>'); |
Fred Drake | a219b41 | 2001-10-22 16:57:49 +0000 | [diff] [blame] | 511 | $HAVE_MODULE_INDEX = 1; |
| 512 | $HAVE_GENERAL_INDEX = 1; |
| 513 | } |
| 514 | elsif (scalar(@parts) == 2) { |
Fred Drake | bb7775a | 2001-12-04 17:03:54 +0000 | [diff] [blame] | 515 | print "\nadd_bbl_and_idx_dummy_commands ==> adding general index"; |
| 516 | my $rx = "([\\\\]begin\\s*$O\\d+$C\\s*theindex)"; |
| 517 | s/$rx/\\textohtmlindex \1/o; |
Fred Drake | a219b41 | 2001-10-22 16:57:49 +0000 | [diff] [blame] | 518 | $HAVE_GENERAL_INDEX = 1; |
Fred Drake | 1191692 | 1998-04-02 22:30:57 +0000 | [diff] [blame] | 519 | } |
Fred Drake | bb7775a | 2001-12-04 17:03:54 +0000 | [diff] [blame] | 520 | elsif (scalar(@parts) == 1) { |
| 521 | print "\nadd_bbl_and_idx_dummy_commands ==> no index found"; |
Fred Drake | d18722b | 2001-01-02 22:08:48 +0000 | [diff] [blame] | 522 | $CUSTOM_BUTTONS .= get_my_icon('blank'); |
Fred Drake | 85d14c9 | 2000-07-31 17:53:45 +0000 | [diff] [blame] | 523 | $global{'max_id'} = $id; # not sure why.... |
| 524 | s/([\\]begin\s*$O\d+$C\s*theindex)/\\textohtmlindex $1/o; |
Fred Drake | 191439a | 1999-09-22 19:50:51 +0000 | [diff] [blame] | 525 | s/[\\]printindex/\\textohtmlindex /o; |
Fred Drake | bb7775a | 2001-12-04 17:03:54 +0000 | [diff] [blame] | 526 | } |
| 527 | else { |
| 528 | die "\n\nBad number of index environments!\n\n"; |
| 529 | } |
Fred Drake | 1191692 | 1998-04-02 22:30:57 +0000 | [diff] [blame] | 530 | #---------------------------------------------------------------------- |
Fred Drake | 64bdc24 | 1998-04-17 02:14:12 +0000 | [diff] [blame] | 531 | lib_add_bbl_and_idx_dummy_commands() |
Fred Drake | 1191692 | 1998-04-02 22:30:57 +0000 | [diff] [blame] | 532 | if defined(&lib_add_bbl_and_idx_dummy_commands); |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 533 | } |
| 534 | |
Fred Drake | c568173 | 2000-09-12 20:13:04 +0000 | [diff] [blame] | 535 | # The bibliographic references, the appendices, the lists of figures |
| 536 | # and tables etc. must appear in the contents table at the same level |
| 537 | # as the outermost sectioning command. This subroutine finds what is |
| 538 | # the outermost level and sets the above to the same level; |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 539 | |
Fred Drake | 13210ed | 1998-03-17 06:28:05 +0000 | [diff] [blame] | 540 | sub set_depth_levels { |
| 541 | # Sets $outermost_level |
Fred Drake | 1191692 | 1998-04-02 22:30:57 +0000 | [diff] [blame] | 542 | my $level; |
Fred Drake | 13210ed | 1998-03-17 06:28:05 +0000 | [diff] [blame] | 543 | #RRM: do not alter user-set value for $MAX_SPLIT_DEPTH |
| 544 | foreach $level ("part", "chapter", "section", "subsection", |
| 545 | "subsubsection", "paragraph") { |
| 546 | last if (($outermost_level) = /\\($level)$delimiter_rx/); |
| 547 | } |
| 548 | $level = ($outermost_level ? $section_commands{$outermost_level} : |
| 549 | do {$outermost_level = 'section'; 3;}); |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 550 | |
Fred Drake | 13210ed | 1998-03-17 06:28:05 +0000 | [diff] [blame] | 551 | #RRM: but calculate value for $MAX_SPLIT_DEPTH when a $REL_DEPTH was given |
| 552 | if ($REL_DEPTH && $MAX_SPLIT_DEPTH) { |
| 553 | $MAX_SPLIT_DEPTH = $level + $MAX_SPLIT_DEPTH; |
| 554 | } elsif (!($MAX_SPLIT_DEPTH)) { $MAX_SPLIT_DEPTH = 1 }; |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 555 | |
Fred Drake | 64bdc24 | 1998-04-17 02:14:12 +0000 | [diff] [blame] | 556 | %unnumbered_section_commands = ('tableofcontents' => $level, |
| 557 | 'listoffigures' => $level, |
| 558 | 'listoftables' => $level, |
| 559 | 'bibliography' => $level, |
| 560 | 'textohtmlindex' => $level, |
| 561 | 'textohtmlmoduleindex' => $level); |
| 562 | $section_headings{'textohtmlmoduleindex'} = 'h1'; |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 563 | |
Fred Drake | 64bdc24 | 1998-04-17 02:14:12 +0000 | [diff] [blame] | 564 | %section_commands = (%unnumbered_section_commands, |
| 565 | %section_commands); |
Fred Drake | 1191692 | 1998-04-02 22:30:57 +0000 | [diff] [blame] | 566 | |
| 567 | make_sections_rx(); |
Fred Drake | 13210ed | 1998-03-17 06:28:05 +0000 | [diff] [blame] | 568 | } |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 569 | |
| 570 | |
Fred Drake | 1072e46 | 1998-04-12 02:16:34 +0000 | [diff] [blame] | 571 | # This changes the markup used for {verbatim} environments, and is the |
Fred Drake | 95474f9 | 1999-02-09 18:45:50 +0000 | [diff] [blame] | 572 | # 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] | 573 | # <pre>...</pre>. |
| 574 | # |
| 575 | # Note that this *must* be done in the init file, not the python.perl |
Fred Drake | c568173 | 2000-09-12 20:13:04 +0000 | [diff] [blame] | 576 | # style support file. The %declarations must be set before |
| 577 | # initialize() is called in the main LaTeX2HTML script (which happens |
| 578 | # before style files are loaded). |
Fred Drake | 1072e46 | 1998-04-12 02:16:34 +0000 | [diff] [blame] | 579 | # |
Fred Drake | e15956b | 2000-04-03 04:51:13 +0000 | [diff] [blame] | 580 | %declarations = ('preform' => '<dl><dd><pre class="verbatim"></pre></dl>', |
Fred Drake | 1072e46 | 1998-04-12 02:16:34 +0000 | [diff] [blame] | 581 | %declarations); |
| 582 | |
Fred Drake | e15956b | 2000-04-03 04:51:13 +0000 | [diff] [blame] | 583 | |
Fred Drake | c568173 | 2000-09-12 20:13:04 +0000 | [diff] [blame] | 584 | # This is added to get rid of the long comment that follows the |
| 585 | # doctype declaration; MSIE5 on NT4 SP4 barfs on it and drops the |
| 586 | # content of the page. |
Fred Drake | a219b41 | 2001-10-22 16:57:49 +0000 | [diff] [blame] | 587 | $MY_PARTIAL_HEADER = ''; |
Fred Drake | e15956b | 2000-04-03 04:51:13 +0000 | [diff] [blame] | 588 | sub make_head_and_body { |
Fred Drake | 85d14c9 | 2000-07-31 17:53:45 +0000 | [diff] [blame] | 589 | my($title, $body) = @_; |
Fred Drake | 1681627 | 2000-09-16 20:40:44 +0000 | [diff] [blame] | 590 | $body = " $body" unless ($body eq ''); |
Fred Drake | 85d14c9 | 2000-07-31 17:53:45 +0000 | [diff] [blame] | 591 | my $DTDcomment = ''; |
| 592 | my($version, $isolanguage) = ($HTML_VERSION, 'EN'); |
| 593 | my %isolanguages = ( 'english', 'EN' , 'USenglish', 'EN.US' |
| 594 | , 'original', 'EN' , 'german' , 'DE' |
| 595 | , 'austrian', 'DE.AT', 'french' , 'FR' |
| 596 | , 'spanish', 'ES'); |
Fred Drake | e15956b | 2000-04-03 04:51:13 +0000 | [diff] [blame] | 597 | $isolanguage = $isolanguages{$default_language}; |
| 598 | $isolanguage = 'EN' unless $isolanguage; |
| 599 | $title = &purify($title,1); |
| 600 | eval("\$title = ". $default_title ) unless ($title); |
| 601 | |
| 602 | # allow user-modification of the <TITLE> tag; thanks Dan Young |
| 603 | if (defined &custom_TITLE_hook) { |
| 604 | $title = &custom_TITLE_hook($title, $toc_sec_title); |
| 605 | } |
| 606 | |
| 607 | if ($DOCTYPE =~ /\/\/[\w\.]+\s*$/) { # language spec included |
| 608 | $DTDcomment = "<!DOCTYPE html PUBLIC \"$DOCTYPE\">\n"; |
| 609 | } else { |
| 610 | $DTDcomment = "<!DOCTYPE html PUBLIC \"$DOCTYPE//" |
| 611 | . ($ISO_LANGUAGE ? $ISO_LANGUAGE : $isolanguage) . "\">\n"; |
| 612 | } |
Fred Drake | a219b41 | 2001-10-22 16:57:49 +0000 | [diff] [blame] | 613 | if ($MY_PARTIAL_HEADER eq '') { |
| 614 | $STYLESHEET = $FILE.".css" unless $STYLESHEET; |
| 615 | $MY_PARTIAL_HEADER = join('', |
| 616 | ($CHARSET && $HTML_VERSION ge "2.1" |
| 617 | ? ('<meta http-equiv="Content-Type" content="text/html; ' |
Fred Drake | cf43004 | 2002-03-22 17:22:38 +0000 | [diff] [blame] | 618 | . "charset=$CHARSET\">\n") |
Fred Drake | a219b41 | 2001-10-22 16:57:49 +0000 | [diff] [blame] | 619 | : ''), |
| 620 | ($BASE ? "<base href=\"$BASE\">\n" : ''), |
Fred Drake | 69f0a8e | 2002-03-26 19:57:52 +0000 | [diff] [blame] | 621 | "<link rel=\"STYLESHEET\" href=\"$STYLESHEET\" type='text/css'>\n", |
Fred Drake | a219b41 | 2001-10-22 16:57:49 +0000 | [diff] [blame] | 622 | "<link rel=\"first\" href=\"$FILE.html\">\n", |
| 623 | ($HAVE_TABLE_OF_CONTENTS |
| 624 | ? ('<link rel="contents" href="contents.html" title="Contents">' |
| 625 | . "\n") |
| 626 | : ''), |
| 627 | ($HAVE_GENERAL_INDEX |
| 628 | ? '<link rel="index" href="genindex.html" title="Index">' |
| 629 | : ''), |
| 630 | # disable for now -- Mozilla doesn't do well with multiple indexes |
| 631 | # ($HAVE_MODULE_INDEX |
| 632 | # ? '<link rel="index" href="modindex.html" title="Module Index">' |
| 633 | # . "\n" |
| 634 | # : ''), |
| 635 | $more_links_mark); |
| 636 | } |
Fred Drake | e15956b | 2000-04-03 04:51:13 +0000 | [diff] [blame] | 637 | |
Fred Drake | e15956b | 2000-04-03 04:51:13 +0000 | [diff] [blame] | 638 | if (!$charset && $CHARSET) { $charset = $CHARSET; $charset =~ s/_/\-/go; } |
| 639 | |
| 640 | join('', ($DOCTYPE ? $DTDcomment : '' ) |
Fred Drake | a219b41 | 2001-10-22 16:57:49 +0000 | [diff] [blame] | 641 | , "<html>\n<head>\n<title>", $title, "</title>\n" |
| 642 | , &meta_information($title) |
| 643 | , $MY_PARTIAL_HEADER |
Fred Drake | e03e1fe | 2002-04-05 17:34:50 +0000 | [diff] [blame^] | 644 | , ($AESOP_META_TYPE eq '' ? '' |
| 645 | : "\n<meta name='aesop' content='$AESOP_META_TYPE'>") |
Fred Drake | a219b41 | 2001-10-22 16:57:49 +0000 | [diff] [blame] | 646 | , "\n</head>\n<body$body>"); |
Fred Drake | e15956b | 2000-04-03 04:51:13 +0000 | [diff] [blame] | 647 | } |
| 648 | |
Fred Drake | bc7101d | 1998-03-06 21:18:55 +0000 | [diff] [blame] | 649 | 1; # This must be the last line |