scan-adoc-refs: extract man page section from .adoc file

[pve-docs.git] / scan-adoc-refs

diff --git a/scan-adoc-refs b/scan-adoc-refs
index 6563c3534c10041e5f28e050698a13a54a4e582e..a9f3b739750db8b81fcd763191e9a88b9cab508b 100755 (executable)
--- a/scan-adoc-refs
+++ b/scan-adoc-refs
@@ -89,6 +89,29 @@ sub register_blockid {
     }
 }
 
+sub register_title {
+    my ($filename, $env, $doctype, $title) = @_;
+
+    # fixme: what about other macros?
+    $title =~ s/\{pve\}/Proxmox VE/g;
+    $title =~ s!http://\S+\[(.*?)\]!$1!g;
+
+    $fileinfo->{titles}->{$env}->{$filename} = $title;
+
+    if (defined($doctype)) {
+       $fileinfo->{doctype}->{$env}->{$filename} = $doctype;
+    } else {
+       die "unable to change title (no doctype)"
+           if !defined($fileinfo->{doctype}->{$env}->{$filename});
+    }
+
+    if (defined($doctype) && ($env eq 'manvolnum') && ($doctype == 0)) {
+       if ($title =~ m/.*\(([1-8])\)\s*$/) {
+           $fileinfo->{mansection}->{$env}->{$filename} = $1;
+       }
+    }
+}
+
 sub scan_adoc_file {
     my ($filename) = @_;
 
@@ -123,17 +146,13 @@ sub scan_adoc_file {
            next if defined($title);
 
            if ($line =~ m/^=====+$/) {
-               $fileinfo->{titles}->{$e}->{$filename} = $env_last_line->{$e};
-               $fileinfo->{doctype}->{$e}->{$filename} = 0;
+               register_title($filename, $e, 0, $env_last_line->{$e});
            } elsif ($line =~ m/^-----+$/) {
-               $fileinfo->{titles}->{$e}->{$filename} = $env_last_line->{$e};
-               $fileinfo->{doctype}->{$e}->{$filename} = 1;
+               register_title($filename, $e, 1, $env_last_line->{$e});
            } elsif ($line =~ m/^= +(\S.*?)( +=)?$/) {
-               $fileinfo->{titles}->{$e}->{$filename} = $1;
-               $fileinfo->{doctype}->{$e}->{$filename} = 0;
+               register_title($filename, $e, 0, $1);
            } elsif ($line =~ m/^== +(\S.*?)( +==)?$/) {
-               $fileinfo->{titles}->{$e}->{$filename} = $1;
-               $fileinfo->{doctype}->{$e}->{$filename} = 1;
+               register_title($filename, $e, 1, $1);
            }
 
            $env_last_line->{$e} = $line;
@@ -143,13 +162,17 @@ sub scan_adoc_file {
        if ($line =~ m/^:(\S+?):\s*(.*\S)?\s*$/) {
            my ($key, $value) = ($1, $2);
            if ($key eq 'pve-toplevel') {
-               
+
                foreach my $e (@{$env_stack->[-1]}) {
                    my $title = $fileinfo->{titles}->{$e}->{$filename};
                    die "not title for toplevel file '$filename' (env=$e)\n"
                        if !defined($title);
                    $fileinfo->{toplevel}->{$e}->{$filename} = 1;
                }
+           } elsif ($key eq 'title') {
+               foreach my $e (@{$env_stack->[-1]}) {
+                   register_title($filename, $e, undef, $value);
+               }
            }
        }
 
@@ -188,6 +211,7 @@ sub resolve_link_target {
     while ($repeat) {
        $repeat = 0;
        foreach my $fn (keys %$include_hash) {
+           next if $fn eq 'pve-admin-guide.adoc';
            if ($include_hash->{$fn}->{$filename}) {
                $filename = $fn;
                $repeat = 1;
@@ -206,10 +230,13 @@ foreach my $e (@$start_env) {
        my $fn = resolve_link_target($e, $blockid_hash->{$blockid});
        if ($e eq 'wiki') {
            my $title = $fileinfo->{titles}->{$e}->{$fn};
-           $title =~ s/\{pve\}/Proxmox VE/g;
            $title =~ s/\s/_/g;
            die "found not title for '$fn' in env '$e'" if !$title;
            $fileinfo->{blockid_target}->{$e}->{$blockid} = "link:/wiki/$title#$blockid";
+       } elsif ($e eq 'default') {
+           my $realfn = "chapter-$fn";
+           $realfn =~ s/\.adoc/.html/;
+           $fileinfo->{blockid_target}->{$e}->{$blockid} = "link:/pve-docs/$realfn#$blockid";
        } else {
            $fileinfo->{blockid_target}->{$e}->{$blockid} = $fn;
        }