[interchange-docs] xmldocs - docelic modified 3 files

docs at icdevgroup.org docs at icdevgroup.org
Sun Nov 11 19:30:45 EST 2007


User:      docelic
Date:      2007-11-12 00:30:45 GMT
Modified:  .        TODO
Modified:  bin      refs-autogen stattree
Log:
* Improved See Also linking: much less items are now linked automatically,
  leaving us with very precise bi-directional linking. This should resolve
  all complaints about See Also section containing links to stuff that
  has nothing useful to do with the context.

  Also, closes #122: Explicit exclude items from see also chain
  (Since linking is now more precise, nothing you didn't want will end
  up being linked - so instead of providing !time syntax, simply don't
  mention 'time' anywhere and bin/refs-autogen won't add it on its own).

* Fixed small incorrect thing in how source context lines were displayed
  for widgets/actionmaps/orderchecks.

Revision  Changes    Path
1.109     +1 -2      xmldocs/TODO


rev 1.109, prev_rev 1.108
Index: TODO
===================================================================
RCS file: /var/cvs/xmldocs/TODO,v
retrieving revision 1.108
retrieving revision 1.109
diff -u -r1.108 -r1.109
--- TODO	10 Nov 2007 23:24:33 -0000	1.108
+++ TODO	12 Nov 2007 00:30:44 -0000	1.109
@@ -1,6 +1,5 @@
 Bugs:
--textarea widget is hidden as it is found in text.widget file
--check if really linking between widgets is not working
+- work on bin/mkreport
 - search doc se nevidi jer je search neki actionmap
 - on online docs, mention that obsolete examples are obsolete, 
   provide search box, provide static files for download, 



1.121     +41 -14    xmldocs/bin/refs-autogen


rev 1.121, prev_rev 1.120
Index: refs-autogen
===================================================================
RCS file: /var/cvs/xmldocs/bin/refs-autogen,v
retrieving revision 1.120
retrieving revision 1.121
diff -u -r1.120 -r1.121
--- refs-autogen	5 Nov 2007 23:38:53 -0000	1.120
+++ refs-autogen	12 Nov 2007 00:30:44 -0000	1.121
@@ -497,7 +497,7 @@
 					my ( $cstart, $cend, $ctxmeta ) = ("", "", "");
 					my $all = 0; # Showing all for an item?
 
-					if ( $gkey !~ /(tag|filter)$/ ) {
+					if ( $gkey !~ /(tag|filter|widget|actionmap|ordercheck)$/ ) {
 						# WE SHOW ONLY PART OF CONTEXT FOR THOSE
 						$$ctx{ctx_p} ||= 0; $$ctx{ctx_n} ||= 0; # *confs don't have it
 						$cstart = $$ctx{lnum}-$$ctx{ctx_p};
@@ -631,24 +631,51 @@
 
 		# This loop is now needed since we added the concept of groups
 		# in %autogenerated.
-		# TODO it's the following code that prevents multiple items
-		# of the same name but different types to all be linked in
-		# see also
-		# TODO it's also here that we need to make sure that in "backlinks"
-		# we get compound group names, not expanded ones. 
-		# (There's no 'systemtags', 'uitags', etc. only 'tags' are 
-		# present with compund in use.
+		# Here, if our item links to say, symbols 'time' and 'alpha',
+		# %tmp would look like this:
+		# %tmp = (
+		# 	time => [ filter, tag, widget ],
+		# 	alpha => [ filter ]
+		# );
 		for my $gr ( keys %autogenerated ) {
-			$tmp{$_} = $gr
-				for (grep {$autogenerated{$gr}{$_} and $_ ne $ag{name}} @$list);
+			for (grep {$autogenerated{$gr}{$_} and $_ ne $ag{name}} @$list) {
+				push @{$tmp{$_}}, $gr
+			}
 		}
+		# @$list will now contain only symbols that exist and can be
+		# linked to (rest is ignored)
 		@$list =keys %tmp;
+
+		# TODO this part of code still prevents linking to multiple
+		# types. If you link to 'time', which is a filter, widget and
+		# a tag, only one (random) of those three will be linked. Not
+		# all three will be linked - only one will be, and you can't control
+		# which one.
+		# Actually halfway it works, all 'time' symbols will 
+		# link to the original symbol that linked to 'time', but that is
+		# the less-important half of the problem.
 		
+		# For each symbol and subtype we will link to, register bidirectional link.
 		for my $sym ( @$list ) {
-			my $list2 = $autogenerated{$tmp{$sym}}{$sym}{'_see also'};
-			push @$list2, @$list, $k;
-			{ my %h; @$list2 = grep {!$h{$_}++ and $sym ne $_} @$list2 }
-			@{ $autogenerated{$tmp{$sym}}{$sym}{'_see also'} } = @$list2;
+			for my $symgrp (@{$tmp{$sym}}) {
+				my $list2 = $autogenerated{$symgrp}{$sym}{'_see also'};
+
+				# Don't push @$list elements as candidates for bidirectional
+				# linking; it generated too many unrelated links. This will
+				# make us pay some more attention to See Also lines.
+				# (Previously, you could link some symbol to some
+				# other symbol and, through generous propagation of links, it would
+				# happen to be linked from all related elements. But now 
+				# only 1-to-1 bidirectional linking will work so you won't be
+				# able to omit symbols from See Also list counting that
+				# refs-autogen will insert them so generously.
+
+				#push @$list2, @$list, $k;
+				push @$list2, $k;
+
+				{ my %h; @$list2 = grep {!$h{$_}++ and $sym ne $_} @$list2 }
+				@{ $autogenerated{$symgrp}{$sym}{'_see also'} } = @$list2;
+			}
 		}
 	}
 



1.58      +1 -0      xmldocs/bin/stattree


rev 1.58, prev_rev 1.57
Index: stattree
===================================================================
RCS file: /var/cvs/xmldocs/bin/stattree,v
retrieving revision 1.57
retrieving revision 1.58
diff -u -r1.57 -r1.58
--- stattree	11 Nov 2007 23:06:39 -0000	1.57
+++ stattree	12 Nov 2007 00:30:44 -0000	1.58
@@ -911,6 +911,7 @@
 	}
 }
 
+# Look one function above.
 sub line_findGlobConfs {
 	######################################################
 	# Diskover global config directives








More information about the docs mailing list