Don't display a "Next" link when we get to the last page in the
[exim-website.git] / script / gen.pl
index d6ebf006bcc3a335a935219331ec26bd281f1433..ac3d3d605d646891eff10d17f2cfcc3ebf0a8c80 100755 (executable)
-#!/usr/bin/perl
+#!/usr/bin/env perl
+#
 use strict;
 use warnings;
 use strict;
 use warnings;
+
+use CSS::Minifier::XS 0.07;
 use File::Copy;
 use File::Find;
 use File::Copy;
 use File::Find;
+use File::Path qw(make_path);
+use File::Slurp;
 use File::Spec;
 use File::Spec;
+use Getopt::Long;
+use JavaScript::Minifier::XS;
+use Pod::Usage;
 use XML::LibXML;
 use XML::LibXSLT;
 
 my $canonical_url = 'http://www.exim.org/';
 
 ## Parse arguments
 use XML::LibXML;
 use XML::LibXSLT;
 
 my $canonical_url = 'http://www.exim.org/';
 
 ## Parse arguments
-  my %opt = parse_arguments();
+my %opt = parse_arguments();
 
 ## Generate the pages
 
 ## Generate the pages
-  do_doc( 'spec',   $_ ) foreach @{$opt{spec}||[]};
-  do_doc( 'filter', $_ ) foreach @{$opt{filter}||[]};
-  do_web(              ) if exists $opt{web};
+do_doc( 'spec',   $_ ) foreach @{ $opt{spec}   || [] };
+do_doc( 'filter', $_ ) foreach @{ $opt{filter} || [] };
+do_web() if exists $opt{web};
 
 ## Add the exim-html-current symlink
 
 ## 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";
+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
 
 ## Generate the website files
-  sub do_web {
-
-     ## Make sure the template web directory exists
-       die "No such directory: $opt{tmpl}/web\n" unless -d "$opt{tmpl}/web";
-
-     ## Scan the web templates
-       find(sub{
-          my( $path ) = substr( $File::Find::name, length("$opt{tmpl}/web"), length($File::Find::name) ) =~ m#^/*(.*)$#;
+sub do_web {
 
 
-          if( -d "$opt{tmpl}/web/$path" ){
+    ## Make sure the template web directory exists
+    die "No such directory: $opt{tmpl}/web\n" unless -d "$opt{tmpl}/web";
 
 
-             ## 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";
-               }
+    ## Scan the web templates
+    find(
+        sub {
+            my ($path) =
+                substr( $File::Find::name, length("$opt{tmpl}/web"), length($File::Find::name) ) =~ m#^/*(.*)$#;
 
 
-          } else {
+            if ( -d "$opt{tmpl}/web/$path" ) {
 
 
-             ## 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" );
-               } elsif( -f "$opt{tmpl}/web/$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];
+                ## 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";
+                }
 
 
-                  ## Copy
-                    print "Copying to  : docroot:/$path\n";
-                    copy( "$opt{tmpl}/web/$path", "$opt{docroot}/$path" ) or die "$path: $!";
+            }
+            else {
 
 
-                  ## Set mtime
-                    utime( time, (stat("$opt{tmpl}/web/$path"))[9], "$opt{docroot}/$path" );
-               }
-          }
+                ## Build HTML from XSL files and simply copy static files which have changed
+                if ( $path =~ /(.+)\.xsl$/ ) {
+                    print "Generating  : docroot:/$1.html\n" if ( $opt{verbose} );
+                    transform( undef, "$opt{tmpl}/web/$path", "$opt{docroot}/$1.html" );
+                }
+                elsif ( -f "$opt{tmpl}/web/$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];
+
+                    if ( $path =~ /(.+)\.css$/ ) {
+                        print "CSS to  : docroot:/$path\n" if ( $opt{verbose} );
+                        my $content = read_file("$opt{tmpl}/web/$path");
+                        write_file( "$opt{docroot}/$path",
+                            $opt{minify} ? CSS::Minifier::XS::minify($content) : $content );
+                    }
+                    elsif ( $path =~ /(.+)\.js$/ ) {
+                        print "JS to  : docroot:/$path\n" if ( $opt{verbose} );
+                        my $content = read_file("$opt{tmpl}/web/$path");
+                        write_file( "$opt{docroot}/$path",
+                            $opt{minify} ? JavaScript::Minifier::XS::minify($content) : $content );
+                    }
+                    else {
+                        ## Copy
+                        print "Copying to  : docroot:/$path\n" if ( $opt{verbose} );
+                        copy( "$opt{tmpl}/web/$path", "$opt{docroot}/$path" ) or die "$path: $!";
+                    }
+                    ## Set mtime
+                    utime( time, ( stat("$opt{tmpl}/web/$path") )[9], "$opt{docroot}/$path" );
+                }
+            }
 
 
-       }, "$opt{tmpl}/web");
-  }
+        },
+        "$opt{tmpl}/web"
+    );
+}
 
 ## Generate index/chapter files for a doc
 
 ## Generate index/chapter files for a doc
