blob: 0bc9aa59d23622e8a8b8306b516f5c54bd367747 [file] [log] [blame]
Fred Drake85d14c92000-07-31 17:53:45 +00001# LaTeX2HTML support base for use with Python documentation.
Fred Drake41814bc1998-05-11 18:23:35 +00002
3package main;
4
Fred Drake85d14c92000-07-31 17:53:45 +00005use L2hos;
6
Fred Drake28e7b4c1998-10-20 18:14:20 +00007$HTML_VERSION = 4.0;
8
Fred Drake6aa5d481998-08-11 03:14:50 +00009$MAX_LINK_DEPTH = 2;
Fred Draked7571651998-04-23 20:06:24 +000010$ADDRESS = '';
Fred Drakebc7101d1998-03-06 21:18:55 +000011
Fred Drakee194beb1998-05-19 19:38:49 +000012$NO_FOOTNODE = 1;
Fred Drakebc7101d1998-03-06 21:18:55 +000013$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 Drakef730fc32000-08-31 07:19:07 +000021$IMAGE_TYPE = 'gif';
Fred Drakebc7101d1998-03-06 21:18:55 +000022
Fred Drake6aa5d481998-08-11 03:14:50 +000023# Control where the navigation bars should show up:
24$TOP_NAVIGATION = 1;
25$BOTTOM_NAVIGATION = 1;
26$AUTO_NAVIGATION = 0;
27
Fred Drake16816272000-09-16 20:40:44 +000028$BODYTEXT = '';
Fred Drakebc7101d1998-03-06 21:18:55 +000029$CHILDLINE = "\n<p><hr>\n";
30$VERBOSITY = 0;
Fred Drakebc7101d1998-03-06 21:18:55 +000031
Fred Drake4d10b431998-08-07 20:51:58 +000032# default # of columns for the indexes
Fred Drakeaa3f9fb1998-08-07 19:52:37 +000033$INDEX_COLUMNS = 2;
Fred Drake2383f6d1999-03-02 16:00:37 +000034$MODULE_INDEX_COLUMNS = 4;
Fred Drakeaa3f9fb1998-08-07 19:52:37 +000035
Fred Drakea219b412001-10-22 16:57:49 +000036$HAVE_MODULE_INDEX = 0;
37$HAVE_GENERAL_INDEX = 0;
38$HAVE_TABLE_OF_CONTENTS = 0;
39
Fred Drakec9f2c141998-03-11 12:08:21 +000040
Fred Drakedb34a1e1998-03-10 23:02:57 +000041# A little painful, but lets us clean up the top level directory a little,
Fred Drake85d14c92000-07-31 17:53:45 +000042# and not be tied to the current directory (as far as I can tell). Testing
43# an existing definition of $mydir is needed since it cannot be computed when
44# run under mkhowto with recent versions of LaTeX2HTML, since this file is
45# not read directly by LaTeX2HTML any more. mkhowto is required to prepend
46# the required definition at the top of the actual input file.
Fred Drakedb34a1e1998-03-10 23:02:57 +000047#
Fred Drake85d14c92000-07-31 17:53:45 +000048if (!defined $mydir) {
49 use Cwd;
50 use File::Basename;
51 ($myname, $mydir, $myext) = fileparse(__FILE__, '\..*');
52 chop $mydir; # remove trailing '/'
53 $mydir = getcwd() . "$dd$mydir"
54 unless $mydir =~ s|^/|/|;
55}
Fred Drakedb34a1e1998-03-10 23:02:57 +000056$LATEX2HTMLSTYLES = "$mydir$envkey$LATEX2HTMLSTYLES";
Fred Drakeb3a3ed81998-07-24 22:17:34 +000057push (@INC, $mydir);
Fred Drakebc7101d1998-03-06 21:18:55 +000058
Fred Drake235e6b11998-03-27 05:19:43 +000059($myrootname, $myrootdir, $myext) = fileparse($mydir, '\..*');
60chop $myrootdir;
61
Fred Drakebc7101d1998-03-06 21:18:55 +000062
Fred Drakea4565b01998-05-15 17:14:17 +000063# Hackish way to get the appropriate paper-*/ directory into $TEXINPUTS;
64# pass in the paper size (a4 or letter) as the environment variable PAPER
65# to add the right directory. If not given, the current directory is
66# added instead for use with HOWTO processing.
67#
68if (defined $ENV{'PAPER'}) {
69 $mytexinputs = "$myrootdir${dd}paper-$ENV{'PAPER'}$envkey";
70}
71else {
72 $mytexinputs = getcwd() . $envkey;
73}
74$mytexinputs .= "$myrootdir${dd}texinputs";
75
76
Fred Drakeb35f2b71999-09-23 16:53:09 +000077# Change this variable to change the text added in "About this document...";
78# this should be an absolute pathname to get it right.
79#
80$ABOUT_FILE = "$myrootdir${dd}html${dd}stdabout.dat";
81
82
Fred Drake85d14c92000-07-31 17:53:45 +000083sub custom_driver_hook {
Fred Drakea4565b01998-05-15 17:14:17 +000084 #
85 # This adds the directory of the main input file to $TEXINPUTS; it
86 # seems to be sufficiently general that it should be fine for HOWTO
87 # processing.
88 #
89 my $file = @_[0];
Fred Drake85d14c92000-07-31 17:53:45 +000090 my($jobname, $dir, $ext) = fileparse($file, '\..*');
91 $dir = L2hos->Make_directory_absolute($dir);
Fred Drakea4565b01998-05-15 17:14:17 +000092 $dir =~ s/$dd$//;
93 $TEXINPUTS = "$dir$envkey$mytexinputs";
Fred Drake85d14c92000-07-31 17:53:45 +000094 print "\nAdding $dir to \$TEXINPUTS\n";
Fred Drake191439a1999-09-22 19:50:51 +000095}
96
Fred Drakea4565b01998-05-15 17:14:17 +000097
Fred Drake85d14c92000-07-31 17:53:45 +000098$CUSTOM_BUTTONS = '';
Fred Drake062bc6e1998-08-13 22:03:46 +000099
Fred Drake85d14c92000-07-31 17:53:45 +0000100sub make_nav_sectref {
Fred Drakebeb27bf1999-02-16 17:22:32 +0000101 my($label,$title) = @_;
102 if ($title) {
Fred Drake02c70822000-09-19 15:36:19 +0000103 if ($title =~ /\<[aA] /) {
104 $title =~ s/\<[aA] /<a class="sectref" /;
105 }
106 else {
107 $title = "<span class=\"sectref\">$title</span>";
108 }
109 return "<b class=\"navlabel\">$label:</b> $title\n";
Fred Drakebeb27bf1999-02-16 17:22:32 +0000110 }
111 return '';
112}
113
Fred Draked18722b2001-01-02 22:08:48 +0000114@my_icon_tags = ();
115$my_icon_tags{'next'} = 'Next Page';
116$my_icon_tags{'next_page'} = 'Next Page';
117$my_icon_tags{'previous'} = 'Previous Page';
118$my_icon_tags{'previous_page'} = 'Previous Page';
119$my_icon_tags{'up'} = 'Up One Level';
120$my_icon_tags{'contents'} = 'Contents';
121$my_icon_tags{'index'} = 'Index';
122$my_icon_tags{'modules'} = 'Module Index';
123
Fred Drakeb31d36c2001-01-04 15:16:01 +0000124@my_icon_names = ();
125$my_icon_names{'previous_page'} = 'previous';
126$my_icon_names{'next_page'} = 'next';
127
Fred Draked18722b2001-01-02 22:08:48 +0000128sub get_my_icon {
129 my $name = @_[0];
130 my $text = $my_icon_tags{$name};
Fred Drakeb31d36c2001-01-04 15:16:01 +0000131 if ($my_icon_names{$name}) {
132 $name = $my_icon_names{$name};
133 }
Fred Draked18722b2001-01-02 22:08:48 +0000134 if ($text eq '') {
135 $name = 'blank';
136 }
Fred Drake85d14c92000-07-31 17:53:45 +0000137 my $iconserver = ($ICONSERVER eq '.') ? '' : "$ICONSERVER/";
Fred Draked18722b2001-01-02 22:08:48 +0000138 return "<img src=\"$iconserver$name.$IMAGE_TYPE\"\n border=\"0\""
Fred Drake85d14c92000-07-31 17:53:45 +0000139 . " height=\"32\"\n alt=\"$text\" width=\"32\">";
140}
141
Fred Drake85d14c92000-07-31 17:53:45 +0000142sub use_my_icon {
143 my $s = @_[0];
Fred Draked18722b2001-01-02 22:08:48 +0000144 if ($s =~ /\<tex2html_([a-z_]+)_visible_mark\>/) {
145 my $r = get_my_icon($1);
146 $s =~ s/\<tex2html_[a-z_]+_visible_mark\>/$r/;
147 }
Fred Drakea0075441999-04-29 19:06:56 +0000148 return $s;
Fred Drake13210ed1998-03-17 06:28:05 +0000149}
150
Fred Drake85d14c92000-07-31 17:53:45 +0000151sub make_nav_panel {
152 my $s;
Fred Draked18722b2001-01-02 22:08:48 +0000153 my $BLANK_ICON = get_my_icon('blank');
Fred Drakef730fc32000-08-31 07:19:07 +0000154 $NEXT = $NEXT_TITLE ? use_my_icon("$NEXT") : $BLANK_ICON;
155 $UP = $UP_TITLE ? use_my_icon("$UP") : $BLANK_ICON;
156 $PREVIOUS = $PREVIOUS_TITLE ? use_my_icon("$PREVIOUS") : $BLANK_ICON;
Fred Drake85d14c92000-07-31 17:53:45 +0000157 $CONTENTS = use_my_icon("$CONTENTS");
158 $INDEX = $INDEX ? use_my_icon("$INDEX") : $BLANK_ICON;
159 if (!$CUSTOM_BUTTONS) {
160 $CUSTOM_BUTTONS = $BLANK_ICON;
161 }
162 $s = ('<table align="center" width="100%" cellpadding="0" cellspacing="2">'
163 . "\n<tr>"
164 # left-hand side
Fred Drake85d14c92000-07-31 17:53:45 +0000165 . "\n<td>$PREVIOUS</td>"
Fred Drake4640e132000-07-31 20:13:23 +0000166 . "\n<td>$UP</td>"
167 . "\n<td>$NEXT</td>"
Fred Drake85d14c92000-07-31 17:53:45 +0000168 # title box
Fred Drakef730fc32000-08-31 07:19:07 +0000169 . "\n<td align=\"center\" width=\"100%\">$t_title</td>"
Fred Drake85d14c92000-07-31 17:53:45 +0000170 # right-hand side
171 . "\n<td>$CONTENTS</td>"
172 . "\n<td>$CUSTOM_BUTTONS</td>" # module index
173 . "\n<td>$INDEX</td>"
174 . "\n</tr></table>\n"
175 # textual navigation
Fred Drake4640e132000-07-31 20:13:23 +0000176 . make_nav_sectref("Previous", $PREVIOUS_TITLE)
Fred Drake85d14c92000-07-31 17:53:45 +0000177 . make_nav_sectref("Up", $UP_TITLE)
Fred Drake4640e132000-07-31 20:13:23 +0000178 . make_nav_sectref("Next", $NEXT_TITLE)
179 );
Fred Drake85d14c92000-07-31 17:53:45 +0000180 # remove these; they are unnecessary and cause errors from validation
181 $s =~ s/ NAME="tex2html\d+"\n */ /g;
182 return $s;
183}
184
Fred Drakefb6499f2001-10-26 14:16:23 +0000185sub add_child_links {
186 my $toc = add_real_child_links(@_);
187 $toc =~ s|\s*</[aA]>|</a>|g;
188 $toc =~ s/ NAME=\"tex2html\d+\"\s*href=/ href=/gi;
189 $toc =~ s|</UL>(\s*<BR>)?|</ul>|gi;
190 return $toc;
191}
192
Fred Drake7497bd32000-10-25 16:18:10 +0000193sub get_version_text {
194 if ($PACKAGE_VERSION ne '' && $t_date) {
195 return ("<span class=\"release-info\">"
Fred Drakedce975c2001-06-20 21:31:36 +0000196 . "Release $PACKAGE_VERSION$RELEASE_INFO,"
Fred Drake7497bd32000-10-25 16:18:10 +0000197 . " documentation updated on $t_date.</span>");
198 }
199 if ($PACKAGE_VERSION ne '') {
200 return ("<span class=\"release-info\">"
Fred Drakedce975c2001-06-20 21:31:36 +0000201 . "Release $PACKAGE_VERSION$RELEASE_INFO.</span>");
Fred Drake7497bd32000-10-25 16:18:10 +0000202 }
203 if ($t_date) {
204 return ("<span class=\"release-info\">Documentation released on "
205 . "$t_date.</span>");
206 }
207 return '';
208}
209
Fred Drake85d14c92000-07-31 17:53:45 +0000210
Fred Drakebc7101d1998-03-06 21:18:55 +0000211sub top_navigation_panel {
Fred Drake7497bd32000-10-25 16:18:10 +0000212 return "\n"
213 . make_nav_panel()
214 . "<br><hr>\n";
Fred Drakebc7101d1998-03-06 21:18:55 +0000215}
216
217sub bot_navigation_panel {
Fred Drake7497bd32000-10-25 16:18:10 +0000218 return "\n<p><hr>\n"
219 . make_nav_panel()
220 . "<hr>\n"
221 . get_version_text()
222 . "\n";
Fred Drake64bdc241998-04-17 02:14:12 +0000223}
224
225sub add_link {
226 # Returns a pair (iconic link, textual link)
227 my($icon, $current_file, @link) = @_;
228 my($dummy, $file, $title) = split($delim,
Fred Drake28e7b4c1998-10-20 18:14:20 +0000229 $section_info{join(' ',@link)});
Fred Draked18722b2001-01-02 22:08:48 +0000230 if ($icon =~ /\<tex2html_([_a-z]+)_visible_mark\>/) {
231 my $r = get_my_icon($1);
232 $icon =~ s/\<tex2html_[_a-z]+_visible_mark\>/$r/;
233 }
Fred Drake64bdc241998-04-17 02:14:12 +0000234 if ($title && ($file ne $current_file)) {
235 $title = purify($title);
236 $title = get_first_words($title, $WORDS_IN_NAVIGATION_PANEL_TITLES);
237 return (make_href($file, $icon), make_href($file, "$title"))
238 }
Fred Draked18722b2001-01-02 22:08:48 +0000239 elsif ($icon eq get_my_icon('up') && $EXTERNAL_UP_LINK) {
Fred Drake64bdc241998-04-17 02:14:12 +0000240 return (make_href($EXTERNAL_UP_LINK, $icon),
241 make_href($EXTERNAL_UP_LINK, "$EXTERNAL_UP_TITLE"))
242 }
Fred Draked18722b2001-01-02 22:08:48 +0000243 elsif ($icon eq get_my_icon('previous')
Fred Drake64bdc241998-04-17 02:14:12 +0000244 && $EXTERNAL_PREV_LINK && $EXTERNAL_PREV_TITLE) {
245 return (make_href($EXTERNAL_PREV_LINK, $icon),
246 make_href($EXTERNAL_PREV_LINK, "$EXTERNAL_PREV_TITLE"))
247 }
Fred Draked18722b2001-01-02 22:08:48 +0000248 elsif ($icon eq get_my_icon('next')
Fred Drake64bdc241998-04-17 02:14:12 +0000249 && $EXTERNAL_DOWN_LINK && $EXTERNAL_DOWN_TITLE) {
250 return (make_href($EXTERNAL_DOWN_LINK, $icon),
251 make_href($EXTERNAL_DOWN_LINK, "$EXTERNAL_DOWN_TITLE"))
252 }
Fred Drake85d14c92000-07-31 17:53:45 +0000253 return (&inactive_img($icon), "");
Fred Drake64bdc241998-04-17 02:14:12 +0000254}
255
256sub add_special_link {
257 my($icon, $file, $current_file) = @_;
Fred Draked18722b2001-01-02 22:08:48 +0000258 if ($icon =~ /\<tex2html_([_a-z]+)_visible_mark\>/) {
259 my $r = get_my_icon($1);
260 $icon =~ s/\<tex2html_[_a-z]+_visible_mark\>/$r/;
261 }
Fred Drake85d14c92000-07-31 17:53:45 +0000262 return (($file && ($file ne $current_file))
263 ? make_href($file, $icon)
264 : undef)
Fred Drake64bdc241998-04-17 02:14:12 +0000265}
266
Fred Drake85d14c92000-07-31 17:53:45 +0000267# The img_tag() function seems only to be called with the parameter
268# 'anchor_invisible_mark', which we want to turn into ''. Since
269# replace_icon_marks() is the only interesting caller, and all it really
270# does is call img_tag(), we can just define the hook alternative to be
271# a no-op instead.
272#
273sub replace_icons_hook {}
Fred Drakebc7101d1998-03-06 21:18:55 +0000274
Fred Drake50cdd971999-02-19 23:04:59 +0000275sub do_cmd_arabic {
276 # get rid of that nasty <SPAN CLASS="arabic">...</SPAN>
Fred Drake85d14c92000-07-31 17:53:45 +0000277 my($ctr, $val, $id, $text) = &read_counter_value(@_[0]);
278 return ($val ? farabic($val) : "0") . $text;
Fred Drake50cdd971999-02-19 23:04:59 +0000279}
280
281
Fred Drakebc7101d1998-03-06 21:18:55 +0000282sub gen_index_id {
283 # this is used to ensure common index key generation and a stable sort
Fred Drake235e6b11998-03-27 05:19:43 +0000284 my($str,$extra) = @_;
Fred Drake64bdc241998-04-17 02:14:12 +0000285 sprintf('%s###%s%010d', $str, $extra, ++$global{'max_id'});
Fred Drakebc7101d1998-03-06 21:18:55 +0000286}
287
Fred Drake85d14c92000-07-31 17:53:45 +0000288sub insert_index {
Fred Drake2383f6d1999-03-02 16:00:37 +0000289 my($mark,$datafile,$columns,$letters,$prefix) = @_;
Fred Drake4d10b431998-08-07 20:51:58 +0000290 my $prog = "$myrootdir/tools/buildindex.py";
291 my $index;
292 if ($letters) {
293 $index = `$prog --columns $columns --letters $datafile`;
294 }
295 else {
296 $index = `$prog --columns $columns $datafile`;
297 }
Fred Drakec5681732000-09-12 20:13:04 +0000298 if (!s/$mark/$prefix$index/) {
299 print "\nCould not locate index mark: $mark";
300 }
Fred Drake64bdc241998-04-17 02:14:12 +0000301}
302
Fred Drake85d14c92000-07-31 17:53:45 +0000303sub add_idx {
Fred Drake9bbdce51999-01-19 16:30:10 +0000304 print "\nBuilding HTML for the index ...";
Fred Drake235e6b11998-03-27 05:19:43 +0000305 close(IDXFILE);
Fred Drake2383f6d1999-03-02 16:00:37 +0000306 insert_index($idx_mark, 'index.dat', $INDEX_COLUMNS, 1, '');
Fred Drake13210ed1998-03-17 06:28:05 +0000307}
Fred Drakebc7101d1998-03-06 21:18:55 +0000308
309
310$idx_module_mark = '<tex2html_idx_module_mark>';
311$idx_module_title = 'Module Index';
312
Fred Drake85d14c92000-07-31 17:53:45 +0000313sub add_module_idx {
Fred Drake9bbdce51999-01-19 16:30:10 +0000314 print "\nBuilding HTML for the module index ...";
Fred Drake235e6b11998-03-27 05:19:43 +0000315 my $key;
Fred Drake2383f6d1999-03-02 16:00:37 +0000316 my $first = 1;
317 my $prevplat = '';
318 my $allthesame = 1;
319 my $prefix = '';
320 foreach $key (keys %Modules) {
321 $key =~ s/<tt>([a-zA-Z0-9._]*)<\/tt>/\1/;
322 my $plat = "$ModulePlatforms{$key}";
323 $plat = ''
Fred Drake62cc3601999-03-04 18:41:17 +0000324 if ($plat eq $IGNORE_PLATFORM_ANNOTATION);
Fred Drake2383f6d1999-03-02 16:00:37 +0000325 if (!$first) {
326 $allthesame = 0
327 if ($prevplat ne $plat);
328 }
329 else { $first = 0; }
330 $prevplat = $plat;
331 }
Fred Drake64bdc241998-04-17 02:14:12 +0000332 open(MODIDXFILE, '>modindex.dat') || die "\n$!\n";
Fred Drake235e6b11998-03-27 05:19:43 +0000333 foreach $key (keys %Modules) {
334 # dump the line in the data file; just use a dummy seqno field
Fred Drake2383f6d1999-03-02 16:00:37 +0000335 my $nkey = $1;
336 my $moditem = "$Modules{$key}";
337 my $plat = '';
338 $key =~ s/<tt>([a-zA-Z0-9._]*)<\/tt>/\1/;
339 if ($ModulePlatforms{$key} && !$allthesame) {
Fred Drakedce975c2001-06-20 21:31:36 +0000340 $plat = (" <em>(<span class=\"platform\">$ModulePlatforms{$key}"
Fred Drakebb584d31999-03-25 22:18:30 +0000341 . '</span>)</em>');
Fred Drake2383f6d1999-03-02 16:00:37 +0000342 }
Fred Drakee15956b2000-04-03 04:51:13 +0000343 print MODIDXFILE $moditem . $IDXFILE_FIELD_SEP
Fred Drakedce975c2001-06-20 21:31:36 +0000344 . "<tt class=\"module\">$key</tt>$plat###\n";
Fred Drakebc7101d1998-03-06 21:18:55 +0000345 }
Fred Drake235e6b11998-03-27 05:19:43 +0000346 close(MODIDXFILE);
Fred Drake42181db2001-01-09 22:02:10 +0000347
348 if ($GLOBAL_MODULE_INDEX) {
349 $prefix = <<MODULE_INDEX_PREFIX;
350
351<p> This index only lists modules documented in this manual.
352 The <em class="citetitle"><a href="$GLOBAL_MODULE_INDEX">Global Module
353 Index</a></em> lists all modules that are documented in this set
354 of manuals.</p>
355MODULE_INDEX_PREFIX
356 }
Fred Drake2383f6d1999-03-02 16:00:37 +0000357 if (!$allthesame) {
Fred Draked18722b2001-01-02 22:08:48 +0000358 $prefix .= <<PLAT_DISCUSS;
Fred Drake2383f6d1999-03-02 16:00:37 +0000359
360<p> Some module names are followed by an annotation indicating what
361platform they are available on.</p>
362
363PLAT_DISCUSS
364 }
365 insert_index($idx_module_mark, 'modindex.dat', $MODULE_INDEX_COLUMNS, 0,
366 $prefix);
Fred Drakebc7101d1998-03-06 21:18:55 +0000367}
368
Fred Drake235e6b11998-03-27 05:19:43 +0000369# replace both indexes as needed:
Fred Drake85d14c92000-07-31 17:53:45 +0000370sub add_idx_hook {
Fred Drakeb3a3ed81998-07-24 22:17:34 +0000371 add_idx() if (/$idx_mark/);
Fred Drake2383f6d1999-03-02 16:00:37 +0000372 process_python_state();
Fred Drakec5681732000-09-12 20:13:04 +0000373 if ($MODULE_INDEX_FILE) {
374 local ($_);
375 open(MYFILE, "<$MODULE_INDEX_FILE");
376 sysread(MYFILE, $_, 1024*1024);
377 close(MYFILE);
378 add_module_idx();
379 open(MYFILE,">$MODULE_INDEX_FILE");
380 print MYFILE $_;
381 close(MYFILE);
382 }
Fred Drake235e6b11998-03-27 05:19:43 +0000383}
Fred Drakebc7101d1998-03-06 21:18:55 +0000384
Fred Drakebc7101d1998-03-06 21:18:55 +0000385
Fred Drake191439a1999-09-22 19:50:51 +0000386# In addition to the standard stuff, add label to allow named node files and
387# support suppression of the page complete (for HTML Help use).
Fred Drakebc7101d1998-03-06 21:18:55 +0000388sub do_cmd_tableofcontents {
389 local($_) = @_;
390 $TITLE = $toc_title;
391 $tocfile = $CURRENT_FILE;
Fred Drake64bdc241998-04-17 02:14:12 +0000392 my($closures,$reopens) = preserve_open_tags();
393 anchor_label('contents', $CURRENT_FILE, $_); # this is added
Fred Drakebeb27bf1999-02-16 17:22:32 +0000394 join('', "<BR>\n\\tableofchildlinks[off]", $closures
Fred Drake64bdc241998-04-17 02:14:12 +0000395 , make_section_heading($toc_title, 'H2'), $toc_mark
Fred Drakebc7101d1998-03-06 21:18:55 +0000396 , $reopens, $_);
397}
398# In addition to the standard stuff, add label to allow named node files.
399sub do_cmd_listoffigures {
400 local($_) = @_;
401 $TITLE = $lof_title;
402 $loffile = $CURRENT_FILE;
Fred Drake64bdc241998-04-17 02:14:12 +0000403 my($closures,$reopens) = preserve_open_tags();
404 anchor_label('lof', $CURRENT_FILE, $_); # this is added
Fred Drakebc7101d1998-03-06 21:18:55 +0000405 join('', "<BR>\n", $closures
Fred Drake64bdc241998-04-17 02:14:12 +0000406 , make_section_heading($lof_title, 'H2'), $lof_mark
Fred Drakebc7101d1998-03-06 21:18:55 +0000407 , $reopens, $_);
408}
409# In addition to the standard stuff, add label to allow named node files.
410sub do_cmd_listoftables {
411 local($_) = @_;
412 $TITLE = $lot_title;
413 $lotfile = $CURRENT_FILE;
Fred Drake64bdc241998-04-17 02:14:12 +0000414 my($closures,$reopens) = preserve_open_tags();
415 anchor_label('lot', $CURRENT_FILE, $_); # this is added
Fred Drakebc7101d1998-03-06 21:18:55 +0000416 join('', "<BR>\n", $closures
Fred Drake64bdc241998-04-17 02:14:12 +0000417 , make_section_heading($lot_title, 'H2'), $lot_mark
Fred Drakebc7101d1998-03-06 21:18:55 +0000418 , $reopens, $_);
419}
420# In addition to the standard stuff, add label to allow named node files.
421sub do_cmd_textohtmlinfopage {
422 local($_) = @_;
423 if ($INFO) { #
Fred Drake64bdc241998-04-17 02:14:12 +0000424 anchor_label("about",$CURRENT_FILE,$_); # this is added
Fred Drakebc7101d1998-03-06 21:18:55 +0000425 } #
Fred Drake15796f71998-11-30 19:25:47 +0000426 my $the_version = ''; # and the rest is
427 if ($t_date) { # mostly ours
428 $the_version = ",\n$t_date";
Fred Drake7497bd32000-10-25 16:18:10 +0000429 if ($PACKAGE_VERSION) {
Fred Drakedce975c2001-06-20 21:31:36 +0000430 $the_version .= ", Release $PACKAGE_VERSION$RELEASE_INFO";
Fred Drake15796f71998-11-30 19:25:47 +0000431 }
432 }
Fred Drake9443dc32001-08-10 20:12:09 +0000433 my $about;
434 open(ABOUT, "<$ABOUT_FILE") || die "\n$!\n";
435 sysread(ABOUT, $about, 1024*1024);
436 close(ABOUT);
Fred Drake15796f71998-11-30 19:25:47 +0000437 $_ = (($INFO == 1)
Fred Drakeb35f2b71999-09-23 16:53:09 +0000438 ? join('',
439 $close_all,
440 "<strong>$t_title</strong>$the_version\n",
Fred Drake9443dc32001-08-10 20:12:09 +0000441 $about,
Fred Drakeb35f2b71999-09-23 16:53:09 +0000442 $open_all, $_)
443 : join('', $close_all, $INFO,"\n", $open_all, $_));
Fred Drake15796f71998-11-30 19:25:47 +0000444 $_;
Fred Drakebc7101d1998-03-06 21:18:55 +0000445}
446
447# $idx_mark will be replaced with the real index at the end
448sub do_cmd_textohtmlindex {
449 local($_) = @_;
450 $TITLE = $idx_title;
451 $idxfile = $CURRENT_FILE;
Fred Drake235e6b11998-03-27 05:19:43 +0000452 if (%index_labels) { make_index_labels(); }
453 if (($SHORT_INDEX) && (%index_segment)) { make_preindex(); }
Fred Drakebc7101d1998-03-06 21:18:55 +0000454 else { $preindex = ''; }
Fred Drake235e6b11998-03-27 05:19:43 +0000455 my $heading = make_section_heading($idx_title, 'h2') . $idx_mark;
Fred Drake11916921998-04-02 22:30:57 +0000456 my($pre,$post) = minimize_open_tags($heading);
Fred Drake235e6b11998-03-27 05:19:43 +0000457 anchor_label('genindex',$CURRENT_FILE,$_); # this is added
Fred Drakec5681732000-09-12 20:13:04 +0000458 return "<br>\n" . $pre . $_;
Fred Drakebc7101d1998-03-06 21:18:55 +0000459}
460
Fred Drakec5681732000-09-12 20:13:04 +0000461$MODULE_INDEX_FILE = '';
462
Fred Drakebc7101d1998-03-06 21:18:55 +0000463# $idx_module_mark will be replaced with the real index at the end
464sub do_cmd_textohtmlmoduleindex {
465 local($_) = @_;
Fred Drakebc7101d1998-03-06 21:18:55 +0000466 $TITLE = $idx_module_title;
Fred Drakec5681732000-09-12 20:13:04 +0000467 anchor_label('modindex', $CURRENT_FILE, $_);
468 $MODULE_INDEX_FILE = "$CURRENT_FILE";
469 $_ = ('<p>' . make_section_heading($idx_module_title, 'h2')
470 . $idx_module_mark . $_);
471 return $_;
Fred Drakebc7101d1998-03-06 21:18:55 +0000472}
473
Fred Drakec5681732000-09-12 20:13:04 +0000474# The bibliography and the index should be treated as separate
475# sections in their own HTML files. The \bibliography{} command acts
476# as a sectioning command that has the desired effect. But when the
477# bibliography is constructed manually using the thebibliography
478# environment, or when using the theindex environment it is not
479# possible to use the normal sectioning mechanism. This subroutine
480# inserts a \bibliography{} or a dummy \textohtmlindex command just
481# before the appropriate environments to force sectioning.
Fred Drakebc7101d1998-03-06 21:18:55 +0000482
Fred Drakec5681732000-09-12 20:13:04 +0000483# XXX This *assumes* that if there are two {theindex} environments,
484# the first is the module index and the second is the standard
485# index. This is sufficient for the current Python documentation,
486# but that's about it.
Fred Drakebc7101d1998-03-06 21:18:55 +0000487
488sub add_bbl_and_idx_dummy_commands {
Fred Drake11916921998-04-02 22:30:57 +0000489 my $id = $global{'max_id'};
Fred Drakebc7101d1998-03-06 21:18:55 +0000490
Fred Drakea219b412001-10-22 16:57:49 +0000491 if (/[\\]tableofcontents/) {
492 $HAVE_TABLE_OF_CONTENTS = 1;
493 }
Fred Drakebc7101d1998-03-06 21:18:55 +0000494 s/([\\]begin\s*$O\d+$C\s*thebibliography)/$bbl_cnt++; $1/eg;
Fred Drake191439a1999-09-22 19:50:51 +0000495 s/([\\]begin\s*$O\d+$C\s*thebibliography)/$id++; "\\bibliography$O$id$C$O$id$C $1"/geo;
Fred Drake85d14c92000-07-31 17:53:45 +0000496 my(@parts) = split(/\\begin\s*$O\d+$C\s*theindex/);
497 if (scalar(@parts) == 3) {
498 # Be careful to re-write the string in place, since $_ is *not*
499 # returned explicity; *** nasty side-effect dependency! ***
Fred Drakebb7775a2001-12-04 17:03:54 +0000500 print "\nadd_bbl_and_idx_dummy_commands ==> adding general index";
Fred Drake85d14c92000-07-31 17:53:45 +0000501 print "\nadd_bbl_and_idx_dummy_commands ==> adding module index";
502 my $rx = "([\\\\]begin\\s*$O\\d+$C\\s*theindex[\\s\\S]*)"
503 . "([\\\\]begin\\s*$O\\d+$C\\s*theindex)";
504 s/$rx/\\textohtmlmoduleindex \1 \\textohtmlindex \2/o;
505 # Add a button to the navigation areas:
Fred Drakeaaa23852000-09-14 22:20:41 +0000506 $CUSTOM_BUTTONS .= ('<a href="modindex.html" title="Module Index">'
Fred Draked18722b2001-01-02 22:08:48 +0000507 . get_my_icon('modules')
Fred Drakeaaa23852000-09-14 22:20:41 +0000508 . '</a>');
Fred Drakea219b412001-10-22 16:57:49 +0000509 $HAVE_MODULE_INDEX = 1;
510 $HAVE_GENERAL_INDEX = 1;
511 }
512 elsif (scalar(@parts) == 2) {
Fred Drakebb7775a2001-12-04 17:03:54 +0000513 print "\nadd_bbl_and_idx_dummy_commands ==> adding general index";
514 my $rx = "([\\\\]begin\\s*$O\\d+$C\\s*theindex)";
515 s/$rx/\\textohtmlindex \1/o;
Fred Drakea219b412001-10-22 16:57:49 +0000516 $HAVE_GENERAL_INDEX = 1;
Fred Drake11916921998-04-02 22:30:57 +0000517 }
Fred Drakebb7775a2001-12-04 17:03:54 +0000518 elsif (scalar(@parts) == 1) {
519 print "\nadd_bbl_and_idx_dummy_commands ==> no index found";
Fred Draked18722b2001-01-02 22:08:48 +0000520 $CUSTOM_BUTTONS .= get_my_icon('blank');
Fred Drake85d14c92000-07-31 17:53:45 +0000521 $global{'max_id'} = $id; # not sure why....
522 s/([\\]begin\s*$O\d+$C\s*theindex)/\\textohtmlindex $1/o;
Fred Drake191439a1999-09-22 19:50:51 +0000523 s/[\\]printindex/\\textohtmlindex /o;
Fred Drakebb7775a2001-12-04 17:03:54 +0000524 }
525 else {
526 die "\n\nBad number of index environments!\n\n";
527 }
Fred Drake11916921998-04-02 22:30:57 +0000528 #----------------------------------------------------------------------
Fred Drake64bdc241998-04-17 02:14:12 +0000529 lib_add_bbl_and_idx_dummy_commands()
Fred Drake11916921998-04-02 22:30:57 +0000530 if defined(&lib_add_bbl_and_idx_dummy_commands);
Fred Drakebc7101d1998-03-06 21:18:55 +0000531}
532
Fred Drakec5681732000-09-12 20:13:04 +0000533# The bibliographic references, the appendices, the lists of figures
534# and tables etc. must appear in the contents table at the same level
535# as the outermost sectioning command. This subroutine finds what is
536# the outermost level and sets the above to the same level;
Fred Drakebc7101d1998-03-06 21:18:55 +0000537
Fred Drake13210ed1998-03-17 06:28:05 +0000538sub set_depth_levels {
539 # Sets $outermost_level
Fred Drake11916921998-04-02 22:30:57 +0000540 my $level;
Fred Drake13210ed1998-03-17 06:28:05 +0000541 #RRM: do not alter user-set value for $MAX_SPLIT_DEPTH
542 foreach $level ("part", "chapter", "section", "subsection",
543 "subsubsection", "paragraph") {
544 last if (($outermost_level) = /\\($level)$delimiter_rx/);
545 }
546 $level = ($outermost_level ? $section_commands{$outermost_level} :
547 do {$outermost_level = 'section'; 3;});
Fred Drakebc7101d1998-03-06 21:18:55 +0000548
Fred Drake13210ed1998-03-17 06:28:05 +0000549 #RRM: but calculate value for $MAX_SPLIT_DEPTH when a $REL_DEPTH was given
550 if ($REL_DEPTH && $MAX_SPLIT_DEPTH) {
551 $MAX_SPLIT_DEPTH = $level + $MAX_SPLIT_DEPTH;
552 } elsif (!($MAX_SPLIT_DEPTH)) { $MAX_SPLIT_DEPTH = 1 };
Fred Drakebc7101d1998-03-06 21:18:55 +0000553
Fred Drake64bdc241998-04-17 02:14:12 +0000554 %unnumbered_section_commands = ('tableofcontents' => $level,
555 'listoffigures' => $level,
556 'listoftables' => $level,
557 'bibliography' => $level,
558 'textohtmlindex' => $level,
559 'textohtmlmoduleindex' => $level);
560 $section_headings{'textohtmlmoduleindex'} = 'h1';
Fred Drakebc7101d1998-03-06 21:18:55 +0000561
Fred Drake64bdc241998-04-17 02:14:12 +0000562 %section_commands = (%unnumbered_section_commands,
563 %section_commands);
Fred Drake11916921998-04-02 22:30:57 +0000564
565 make_sections_rx();
Fred Drake13210ed1998-03-17 06:28:05 +0000566}
Fred Drakebc7101d1998-03-06 21:18:55 +0000567
568
Fred Drake1072e461998-04-12 02:16:34 +0000569# This changes the markup used for {verbatim} environments, and is the
Fred Drake95474f91999-02-09 18:45:50 +0000570# best way I've found that ensures the <dl> goes on the outside of the
Fred Drake1072e461998-04-12 02:16:34 +0000571# <pre>...</pre>.
572#
573# Note that this *must* be done in the init file, not the python.perl
Fred Drakec5681732000-09-12 20:13:04 +0000574# style support file. The %declarations must be set before
575# initialize() is called in the main LaTeX2HTML script (which happens
576# before style files are loaded).
Fred Drake1072e461998-04-12 02:16:34 +0000577#
Fred Drakee15956b2000-04-03 04:51:13 +0000578%declarations = ('preform' => '<dl><dd><pre class="verbatim"></pre></dl>',
Fred Drake1072e461998-04-12 02:16:34 +0000579 %declarations);
580
Fred Drakee15956b2000-04-03 04:51:13 +0000581
Fred Drakec5681732000-09-12 20:13:04 +0000582# This is added to get rid of the long comment that follows the
583# doctype declaration; MSIE5 on NT4 SP4 barfs on it and drops the
584# content of the page.
Fred Drakea219b412001-10-22 16:57:49 +0000585$MY_PARTIAL_HEADER = '';
Fred Drakee15956b2000-04-03 04:51:13 +0000586sub make_head_and_body {
Fred Drake85d14c92000-07-31 17:53:45 +0000587 my($title, $body) = @_;
Fred Drake16816272000-09-16 20:40:44 +0000588 $body = " $body" unless ($body eq '');
Fred Drake85d14c92000-07-31 17:53:45 +0000589 my $DTDcomment = '';
590 my($version, $isolanguage) = ($HTML_VERSION, 'EN');
591 my %isolanguages = ( 'english', 'EN' , 'USenglish', 'EN.US'
592 , 'original', 'EN' , 'german' , 'DE'
593 , 'austrian', 'DE.AT', 'french' , 'FR'
594 , 'spanish', 'ES');
Fred Drakee15956b2000-04-03 04:51:13 +0000595 $isolanguage = $isolanguages{$default_language};
596 $isolanguage = 'EN' unless $isolanguage;
597 $title = &purify($title,1);
598 eval("\$title = ". $default_title ) unless ($title);
599
600 # allow user-modification of the <TITLE> tag; thanks Dan Young
601 if (defined &custom_TITLE_hook) {
602 $title = &custom_TITLE_hook($title, $toc_sec_title);
603 }
604
605 if ($DOCTYPE =~ /\/\/[\w\.]+\s*$/) { # language spec included
606 $DTDcomment = "<!DOCTYPE html PUBLIC \"$DOCTYPE\">\n";
607 } else {
608 $DTDcomment = "<!DOCTYPE html PUBLIC \"$DOCTYPE//"
609 . ($ISO_LANGUAGE ? $ISO_LANGUAGE : $isolanguage) . "\">\n";
610 }
Fred Drakea219b412001-10-22 16:57:49 +0000611 if ($MY_PARTIAL_HEADER eq '') {
612 $STYLESHEET = $FILE.".css" unless $STYLESHEET;
613 $MY_PARTIAL_HEADER = join('',
614 ($CHARSET && $HTML_VERSION ge "2.1"
615 ? ('<meta http-equiv="Content-Type" content="text/html; '
Fred Drakecf430042002-03-22 17:22:38 +0000616 . "charset=$CHARSET\">\n")
Fred Drakea219b412001-10-22 16:57:49 +0000617 : ''),
618 ($BASE ? "<base href=\"$BASE\">\n" : ''),
Fred Drake69f0a8e2002-03-26 19:57:52 +0000619 "<link rel=\"STYLESHEET\" href=\"$STYLESHEET\" type='text/css'>\n",
Fred Drakea219b412001-10-22 16:57:49 +0000620 "<link rel=\"first\" href=\"$FILE.html\">\n",
621 ($HAVE_TABLE_OF_CONTENTS
622 ? ('<link rel="contents" href="contents.html" title="Contents">'
623 . "\n")
624 : ''),
625 ($HAVE_GENERAL_INDEX
626 ? '<link rel="index" href="genindex.html" title="Index">'
627 : ''),
628 # disable for now -- Mozilla doesn't do well with multiple indexes
629 # ($HAVE_MODULE_INDEX
630 # ? '<link rel="index" href="modindex.html" title="Module Index">'
631 # . "\n"
632 # : ''),
633 $more_links_mark);
634 }
Fred Drakee15956b2000-04-03 04:51:13 +0000635
Fred Drakee15956b2000-04-03 04:51:13 +0000636 if (!$charset && $CHARSET) { $charset = $CHARSET; $charset =~ s/_/\-/go; }
637
638 join('', ($DOCTYPE ? $DTDcomment : '' )
Fred Drakea219b412001-10-22 16:57:49 +0000639 , "<html>\n<head>\n<title>", $title, "</title>\n"
640 , &meta_information($title)
641 , $MY_PARTIAL_HEADER
642 , "\n</head>\n<body$body>");
Fred Drakee15956b2000-04-03 04:51:13 +0000643}
644
Fred Drakebc7101d1998-03-06 21:18:55 +00006451; # This must be the last line