File: makemanual

package info (click to toggle)
latexml 0.8.8-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 31,920 kB
  • sloc: xml: 109,048; perl: 30,224; sh: 179; javascript: 28; makefile: 13
file content (122 lines) | stat: -rwxr-xr-x 4,084 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
#!/usr/bin/env perl
use strict;
use warnings;
use FindBin;
use lib "$FindBin::RealBin/../blib/lib", $FindBin::RealBin;
use LaTeXML::Util::Pathname;
use Carp;
use Getopt::Long qw(:config no_ignore_case);
use Pod::Usage;
use MakeTools;

#%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
# Assume this script is in LaTeXML's doc directory!
my $DOCDIR = $FindBin::RealBin;
# Use latexml from blib!
my $LATEXMLDIR = "$DOCDIR/..";
$ENV{PATH}      = "$LATEXMLDIR/blib/script:$ENV{PATH}";
$ENV{TEXINPUTS} = "$LATEXMLDIR/blib/lib/LaTeXML/texmf"
  . ($ENV{TEXINPUTS} ? ":" . $ENV{TEXINPUTS} : '')
  . "::";
my $MANDIR = "$DOCDIR/manual";
my $WEBDIR = "/local/www/site/htdocs/LaTeXML";

my $identity = "makemanual (part of LaTeXML)";
my ($force, $help, $validate, $verbosity) = (0, 0, 1, 0);
my ($dopdf, $dohtml) = (undef, undef);
GetOptions("force!" => \$force,
  "help"      => \$help,
  "pdf!"      => \$dopdf,
  "html!"     => \$dohtml,
  "xhtml!"    => \$dohtml,
  "validate!" => \$validate,
  "webdir=s"  => \$WEBDIR,
  verbose     => sub { $verbosity++; },
  quiet       => sub { $verbosity--; },
) or pod2usage(-message => $identity, -exitval => 1, -verbose => 0, -output => \*STDERR);
pod2usage(-message => $identity, -exitval => 1, -verbose => 2, -output => \*STDOUT) if $help;

$WEBDIR = pathname_absolute($WEBDIR);

BEGIN { $SIG{__DIE__} = \&confess; }

if ((!defined $dopdf) && (!defined $dohtml)) {
  $dopdf = $dohtml = 1; }
elsif (!defined $dopdf) {
  $dopdf = 1 if defined $dohtml && !$dohtml; }
elsif (!defined $dohtml) {
  $dohtml = 1 if defined $dopdf && !$dopdf; }

# Sanity check
if (!($dopdf || $dohtml)) {
  heading("Nothing to do... (see --help)");
  exit(0); }

my $tmp;
if (!(($tmp = pathname_mkdir($WEBDIR)) && -w $tmp)) {
  die "Destination '$WEBDIR' is not writable; please set --webdir (see --help):\n  $!"; }

#======================================================================
# Generate Appendices from PODS, Schema, etc
#======================================================================
setVerbosity($verbosity);

heading("Extracting Release, PODS and Schema info");
getReleaseInfo("$WEBDIR/releases");
system("$MANDIR/genpods" . ($force ? " --force" : "")) == 0
  or warn "Failed to generate pods?";
system("$MANDIR/genschema" . ($force ? " --force" : "")) == 0
  or warn "Failed to generate schema documentation?";

#======================================================================
# Now generate the manual
#======================================================================
if ($dopdf) {
  heading("Generating pdf of manual");
  pdflatex("$MANDIR/manual.tex",
    dependencies => ["$DOCDIR/sty/latexmldoc.sty", "$DOCDIR/sty/latexmlreleases.tex",
      "$MANDIR/schema.tex", "$MANDIR/pods"],
    indexoptions => [],
    force        => $force);
  copy("$MANDIR/manual.pdf", "$LATEXMLDIR/manual.pdf");
  copy("$MANDIR/manual.pdf", "$WEBDIR/manual.pdf");
}

if ($dohtml) {
  heading("Generating html of manual");
  latexml("$MANDIR/manual.tex" => "$WEBDIR/manual/index.html",
    dependencies => ["$DOCDIR/sty/latexmldoc.sty.ltxml", "$DOCDIR/sty/latexmlreleases.tex",
      "$MANDIR/schema.tex", "$MANDIR/pods"],
    postoptions => [
      "--format=html5",
      "--split", "--splitnaming=labelrelative", "--splitat=subsection",
      "--sourcedir=$MANDIR",
      "--urlstyle=server",
      "--sitedirectory=$WEBDIR",
      "--css=$DOCDIR/latexmldoc.css",
      "--javascript=LaTeXML-maybeMathjax.js",
      ($validate ? () : ("--novalidate")),
      "--icon=$DOCDIR/favicon.ico"],
    force => $force);
  # but if only css needs updating...
  copy("$MANDIR/../latexmldoc.css", "$WEBDIR/latexmldoc.css");
}
#======================================================================

__END__

=head1 NAME

C<makemanual> - generate manual for LaTeXML

=head1 SYNOPSIS

makemanual [options]

 Options:
  --force           Force regeneration (default: only if needed)
  --webdir          Directory to put website at. Defaults to
                    '/local/www/site/htdocs/LaTeXML'
  --help            Shows this help.

=cut