-  sub do_doc {
-     my( $type, $xml_path ) = @_;
-
-     ## Read and validate the XML file
-       my $xml = XML::LibXML->new()->parse_file( $xml_path ) or die $!;
-
-     ## Get the version number
-       my $version = $xml->findvalue('/book/bookinfo/revhistory/revision/revnumber');
-       die "Unable to get version number\n" unless defined $version && $version =~ /^\d+(\.\d+)*$/;
-
-     ## Prepend chapter filenames?
-       my $prepend_chapter = $type eq 'filter' ? 'filter_' : '';
-
-     ## Add the canonical url for this document
-       $xml->documentElement()->appendTextChild('canonical_url',"${canonical_url}exim-html-current/doc/html/spec_html/".($type eq 'spec'?'index':'filter').".html");
-
-     ## Fixup the XML
-       xref_fixup( $xml, $prepend_chapter );
-
-     ## 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",
-          );
-       }
-
-     ## 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",
-          );
-       }
-
-     ## Generate the chapters
-       my $counter = 0;
-       foreach my $chapter ( map {$_->cloneNode(1)} $xml->findnodes('/book/chapter') ){
-
-          ## Add a <chapter_id>N</chapter_id> node for the stylesheet to use
-            $chapter->appendTextChild( 'chapter_id', ++$counter );
-
-          ## Add previous/next/canonical urls for nav
-            {
-               $chapter->appendTextChild( 'prev_url',
+sub do_doc {
+    my ( $type, $xml_path ) = @_;
+
+    ## Read and validate the XML file
+    my $xml = XML::LibXML->new()->parse_file($xml_path) or die $!;
+
+    ## Get the version number
+    my $version = $xml->findvalue('/book/bookinfo/revhistory/revision/revnumber');
+    die "Unable to get version number\n" unless defined $version && $version =~ /^\d+(\.\d+)*$/;
+
+    ## Prepend chapter filenames?
+    my $prepend_chapter = $type eq 'filter' ? 'filter_' : '';
+
+    ## Add the canonical url for this document
+    $xml->documentElement()
+        ->appendTextChild( 'canonical_url',
+        "${canonical_url}exim-html-current/doc/html/spec_html/" . ( $type eq 'spec' ? 'index' : 'filter' ) . ".html" );
+
+    ## Fixup the XML
+    xref_fixup( $xml, $prepend_chapter );
+
+    ## 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", );
+    }
+
+    ## 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" if ( $opt{verbose} );
+        transform( $xml, "$opt{tmpl}/doc/toc.xsl", "$opt{docroot}/$path", );
+    }
+
+    ## Generate the chapters
+    my $counter = 0;
+    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 );
+
+        ## Add previous/next/canonical urls for nav
+        {
+            $chapter->appendTextChild( 'prev_url',
                   $counter == 1
                   $counter == 1
-                    ? $type eq 'filter'
-                      ? '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) );
-            }
+                ? $type eq 'filter'
+                        ? 'filter.html'
+                        : 'index.html'
+                : sprintf( '%sch%02d.html', $prepend_chapter, $counter - 1 ) );
+            $chapter->appendTextChild( 'next_url', sprintf( '%sch%02d.html', $prepend_chapter, $counter + 1 ) ) unless int(@chapters) == $counter;
+            $chapter->appendTextChild(
+                'canonical_url',
+                sprintf(
+                    'http://www.exim.org/exim-html-current/doc/html/spec_html/%sch%02d.html',
+                    $prepend_chapter, $counter
+                )
+            );
+        }
 
 
-          ## Create an XML document from the chapter
-            my $doc = XML::LibXML::Document->createDocument( '1.0', 'UTF-8' );
-            $doc->setDocumentElement( $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",
-               );
-            }
-       }
-  }
+        ## Create an XML document from the chapter
+        my $doc = XML::LibXML::Document->createDocument( '1.0', 'UTF-8' );
+        $doc->setDocumentElement($chapter);
 
 
-## Fixup xref tags
-  sub xref_fixup {
-     my( $xml, $prepend_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" if ( $opt{verbose} );
+            transform( $doc, "$opt{tmpl}/doc/chapter.xsl", "$opt{docroot}/$path", );
+        }
+    }
+}
 
 
-     my %index = ();
+## Fixup xref tags
+sub xref_fixup {
+    my ( $xml, $prepend_chapter ) = @_;
 
 
-     ## Add the "prepend_chapter" info
-       ($xml->findnodes('/book'))[0]->appendTextChild( 'prepend_chapter', $prepend_chapter );
+    my %index = ();
 
 
-     ## Iterate over each chapter
-       my $chapter_counter = 0;
-       foreach my $chapter ( $xml->findnodes('/book/chapter') ){
-          ++$chapter_counter;
+    ## Add the "prepend_chapter" info
+    ( $xml->findnodes('/book') )[0]->appendTextChild( 'prepend_chapter', $prepend_chapter );
 
 
-          my $chapter_id    = $chapter->getAttribute('id');
-          my $chapter_title = $chapter->findvalue('title');
+    ## Iterate over each chapter
+    my $chapter_counter = 0;
+    foreach my $chapter ( $xml->findnodes('/book/chapter') ) {
+        ++$chapter_counter;
 
 
-          $index{$chapter_id} = { chapter_id => $chapter_counter, chapter_title => $chapter_title };
+        my $chapter_id = $chapter->getAttribute('id');
+        unless ($chapter_id) {    # synthesise missing id
+            $chapter_id = sprintf( 'chapter_noid_%04d', $chapter_counter );
+            $chapter->setAttribute( 'id', $chapter_id );
+        }
+        my $chapter_title = $chapter->findvalue('title');
 
 
-          ## Iterate over each section
-            my $section_counter = 0;
-            foreach my $section ( $chapter->findnodes('section') ){
-               ++$section_counter;
+        $index{$chapter_id} = { chapter_id => $chapter_counter, chapter_title => $chapter_title };
 
 
-               my $section_id      = $section->getAttribute('id');
-               my $section_title   = $section->findvalue('title');
+        ## Iterate over each section
+        my $section_counter = 0;
+        foreach my $section ( $chapter->findnodes('section') ) {
+            ++$section_counter;
 
 
-               $index{$section_id} = { chapter_id => $chapter_counter, chapter_title => $chapter_title, section_id => $section_counter };
+            my $section_id = $section->getAttribute('id');
+            unless ($section_id) {    # synthesise missing id
+                $section_id = sprintf( 'section_noid_%04d_%04d', $chapter_counter, $section_counter );
+                $section->setAttribute( 'id', $section_id );
             }
             }
-       }
+            my $section_title = $section->findvalue('title');
+
+            $index{$section_id} = {
+                chapter_id    => $chapter_counter,
+                chapter_title => $chapter_title,
+                section_id    => $section_counter,
+                section_title => $section_title
+            };
+        }
+    }
+    ## Build indexes as new chapters
+    build_indexes( $xml, $prepend_chapter, \%index );
 
     ## Replace all of the xrefs in the XML
 
     ## Replace all of the xrefs in the XML
-      foreach my $xref ( $xml->findnodes('//xref') ){
-         my $linkend = $xref->getAttribute('linkend');
-         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( 'url', sprintf('%sch%02d.html',$prepend_chapter, $index{$linkend}{'chapter_id'}).($index{$linkend}{'section_id'}?'#'.$linkend:'') );
-          }
-       }
-  }
+    foreach my $xref ( $xml->findnodes('//xref') ) {
+        my $linkend = $xref->getAttribute('linkend');
+        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( 'url',
+                sprintf( '%sch%02d.html', $prepend_chapter, $index{$linkend}{'chapter_id'} )
+                    . ( $index{$linkend}{'section_id'} ? '#' . $linkend : '' ) );
+        }
+    }
+}
+
+## Build indexes
+sub build_indexes {
+    my ( $xml, $prepend_chapter, $xref ) = @_;
+
+    my $index_hash = {};
+    my $current_id;
+    foreach my $node ( $xml->findnodes('//section | //chapter | //indexterm') ) {
+        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 $secondary = $node->findvalue('child::secondary') || '';
+            next unless ( $primary || $secondary );    # skip blank entries for now...
+            $index_hash->{$role}{$first}{$primary}{$secondary} ||= [];
+            push @{ $index_hash->{$role}{$first}{$primary}{$secondary} }, $current_id;
+        }
+        else {
+            $current_id = $node->getAttribute('id');
+        }
+    }
+
+    # now we build a set of new chapters with the index data in
+    my $book = ( $xml->findnodes('/book') )[0];
+    foreach my $role ( sort { $a cmp $b } keys %{$index_hash} ) {
+        my $chapter = XML::LibXML::Element->new('chapter');
+        $book->appendChild($chapter);
+        $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', 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 $entry = XML::LibXML::Element->new('varlistentry');
+                my $item  = XML::LibXML::Element->new('listitem');
+                $list->appendChild($entry)->appendTextChild( 'term', $primary );
+                $entry->appendChild($item);
+                my $slist;
+                foreach my $secondary ( sort { $a cmp $b } keys %{ $index_hash->{$role}{$first}{$primary} } ) {
+                    my $para = XML::LibXML::Element->new('para');
+                    if ( $secondary eq '' ) {
+                        $item->appendChild($para);    # skip having extra layer of heirarchy
+                    }
+                    else {
+                        unless ($slist) {
+                            $slist = XML::LibXML::Element->new('variablelist');
+                            $item->appendChild($slist);
+                        }
+                        my $sentry = XML::LibXML::Element->new('varlistentry');
+                        my $sitem  = XML::LibXML::Element->new('listitem');
+                        $slist->appendChild($sentry)->appendTextChild( 'term', $secondary );
+                        $sentry->appendChild($sitem)->appendChild($para);
+                    }
+                    my $count = 0;
+                    foreach my $ref ( @{ $index_hash->{$role}{$first}{$primary}{$secondary} } ) {
+                        $para->appendText(', ')
+                            if ( $count++ );
+                        my $xrefel = XML::LibXML::Element->new('xref');
+                        $xrefel->setAttribute( linkend => $ref );
+                        $xrefel->setAttribute( longref => 1 );
+                        $para->appendChild($xrefel);
+                    }
+                }
+            }
+        }
+    }
+}
 
 ## Handle the transformation
 
 ## Handle the transformation
