]>
git.proxmox.com Git - pve-docs.git/blob - scan-adoc-refs
14 pvelogo
=> 0, # ignore
20 "pve-admin-guide.adoc" => "pve-admin-guide.html",
21 "datacenter.cfg.adoc" => "datacenter.cfg.5.html",
22 "ha-manager.adoc" => "chapter-ha-manager.html",
23 "pct.adoc" => "chapter-pct.html",
24 "pve-bibliography.adoc" => "chapter-pve-bibliography.html",
25 "pve-firewall.adoc" => "chapter-pve-firewall.html",
26 "pve-installation.adoc" => "chapter-pve-installation.html",
27 "pvecm.adoc" => "chapter-pvecm.html",
28 "pvesm.adoc" => "chapter-pvesm.html",
29 "pveum.adoc" => "chapter-pveum.html",
30 "qm.adoc" => "chapter-qm.html",
31 "sysadmin.adoc" => "chapter-sysadmin.html",
32 "vzdump.adoc" => "chapter-vzdump.html",
33 "pmxcfs.adoc" => "chapter-pmxcfs.html",
34 "pve-faq.adoc" => "chapter-pve-faq.html",
40 foreach my $e (keys %$environments) {
41 push @$start_env, $e if $environments->{$e};
44 my $env_stack = [$start_env];
45 my $env_name_stack = [];
47 sub reset_environment_stack
{
48 $env_stack = [$start_env];
52 sub push_environment
{
55 die "undefined environment '$env'\n" if !defined($environments->{$env});
57 # FIXME: this seems wrong (nested env?)?
58 return if !$environments->{$env}; # do not track
62 foreach my $e (@{$env_stack->[-1]}) {
67 die "empty environment" if !scalar($new_env);
68 push @$env_stack, $new_env;
70 push @$env_stack, [$env];
73 push @$env_name_stack, $env;
79 die "undefined environment '$env'\n" if !defined($environments->{$env});
81 return if !$environments->{$env}; # do not track
84 my $res = pop @$env_name_stack;
86 die "environment missmatch ($res != $env)\n" if $res ne $env;
89 sub register_include
{
90 my ($filename, $include_filename, $env_list) = @_;
92 return if $include_filename !~ m/\.adoc$/; # skip attributes.txt
94 foreach my $e (@$env_list) {
95 $fileinfo->{include
}->{$e}->{$filename}->{$include_filename} = 1;
99 sub register_blockid
{
100 my ($filename, $blockid, $reftext, $env_list) = @_;
102 foreach my $e (@$env_list) {
103 my $fn = $fileinfo->{blockid
}->{$e}->{$blockid};
104 die "blockid '$blockid' already defined in $fn"
106 $fileinfo->{blockid
}->{$e}->{$blockid} = $filename;
107 $fileinfo->{reftext
}->{$e}->{$blockid} = $reftext
108 if defined($reftext);
113 my ($filename, $env, $doctype, $title, $blockid) = @_;
115 # fixme: what about other macros?
116 $title =~ s/\{pve\}/Proxmox VE/g;
117 $title =~ s!http://\S+\[(.*?)\]!$1!g;
119 # register document title (onyl once)
120 if (!defined($fileinfo->{titles
}->{$env}->{$filename})) {
122 $fileinfo->{titles
}->{$env}->{$filename} = $title;
124 if (defined($doctype)) {
125 $fileinfo->{doctype
}->{$env}->{$filename} = $doctype;
127 die "unable to change title (no doctype)"
128 if !defined($fileinfo->{doctype
}->{$env}->{$filename});
131 if (defined($doctype) && ($env eq 'manvolnum') && ($doctype == 0)) {
132 if ($title =~ m/.*\(([1-8])\)\s*$/) {
133 $fileinfo->{mansection
}->{$env}->{$filename} = $1;
140 if !defined($fileinfo->{blockid
}->{$env}->{$blockid});
141 $fileinfo->{reftitle
}->{$env}->{$blockid} = $title;
148 reset_environment_stack
();
150 # print "SCAN $filename\n";
152 my $fh = IO
::File-
>new("$filename", "r") or
153 die "unable to open file '$filename' - $!\n";
155 my $env_last_line = {};
156 my $env_last_blockid = {};
158 while (defined (my $line = <$fh>)) {
159 if ($line =~ m/^if(n?)def::(\S+)\[(.*)\]\s*$/) {
160 my ($not, $env, $text) = ($1, $2, $3);
161 die "unsuported ifdef usage - implement me" if $text;
162 push_environment
($env, $not);
164 } elsif ($line =~ m/^endif::(\S+)\[(.*)\]\s*$/) {
165 my ($env, $text) = ($1, $2);
166 die "unsuported ifdef usage - implement me" if $text;
167 pop_environment
($env);
169 } elsif ($line =~ m/^include::(\S+)\[.*\]\s*$/) {
170 register_include
($filename, $1, $env_stack->[-1]);
174 # try to detect titles
175 foreach my $e (@{$env_stack->[-1]}) {
176 if ($line =~ m/^=====+$/) {
177 register_title
($filename, $e, 0, $env_last_line->{$e},
178 $env_last_blockid->{$e});
179 } elsif ($line =~ m/^-----+$/) {
180 register_title
($filename, $e, 1, $env_last_line->{$e},
181 $env_last_blockid->{$e});
182 } elsif ($line =~ m/^~~~~~+$/) {
183 register_title
($filename, $e, 2, $env_last_line->{$e},
184 $env_last_blockid->{$e});
185 } elsif ($line =~ m/^\^\^\^\^\^+$/) {
186 register_title
($filename, $e, 3, $env_last_line->{$e},
187 $env_last_blockid->{$e});
188 } elsif ($line =~ m/^= +(\S.*?)( +=)?$/) {
189 register_title
($filename, $e, 0, $1, $env_last_blockid->{$e});
190 } elsif ($line =~ m/^== +(\S.*?)( +==)?$/) {
191 register_title
($filename, $e, 1, $1, $env_last_blockid->{$e});
192 } elsif ($line =~ m/^=== +(\S.*?)( +===)?$/) {
193 register_title
($filename, $e, 2, $1, $env_last_blockid->{$e});
194 } elsif ($line =~ m/^==== +(\S.*?)( +====)?$/) {
195 register_title
($filename, $e, 3, $1, $env_last_blockid->{$e});
198 $env_last_line->{$e} = $line;
199 chomp $env_last_line->{$e};
202 if ($line =~ m/^:(\S+?):\s*(.*\S)?\s*$/) {
203 my ($key, $value) = ($1, $2);
204 if ($key eq 'pve-toplevel') {
206 foreach my $e (@{$env_stack->[-1]}) {
207 my $title = $fileinfo->{titles
}->{$e}->{$filename};
208 die "not title for toplevel file '$filename' (env=$e)\n"
210 $fileinfo->{toplevel
}->{$e}->{$filename} = 1;
212 } elsif ($key eq 'title') {
213 foreach my $e (@{$env_stack->[-1]}) {
214 register_title
($filename, $e, undef, $value);
219 if ($line =~ m/^\[\[(.*)\]\]\s*$/) {
221 die "implement me" if $blockid =~m/,/;
223 register_blockid
($filename, $blockid, $reftext, $env_stack->[-1]);
224 foreach my $e (@{$env_stack->[-1]}) {
225 $env_last_blockid->{$e} = $blockid;
229 if ($line =~ m/^\s*$/) {
230 foreach my $e (@{$env_stack->[-1]}) {
231 delete $env_last_blockid->{$e};
236 # bibliography anchors
237 if ($line =~ m/\[\[\[([^\]]*)\]\]\]/) {
239 die "implement me" if $blockid =~m/,/;
240 register_blockid
($filename, $blockid, "[$blockid]", $env_stack->[-1]);
245 my $scanned_files = {};
246 while (my $filename = shift) {
247 next if $filename !~ m/\.adoc$/; # skip attributes.txt
248 next if $scanned_files->{$filename};
250 scan_adoc_file
($filename);
251 $scanned_files->{$filename} = 1;
254 sub resolve_link_target
{
255 my ($env, $filename) = @_;
257 my $include_hash = $fileinfo->{include
}->{$env};
263 foreach my $fn (keys %$include_hash) {
264 if ($include_hash->{$fn}->{$filename}) {
265 next if ($fn eq 'pve-admin-guide.adoc') &&
266 $fileinfo->{outfile
}->{$env}->{$filename};
278 # try to generate output file mapping
279 foreach my $e (@$start_env) {
280 my $toplevel_hash = $fileinfo->{toplevel
}->{$e};
281 foreach my $fn (sort keys %$toplevel_hash) {
282 my $mansection = $fileinfo->{mansection
}->{manvolnum
}->{$fn};
285 $realfn =~ s/\.adoc$//;
286 if (defined($mansection) && ($mansection == 5)) {
287 $realfn .= ".$mansection";
289 $realfn = "$realfn-plain.html";
290 $fileinfo->{outfile
}->{$e}->{$fn} = $realfn;
291 } elsif ($e eq 'manvolnum') {
293 $realfn =~ s/\.adoc$//;
294 die "toplevel file '$fn' is marhes as manual page!" if !$mansection;
295 $realfn .= ".$mansection";
296 $fileinfo->{outfile
}->{$e}->{$fn} = $realfn;
301 # now resolve blockids
302 foreach my $e (@$start_env) {
303 my $blockid_hash = $fileinfo->{blockid
}->{$e};
304 foreach my $blockid (keys %$blockid_hash) {
305 my $fn = resolve_link_target
($e, $blockid_hash->{$blockid});
307 my $title = $fileinfo->{titles
}->{$e}->{$fn};
309 die "found not title for '$fn' in env '$e'" if !$title;
310 $fileinfo->{blockid_target
}->{$e}->{$blockid} = "link:/wiki/$title#$blockid";
312 # we do not produce wiki pages for all content
313 #my $realfn = $fileinfo->{outfile}->{$e}->{$fn};
314 #warn "no output file mapping for '$fn' ($e)\n" if !$realfn;
316 } elsif ($e eq 'default') {
317 my $realfn = $fileinfo->{outfile
}->{$e}->{$fn} ||
318 die "no output file mapping for '$fn'\n";
319 $fileinfo->{blockid_target
}->{$e}->{$blockid} = "link:/pve-docs/$realfn#$blockid";
320 } elsif ($e eq 'manvolnum') {
321 # we do not produce manpages for all content
322 # my $realfn = $fileinfo->{outfile}->{$e}->{$fn} ||
323 # warn "no output file mapping for '$fn'\n";
324 $fileinfo->{blockid_target
}->{$e}->{$blockid} = $fn;
330 print to_json
($fileinfo, { pretty
=> 1, canonical
=> 1 } );