blob: b7ade490845135c2d5b0b0ad0811808059998972 [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 Drakee03e1fe2002-04-05 17:34:50 +000040$AESOP_META_TYPE = 'information';
41
Fred Drakec9f2c141998-03-11 12:08:21 +000042
Fred Drakedb34a1e1998-03-10 23:02:57 +000043# A little painful, but lets us clean up the top level directory a little,
Fred Drake85d14c92000-07-31 17:53:45 +000044# 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 Drakedb34a1e1998-03-10 23:02:57 +000049#
Fred Drake85d14c92000-07-31 17:53:45 +000050if (!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 Drakedb34a1e1998-03-10 23:02:57 +000058$LATEX2HTMLSTYLES = "$mydir$envkey$LATEX2HTMLSTYLES";
Fred Drakeb3a3ed81998-07-24 22:17:34 +000059push (@INC, $mydir);
Fred Drakebc7101d1998-03-06 21:18:55 +000060
Fred Drake235e6b11998-03-27 05:19:43 +000061($myrootname, $myrootdir, $myext) = fileparse($mydir, '\..*');
62chop $myrootdir;
63
Fred Drakebc7101d1998-03-06 21:18:55 +000064
Fred Drakea4565b01998-05-15 17:14:17 +000065# 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#
70if (defined $ENV{'PAPER'}) {
71 $mytexinputs = "$myrootdir${dd}paper-$ENV{'PAPER'}$envkey";
72}
73else {
74 $mytexinputs = getcwd() . $envkey;
75}
76$mytexinputs .= "$myrootdir${dd}texinputs";
77
78
Fred Drakeb35f2b71999-09-23 16:53:09 +000079# 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 Drake85d14c92000-07-31 17:53:45 +000085sub custom_driver_hook {
Fred Drakea4565b01998-05-15 17:14:17 +000086 #
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 Drake85d14c92000-07-31 17:53:45 +000092 my($jobname, $dir, $ext) = fileparse($file, '\..*');
93 $dir = L2hos->Make_directory_absolute($dir);
Fred Drakea4565b01998-05-15 17:14:17 +000094 $dir =~ s/$dd$//;
95 $TEXINPUTS = "$dir$envkey$mytexinputs";
Fred Drake85d14c92000-07-31 17:53:45 +000096 print "\nAdding $dir to \$TEXINPUTS\n";
Fred Drake191439a1999-09-22 19:50:51 +000097}
98
Fred Drakea4565b01998-05-15 17:14:17 +000099
Fred Drake85d14c92000-07-31 17:53:45 +0000100$CUSTOM_BUTTONS = '';
Fred Drake062bc6e1998-08-13 22:03:46 +0000101
Fred Drake85d14c92000-07-31 17:53:45 +0000102sub make_nav_sectref {
Fred Drakebeb27bf1999-02-16 17:22:32 +0000103 my($label,$title) = @_;
104 if ($title) {
Fred Drake02c70822000-09-19 15:36:19 +0000105 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 Drakebeb27bf1999-02-16 17:22:32 +0000112 }
113 return '';
114}
115
Fred Draked18722b2001-01-02 22:08:48 +0000116@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 Drakeb31d36c2001-01-04 15:16:01 +0000126@my_icon_names = ();
127$my_icon_names{'previous_page'} = 'previous';
128$my_icon_names{'next_page'} = 'next';
129
Fred Draked18722b2001-01-02 22:08:48 +0000130sub get_my_icon {
131 my $name = @_[0];
132 my $text = $my_icon_tags{$name};
Fred Drakeb31d36c2001-01-04 15:16:01 +0000133 if ($my_icon_names{$name}) {
134 $name = $my_icon_names{$name};
135 }
Fred Draked18722b2001-01-02 22:08:48 +0000136 if ($text eq '') {
137 $name = 'blank';
138 }
Fred Drake85d14c92000-07-31 17:53:45 +0000139 my $iconserver = ($ICONSERVER eq '.') ? '' : "$ICONSERVER/";
Fred Draked18722b2001-01-02 22:08:48 +0000140 return "<img src=\"$iconserver$name.$IMAGE_TYPE\"\n border=\"0\""
Fred Drake85d14c92000-07-31 17:53:45 +0000141 . " height=\"32\"\n alt=\"$text\" width=\"32\">";
142}
143
Fred Drake85d14c92000-07-31 17:53:45 +0000144sub use_my_icon {
145 my $s = @_[0];
Fred Draked18722b2001-01-02 22:08:48 +0000146 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 Drakea0075441999-04-29 19:06:56 +0000150 return $s;
Fred Drake13210ed1998-03-17 06:28:05 +0000151}
152
Fred Drake85d14c92000-07-31 17:53:45 +0000153sub make_nav_panel {
154 my $s;
Fred Draked18722b2001-01-02 22:08:48 +0000155 my $BLANK_ICON = get_my_icon('blank');
Fred Drakef730fc32000-08-31 07:19:07 +0000156 $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 Drake85d14c92000-07-31 17:53:45 +0000159 $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 Drake85d14c92000-07-31 17:53:45 +0000167 . "\n<td>$PREVIOUS</td>"
Fred Drake4640e132000-07-31 20:13:23 +0000168 . "\n<td>$UP</td>"
169 . "\n<td>$NEXT</td>"
Fred Drake85d14c92000-07-31 17:53:45 +0000170 # title box
Fred Drakef730fc32000-08-31 07:19:07 +0000171 . "\n<td align=\"center\" width=\"100%\">$t_title</td>"
Fred Drake85d14c92000-07-31 17:53:45 +0000172 # 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 Drake4640e132000-07-31 20:13:23 +0000178 . make_nav_sectref("Previous", $PREVIOUS_TITLE)
Fred Drake85d14c92000-07-31 17:53:45 +0000179 . make_nav_sectref("Up", $UP_TITLE)
Fred Drake4640e132000-07-31 20:13:23 +0000180 . make_nav_sectref("Next", $NEXT_TITLE)
181 );
Fred Drake85d14c92000-07-31 17:53:45 +0000182 # remove these; they are unnecessary and cause errors from validation
183 $s =~ s/ NAME="tex2html\d+"\n */ /g;
184 return $s;
185}
186
Fred Drakefb6499f2001-10-26 14:16:23 +0000187sub 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 Drake7497bd32000-10-25 16:18:10 +0000195sub get_version_text {
196 if ($PACKAGE_VERSION ne '' && $t_date) {
197 return ("<span class=\"release-info\">"
Fred Drakedce975c2001-06-20 21:31:36 +0000198 . "Release $PACKAGE_VERSION$RELEASE_INFO,"
Fred Drake7497bd32000-10-25 16:18:10 +0000199 . " documentation updated on $t_date.</span>");
200 }
201 if ($PACKAGE_VERSION ne '') {
202 return ("<span class=\"release-info\">"
Fred Drakedce975c2001-06-20 21:31:36 +0000203 . "Release $PACKAGE_VERSION$RELEASE_INFO.</span>");
Fred Drake7497bd32000-10-25 16:18:10 +0000204 }
205 if ($t_date) {
206 return ("<span class=\"release-info\">Documentation released on "
207 . "$t_date.</span>");
208 }
209 return '';
210}
211
Fred Drake85d14c92000-07-31 17:53:45 +0000212
Fred Drakebc7101d1998-03-06 21:18:55 +0000213sub top_navigation_panel {
Fred Drake7497bd32000-10-25 16:18:10 +0000214 return "\n"
215 . make_nav_panel()
216 . "<br><hr>\n";
Fred Drakebc7101d1998-03-06 21:18:55 +0000217}
218
219sub bot_navigation_panel {
Fred Drake7497bd32000-10-25 16:18:10 +0000220 return "\n<p><hr>\n"
221 . make_nav_panel()
222 . "<hr>\n"
223 . get_version_text()
224 . "\n";
Fred Drake64bdc241998-04-17 02:14:12 +0000225}
226
227sub add_link {
228 # Returns a pair (iconic link, textual link)
229 my($icon, $current_file, @link) = @_;
230 my($dummy, $file, $title) = split($delim,
Fred Drake28e7b4c1998-10-20 18:14:20 +0000231 $section_info{join(' ',@link)});
Fred Draked18722b2001-01-02 22:08:48 +0000232 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 Drake64bdc241998-04-17 02:14:12 +0000236 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 Draked18722b2001-01-02 22:08:48 +0000241 elsif ($icon eq get_my_icon('up') && $EXTERNAL_UP_LINK) {
Fred Drake64bdc241998-04-17 02:14:12 +0000242 return (make_href($EXTERNAL_UP_LINK, $icon),
243 make_href($EXTERNAL_UP_LINK, "$EXTERNAL_UP_TITLE"))
244 }
Fred Draked18722b2001-01-02 22:08:48 +0000245 elsif ($icon eq get_my_icon('previous')
Fred Drake64bdc241998-04-17 02:14:12 +0000246 && $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 Draked18722b2001-01-02 22:08:48 +0000250 elsif ($icon eq get_my_icon('next')
Fred Drake64bdc241998-04-17 02:14:12 +0000251 && $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 Drake85d14c92000-07-31 17:53:45 +0000255 return (&inactive_img($icon), "");
Fred Drake64bdc241998-04-17 02:14:12 +0000256}
257
258sub add_special_link {
259 my($icon, $file, $current_file) = @_;
Fred Draked18722b2001-01-02 22:08:48 +0000260 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 Drake85d14c92000-07-31 17:53:45 +0000264 return (($file && ($file ne $current_file))
265 ? make_href($file, $icon)
266 : undef)
Fred Drake64bdc241998-04-17 02:14:12 +0000267}
268
Fred Drake85d14c92000-07-31 17:53:45 +0000269# 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#
275sub replace_icons_hook {}
Fred Drakebc7101d1998-03-06 21:18:55 +0000276
Fred Drake50cdd971999-02-19 23:04:59 +0000277sub do_cmd_arabic {
278 # get rid of that nasty <SPAN CLASS="arabic">...</SPAN>
Fred Drake85d14c92000-07-31 17:53:45 +0000279 my($ctr, $val, $id, $text) = &read_counter_value(@_[0]);
280 return ($val ? farabic($val) : "0") . $text;
Fred Drake50cdd971999-02-19 23:04:59 +0000281}
282
283
Fred Drakebc7101d1998-03-06 21:18:55 +0000284sub gen_index_id {
285 # this is used to ensure common index key generation and a stable sort
Fred Drake235e6b11998-03-27 05:19:43 +0000286 my($str,$extra) = @_;
Fred Drake64bdc241998-04-17 02:14:12 +0000287 sprintf('%s###%s%010d', $str, $extra, ++$global{'max_id'});
Fred Drakebc7101d1998-03-06 21:18:55 +0000288}
289
Fred Drake85d14c92000-07-31 17:53:45 +0000290sub insert_index {
Fred Drake2383f6d1999-03-02 16:00:37 +0000291 my($mark,$datafile,$columns,$letters,$prefix) = @_;
Fred Drake4d10b431998-08-07 20:51:58 +0000292 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 Drakec5681732000-09-12 20:13:04 +0000300 if (!s/$mark/$prefix$index/) {
301 print "\nCould not locate index mark: $mark";
302 }
Fred Drake64bdc241998-04-17 02:14:12 +0000303}
304
Fred Drake85d14c92000-07-31 17:53:45 +0000305sub add_idx {
Fred Drake9bbdce51999-01-19 16:30:10 +0000306 print "\nBuilding HTML for the index ...";
Fred Drake235e6b11998-03-27 05:19:43 +0000307 close(IDXFILE);
Fred Drake2383f6d1999-03-02 16:00:37 +0000308 insert_index($idx_mark, 'index.dat', $INDEX_COLUMNS, 1, '');
Fred Drake13210ed1998-03-17 06:28:05 +0000309}
Fred Drakebc7101d1998-03-06 21:18:55 +0000310
311
312$idx_module_mark = '<tex2html_idx_module_mark>';
313$idx_module_title = 'Module Index';
314
Fred Drake85d14c92000-07-31 17:53:45 +0000315sub add_module_idx {
Fred Drake9bbdce51999-01-19 16:30:10 +0000316 print "\nBuilding HTML for the module index ...";
Fred Drake235e6b11998-03-27 05:19:43 +0000317 my $key;
Fred Drake2383f6d1999-03-02 16:00:37 +0000318 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 Drake62cc3601999-03-04 18:41:17 +0000326 if ($plat eq $IGNORE_PLATFORM_ANNOTATION);
Fred Drake2383f6d1999-03-02 16:00:37 +0000327 if (!$first) {
328 $allthesame = 0
329 if ($prevplat ne $plat);
330 }
331 else { $first = 0; }
332 $prevplat = $plat;
333 }
Fred Drake64bdc241998-04-17 02:14:12 +0000334 open(MODIDXFILE, '>modindex.dat') || die "\n$!\n";
Fred Drake235e6b11998-03-27 05:19:43 +0000335 foreach $key (keys %Modules) {
336 # dump the line in the data file; just use a dummy seqno field
Fred Drake2383f6d1999-03-02 16:00:37 +0000337 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 Drakedce975c2001-06-20 21:31:36 +0000342 $plat = (" <em>(<span class=\"platform\">$ModulePlatforms{$key}"
Fred Drakebb584d31999-03-25 22:18:30 +0000343 . '</span>)</em>');
Fred Drake2383f6d1999-03-02 16:00:37 +0000344 }
Fred Drakee15956b2000-04-03 04:51:13 +0000345 print MODIDXFILE $moditem . $IDXFILE_FIELD_SEP
Fred Drakedce975c2001-06-20 21:31:36 +0000346 . "<tt class=\"module\">$key</tt>$plat###\n";
Fred Drakebc7101d1998-03-06 21:18:55 +0000347 }
Fred Drake235e6b11998-03-27 05:19:43 +0000348 close(MODIDXFILE);
Fred Drake42181db2001-01-09 22:02:10 +0000349
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>
357MODULE_INDEX_PREFIX
358 }
Fred Drake2383f6d1999-03-02 16:00:37 +0000359 if (!$allthesame) {
Fred Draked18722b2001-01-02 22:08:48 +0000360 $prefix .= <<PLAT_DISCUSS;
Fred Drake2383f6d1999-03-02 16:00:37 +0000361
362<p> Some module names are followed by an annotation indicating what
363platform they are available on.</p>
364
365PLAT_DISCUSS
366 }
367 insert_index($idx_module_mark, 'modindex.dat', $MODULE_INDEX_COLUMNS, 0,
368 $prefix);
Fred Drakebc7101d1998-03-06 21:18:55 +0000369}
370
Fred Drake235e6b11998-03-27 05:19:43 +0000371# replace both indexes as needed:
Fred Drake85d14c92000-07-31 17:53:45 +0000372sub add_idx_hook {
Fred Drakeb3a3ed81998-07-24 22:17:34 +0000373 add_idx() if (/$idx_mark/);
Fred Drake2383f6d1999-03-02 16:00:37 +0000374 process_python_state();
Fred Drakec5681732000-09-12 20:13:04 +0000375 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 Drake235e6b11998-03-27 05:19:43 +0000385}
Fred Drakebc7101d1998-03-06 21:18:55 +0000386
Fred Drakebc7101d1998-03-06 21:18:55 +0000387
Fred Drake191439a1999-09-22 19:50:51 +0000388# 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 Drakebc7101d1998-03-06 21:18:55 +0000390sub do_cmd_tableofcontents {
391 local($_) = @_;
392 $TITLE = $toc_title;
393 $tocfile = $CURRENT_FILE;
Fred Drake64bdc241998-04-17 02:14:12 +0000394 my($closures,$reopens) = preserve_open_tags();
395 anchor_label('contents', $CURRENT_FILE, $_); # this is added
Fred Drakebeb27bf1999-02-16 17:22:32 +0000396 join('', "<BR>\n\\tableofchildlinks[off]", $closures
Fred Drake64bdc241998-04-17 02:14:12 +0000397 , make_section_heading($toc_title, 'H2'), $toc_mark
Fred Drakebc7101d1998-03-06 21:18:55 +0000398 , $reopens, $_);
399}
400# In addition to the standard stuff, add label to allow named node files.
401sub do_cmd_listoffigures {
402 local($_) = @_;
403 $TITLE = $lof_title;
404 $loffile = $CURRENT_FILE;
Fred Drake64bdc241998-04-17 02:14:12 +0000405 my($closures,$reopens) = preserve_open_tags();
406 anchor_label('lof', $CURRENT_FILE, $_); # this is added
Fred Drakebc7101d1998-03-06 21:18:55 +0000407 join('', "<BR>\n", $closures
Fred Drake64bdc241998-04-17 02:14:12 +0000408 , make_section_heading($lof_title, 'H2'), $lof_mark
Fred Drakebc7101d1998-03-06 21:18:55 +0000409 , $reopens, $_);
410}
411# In addition to the standard stuff, add label to allow named node files.
412sub do_cmd_listoftables {
413 local($_) = @_;
414 $TITLE = $lot_title;
415 $lotfile = $CURRENT_FILE;
Fred Drake64bdc241998-04-17 02:14:12 +0000416 my($closures,$reopens) = preserve_open_tags();
417 anchor_label('lot', $CURRENT_FILE, $_); # this is added
Fred Drakebc7101d1998-03-06 21:18:55 +0000418 join('', "<BR>\n", $closures
Fred Drake64bdc241998-04-17 02:14:12 +0000419 , make_section_heading($lot_title, 'H2'), $lot_mark
Fred Drakebc7101d1998-03-06 21:18:55 +0000420 , $reopens, $_);
421}
422# In addition to the standard stuff, add label to allow named node files.
423sub do_cmd_textohtmlinfopage {
424 local($_) = @_;
425 if ($INFO) { #
Fred Drake64bdc241998-04-17 02:14:12 +0000426 anchor_label("about",$CURRENT_FILE,$_); # this is added
Fred Drakebc7101d1998-03-06 21:18:55 +0000427 } #
Fred Drake15796f71998-11-30 19:25:47 +0000428 my $the_version = ''; # and the rest is
429 if ($t_date) { # mostly ours
430 $the_version = ",\n$t_date";
Fred Drake7497bd32000-10-25 16:18:10 +0000431 if ($PACKAGE_VERSION) {
Fred Drakedce975c2001-06-20 21:31:36 +0000432 $the_version .= ", Release $PACKAGE_VERSION$RELEASE_INFO";
Fred Drake15796f71998-11-30 19:25:47 +0000433 }
434 }
Fred Drake9443dc32001-08-10 20:12:09 +0000435 my $about;
436 open(ABOUT, "<$ABOUT_FILE") || die "\n$!\n";
437 sysread(ABOUT, $about, 1024*1024);
438 close(ABOUT);
Fred Drake15796f71998-11-30 19:25:47 +0000439 $_ = (($INFO == 1)
Fred Drakeb35f2b71999-09-23 16:53:09 +0000440 ? join('',
441 $close_all,
442 "<strong>$t_title</strong>$the_version\n",
Fred Drake9443dc32001-08-10 20:12:09 +0000443 $about,
Fred Drakeb35f2b71999-09-23 16:53:09 +0000444 $open_all, $_)
445 : join('', $close_all, $INFO,"\n", $open_all, $_));
Fred Drake15796f71998-11-30 19:25:47 +0000446 $_;
Fred Drakebc7101d1998-03-06 21:18:55 +0000447}
448
449# $idx_mark will be replaced with the real index at the end
450sub do_cmd_textohtmlindex {
451 local($_) = @_;
452 $TITLE = $idx_title;
453 $idxfile = $CURRENT_FILE;
Fred Drake235e6b11998-03-27 05:19:43 +0000454 if (%index_labels) { make_index_labels(); }
455 if (($SHORT_INDEX) && (%index_segment)) { make_preindex(); }
Fred Drakebc7101d1998-03-06 21:18:55 +0000456 else { $preindex = ''; }
Fred Drake235e6b11998-03-27 05:19:43 +0000457 my $heading = make_section_heading($idx_title, 'h2') . $idx_mark;
Fred Drake11916921998-04-02 22:30:57 +0000458 my($pre,$post) = minimize_open_tags($heading);
Fred Drake235e6b11998-03-27 05:19:43 +0000459 anchor_label('genindex',$CURRENT_FILE,$_); # this is added
Fred Drakec5681732000-09-12 20:13:04 +0000460 return "<br>\n" . $pre . $_;
Fred Drakebc7101d1998-03-06 21:18:55 +0000461}
462
Fred Drakec5681732000-09-12 20:13:04 +0000463$MODULE_INDEX_FILE = '';
464
Fred Drakebc7101d1998-03-06 21:18:55 +0000465# $idx_module_mark will be replaced with the real index at the end
466sub do_cmd_textohtmlmoduleindex {
467 local($_) = @_;
Fred Drakebc7101d1998-03-06 21:18:55 +0000468 $TITLE = $idx_module_title;
Fred Drakec5681732000-09-12 20:13:04 +0000469 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 Drakebc7101d1998-03-06 21:18:55 +0000474}
475
Fred Drakec5681732000-09-12 20:13:04 +0000476# 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 Drakebc7101d1998-03-06 21:18:55 +0000484
Fred Drakec5681732000-09-12 20:13:04 +0000485# 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 Drakebc7101d1998-03-06 21:18:55 +0000489
490sub add_bbl_and_idx_dummy_commands {
Fred Drake11916921998-04-02 22:30:57 +0000491 my $id = $global{'max_id'};
Fred Drakebc7101d1998-03-06 21:18:55 +0000492
Fred Drakea219b412001-10-22 16:57:49 +0000493 if (/[\\]tableofcontents/) {
494 $HAVE_TABLE_OF_CONTENTS = 1;
495 }
Fred Drakebc7101d1998-03-06 21:18:55 +0000496 s/([\\]begin\s*$O\d+$C\s*thebibliography)/$bbl_cnt++; $1/eg;
Fred Drake191439a1999-09-22 19:50:51 +0000497 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 +0000498 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 Drakebb7775a2001-12-04 17:03:54 +0000502 print "\nadd_bbl_and_idx_dummy_commands ==> adding general index";
Fred Drake85d14c92000-07-31 17:53:45 +0000503 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 Drakeaaa23852000-09-14 22:20:41 +0000508 $CUSTOM_BUTTONS .= ('<a href="modindex.html" title="Module Index">'
Fred Draked18722b2001-01-02 22:08:48 +0000509 . get_my_icon('modules')
Fred Drakeaaa23852000-09-14 22:20:41 +0000510 . '</a>');
Fred Drakea219b412001-10-22 16:57:49 +0000511 $HAVE_MODULE_INDEX = 1;
512 $HAVE_GENERAL_INDEX = 1;
513 }
514 elsif (scalar(@parts) == 2) {
Fred Drakebb7775a2001-12-04 17:03:54 +0000515 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 Drakea219b412001-10-22 16:57:49 +0000518 $HAVE_GENERAL_INDEX = 1;
Fred Drake11916921998-04-02 22:30:57 +0000519 }
Fred Drakebb7775a2001-12-04 17:03:54 +0000520 elsif (scalar(@parts) == 1) {
521 print "\nadd_bbl_and_idx_dummy_commands ==> no index found";
Fred Draked18722b2001-01-02 22:08:48 +0000522 $CUSTOM_BUTTONS .= get_my_icon('blank');
Fred Drake85d14c92000-07-31 17:53:45 +0000523 $global{'max_id'} = $id; # not sure why....
524 s/([\\]begin\s*$O\d+$C\s*theindex)/\\textohtmlindex $1/o;
Fred Drake191439a1999-09-22 19:50:51 +0000525 s/[\\]printindex/\\textohtmlindex /o;
Fred Drakebb7775a2001-12-04 17:03:54 +0000526 }
527 else {
528 die "\n\nBad number of index environments!\n\n";
529 }
Fred Drake11916921998-04-02 22:30:57 +0000530 #----------------------------------------------------------------------
Fred Drake64bdc241998-04-17 02:14:12 +0000531 lib_add_bbl_and_idx_dummy_commands()
Fred Drake11916921998-04-02 22:30:57 +0000532 if defined(&lib_add_bbl_and_idx_dummy_commands);
Fred Drakebc7101d1998-03-06 21:18:55 +0000533}
534
Fred Drakec5681732000-09-12 20:13:04 +0000535# 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 Drakebc7101d1998-03-06 21:18:55 +0000539
Fred Drake13210ed1998-03-17 06:28:05 +0000540sub set_depth_levels {
541 # Sets $outermost_level
Fred Drake11916921998-04-02 22:30:57 +0000542 my $level;
Fred Drake13210ed1998-03-17 06:28:05 +0000543 #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 Drakebc7101d1998-03-06 21:18:55 +0000550
Fred Drake13210ed1998-03-17 06:28:05 +0000551 #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 Drakebc7101d1998-03-06 21:18:55 +0000555
Fred Drake64bdc241998-04-17 02:14:12 +0000556 %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 Drakebc7101d1998-03-06 21:18:55 +0000563
Fred Drake64bdc241998-04-17 02:14:12 +0000564 %section_commands = (%unnumbered_section_commands,
565 %section_commands);
Fred Drake11916921998-04-02 22:30:57 +0000566
567 make_sections_rx();
Fred Drake13210ed1998-03-17 06:28:05 +0000568}
Fred Drakebc7101d1998-03-06 21:18:55 +0000569
570
Fred Drake1072e461998-04-12 02:16:34 +0000571# This changes the markup used for {verbatim} environments, and is the
Fred Drake95474f91999-02-09 18:45:50 +0000572# best way I've found that ensures the <dl> goes on the outside of the
Fred Drake1072e461998-04-12 02:16:34 +0000573# <pre>...</pre>.
574#
575# Note that this *must* be done in the init file, not the python.perl
Fred Drakec5681732000-09-12 20:13:04 +0000576# 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 Drake1072e461998-04-12 02:16:34 +0000579#
Fred Drakee15956b2000-04-03 04:51:13 +0000580%declarations = ('preform' => '<dl><dd><pre class="verbatim"></pre></dl>',
Fred Drake1072e461998-04-12 02:16:34 +0000581 %declarations);
582
Fred Drakee15956b2000-04-03 04:51:13 +0000583
Fred Drakec5681732000-09-12 20:13:04 +0000584# 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 Drakea219b412001-10-22 16:57:49 +0000587$MY_PARTIAL_HEADER = '';
Fred Drakee15956b2000-04-03 04:51:13 +0000588sub make_head_and_body {
Fred Drake85d14c92000-07-31 17:53:45 +0000589 my($title, $body) = @_;
Fred Drake16816272000-09-16 20:40:44 +0000590 $body = " $body" unless ($body eq '');
Fred Drake85d14c92000-07-31 17:53:45 +0000591 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 Drakee15956b2000-04-03 04:51:13 +0000597 $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 Drakea219b412001-10-22 16:57:49 +0000613 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 Drakecf430042002-03-22 17:22:38 +0000618 . "charset=$CHARSET\">\n")
Fred Drakea219b412001-10-22 16:57:49 +0000619 : ''),
620 ($BASE ? "<base href=\"$BASE\">\n" : ''),
Fred Drake69f0a8e2002-03-26 19:57:52 +0000621 "<link rel=\"STYLESHEET\" href=\"$STYLESHEET\" type='text/css'>\n",
Fred Drakea219b412001-10-22 16:57:49 +0000622 "<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 Drakee15956b2000-04-03 04:51:13 +0000637
Fred Drakee15956b2000-04-03 04:51:13 +0000638 if (!$charset && $CHARSET) { $charset = $CHARSET; $charset =~ s/_/\-/go; }
639
640 join('', ($DOCTYPE ? $DTDcomment : '' )
Fred Drakea219b412001-10-22 16:57:49 +0000641 , "<html>\n<head>\n<title>", $title, "</title>\n"
642 , &meta_information($title)
643 , $MY_PARTIAL_HEADER
Fred Drakee03e1fe2002-04-05 17:34:50 +0000644 , ($AESOP_META_TYPE eq '' ? ''
645 : "\n<meta name='aesop' content='$AESOP_META_TYPE'>")
Fred Drakea219b412001-10-22 16:57:49 +0000646 , "\n</head>\n<body$body>");
Fred Drakee15956b2000-04-03 04:51:13 +0000647}
648
Fred Drakebc7101d1998-03-06 21:18:55 +00006491; # This must be the last line