-  sub transform {
-     my( $xml, $xsl_path, $out_path ) = @_;
-
-     ## Build an empty XML structure if an undefined $xml was passed
-       unless( defined $xml ){
-          $xml = XML::LibXML::Document->createDocument( '1.0', 'UTF-8' );
-          $xml->setDocumentElement( $xml->createElement('content') );
-       }
-
-     ## Add the current version of Exim to the XML
-       $xml->documentElement()->appendTextChild( 'current_version', $opt{latest} );
-
-     ## 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 );
-
-     ## Generate a doc from the XML transformed with the XSL
-       my $doc = $stylesheet->transform( $xml );
-
-     ## Make the containing directory if it doesn't exist
-       mkdirp( ($out_path =~ /^(.+)\/.+$/)[0] );
-
-     ## Write out the document
-       open my $out, '>', $out_path or die $!;
-       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";
-     }
-  }
+sub transform {
+    my ( $xml, $xsl_path, $out_path ) = @_;
+
+    ## Build an empty XML structure if an undefined $xml was passed
+    unless ( defined $xml ) {
+        $xml = XML::LibXML::Document->createDocument( '1.0', 'UTF-8' );
+        $xml->setDocumentElement( $xml->createElement('content') );
+    }
+
+    ## Add the current version of Exim to the XML
+    $xml->documentElement()->appendTextChild( 'current_version', $opt{latest} );
+
+    ## 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);
+
+    ## Generate a doc from the XML transformed with the XSL
+    my $doc = $stylesheet->transform($xml);
+
+    ## Make the containing directory if it doesn't exist
+    make_path( ( $out_path =~ /^(.+)\/.+$/ )[0], { verbose => 1 } );
+
+    ## Write out the document
+    open my $out, '>', $out_path or die "Unable to write $out_path - $!";
+    print $out $stylesheet->output_as_bytes($doc);
+    close $out;
+}
+
+## error_help
+sub error_help {
+    my $msg = shift;
+
+    warn $msg;
+    pod2usage( -exitval => 1, -verbose => 0 );
+}
 
 ## Parse arguments
 
 ## Parse arguments
