[docs] xmldocs - docelic modified 4 files

[docs at icdevgroup.org]

User:      docelic
Date:      2004-08-06 15:57:27 GMT
Modified:  .        README TODO
Modified:  bin      refs-autogen stattree
Log:
- bin/stattree and bin/refs-autogen:
  - Added support for discover of user/system/ui tags
- README: added make target examples
- TODO: added item

Revision  Changes    Path
1.6       +10 -2     xmldocs/README


rev 1.6, prev_rev 1.5
Index: README
===================================================================
RCS file: /var/cvs/xmldocs/README,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- README	30 Jul 2004 16:22:25 -0000	1.5
+++ README	6 Aug 2004 15:57:27 -0000	1.6
@@ -18,7 +18,14 @@
 
   make guides
   make refs
+
+	make OUTPUT/iccattut.html
+	make OUTPUT/iccattut
+	make OUTPUT/iccattut.man
+
   make OUTPUT/xmldocs.css
+	make tmp/refs-autogen
+	make tmp/olinkdbs
 
 
 PREREQUISITES
@@ -33,14 +40,15 @@
   - xsltproc
   - xmlto
 	- exuberant-ctags
+	- passivetex (for FO output - ps, pdf, ...)
 
 
 FINAL OUTPUT
 
 During the invocation of 'make', few files will be created:
   
-  tmp/*.db       - OLink DB files generated from source .xml files
-                   (currently disabled), and other temporary files.
+  tmp/*.db       - OLink DB files generated from source .xml files,
+                   and other temporary files.
 
   cache/<ver>/*  - Various Interchange source tree statistics, available
                    over a filesystem interface. (For XInclusion in .xml



1.5       +4 -0      xmldocs/TODO


rev 1.5, prev_rev 1.4
Index: TODO
===================================================================
RCS file: /var/cvs/xmldocs/TODO,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- TODO	6 Aug 2004 14:00:54 -0000	1.4
+++ TODO	6 Aug 2004 15:57:27 -0000	1.5
@@ -8,6 +8,10 @@
   ask for clarification. (this could be done with either pure IC (forum?), or 
 	XML forms capability)..
 - filenames in Source contexts should also be clickable
+- in html, make source contexts "rollable" by either using some css
+  properties or javascript. this is not really needed when you only have
+	say, 15 lines of context, but it'll come great when you have a copy
+	of a 300-lines usertag.
 
  Long-term:
 - Support using refs/<filename> with all the documentation for a symbol



1.15      +4 -2      xmldocs/bin/refs-autogen


rev 1.15, prev_rev 1.14
Index: refs-autogen
===================================================================
RCS file: /var/cvs/xmldocs/bin/refs-autogen,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -r1.14 -r1.15
--- refs-autogen	6 Aug 2004 14:00:54 -0000	1.14
+++ refs-autogen	6 Aug 2004 15:57:27 -0000	1.15
@@ -43,6 +43,9 @@
 my %longname = (
 	globvar => "Global Variable",
 	pragma => "Pragma",
+	usertag => "User tag",
+	uitag => "UI tag",
+	systemtag => "System tag",
 );
 
 # General description of symbol types
@@ -138,8 +141,7 @@
 			for my $ctx ( @$ar ) {
 				my ($fi, $ln, $ctxmeta, $ctxdata) = @$ctx;
 				my @ctxsize = split /\s/, $ctxmeta;
-				# Support incompatible bin/stattree change
-				# XXX Remove once we autogenerate all with new bin/stattree
+				# Support item types with only context info in this field
 				my $ctxsize = scalar @ctxsize == 2 ? $ctxsize[1] : $ctxsize[0];
 				my $loc = "$fi:$ln";
 				for my $arr ( @{ $covered{$key}{$fi} } ) {



1.9       +15 -5     xmldocs/bin/stattree


rev 1.9, prev_rev 1.8
Index: stattree
===================================================================
RCS file: /var/cvs/xmldocs/bin/stattree,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- stattree	4 Aug 2004 17:40:44 -0000	1.8
+++ stattree	6 Aug 2004 15:57:27 -0000	1.9
@@ -197,8 +197,7 @@
 					if ( !$hash{version} or "$hash{version}" eq "$2" ) {
 						$hash{version} = $2
 					}
-					# break; # We *could* stop processing here,
-					         # but we won't.
+					last;
 				}
 			}
 			# ICVERSION must be known here, or someone's playing, or
@@ -267,15 +266,14 @@
 				######################################################
 				# See if it's a beginning of a subroutine name, and remember the
 				# name/linenum.
-				if ( $line =~ /^\s*sub\s+(\w+)\s*\{\s*$/ ) {
+				if ( $line =~ m#^\s*sub\s+(\w+)\s*\{\s*$# ) {
 					$hash{total}{perl_functions}++;
 					@gfunc = ( $1, $lnum );
 				}
-				
+
 			} else {
 				warn "IMPOSSIBLE\n";
 			}
-		}
 
 		# TODO:
 		# - parse contents, identify blocks and add to appropriate
@@ -283,6 +281,18 @@
 		# - code with inline comments or html with tags count as "gray area"
 		#   (adds 1 to both)
 
+		##########################################################
+		# Found a tag
+		} elsif ( $fsubtype =~ /^(user|ui|system)tag$/ )  {
+			#$hash{total}{$fsubtype . "s"}++;
+			$file =~ m#(\w+?)\.(core)?tag$# or
+				warn "I know $file is a tag but regex doesn't match it\n";
+			my $tagname = $1;
+			@{ $hash{symbols}{$fsubtype}{$1} } = ();
+				# Not this, context info will be provided in html files
+				#[ "$i{ver}/$file", scalar @file, "1:" . scalar @file, [ @file ] ];
+			last;
+		}
 	}
 }