[docs] xmldocs - docelic modified 6 files

docs at icdevgroup.org docs at icdevgroup.org
Tue Feb 1 16:35:07 EST 2005


User:      docelic
Date:      2005-02-01 21:35:07 GMT
Modified:  bin      generic-autogen icsdf2xml.pl refs-autogen stattree
Added:     bin      procmv.pl splitfile.pl
Log:
- refs-autogen, stattree: comment added only
- improvements to other helper scripts

Revision  Changes    Path
1.12      +0 -2      xmldocs/bin/generic-autogen


rev 1.12, prev_rev 1.11
Index: generic-autogen
===================================================================
RCS file: /var/cvs/xmldocs/bin/generic-autogen,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- generic-autogen	3 Jan 2005 20:41:01 -0000	1.11
+++ generic-autogen	1 Feb 2005 21:35:07 -0000	1.12
@@ -44,8 +44,6 @@
 <glossary>
 	<title>Interchange Documentation: Glossary</title>
 
-<toc/>
-
 __ENDP__
 my $howtos = <<__ENDP__;
 <?xml version="1.0" standalone="no"?>



1.3       +21 -6     xmldocs/bin/icsdf2xml.pl


rev 1.3, prev_rev 1.2
Index: icsdf2xml.pl
===================================================================
RCS file: /var/cvs/xmldocs/bin/icsdf2xml.pl,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- icsdf2xml.pl	27 Dec 2004 01:06:10 -0000	1.2
+++ icsdf2xml.pl	1 Feb 2005 21:35:07 -0000	1.3
@@ -23,13 +23,16 @@
 	s#C\<(\[[\w_\-]+ [\w_\-]+\])\>#<code>$1</code>#g;
 
 	s#^=over\s+.*#</para>#;
-	s#^=item\s+.*#</para> <para>#;
-	s#^=back\s*.*#</para> <para>#;
+	s#^=item\s+.*#</para></listitem> <listitem><para>#;
+	s#^=back\s*.*#</para></listitem> <listitem><para>#;
 
