X-Git-Url: https://git.exim.org/exim-website.git/blobdiff_plain/fc83efe2751fa34b4123a03412da138d71ec9007..322439df5d8a8928b8db4bb41aeae33030038f61:/script/gen.pl diff --git a/script/gen.pl b/script/gen.pl index 140df44..3c1137b 100755 --- a/script/gen.pl +++ b/script/gen.pl @@ -1,13 +1,16 @@ #!/usr/bin/perl +# use strict; use warnings; -use CSS::Minifier::XS; + +use CSS::Minifier::XS 0.07; use File::Copy; use File::Find; use File::Slurp; use File::Spec; use Getopt::Long; use JavaScript::Minifier::XS; +use Pod::Usage; use XML::LibXML; use XML::LibXSLT; @@ -185,10 +188,16 @@ sub xref_fixup { } my $section_title = $section->findvalue('title'); - $index{$section_id} = - { chapter_id => $chapter_counter, chapter_title => $chapter_title, section_id => $section_counter }; + $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 foreach my $xref ( $xml->findnodes('//xref') ) { @@ -196,7 +205,8 @@ sub xref_fixup { 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_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 : '' ) ); @@ -204,6 +214,79 @@ sub xref_fixup { } } +## 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 sub transform { my ( $xml, $xsl_path, $out_path ) = @_; @@ -230,7 +313,7 @@ sub transform { mkdirp( ( $out_path =~ /^(.+)\/.+$/ )[0] ); ## 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; } @@ -249,73 +332,151 @@ sub mkdirp { } } +## 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{}', 'filter=s{}', 'latest=s', 'tmpl=s', 'docroot=s', 'minify!' ) - || help( 1, 'Bad options' ); + my %opt = ( spec => [], filter => [], help => 0, man => 0, web => 0, minify => 1 ); + GetOptions( \%opt, 'help|h!', 'man!', 'web!', 'spec=s{1,}', 'filter=s{1,}', 'latest=s', 'tmpl=s', 'docroot=s', 'minify!' ) + || 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} } ]; } ## --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' ) + error_help('Must include at least one of --web, --spec or --filter') unless ( defined $opt{web} || scalar( @{ $opt{spec} } ) || scalar( @{ $opt{web} } ) ); 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 -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 + +=item B<--help> + +Display help and exits + +=item B<--man> + +Display man page + +=item B<--spec> I + +List of files that make up the specification documentation +docbook/XML source files. + +=item B<--filter> I + +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 + +Specify the current exim version. This is used to create links to +the current documentation. + +This option is I + +=item B<--tmpl> I + +Specify the directory that the templates are kept in. + +This option is I + +=item B<--docroot> I + +Specify the directory that the output should be generated into. +This is the website C directory. + +This option is I + +=item B<--minify> + +If this option is set then both the CSS and Javascript files +processed are minified using L and +L respectively. + +This option is set by default - to disable it specify C<--no-minify> + +=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 - mostly broke the framework +Mike produced. + +=head1 COPYRIGHT + +Copyright 2010 Exim Maintainers. All rights reserved. + +=cut - exit($exit_code); -}