1995-05-10 01:58:06 +02:00
|
|
|
#!/usr/bin/perl
|
1996-09-08 22:40:52 +02:00
|
|
|
|
1996-10-06 01:38:55 +02:00
|
|
|
# $Id: sgmlfmt.pl,v 1.16 1996/10/01 16:23:39 jfieber Exp $
|
1996-09-08 22:40:52 +02:00
|
|
|
|
|
|
|
|
# Copyright (C) 1996
|
|
|
|
|
# John R. Fieber. All rights reserved.
|
|
|
|
|
#
|
|
|
|
|
# Redistribution and use in source and binary forms, with or without
|
|
|
|
|
# modification, are permitted provided that the following conditions
|
|
|
|
|
# are met:
|
|
|
|
|
# 1. Redistributions of source code must retain the above copyright
|
|
|
|
|
# notice, this list of conditions and the following disclaimer.
|
|
|
|
|
# 2. Redistributions in binary form must reproduce the above copyright
|
|
|
|
|
# notice, this list of conditions and the following disclaimer in the
|
|
|
|
|
# documentation and/or other materials provided with the distribution.
|
|
|
|
|
#
|
|
|
|
|
# THIS SOFTWARE IS PROVIDED BY JOHN R. FIEBER AND CONTRIBUTORS ``AS IS'' AND
|
|
|
|
|
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
|
|
|
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
|
|
|
# ARE DISCLAIMED. IN NO EVENT SHALL JOHN R. FIEBER OR CONTRIBUTORS BE LIABLE
|
|
|
|
|
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
|
|
|
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
|
|
|
# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
|
|
|
# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
|
|
|
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
|
|
|
# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
|
|
|
# SUCH DAMAGE.
|
|
|
|
|
|
1995-05-10 01:58:06 +02:00
|
|
|
|
|
|
|
|
# Format an sgml document tagged according to the linuxdoc DTD.
|
|
|
|
|
# by John Fieber <jfieber@freebsd.org> for the FreeBSD documentation
|
|
|
|
|
# project.
|
|
|
|
|
|
|
|
|
|
|
1995-08-31 02:14:02 +02:00
|
|
|
require 'newgetopt.pl';
|
|
|
|
|
|
1996-09-08 22:40:52 +02:00
|
|
|
#
|
|
|
|
|
# The SGML parser, and translation engine.
|
|
|
|
|
#
|
|
|
|
|
|
|
|
|
|
$sgmls = "sgmls";
|
|
|
|
|
$instant = "instant";
|
1995-05-10 01:58:06 +02:00
|
|
|
|
|
|
|
|
#
|
|
|
|
|
# Locate the DTD, an SGML declaration, and the replacement files
|
|
|
|
|
#
|
|
|
|
|
|
1996-09-08 22:40:52 +02:00
|
|
|
$doctype = "<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 3.2//EN\">";
|
|
|
|
|
$dtdbase = "/usr/share/sgml/FreeBSD";
|
|
|
|
|
$dtd = "$dtdbase/linuxdoc.dtd";
|
|
|
|
|
$decl = "$dtdbase/linuxdoc.dcl";
|
1995-05-10 01:58:06 +02:00
|
|
|
|
1996-09-29 21:42:51 +02:00
|
|
|
#
|
|
|
|
|
# Things to clean up if we exit abnormally
|
|
|
|
|
#
|
|
|
|
|
|
|
|
|
|
@cleanfiles = ();
|
|
|
|
|
|
|
|
|
|
#
|
|
|
|
|
# Interrupt handler, remove scratch files.
|
|
|
|
|
#
|
|
|
|
|
|
|
|
|
|
sub sighandler {
|
|
|
|
|
local($sig) = @_;
|
|
|
|
|
unlink @cleanfiles;
|
|
|
|
|
exit(1);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
$SIG{'HUP'} = 'sighandler';
|
|
|
|
|
$SIG{'INT'} = 'sighandler';
|
|
|
|
|
$SIG{'QUIT'} = 'sighandler';
|
|
|
|
|
|
|
|
|
|
#
|
|
|
|
|
# Display a usage message.
|
|
|
|
|
#
|
|
|
|
|
|
1995-08-31 02:14:02 +02:00
|
|
|
sub usage {
|
|
|
|
|
print "Usage:\n";
|
1995-10-07 23:28:34 +01:00
|
|
|
print "sgmlfmt -f <format> [-i <namea> ...] [-links] [-ssi] file\n";
|
1996-09-09 16:15:28 +02:00
|
|
|
print "where <format> is one of: ascii, html, koi8-r, latex, latin1, ps, roff\n";
|
1995-08-31 02:14:02 +02:00
|
|
|
}
|
1996-05-15 19:05:17 +02:00
|
|
|
|
1995-05-10 01:58:06 +02:00
|
|
|
#
|
|
|
|
|
# Look for the file specified on the command line
|
|
|
|
|
#
|
|
|
|
|
|
|
|
|
|
sub getfile {
|
|
|
|
|
local($filearg) = @_;
|
|
|
|
|
if (-f "$filearg.sgml") {
|
|
|
|
|
$file = "$filearg.sgml";
|
|
|
|
|
}
|
|
|
|
|
elsif (-f $filearg) {
|
|
|
|
|
$file = $filearg;
|
|
|
|
|
}
|
|
|
|
|
else {
|
|
|
|
|
return 0;
|
|
|
|
|
}
|
|
|
|
|
$fileroot = $file;
|
|
|
|
|
$fileroot =~ s/.*\///; # drop the path
|
|
|
|
|
$fileroot =~ s/\.sgml$//; # drop the .sgml
|
|
|
|
|
$filepath = $file;
|
|
|
|
|
$filepath =~ s/\/*[^\/]*$//;
|
1996-09-08 22:40:52 +02:00
|
|
|
if ($filepath ne "") {
|
|
|
|
|
$ENV{"SGML_PATH"} .= ":$filepath/%S:%S";
|
1995-05-10 01:58:06 +02:00
|
|
|
}
|
|
|
|
|
return 1;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#
|
1996-09-08 22:40:52 +02:00
|
|
|
# A function to run sgmls and instant on the input file.
|
1995-05-10 01:58:06 +02:00
|
|
|
#
|
|
|
|
|
# Arguments:
|
|
|
|
|
# 1. A file handle for the output
|
1996-09-08 22:40:52 +02:00
|
|
|
# 2. A translation file
|
1995-05-10 01:58:06 +02:00
|
|
|
#
|
|
|
|
|
|
|
|
|
|
sub sgmlparse {
|
1996-09-08 22:40:52 +02:00
|
|
|
local($ifhandle, $replacement) = @_;
|
1995-08-31 02:14:02 +02:00
|
|
|
$defines = join(" -i ", @opt_i);
|
|
|
|
|
if ($defines ne "") {
|
|
|
|
|
$defines = "-i $defines";
|
|
|
|
|
}
|
1996-09-08 22:40:52 +02:00
|
|
|
open($ifhandle, "$sgmls $defines $decl $file | " .
|
|
|
|
|
"$instant -Dfilename=$fileroot -t linuxdoc-${replacement}.ts |");
|
1995-05-10 01:58:06 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#
|
1996-09-08 22:40:52 +02:00
|
|
|
# Generate roff output
|
1995-05-10 01:58:06 +02:00
|
|
|
#
|
|
|
|
|
|
1996-09-08 22:40:52 +02:00
|
|
|
sub gen_roff {
|
1996-09-29 21:42:51 +02:00
|
|
|
@cleanfiles = (@cleanfiles, "${fileroot}.roff");
|
1996-09-08 22:40:52 +02:00
|
|
|
open (outfile, ">$fileroot.roff");
|
|
|
|
|
&sgmlparse(infile, "roff");
|
1995-05-10 01:58:06 +02:00
|
|
|
while (<infile>) {
|
|
|
|
|
print outfile;
|
|
|
|
|
}
|
|
|
|
|
close(infile);
|
|
|
|
|
close(outfile);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#
|
1996-09-08 22:40:52 +02:00
|
|
|
# Generate something from roff output
|
1995-05-10 01:58:06 +02:00
|
|
|
#
|
|
|
|
|
|
1996-09-08 22:40:52 +02:00
|
|
|
sub do_groff {
|
|
|
|
|
local($driver, $postproc) = @_;
|
1996-09-29 21:42:51 +02:00
|
|
|
@cleanfiles = (@cleanfiles, "${fileroot}.trf", "${fileroot}.tmp",
|
|
|
|
|
"${fileroot}.qrf", "${fileroot}.${driver}");
|
1996-09-08 22:40:52 +02:00
|
|
|
open (outfile, ">$fileroot.trf");
|
|
|
|
|
&sgmlparse(infile, "roff");
|
1995-05-10 01:58:06 +02:00
|
|
|
while (<infile>) {
|
|
|
|
|
print outfile;
|
|
|
|
|
}
|
|
|
|
|
close(infile);
|
|
|
|
|
close(outfile);
|
1996-09-08 22:40:52 +02:00
|
|
|
system("groff -T ${driver} -t ${fileroot}.trf ${postproc} > ${fileroot}.${driver}");
|
1995-05-10 01:58:06 +02:00
|
|
|
|
1996-09-08 22:40:52 +02:00
|
|
|
# If foo.tmp has been created, then there are cross references
|
|
|
|
|
# in the file and we need a second pass to resolve them correctly.
|
1995-05-10 01:58:06 +02:00
|
|
|
|
1996-09-08 22:40:52 +02:00
|
|
|
if (stat("${fileroot}.tmp")) {
|
|
|
|
|
system("groff -T ${driver} -t ${fileroot}.trf ${postproc} > ${fileroot}.${driver}");
|
|
|
|
|
unlink("${fileroot}.qrf");
|
1995-05-10 01:58:06 +02:00
|
|
|
}
|
1996-09-08 22:40:52 +02:00
|
|
|
unlink("${fileroot}.trf");
|
1995-05-10 01:58:06 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#
|
|
|
|
|
# Generate LaTeX output
|
|
|
|
|
#
|
|
|
|
|
|
|
|
|
|
sub gen_latex {
|
1996-09-29 21:42:51 +02:00
|
|
|
@cleanfiles = (@cleanfiles, "${fileroot}.latex");
|
1996-09-08 22:40:52 +02:00
|
|
|
open(outfile, ">$fileroot.latex");
|
1995-05-10 01:58:06 +02:00
|
|
|
&sgmlparse(infile, "latex");
|
|
|
|
|
while (<infile>) {
|
|
|
|
|
print outfile;
|
|
|
|
|
}
|
|
|
|
|
close(infile);
|
|
|
|
|
close(outfile);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#
|
|
|
|
|
# Generate HTML output.
|
|
|
|
|
#
|
|
|
|
|
# HTML is generated in two passes.
|
|
|
|
|
#
|
|
|
|
|
# The first pass takes the output from sgmlsasp and gathers information
|
|
|
|
|
# about the structure of the document that is used in the sceond pass
|
|
|
|
|
# for splitting the file into separate files. Targets for cross
|
|
|
|
|
# references are also stored in this pass.
|
|
|
|
|
#
|
|
|
|
|
# Based on the information from the first pass, the second pass
|
|
|
|
|
# generates a numbered series of HTML files, a "toplevel" file
|
|
|
|
|
# containing the title, author, abstract and a brief table of
|
|
|
|
|
# contents. A detailed table of contents is also generated. The
|
|
|
|
|
# second pass generates links for cross references and URLs.
|
|
|
|
|
|
|
|
|
|
#
|
|
|
|
|
# Tunable parameters
|
|
|
|
|
#
|
|
|
|
|
$maxlevel = 3; # max section depth
|
|
|
|
|
$num_depth = 4; # depth of numbering
|
|
|
|
|
$m_depth = 2; # depth of menus
|
|
|
|
|
|
|
|
|
|
|
1995-08-29 03:02:12 +02:00
|
|
|
$sc = 0; # section counter
|
|
|
|
|
$filecount = 0; # file counter
|
|
|
|
|
|
|
|
|
|
# Other variables:
|
|
|
|
|
#
|
|
|
|
|
# st_xxxx - Section Table. Arrays containing information about a
|
|
|
|
|
# given section. To be accesssed via the section counter $sc.
|
|
|
|
|
#
|
|
|
|
|
# st_ol - The output level of the given section. I.E. how many
|
|
|
|
|
# levels from the table of contents does it lie in terms
|
|
|
|
|
# of HTML files which is distinct from <sect1>, <sect2> etc.
|
|
|
|
|
# levels.
|
|
|
|
|
#
|
|
|
|
|
# st_sl - The absolute depth of a section. Contrast st_ol.
|
|
|
|
|
#
|
|
|
|
|
# st_num - The section number in the form X.Y.Z....
|
|
|
|
|
#
|
|
|
|
|
# st_file - The HTML file the section belongs to.
|
|
|
|
|
#
|
|
|
|
|
# st_header - The text of the section title.
|
|
|
|
|
#
|
|
|
|
|
# st_parent - The section number of the given sections parent.
|
1995-05-10 01:58:06 +02:00
|
|
|
|
|
|
|
|
sub gen_html {
|
|
|
|
|
local($i, $sl);
|
|
|
|
|
|
1996-10-01 18:23:39 +02:00
|
|
|
# Remove any lingering link file
|
|
|
|
|
unlink("${fileroot}.ln");
|
|
|
|
|
|
|
|
|
|
$tmpfile = "/tmp/sgmlf.$$";
|
1996-09-29 21:42:51 +02:00
|
|
|
@cleanfiles = (@cleanfiles, "$tmpfile", "${fileroot}.html",
|
|
|
|
|
"${fileroot}_toc.html", "${fileroot}.ln");
|
1995-05-10 01:58:06 +02:00
|
|
|
open(bar, ">$tmpfile");
|
|
|
|
|
# print STDERR "(Pass 1...";
|
|
|
|
|
&sgmlparse(foo, "html");
|
|
|
|
|
while (<foo>) {
|
|
|
|
|
print bar;
|
|
|
|
|
# count up the number of files to be generated
|
1995-08-29 03:02:12 +02:00
|
|
|
# and gather assorted info about the document structure
|
1995-10-07 23:28:34 +01:00
|
|
|
if (/^<\@\@sect>/) {
|
1995-08-29 03:02:12 +02:00
|
|
|
$sl++; # current section level
|
|
|
|
|
$sc++; # current section number
|
1995-05-10 01:58:06 +02:00
|
|
|
$st_sl[$sc] = $sl;
|
|
|
|
|
|
1995-08-29 03:02:12 +02:00
|
|
|
# In case this section has subsections, set the parent
|
|
|
|
|
# pointer for this level to point at this section.
|
|
|
|
|
$parent_pointer[$sl] = $sc;
|
|
|
|
|
|
|
|
|
|
# Figure out who is the parent if this section.
|
|
|
|
|
$st_parent[$sc] = $parent_pointer[$sl - 1];
|
|
|
|
|
|
1995-05-10 01:58:06 +02:00
|
|
|
# Per level counters
|
|
|
|
|
$counter[$sl]++;
|
|
|
|
|
$counter[$sl + 1] = 0;
|
|
|
|
|
|
|
|
|
|
# calculate the section number in the form x.y.z.
|
|
|
|
|
if ($sl <= $num_depth) {
|
1995-08-29 03:02:12 +02:00
|
|
|
$st_num[$sc] = $st_num[$st_parent[$sc]] . "$counter[$sl].";
|
1995-05-10 01:58:06 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
# calculate the file number and output level
|
|
|
|
|
if ($sl <= $maxlevel) {
|
|
|
|
|
$filecount++;
|
|
|
|
|
$st_ol[$sc] = $sl;
|
1996-09-29 21:42:51 +02:00
|
|
|
@cleanfiles = (@cleanfiles, "${fileroot}${filecount}.html");
|
1995-05-10 01:58:06 +02:00
|
|
|
}
|
|
|
|
|
else {
|
|
|
|
|
$st_ol[$sc] = $maxlevel;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
$st_file[$sc] = $filecount;
|
|
|
|
|
|
|
|
|
|
# Calculate the highest level node in which this
|
|
|
|
|
# node should appear as a menu item.
|
|
|
|
|
$st_pl[$sc] = $sl - $m_depth;
|
|
|
|
|
if ($st_pl[$sc] < 0) {
|
|
|
|
|
$st_pl[$sc] = 0;
|
|
|
|
|
}
|
|
|
|
|
if ($st_pl[$sc] > $maxlevel) {
|
|
|
|
|
$st_pl[$sc] = $maxlevel;
|
|
|
|
|
}
|
|
|
|
|
}
|
1995-10-07 23:28:34 +01:00
|
|
|
if (/^<\@\@endsect>/) {
|
1995-05-10 01:58:06 +02:00
|
|
|
$sl--;
|
|
|
|
|
}
|
|
|
|
|
|
1995-08-29 03:02:12 +02:00
|
|
|
# record section titles
|
1995-10-07 23:28:34 +01:00
|
|
|
if (/^<\@\@head>/) {
|
1995-08-29 03:02:12 +02:00
|
|
|
chop;
|
1995-10-07 23:28:34 +01:00
|
|
|
s/^<\@\@head>//;
|
1995-08-29 03:02:12 +02:00
|
|
|
$st_header[$sc] = $_;
|
|
|
|
|
}
|
|
|
|
|
|
1995-05-10 01:58:06 +02:00
|
|
|
# record the section number that a label occurs in
|
1995-10-07 23:28:34 +01:00
|
|
|
if (/^<\@\@label>/) {
|
1995-05-10 01:58:06 +02:00
|
|
|
chop;
|
1995-10-07 23:28:34 +01:00
|
|
|
s/^<\@\@label>//;
|
1995-05-10 01:58:06 +02:00
|
|
|
if ($references{$_} eq "") {
|
|
|
|
|
$references{$_} = "$filecount";
|
1995-08-31 02:14:02 +02:00
|
|
|
if ($opt_links) {
|
1995-08-29 03:02:12 +02:00
|
|
|
&extlink($_, "${fileroot}${filecount}.html");
|
1995-06-30 17:19:12 +02:00
|
|
|
}
|
1995-05-10 01:58:06 +02:00
|
|
|
}
|
|
|
|
|
else {
|
|
|
|
|
print STDERR "Warning: the label `$_' is multiply-defined.\n";
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
close(bar);
|
|
|
|
|
|
|
|
|
|
open(foofile, $tmpfile);
|
|
|
|
|
&html2html(foofile, "boo");
|
|
|
|
|
|
|
|
|
|
unlink($tmpfile);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#
|
|
|
|
|
# HTML conversion, pass number 2
|
|
|
|
|
#
|
|
|
|
|
|
|
|
|
|
sub html2html {
|
|
|
|
|
local($infile, $outfile) = @_;
|
|
|
|
|
local($i);
|
|
|
|
|
|
|
|
|
|
$sc = 0;
|
|
|
|
|
push(@scs, $sc);
|
|
|
|
|
|
|
|
|
|
open(tocfile, ">${fileroot}_toc.html");
|
1996-05-15 19:05:17 +02:00
|
|
|
print tocfile "$doctype\n<HTML>\n";
|
1995-05-10 01:58:06 +02:00
|
|
|
|
|
|
|
|
while (<$infile>) {
|
|
|
|
|
# change `<' and `>' to `<' and `>' in <pre></pre>
|
|
|
|
|
if (/<pre>/.../<\/pre>/) {
|
|
|
|
|
s/</\</g;
|
|
|
|
|
s/\<([\/]*)pre>/<\1pre>/g;
|
|
|
|
|
s/>/\>/g;
|
|
|
|
|
s/<([\/]*)pre\>/<\1pre>/g;
|
|
|
|
|
}
|
|
|
|
|
|
1995-05-18 05:01:28 +02:00
|
|
|
# remove extraneous empty paragraphs (it is arguable that this
|
|
|
|
|
# is really a bug with the DTD, but changing it would break
|
|
|
|
|
# almost every document written to this DTD.)
|
|
|
|
|
s/<p><\/p>//;
|
|
|
|
|
|
1995-05-10 01:58:06 +02:00
|
|
|
tagsw: {
|
|
|
|
|
# titles and headings
|
1995-10-07 23:28:34 +01:00
|
|
|
if (s/^<\@\@title>//) {
|
1995-05-10 01:58:06 +02:00
|
|
|
chop;
|
1995-08-29 03:02:12 +02:00
|
|
|
$st_header[0] = $_;
|
|
|
|
|
$st_parent[0] = -1;
|
|
|
|
|
print tocfile "<HEAD>\n<TITLE>$st_header[0]</TITLE>\n</HEAD>\n";
|
|
|
|
|
print tocfile "<H1>$st_header[0]</H1>\n";
|
1995-10-07 23:28:34 +01:00
|
|
|
|
1995-05-10 01:58:06 +02:00
|
|
|
$header[$st_ol[$sc]] =
|
1996-05-15 19:05:17 +02:00
|
|
|
"$doctype\n<HTML>\n<HEAD>\n<TITLE>$st_header[0]</TITLE>\n" .
|
1996-10-06 01:38:55 +02:00
|
|
|
"</HEAD>\n$BODY\n";
|
|
|
|
|
$header[$st_ol[$sc]] .= $html_header;
|
1995-10-07 23:28:34 +01:00
|
|
|
if ($opt_ssi) { # Server Side Include hook
|
|
|
|
|
$header[$st_ol[$sc]] .=
|
|
|
|
|
"<!--#include virtual=\"./$fileroot.hdr\" -->";
|
|
|
|
|
}
|
|
|
|
|
$header[$st_ol[$sc]] .= "\n<H1>$st_header[0]</H1>\n";
|
|
|
|
|
|
|
|
|
|
$footer[$st_ol[$sc]] = "\n";
|
1996-10-06 01:38:55 +02:00
|
|
|
$footer[$st_ol[$sc]] .= $html_footer;
|
1995-10-07 23:28:34 +01:00
|
|
|
if ($opt_ssi) { # Server Side Include hook
|
|
|
|
|
$footer[$st_ol[$sc]] .=
|
|
|
|
|
"<!--#include virtual=\"./$fileroot.ftr\" -->";
|
|
|
|
|
}
|
|
|
|
|
$footer[$st_ol[$sc]] .= "\n</BODY>\n</HTML>\n";
|
1995-05-10 01:58:06 +02:00
|
|
|
last tagsw;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#
|
|
|
|
|
# HEADER begin
|
|
|
|
|
#
|
1995-10-07 23:28:34 +01:00
|
|
|
if (s/^<\@\@head>//) {
|
1995-05-10 01:58:06 +02:00
|
|
|
chop;
|
|
|
|
|
|
|
|
|
|
if ($part == 1) {
|
|
|
|
|
$text[0] .= "<H1>Part $partnum:<BR>$_";
|
|
|
|
|
last tagsw;
|
|
|
|
|
}
|
|
|
|
|
|
1995-08-29 03:02:12 +02:00
|
|
|
$href = "\"${fileroot}$st_file[$sc].html#$sc\"";
|
1995-05-10 01:58:06 +02:00
|
|
|
|
|
|
|
|
# set up headers and footers
|
|
|
|
|
if ($st_sl[$sc] > 0 && $st_sl[$sc] <= $maxlevel) {
|
|
|
|
|
$header[$st_ol[$sc]] =
|
1996-10-06 01:38:55 +02:00
|
|
|
"$doctype\n<HTML>\n<HEAD>\n<TITLE>$_</TITLE>\n</HEAD>\n$BODY\n";
|
|
|
|
|
$header[$st_ol[$sc]] .= $html_header;
|
1995-10-07 23:28:34 +01:00
|
|
|
if ($opt_ssi) { # Server Side Include hook
|
|
|
|
|
$header[$st_ol[$sc]] .=
|
|
|
|
|
"<!--#include virtual=\"./$fileroot.hdr$st_ol[$sc]\" -->";
|
|
|
|
|
}
|
1996-10-06 01:38:55 +02:00
|
|
|
$header[$st_ol[$sc]] .= "\n$navbar[$st_ol[$sc]]\n<HR NOSHADE>\n";
|
|
|
|
|
$footer[$st_ol[$sc]] = "<HR NOSHADE>\n$navbar[$st_ol[$sc]]\n";
|
|
|
|
|
$footer[$st_ol[$sc]] .= $html_footer;
|
1995-10-07 23:28:34 +01:00
|
|
|
if ($opt_ssi) { # Server Side Include hook
|
|
|
|
|
$footer[$st_ol[$sc]] .=
|
|
|
|
|
"<!--#include virtual=\"./$fileroot.ftr$st_ol[$sc]\" -->";
|
|
|
|
|
}
|
1996-03-26 14:26:53 +01:00
|
|
|
$footer[$st_ol[$sc]] .= "\n</BODY>\n</HTML>\n";
|
1995-05-10 01:58:06 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
# Add this to the master table of contents
|
1995-08-29 03:02:12 +02:00
|
|
|
print tocfile "<DD>$st_num[$sc] " .
|
1995-05-10 01:58:06 +02:00
|
|
|
"<A HREF=$href>$_";
|
|
|
|
|
|
|
|
|
|
# Calculate the <H?> level to use in the HTML file
|
|
|
|
|
$hlevel = $st_sl[$sc] - $st_ol[$sc] + 2;
|
|
|
|
|
$shlevel = $st_sl[$sc] - $st_ol[$sc] + 3;
|
|
|
|
|
|
|
|
|
|
$i = $st_ol[$sc];
|
|
|
|
|
|
|
|
|
|
# Add the section header
|
1995-08-29 03:02:12 +02:00
|
|
|
$text[$i] .= "<H$hlevel><A NAME=\"$sc\"></A>$st_num[$sc] $_";
|
1995-05-10 01:58:06 +02:00
|
|
|
$i--;
|
|
|
|
|
|
|
|
|
|
# And also to the parent
|
|
|
|
|
if ($st_sl[$sc] == $st_ol[$sc] && $i >= 0) {
|
1995-08-29 03:02:12 +02:00
|
|
|
$text[$i] .= "<H$shlevel>$st_num[$sc] " .
|
1995-05-10 01:58:06 +02:00
|
|
|
"<A HREF=$href>$_";
|
|
|
|
|
$i--;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
# and to the grandparents
|
|
|
|
|
for (; $i >= $st_pl[$sc]; $i--) {
|
|
|
|
|
$text[$i] .= "<DD>$st_num[$sc] " .
|
|
|
|
|
"<A HREF=$href>$_";
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
last tagsw;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#
|
|
|
|
|
# HEADER end
|
|
|
|
|
#
|
1995-10-07 23:28:34 +01:00
|
|
|
if (s/^<\@\@endhead>//) {
|
1995-05-10 01:58:06 +02:00
|
|
|
if ($part == 1) {
|
|
|
|
|
$text[0] .= "</H1>\n";
|
|
|
|
|
$part = 0;
|
|
|
|
|
last tagsw;
|
|
|
|
|
}
|
1996-05-15 19:05:17 +02:00
|
|
|
print tocfile "</A>\n";
|
1995-05-10 01:58:06 +02:00
|
|
|
|
|
|
|
|
$i = $st_ol[$sc];
|
|
|
|
|
|
|
|
|
|
# Close the section header
|
|
|
|
|
$text[$i] .= "</H$hlevel>\n";
|
|
|
|
|
$i--;
|
|
|
|
|
|
|
|
|
|
# in the parent...
|
|
|
|
|
if ($st_sl[$sc] == $st_ol[$sc] && $i >= 0) {
|
|
|
|
|
$text[$i] .= "</A></H$shlevel>\n";
|
|
|
|
|
$i--;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
# in the grandparent...
|
|
|
|
|
for (; $i >= $st_pl[$sc]; $i--) {
|
|
|
|
|
$text[$i] .= "</A></DD>\n";
|
|
|
|
|
}
|
|
|
|
|
last tagsw;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
# sectioning
|
1995-10-07 23:28:34 +01:00
|
|
|
if (s/^<\@\@part>//) {
|
1995-05-10 01:58:06 +02:00
|
|
|
$part = 1;
|
|
|
|
|
$partnum++;
|
|
|
|
|
last tagsw;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#
|
|
|
|
|
# BEGINNING of a section
|
|
|
|
|
#
|
1995-10-07 23:28:34 +01:00
|
|
|
if (s/^<\@\@sect>//) {
|
1995-05-10 01:58:06 +02:00
|
|
|
# Increment the section counter and save it on a stack
|
|
|
|
|
# for future reference.
|
|
|
|
|
$sc++;
|
|
|
|
|
push(@scs, $sc);
|
|
|
|
|
|
|
|
|
|
# Set up the navigation bar
|
|
|
|
|
if ($st_file[$sc] > $st_file[$sc - 1]) {
|
|
|
|
|
&navbar($st_file[$sc], $filecount, $sc);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
# Prepare for menu entries in the table of contents and
|
|
|
|
|
# parent file(s).
|
|
|
|
|
if ($st_sl[$sc - 1] < $st_sl[$sc]) {
|
|
|
|
|
print tocfile "<DL>\n";
|
|
|
|
|
$i = $st_ol[$sc] - 1 - ($st_sl[$sc] == $st_ol[$sc]);
|
|
|
|
|
for (; $i >= $st_pl[$sc]; $i--) {
|
|
|
|
|
$text[$i] .= "<DL>\n";
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
last tagsw;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#
|
|
|
|
|
# END of a section
|
|
|
|
|
#
|
1995-10-07 23:28:34 +01:00
|
|
|
if (s/^<\@\@endsect>//) {
|
1995-05-10 01:58:06 +02:00
|
|
|
|
|
|
|
|
# Remember the section number! Subsections may have
|
|
|
|
|
# altered the global $sc variable.
|
|
|
|
|
local ($lsc) = pop(@scs);
|
|
|
|
|
|
|
|
|
|
# Close off subsection menus we may have created in
|
|
|
|
|
# parent file(s).
|
|
|
|
|
if ($st_sl[$lsc] > $st_sl[$sc + 1]) {
|
|
|
|
|
print tocfile "</DL>\n";
|
1996-05-15 19:05:17 +02:00
|
|
|
if ($st_sl[$lsc] > 1) {
|
|
|
|
|
print tocfile "</DD>\n";
|
|
|
|
|
}
|
1995-05-10 01:58:06 +02:00
|
|
|
$i = $st_ol[$lsc] - 1 - ($st_sl[$lsc] == $st_ol[$lsc]);
|
|
|
|
|
for (; $i >= $st_pl[$lsc]; $i--) {
|
|
|
|
|
$text[$i] .= "</DL>\n";
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
# If this section is below $maxlevel, write it now.
|
|
|
|
|
if ($st_sl[$lsc] <= $maxlevel) {
|
1995-08-29 03:02:12 +02:00
|
|
|
open(SECOUT, ">${fileroot}$st_file[$lsc].html");
|
1995-05-10 01:58:06 +02:00
|
|
|
print SECOUT "$header[$st_ol[$lsc]] $text[$st_ol[$lsc]] " .
|
|
|
|
|
"$footer[$st_ol[$lsc]]";
|
|
|
|
|
$text[$st_ol[$lsc]] = "";
|
|
|
|
|
close(SECOUT);
|
|
|
|
|
}
|
|
|
|
|
last tagsw;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
# cross references
|
1995-10-07 23:28:34 +01:00
|
|
|
if (s/^<\@\@label>//) {
|
1995-05-10 01:58:06 +02:00
|
|
|
chop;
|
|
|
|
|
$text[$st_ol[$sc]] .= "<A NAME=\"$_\"></A>";
|
|
|
|
|
last tagsw;
|
|
|
|
|
}
|
1995-10-07 23:28:34 +01:00
|
|
|
if (s/^<\@\@ref>//) {
|
1995-05-10 01:58:06 +02:00
|
|
|
chop;
|
|
|
|
|
$refname = $_;
|
1995-06-30 17:19:12 +02:00
|
|
|
if ($references{$_} eq "") {
|
|
|
|
|
print "Warning: Reference to $_ has no defined target\n";
|
|
|
|
|
}
|
|
|
|
|
else {
|
|
|
|
|
$text[$st_ol[$sc]] .=
|
1995-08-29 03:02:12 +02:00
|
|
|
"<A HREF=\"${fileroot}$references{$_}.html#$_\">";
|
1995-06-30 17:19:12 +02:00
|
|
|
}
|
1995-05-10 01:58:06 +02:00
|
|
|
last tagsw;
|
|
|
|
|
}
|
1995-10-07 23:28:34 +01:00
|
|
|
if (s/^<\@\@endref>//) {
|
1996-09-08 22:40:52 +02:00
|
|
|
$text[$st_ol[$sc]] .= "</A>";
|
1995-05-10 01:58:06 +02:00
|
|
|
last tagsw;
|
|
|
|
|
}
|
1995-10-07 23:28:34 +01:00
|
|
|
if (s/^<\@\@refnam>//) {
|
1996-09-08 22:40:52 +02:00
|
|
|
$text[$st_ol[$sc]] .= "$refname";
|
1995-05-10 01:58:06 +02:00
|
|
|
last tagsw;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
# If nothing else did anything with this line, just print it.
|
|
|
|
|
$text[$st_ol[$sc]] .= "$_";
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
1996-03-26 14:26:53 +01:00
|
|
|
print tocfile "</HTML>\n";
|
1995-05-10 01:58:06 +02:00
|
|
|
open(SECOUT, ">$fileroot.html");
|
|
|
|
|
print SECOUT "$header[0] $text[0] $footer[0]";
|
|
|
|
|
close(SECOUT);
|
|
|
|
|
close tocfile;
|
|
|
|
|
}
|
|
|
|
|
|
1995-06-30 17:19:12 +02:00
|
|
|
# navbar
|
|
|
|
|
#
|
|
|
|
|
# Generate a navigation bar to go on the top and bottom of the page.
|
|
|
|
|
|
1995-05-10 01:58:06 +02:00
|
|
|
sub navbar {
|
|
|
|
|
local ($fnum, $fmax, $sc) = @_;
|
1995-09-22 20:24:32 +02:00
|
|
|
local ($i, $itext, $prv, $nxt, $colon);
|
|
|
|
|
|
|
|
|
|
$colon = "<b>:</b>";
|
1995-05-10 01:58:06 +02:00
|
|
|
|
1995-08-29 03:02:12 +02:00
|
|
|
# Generate the section hierarchy
|
1995-05-10 01:58:06 +02:00
|
|
|
|
1995-08-29 03:02:12 +02:00
|
|
|
$navbar[$st_ol[$sc]] =
|
1995-09-22 20:24:32 +02:00
|
|
|
"<A HREF=\"${fileroot}.html\"><EM>$st_header[0]</EM></A>\n";
|
1995-08-29 03:02:12 +02:00
|
|
|
$i = $st_parent[$sc];
|
|
|
|
|
while ($i > 0) {
|
1995-10-07 23:28:34 +01:00
|
|
|
$itext = " $colon <A HREF=\"${fileroot}$st_file[$i].html\"><EM>$st_header[$i]</EM></A>\n$itext";
|
1995-08-29 03:02:12 +02:00
|
|
|
$i = $st_parent[$i];
|
1995-05-10 01:58:06 +02:00
|
|
|
}
|
1995-09-22 20:24:32 +02:00
|
|
|
$navbar[$st_ol[$sc]] .= "$itext $colon <EM>$st_header[$sc]</EM><BR>\n";
|
1995-08-29 03:02:12 +02:00
|
|
|
|
|
|
|
|
# Generate previous and next pointers
|
|
|
|
|
|
|
|
|
|
# Previous pointer must be in a different file AND must be at the
|
|
|
|
|
# same or higher section level. If the current node is the
|
|
|
|
|
# beginning of a chapter, then previous will go to the beginning
|
|
|
|
|
# of the previous chapter, not the end of the previous chapter.
|
|
|
|
|
|
|
|
|
|
$prv = $sc;
|
|
|
|
|
while ($prv >= 0 && $st_file[$prv] >= $st_file[$sc] - 1) {
|
|
|
|
|
$prv--;
|
1995-05-10 01:58:06 +02:00
|
|
|
}
|
1995-08-29 03:02:12 +02:00
|
|
|
$prv++;
|
|
|
|
|
$navbar[$st_ol[$sc]] .=
|
1995-09-22 20:24:32 +02:00
|
|
|
"<b>Previous:</b> <A HREF=\"${fileroot}$st_file[$prv].html\"><EM>$st_header[$prv]</EM></A><BR>\n";
|
1995-08-29 03:02:12 +02:00
|
|
|
|
|
|
|
|
# Then next pointer must be in a higher numbered file OR the home
|
|
|
|
|
# page of the document.
|
|
|
|
|
|
|
|
|
|
$nxt = $sc;
|
|
|
|
|
if ($st_file[$nxt] == $filecount) {
|
|
|
|
|
$nxt = 0;
|
1995-05-10 01:58:06 +02:00
|
|
|
}
|
|
|
|
|
else {
|
1995-08-29 03:02:12 +02:00
|
|
|
while ($st_file[$nxt] == $st_file[$sc]) {
|
|
|
|
|
$nxt++;
|
|
|
|
|
}
|
1995-05-10 01:58:06 +02:00
|
|
|
}
|
1995-08-29 03:02:12 +02:00
|
|
|
|
|
|
|
|
$navbar[$st_ol[$sc]] .=
|
1995-09-22 20:24:32 +02:00
|
|
|
"<b>Next:</b> <A HREF=\"${fileroot}$st_file[$nxt].html\"><EM>$st_header[$nxt]</EM></A>\n";
|
1995-08-29 03:02:12 +02:00
|
|
|
|
1995-09-22 20:24:32 +02:00
|
|
|
$navbar[$st_ol[$sc]] .= "\n";
|
1995-08-29 03:02:12 +02:00
|
|
|
|
1995-05-10 01:58:06 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
1995-06-30 17:19:12 +02:00
|
|
|
# extlink
|
|
|
|
|
#
|
1996-09-29 19:34:05 +02:00
|
|
|
# Build a shell script to create symbolic links from the name in
|
|
|
|
|
# a reference to the numbered
|
1995-06-30 17:19:12 +02:00
|
|
|
# html file. Since the file number that any given section has is
|
|
|
|
|
# subject to change as the document goes through revisions, this allows
|
|
|
|
|
# for a fixed target that separate documents can hook into.
|
|
|
|
|
#
|
|
|
|
|
# Slashes (/) in the reference are converted to percents (%) while
|
|
|
|
|
# spaces ( ) are converted to underscores (_);
|
1995-05-10 01:58:06 +02:00
|
|
|
|
1995-06-30 17:19:12 +02:00
|
|
|
sub extlink {
|
|
|
|
|
local ($ref, $fn) = @_;
|
1995-05-10 01:58:06 +02:00
|
|
|
|
1995-06-30 17:19:12 +02:00
|
|
|
$ref =~ s/\//%/g;
|
|
|
|
|
$ref =~ s/ /_/g;
|
|
|
|
|
|
|
|
|
|
$file = "$ref.html";
|
|
|
|
|
|
1996-09-29 19:34:05 +02:00
|
|
|
if (!fileno(LINKFILE)) {
|
|
|
|
|
open(LINKFILE, ">${fileroot}.ln");
|
1995-06-30 17:19:12 +02:00
|
|
|
}
|
1996-09-29 19:34:05 +02:00
|
|
|
|
|
|
|
|
print LINKFILE "ln -fs $fn $file\n";
|
1995-06-30 17:19:12 +02:00
|
|
|
}
|
1995-05-10 01:58:06 +02:00
|
|
|
|
|
|
|
|
# Now, read the command line and take appropriate action
|
|
|
|
|
|
1995-08-31 02:14:02 +02:00
|
|
|
sub main {
|
|
|
|
|
# Check arguments
|
1996-10-06 01:38:55 +02:00
|
|
|
if (!&NGetOpt('f=s', 'links', 'ssi', 'i:s@', 'hdr=s', 'ftr=s', 'white')) {
|
1995-08-31 02:14:02 +02:00
|
|
|
&usage;
|
|
|
|
|
exit 1;
|
1995-05-10 01:58:06 +02:00
|
|
|
}
|
1995-08-31 02:14:02 +02:00
|
|
|
if (@ARGV == 0) {
|
|
|
|
|
print "An input file must be specified.\n";
|
|
|
|
|
&usage;
|
|
|
|
|
exit 1;
|
|
|
|
|
}
|
|
|
|
|
if (&getfile($ARGV[0]) == 0) {
|
|
|
|
|
print "Cannot locate specified file: $ARGV[0]\n";
|
|
|
|
|
&usage;
|
|
|
|
|
exit 1;
|
1995-05-10 01:58:06 +02:00
|
|
|
}
|
|
|
|
|
|
1995-08-31 02:14:02 +02:00
|
|
|
# Generate output
|
|
|
|
|
if ($opt_f eq 'html') {
|
1996-10-06 01:38:55 +02:00
|
|
|
if ($opt_hdr) {$html_header = &gethf($opt_hdr);}
|
|
|
|
|
if ($opt_ftr) {$html_footer = &gethf($opt_ftr);}
|
|
|
|
|
if ($opt_white) {$BODY = "<BODY text=\"#000000\" bgcolor=\"#ffffff\">";}
|
|
|
|
|
else {$BODY = "<BODY>"}
|
1996-09-08 22:40:52 +02:00
|
|
|
&gen_html();
|
1995-08-31 02:14:02 +02:00
|
|
|
}
|
1996-09-08 22:40:52 +02:00
|
|
|
elsif ($opt_f eq 'latex' || $opt_f eq 'latex') {
|
|
|
|
|
&gen_latex();
|
1995-08-31 02:14:02 +02:00
|
|
|
}
|
1996-09-08 22:40:52 +02:00
|
|
|
elsif ($opt_f eq 'roff') {
|
|
|
|
|
&gen_roff();
|
1995-08-31 02:14:02 +02:00
|
|
|
}
|
|
|
|
|
elsif ($opt_f eq 'ascii') {
|
1996-09-08 22:40:52 +02:00
|
|
|
&do_groff("ascii", "| col");
|
|
|
|
|
}
|
|
|
|
|
elsif ($opt_f eq 'latin1') {
|
|
|
|
|
&do_groff("latin1", "| col");
|
|
|
|
|
}
|
|
|
|
|
elsif ($opt_f eq 'koi8-r') {
|
|
|
|
|
&do_groff("koi8-r", "| col");
|
1995-08-31 02:14:02 +02:00
|
|
|
}
|
1996-09-08 22:40:52 +02:00
|
|
|
elsif ($opt_f eq 'ps') {
|
|
|
|
|
&do_groff("ps", "");
|
1995-05-10 01:58:06 +02:00
|
|
|
}
|
|
|
|
|
else {
|
1995-08-31 02:14:02 +02:00
|
|
|
if ($opt_f eq "") {
|
|
|
|
|
print "An output format must be specified with the -f option.\n";
|
|
|
|
|
}
|
|
|
|
|
else {
|
|
|
|
|
print "\"$opt_f\" is an unknown output format.\n";
|
|
|
|
|
}
|
|
|
|
|
&usage;
|
|
|
|
|
exit 1;
|
1995-05-10 01:58:06 +02:00
|
|
|
}
|
1995-08-31 02:14:02 +02:00
|
|
|
|
1995-05-10 01:58:06 +02:00
|
|
|
}
|
|
|
|
|
|
1995-08-31 02:14:02 +02:00
|
|
|
&main;
|
|
|
|
|
|
1995-05-10 01:58:06 +02:00
|
|
|
exit 0;
|
|
|
|
|
|
1996-10-06 01:38:55 +02:00
|
|
|
sub getdate {
|
|
|
|
|
@months = ("January", "February", "March", "April", "May","June",
|
|
|
|
|
"July", "August", "September", "October", "November", "December");
|
|
|
|
|
($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = localtime(time);
|
|
|
|
|
$year += 1900;
|
|
|
|
|
return "$months[$mon] $mday, $year";
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
sub gethf {
|
|
|
|
|
local ($file) = @_;
|
|
|
|
|
|
|
|
|
|
$date = &getdate;
|
|
|
|
|
$data = "";
|
|
|
|
|
|
|
|
|
|
if (open(IN, $file)) {
|
|
|
|
|
while (<IN>) {
|
|
|
|
|
s/\@\@UPDATE\@\@/Updated $date/;
|
|
|
|
|
$data .= $_;
|
|
|
|
|
}
|
|
|
|
|
close(IN);
|
|
|
|
|
}
|
|
|
|
|
return $data;
|
|
|
|
|
}
|
