scan-adoc-refs: allow to overwrite title using attribute

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

diff --git a/scan-adoc-refs b/scan-adoc-refs
index a4e46d1885a111245b00856e8260d96ff46b9b84..3885348fc7fc9762cc74c8366b39d9a722e2b8d7 100755 (executable)
--- a/scan-adoc-refs
+++ b/scan-adoc-refs
@@ -14,12 +14,6 @@ my $environments = {
     pvelogo => 0, # ignore
 };
 
-my $resolve_skip_files = {
-    default => {},
-    wiki => { 'pve-admin-guide.adoc' => 1 },
-    manvolnum => {},
-};
-
 my $fileinfo = {};
 
 my $start_env = [];
@@ -40,8 +34,9 @@ sub push_environment {
 
     die "undefined environment '$env'\n" if !defined($environments->{$env});
 
+    # FIXME: this seems wrong  (nested env?)?
     return if !$environments->{$env}; # do not track
-    
+
     if ($not) {
        my $new_env = [];
        foreach my $e (@{$env_stack->[-1]}) {
@@ -54,7 +49,7 @@ sub push_environment {
     } else {
        push @$env_stack, [$env];
     }
-    
+
     push @$env_name_stack, $env;
 }
 
@@ -62,12 +57,12 @@ sub pop_environment {
     my ($env) = @_;
 
     die "undefined environment '$env'\n" if !defined($environments->{$env});
-   
+
     return if !$environments->{$env}; # do not track
 
     pop @$env_stack;
     my $res = pop @$env_name_stack;
-    
+
     die "environment missmatch ($res != $env)\n" if $res ne $env;
 }
 
@@ -82,13 +77,32 @@ sub register_include {
 }
 
 sub register_blockid {
-    my ($filename, $blockid, $env_list) = @_;
+    my ($filename, $blockid, $reftext, $env_list) = @_;
 
     foreach my $e (@$env_list) {
        my $fn = $fileinfo->{blockid}->{$e}->{$blockid};
-       die "blockid '$blockid' already defined in $fn" 
+       die "blockid '$blockid' already defined in $fn"
            if defined($fn);
        $fileinfo->{blockid}->{$e}->{$blockid} = $filename;
+       $fileinfo->{reftext}->{$e}->{$blockid} = $reftext
+           if defined($reftext);
+    }
+}
+
+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});
     }
 }
 
@@ -96,17 +110,17 @@ sub scan_adoc_file {
     my ($filename) = @_;
 
     reset_environment_stack();
-    
+
     # print "SCAN $filename\n";
 
     my $fh = IO::File->new("$filename", "r") or
        die "unable to open file '$filename' - $!\n";
 
     my $env_last_line = {};
-    
+
     while (defined (my $line = <$fh>)) {
        if ($line =~ m/^if(n?)def::(\S+)\[(.*)\]\s*$/) {
-           my ($not, $env, $text) = ($1, $2);
+           my ($not, $env, $text) = ($1, $2, $3);
            die "unsuported ifdef usage - implement me" if $text;
            push_environment($env, $not);
            next;
@@ -125,25 +139,51 @@ sub scan_adoc_file {
            my $title = $fileinfo->{titles}->{$e}->{$filename};
            next if defined($title);
 
-           if (($line =~ m/^=====+/) || ($line =~ m/^-----+/)) {
-               $fileinfo->{titles}->{$e}->{$filename} = $env_last_line->{$e};
+           if ($line =~ m/^=====+$/) {
+               register_title($filename, $e, 0, $env_last_line->{$e});
+           } elsif ($line =~ m/^-----+$/) {
+               register_title($filename, $e, 1, $env_last_line->{$e});
+           } elsif ($line =~ m/^= +(\S.*?)( +=)?$/) {
+               register_title($filename, $e, 0, $1);
+           } elsif ($line =~ m/^== +(\S.*?)( +==)?$/) {
+               register_title($filename, $e, 1, $1);
            }
+
            $env_last_line->{$e} = $line;
            chomp $env_last_line->{$e};
        }
-       
-       # fixme: also scan <<>>
-       
-       while ($line =~ m/xref:([^\s\[\]]+)\[([^\]]*)\]/g) {
-           # print "$filename xref:$1 [$2]\n";
+
+       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);
+               }
+           }
        }
 
        if ($line =~ m/^\[\[(.*)\]\]\s*$/) {
            my $blockid = $1;
            die "implement me" if $blockid =~m/,/;
-           register_blockid($filename, $blockid, $env_stack->[-1]);
+           my $reftext = '';
+           register_blockid($filename, $blockid, $reftext, $env_stack->[-1]);
        }
-    } 
+       # fixme: "anchor:"
+       # bibliography anchors
+       if ($line =~ m/\[\[\[([^\]]*)\]\]\]/) {
+           my $blockid = $1;
+           die "implement me" if $blockid =~m/,/;
+           register_blockid($filename, $blockid, "&#91;$blockid&#93;", $env_stack->[-1]);
+       }
+    }
 }
 
 my $scanned_files = {};
@@ -165,7 +205,6 @@ sub resolve_link_target {
     while ($repeat) {
        $repeat = 0;
        foreach my $fn (keys %$include_hash) {
-           next if $resolve_skip_files->{$env}->{$fn};
            if ($include_hash->{$fn}->{$filename}) {
                $filename = $fn;
                $repeat = 1;
@@ -173,7 +212,7 @@ sub resolve_link_target {
            }
        }
     }
-    
+
     return $filename;
 }
 
@@ -185,7 +224,6 @@ foreach my $e (@$start_env) {
        if ($e eq 'wiki') {
            my $title = $fileinfo->{titles}->{$e}->{$fn};
            $title =~ s/\s/_/g;
-           $title =~ s/\{pve\}/Proxmox VE/g;
            die "found not title for '$fn' in env '$e'" if !$title;
            $fileinfo->{blockid_target}->{$e}->{$blockid} = "link:/wiki/$title#$blockid";
        } else {
@@ -196,4 +234,3 @@ foreach my $e (@$start_env) {
 
 
 print to_json($fileinfo, { pretty => 1 } );
-