]> git.proxmox.com Git - pve-docs.git/blobdiff - scan-adoc-refs
scan-adoc-refs: allow to overwrite title using attribute
[pve-docs.git] / scan-adoc-refs
index 613f282c6b72aa0abdc8c3efd0a3c9032a53d35c..3885348fc7fc9762cc74c8366b39d9a722e2b8d7 100755 (executable)
@@ -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 = [];
@@ -95,6 +89,23 @@ 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});
+    }
+}
+
 sub scan_adoc_file {
     my ($filename) = @_;
 
@@ -128,17 +139,35 @@ 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*$/) {
@@ -176,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;
@@ -195,7 +223,6 @@ 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";