X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=scan-adoc-refs;h=2f24f331d77a1fe7e690f4a517328da7e6878b92;hp=246cd35f26c1548ff82f90dae6cc5de3653acb9d;hb=66e541d00400769a6b5aa237669968411e8a6d1b;hpb=a0ba8b4c2025c1918756ce15d93d5fc845489f7b

diff --git a/scan-adoc-refs b/scan-adoc-refs
index 246cd35..2f24f33 100755
--- 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 = [];
@@ -83,13 +77,51 @@ 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"
 	    if defined($fn);
 	$fileinfo->{blockid}->{$e}->{$blockid} = $filename;
+	$fileinfo->{reftext}->{$e}->{$blockid} = $reftext
+	    if defined($reftext);
+    }
+}
+
+sub register_title {
+    my ($filename, $env, $doctype, $title, $blockid) = @_;
+
+    # fixme: what about other macros?
+    $title =~ s/\{pve\}/Proxmox VE/g;
+    $title =~ s!http://\S+\[(.*?)\]!$1!g;
+
+    # register document title (onyl once)
+    if (!defined($fileinfo->{titles}->{$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)) {
+	if ($title =~ m/.*\(([1-8])\)\s*$/) {
+	    $fileinfo->{mansection}->{$env}->{$filename} = $1;
+	}
+    }
+
+    if ($blockid) {
+	die "internal error"
+	    if !defined($fileinfo->{blockid}->{$env}->{$blockid});
+	$fileinfo->{reftitle}->{$env}->{$blockid} = $title;
     }
 }
 
@@ -104,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*$/) {
@@ -123,33 +156,71 @@ 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/^=====+/) || ($line =~ m/^-----+/)) {
-		$fileinfo->{titles}->{$e}->{$filename} = $env_last_line->{$e};
+	    if ($line =~ m/^=====+$/) {
+		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},
+			       $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, $env_last_blockid->{$e});
+	    } elsif ($line =~ m/^== +(\S.*?)( +==)?$/) {
+		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;
 	    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]);
+	    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/\[\[\[([^\]]*)\]\]\]/) {
 	    my $blockid = $1;
 	    die "implement me" if $blockid =~m/,/;
-	    register_blockid($filename, $blockid, $env_stack->[-1]);
+	    register_blockid($filename, $blockid, "&#91;$blockid&#93;", $env_stack->[-1]);
 	}
     }
 }
@@ -173,8 +244,9 @@ 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}) {
+		next if ($fn eq 'pve-admin-guide.adoc') &&
+		    $fileinfo->{outfile}->{$env}->{$filename};
 		$filename = $fn;
 		$repeat = 1;
 		last;
@@ -185,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};
@@ -193,14 +304,25 @@ 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 {
+
+	    # 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 = $fileinfo->{outfile}->{$e}->{$fn} ||
+		die "no output file mapping for '$fn'\n";
+	    $fileinfo->{blockid_target}->{$e}->{$blockid} = "link:/pve-docs/$realfn#$blockid";
+	} 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 } );