X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=scan-adoc-refs;h=03dc51cf59f668da803c738d3fbb09b8f58b3ea4;hp=1ddc9350d4e98815620fc25bb684704316368111;hb=f3c27fb1e259372edb0a89af54481a95c6d82d97;hpb=835dd63b03c3ca79ae0a9fa799d50a259fd7dab5

diff --git a/scan-adoc-refs b/scan-adoc-refs
index 1ddc935..03dc51c 100755
--- a/scan-adoc-refs
+++ b/scan-adoc-refs
@@ -14,14 +14,53 @@ my $environments = {
     pvelogo => 0, # ignore
 };
 
-my $resolve_skip_files = {
-    default => {},
-    wiki => { 'pve-admin-guide.adoc' => 1 },
-    manvolnum => {},
+my $fileinfo = {
+    outfile => {
+	default => {
+	    "pve-admin-guide.adoc" => "pve-admin-guide.html",
+	    "datacenter.cfg.adoc" => "datacenter.cfg.5.html",
+	    "ha-manager.adoc" => "chapter-ha-manager.html",
+	    "pct.adoc" => "chapter-pct.html",
+	    "pve-bibliography.adoc" => "chapter-pve-bibliography.html",
+	    "pve-firewall.adoc" => "chapter-pve-firewall.html",
+	    "pve-installation.adoc" => "chapter-pve-installation.html",
+	    "pvecm.adoc" => "chapter-pvecm.html",
+	    "pvesm.adoc" => "chapter-pvesm.html",
+	    "pveum.adoc" => "chapter-pveum.html",
+	    "qm.adoc" => "chapter-qm.html",
+	    "sysadmin.adoc" => "chapter-sysadmin.html",
+	    "vzdump.adoc" => "chapter-vzdump.html",
+	    "pmxcfs.adoc" => "chapter-pmxcfs.html",
+	    "pve-faq.adoc" => "chapter-pve-faq.html",
+	},
+	manvolnum => {
+	    "ha-manager.adoc" => "ha-manager.1",
+	    "pct.adoc" => "pct.1",
+	    "pveam.adoc" => "pveam.1",
+	    "pveceph.adoc" => "pveceph.1",
+	    "pvecm.adoc" => "pvecm.1",
+	    "pveperf.adoc" => "pveperf.1",
+	    "pvesm.adoc" => "pvesm.1",
+	    "pvesubscription.adoc" => "pvesubscription.1",
+	    "pveum.adoc" => "pveum.1",
+	    "qm.adoc" => "qm.1",
+	    "qmrestore.adoc" => "qmrestore.1",
+	    "vzdump.adoc" => "vzdump.1",
+	    "datacenter.cfg.adoc" => "datacenter.cfg.5",
+	    "pct.conf.adoc" => "pct.conf.5",
+	    "qm.conf.adoc" => "qm.conf.5",
+	    "pmxcfs.adoc" => "pmxcfs.8",
+	    "pvedaemon.adoc" => "pvedaemon.8",
+	    "pve-firewall.adoc" => "pve-firewall.8",
+	    "pve-ha-crm.adoc" => "pve-ha-crm.8",
+	    "pve-ha-lrm.adoc" => "pve-ha-lrm.8",
+	    "pveproxy.adoc" => "pveproxy.8",
+	    "pvestatd.adoc" => "pvestatd.8",
+	    "spiceproxy.adoc" => "spiceproxy.8",
+	},
+    },
 };
 
-my $fileinfo = {};
-
 my $start_env = [];
 foreach my $e (keys %$environments) {
     push @$start_env, $e if $environments->{$e};
@@ -83,13 +122,48 @@ 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});
+	}
+
+	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 +178,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,26 +198,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, "&#91;$blockid&#93;", $env_stack->[-1]);
 	}
     }
 }
@@ -166,8 +286,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;
@@ -178,6 +299,24 @@ 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";
+	    }
+	    my $realfn = "$realfn-plain.html";
+	    $fileinfo->{outfile}->{$e}->{$fn} = $realfn;
+	}
+    }
+}
+
 # now resolve blockids
 foreach my $e (@$start_env) {
     my $blockid_hash = $fileinfo->{blockid}->{$e};
@@ -186,14 +325,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 } );