-  sub parse_arguments {
-     my %opt = ();
-
-     ## --help
-       help(0) if int(@ARGV) == 0 || grep(/^--help|-h$/,@ARGV);
-
-     my @collection = @ARGV;
-     while( @collection ){
-        my $key = shift @collection;
-
-        if( $key eq '--web' ){
-
-           ## --web
-             $opt{web} = 1;
-        } elsif( $key =~ /^--(spec|filter)$/ ){
-
-           ## --spec and --filter
-             my $continue = 1;
-             while( $continue && @collection ){
-                my $value = shift @collection;
-
-                if( $value =~ /^--/ ){
-                   unshift @collection, $value;
-                   $continue = 0;
-                } else {
-                   $value = File::Spec->rel2abs( $value );
-                   help( 1, 'No such file: '.$value   ) unless -f $value;
-                   push @{$opt{$1}}, $value unless grep( $_ eq $value, @{$opt{$1}} );
-                }
-             }
-             help( 1, 'Missing value for '.$key ) unless exists $opt{$1};
-        } elsif( $key eq '--latest' ){
-
-           ## --latest
-             my $value = shift @collection;
-             help( 1, 'Missing value for '.$key ) unless defined $value;
-             help( 1, 'Invalid value for '.$key ) unless $value =~ /^\d+(?:\.\d+)*$/;
-             $opt{latest} = $value;
-        } elsif( $key =~ /^--(tmpl|docroot)$/ ){
-
-           ## --tmpl and --docroot
-             my $value = shift @collection;
-             help( 1, 'Missing value for '.$key    ) unless defined $value;
-             $value = File::Spec->rel2abs( $value );
-             help( 1, 'No such directory: '.$value ) unless -d $value;
-             $opt{$1} = $value;
-             $opt{$1} =~ s#/+$##;
-        } else {
-           help( 1, 'Bad argument: '.$key );
-        }
-     }
+sub parse_arguments {
+
+    my %opt = ( spec => [], filter => [], help => 0, man => 0, web => 0, minify => 1, verbose => 0 );
+    GetOptions(
+        \%opt,      'help|h!', 'man!',      'web!',    'spec=s{1,}', 'filter=s{1,}',
+        'latest=s', 'tmpl=s',  'docroot=s', 'minify!', 'verbose!'
+    ) || pod2usage( -exitval => 1, -verbose => 0 );
+
+    ## --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} } ];
+    }
+    ## --latest
+    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]) {
+        error_help( 'Missing value for ' . $set ) unless ( exists( $opt{$set} ) && defined( $opt{$set} ) );
+        my $f = File::Spec->rel2abs( $opt{$set} );
+        error_help( 'No such directory: ' . $opt{$set} ) unless -d $f;
+        $opt{$set} = $f;
+    }
+    error_help('Excess arguments') if ( scalar(@ARGV) );
+
+    error_help('Must include at least one of --web, --spec or --filter')
+        unless ( $opt{web} || scalar( @{ $opt{spec} || [] } ) || scalar( @{ $opt{filter} || [] } ) );
+
+    return %opt;
+}
+
+1;
+
+__END__
+
+=head1 NAME
+
+gen.pl - Generate exim html documentation and website
+
+=head1 SYNOPSIS
+
+gen.pl [options]
+
+ 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    
+
+=head1 OPTIONS
+
+=over 4
+
+=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.
 
 
-     help( 1, 'Must include at least one of --web, --spec or --filter' ) unless exists $opt{web} || exists $opt{spec} || exists $opt{filter};
-     foreach(qw( latest tmpl docroot )){
-        help( 1, 'Missing argument: --'.$_ ) unless exists $opt{$_};
-     }
+This option is set by default - to disable it specify C<--no-minify>
 
 
-     return %opt;
-  }
+=back
 
 
-## Help information
-  sub help {
-     my( $exit_code, $msg ) = @_;
+=head1 DESCRIPTION
 
 
-     print "$msg\n\n" if defined $msg;
+Generates the exim website and HTML documentation.
 
 
-     print << "END_HELP";
-Options:
-   --help or -h  : Print this help information and then exit
+=head1 EXAMPLE
 
 
-   --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
+    script/gen.pl \
+      --web \
+      --spec docbook/*/spec.xml \
+      --filter  docbook/*/filter.xml \
+      --latest 4.72 \
+      --tmpl templates \
+      --docroot /tmp/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 AUTHOR
 
 
-   --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
+Mike Cardwell
 
 
-   If CSS::Minifier::XS is installed, then CSS will be minified.
-   If JavaScript::Minifier::XS is installed, then JavaScript will be minified.
+Nigel Metheringham <nigel@exim.org> - mostly broke the framework
+Mike produced.
 
 
-Example:
+=head1 COPYRIGHT
 
 
-   ./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
+Copyright 2010 Exim Maintainers. All rights reserved.
 
 
-     exit( $exit_code );
-  }
+=cut