[docs] xmldocs - docelic modified 16 files
docs at icdevgroup.org
docs at icdevgroup.org
Tue Aug 24 15:52:08 EDT 2004
User: docelic
Date: 2004-08-24 19:52:08 GMT
Modified: . Makefile TODO
Modified: bin refs-autogen stattree
Modified: cache/4.6.0 .cache.bin
Modified: cache/4.8.0 .cache.bin
Modified: cache/5.0.0 .cache.bin
Modified: cache/5.2.0 .cache.bin
Modified: cache/cvs-head .cache.bin
Modified: docbook docbookxi.dtd
Modified: docbook/item-skel control
Modified: refs/env control example example2
Modified: refs/substitute_table_image control example
Log:
- Makefile:
- add generation of usertags, systemtags and uitags
- bin/refs-autogen:
- Autogenerate second section ("Tag Structure") for tags. This second section
is "context sensitive". For tags it displays the structure; for pragmas
or globvars it displays the default value.
You can override the field by not leaving "default: " empty in
refs/<tagname>/control.
- bin/stattree:
- save tag data to $hash{specific} (this is later used in autogenerating
"Tag Structure" section for tags (in bin/refs-autogen)).
- docbook/docbookxi.dtd:
- Add ICDEVGROUP entity to be used in author: control field like this:
author: Mickey Mouse, &ICDEVGROUP;
- docbook/item-skel/control:
- document that default: should be empty for tags
- refs/env/*:
- adjust entries
- refs/substitute_table_image/example:
- fix typo
- refs/substitute_table_image/control:
- Now that we have the ICDEVGROUP entity handy, add author info
- TODO:
- items
Revision Changes Path
1.15 +3 -0 xmldocs/Makefile
rev 1.15, prev_rev 1.14
Index: Makefile
===================================================================
RCS file: /var/cvs/xmldocs/Makefile,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -r1.14 -r1.15
--- Makefile 10 Aug 2004 17:40:43 -0000 1.14
+++ Makefile 24 Aug 2004 19:52:04 -0000 1.15
@@ -33,6 +33,9 @@
refs: $(OUTPUT)/images $(OUTPUT)/files
make $(OUTPUT)/pragmas.html $(OUTPUT)/pragmas $(OUTPUT)/pragmas.man
make $(OUTPUT)/globvars.html $(OUTPUT)/globvars $(OUTPUT)/globvars.man
+ make $(OUTPUT)/usertags.html $(OUTPUT)/usertags $(OUTPUT)/usertags.man
+ make $(OUTPUT)/systemtags.html $(OUTPUT)/systemtags $(OUTPUT)/systemtags.man
+ make $(OUTPUT)/uitags.html $(OUTPUT)/uitags $(OUTPUT)/uitags.man
howtos: howtos/howtos.xml howtos/*.xml
make $(OUTPUT)/howtos.html
1.11 +2 -0 xmldocs/TODO
rev 1.11, prev_rev 1.10
Index: TODO
===================================================================
RCS file: /var/cvs/xmldocs/TODO,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- TODO 23 Aug 2004 17:38:41 -0000 1.10
+++ TODO 24 Aug 2004 19:52:04 -0000 1.11
@@ -13,6 +13,8 @@
to be prefixed with "Example: ", although they're technically not).
- Add support to document tags which are NOT found in separate files
(like [restrict]).
+- Under availability, if applicable, display cvs line (modification time,
+ username and version).
Mid-term:
- Think about adding "online example" (role=html in combination with
1.22 +12 -1 xmldocs/bin/refs-autogen
rev 1.22, prev_rev 1.21
Index: refs-autogen
===================================================================
RCS file: /var/cvs/xmldocs/bin/refs-autogen,v
retrieving revision 1.21
retrieving revision 1.22
diff -u -r1.21 -r1.22
--- refs-autogen 24 Aug 2004 18:21:59 -0000 1.21
+++ refs-autogen 24 Aug 2004 19:52:04 -0000 1.22
@@ -174,6 +174,16 @@
$ag{name} ||= $ag{id} || $k;
$ag{name} = $hash{specific}{$ag{name}}{_name} if
$hash{specific}{$ag{name}}{_name};
+
+ # 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;
+ }
# _See Also_ section: "bidirectional" linking
if ( defined @{ $ag{'_see also'} } ) {
@@ -298,6 +308,7 @@
id => $name,
"_symbol type" => $group,
"symbol type" => $general_desc{$group},
+ "_first section" => ( $group =~ /tag$/ ? "TAG STRUCTURE" : "DEFAULT" ),
};
# Suplement with information from a control file
@@ -420,7 +431,7 @@
</refsect1>
<refsect1>
-<title>DEFAULT</title>
+<title>$ag{"_first section"}</title>
<para>$ag{"default"}</para>
</refsect1>
1.14 +12 -2 xmldocs/bin/stattree
rev 1.14, prev_rev 1.13
Index: stattree
===================================================================
RCS file: /var/cvs/xmldocs/bin/stattree,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -r1.13 -r1.14
--- stattree 23 Aug 2004 17:38:41 -0000 1.13
+++ stattree 24 Aug 2004 19:52:04 -0000 1.14
@@ -327,9 +327,19 @@
$specific{_name} = $tn;
+ # XXX CRITICAL:
+ # support for multiple tag definitions in the same file is
+ # missing, as well as support for Alias option which has
+ # reverse order (alias Alias name, and not name Alias alias).
+
my $tagopt = lc ( shift @lis );
- next if $tagopt eq 'routine';
- $specific{$tagopt} = "@lis";
+ next if $tagopt =~ /^(routine|documentation)$/;
+ if ( "@lis" =~ /<</ ) {
+ warn "TODO: Unsupported << in $tn\n";
+ next;
+ }
+ $specific{"_tagopt_$tagopt"} = "@lis";
+ #print "$tn :: $tagopt :: @lis\n";
}
$hash{specific}{$tagname} = { %specific };
last;
1.4 +1989 -1361xmldocs/cache/4.6.0/.cache.bin
<<.cache.bin: data>>
1.4 +1752 -1305xmldocs/cache/4.8.0/.cache.bin
rev 1.4, prev_rev 1.3
Index: .cache.bin
===================================================================
RCS file: /var/cvs/xmldocs/cache/4.8.0/.cache.bin,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
Binary files /tmp/cvsHYlRwn and /tmp/cvspXguv7 differ
1.4 +2039 -2121xmldocs/cache/5.0.0/.cache.bin
rev 1.4, prev_rev 1.3
Index: .cache.bin
===================================================================
RCS file: /var/cvs/xmldocs/cache/5.0.0/.cache.bin,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
Binary files /tmp/cvsF1p21T and /tmp/cvstpcltF differ
1.4 +2050 -2128xmldocs/cache/5.2.0/.cache.bin
rev 1.4, prev_rev 1.3
Index: .cache.bin
===================================================================
RCS file: /var/cvs/xmldocs/cache/5.2.0/.cache.bin,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
Binary files /tmp/cvsaLxcfL and /tmp/cvsyJtnny differ
1.12 +1781 -1859xmldocs/cache/cvs-head/.cache.bin
rev 1.12, prev_rev 1.11
Index: .cache.bin
===================================================================
RCS file: /var/cvs/xmldocs/cache/cvs-head/.cache.bin,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
Binary files /tmp/cvsPQXR6J and /tmp/cvsZSFbNy differ
1.7 +2 -0 xmldocs/docbook/docbookxi.dtd
rev 1.7, prev_rev 1.6
Index: docbookxi.dtd
===================================================================
RCS file: /var/cvs/xmldocs/docbook/docbookxi.dtd,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- docbookxi.dtd 13 Aug 2004 21:09:15 -0000 1.6
+++ docbookxi.dtd 24 Aug 2004 19:52:08 -0000 1.7
@@ -31,6 +31,8 @@
<!ENTITY DEF_SEEALSO "No information.">
<!ENTITY DEF_PURPOSE "description line missing">
+<!-- Elements that supplement user's text -->
+<!ENTITY ICDEVGROUP "<ulink url='http://www.icdevgroup.org'>Interchange Development Group</ulink>">
<!-- Remove MsgSet -->
<!ENTITY % compound.class "procedure|sidebar">
1.4 +1 -0 xmldocs/docbook/item-skel/control
rev 1.4, prev_rev 1.3
Index: control
===================================================================
RCS file: /var/cvs/xmldocs/docbook/item-skel/control,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- control 28 Jul 2004 15:27:05 -0000 1.3
+++ control 24 Aug 2004 19:52:08 -0000 1.4
@@ -5,6 +5,7 @@
# purpose: oneline description (MUST FILL IN)
purpose:
# default value if applicable (make it short, just like: 0, none, ...)
+# If documenting a TAG, leave "default" field empty unless you're overriding!
default:
# Please take time to fill in the See Also line.
# Just name the related symbols. The system will work everything out.
1.3 +1 -2 xmldocs/refs/env/control
rev 1.3, prev_rev 1.2
Index: control
===================================================================
RCS file: /var/cvs/xmldocs/refs/env/control,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- control 24 Aug 2004 18:26:44 -0000 1.2
+++ control 24 Aug 2004 19:52:08 -0000 1.3
@@ -1,4 +1,3 @@
purpose: provides read-only access to the HTTP environment variables
-default: none
see also: var
-author: Ed LaFrance
+author: Ed LaFrance, &ICDEVGROUP;
1.2 +5 -3 xmldocs/refs/env/example
rev 1.2, prev_rev 1.1
Index: example
===================================================================
RCS file: /var/cvs/xmldocs/refs/env/example,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- example 13 Aug 2004 21:16:43 -0000 1.1
+++ example 24 Aug 2004 19:52:08 -0000 1.2
@@ -1,16 +1,18 @@
<example>
<title>
-Display the client remote address and port
+Display the client connection and browser information
</title>
<para>
The client's remote address and port are kept in <envar>REMOTE_ADDR</envar>
-and <envar>REMOTE_PORT</envar> variables.
+and <envar>REMOTE_PORT</envar> variables. User's browser ID string is kept in
+<envar>HTTP_USER_AGENT</envar>.
</para>
<programlisting><![CDATA[
-Client connection: [env REMOTE_ADDR]:[env name="REMOTE_PORT"]
+Client connection: [env REMOTE_ADDR]:[env name="REMOTE_PORT"]<br/>
+Client browser: [env arg="HTTP_USER_AGENT"]
]]></programlisting>
</example>
1.2 +1 -1 xmldocs/refs/env/example2
rev 1.2, prev_rev 1.1
Index: example2
===================================================================
RCS file: /var/cvs/xmldocs/refs/env/example2,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- example2 13 Aug 2004 21:16:43 -0000 1.1
+++ example2 24 Aug 2004 19:52:08 -0000 1.2
@@ -5,7 +5,7 @@
</title>
<programlisting><![CDATA[
-HTTP environment: <br>
+HTTP environment: <br/>
[env]
]]></programlisting>
1.4 +1 -0 xmldocs/refs/substitute_table_image/control
rev 1.4, prev_rev 1.3
Index: control
===================================================================
RCS file: /var/cvs/xmldocs/refs/substitute_table_image/control,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- control 24 Aug 2004 18:26:45 -0000 1.3
+++ control 24 Aug 2004 19:52:08 -0000 1.4
@@ -1,3 +1,4 @@
purpose: substitute background image paths in HTML table elements
default: 0
see also: no_image_rewrite, ImageDir, ImageSecureDir
+author: Stefan Hornburg, &ICDEVGROUP;
1.2 +1 -1 xmldocs/refs/substitute_table_image/example
rev 1.2, prev_rev 1.1
Index: example
===================================================================
RCS file: /var/cvs/xmldocs/refs/substitute_table_image/example,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- example 23 Jul 2004 13:32:08 -0000 1.1
+++ example 24 Aug 2004 19:52:08 -0000 1.2
@@ -9,7 +9,7 @@
</para>
<programlisting><![CDATA[
-Pragma substitute_table_images
+Pragma substitute_table_image
]]></programlisting>
</example>
More information about the docs
mailing list