-#!/usr/bin/perl
+#!/usr/bin/env perl
+#
use strict;
use warnings;
-use CSS::Minifier::XS;
+
+use CSS::Minifier::XS 0.07;
use File::Copy;
use File::Find;
+use File::Path qw(make_path);
use File::Slurp;
use File::Spec;
use Getopt::Long;
use JavaScript::Minifier::XS;
+use Pod::Usage;
use XML::LibXML;
use XML::LibXSLT;
## Parse arguments
my %opt = parse_arguments();
+## setup static root location
+## TODO: for doc generation only this should be within the docs dir
+$opt{staticroot} = File::Spec->catdir( $opt{docroot}, 'static' );
+
## Generate the pages
+my %cache; # General cache object
do_doc( 'spec', $_ ) foreach @{ $opt{spec} || [] };
do_doc( 'filter', $_ ) foreach @{ $opt{filter} || [] };
-do_web() if exists $opt{web};
+do_web() if ( $opt{web} );
+do_static() if ( $opt{web} or !$opt{localstatic} ); # need this for all other pages generated
## Add the exim-html-current symlink
-print "Symlinking exim-html-current to exim-html-$opt{latest}\n";
-symlink( "$opt{docroot}/exim-html-$opt{latest}", "$opt{docroot}/exim-html-current" );
+print "Symlinking exim-html-current to exim-html-$opt{latest}\n" if ( $opt{verbose} );
+unlink("$opt{docroot}/exim-html-current") if ( -l "$opt{docroot}/exim-html-current" );
+symlink( "exim-html-$opt{latest}", "$opt{docroot}/exim-html-current" )
+ || die "symlink to $opt{docroot}/exim-html-current failed";
+# ------------------------------------------------------------------
## Generate the website files
sub do_web {
+ ## copy these templates to docroot...
+ copy_transform_files( "$opt{tmpl}/web", $opt{docroot}, 0 );
+}
+
+# ------------------------------------------------------------------
+## Generate the static file set
+sub do_static {
+ my $staticroot = shift || $opt{staticroot};
+
+ ## make sure I have a directory
+ mkdir($staticroot) or die "Unable to make staticroot: $!\n" unless ( -d $staticroot );
+
+ ## copy these templates to docroot...
+ copy_transform_files( "$opt{tmpl}/static", $staticroot, 1 );
+}
+
+# ------------------------------------------------------------------
+## Generate the website files
+sub copy_transform_files {
+ my $source = shift;
+ my $target = shift;
+ my $static = shift;
+
## Make sure the template web directory exists
- die "No such directory: $opt{tmpl}/web\n" unless -d "$opt{tmpl}/web";
+ die "No such directory: $source\n" unless ( -d $source );
## Scan the web templates
find(
sub {
- my ($path) = substr( $File::Find::name, length("$opt{tmpl}/web"), length($File::Find::name) ) =~ m#^/*(.*)$#;
+ my ($path) = substr( $File::Find::name, length("$source"), length($File::Find::name) ) =~ m#^/*(.*)$#;
- if ( -d "$opt{tmpl}/web/$path" ) {
+ if ( -d "$source/$path" ) {
- ## Create the directory in the doc root if it doesn't exist
- if ( !-d "$opt{docroot}/$path" ) {
- mkdir("$opt{docroot}/$path") or die "Unable to make $opt{docroot}/$path: $!\n";
+ ## Create the directory in the target if it doesn't exist
+ if ( !-d "$target/$path" ) {
+ mkdir("$target/$path") or die "Unable to make $target/$path: $!\n";
}
}
else {
## Build HTML from XSL files and simply copy static files which have changed
- if ( $path =~ /(.+)\.xsl$/ ) {
- print "Generating : docroot:/$1.html\n";
- transform( undef, "$opt{tmpl}/web/$path", "$opt{docroot}/$1.html" );
+ if ( ( !$static ) and ( $path =~ /(.+)\.xsl$/ ) ) {
+ print "Generating : /$1.html\n" if ( $opt{verbose} );
+ transform( undef, "$source/$path", "$target/$1.html" );
}
- elsif ( -f "$opt{tmpl}/web/$path" ) {
+ elsif ( -f "$source/$path" ) {
- ## Skip if the file hasn't changed (mtime based)
- return if -f "$opt{docroot}/$path" && ( stat("$opt{tmpl}/web/$path") )[9] == ( stat("$opt{docroot}/$path") )[9];
+ ## Skip if the file hasn't changed (mtime/size based)
+ return
+ if (( -f "$target/$path" )
+ and ( ( stat("$source/$path") )[9] == ( stat("$target/$path") )[9] )
+ and ( ( stat("$source/$path") )[7] == ( stat("$target/$path") )[7] ) );
if ( $path =~ /(.+)\.css$/ ) {
- print "CSS to : docroot:/$path\n";
- my $content = read_file("$opt{tmpl}/web/$path");
- write_file( "$opt{docroot}/$path", $opt{minify} ? CSS::Minifier::XS::minify($content) : $content );
+ print "CSS to : /$path\n" if ( $opt{verbose} );
+ my $content = read_file("$source/$path");
+ write_file( "$target/$path", $opt{minify} ? CSS::Minifier::XS::minify($content) : $content );
}
elsif ( $path =~ /(.+)\.js$/ ) {
- print "JS to : docroot:/$path\n";
- my $content = read_file("$opt{tmpl}/web/$path");
- write_file( "$opt{docroot}/$path", $opt{minify} ? JavaScript::Minifier::XS::minify($content) : $content );
+ print "JS to : /$path\n" if ( $opt{verbose} );
+ my $content = read_file("$source/$path");
+ write_file( "$target/$path",
+ $opt{minify} ? JavaScript::Minifier::XS::minify($content) : $content );
}
else {
## Copy
- print "Copying to : docroot:/$path\n";
- copy( "$opt{tmpl}/web/$path", "$opt{docroot}/$path" ) or die "$path: $!";
+ print "Copying to : /$path\n" if ( $opt{verbose} );
+ copy( "$source/$path", "$target/$path" ) or die "$path: $!";
}
## Set mtime
- utime( time, ( stat("$opt{tmpl}/web/$path") )[9], "$opt{docroot}/$path" );
+ utime( time, ( stat("$source/$path") )[9], "$target/$path" );
}
}
},
- "$opt{tmpl}/web"
+ "$source"
);
}
+# ------------------------------------------------------------------
## Generate index/chapter files for a doc
sub do_doc {
my ( $type, $xml_path ) = @_;
## Add the canonical url for this document
$xml->documentElement()
- ->appendTextChild( 'canonical_url',
+ ->appendTextChild( 'canonical_url',
"${canonical_url}exim-html-current/doc/html/spec_html/" . ( $type eq 'spec' ? 'index' : 'filter' ) . ".html" );
+ ## Add a url for the latest version of this document
+ if ( $version ne $opt{latest} ) {
+ $xml->documentElement()
+ ->appendTextChild( 'current_url',
+ "../../../../exim-html-current/doc/html/spec_html/" . ( $type eq 'spec' ? 'index' : 'filter' ) . ".html" );
+ }
+
## Fixup the XML
xref_fixup( $xml, $prepend_chapter );
+ ## set the staticroot
+ my $staticroot =
+ $opt{localstatic}
+ ? File::Spec->catdir( $opt{docroot}, "exim-html-$version", 'doc', 'html', 'static' )
+ : $opt{staticroot};
+ unless ( -d $staticroot ) {
+ make_path( $staticroot, { verbose => $opt{verbose} } );
+ do_static($staticroot);
+ }
+
## Generate the front page
{
my $path = "exim-html-$version/doc/html/spec_html/" . ( $type eq 'filter' ? $type : 'index' ) . ".html";
- print "Generating : docroot:/$path\n";
- transform( $xml, "$opt{tmpl}/doc/index.xsl", "$opt{docroot}/$path", );
+ print "Generating : docroot:/$path\n" if ( $opt{verbose} );
+ transform( $xml, "$opt{tmpl}/doc/index.xsl", "$opt{docroot}/$path", $staticroot );
}
## Generate a Table of Contents XML file
{
- my $path = "exim-html-$version/doc/html/spec_html/" . ( $type eq 'filter' ? 'filter_toc' : 'index_toc' ) . ".xml";
- print "Generating : docroot:/$path\n";
- transform( $xml, "$opt{tmpl}/doc/toc.xsl", "$opt{docroot}/$path", );
+ my $path =
+ "exim-html-$version/doc/html/spec_html/" . ( $type eq 'filter' ? 'filter_toc' : 'index_toc' ) . ".xml";
+ print "Generating : docroot:/$path\n" if ( $opt{verbose} );
+ transform( $xml, "$opt{tmpl}/doc/toc.xsl", "$opt{docroot}/$path", $staticroot );
}
## Generate the chapters
my $counter = 0;
- foreach my $chapter ( map { $_->cloneNode(1) } $xml->findnodes('/book/chapter') ) {
+ my @chapters = map { $_->cloneNode(1) } $xml->findnodes('/book/chapter');
+ foreach my $chapter (@chapters) {
## Add a <chapter_id>N</chapter_id> node for the stylesheet to use
$chapter->appendTextChild( 'chapter_id', ++$counter );
$chapter->appendTextChild( 'prev_url',
$counter == 1
? $type eq 'filter'
- ? 'filter.html'
- : 'index.html'
+ ? 'filter.html'
+ : 'index.html'
: sprintf( '%sch%02d.html', $prepend_chapter, $counter - 1 ) );
- $chapter->appendTextChild( 'next_url', sprintf( '%sch%02d.html', $prepend_chapter, $counter + 1 ) );
- $chapter->appendTextChild( 'canonical_url',
- sprintf( 'http://www.exim.org/exim-html-current/doc/html/spec_html/%sch%02d.html', $prepend_chapter, $counter ) );
+ $chapter->appendTextChild( 'next_url', sprintf( '%sch%02d.html', $prepend_chapter, $counter + 1 ) )
+ unless int(@chapters) == $counter;
+ $chapter->appendTextChild( 'toc_url', ( $type eq 'filter' ? 'filter' : 'index' ) . '.html' );
+ $chapter->appendTextChild(
+ 'canonical_url',
+ sprintf(
+ 'http://www.exim.org/exim-html-current/doc/html/spec_html/%sch%02d.html',
+ $prepend_chapter, $counter
+ )
+ );
+ if ( $version ne $opt{latest} ) {
+ $chapter->appendTextChild(
+ 'current_url',
+ sprintf(
+ '../../../../exim-html-current/doc/html/spec_html/%sch%02d.html',
+ $prepend_chapter, $counter
+ )
+ );
+ }
}
## Create an XML document from the chapter
## Transform the chapter into html
{
my $path = sprintf( 'exim-html-%s/doc/html/spec_html/%sch%02d.html', $version, $prepend_chapter, $counter );
- print "Generating : docroot:/$path\n";
- transform( $doc, "$opt{tmpl}/doc/chapter.xsl", "$opt{docroot}/$path", );
+ print "Generating : docroot:/$path\n" if ( $opt{verbose} );
+ transform( $doc, "$opt{tmpl}/doc/chapter.xsl", "$opt{docroot}/$path", $staticroot );
}
}
}
+# ------------------------------------------------------------------
## Fixup xref tags
sub xref_fixup {
my ( $xml, $prepend_chapter ) = @_;
if ( exists $index{$linkend} ) {
$xref->setAttribute( 'chapter_id', $index{$linkend}{'chapter_id'} );
$xref->setAttribute( 'chapter_title', $index{$linkend}{'chapter_title'} );
- $xref->setAttribute( 'section_id', $index{$linkend}{'section_id'} ) if ( $index{$linkend}{'section_id'} );
- $xref->setAttribute( 'section_title', $index{$linkend}{'section_title'} ) if ( $index{$linkend}{'section_title'} );
+ $xref->setAttribute( 'section_id', $index{$linkend}{'section_id'} ) if ( $index{$linkend}{'section_id'} );
+ $xref->setAttribute( 'section_title', $index{$linkend}{'section_title'} )
+ if ( $index{$linkend}{'section_title'} );
$xref->setAttribute( 'url',
sprintf( '%sch%02d.html', $prepend_chapter, $index{$linkend}{'chapter_id'} )
- . ( $index{$linkend}{'section_id'} ? '#' . $linkend : '' ) );
+ . ( $index{$linkend}{'section_id'} ? '#' . $linkend : '' ) );
}
}
}
+# ------------------------------------------------------------------
## Build indexes
sub build_indexes {
my ( $xml, $prepend_chapter, $xref ) = @_;
if ( $node->nodeName eq 'indexterm' ) {
my $role = $node->getAttribute('role') || 'concept';
my $primary = $node->findvalue('child::primary');
- my $first = ( $primary =~ /^[A-Za-z]/ ) ? uc( substr( $primary, 0, 1 ) ) : ''; # first letter or marker
+ my $first = ( $primary =~ /^[A-Za-z]/ ) ? uc( substr( $primary, 0, 1 ) ) : ''; # first letter or marker
my $secondary = $node->findvalue('child::secondary') || '';
- next unless ( $primary || $secondary ); # skip blank entries for now...
+ next unless ( $primary || $secondary ); # skip blank entries for now...
$index_hash->{$role}{$first}{$primary}{$secondary} ||= [];
push @{ $index_hash->{$role}{$first}{$primary}{$secondary} }, $current_id;
}
foreach my $role ( sort { $a cmp $b } keys %{$index_hash} ) {
my $chapter = XML::LibXML::Element->new('chapter');
$book->appendChild($chapter);
- $chapter->setAttribute( 'id', 'index_' . $role );
+ $chapter->setAttribute( 'id', join( '_', 'index', $role ) );
+ $chapter->setAttribute( 'class', 'index' );
$chapter->appendTextChild( 'title', ( ucfirst($role) . ' Index' ) );
foreach my $first ( sort { $a cmp $b } keys %{ $index_hash->{$role} } ) {
my $section = XML::LibXML::Element->new('section');
my $list = XML::LibXML::Element->new('variablelist');
$chapter->appendChild($section);
- $section->setAttribute( 'id', 'index_' . $role . '_' . $first );
+ $section->setAttribute( 'id', join( '_', 'index', $role, $first ) );
+ $section->setAttribute( 'class', 'index' );
$section->appendTextChild( 'title', $first ? $first : 'Symbols' );
$section->appendChild($list);
foreach my $primary ( sort { $a cmp $b } keys %{ $index_hash->{$role}{$first} } ) {
my $count = 0;
foreach my $ref ( @{ $index_hash->{$role}{$first}{$primary}{$secondary} } ) {
$para->appendText(', ')
- if ( $count++ );
+ if ( $count++ );
my $xrefel = XML::LibXML::Element->new('xref');
$xrefel->setAttribute( linkend => $ref );
$xrefel->setAttribute( longref => 1 );
}
}
+# ------------------------------------------------------------------
## Handle the transformation
sub transform {
- my ( $xml, $xsl_path, $out_path ) = @_;
+ my ( $xml, $xsl_path, $out_path, $staticroot_abs ) = @_;
+
+ ## make sure $staticroot is set
+ $staticroot_abs ||= $opt{staticroot};
## Build an empty XML structure if an undefined $xml was passed
unless ( defined $xml ) {
## Add the current version of Exim to the XML
$xml->documentElement()->appendTextChild( 'current_version', $opt{latest} );
+ ## Add the old versions of Exim to the XML
+ $xml->documentElement()->appendTextChild( 'old_versions', $_ ) foreach old_docs_versions();
+
## Parse the ".xsl" file as XML
my $xsl = XML::LibXML->new()->parse_file($xsl_path) or die $!;
## Generate a stylesheet from the ".xsl" XML.
my $stylesheet = XML::LibXSLT->new()->parse_stylesheet($xsl);
+ ## work out the static root relative to the target
+ my $target_dir = ( File::Spec->splitpath($out_path) )[1];
+ my $staticroot = File::Spec->abs2rel( $staticroot_abs, $target_dir );
+
## Generate a doc from the XML transformed with the XSL
- my $doc = $stylesheet->transform($xml);
+ my $doc = $stylesheet->transform( $xml, staticroot => sprintf( "'%s'", $staticroot ) );
## Make the containing directory if it doesn't exist
- mkdirp( ( $out_path =~ /^(.+)\/.+$/ )[0] );
+ make_path( ( $out_path =~ /^(.+)\/.+$/ )[0], { verbose => $opt{verbose} } );
## Write out the document
- open my $out, '>', $out_path or die $!;
+ open my $out, '>', $out_path or die "Unable to write $out_path - $!";
print $out $stylesheet->output_as_bytes($doc);
close $out;
}
-## "mkdir -p "
-sub mkdirp {
- my $path = shift;
-
- my @parts = ();
- foreach ( split( /\//, $path ) ) {
- push @parts, $_;
- my $make = join( '/', @parts );
- next unless length($make);
- next if -d $make;
- mkdir($make) or die "Unable to mkdir $make: $!\n";
+# ------------------------------------------------------------------
+## Look in the docroot for old versions of the documentation
+sub old_docs_versions {
+ if ( !exists $cache{old_docs_versions} ) {
+ my @versions;
+ foreach ( glob("$opt{docroot}/exim-html-*") ) {
+ push @versions, $1 if /-(\d+(?:\.\d+)?)$/ && $1 lt $opt{latest} && -d $_;
+ }
+ $cache{old_docs_versions} = [ reverse sort { $a cmp $b } @versions ];
}
+ return @{ $cache{old_docs_versions} };
+}
+
+# ------------------------------------------------------------------
+## error_help
+sub error_help {
+ my $msg = shift;
+
+ warn $msg;
+ pod2usage( -exitval => 1, -verbose => 0 );
}
+# ------------------------------------------------------------------
## Parse arguments
sub parse_arguments {
- my %opt = ( spec => [], filter => [], help => 0, web => 0, minify => 1 );
- GetOptions( \%opt, 'help|h!', 'web!', 'spec=s{1,}', 'filter=s{1,}', 'latest=s', 'tmpl=s', 'docroot=s', 'minify!' )
- || help( 1, 'Bad options' );
+ my %opt = ( spec => [], filter => [], help => 0, man => 0, web => 0, minify => 1, verbose => 0, localstatic => 0 );
+ GetOptions(
+ \%opt, 'help|h!', 'man!', 'web!', 'spec=s{1,}', 'filter=s{1,}',
+ 'latest=s', 'tmpl=s', 'docroot=s', 'minify!', 'verbose!', 'localstatic!'
+ ) || pod2usage( -exitval => 1, -verbose => 0 );
## --help
- help(0) if ( $opt{help} );
+ pod2usage(0) if ( $opt{help} );
+ pod2usage( -verbose => 2 ) if ( $opt{man} );
## --spec and --filter lists
foreach my $set (qw[spec filter]) {
- $opt{$set} = [ map { my $f = File::Spec->rel2abs($_); help( 1, 'No such file: ' . $_ ) unless -f $f; $f } @{ $opt{$set} } ];
+ $opt{$set} =
+ [ map { my $f = File::Spec->rel2abs($_); error_help( 1, 'No such file: ' . $_ ) unless -f $f; $f }
+ @{ $opt{$set} } ];
}
## --latest
- help( 1, 'Missing value for latest' ) unless ( exists( $opt{latest} ) && defined( $opt{latest} ) );
- help( 1, 'Invalid value for latest' ) unless $opt{latest} =~ /^\d+(?:\.\d+)*$/;
+ error_help('Missing value for latest') unless ( exists( $opt{latest} ) && defined( $opt{latest} ) );
+ error_help('Invalid value for latest') unless $opt{latest} =~ /^\d+(?:\.\d+)*$/;
## --tmpl and --docroot
foreach my $set (qw[tmpl docroot]) {
- help( 1, 'Missing value for ' . $set ) unless ( exists( $opt{$set} ) && defined( $opt{$set} ) );
+ error_help( 'Missing value for ' . $set ) unless ( exists( $opt{$set} ) && defined( $opt{$set} ) );
my $f = File::Spec->rel2abs( $opt{$set} );
- help( 1, 'No such directory: ' . $opt{$set} ) unless -d $f;
+ error_help( 'No such directory: ' . $opt{$set} ) unless -d $f;
$opt{$set} = $f;
}
- help( 1, 'Excess arguments' ) if ( scalar(@ARGV) );
+ error_help('Excess arguments') if ( scalar(@ARGV) );
- help( 1, 'Must include at least one of --web, --spec or --filter' )
- unless ( defined $opt{web} || scalar( @{ $opt{spec} } ) || scalar( @{ $opt{web} } ) );
+ error_help('Must include at least one of --web, --spec or --filter')
+ unless ( $opt{web} || scalar( @{ $opt{spec} || [] } ) || scalar( @{ $opt{filter} || [] } ) );
return %opt;
}
-## Help information
-sub help {
- my ( $exit_code, $msg ) = @_;
+# ------------------------------------------------------------------
+1;
- print "$msg\n\n" if defined $msg;
+__END__
- print << "END_HELP";
-Options:
- --help or -h : Print this help information and then exit
+=head1 NAME
- --web : Generate the general website pages
- --spec PATH : Generate the spec pages. PATH is the path to the spec.xml
- --filter PATH : Generate the filter pages. PATH is the path to the filter.xml
+gen.pl - Generate exim html documentation and website
- One or more of the above three options are required. --spec and --filter can
- take multiple values to generate different sets of documentation for
- different versions at the same time.
+=head1 SYNOPSIS
- --latest VERSION : Required. Specify the latest stable version of Exim.
- --tmpl PATH : Required. Path to the templates directory
- --docroot PATH : Required. Path to the website document root
+gen.pl [options]
- If CSS::Minifier::XS is installed, then CSS will be minified.
- If JavaScript::Minifier::XS is installed, then JavaScript will be minified.
+ Options:
+ --help display this help and exits
+ --man displays man page
+ --spec file... spec docbook/XML source files
+ --filter file... filter docbook/XML source files
+ --web Generate the general website pages
+ --latest VERSION Required. Specify the latest stable version of Exim.
+ --tmpl PATH Required. Path to the templates directory
+ --docroot PATH Required. Path to the website document root
+ --[no-]minify [Don't] minify CSS and Javascript
+ --localstatic Makes the static files local to each doc ver
-Example:
+=head1 OPTIONS
- ./gen.pl --latest 4.72
- --web
- --spec spec.xml 4.71/spec.xml
- --filter filter.xml 4.71/filter.xml
- --tmpl ~/www/templates
- --docroot ~/www/docroot
-END_HELP
+=over 4
- exit($exit_code);
-}
+=item B<--help>
+
+Display help and exits
+
+=item B<--man>
+
+Display man page
+
+=item B<--spec> I<file...>
+
+List of files that make up the specification documentation docbook/XML source
+files.
+
+=item B<--filter> I<file...>
+
+List of files that make up the filter documentation docbook/XML source files.
+
+=item B<--web>
+
+Generate the website from the template files.
+
+=item B<--latest> I<version>
+
+Specify the current exim version. This is used to create links to the current
+documentation.
+
+This option is I<required>
+
+=item B<--tmpl> I<directory>
+
+Specify the directory that the templates are kept in.
+
+This option is I<required>
+
+=item B<--docroot> I<directory>
+
+Specify the directory that the output should be generated into. This is the
+website C<docroot> directory.
+
+This option is I<required>
+
+=item B<--minify>
+
+If this option is set then both the CSS and Javascript files processed are
+minified using L<CSS::Minifier::XS> and L<JavaScript::Minifier::XS>
+respectively.
+
+This option is set by default - to disable it specify C<--no-minify>
+
+=item B<--localstatic>
+
+Makes the static files (CSS, images etc), local for each version of the
+documentation. This is more suitable for packaged HTML documentation.
+
+=back
+
+=head1 DESCRIPTION
+
+Generates the exim website and HTML documentation.
+
+=head1 EXAMPLE
+
+ script/gen.pl \
+ --web \
+ --spec docbook/*/spec.xml \
+ --filter docbook/*/filter.xml \
+ --latest 4.72 \
+ --tmpl templates \
+ --docroot /tmp/website
+
+=head1 AUTHOR
+
+Mike Cardwell
+
+Nigel Metheringham <nigel@exim.org> - mostly broke the framework Mike produced.
+
+=head1 COPYRIGHT
+
+Copyright 2010-2012 Exim Maintainers. All rights reserved.
+
+=cut
git://git.exim.org / exim-website.git / blobdiff