use warnings;
use CSS::Minifier::XS 0.07;
+use File::Basename;
use File::Copy;
use File::Find;
use File::Path qw(make_path);
do_doc( 'spec', $_ ) foreach @{ $opt{spec} || [] };
do_doc( 'filter', $_ ) foreach @{ $opt{filter} || [] };
do_web() if ( $opt{web} );
-do_static(); # need this for all other pages generated
+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" if ( $opt{verbose} );
# ------------------------------------------------------------------
## Generate the static file set
sub do_static {
+ my $staticroot = shift || $opt{staticroot};
## make sure I have a directory
- mkdir( $opt{staticroot} ) or die "Unable to make staticroot: $!\n" unless ( -d $opt{staticroot} );
+ mkdir($staticroot) or die "Unable to make staticroot: $!\n" unless ( -d $staticroot );
## copy these templates to docroot...
- copy_transform_files( "$opt{tmpl}/static", $opt{staticroot}, 1 );
+ copy_transform_files( "$opt{tmpl}/static", $staticroot, 1 );
}
# ------------------------------------------------------------------
## 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" if ( $opt{verbose} );
- transform( $xml, "$opt{tmpl}/doc/index.xsl", "$opt{docroot}/$path", );
+ 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" if ( $opt{verbose} );
- transform( $xml, "$opt{tmpl}/doc/toc.xsl", "$opt{docroot}/$path", );
+ transform( $xml, "$opt{tmpl}/doc/toc.xsl", "$opt{docroot}/$path", $staticroot );
}
## Generate the chapters
my $counter = 0;
my @chapters = map { $_->cloneNode(1) } $xml->findnodes('/book/chapter');
+ my( $chapter_title, $chapter_title_prev, $chapter_title_next );
foreach my $chapter (@chapters) {
## Add a <chapter_id>N</chapter_id> node for the stylesheet to use
$chapter->appendTextChild( 'chapter_id', ++$counter );
+ ## Get the current and surrounding chapter titles
+ $chapter_title_prev = $chapter_title;
+ $chapter_title = $chapter_title_next || $chapter->findvalue('title_uri');
+ $chapter_title_next = $chapters[$counter]->findvalue('title_uri') if $counter < int(@chapters);
+
## Add previous/next/canonical urls for nav
{
$chapter->appendTextChild( 'prev_url',
? $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 ) )
+ : sprintf( '%sch-%s.html', $prepend_chapter, $chapter_title_prev ) );
+ $chapter->appendTextChild( 'this_url', sprintf( '%sch-%s.html', $prepend_chapter, $chapter_title ) );
+ $chapter->appendTextChild( 'next_url', sprintf( '%sch-%s.html', $prepend_chapter, $chapter_title_next ) )
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
+ 'http://www.exim.org/exim-html-current/doc/html/spec_html/%sch-%s.html',
+ $prepend_chapter, $chapter_title
)
);
if ( $version ne $opt{latest} ) {
$chapter->appendTextChild(
'current_url',
sprintf(
- '../../../../exim-html-current/doc/html/spec_html/%sch%02d.html',
- $prepend_chapter, $counter
+ '../../../../exim-html-current/doc/html/spec_html/%sch-%s.html',
+ $prepend_chapter, $chapter_title
)
);
}
## 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 $real_path = sprintf( 'exim-html-%s/doc/html/spec_html/%sch-%s.html', $version, $prepend_chapter, $chapter_title );
+ my $link_path = sprintf( 'exim-html-%s/doc/html/spec_html/%sch%02d.html', $version, $prepend_chapter, $counter );
+ print "Generating : docroot:/$real_path\n" if ( $opt{verbose} );
+ transform( $doc, "$opt{tmpl}/doc/chapter.xsl", "$opt{docroot}/$real_path", $staticroot );
+ # Making a relative symlink to a file in the same directory.
+ # Extract just the filename portion of $real_path.
+ my $real_file = basename($real_path);
+ print "Symlinking : docroot:/$link_path to $real_file\n" if ( $opt{verbose} );
+ if ( -f "$opt{docroot}/$link_path" ) {
+ unlink("$opt{docroot}/$link_path") or die "failed removing $opt{docroot}/$link_path: $!";
+ }
+ symlink( "$real_file", "$opt{docroot}/$link_path" ) || die "symlink to $opt{docroot}/$link_path failed: $!";
}
}
}
}
my $chapter_title = $chapter->findvalue('title');
+ ## Set title_uri so we can use eg ch-introduction.html instead of ch01.html
+ $chapter->appendTextChild( 'title_uri', title_to_uri($chapter_title) );
+
$index{$chapter_id} = { chapter_id => $chapter_counter, chapter_title => $chapter_title };
## Iterate over each section
$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'} )
+ sprintf( '%sch-%s.html', $prepend_chapter, title_to_uri($index{$linkend}{'chapter_title'}) )
. ( $index{$linkend}{'section_id'} ? '#' . $linkend : '' ) );
}
}
$chapter->setAttribute( 'id', join( '_', 'index', $role ) );
$chapter->setAttribute( 'class', 'index' );
$chapter->appendTextChild( 'title', ( ucfirst($role) . ' Index' ) );
+ $chapter->appendTextChild( 'title_uri', title_to_uri(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');
# ------------------------------------------------------------------
## 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 ) {
## work out the static root relative to the target
my $target_dir = ( File::Spec->splitpath($out_path) )[1];
- my $staticroot = File::Spec->abs2rel( $opt{staticroot}, $target_dir );
+ my $staticroot = File::Spec->abs2rel( $staticroot_abs, $target_dir );
## Generate a doc from the XML transformed with the XSL
my $doc = $stylesheet->transform( $xml, staticroot => sprintf( "'%s'", $staticroot ) );
close $out;
}
+# ------------------------------------------------------------------
+## Takes a chapter title and fixes it up so it is suitable for use in a URI
+sub title_to_uri {
+ my $title = lc(shift);
+ $title =~ s/[^a-z0-9\s]+//gi; # Only allow spaces, numbers and letters
+ $title =~ s/\s+/_/g; # Replace spaces with underscores so URLs are easier to copy about
+ return $title;
+}
+
# ------------------------------------------------------------------
## 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 < $opt{latest} && -d $_;
+ push @versions, $1 if /-(\d+(?:\.\d+)?)$/ && $1 lt $opt{latest} && -d $_;
}
- $cache{old_docs_versions} = [ reverse sort { $a <=> $b } @versions ];
+ $cache{old_docs_versions} = [ reverse sort { $a cmp $b } @versions ];
}
return @{ $cache{old_docs_versions} };
}
## Parse arguments
sub parse_arguments {
- my %opt = ( spec => [], filter => [], help => 0, man => 0, web => 0, minify => 1, verbose => 0 );
+ 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!'
+ 'latest=s', 'tmpl=s', 'docroot=s', 'minify!', 'verbose!', 'localstatic!'
) || pod2usage( -exitval => 1, -verbose => 0 );
## --help
## --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 }
+ [ map { my $f = File::Spec->rel2abs($_); error_help( 'No such file: ' . $_ ) unless -f $f; $f }
@{ $opt{$set} } ];
}
## --latest
--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
+ --[no-]minify [Don't] minify CSS and Javascript
+ --localstatic Makes the static files local to each doc ver
=head1 OPTIONS
=item B<--spec> I<file...>
-List of files that make up the specification documentation
-docbook/XML source files.
+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.
+List of files that make up the filter documentation docbook/XML source files.
=item B<--web>
=item B<--latest> I<version>
-Specify the current exim version. This is used to create links to
-the current documentation.
+Specify the current exim version. This is used to create links to the current
+documentation.
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.
+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.
+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
Mike Cardwell
-Nigel Metheringham <nigel@exim.org> - mostly broke the framework
-Mike produced.
+Nigel Metheringham <nigel@exim.org> - mostly broke the framework Mike produced.
=head1 COPYRIGHT
git://git.exim.org / exim-website.git / blobdiff