]>
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
"attributes.txt" && -f
"pve-admin-guide.adoc") {
32 $adoc_source_dir = "."
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 die "link target is not a manual page" if !defined($section);
152 if ($man_target eq 'html') {
154 $target =~ s/\.adoc//;
155 $target .= ".$section";
156 return "link:${target}.html#${blockid}\[$text\]";
157 } elsif ($man_target eq 'man') {
159 $command =~ s/\.adoc//;
160 return "\*${text}\* (man \*${command}\*($section))";
167 my ($env, $blockid, $text) = @_;
169 if ($env eq 'wiki') {
170 return replace_wiki_xref
($blockid, $text);
171 } elsif ($env eq 'manvolnum') {
172 if (($man_target eq 'man') || ($man_target eq 'html')) {
173 return replace_man_xref
($blockid, $text);
174 } elsif ($man_target eq 'wiki') {
175 return replace_wiki_xref
($blockid, $text);
179 } elsif ($env eq 'default') {
180 return replace_default_xref
($blockid, $text);
182 die "internal error";
186 sub prepare_adoc_file
{
187 my ($target_env, $filename, $attributes) = @_;
189 return $prepared_files->{$filename} if defined($prepared_files->{$filename});
191 debug
("prepare $filename");
193 my $dirname = dirname
($filename);
194 my $basename = basename
($filename);
196 my $outfilename = "$dirname/${tmpprefix}$basename";
198 $prepared_files->{$filename} = $outfilename;
200 my $fh = IO
::File-
>new("$filename", "r") or
201 die "unable to open file '$filename' - $!\n";
203 my $outfh = IO
::File-
>new("$outfilename", "w") or
204 die "unable to open temporary file '$outfilename'\n";
206 push @$files_for_cleanup, $outfilename;
208 while (defined (my $line = <$fh>)) {
210 if ($line =~ m/^if(n?)def::(\S+)\[(.*)\]\s*$/) {
211 my ($not, $env, $text) = ($1, $2, $3);
212 die "unsuported ifdef usage - implement me" if $text;
214 my $skip = !exists($attributes->{$env}) ?
1 : 0;
215 $skip = ($skip ?
0 : 1 ) if $not;
217 push_environment
($env, $skip);
219 } elsif ($line =~ m/^endif::(\S+)\[(.*)\]\s*$/) {
220 my ($env, $text) = ($1, $2);
221 die "unsuported ifdef usage - implement me" if $text;
222 pop_environment
($env);
228 if ($line =~ m/^include::(\S+)(\[.*\]\s*)$/) {
229 my ($fn, $rest) = ($1, $2);
230 debug
("include $fn");
231 my $new_fn = prepare_adoc_file
($target_env, $fn, $attributes);
233 print $outfh "include::${new_fn}$rest\n";
238 $line =~ s/xref:([^\s\[\]]+)\[([^\]]*)\]/replace_xref(${target_env},$1,$2)/ge;
240 $line =~ s/<<([^\s,\[\]]+)(?:,(.*?))?>>/replace_xref(${target_env},$1,$2)/ge;
242 print $outfh $line . "\n";
248 sub compile_asciidoc
{
253 GetOptions
("outfile=s" => \
$outfile,
254 "keep-artifacts" => \
$keep_artifacts,
255 "verbose" => \
$verbose) or
256 die("Error in command line arguments\n");
258 my $infile = shift(@ARGV) or
259 die "no input file specified\n";
261 scalar(@ARGV) == 0 or
262 die "too many arguments...\n";
264 my $outfilemap = $fileinfo->{outfile
}->{$env}->{$infile} ||
265 die "no output file mapping '$infile => $outfile' ($env)";
267 if ($man_target eq 'html') {
268 $outfilemap .= '.html';
269 } elsif ($man_target eq 'wiki') {
270 $outfilemap .= '-plain.html';
273 die "wrong output file name '$outfile != $outfilemap' ($env)"
274 if $outfile ne $outfilemap;
276 defined($fileinfo->{titles
}->{$env}) ||
277 die "unknown environment '$env'";
279 my $title = $fileinfo->{titles
}->{$env}->{$infile} or
280 die "unable to get title for '$infile'$env\n";
282 debug
("compile $title");
286 my $doctype = $fileinfo->{doctype
}->{$env}->{$infile};
288 die "unable to get document type for '$infile'\n"
289 if !defined($doctype);
291 $leveloffset = - $doctype;
298 leveloffset
=> $leveloffset,
299 revnumber
=> $release,
303 my $mansection = $fileinfo->{mansection
}->{$env}->{$infile};
305 if ($env eq 'wiki') {
306 } elsif ($env eq 'manvolnum') {
307 die "undefined man section" if !defined($mansection);
308 $attributes->{manvolnum
} = $mansection;
309 } elsif ($env eq 'default') {
310 die "$infile: wrong doctype\n" if $doctype != 0;
311 $attributes->{toc
} = undef;
314 if (!defined($outfile)) {
316 $outfile =~ s/\.adoc$//;
317 if ($env eq 'manvolnum') {
318 if (($man_target eq 'html') || ($man_target eq 'wiki')) {
319 $outfile .= ".$mansection.html";
321 $outfile .= ".$mansection";
328 if (($env eq 'manvolnum') && ($man_target eq 'man')) {
330 # asciidoc /etc/asciidoc/docbook-xsl/manpage.xsl skip REFERENCES
331 # section like footnotes, so we cannot use a2x.
332 # We use xmlto instead.
334 my $cmd = ['asciidoc', '-dmanpage', '-bdocbook', '-a', 'docinfo1'];
336 foreach my $key (keys %$attributes) {
337 my $value = $attributes->{$key};
338 if (defined($value)) {
339 push @$cmd, '-a', "$key=$value";
341 push @$cmd, '-a', $key;
345 push @$cmd, '--verbose' if $verbose;
347 my $tmpxmlfile = "${outfile}.xml.tmp";
349 push @$cmd, '--out-file', $tmpxmlfile;
351 push @$files_for_cleanup, $tmpxmlfile;
353 my $new_infile = prepare_adoc_file
($env, $infile, $attributes);
355 push @$cmd, $new_infile;
357 debug
("run " . join(' ', @$cmd));
359 system(@$cmd) == 0 or
362 $cmd = ['xmlto', 'man', $tmpxmlfile];
364 push @$cmd, '-v' if $verbose;
366 debug
("run " . join(' ', @$cmd));
368 system(@$cmd) == 0 or
373 $attributes->{icons
} = undef;
374 $attributes->{'data-uri'} = undef;
376 my $cmd = ['asciidoc'];
378 if (($env eq 'wiki') ||
379 (($env eq 'manvolnum') && ($man_target eq 'wiki'))) {
383 if (-f
"./asciidoc/mediawiki.conf") {
385 push @$cmd, '-b', "$cwd/asciidoc/mediawiki";
387 push @$cmd, '-b', "mediawiki";
391 foreach my $key (keys %$attributes) {
392 my $value = $attributes->{$key};
393 if (defined($value)) {
394 push @$cmd, '-a', "$key=$value";
396 push @$cmd, '-a', $key;
400 push @$cmd, '--verbose' if $verbose;
402 push @$cmd, '--out-file', $outfile;
404 my $new_infile = prepare_adoc_file
($env, $infile, $attributes);
406 push @$cmd, $new_infile;
408 debug
("run " . join(' ', @$cmd));
410 system(@$cmd) == 0 or
419 foreach my $blockid (sort keys %{$fileinfo->{blockid_target
}->{default}}) {
420 my $link = $fileinfo->{blockid_target
}->{default}->{$blockid};
421 my $reftitle = $fileinfo->{reftitle
}->{default}->{$blockid};
422 my $reftext = $fileinfo->{reftext
}->{default}->{$blockid};
423 die "internal error" if $link !~ m/^link:/;
426 my $file = $fileinfo->{blockid
}->{default}->{$blockid};
427 die "internal error - no filename" if ! defined($file);
428 my $title = $fileinfo->{titles
}->{default}->{$file} ||
429 die "internal error - no title";
431 $data->{$blockid}->{title
} = $title;
432 $data->{$blockid}->{link} = $link;
433 my $subtitle = $reftitle || $reftext;
434 $data->{$blockid}->{subtitle
} = $subtitle
435 if $subtitle && ($title ne $subtitle);
441 sub scan_extjs_file
{
442 my ($filename, $res_data) = @_;
444 my $fh = IO
::File-
>new($filename, "r") ||
445 die "unable to open '$filename' - $!\n";
447 debug
("scan-extjs $filename");
449 while(defined(my $line = <$fh>)) {
450 if ($line =~ m/\s+onlineHelp:\s*[\'\"](.*?)[\'\"]/) {
452 my $link = $fileinfo->{blockid_target
}->{default}->{$blockid};
453 die "undefined blockid '$blockid' ($filename, line $.)\n"
454 if !(defined($link) || defined($online_help_links->{$blockid}));
456 $res_data->{$blockid} = 1;
461 if ($clicmd eq 'compile-wiki') {
463 eval { compile_asciidoc
('wiki'); };
470 } elsif ($clicmd eq 'compile-chapter') {
472 eval { compile_asciidoc
('default'); };
479 } elsif ($clicmd eq 'compile-man-html') {
481 $man_target = 'html';
483 eval { compile_asciidoc
('manvolnum'); };
490 } elsif ($clicmd eq 'compile-man-wiki') {
492 $man_target = 'wiki';
494 eval { compile_asciidoc
('manvolnum'); };
501 } elsif ($clicmd eq 'compile-man') {
503 eval { compile_asciidoc
('manvolnum'); };
510 } elsif ($clicmd eq 'print-links') {
514 GetOptions
("outfile=s" => \
$outfile,
515 "verbose" => \
$verbose) or
516 die("Error in command line arguments\n");
518 scalar(@ARGV) == 0 or
519 die "too many arguments...\n";
521 my $data = get_links
();
523 my $res = to_json
($data, { pretty
=> 1, canonical
=> 1 } );
525 if (defined($outfile)) {
526 my $outfh = IO
::File-
>new("$outfile", "w") or
527 die "unable to open temporary file '$outfile'\n";
536 } elsif ($clicmd eq 'scan-extjs') {
538 GetOptions
("verbose" => \
$verbose) or
539 die("Error in command line arguments\n");
542 my $scanned_files = {};
543 while (my $filename = shift) {
544 die "got strange file name '$filename'\n"
545 if $filename !~ m/\.js$/;
546 next if $scanned_files->{$filename};
548 scan_extjs_file
($filename, $link_hash);
549 $scanned_files->{$filename} = 1;
552 my $data = get_links
();
556 foreach my $blockid (keys %$link_hash) {
557 $res_data->{$blockid} = $data->{$blockid} || $online_help_links->{$blockid} ||
558 die "internal error - no data for '$blockid'";
561 my $data_str = to_json
($res_data, { pretty
=> 1, canonical
=> 1 });
564 print "var pveOnlineHelpInfo = ${data_str};\n";
568 die "unknown command '$clicmd'\n";