--------------------- PatchSet 11437 Date: 2007/05/14 14:34:21 Author: amosjeffries Branch: HEAD Tag: (none) Log: Fancy-Up the squid.conf documentation output. Made HTML templates XHTML compliant. Made inline HTML output in script XHTML instead. Added $version to split page data to create full header for small files. Members: scripts/www/build-cfg-help.pl:1.13->1.14 scripts/www/template.html:1.5->1.6 scripts/www/template_single.html:1.1->1.2 Index: squid/scripts/www/build-cfg-help.pl =================================================================== RCS file: /cvsroot/squid/squid/scripts/www/build-cfg-help.pl,v retrieving revision 1.13 retrieving revision 1.14 diff -u -r1.13 -r1.14 --- squid/scripts/www/build-cfg-help.pl 13 May 2007 22:16:56 -0000 1.13 +++ squid/scripts/www/build-cfg-help.pl 14 May 2007 14:34:21 -0000 1.14 @@ -9,7 +9,7 @@ # # Adrian Chadd # -# $Id: build-cfg-help.pl,v 1.13 2007/05/13 22:16:56 hno Exp $ +# $Id: build-cfg-help.pl,v 1.14 2007/05/14 14:34:21 amosjeffries Exp $ # # The template file is reasonably simple to parse. There's a number of @@ -161,12 +161,21 @@ $index->open(filename("index"), "w") || die "Couldn't open ".filename("index").": $!\n" if ($format eq "splithtml"); $index->open($path, "w") || die "Couldn't open ".filename("index").": $!\n" if ($format eq "singlehtml"); print $index < - + + + + Squid $version configuration file - - - + + + + + EOF ; @@ -196,6 +205,7 @@ if ($_ =~ /^NAME: (.*)$/) { my (@aliases) = split(/ /, $1); $data = {}; + $data->{'version'} = $version; foreach (@aliases) { $all_names{$_} = $data; } @@ -266,7 +276,7 @@ print $index "\n"; print $index "

Alphabetic index

\n" if $format eq "splithtml"; print $index "

Alphabetic index

\n" if $format eq "singlehtml"; -print $index "
\n" if $format eq "singlehtml"; +print $index "
\n" if $format eq "singlehtml"; # and now, build the option pages my (@names) = keys %option; @@ -284,14 +294,25 @@ $fh->open($indexname, "w") || die "Couldn't open $indexname for writing: $!\n"; $fh_open = 1; print $fh < - - Squid $version configuration file index - - + + + + + Squid $version configuration file + + + + + +

| Table of contents |

-

Alphabetic index of all options

+

Alphabetic index of all options

EOF ; } elsif ($format eq "singlehtml") { Index: squid/scripts/www/template.html =================================================================== RCS file: /cvsroot/squid/squid/scripts/www/template.html,v retrieving revision 1.5 retrieving revision 1.6 diff -u -r1.5 -r1.6 --- squid/scripts/www/template.html 13 May 2007 22:16:56 -0000 1.5 +++ squid/scripts/www/template.html 14 May 2007 14:34:21 -0000 1.6 @@ -1,39 +1,53 @@ - - - Configuration File: %title% + + + + + Squid %version% Configuration File: %title% + + + + + + + - | Back up to the index |
- -

Option: %name%

+

| Back up to the index |

- 
+  
+    
+      
+    
+    
+      
+    
+    
+      
+    
+    
+      
+    
+    
+      
+    
+    
+      
+    
+    
+  
Option Name:%name%
Also Known As:%aliaslist%
Requires:%ifdef%
Default Value:%default%
Suggested Config:%config%

+        
 %ldoc%
-  

-
-  
Aliases

-  

-%aliaslist%
-  

-
-  
Default Values

-
-  

-%default%
-  

-
-  
Compile-time option

-  

-%ifdef%
-  

-
-  
Suggested Base Configuration

+        
+      
 

 
-  
-%config%
-  

+  
| Back up to the index |

 
   
 
Index: squid/scripts/www/template_single.html
===================================================================
RCS file: /cvsroot/squid/squid/scripts/www/template_single.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- squid/scripts/www/template_single.html	13 May 2007 22:16:56 -0000	1.1
+++ squid/scripts/www/template_single.html	14 May 2007 14:34:21 -0000	1.2
@@ -1,27 +1,27 @@
-  
Option: %name%

 
-  
+  
Option: %name%

+  
+    
+      
+    
+    
+      
+    
+    
+      
+    
+    
+      
+    
+    
+      
+    
+    
+      
+    
+    
+  
Option Name:%name%
Also Known As:%aliaslist%
Compile Requires:%ifdef%
Default Value:%default%
Suggested Config:%config%

+        
 %ldoc%
-  

-
-  
Aliases

-  

-%aliaslist%
-  

-
-  
Default Values

-
-  

-%default%
-  

-
-  
Compile-time option

-  

-%ifdef%
-  

-
-  
Suggested Base Configuration

-
-  
-%config%
-  

+        
+