[docs] xmldocs - docelic modified 7 files

docs at icdevgroup.org docs at icdevgroup.org
Sat Oct 9 07:30:29 EDT 2004


User:      docelic
Date:      2004-10-09 11:30:29 GMT
Modified:  .        TODO
Modified:  bin      refs-autogen stattree
Modified:  refs     jsq jsqn
Removed:   glossary ic-tag-lang
Removed:   pending  glossary.xml
Log:
- bin/stattree:
 - Now saves discovered global and catalog config directives to cache file

- bin/refs-autogen:
 - Generalization adjustments to properly generate {globconf,catconf}s.xml

- TODO: items

- refs/jsq*:
 - Fixed missing CDATA section

- glossary/*, pending/*:
 - Removed unneeded stuff

Revision  Changes    Path
1.32      +3 -0      xmldocs/TODO


rev 1.32, prev_rev 1.31
Index: TODO
===================================================================
RCS file: /var/cvs/xmldocs/TODO,v
retrieving revision 1.31
retrieving revision 1.32
diff -u -r1.31 -r1.32
--- TODO	6 Oct 2004 20:50:15 -0000	1.31
+++ TODO	9 Oct 2004 11:30:28 -0000	1.32
@@ -138,3 +138,6 @@
 check if all Default fields are properly formated (<literal> or none)
 s/a HTML/an HTML/
 
+Makefile:
+ - olinkdbs targets need to have literal depends, not $(shell )
+



1.41      +103 -1    xmldocs/bin/refs-autogen


rev 1.41, prev_rev 1.40
Index: refs-autogen
===================================================================
RCS file: /var/cvs/xmldocs/bin/refs-autogen,v
retrieving revision 1.40
retrieving revision 1.41
diff -u -r1.40 -r1.41
--- refs-autogen	1 Oct 2004 21:04:41 -0000	1.40
+++ refs-autogen	9 Oct 2004 11:30:28 -0000	1.41
@@ -90,6 +90,8 @@
 	usertag => "User Tag",
 	uitag => "User Interface Tag",
 	systemtag => "System Tag",
+	globconf => "Global Configuration Directive",
+	catconf => "Catalog Configuration Directive",
 );
 
 # Default fields
@@ -235,7 +237,7 @@
 					
 					my ( $cstart, $cend, $ctxmeta ) = ("", "", "");
 					#if (0) { use Data::Dumper; print Dumper $ctx; sleep 10; }
-					if ( $gkey !~ /tag$/ ) {
+					if ( $gkey !~ /(tag|conf)$/ ) {
 						# WE SHOW ONLY PART OF CONTEXT FOR THOSE
 						$cstart = $$ctx{lnum}-$$ctx{ctxpre};
 						$cend = $$ctx{lnum}+$$ctx{ctxpost};
@@ -835,9 +837,109 @@
 </refentry>
 __ENDP__
 
+
+$templates{globconf} = <<'__ENDP__';
+<refentry id="$ag{id}">
+
+<refmeta>
+<refentrytitle>$ag{"name"}</refentrytitle>
+<manvolnum>7ic</manvolnum>
+<refmiscinfo class="title">$ag{"name"}</refmiscinfo>
+</refmeta>
+
+<refnamediv>
+<refname>$ag{"name"}</refname>
+<refpurpose>$ag{"purpose"}</refpurpose>
+</refnamediv>
+
+<refsect1 id='$ag{"name"}_synopsis'>
+<title>PARAMETERS</title>
+
+<informaltable pgwide='1' frame='none'>
+<tgroup cols='5' align='left'>
+<colspec colname='arg'/>
+<colspec colname='pos'/>
+<colspec colname='req'/>
+<colspec colname='def'/>
+<colspec colname='dsc'/>
+
+<thead>
+<row>
+<entry>Argument</entry>
+<entry>Pos.</entry>
+<entry>Req.</entry>
+<entry>Default</entry>
+<entry>Description</entry>
+</row>
+</thead>
+<tbody>
+$ag{"synopsis"}
+</tbody>
+</tgroup>
+</informaltable>
+</refsect1>
+
+<refsect1 id='$ag{"name"}_description'>
+<title>DESCRIPTION</title>
+<para>$ag{"description"}</para>
+</refsect1>
+
+<!-- Disabled. I could remove it unless I do something useful with it.
+<refsect1 id='$ag{"name"}_structure"}'>
+<title>TAG STRUCTURE</title>
+<para>$ag{"structure"}</para>
+</refsect1>
+-->
+
+<refsect1 id='$ag{"name"}_examples'>
+<title>EXAMPLES</title>
+$ag{"example"}
+</refsect1>
+
+<refsect1 id='$ag{"name"}_notes'>
+<title>NOTES</title>
+<para>$ag{"notes"}</para>
+</refsect1>
+
+<refsect1 id='$ag{"name"}_availability'>
+<title>AVAILABILITY</title>
+<para>$ag{"name"} is available in Interchange versions:
+</para><para>
+$ag{"available in"}</para>
+</refsect1>
+
+<refsect1 id='$ag{"name"}_source'>
+<title>SOURCE</title>
+<para>Interchange $ag{"source ver"}:
+</para>
+$ag{source}
+</refsect1>
+
+<refsect1 id='$ag{"name"}_authors'>
+<title>AUTHORS</title>
+<para>$ag{"author"}</para>
+</refsect1>
+
+<!-- Removed because copyright is seen in Source (first few lines),
+     and the generated document starts with copyright notice
+<refsect1 id='$ag{"name"}_copyright'>
+<title>COPYRIGHT</title>
+$ag{"copyright"}
+</refsect1>
+-->
+
+<refsect1 id='$ag{"name"}_seeAlso'>
+<title>SEE ALSO</title>
+<para>$ag{"see also"}</para>
+</refsect1>
+
+</refentry>
+__ENDP__
+
 $templates{globvar} = $templates{pragma};
 $templates{uitag} = $templates{usertag};
 $templates{systemtag} = $templates{usertag};
+$templates{catconf} = $templates{globconf};
 
 }
 



1.22      +18 -3     xmldocs/bin/stattree


rev 1.22, prev_rev 1.21
Index: stattree
===================================================================
RCS file: /var/cvs/xmldocs/bin/stattree,v
retrieving revision 1.21
retrieving revision 1.22
diff -u -r1.21 -r1.22
--- stattree	8 Oct 2004 19:17:12 -0000	1.21
+++ stattree	9 Oct 2004 11:30:28 -0000	1.22
@@ -388,7 +388,7 @@
 	####################################################################
 	# lib/Vend/Config.pm
 	if ( $c{file} eq 'lib/Vend/Config.pm' ) {
-		file_parseVendConfig(\@filedata);
+		file_parseVendConfig(\%c, \@filedata);
 	}
 }
 
@@ -490,6 +490,7 @@
 
 
 sub file_parseVendConfig {
+	my %c = %{ (shift) };
 	my $content = shift; # Complete lib/Vend/Config.pm file
 
 	my $linenr = 0;      # Increases as we parse Config.pm
@@ -551,7 +552,7 @@
 		} else { # Too many closing brackets
 			$globalclose++;
 			$run = 0;
-			$opens = 0; # BLAM! Took me a while to figure it out
+			$opens = 0; $directive = ""; # BLAM! Took me a while to figure those two out
 			# This is okay, verified to only happen at closing of the 
 			# opening of "my $directives = [" which is not counted.
 			#die "Holy moustache! at $linenr: $line\n";
@@ -561,7 +562,21 @@
 	$globalclose == 2 or die "Assert globalclose == 2: $globalclose\n";
 
 	# Well, let's congratulate ourselves.
-	#print Dumper @globconf;
+
+	for my $ln (@globconf) {
+		$ln =~ /^\s*\['(\S+?)'/ or die "Can't match global directive name in '$ln'?\n";
+		push @{ $hash{symbols}{globconf}{$1} }, {
+			%c,
+			ctx => [ split /\n/, $ln ],
+		}
+	}
+	for my $ln (@catconf) {
+		$ln =~ /^\s*\['(\S+?)'/ or die "Can't match catalog directive name in '$ln'?\n";
+		push @{ $hash{symbols}{catconf}{$1} }, {
+			%c,
+			ctx => [ split /\n/, $ln ],
+		}
+	}
 }
 
 



1.2       +5 -5      xmldocs/refs/jsq


rev 1.2, prev_rev 1.1
Index: jsq
===================================================================
RCS file: /var/cvs/xmldocs/refs/jsq,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- jsq	8 Oct 2004 21:07:16 -0000	1.1
+++ jsq	9 Oct 2004 11:30:29 -0000	1.2
@@ -14,7 +14,7 @@
 <tag>jsq</tag> tag quotes (escapes) strings and performs basic variable
 substitution, for use in JavaScript code blocks.
 </para><para>
-This is mostly used for long string which are hard to prepare manually.
+This is mostly used for long strings which are hard to prepare manually.
 </para><para>
 <tag>jsquote</tag> is an alias for <tag>jsq</tag>.
 __END__
@@ -26,25 +26,25 @@
 	Here's an example of JavaScript code and the output it would generate,
 	once expanded by Interchange:
 	</para>
-  <programlisting> 
+  <programlisting><![CDATA[
 <script>
   var astring = 'just an insert';
   var somevar = [jsq] Big long string you don't
   want to have to quote for JS, and you want to
   insert the variable $astring.[/jsq];
 </script>
-  </programlisting>
+  ]]></programlisting>
 	<para>
 	Expands to:
 	</para>
-  <programlisting>
+  <programlisting><![CDATA[
 <script>
 var astring = 'just an insert';
 var somevar = " Big long string you don't" +
   '  want to have to quote for JS, and you want to' +
   '  insert the variable ' + astring + '.';
 </script>
-  </programlisting>
+  ]]></programlisting>
 </example>
 __END__
 



1.2       +7 -7      xmldocs/refs/jsqn


rev 1.2, prev_rev 1.1
Index: jsqn
===================================================================
RCS file: /var/cvs/xmldocs/refs/jsqn,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- jsqn	8 Oct 2004 21:07:16 -0000	1.1
+++ jsqn	9 Oct 2004 11:30:29 -0000	1.2
@@ -14,7 +14,7 @@
 <tag>jsqn</tag> tag quotes (escapes) strings (without performing variable
 substitution), for use in JavaScript code blocks.
 </para><para>
-This is mostly used for long string which are hard to prepare manually.
+This is mostly used for long strings which are hard to prepare manually.
 __END__
 
 __NAME__ example
@@ -24,25 +24,25 @@
 	Here's an example of JavaScript code and the output it would generate,
 	once expanded by Interchange:
 	</para>
-  <programlisting> 
+  <programlisting><![CDATA[
 <script>
   var astring = 'just an insert';
   var somevar = [jsqn] Big long string you don't
-  want to have to quote for JS, and you want to
+  want to have to quote for JS, and you don't want to
   insert the variable $astring.[/jsqn];
 </script>
-  </programlisting>
+  ]]></programlisting>
 	<para>
 	Expands to:
 	</para>
-  <programlisting>
+  <programlisting><![CDATA[
 <script>
 var astring = 'just an insert';
 var somevar = " Big long string you don't" +
-  '  want to have to quote for JS, and you want to' +
+  '  want to have to quote for JS, and you don't want to' +
   '  insert the variable $astring.';
 </script>
-  </programlisting>
+  ]]></programlisting>
 </example>
 __END__
 








More information about the docs mailing list