]>
git.proxmox.com Git - pve-docs.git/blob - asciidoc-pve.in
15 my $release = '@RELEASE@';
18 die "no command specified\n";
21 while (<main
::DATA
>) { $data_str .= $_; }
23 my $fileinfo = decode_json
($data_str);
25 my $tmpprefix = ".asciidoc-pve-tmp_";
27 my $adoc_source_dir = "/usr/share/pve-doc-generator";
29 # inside pve-docs source dir?
30 if (-f
"attributes.txt" && -f
"pve-admin-guide.adoc") {
31 $adoc_source_dir = "."
34 my $prepared_files = {};
36 my $man_target = 'man';
45 print STDERR
"asciidoc-pve: $msg\n";
48 sub push_environment
{
49 my ($env, $skip) = @_;
51 $skip = 1 if $env_skip;
52 $skip = 0 if !defined($skip);
54 push @$env_stack, [$env, $skip];
62 my $last_stack_entry = pop @$env_stack;
63 die "unable to pop env '$env'" if !defined($last_stack_entry);
65 my ($last_env, $skip) = @$last_stack_entry;
66 die "environment missmatch (${last_env} != $env)\n" if $last_env ne $env;
68 if (!scalar(@$env_stack)) {
71 my (undef, $skip) = @{$env_stack->[-1]};
76 my $files_for_cleanup = [];
80 return if $keep_artifacts;
82 foreach my $file (@$files_for_cleanup) {
87 sub replace_wiki_xref
{
88 my ($blockid, $text) = @_;
90 my $link = $fileinfo->{blockid_target
}->{wiki
}->{$blockid};
91 my $reftext = $fileinfo->{reftext
}->{wiki
}->{$blockid};
93 die "unable to resolve wiki link (xref:$blockid)\n"
96 $text = $reftext if !length($text);
98 die "xref: no text for wiki link '$blockid'\n" if !$text;
100 return "$link\[$text\]";
103 sub replace_default_xref
{
104 my ($blockid, $text) = @_;
106 my $link = $fileinfo->{blockid_target
}->{default}->{$blockid};
107 my $reftext = $fileinfo->{reftext
}->{default}->{$blockid};
109 die "unable to resolve chapter link (xref:$blockid)\n"
112 $text = $reftext if !length($text);
114 die "xref: no text for chapter link '$blockid'\n" if !$text;
116 return "$link\[$text\]";
119 sub replace_man_xref
{
120 my ($blockid, $text) = @_;
122 my $link = $fileinfo->{blockid_target
}->{manvolnum
}->{$blockid};
123 my $reftext = $fileinfo->{reftext
}->{manvolnum
}->{$blockid};
125 die "unable to resolve man page link (xref:$blockid)\n"
128 $text = $reftext if !length($text);
130 die "xref: no text for man page link '$blockid'\n" if !$text;
132 my $section = $fileinfo->{mansection
}->{manvolnum
}->{$link};
133 die "link target is not a manual page" if !defined($section);
136 if ($man_target eq 'html') {
138 $target =~ s/\.adoc//;
139 $target .= ".$section";
140 return "link:${target}.html#${blockid}\[$text\]";
141 } elsif ($man_target eq 'man') {
143 $command =~ s/\.adoc//;
144 return "\*${text}\* (man \*${command}\*($section))";
151 my ($env, $blockid, $text) = @_;
153 if ($env eq 'wiki') {
154 return replace_wiki_xref
($blockid, $text);
155 } elsif ($env eq 'manvolnum') {
156 if (($man_target eq 'man') || ($man_target eq 'html')) {
157 return replace_man_xref
($blockid, $text);
158 } elsif ($man_target eq 'wiki') {
159 return replace_wiki_xref
($blockid, $text);
163 } elsif ($env eq 'default') {
164 return replace_default_xref
($blockid, $text);
166 die "internal error";
170 sub prepare_adoc_file
{
171 my ($target_env, $filename, $attributes) = @_;
173 return $prepared_files->{$filename} if defined($prepared_files->{$filename});
175 debug
("prepare $filename");
177 my $dirname = dirname
($filename);
178 my $basename = basename
($filename);
180 my $outfilename = "$dirname/${tmpprefix}$basename";
182 $prepared_files->{$filename} = $outfilename;
184 my $fh = IO
::File-
>new("$filename", "r") or
185 die "unable to open file '$filename' - $!\n";
187 my $outfh = IO
::File-
>new("$outfilename", "w") or
188 die "unable to open temporary file '$outfilename'\n";
190 push @$files_for_cleanup, $outfilename;
192 while (defined (my $line = <$fh>)) {
194 if ($line =~ m/^if(n?)def::(\S+)\[(.*)\]\s*$/) {
195 my ($not, $env, $text) = ($1, $2, $3);
196 die "unsuported ifdef usage - implement me" if $text;
198 my $skip = !exists($attributes->{$env}) ?
1 : 0;
199 $skip = ($skip ?
0 : 1 ) if $not;
201 push_environment
($env, $skip);
203 } elsif ($line =~ m/^endif::(\S+)\[(.*)\]\s*$/) {
204 my ($env, $text) = ($1, $2);
205 die "unsuported ifdef usage - implement me" if $text;
206 pop_environment
($env);
212 if ($line =~ m/^include::(\S+)(\[.*\]\s*)$/) {
213 my ($fn, $rest) = ($1, $2);
214 debug
("include $fn");
215 my $new_fn = prepare_adoc_file
($target_env, $fn, $attributes);
217 print $outfh "include::${new_fn}$rest\n";
222 $line =~ s/xref:([^\s\[\]]+)\[([^\]]*)\]/replace_xref(${target_env},$1,$2)/ge;
224 $line =~ s/<<([^\s,\[\]]+)(?:,(.*?))?>>/replace_xref(${target_env},$1,$2)/ge;
226 print $outfh $line . "\n";
232 sub compile_asciidoc
{
237 GetOptions
("outfile=s" => \
$outfile,
238 "keep-artifacts" => \
$keep_artifacts,
239 "verbose" => \
$verbose) or
240 die("Error in command line arguments\n");
242 my $infile = shift(@ARGV) or
243 die "no input file specified\n";
245 scalar(@ARGV) == 0 or
246 die "too many arguments...\n";
248 defined($fileinfo->{titles
}->{$env}) ||
249 die "unknown environment '$env'";
251 my $title = $fileinfo->{titles
}->{$env}->{$infile} or
252 die "unable to get title for '$infile'$env\n";
254 debug
("compile $title");
258 my $doctype = $fileinfo->{doctype
}->{$env}->{$infile};
260 die "unable to get document type for '$infile'\n"
261 if !defined($doctype);
263 $leveloffset = - $doctype;
270 leveloffset
=> $leveloffset,
273 my $mansection = $fileinfo->{mansection
}->{$env}->{$infile};
275 if ($env eq 'wiki') {
276 } elsif ($env eq 'manvolnum') {
277 die "undefined man section" if !defined($mansection);
278 $attributes->{manvolnum
} = $mansection;
279 } elsif ($env eq 'default') {
280 die "$infile: wrong doctype\n" if $doctype != 0;
281 $attributes->{toc
} = undef;
284 if (!defined($outfile)) {
286 $outfile =~ s/\.adoc$//;
287 if ($env eq 'manvolnum') {
288 if (($man_target eq 'html') || ($man_target eq 'wiki')) {
289 $outfile .= ".$mansection.html";
291 $outfile .= ".$mansection";
298 if (($env eq 'manvolnum') && ($man_target eq 'man')) {
300 # asciidoc /etc/asciidoc/docbook-xsl/manpage.xsl skip REFERENCES
301 # section like footnotes, so we cannot use a2x.
302 # We use xmlto instead.
304 my $cmd = ['asciidoc', '-dmanpage', '-bdocbook', '-a', 'docinfo1'];
306 foreach my $key (keys %$attributes) {
307 my $value = $attributes->{$key};
308 if (defined($value)) {
309 push @$cmd, '-a', "$key=$value";
311 push @$cmd, '-a', $key;
315 push @$cmd, '--verbose' if $verbose;
317 my $tmpxmlfile = "${outfile}.xml.tmp";
319 push @$cmd, '--out-file', $tmpxmlfile;
321 push @$files_for_cleanup, $tmpxmlfile;
323 my $new_infile = prepare_adoc_file
($env, $infile, $attributes);
325 push @$cmd, $new_infile;
327 debug
("run " . join(' ', @$cmd));
329 system(@$cmd) == 0 or
332 $cmd = ['xmlto', 'man', $tmpxmlfile];
334 push @$cmd, '-v' if $verbose;
336 debug
("run " . join(' ', @$cmd));
338 system(@$cmd) == 0 or
343 $attributes->{icons
} = undef;
344 $attributes->{'data-uri'} = undef;
345 $attributes->{revnumber
} = $release;
347 my $cmd = ['asciidoc'];
349 push @$cmd, '-s' if ($env eq 'wiki') ||
350 (($env eq 'manvolnum') && ($man_target eq 'wiki'));
352 foreach my $key (keys %$attributes) {
353 my $value = $attributes->{$key};
354 if (defined($value)) {
355 push @$cmd, '-a', "$key=$value";
357 push @$cmd, '-a', $key;
361 push @$cmd, '--verbose' if $verbose;
363 push @$cmd, '--out-file', $outfile;
365 my $new_infile = prepare_adoc_file
($env, $infile, $attributes);
367 push @$cmd, $new_infile;
369 debug
("run " . join(' ', @$cmd));
371 system(@$cmd) == 0 or
376 if ($clicmd eq 'compile-wiki') {
378 eval { compile_asciidoc
('wiki'); };
385 } elsif ($clicmd eq 'compile-chapter') {
387 eval { compile_asciidoc
('default'); };
394 } elsif ($clicmd eq 'compile-man-html') {
396 $man_target = 'html';
398 eval { compile_asciidoc
('manvolnum'); };
405 } elsif ($clicmd eq 'compile-man-wiki') {
407 $man_target = 'wiki';
409 eval { compile_asciidoc
('manvolnum'); };
416 } elsif ($clicmd eq 'compile-man') {
418 eval { compile_asciidoc
('manvolnum'); };
427 die "unknown command '$clicmd'\n";