]>
git.proxmox.com Git - pve-docs.git/blob - asciidoc-pve.in
16 my $release = '@RELEASE@';
19 die "no command specified\n";
22 while (<main
::DATA
>) { $data_str .= $_; }
24 my $fileinfo = decode_json
($data_str);
26 my $tmpprefix = '.asciidoc-pve-tmp'.$$.'_';
28 my $adoc_source_dir = "/usr/share/pve-doc-generator";
30 # inside pve-docs source dir?
31 if (-f
"asciidoc-pve.in" && -f
"pve-admin-guide.adoc") {
32 $adoc_source_dir = getcwd
();
35 my $prepared_files = {};
37 my $man_target = 'man';
41 my $online_help_links = {
42 'pve_service_daemons' => {
43 link => '/pve-docs/index.html#_service_daemons',
44 title
=> 'Service Daemons',
46 'pve_documentation_index' => {
47 link => '/pve-docs/index.html',
48 title
=> 'Proxmox VE Documentation Index',
50 'pve_admin_guide' => {
51 link => '/pve-docs/pve-admin-guide.html',
52 title
=> 'Proxmox VE Administration Guide',
61 print STDERR
"asciidoc-pve: $msg\n";
64 sub push_environment
{
65 my ($env, $skip) = @_;
67 $skip = 1 if $env_skip;
68 $skip = 0 if !defined($skip);
70 push @$env_stack, [$env, $skip];
78 my $last_stack_entry = pop @$env_stack;
79 die "unable to pop env '$env'" if !defined($last_stack_entry);
81 my ($last_env, $skip) = @$last_stack_entry;
82 die "environment missmatch (${last_env} != $env)\n" if $last_env ne $env;
84 if (!scalar(@$env_stack)) {
87 my (undef, $skip) = @{$env_stack->[-1]};
92 my $files_for_cleanup = [];
96 return if $keep_artifacts;
98 foreach my $file (@$files_for_cleanup) {
103 sub replace_wiki_xref
{
104 my ($blockid, $text) = @_;
106 my $link = $fileinfo->{blockid_target
}->{wiki
}->{$blockid};
107 my $reftext = $fileinfo->{reftext
}->{wiki
}->{$blockid};
109 die "unable to resolve wiki link (xref:$blockid)\n"
112 $text = $reftext if !length($text);
114 die "xref: no text for wiki link '$blockid'\n" if !$text;
116 return "$link\[$text\]";
119 sub replace_default_xref
{
120 my ($blockid, $text) = @_;
122 my $link = $fileinfo->{blockid_target
}->{default}->{$blockid};
123 my $reftext = $fileinfo->{reftext
}->{default}->{$blockid};
125 die "unable to resolve chapter link (xref:$blockid)\n"
128 $text = $reftext if !length($text);
130 die "xref: no text for chapter link '$blockid'\n" if !$text;
132 return "$link\[$text\]";
135 sub replace_man_xref
{
136 my ($blockid, $text) = @_;
138 my $link = $fileinfo->{blockid_target
}->{manvolnum
}->{$blockid};
139 my $reftext = $fileinfo->{reftext
}->{manvolnum
}->{$blockid};
141 die "unable to resolve man page link (xref:$blockid)\n"
144 $text = $reftext if !length($text);
146 die "xref: no text for man page link '$blockid'\n" if !$text;
148 my $section = $fileinfo->{mansection
}->{manvolnum
}->{$link};
149 if (!defined($section)) {
150 warn "link '$blockid' target '$link' is not a manual page, ignoring\n";
155 if ($man_target eq 'html') {
157 $target =~ s/\.adoc//;
158 $target .= ".$section";
159 return "link:${target}.html#${blockid}\[$text\]";
160 } elsif ($man_target eq 'man') {
162 $command =~ s/\.adoc//;
163 return "\*${text}\* (man \*${command}\*($section))";
170 my ($env, $blockid, $text) = @_;
172 if ($env eq 'wiki') {
173 return replace_wiki_xref
($blockid, $text);
174 } elsif ($env eq 'manvolnum') {
175 if (($man_target eq 'man') || ($man_target eq 'html')) {
176 return replace_man_xref
($blockid, $text);
177 } elsif ($man_target eq 'wiki') {
178 return replace_wiki_xref
($blockid, $text);
182 } elsif ($env eq 'default') {
183 return replace_default_xref
($blockid, $text);
185 die "internal error";
189 sub prepare_adoc_file
{
190 my ($target_env, $filename, $attributes) = @_;
192 return $prepared_files->{$filename} if defined($prepared_files->{$filename});
194 debug
("prepare $filename");
196 my $dirname = dirname
($filename);
197 my $basename = basename
($filename);
199 my $outfilename = "$dirname/${tmpprefix}$basename";
201 $prepared_files->{$filename} = $outfilename;
203 my $fh = IO
::File-
>new("$filename", "r") or
204 die "unable to open file '$filename' - $!\n";
206 my $outfh = IO
::File-
>new("$outfilename", "w") or
207 die "unable to open temporary file '$outfilename'\n";
209 push @$files_for_cleanup, $outfilename;
211 while (defined (my $line = <$fh>)) {
213 if ($line =~ m/^if(n?)def::(\S+)\[(.*)\]\s*$/) {
214 my ($not, $env, $text) = ($1, $2, $3);
215 die "unsuported ifdef usage - implement me" if $text;
217 my $skip = !exists($attributes->{$env}) ?
1 : 0;
218 $skip = ($skip ?
0 : 1 ) if $not;
220 push_environment
($env, $skip);
222 } elsif ($line =~ m/^endif::(\S+)\[(.*)\]\s*$/) {
223 my ($env, $text) = ($1, $2);
224 die "unsuported ifdef usage - implement me" if $text;
225 pop_environment
($env);
231 if ($line =~ m/^include::(\S+)(\[.*\]\s*)$/) {
232 my ($fn, $rest) = ($1, $2);
233 debug
("include $fn");
234 my $new_fn = prepare_adoc_file
($target_env, $fn, $attributes);
236 print $outfh "include::${new_fn}$rest\n";
240 if ($line =~ m/xref:\S+?\[[^\]]*$/) {
241 die "possible xref spanning multiple lines in '$filename':\n(line $.): $line\n";
243 if ($line =~ m/<<((?!\>\>).)*$/) {
244 die "possible xref spanning multiple lines in '$filename':\n(line $.): $line\n";
247 $line =~ s/xref:([^\s\[\]]+)\[([^\]]*)\]/replace_xref(${target_env},$1,$2)/ge;
249 $line =~ s/<<([^\s,\[\]]+)(?:,(.*?))?>>/replace_xref(${target_env},$1,$2)/ge;
251 print $outfh $line . "\n";
257 sub compile_asciidoc
{
262 GetOptions
("outfile=s" => \
$outfile,
263 "keep-artifacts" => \
$keep_artifacts,
264 "verbose" => \
$verbose) or
265 die("Error in command line arguments\n");
267 my $infile = shift(@ARGV) or
268 die "no input file specified\n";
270 scalar(@ARGV) == 0 or
271 die "too many arguments...\n";
273 my $outfilemap = $fileinfo->{outfile
}->{$env}->{$infile} ||
274 die "no output file mapping for '$infile' ($env)";
276 if ($man_target eq 'html') {
277 $outfilemap .= '.html';
278 } elsif ($man_target eq 'wiki') {
279 $outfilemap .= '-plain.html';
282 if (defined($outfile)) {
283 die "wrong output file name '$outfile != $outfilemap' ($env)"
284 if $outfile ne $outfilemap;
286 $outfile = $outfilemap;
289 defined($fileinfo->{titles
}->{$env}) ||
290 die "unknown environment '$env'";
292 my $title = $fileinfo->{titles
}->{$env}->{$infile} or
293 die "unable to get title for '$infile'$env\n";
295 debug
("compile $title");
299 my $doctype = $fileinfo->{doctype
}->{$env}->{$infile};
301 die "unable to get document type for '$infile'\n"
302 if !defined($doctype);
304 $leveloffset = - $doctype;
307 if (defined($ENV{SOURCE_DATE_EPOCH
})) {
308 $date = `date -d "\@$ENV{SOURCE_DATE_EPOCH}"`;
316 leveloffset
=> $leveloffset,
317 revnumber
=> $release,
319 'footer-style' => 'revdate',
322 my $mansection = $fileinfo->{mansection
}->{$env}->{$infile};
324 if ($env eq 'wiki') {
325 } elsif ($env eq 'manvolnum') {
326 die "undefined man section" if !defined($mansection);
327 $attributes->{manvolnum
} = $mansection;
328 } elsif ($env eq 'default') {
329 die "$infile: wrong doctype\n" if $doctype != 0;
330 $attributes->{toc2
} = undef;
333 if (!defined($outfile)) {
335 $outfile =~ s/\.adoc$//;
336 if ($env eq 'manvolnum') {
337 if (($man_target eq 'html') || ($man_target eq 'wiki')) {
338 $outfile .= ".$mansection.html";
340 $outfile .= ".$mansection";
347 if (($env eq 'manvolnum') && ($man_target eq 'man')) {
349 # asciidoc /etc/asciidoc/docbook-xsl/manpage.xsl skip REFERENCES
350 # section like footnotes, so we cannot use a2x.
351 # We use xmlto instead.
353 my $cmd = ['asciidoc', '-dmanpage', '-bdocbook',
354 '-f', "$adoc_source_dir/asciidoc/asciidoc-pve.conf",
357 foreach my $key (keys %$attributes) {
358 my $value = $attributes->{$key};
359 if (defined($value)) {
360 push @$cmd, '-a', "$key=$value";
362 push @$cmd, '-a', $key;
366 push @$cmd, '--verbose' if $verbose;
368 my $tmpxmlfile = "${outfile}.xml.tmp";
370 push @$cmd, '--out-file', $tmpxmlfile;
372 push @$files_for_cleanup, $tmpxmlfile;
374 my $new_infile = prepare_adoc_file
($env, $infile, $attributes);
376 push @$cmd, $new_infile;
378 debug
("run " . join(' ', @$cmd));
380 system(@$cmd) == 0 or
383 $cmd = ['xmlto', 'man', $tmpxmlfile];
385 push @$cmd, '-v' if $verbose;
387 debug
("run " . join(' ', @$cmd));
389 system(@$cmd) == 0 or
394 $attributes->{icons
} = undef;
395 $attributes->{'data-uri'} = undef;
397 my $cmd = ['asciidoc',
398 '-f', "$adoc_source_dir/asciidoc/asciidoc-pve.conf",
401 if (($env eq 'wiki') ||
402 (($env eq 'manvolnum') && ($man_target eq 'wiki'))) {
404 push @$cmd, '-b', "$adoc_source_dir/asciidoc/mediawiki";
406 push @$cmd, '-b', "$adoc_source_dir/asciidoc/pve-html";
409 foreach my $key (keys %$attributes) {
410 my $value = $attributes->{$key};
411 if (defined($value)) {
412 push @$cmd, '-a', "$key=$value";
414 push @$cmd, '-a', $key;
418 push @$cmd, '--verbose' if $verbose;
420 push @$cmd, '--out-file', $outfile;
422 my $new_infile = prepare_adoc_file
($env, $infile, $attributes);
424 push @$cmd, $new_infile;
426 debug
("run " . join(' ', @$cmd));
428 system(@$cmd) == 0 or
437 foreach my $blockid (sort keys %{$fileinfo->{blockid_target
}->{default}}) {
438 my $link = $fileinfo->{blockid_target
}->{default}->{$blockid};
439 my $reftitle = $fileinfo->{reftitle
}->{default}->{$blockid};
440 my $reftext = $fileinfo->{reftext
}->{default}->{$blockid};
441 die "internal error" if $link !~ m/^link:/;
444 my $file = $fileinfo->{blockid
}->{default}->{$blockid};
445 die "internal error - no filename" if ! defined($file);
446 my $title = $fileinfo->{titles
}->{default}->{$file} ||
447 die "internal error - no title";
449 $data->{$blockid}->{title
} = $title;
450 $data->{$blockid}->{link} = $link;
451 my $subtitle = $reftitle || $reftext;
452 $data->{$blockid}->{subtitle
} = $subtitle
453 if $subtitle && ($title ne $subtitle);
459 sub scan_extjs_file
{
460 my ($filename, $res_data) = @_;
462 my $fh = IO
::File-
>new($filename, "r") ||
463 die "unable to open '$filename' - $!\n";
465 debug
("scan-extjs $filename");
467 while(defined(my $line = <$fh>)) {
468 if ($line =~ m/\s+onlineHelp:\s*[\'\"](.*?)[\'\"]/) {
470 my $link = $fileinfo->{blockid_target
}->{default}->{$blockid};
471 die "undefined blockid '$blockid' ($filename, line $.)\n"
472 if !(defined($link) || defined($online_help_links->{$blockid}));
474 $res_data->{$blockid} = 1;
479 if ($clicmd eq 'compile-wiki') {
481 eval { compile_asciidoc
('wiki'); };
488 } elsif ($clicmd eq 'compile-chapter') {
490 eval { compile_asciidoc
('default'); };
497 } elsif ($clicmd eq 'compile-man-html') {
499 $man_target = 'html';
501 eval { compile_asciidoc
('manvolnum'); };
508 } elsif ($clicmd eq 'compile-man-wiki') {
510 $man_target = 'wiki';
512 eval { compile_asciidoc
('manvolnum'); };
519 } elsif ($clicmd eq 'compile-man') {
521 eval { compile_asciidoc
('manvolnum'); };
528 } elsif ($clicmd eq 'print-links') {
532 GetOptions
("outfile=s" => \
$outfile,
533 "verbose" => \
$verbose) or
534 die("Error in command line arguments\n");
536 scalar(@ARGV) == 0 or
537 die "too many arguments...\n";
539 my $data = get_links
();
541 my $res = to_json
($data, { pretty
=> 1, canonical
=> 1 } );
543 if (defined($outfile)) {
544 my $outfh = IO
::File-
>new("$outfile", "w") or
545 die "unable to open temporary file '$outfile'\n";
554 } elsif ($clicmd eq 'scan-extjs') {
556 GetOptions
("verbose" => \
$verbose) or
557 die("Error in command line arguments\n");
560 my $scanned_files = {};
561 while (my $filename = shift) {
562 die "got strange file name '$filename'\n"
563 if $filename !~ m/\.js$/;
564 next if $scanned_files->{$filename};
566 scan_extjs_file
($filename, $link_hash);
567 $scanned_files->{$filename} = 1;
570 my $data = get_links
();
574 foreach my $blockid (keys %$link_hash) {
575 $res_data->{$blockid} = $data->{$blockid} || $online_help_links->{$blockid} ||
576 die "internal error - no data for '$blockid'";
579 my $data_str = to_json
($res_data, { pretty
=> 1, canonical
=> 1 });
582 print "const pveOnlineHelpInfo = ${data_str};\n";
584 } elsif ($clicmd eq 'chapter-table') {
586 print '[width="100%",options="header"]' . "\n";
588 print "|Title|Link\n";
590 my $filelist = $fileinfo->{outfile
}->{default};
591 foreach my $sourcefile (sort keys %$filelist) {
592 my $target = $filelist->{$sourcefile};
593 next if $target eq 'pve-admin-guide.html';
594 my $title = $fileinfo->{titles
}->{default}->{$sourcefile} ||
595 die "not title for '$sourcefile'";
596 print "|$title|link:$target\[\]\n";
601 } elsif ($clicmd =~ m/^man([158])page-table$/) {
604 print '[width="100%",cols="5*d",options="header"]' . "\n";
606 print "|Name 3+|Title|Link\n";
608 my $filelist = $fileinfo->{outfile
}->{manvolnum
};
609 foreach my $manpage (sort keys %$filelist) {
610 next if $section ne $fileinfo->{mansection
}->{manvolnum
}->{$manpage};
611 my $mantitle = $fileinfo->{titles
}->{manvolnum
}->{$manpage} ||
612 die "not manual title for '$manpage'";
613 my $title = $fileinfo->{titles
}->{default}->{$manpage} ||
614 die "not title for '$manpage'";
616 # hack - remove command name prefix from titles
617 $title =~ s/^[a-z]+\s*-\s*//;
619 my $target = $filelist->{$manpage};
620 print "|$mantitle 3+|$title|link:$target.html\[$target\]\n";
627 die "unknown command '$clicmd'\n";