[docs] xmldocs - docelic modified 7 files
docs at icdevgroup.org
docs at icdevgroup.org
Sat Oct 16 09:23:11 EDT 2004
User: docelic
Date: 2004-10-16 13:23:11 GMT
Modified: docbook literals.ent
Modified: refs capture_page email email-raw var
Added: glossary get
Added: refs cgi
Log:
- Documented [cgi]
- Added entities to auto-create rows in parameter lists for tags.
Instead of duplicating rows for each hide= or filter= attribute
(which many tags have), simply use &ROW_HIDE_0, &ROW_HIDE_1, etc..
where 1, 0 or anything else in the third chunk identifies default value.
- Adjusted some ref pages to use above entities.
- Glossary placeholder +1
Revision Changes Path
1.3 +62 -0 xmldocs/docbook/literals.ent
rev 1.3, prev_rev 1.2
Index: literals.ent
===================================================================
RCS file: /var/cvs/xmldocs/docbook/literals.ent,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- literals.ent 6 Oct 2004 20:50:16 -0000 1.2
+++ literals.ent 16 Oct 2004 13:23:10 -0000 1.3
@@ -61,3 +61,65 @@
<!ENTITY ITL "<glossterm linkend='ITL'>ITL</glossterm>">
<!ENTITY SMTP "<ulink url='http://cr.yp.to/smtp.html'>SMTP</ulink> (<classname>Net::SMTP</classname> Perl module)">
+
+<!-- ENTITIES TO EASIER CONSTRUCT TAG PARAMETERS LIST -->
+<!-- put standard ones here, such as Hide or Interpolate/reparse -->
+<!ENTITY ROW_INTERPOLATE_0 "
+<row>
+ <entry>
+ <group choice='opt'>
+ <arg choice='plain'>interpolate</arg>
+ <arg choice='plain'>reparse</arg>
+ </group>
+ </entry>
+ <entry></entry><entry></entry>
+ <entry>0</entry>
+ <entry>Interpolate (reparse) for other Interchange tags?</entry>
+</row>
+">
+<!ENTITY ROW_INTERPOLATE_1 "
+<row>
+ <entry>
+ <group choice='opt'>
+ <arg choice='plain'>interpolate</arg>
+ <arg choice='plain'>reparse</arg>
+ </group>
+ </entry>
+ <entry></entry><entry></entry>
+ <entry>1</entry>
+ <entry>Interpolate (reparse) for other Interchange tags?</entry>
+</row>
+">
+<!ENTITY ROW_HIDE_0 "
+<row>
+ <entry>
+ <arg choice='plain'>hide</arg>
+ </entry>
+ <entry></entry><entry></entry>
+ <entry>0</entry>
+ <entry>Hide the tag return value?</entry>
+</row>
+">
+<!ENTITY ROW_HIDE_1 "
+<row>
+ <entry>
+ <arg choice='plain'>hide</arg>
+ </entry>
+ <entry></entry><entry></entry>
+ <entry>1</entry>
+ <entry>Hide the tag return value?</entry>
+</row>
+">
+<!ENTITY ROW_FILTER_none "
+<row>
+ <entry>
+ <arg choice='plain'>filter</arg>
+ </entry>
+ <entry></entry><entry></entry>
+ <entry>None.</entry>
+ <entry>
+ <glossterm linkend='filter'>Interchange filter</glossterm> to apply.
+ </entry>
+</row>
+">
+
1.1 xmldocs/glossary/get
rev 1.1, prev_rev 1.0
Index: get
===================================================================
<glossentry id="GET">
<glossterm>GET</glossterm>
<glossterm>Form Method: GET</glossterm>
<!--<acronym></acronym>-->
<!--<abbrev></abbrev>-->
<glossdef>
<para>
meek.
</para>
</glossdef>
</glossentry>
1.3 +1 -9 xmldocs/refs/capture_page
rev 1.3, prev_rev 1.2
Index: capture_page
===================================================================
RCS file: /var/cvs/xmldocs/refs/capture_page,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- capture_page 6 Oct 2004 20:50:16 -0000 1.2
+++ capture_page 16 Oct 2004 13:23:10 -0000 1.3
@@ -68,15 +68,7 @@
<entry></entry>
<entry>File creation <glossterm linkend='umask'>umask</glossterm>.</entry>
</row>
-<row>
- <entry>
- <arg choice='plain'>hide</arg>
- </entry>
- <entry></entry><entry></entry>
- <entry>0</entry>
- <entry>Hide return value of the <function>Vend::File::writefile()</function>
- function?</entry>
-</row>
+&ROW_HIDE_0;
__END__
__NAME__ description
1.2 +1 -8 xmldocs/refs/email
rev 1.2, prev_rev 1.1
Index: email
===================================================================
RCS file: /var/cvs/xmldocs/refs/email,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- email 14 Oct 2004 20:14:01 -0000 1.1
+++ email 16 Oct 2004 13:23:10 -0000 1.2
@@ -45,14 +45,7 @@
<entry>Additional e-mail headers to include. For example,
<literal>Errors-To: errors at mydomain.local</literal>.</entry>
</row>
-<row>
- <entry>
- <arg choice='plain'>hide</arg>
- </entry>
- <entry></entry><entry></entry>
- <entry>0</entry>
- <entry>Hide tag return value?</entry>
-</row>
+&ROW_HIDE_0;
__END__
1.2 +1 -8 xmldocs/refs/email-raw
rev 1.2, prev_rev 1.1
Index: email-raw
===================================================================
RCS file: /var/cvs/xmldocs/refs/email-raw,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- email-raw 2 Oct 2004 20:37:19 -0000 1.1
+++ email-raw 16 Oct 2004 13:23:10 -0000 1.2
@@ -4,14 +4,7 @@
__NAME__ synopsis
-<row>
- <entry>
- <arg choice='plain'>hide</arg>
- </entry>
- <entry></entry><entry></entry>
- <entry>0</entry>
- <entry>Hide the tag return value?</entry>
-</row>
+&ROW_HIDE_0;
__END__
1.4 +1 -10 xmldocs/refs/var
rev 1.4, prev_rev 1.3
Index: var
===================================================================
RCS file: /var/cvs/xmldocs/refs/var,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- var 6 Oct 2004 20:50:16 -0000 1.3
+++ var 16 Oct 2004 13:23:10 -0000 1.4
@@ -24,16 +24,7 @@
catalog variable
with the fallback to global, if local one is not defined.</entry>
</row>
-<row>
- <entry>
- <arg choice='plain'>filter</arg>
- </entry>
- <entry>Yes</entry><entry></entry>
- <entry></entry>
- <entry><glossterm linkend='filter'>Interchange filter</glossterm> to
- apply.</entry>
-</row>
-
+&ROW_FILTER_none;
__END__
1.1 xmldocs/refs/cgi
rev 1.1, prev_rev 1.0
Index: cgi
===================================================================
__NAME__ purpose
get or set current value of the specified CGI input variable
__END__
__NAME__ see also
value
__END__
__NAME__ synopsis
<row>
<entry>
<arg choice='plain'>name</arg>
</entry>
<entry>Yes</entry><entry>Yes</entry>
<entry></entry>
<entry>Name of the CGI input variable.</entry>
</row>
<row>
<entry>
<arg choice='plain'>set</arg>
</entry>
<entry></entry><entry></entry>
<entry>None.</entry>
<entry>New value for a variable to set, instead of retrieving
the current content.</entry>
</row>
<row>
<entry>
<arg choice='plain'>default</arg>
</entry>
<entry></entry><entry></entry>
<entry>None.</entry>
<entry>
Text to return if the variable requested is missing or otherwise
false.
</entry>
</row>
<row>
<entry>
<arg choice='plain'>enable_html</arg>
</entry>
<entry></entry><entry></entry>
<entry>0</entry>
<entry>Allow HTML tags to appear in the output? By default,
All < characters are replaced by &lt;.
</entry>
</row>
<row>
<entry>
<arg choice='plain'>keep</arg>
</entry>
<entry></entry><entry></entry>
<entry>0</entry>
<entry>
Do apply filter for display, but do not modify the original
CGI value itself (from the the <varname>$CGI::values</varname> hash)?
</entry>
</row>
&ROW_FILTER_none;
&ROW_HIDE_0;
__END__
__NAME__ notes
This is one of often used Interchange tags.
__END__
__NAME__ description
The tag displays the value of a CGI variable submitted to a current page.
This is similar to the <tag>value</tag> tag, except that it displays
transitory values that have been submitted with the current request.
In other words, the CGI values are reset on each request and you can
only access the values directly submitted to the current page.
</para><para>
For instance, if you invoke the page with <glossterm linkend='GET'>GET
</glossterm> parameters, such as <literal>pagename?foo=bar</literal>,
then the value of the <literal>foo</literal> CGI variable will be
accessible using <code>[cgi foo]</code> in
&ITL; or <code>$CGI->{foo}</code> in embedded Perl.
__END__
__NAME__ notes
__END__
__NAME__ example
<example>
<title>Accessing CGI variables</title>
<para>
Save the following content to a test page named say,
<filename>cgitest.html</filename>, then visit
<literal><![CDATA[cgitest?foo=bar&toad=stool]]></literal> with your browser.
</para>
<programlisting>
<![CDATA[
Value of 'foo': [cgi foo]<br/>
Value of 'toad': [cgi name=toad]<br/>
]]>
</programlisting>
</example>
__END__
More information about the docs
mailing list