-	!&in_pl and do {
+	!$in_pl and do {
 		s/&/&amp;/g;
 		s/interchange/&IC;/gi;
-	}
+	};
+
+	s#{{CMD\[.*?\](\w+)}}#$1#g;
+	s#variable#&glos-variable;#;
 
 	s/(<[\w_-]+)/lc $1/ge and do {
 		s/( [A-Z]+=)/lc $1/ge;
@@ -39,7 +42,7 @@
 ######################### SECT1
 	/^H1:\s*(.*?)\s*$/ and do {
 	my $sec = $1;
-	(my $title = lc $1) =~ s/(^|[\s_-"']+)(\w)/uc $2/ge;
+	(my $title = lc $1) =~ s/(^|[\s_"'-]+)(\w)/uc $2/ge;
 	push @output, <<__ENDD__;
 </para>
 </sect1>
@@ -72,6 +75,16 @@
 		push @output, $1, "\n";
 		next;
 	};
+	/^\!block example$/ and do {
+		push @output, "\n<programlisting><![CDATA[\n" unless $in_pl++;
+		push @output, $1, "\n";
+		next;
+	};
+	/^\!endblock$/ and do {
+		push @output, "\n]]></programlisting>\n\n" if $in_pl; $in_pl=0;
+		next;
+	};
+
 
 	# If we got here, we're in "para"
 	push @output, "]]></programlisting>\n\n" if $in_pl; $in_pl=0;
@@ -81,4 +94,6 @@
 }
 
 
-print @output;
+{ no warnings;
+print @output; }
+



1.81      +7 -0      xmldocs/bin/refs-autogen


rev 1.81, prev_rev 1.80
Index: refs-autogen
===================================================================
RCS file: /var/cvs/xmldocs/bin/refs-autogen,v
retrieving revision 1.80
retrieving revision 1.81
diff -u -r1.80 -r1.81
--- refs-autogen	21 Jan 2005 23:41:11 -0000	1.80
+++ refs-autogen	1 Feb 2005 21:35:07 -0000	1.81
@@ -472,6 +472,13 @@
 
 		# 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.
 		for my $gr ( keys %autogenerated ) {
 			$tmp{$_} = $gr
 				for (grep {$autogenerated{$gr}{$_} and $_ ne $ag{name}} @$list);



1.36      +3 -0      xmldocs/bin/stattree


rev 1.36, prev_rev 1.35
Index: stattree
===================================================================
RCS file: /var/cvs/xmldocs/bin/stattree,v
retrieving revision 1.35
retrieving revision 1.36
diff -u -r1.35 -r1.36
--- stattree	8 Dec 2004 14:46:33 -0000	1.35
+++ stattree	1 Feb 2005 21:35:07 -0000	1.36
@@ -347,7 +347,10 @@
 
 					@lis == 1 or die "$tn MapRoutines, but argc != 1 ?\n";
 					next if "@lis" =~ /^::/; # TODO
+					# TODO : Functions don't end up having proper Line: x-y in source
+					# contexts but have Lines: as if the whole file was shown.
 					file_extractSub($tn, "@lis", \%c, {group => $c{fsubtype},name=>$tn});
+					#file_extractSub($tn, "@lis", \%c, {group => 'function',name=>$tn});
 				}
 				
 				if ( "@lis" =~ /<</ and $tagopt !~ /^routine/ ) {



1.1                  xmldocs/bin/procmv.pl


rev 1.1, prev_rev 1.0
Index: procmv.pl
===================================================================
#!/usr/bin/perl

use warnings;
use strict;

#
# Hacked to convert list of mv_ vars and descriptions into files for xmldocs
# This is probably a one-time-use script.
#
# docelic at icdevgroup.org, Dec 2004.
#

my @tmpl = <DATA>;
my %argtype = (
	A => " (All)",
	S => " (Search)",
	O => " (Order)",
	C => "",
	XA => " (Causes execution, All)",
	OS => " (Order, Search)",

);

while (<>) {
	@_ = split /\|/;
	@_ == 4 or die "NOT 4\n";

	$_[4] = lc $_[3];
	$_[5] = $argtype{$_[2]};
	$_[6] = lc $argtype{$_[2]};

	print "IN $_[0]\n";
	( my $txt = join "", @tmpl ) =~ s/(\$_\[\d\])/$1/gee;

	open OUT, "> $_[0].mv" or die "Cant open $_[1] ($!)\n";
	print OUT $txt;
	close OUT;
}


__DATA__

__NAME__ purpose
$_[4]$_[5]
__END__

__NAME__ variable type
$_[6]
__END__

__NAME__ synopsis
<group choice='opt'>
	<arg choice='plain'></arg>
</group>
__END__

__NAME__ description
$_[3]
__END__




1.1                  xmldocs/bin/splitfile.pl


rev 1.1, prev_rev 1.0
Index: splitfile.pl
===================================================================
#!/usr/bin/perl

# Custom script to use chained with icsdf2xml. It takes mostly processed
# input, and splits it to separate files, using a template and file names
# from headers in input

# Usage:
# perl ../../bin/icsdf2xml.pl INPUT_FILE | perl ../../bin/splitfile.pl > /tmp/item_list

use warnings;
use strict;

my @buff;
my $tmpl = join '', <DATA>;

while ($_ = <>) {
	
	if ( /^LI1:\s*([\w_]+?)\s*$/ ) {
		flus();
		@buff=();
		open OUT, "> $1" or die "Can't open $1 ($!)\n";
		print $1, ' ';
		next;
	}

	s/^\s+//;
	push @buff, $_;
	
}

sub flus {
		local $" = "";
		my $c = eval $tmpl;
		print OUT $c;
}

flus();
exit 0;



__DATA__

"
__NAME__ purpose
__END__


__NAME__ synopsis
<group choice='req'>
	<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__


__NAME__ default
<literal></literal>
__END__


__NAME__ description
@buff
__END__


__NAME__ notes
__END__


__NAME__ see also
__END__


__NAME__ missing
More complete information
__END__


__NAME__ example: 
__END__
"









More information about the docs mailing list