[interchange-docs] xmldocs - docelic modified 14 files
docs at icdevgroup.org
docs at icdevgroup.org
Mon Mar 27 17:38:31 EST 2006
User: docelic
Date: 2006-03-27 22:38:31 GMT
Modified: bin refs-autogen stattree
Modified: docbook html-chunks.xsl
Modified: docbook/symbol-templates catconf catvar filter globconf
Modified: globvar mv ordercheck pragma systemtag uitag
Modified: usertag
Log:
- bin/*: some small description text clarifications
- bin/refs-autogen:
- put hash with names of compound output files at the top,
so it can be reused on other places in the code
- fix warning about $hash{version} being undefined
- docbook/symbol-templates/*: add <refclass> element
(it is currently suppressed in output, but will be used to determine
documentation area - for swish searching and all)
- docbook/html-chunks.xsl: attempt to make <refclass> render as
HTML meta variable. Doesn't break the build, but doesn't make the desired
effect either. :|
Revision Changes Path
1.102 +19 -8 xmldocs/bin/refs-autogen
rev 1.102, prev_rev 1.101
Index: refs-autogen
===================================================================
RCS file: /var/cvs/xmldocs/bin/refs-autogen,v
retrieving revision 1.101
retrieving revision 1.102
diff -u -r1.101 -r1.102
--- refs-autogen 16 Dec 2005 13:24:44 -0000 1.101
+++ refs-autogen 27 Mar 2006 22:38:30 -0000 1.102
@@ -25,7 +25,7 @@
my $OUTPUT = "OUTPUT";
my %refcache; # memory cache of Storable files. Not really needed but I
# copied old code which had it, so ...
-my %hash; # complete tree data for each IC version we parse
+my %hash; # complete tree data for each IC version we parse (one by one)
my $cachedir = $ENV{CACHE} || "cache";
my %i; # internally derived data (only $i{ver} for now).
my %autogenerated; # Content of autogenerated symbols
@@ -136,6 +136,14 @@
'filter type' => "&DEF_FILTER_TYPE;",
);
+# Translation from fine-grained names to compound names
+# Selection is done based on last three chars of full name
+my %compounds = (
+ tag => 'tag',
+ onf => 'conf',
+ var => 'var',
+);
+
my @mandatory = (qw/synopsis example description purpose/);
# General section intros and "outros"; this header repeats per-item,
@@ -210,6 +218,11 @@
# Ok, before doing the REAL work, let's dump file entities. We will create
# file $fileentitiespath, and dump entities to it. That file will contain
# entities from ALL IC versions.
+ #
+ # For clarification: The point here is that you can write something like
+ # "For more information, see &cvsfile-README;", and it will automagically
+ # point to that file in ICDEVGROUP CVS.
+ #
# For non-last version, only one entity will be generated. Example:
# FILE: IC4.8/README ----> ENTITY: &cvsfile4.8-README;
# (LOCATION: SITE/cgi-bin/cvsweb/interchange/?only_with_tag=STABLE_4_8-root)
@@ -273,7 +286,7 @@
$MANIFEST[$i] . qq{</ulink>"} . ">\n";
}
}
- # File entities dumped.... Job done.
+ # File entities dumped.... Warmup job done.
#########################################################################
@@ -294,12 +307,10 @@
if (! $symbol_lists{$gkey} ) {
my ($name, @olist);
- $name = $gkey;
+ #$name = $gkey; # Done below
my $pref = "";
if ( $compounds ) {
- $gkey =~ /tag$/ and $name = 'tag';
- $gkey =~ /conf$/ and $name = 'conf';
- $gkey =~ /var$/ and $name = 'var';
+ $name = $compounds{ substr($gkey, -3, 3) } || $gkey;
$pref = "${gkey}s -> ";
}
@@ -573,7 +584,7 @@
$ag{name} ||= $ag{id} || $k;
$ag{name} = $hash{specific}{$ag{name}}{_name} if
$hash{specific}{$ag{name}}{_name};
-
+
################################################################
# DO STUFF HERE IF IT'S COMMON FOR ALL SYMBOLS. IF it's not,
# jump out to symbol-specific-subroutine that will handle that.
@@ -843,7 +854,6 @@
die "Can't produce reference refs/$prefix${group}s.xml ($!)\n";
print OUT $refpage;
close OUT;
-#}
}
@@ -961,6 +971,7 @@
name => $name,
id => $name,
"_symbol type" => $group,
+ "compound name" => $compounds ? $compounds{ substr($group,-3,3) } : $group,
#"symbol type" => "&SYMBOL_" . uc($group) . ";",
};
1.50 +1 -1 xmldocs/bin/stattree
rev 1.50, prev_rev 1.49
Index: stattree
===================================================================
RCS file: /var/cvs/xmldocs/bin/stattree,v
retrieving revision 1.49
retrieving revision 1.50
diff -u -r1.49 -r1.50
--- stattree 16 Dec 2005 13:24:44 -0000 1.49
+++ stattree 27 Mar 2006 22:38:30 -0000 1.50
@@ -363,7 +363,7 @@
# Skip this simple sanity check for 4.6.0 - those files do not
# have .(core)?tag ending.
- if ( $hash{version} ne '4.6.0') {
+ if ( $hash{version} and $hash{version} ne '4.6.0') {
$c{file} =~ m#(\w+?)\.(core)?tag$# or
warn "I know $c{file} is a tag but regex doesn't match it\n";
}
1.13 +8 -0 xmldocs/docbook/html-chunks.xsl
rev 1.13, prev_rev 1.12
Index: html-chunks.xsl
===================================================================
RCS file: /var/cvs/xmldocs/docbook/html-chunks.xsl,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -r1.12 -r1.13
--- html-chunks.xsl 1 Sep 2005 23:12:38 -0000 1.12
+++ html-chunks.xsl 27 Mar 2006 22:38:30 -0000 1.13
@@ -96,5 +96,13 @@
<xsl:copy-of select="$link"/>
</xsl:template>
+ <xsl:template match="refclass[1]">
+ <xsl:variable name="area">
+ <xsl:value-of select="." />
+ </xsl:variable>
+ <meta name="AREA" content="$area" />
+ </xsl:template>
+
+
</xsl:stylesheet>
1.2 +1 -0 xmldocs/docbook/symbol-templates/catconf
rev 1.2, prev_rev 1.1
Index: catconf
===================================================================
RCS file: /var/cvs/xmldocs/docbook/symbol-templates/catconf,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- catconf 26 Nov 2005 13:32:07 -0000 1.1
+++ catconf 27 Mar 2006 22:38:30 -0000 1.2
@@ -9,6 +9,7 @@
<refnamediv>
<refname>$ag{"name"}</refname>
<refpurpose>$ag{"purpose"}</refpurpose>
+<refclass>$ag{"compound name"}</refclass>
</refnamediv>
<refsect1 id='$ag{"name"}_synopsis'>
1.2 +1 -0 xmldocs/docbook/symbol-templates/catvar
rev 1.2, prev_rev 1.1
Index: catvar
===================================================================
RCS file: /var/cvs/xmldocs/docbook/symbol-templates/catvar,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- catvar 26 Nov 2005 13:32:07 -0000 1.1
+++ catvar 27 Mar 2006 22:38:30 -0000 1.2
@@ -9,6 +9,7 @@
<refnamediv>
<refname>$ag{"name"}</refname>
<refpurpose>$ag{"purpose"}</refpurpose>
+<refclass>$ag{"compound name"}</refclass>
</refnamediv>
<refsect1 id='$ag{"name"}_synopsis'>
1.2 +1 -0 xmldocs/docbook/symbol-templates/filter
rev 1.2, prev_rev 1.1
Index: filter
===================================================================
RCS file: /var/cvs/xmldocs/docbook/symbol-templates/filter,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- filter 26 Nov 2005 13:32:07 -0000 1.1
+++ filter 27 Mar 2006 22:38:30 -0000 1.2
@@ -9,6 +9,7 @@
<refnamediv>
<refname>$ag{"name"}</refname>
<refpurpose>$ag{"purpose"}</refpurpose>
+<refclass>$ag{"compound name"}</refclass>
</refnamediv>
<refsect1 id='$ag{"name"}_description'>
1.2 +1 -0 xmldocs/docbook/symbol-templates/globconf
rev 1.2, prev_rev 1.1
Index: globconf
===================================================================
RCS file: /var/cvs/xmldocs/docbook/symbol-templates/globconf,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- globconf 26 Nov 2005 13:32:07 -0000 1.1
+++ globconf 27 Mar 2006 22:38:30 -0000 1.2
@@ -9,6 +9,7 @@
<refnamediv>
<refname>$ag{"name"}</refname>
<refpurpose>$ag{"purpose"}</refpurpose>
+<refclass>$ag{"compound name"}</refclass>
</refnamediv>
<refsect1 id='$ag{"name"}_synopsis'>
1.2 +1 -0 xmldocs/docbook/symbol-templates/globvar
rev 1.2, prev_rev 1.1
Index: globvar
===================================================================
RCS file: /var/cvs/xmldocs/docbook/symbol-templates/globvar,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- globvar 26 Nov 2005 13:32:07 -0000 1.1
+++ globvar 27 Mar 2006 22:38:30 -0000 1.2
@@ -9,6 +9,7 @@
<refnamediv>
<refname>$ag{"name"}</refname>
<refpurpose>$ag{"purpose"}</refpurpose>
+<refclass>$ag{"compound name"}</refclass>
</refnamediv>
<refsect1 id='$ag{"name"}_synopsis'>
1.2 +1 -0 xmldocs/docbook/symbol-templates/mv
rev 1.2, prev_rev 1.1
Index: mv
===================================================================
RCS file: /var/cvs/xmldocs/docbook/symbol-templates/mv,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- mv 26 Nov 2005 13:32:07 -0000 1.1
+++ mv 27 Mar 2006 22:38:30 -0000 1.2
@@ -9,6 +9,7 @@
<refnamediv>
<refname>$ag{"name"}</refname>
<refpurpose>$ag{"purpose"}</refpurpose>
+<refclass>$ag{"compound name"}</refclass>
</refnamediv>
<refsect1 id='$ag{"name"}_synopsis'>
1.2 +1 -0 xmldocs/docbook/symbol-templates/ordercheck
rev 1.2, prev_rev 1.1
Index: ordercheck
===================================================================
RCS file: /var/cvs/xmldocs/docbook/symbol-templates/ordercheck,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ordercheck 26 Nov 2005 13:32:07 -0000 1.1
+++ ordercheck 27 Mar 2006 22:38:30 -0000 1.2
@@ -9,6 +9,7 @@
<refnamediv>
<refname>$ag{"name"}</refname>
<refpurpose>$ag{"purpose"}</refpurpose>
+<refclass>$ag{"compound name"}</refclass>
</refnamediv>
<refsect1 id='$ag{"name"}_description'>
1.2 +1 -0 xmldocs/docbook/symbol-templates/pragma
rev 1.2, prev_rev 1.1
Index: pragma
===================================================================
RCS file: /var/cvs/xmldocs/docbook/symbol-templates/pragma,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- pragma 26 Nov 2005 13:32:07 -0000 1.1
+++ pragma 27 Mar 2006 22:38:30 -0000 1.2
@@ -9,6 +9,7 @@
<refnamediv>
<refname>$ag{"name"}</refname>
<refpurpose>$ag{"purpose"}</refpurpose>
+<refclass>$ag{"compound name"}</refclass>
</refnamediv>
<refsect1 id='$ag{"name"}_synopsis'>
1.2 +1 -0 xmldocs/docbook/symbol-templates/systemtag
rev 1.2, prev_rev 1.1
Index: systemtag
===================================================================
RCS file: /var/cvs/xmldocs/docbook/symbol-templates/systemtag,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- systemtag 26 Nov 2005 13:32:07 -0000 1.1
+++ systemtag 27 Mar 2006 22:38:30 -0000 1.2
@@ -9,6 +9,7 @@
<refnamediv>
<refname>$ag{"name"}</refname>
<refpurpose>$ag{"purpose"}</refpurpose>
+<refclass>$ag{"compound name"}</refclass>
</refnamediv>
<refsect1 id='$ag{"name"}_synopsis'>
1.2 +1 -0 xmldocs/docbook/symbol-templates/uitag
rev 1.2, prev_rev 1.1
Index: uitag
===================================================================
RCS file: /var/cvs/xmldocs/docbook/symbol-templates/uitag,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- uitag 26 Nov 2005 13:32:07 -0000 1.1
+++ uitag 27 Mar 2006 22:38:30 -0000 1.2
@@ -9,6 +9,7 @@
<refnamediv>
<refname>$ag{"name"}</refname>
<refpurpose>$ag{"purpose"}</refpurpose>
+<refclass>$ag{"compound name"}</refclass>
</refnamediv>
<refsect1 id='$ag{"name"}_synopsis'>
1.2 +1 -0 xmldocs/docbook/symbol-templates/usertag
rev 1.2, prev_rev 1.1
Index: usertag
===================================================================
RCS file: /var/cvs/xmldocs/docbook/symbol-templates/usertag,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- usertag 26 Nov 2005 13:32:07 -0000 1.1
+++ usertag 27 Mar 2006 22:38:30 -0000 1.2
@@ -9,6 +9,7 @@
<refnamediv>
<refname>$ag{"name"}</refname>
<refpurpose>$ag{"purpose"}</refpurpose>
+<refclass>$ag{"compound name"}</refclass>
</refnamediv>
<refsect1 id='$ag{"name"}_synopsis'>
More information about the docs
mailing list