scan-adoc-refs: fix title change via attribute

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

diff --git a/scan-adoc-refs b/scan-adoc-refs
index a9f3b739750db8b81fcd763191e9a88b9cab508b..2f24f331d77a1fe7e690f4a517328da7e6878b92 100755 (executable)
--- a/scan-adoc-refs
+++ b/scan-adoc-refs
@@ -90,19 +90,26 @@ sub register_blockid {
 }
 
 sub register_title {
-    my ($filename, $env, $doctype, $title) = @_;
+    my ($filename, $env, $doctype, $title, $blockid) = @_;
 
     # fixme: what about other macros?
     $title =~ s/\{pve\}/Proxmox VE/g;
     $title =~ s!http://\S+\[(.*?)\]!$1!g;
 
-    $fileinfo->{titles}->{$env}->{$filename} = $title;
+    # register document title (onyl once)
+    if (!defined($fileinfo->{titles}->{$env}->{$filename})) {
 
-    if (defined($doctype)) {
-       $fileinfo->{doctype}->{$env}->{$filename} = $doctype;
-    } else {
-       die "unable to change title (no doctype)"
-           if !defined($fileinfo->{doctype}->{$env}->{$filename});
+       $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});
+       }
+    } elsif (!defined($doctype)) {
+       # change title via :title: attribute
+       $fileinfo->{titles}->{$env}->{$filename} = $title;
     }
 
     if (defined($doctype) && ($env eq 'manvolnum') && ($doctype == 0)) {
@@ -110,6 +117,12 @@ sub register_title {
            $fileinfo->{mansection}->{$env}->{$filename} = $1;
        }
     }
