[docs] xmldocs - docelic modified 16 files

docs at icdevgroup.org docs at icdevgroup.org
Sat Dec 4 17:47:24 EST 2004


User:      docelic
Date:      2004-12-04 22:47:24 GMT
Modified:  .        Makefile
Modified:  bin      refs-autogen stattree
Modified:  docbook  literals.ent olinkdb-c.xml olinkdb-nc.xml
Modified:  glossary img
Modified:  refs     delete_cart download load_cart save_cart
Modified:  refs/post_page notes
Modified:  refs/pre_page description
Modified:  refs/safe_data description
Added:     glossary interpolate
Removed:   glossary interpolation
Log:
- Makefile:
 - support for "compound" docs

- bin/refs-autogen:
 - Improve printing of "GEN: ...." lines so compound docs are indicated
 - Fix a bug regarding source contexts which caused each new parsed
   version to drop some of the contexts. (This happened because the source
   was shown anew, but the list of already covered areas wasn't reset to an
   empty state).
 - Do NOT prefix compound docs with "ic" (causes all sorts of problems and
   doesn't make sense since you can always symlink it).

- Misc:
 - Rename glossary entry 'interpolation' to 'interpolate'
 - Fix some references to glossary
 - Adjust docbook/olink-*.xml files for compound docs

Revision  Changes    Path
1.49      +2 -1      xmldocs/Makefile


rev 1.49, prev_rev 1.48
Index: Makefile
===================================================================
RCS file: /var/cvs/xmldocs/Makefile,v
retrieving revision 1.48
retrieving revision 1.49
diff -u -r1.48 -r1.49
--- Makefile	28 Nov 2004 23:04:07 -0000	1.48
+++ Makefile	4 Dec 2004 22:47:23 -0000	1.49
@@ -12,7 +12,8 @@
 
 #############################################################
 # Base definitions
-SYMBOL_TYPES= pragmas globvars usertags uitags systemtags globconfs catconfs filters catvars
+#SYMBOL_TYPES= pragmas globvars usertags uitags systemtags globconfs catconfs filters catvars
+SYMBOL_TYPES= pragmas globvars tags globconfs catconfs filters catvars
 GUIDES      = iccattut xmldocs
 HOWTOS      = howtos
 GLOSSARY    = glossary



1.71      +18 -7     xmldocs/bin/refs-autogen


rev 1.71, prev_rev 1.70
Index: refs-autogen
===================================================================
RCS file: /var/cvs/xmldocs/bin/refs-autogen,v
retrieving revision 1.70
retrieving revision 1.71
diff -u -r1.70 -r1.71
--- refs-autogen	4 Dec 2004 21:39:08 -0000	1.70
+++ refs-autogen	4 Dec 2004 22:47:23 -0000	1.71
@@ -146,8 +146,16 @@
 
 		# Simply for display purpose
 		if (! $symbol_lists{$gkey} ) {
-			my @olist;
-			push @olist, "refs/${gkey}s.xml" if $output_xml;
+			my ($name, @olist);
+
+			$name = $gkey;
+			my $pref = "";
+			if ( $compounds ) {
+				$gkey =~ /tag$/ and $name = 'tag';
+				$pref = "${gkey}s -> ";
+			}
+
+			push @olist, "${pref}refs/${name}s.xml" if $output_xml;
 			push @olist, "tmp/${gkey}s.list" if $output_list;
 			local $" = ", ";
 			print "GEN: @olist\n";
@@ -227,19 +235,22 @@
 			my $ag = $autogenerated{$gkey}{$key};
 			my $ar = $hash{symbols}{ $$ag{"_symbol type"} }{$key};
 
-			if ( $ar ) {$$ag{source} = "" }
+			if ( $ar ) {
+				$$ag{source} = "";
+				$covered{$gkey}{$key} = {}; # This one was though to find ;-)
+			}
 
 			my $ctxtotal = scalar @$ar;
 			my $ctxshown = 0;
 			for my $ctx ( @$ar ) {
-				
+
 				my $fi = $$ctx{file};
 				my $ln = $$ctx{lnum} || 0; #HA! How come $$ctx{lnum} is undefined??
 			
 				# See if the source context was already listed. (I don't think this
 				# can happen - that the same one appears twice). This code actually
 				# weeds out *different* but overlapping contexts.
-				for my $arr ( @{ $covered{$key}{$fi} } ) {
+				for my $arr ( @{ $covered{$gkey}{$key}{$fi} } ) {
 					next if !$ln or !$$arr[0] or !$$arr[1];
 					if ($ln > $$arr[0] and $ln < $$arr[1]) {
 						$ctxtotal--;
@@ -340,7 +351,7 @@
 					}
 					$$ag{"source ver"} = $hash{version};
 				}
-				push @{ $covered{$key}{$fi} }, [ $$ctx{ctxs}, $$ctx{ctxe} ];
+				push @{ $covered{$gkey}{$key}{$fi} }, [ $$ctx{ctxs}, $$ctx{ctxe} ];
 				DONELOOP:
 			}
 
@@ -569,7 +580,7 @@
 	$refpage .= "\n" . '</reference>';
 
 	# Dump page
-	my $prefix = $compounds ? "ic" : "";
+	my $prefix = ""; #$compounds ? "ic" : "";
 	open OUT, "> refs/$prefix${group}s.xml" or
 		die "Can't produce reference refs/$prefix${group}s.xml ($!)\n";
 	print OUT $refpage;



1.34      +1 -1      xmldocs/bin/stattree


rev 1.34, prev_rev 1.33
Index: stattree
===================================================================
RCS file: /var/cvs/xmldocs/bin/stattree,v
retrieving revision 1.33
retrieving revision 1.34
diff -u -r1.33 -r1.34
--- stattree	27 Nov 2004 00:41:46 -0000	1.33
+++ stattree	4 Dec 2004 22:47:23 -0000	1.34
@@ -780,7 +780,7 @@
 			file_extractSub( $tagname, $1, $c, $context_data);
 			return;
 
-		} elsif ( $line =~ /^sub $func {/ ) {
+		} elsif ( $line =~ /^sub $func \{/ ) {
 			$start = $i+1 unless $start;
 			@content = ($line);
 



1.18      +2 -2      xmldocs/docbook/literals.ent


rev 1.18, prev_rev 1.17
Index: literals.ent
===================================================================
RCS file: /var/cvs/xmldocs/docbook/literals.ent,v
retrieving revision 1.17
retrieving revision 1.18
diff -u -r1.17 -r1.18
--- literals.ent	23 Nov 2004 18:01:00 -0000	1.17
+++ literals.ent	4 Dec 2004 22:47:23 -0000	1.18
@@ -92,7 +92,7 @@
 	</entry>
 	<entry></entry><entry></entry>
 	<entry>0</entry>
-	<entry>&glos-interpolation; input?</entry>
+	<entry>&glos-interpolate; input?</entry>
 </row>
 ">
 <!ENTITY ROW_INTERPOLATE_1 "
@@ -104,7 +104,7 @@
 	</entry>
 	<entry></entry><entry></entry>
 	<entry>1</entry>
-	<entry>&glos-interpolation; input?</entry>
+	<entry>&glos-interpolate; input?</entry>
 </row>
 ">
 <!ENTITY ROW_REPARSE_0 "



1.7       +10 -0     xmldocs/docbook/olinkdb-c.xml


rev 1.7, prev_rev 1.6
Index: olinkdb-c.xml
===================================================================
RCS file: /var/cvs/xmldocs/docbook/olinkdb-c.xml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- olinkdb-c.xml	22 Nov 2004 00:18:43 -0000	1.6
+++ olinkdb-c.xml	4 Dec 2004 22:47:23 -0000	1.7
@@ -13,6 +13,8 @@
 	<!ENTITY systemtags SYSTEM "../tmp/systemtags-c.db"> 
 	<!ENTITY globconfs SYSTEM "../tmp/globconfs-c.db"> 
 	<!ENTITY catconfs SYSTEM "../tmp/catconfs-c.db"> 
+	<!-- COMPOUNDS -->
+	<!ENTITY tags SYSTEM "../tmp/tags-c.db"> 
 ]>
 
 <targetset>
@@ -65,6 +67,7 @@
 				</document>
 			</dir>
 			
+			<!--
 			<dir name='uitags'>
 				<document targetdoc="uitags">
 				&uitags;
@@ -80,6 +83,13 @@
 			<dir name='systemtags'>
 				<document targetdoc="systemtags">
 				&systemtags;
+				</document>
+			</dir>
+			-->
+
+			<dir name='ictags'>
+				<document targetdoc="tags">
+				&tags;
 				</document>
 			</dir>
 			



1.6       +4 -0      xmldocs/docbook/olinkdb-nc.xml


rev 1.6, prev_rev 1.5
Index: olinkdb-nc.xml
===================================================================
RCS file: /var/cvs/xmldocs/docbook/olinkdb-nc.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- olinkdb-nc.xml	22 Nov 2004 00:18:43 -0000	1.5
+++ olinkdb-nc.xml	4 Dec 2004 22:47:23 -0000	1.6
@@ -13,6 +13,8 @@
 	<!ENTITY systemtags SYSTEM "../tmp/systemtags-nc.db"> 
 	<!ENTITY globconfs SYSTEM "../tmp/globconfs-nc.db"> 
 	<!ENTITY catconfs SYSTEM "../tmp/catconfs-nc.db"> 
+	<!-- COMPOUNDS -->
+	<!ENTITY tags SYSTEM "../tmp/tags-nc.db"> 
 ]>
 
 <targetset>
@@ -34,6 +36,8 @@
 			<document targetdoc="systemtags" baseuri="systemtags.html"> &systemtags; </document>
 			<document targetdoc="globconfs" baseuri="globconfs.html"> &globconfs; </document>
 			<document targetdoc="catconfs" baseuri="catconfs.html"> &catconfs; </document>
+			<!-- COMPOUNDS -->
+			<document targetdoc="tags" baseuri="tags.html"> &tags; </document>
 		</dir>
 	</sitemap>
 



1.3       +1 -0      xmldocs/glossary/img


rev 1.3, prev_rev 1.2
Index: img
===================================================================
RCS file: /var/cvs/xmldocs/glossary/img,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- img	20 Oct 2004 15:44:35 -0000	1.2
+++ img	4 Dec 2004 22:47:23 -0000	1.3
@@ -1,5 +1,6 @@
 
 <glossentry id="img">
+<glossterm>&lt;img&gt;</glossterm>
 <glossterm>Hypertext image</glossterm>
 
 <glossdef>



1.1                  xmldocs/glossary/interpolate


rev 1.1, prev_rev 1.0
Index: interpolate
===================================================================

<glossentry id="interpolate">
<glossterm>interpolate</glossterm>

<glossdef>
<para>
meek.
Default is off
</para>

</glossdef>

</glossentry>




1.7       +1 -1      xmldocs/refs/delete_cart


rev 1.7, prev_rev 1.6
Index: delete_cart
===================================================================
RCS file: /var/cvs/xmldocs/refs/delete_cart,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- delete_cart	9 Nov 2004 23:16:16 -0000	1.6
+++ delete_cart	4 Dec 2004 22:47:23 -0000	1.7
@@ -22,7 +22,7 @@
 
 
 __NAME__ description
-This tag deletes a shopping cart from the &glos-userdb;.
+This tag deletes a shopping cart from the &glos-UserDB;.
 This is basically the same as
 <code>[userdb function=delete_cart
 nickname=<replaceable>CART_NAME</replaceable>]</code>.



1.6       +1 -1      xmldocs/refs/download


rev 1.6, prev_rev 1.5
Index: download
===================================================================
RCS file: /var/cvs/xmldocs/refs/download,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- download	9 Nov 2004 23:16:16 -0000	1.5
+++ download	4 Dec 2004 22:47:23 -0000	1.6
@@ -18,7 +18,7 @@
 
 __NAME__ description
 The main function of this &glos-pragma; is to prevent any
-&glos-interpolation; of the output.
+interpolation of the output (see the &glos-interpolate; glossary entry).
 It helps to preserve the downloads intact if they 
 happen to contain constructs similar to
 <literal>__<replaceable>VAR</replaceable>__</literal> 



1.3       +1 -1      xmldocs/refs/load_cart


rev 1.3, prev_rev 1.2
Index: load_cart
===================================================================
RCS file: /var/cvs/xmldocs/refs/load_cart,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- load_cart	9 Nov 2004 23:16:16 -0000	1.2
+++ load_cart	4 Dec 2004 22:47:23 -0000	1.3
@@ -35,7 +35,7 @@
 
 
 __NAME__ description
-This tag loads a cart from the &glos-userdb;.
+This tag loads a cart from the &glos-UserDB;.
 <emphasis role='bold'>The loaded cart will be merged with the current
 one</emphasis>.
 __END__



1.3       +1 -1      xmldocs/refs/save_cart


rev 1.3, prev_rev 1.2
Index: save_cart
===================================================================
RCS file: /var/cvs/xmldocs/refs/save_cart,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- save_cart	9 Nov 2004 23:16:16 -0000	1.2
+++ save_cart	4 Dec 2004 22:47:23 -0000	1.3
@@ -41,7 +41,7 @@
 
 
 __NAME__ description
-This tag saves current cart to &glos-userdb;.
+This tag saves current cart to &glos-UserDB;.
 </para><para>
 Note that the cart name does not have to be unique. If there are more carts
 with the same nickname, an index will be added.



1.4       +1 -1      xmldocs/refs/post_page/notes


rev 1.4, prev_rev 1.3
Index: notes
===================================================================
RCS file: /var/cvs/xmldocs/refs/post_page/notes,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- notes	24 Aug 2004 18:26:44 -0000	1.3
+++ notes	4 Dec 2004 22:47:23 -0000	1.4
@@ -1 +1 @@
-The old documentation system improperly describes the phase at which the <pragma>post_page</pragma> pragma takes effect (it states it happens after <option>Variable</option> processing and before tag interpolation).
+The old documentation system improperly describes the phase at which the <pragma>post_page</pragma> pragma takes effect (it states it happens after <option>Variable</option> processing and before tags are &glos-interpolate;d).



1.4       +1 -1      xmldocs/refs/pre_page/description


rev 1.4, prev_rev 1.3
Index: description
===================================================================
RCS file: /var/cvs/xmldocs/refs/pre_page/description,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- description	22 Sep 2004 21:13:07 -0000	1.3
+++ description	4 Dec 2004 22:47:24 -0000	1.4
@@ -1,6 +1,6 @@
 This pragma defines a <literal>Sub</literal> or <literal>GlobalSub</literal>
 to run
 <emphasis>after</emphasis> <option>Variable</option> substitution and
-<emphasis>before</emphasis> tag interpolation on a page. A
+<emphasis>before</emphasis> tags are &glos-interpolate;d on a page. A
 <emphasis>reference</emphasis> to the page contents
 is passed to the subroutine.



1.9       +1 -1      xmldocs/refs/safe_data/description


rev 1.9, prev_rev 1.8
Index: description
===================================================================
RCS file: /var/cvs/xmldocs/refs/safe_data/description,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- description	9 Nov 2004 23:16:17 -0000	1.8
+++ description	4 Dec 2004 22:47:24 -0000	1.9
@@ -1,4 +1,4 @@
-By default, Interchange does not allow data returned from the databases to be interpolated (all the &#91;s are converted to an &glos-HTML; entity (&amp;#91;) and displayed literally). Setting this pragma eliminates the restriction and passes &#91;s through for interpolation).
+By default, Interchange does not allow data returned from the databases to be &glos-interpolate;d (all the &#91;s are converted to an &glos-HTML; entity (&amp;#91;) and displayed literally). Setting this pragma eliminates the restriction and passes &#91;s through for interpolation).
 </para><para>
 If you want to have tags in your database and display them in Interchange pages (to say, display <tag>page</tag> links for internal hyperlinks in your product descriptions), you need to enable this pragma.
 Some things to consider, though:








More information about the docs mailing list