[docs] xmldocs - docelic modified 3 files

docs at icdevgroup.org docs at icdevgroup.org
Sat Nov 6 14:40:03 EST 2004


User:      docelic
Date:      2004-11-06 19:40:03 GMT
Modified:  .        Makefile
Modified:  bin      refs-autogen
Modified:  docbook  common.xsl
Log:
- Makefile: just comment uppercasing

- bin/refs-autogen:
 - cleaned up a bit
 - generation of "See Also" broken for now

- docbook/common.xsl:
 - add parameter

Revision  Changes    Path
1.39      +1 -1      xmldocs/Makefile


rev 1.39, prev_rev 1.38
Index: Makefile
===================================================================
RCS file: /var/cvs/xmldocs/Makefile,v
retrieving revision 1.38
retrieving revision 1.39
diff -u -r1.38 -r1.39
--- Makefile	6 Nov 2004 18:24:36 -0000	1.38
+++ Makefile	6 Nov 2004 19:40:03 -0000	1.39
@@ -111,7 +111,7 @@
 
 
 #############################################################
-# Standard targets || two-pass processing method
+# STANDARD TARGETS || two-pass processing method
 $O/%.html: %.xml docbook/autodefs.ent skel
 	echo "C     $@"
 	$(PSR) $(PSR_FLAGS)                                                \



1.59      +14 -58    xmldocs/bin/refs-autogen


rev 1.59, prev_rev 1.58
Index: refs-autogen
===================================================================
RCS file: /var/cvs/xmldocs/bin/refs-autogen,v
retrieving revision 1.58
retrieving revision 1.59
diff -u -r1.58 -r1.59
--- refs-autogen	6 Nov 2004 11:53:49 -0000	1.58
+++ refs-autogen	6 Nov 2004 19:40:03 -0000	1.59
@@ -4,31 +4,7 @@
 
 # The script parses cache files made by bin/stattree, and generates
 # the refs/*.xml files.
-# Currently that includes pragmas, globvars, uitags, usertags, systemtags.
 
-# Ok, so this is how the .xml generation process goes:
-#
-# - We first load all templates to $templates{sybol_name}. Each symbol type
-#   has its own template (which are specified at the end of this file).
-#
-# - Then for each IC version mentioned on the command line, we:
-#   - load the cache file
-#   - go through all the symbols found in the cache, and:
-#     - push symbol name to @$symbol_lists{group name} (if not there already)
-#     - call process_symbol() which creates the skel entry in
-#       $autogenerated{$group}{$symbol} if not present
-#       (and also fixes stuff if the item IS present, but the path changed
-#       so Source contexts wouldn't work).
-#     - we then call populate() which updates $autogenerated{$group}$symbol}
-#       with user-supplied information from the filesystem (refs/*/*).
-#     - we update the "Available in" line
-#     - we do some more tuning
-#     - we construct the "Source" section (only dealing with formatting
-#       and display; what's actually in there is already decided in 
-#       bin/stattree run)
-#     - When all items are read-in and generated, the templates are filled
-#       with items, expanding variables.
-#     - Finally, the whole thing is output as .xml
 use warnings;
 use strict;
 use File::Find;
@@ -183,7 +159,7 @@
 
 						# If it was just the same symbol changing tag subgroup
 						# (uitag -> usertag), then delete it from the old location.
-						# (That means we'll trat it as new item, and it will be properly
+						# (That means we'll treat it as new item, and it will be properly
 						# re-created at the new position).
 						my $prev = scalar @{ $symbol_lists{$gk} }; # Quick sanity check
 						@{ $symbol_lists{$gk} } = grep {!/^$key$/} @{ $symbol_lists{$gk} };
@@ -209,8 +185,6 @@
 
 			# Register the presence of this item in this version.
 			push @{ $autogenerated{$gkey}{$key}{"_available in"} }, $hash{version};
-			$autogenerated{$gkey}{$key}{"available in"} =
-				join ", ", @{ $autogenerated{$gkey}{$key}{"_available in"} };
 
 			# Prepare source contexts, avoiding those cases
 			# where a symbol appears multiple times inside the same
