#!/usr/bin/env perl # $Id$ # Make index file of all HTML and PDF documentation (printed on stdout). # Originally written 2009, Manuel P\'egouri\'e-Gonnard. WTFPL v2. BEGIN { $0 =~ m#(.*)/(.*)#; ($progdir, $progname) = ($1, $2); unshift @INC, "$progdir/.."; } use warnings FATAL => 'all'; use Fatal qw(:void open close opendir closedir chdir mkdir); use TeXLive::TLPDB; use File::Basename; my $CATALOGUE_DIR = "/home/httpd/html/catalogue/entries"; exit(main()); sub main { my $tlpdb = TeXLive::TLPDB->new('root' => "$progdir/../.."); die "$progname: unable to load TLPDB\n" unless defined $tlpdb; print < TeX Live documentation

TeX Live documentation

This document lists links to all HTML and PDF files for packages and guides contained in TeX Live (TL documentation web page), sorted by package name.

For documentation on TeX Live itself, see the texlive-en package below and its several nearby translations, as well as the texlive.infra and texlive-scripts packages. There are also links from the index.html page here. END_HEADER print_all_pkg($tlpdb); # print footer chomp (my $date = `LC_ALL=C date`); print < Generated $date by $progname. END_TRAILER return 0; } # print the links for letters, then packages # sub print_all_pkg { my ($tlpdb) = @_; # @lines is the big list, @letters the list of initials of package names local (@lines, @letters, $current_letter, $n); $current_letter = "\0"; # first build the output and the list of initials for my $tlpn (sort {lc $a cmp lc $b} $tlpdb->list_packages) { # don't show our infra packages, just confusing: next if $tlpn =~ /^00texlive\.|texlive-docindex/; my $tlpkg = $tlpdb->get_package($tlpn); push_pkg_list($tlpkg); } push @lines, "\n\n\n"; # then actually print them my $access = "\n

" . join(" - ", @letters) . "

\n"; print $access; print @lines; print $access; } # push the content for a package to the list of lines # sub push_pkg_list { my ($tlpkg) = @_; my $name = $tlpkg->name; my @docfiles = $tlpkg->docfiles; # almost always the documentation is in doc, where it should be. @docfiles = grep { m/\.(html|pdf)/ } @docfiles; if (@docfiles == 0) { # but in one notable case, koma-script, it is in runfiles, # per the author's specification. my @runfiles = $tlpkg->runfiles; @docfiles = grep { m/\.(html|pdf)/ } @runfiles; } # if no adequate documentation is found, print nothing return if @docfiles == 0; $n++; # list counter # check initial my $init = uc(substr($name, 0, 1)); unless ($init eq $current_letter) { $current_letter = $init; # put header in the big list... push @lines, "\n\n" unless $n == 1; push @lines, qq#\n

$init

\n#; push @lines, qq#\n

$init

$name\n#; # # Don't link to CTAN if the package doesn't exist. # We could find more by looking at the .tlpsrc, but let's skip # until someone notices. Except 12many works, and it's the very # first one, so add that in. my $lc_name = lc($name); my $name1 = substr($name, 0, 1); # for Catalogue check push @lines, qq#(CTAN):\n# if -r "$CATALOGUE_DIR/$name1/$lc_name.xml" || $name eq "12many"; # my $shortdesc = $tlpkg->shortdesc; # a few shortdescs already end with a period: $shortdesc =~ s/\.$// if defined $shortdesc; push @lines, "$shortdesc. \n" if defined $shortdesc; #warn "$name\n" if not defined $shortdesc; # now the list of docfiles my $list; for my $file (@docfiles) { my $name = basename($file); $list .= qq#$name#; my $dflanguage = $tlpkg->{'docfiledata'}{$file}{'language'}; $list .= " ($dflanguage) " if (defined $dflanguage && $dflanguage ne "en"); $list .= "\n"; } $list =~ s/( )?\n$//; push @lines, "$list\n