Windows: Build Texinfo documentation as compiled HTML

This commit is contained in:
Asanka C. Herath
2010-10-14 17:30:44 -04:00
parent 9fd109a0e1
commit d98e72bc62
5 changed files with 222 additions and 0 deletions

120
cf/w32-hh-toc-from-info.pl Normal file
View File

@@ -0,0 +1,120 @@
########################################################################
#
# Copyright (c) 2010, Secure Endpoints Inc.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
#
# - Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
#
# - 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 THE COPYRIGHT HOLDERS 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 THE
# COPYRIGHT HOLDER 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.
#
use HTML::TreeBuilder;
my $input_file = "index.html";
my $toc_file = "toc.hhc";
for (@ARGV) {
ARG: {
/-o(.*)/ && do {
$toc_file = $1;
last ARG;
};
$input_file = $_;
}
}
print "Processing TOC in $input_file\n";
print "Writing to $toc_file\n";
open(TOC, '>', $toc_file) or die "Can't open $toc_file\n";
my $tree = HTML::TreeBuilder->new();
$tree->parse_file($input_file);
my $contents = $tree->look_down('class', 'contents');
my $clist = $contents->find_by_tag_name('ul');
print TOC '<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
<html>
<head>
<meta name="GENERATOR" content="Heimdal">
</head>
<body>
';
process_ul_element($clist, 0);
print TOC '
</body>
</html>
';
sub process_ul_element
{
my $e = shift;
my $level = shift;
if ($e->tag() eq "ul") {
print TOC ' 'x$level;
print TOC "<ul>\n";
my @items = $e->content_list();
for (@items) {
process_li_element($_, $level + 1);
}
print TOC ' 'x$level;
print TOC "</ul>\n";
}
}
sub process_li_element
{
my $e = shift;
my $level = shift;
if ($e->tag() eq "li") {
my $a = $e->find_by_tag_name('a');
my $href = $a->attr('href');
my @ac = $a->content_list();
my $title = $ac[0];
print TOC " "x$level;
print TOC "<li><object type=\"text/sitemap\"><param name=\"Name\" value=\"$title\"><param name=\"Local\" value=\"$href\"></object>\n";
my @items = $e->content_list();
for (@items) {
process_ul_element($_, $level + 1);
}
}
}

View File

@@ -33,3 +33,85 @@ RELDIR=doc
!include ../windows/NTMakefile.w32
heimdal_TEXINFOS = \
$(OBJ)\ack.texi \
$(OBJ)\apps.texi \
$(OBJ)\copyright.texi \
$(OBJ)\heimdal.texi \
$(OBJ)\install.texi \
$(OBJ)\intro.texi \
$(OBJ)\kerberos4.texi \
$(OBJ)\migration.texi \
$(OBJ)\misc.texi \
$(OBJ)\programming.texi \
$(OBJ)\setup.texi \
$(OBJ)\vars.texi \
$(OBJ)\whatis.texi \
$(OBJ)\win2k.texi
hx509_TEXINFOS = \
$(OBJ)\hx509.texi
{}.texi{$(OBJ)}.texi:
$(CP) $** $@
{}.tin{$(OBJ)}.texi:
$(SED) -e "s,[@]dbdir[@],x,g" \
-e "s,[@]PACKAGE_VERSION[@],$(VER_PACKAGE_VERSION),g" < $** > $@
MAKEINFOFLAGS = --css-include=$(SRCDIR)/heimdal.css
######################################################################
# Build heimdal.chm
# Copyrights-and-Licenses.html is where the table of contents ends up
# when generating HTML output using makeinfo. Same goes for
# How-to-use-the-PKCS11-module.html below.
$(OBJ)\heimdal\index.html $(OBJ)\heimdal\Copyrights-and-Licenses.html: $(heimdal_TEXINFOS)
cd $(OBJ)
$(MAKEINFO) $(MAKEINFOFLAGS) --html heimdal.texi
cd $(SRCDIR)
$(OBJ)\heimdal\toc.hhc: $(OBJ)\heimdal\Copyrights-and-Licenses.html
$(PERL) $(SRC)\cf\w32-hh-toc-from-info.pl -o$@ $**
$(OBJ)\heimdal\heimdal.hhp: heimdal.hhp
$(CP) $** $@
$(DOCDIR)\heimdal.chm: $(OBJ)\heimdal\heimdal.hhp $(OBJ)\heimdal\toc.hhc
cd $(OBJ)\heimdal
-$(HHC) heimdal.hhp
$(CP) heimdal.chm $@
cd $(SRCDIR)
######################################################################
# Build hx509.chm
$(OBJ)\hx509\index.html $(OBJ)\hx509\How-to-use-the-PKCS11-module.html: $(hx509_TEXINFOS)
cd $(OBJ)
$(MAKEINFO) $(MAKEINFOFLAGS) --html hx509.texi
cd $(SRCDIR)
$(OBJ)\hx509\toc.hhc: $(OBJ)\hx509\How-to-use-the-PKCS11-module.html
$(PERL) $(SRC)\cf\w32-hh-toc-from-info.pl -o$@ $**
$(OBJ)\hx509\hx509.hhp: hx509.hhp
$(CP) $** $@
$(DOCDIR)\hx509.chm: $(OBJ)\hx509\hx509.hhp $(OBJ)\hx509\toc.hhc
cd $(OBJ)\hx509
-$(HHC) hx509.hhp
$(CP) hx509.chm $@
cd $(SRCDIR)
all:: $(OBJ)\heimdal\index.html $(OBJ)\hx509\index.html \
$(DOCDIR)\heimdal.chm $(DOCDIR)\hx509.chm
clean::
-$(RM) $(OBJ)\heimdal\*.*
-$(RM) $(OBJ)\hx509\*.*
-$(RM) $(DOCDIR)\heimdal.chm
-$(RM) $(DOCDIR)\hx509.chm
.SUFFIXES: .texi .tin

8
doc/heimdal.hhp Normal file
View File

@@ -0,0 +1,8 @@
[OPTIONS]
Compatibility=1.1 or later
Compiled file=heimdal.chm
Contents file=toc.hhc
Default topic=index.html
Display compile progress=No
Language=0x409 English (United States)
Title=Heimdal

8
doc/hx509.hhp Normal file
View File

@@ -0,0 +1,8 @@
[OPTIONS]
Compatibility=1.1 or later
Compiled file=hx509.chm
Contents file=toc.hhc
Default topic=index.html
Display compile progress=No
Language=0x409 English (United States)
Title=HX509

View File

@@ -78,6 +78,7 @@ OBJDIR =$(SRC)\out\obj_$(OUTDIR)
INCDIR =$(DESTDIR)\inc
LIBDIR =$(DESTDIR)\lib
BINDIR =$(DESTDIR)\bin
DOCDIR =$(DESTDIR)\doc
SBINDIR =$(BINDIR)
LIBEXECDIR =$(BINDIR)
ASMDIR =$(BINDIR)
@@ -372,6 +373,9 @@ mkdirs:
! if !exist($(INCDIR))
$(MKDIR) $(INCDIR)
! endif
! if !exist($(DOCDIR))
$(MKDIR) $(DOCDIR)
! endif
! if !exist($(INCDIR)\gssapi)
$(MKDIR) $(INCDIR)\gssapi
! endif