+
+    if ($blockid) {
+       die "internal error"
+           if !defined($fileinfo->{blockid}->{$env}->{$blockid});
+       $fileinfo->{reftitle}->{$env}->{$blockid} = $title;
+    }
 }
 
 sub scan_adoc_file {
@@ -123,6 +136,7 @@ sub scan_adoc_file {
        die "unable to open file '$filename' - $!\n";
 
     my $env_last_line = {};
+    my $env_last_blockid = {};
 
     while (defined (my $line = <$fh>)) {
        if ($line =~ m/^if(n?)def::(\S+)\[(.*)\]\s*$/) {
@@ -142,17 +156,26 @@ sub scan_adoc_file {
 
        # try to detect titles
        foreach my $e (@{$env_stack->[-1]}) {
-           my $title = $fileinfo->{titles}->{$e}->{$filename};
-           next if defined($title);
-
            if ($line =~ m/^=====+$/) {
-               register_title($filename, $e, 0, $env_last_line->{$e});
+               register_title($filename, $e, 0, $env_last_line->{$e},
+                              $env_last_blockid->{$e});
            } elsif ($line =~ m/^-----+$/) {
-               register_title($filename, $e, 1, $env_last_line->{$e});
+               register_title($filename, $e, 1, $env_last_line->{$e},
+                              $env_last_blockid->{$e});
+           } elsif ($line =~ m/^~~~~~+$/) {
+               register_title($filename, $e, 2, $env_last_line->{$e},
+                              $env_last_blockid->{$e});
+           } elsif ($line =~ m/^\^\^\^\^\^+$/) {
+               register_title($filename, $e, 3, $env_last_line->{$e},
+                              $env_last_blockid->{$e});
            } elsif ($line =~ m/^= +(\S.*?)( +=)?$/) {
-               register_title($filename, $e, 0, $1);
+               register_title($filename, $e, 0, $1, $env_last_blockid->{$e});
            } elsif ($line =~ m/^== +(\S.*?)( +==)?$/) {
-               register_title($filename, $e, 1, $1);
+               register_title($filename, $e, 1, $1, $env_last_blockid->{$e});
+           } elsif ($line =~ m/^=== +(\S.*?)( +===)?$/) {
+               register_title($filename, $e, 2, $1, $env_last_blockid->{$e});
+           } elsif ($line =~ m/^==== +(\S.*?)( +====)?$/) {
+               register_title($filename, $e, 3, $1, $env_last_blockid->{$e});
            }
 
            $env_last_line->{$e} = $line;
@@ -181,7 +204,17 @@ sub scan_adoc_file {
            die "implement me" if $blockid =~m/,/;
            my $reftext = '';
            register_blockid($filename, $blockid, $reftext, $env_stack->[-1]);
+           foreach my $e (@{$env_stack->[-1]}) {
+               $env_last_blockid->{$e} = $blockid;
+           }
+       }
+
+       if ($line =~ m/^\s*$/) {
+           foreach my $e (@{$env_stack->[-1]}) {
+               delete $env_last_blockid->{$e};
+           }
        }
+
        # fixme: "anchor:"
        # bibliography anchors
        if ($line =~ m/\[\[\[([^\]]*)\]\]\]/) {
@@ -211,8 +244,9 @@ 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}) {
+               next if ($fn eq 'pve-admin-guide.adoc') &&
+                   $fileinfo->{outfile}->{$env}->{$filename};
                $filename = $fn;
                $repeat = 1;
                last;
@@ -223,6 +257,45 @@ sub resolve_link_target {
     return $filename;
 }
 
+
+# try to generate output file mapping
+foreach my $e (@$start_env) {
+    my $toplevel_hash = $fileinfo->{toplevel}->{$e};
+    foreach my $fn (sort keys %$toplevel_hash) {
+       my $mansection = $fileinfo->{mansection}->{manvolnum}->{$fn};
+       if ($e eq 'wiki') {
+           my $realfn = $fn;
+           $realfn =~ s/\.adoc$//;
+           if (defined($mansection) && ($mansection == 5)) {
+               $realfn .= ".$mansection";
+           }
+           $realfn = "$realfn-plain.html";
+           $fileinfo->{outfile}->{$e}->{$fn} = $realfn;
+       } elsif ($e eq 'manvolnum') {
+           my $realfn = $fn;
+           $realfn =~ s/\.adoc$//;
+           die "toplevel file '$fn' is not marked as manual page!" if !$mansection;
+           $realfn .= ".$mansection";
+           $fileinfo->{outfile}->{$e}->{$fn} = $realfn;
+       } elsif ($e eq 'default') {
+           my $realfn = $fn;
+           $realfn =~ s/\.adoc$//;                 
+           if (defined($mansection) && ($mansection == 5)) {
+               $realfn .= ".$mansection";
+               $realfn = "$realfn.html";
+           } else {
+               if (($fn ne 'pve-admin-guide.adoc') &&
+                   $fileinfo->{doctype}->{$e}->{$fn} == 0) {
+                   $realfn = "chapter-$realfn.html";       
+               } else {
+                   $realfn = "$realfn.html";
+               }
+           }
+           $fileinfo->{outfile}->{$e}->{$fn} = $realfn;
+       }
+    }
+}
+
 # now resolve blockids
 foreach my $e (@$start_env) {
     my $blockid_hash = $fileinfo->{blockid}->{$e};
@@ -233,15 +306,23 @@ foreach my $e (@$start_env) {
            $title =~ s/\s/_/g;
            die "found not title for '$fn' in env '$e'" if !$title;
            $fileinfo->{blockid_target}->{$e}->{$blockid} = "link:/wiki/$title#$blockid";
+
+           # we do not produce wiki pages for all content
+           #my $realfn = $fileinfo->{outfile}->{$e}->{$fn};
+           #warn "no output file mapping for '$fn' ($e)\n" if !$realfn;
+
        } elsif ($e eq 'default') {
-           my $realfn = "chapter-$fn";
-           $realfn =~ s/\.adoc/.html/;
+           my $realfn = $fileinfo->{outfile}->{$e}->{$fn} ||
+               die "no output file mapping for '$fn'\n";
            $fileinfo->{blockid_target}->{$e}->{$blockid} = "link:/pve-docs/$realfn#$blockid";
-       } else {
+       } elsif ($e eq 'manvolnum') {
+           # we do not produce manpages for all content
+           # my $realfn = $fileinfo->{outfile}->{$e}->{$fn} ||
+           # warn "no output file mapping for '$fn'\n";
            $fileinfo->{blockid_target}->{$e}->{$blockid} = $fn;
        }
     }
 }
 
 
-print to_json($fileinfo, { pretty => 1 } );
+print to_json($fileinfo, { pretty => 1,  canonical => 1 } );