@@ -230,15 +204,6 @@
 			my $ctxshown = 0;
 			for my $ctx ( @$ar ) {
 				
-#					my $hidden = @$ar - $max_ctxs;
-#					$$ag{source} .= <<ENDD;
-#<para>
-#</para>
-#<para>
-#(With $hidden contexts not shown).
-#</para>
-#ENDD
-
 				my $fi = $$ctx{file};
 				my $ln = $$ctx{lnum} || 0; #HA! How come $$ctx{lnum} is undefined??
 			
@@ -350,6 +315,7 @@
 ### THIS IS LAST RUN ###
 # Final entry. That's where we add examples
 # (which don't have version-specific data, they're always "latest")
+
 for my $group ( keys %autogenerated ) {
 while ( my($k,$v) = each %{ $autogenerated{$group} } ) {
 	my %ag = %$v;
@@ -368,31 +334,16 @@
 	# jump out to symbol-specific-subroutine that will handle that.
 	################################################################
 
-	# PLUG IN SYMBOL-SPECIFIC STUFF HERE
-	
-	## If we're dealing with a TAG, construct its "Default" section:
-	#if ( $ag{"_symbol type"} =~ /tag$/i and !$ag{default} ) {
-	#	my @items;
-	#	while ( my ($x,$y) = each %{ $hash{specific}{ $ag{name} } } ) {
-	#		next unless $x =~ s/^_tagopt_//;
-	#		push @items, "$x $y";
-	#	}
-	#	#$ag{default} = join '</para><para>', @items;
-	#	$ag{default} = join '<sbr/>', @items;
-	#}
-
 	# _See Also_ section: "bidirectional" linking
 	if ( defined @{ $ag{'_see also'} } ) {
 		my $list = $ag{'_see also'};
 		@$list = grep {$autogenerated{$group}{$_} and $_ ne $ag{name}} @$list;
-		#$ag{'see also'} = join ", ", @{ $ag{'_see also'} }; # Done below anyway
 		
 		for my $sym ( @$list ) {
 			my $list2 = $autogenerated{$group}{$sym}{'_see also'};
 			push @$list2, @$list, $k;
 			{ my %h; @$list2 = grep {!$h{$_}++ and $sym ne $_} @$list2 }
 			@{ $autogenerated{$group}{$sym}{'_see also'} } = @$list2;
-			$autogenerated{$group}{$sym}{'see also'} = join ", ", @$list2;
 		}
 	}
 
@@ -422,10 +373,7 @@
 			$itm =~ s/^(.+)$/<$linktype $linkarg='$1'><citerefentry><refentrytitle>$1<\/refentrytitle><manvolnum>7ic<\/manvolnum><\/citerefentry><\/$linktype>/;
 		}
 	}
-	$ag{'see also'} = join ", ", @see_items;
-
-	# Compress 4.6.0, 4.8.0, 5.0.0 to 4.6.0-5.0.0
-	$ag{'available in'} = compress_availability($ag{'_available in'});
+	@{ $ag{'_see also'} } = @see_items;
 
 	# Finally, set default values if they weren't overriden by real information
 	for my $field (@page_order) {
@@ -439,6 +387,14 @@
 	}
 
 
+	##########################################################################
+	# "Stringify" array values
+	$ag{"available in"} = join ", ", @{ $ag{"_available in"} };
+	$ag{'see also'} = join ", ", $ag{'_see also'};
+	# Compress 4.6.0, 4.8.0, 5.0.0 to 4.6.0-5.0.0
+	$ag{'available in'} = compress_availability($ag{'_available in'});
+
+
 	# DONE
 	$ag{latest} = $hash{version};
 
@@ -459,9 +415,6 @@
 #	}
 
 
-	# The 'structure' field will show which other symbols the current
-	# symbol uses. Fill it:
-
 	if ( my $fname = $hash{specific}{$ag{name}}{"_tagopt_maproutine"} ) {
 		# This means tag is MapRoutined, so it doesn't use any other 
 		# symbols directly, but possibly the maproutined function do.
@@ -471,6 +424,9 @@
 		#$hash{uses}{$group}{$ag{name}} = $hash{uses}{function}{ $fname };
 	}
 	
+
+	# The 'structure' field will show which other symbols the current
+	# symbol uses. Fill it:
 	if ( $hash{uses}{$group}{$ag{name}} ) {
 		while (my($k,$v)=each %{ $hash{uses}{$group}{$ag{name}} }) {
 			$ag{structure} .= "$k: @$v<sbr/>\n";



1.13      +1 -0      xmldocs/docbook/common.xsl


rev 1.13, prev_rev 1.12
Index: common.xsl
===================================================================
RCS file: /var/cvs/xmldocs/docbook/common.xsl,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -r1.12 -r1.13
--- common.xsl	18 Oct 2004 10:16:44 -0000	1.12
+++ common.xsl	6 Nov 2004 19:40:03 -0000	1.13
@@ -19,6 +19,7 @@
 	<xsl:param name="callout.graphics.path">./images/</xsl:param>
 
 	<xsl:param name="glossary.auto.link">0</xsl:param>
+	<xsl:param name="glossterm.auto.link">1</xsl:param>
 	<xsl:param name="glossentry.show.acronym">yes</xsl:param>
 	<xsl:param name="glossary.as.blocks">yes</xsl:param>
 








More information about the docs mailing list