[docs] xmldocs - docelic modified 34 files
docs at icdevgroup.org
docs at icdevgroup.org
Fri Sep 24 17:01:02 EDT 2004
User: docelic
Date: 2004-09-24 21:01:02 GMT
Modified: . README TODO
Modified: bin refs-autogen
Modified: docbook common.xsl xmldocs.css
Modified: docbook/item-skel example synopsis
Modified: refs var
Modified: refs/CGIWRAP_WORKAROUND synopsis
Modified: refs/MV_BAD_LOCK synopsis
Modified: refs/MV_DOLLAR_ZERO synopsis
Modified: refs/MV_FILE synopsis
Modified: refs/MV_GETPPID_BROKEN synopsis
Modified: refs/MV_HELO synopsis
Modified: refs/MV_HTML4_COMPLIANT synopsis
Modified: refs/MV_MAILFROM synopsis
Modified: refs/MV_NO_CRYPT synopsis
Modified: refs/MV_PAGE synopsis
Modified: refs/MV_PREV_PAGE synopsis
Modified: refs/MV_SESSION_READ_RETRY synopsis
Modified: refs/MV_SMTPHOST synopsis
Modified: refs/MV_SUBJECT synopsis
Modified: refs/area synopsis
Modified: refs/init_page synopsis
Modified: refs/no_html_parse synopsis
Modified: refs/no_image_rewrite synopsis
Modified: refs/post_page synopsis
Modified: refs/pre_page synopsis
Modified: refs/safe_data synopsis
Modified: refs/strip_white synopsis
Modified: refs/substitute_table_image synopsis
Added: refs button
Added: refs/env synopsis
Removed: docbook/item-skel bugs
Log:
A large commit with many enhancements:
- README: update to current
- TODO: items
- bin/refs-autogen: restructured the order of sections in generated refentries
- docbook/common.xsl: turned use.extensions to 0 (it prevented <table>s from working)
- docbook/xmldocs.css: definitions for table elements (needs more tuning)
- docbook/item-skel/*: adjusted
- refs/*/synopsis: adjusted to new scheme
Revision Changes Path
1.9 +38 -11 xmldocs/README
rev 1.9, prev_rev 1.8
Index: README
===================================================================
RCS file: /var/cvs/xmldocs/README,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- README 21 Sep 2004 10:12:48 -0000 1.8
+++ README 24 Sep 2004 21:00:59 -0000 1.9
@@ -5,6 +5,10 @@
ICDEVGROUP Documentation Set
http://www.icdevgroup.org/cgi-bin/cvsweb/xmldocs/
+This is a technical look at the XMLDOCS system, and it tells you how to get
+the documentation generated. For the XMLDOCS authoring QuickStart, see
+guides/xmldocs.xml (or that is OUTPUT/xmldocs.html after you run 'make').
+
INTRODUCTION
@@ -24,9 +28,9 @@
make OUTPUT/iccattut.man
make OUTPUT/xmldocs.css
- make tmp/stattrees
- make tmp/refs-autogen
make tmp/olinkdbs
+ make tmp/stattrees (same as 'make cache')
+ make tmp/refs-autogen (same as 'make refxmls')
PREREQUISITES
@@ -59,8 +63,9 @@
from it are created by bin/mkreport.
The cache is Perl's portable Storable dump, and is only
- a convenience. If the binary is incompatible for you,
- simply get Interchange sources and run bin/stattree yourself.
+ a convenience. If the binary is incompatible for you
+ (which often happens to be the case), simply get
+ Interchange sources and run bin/stattree yourself.
OUTPUT/ - Autogenerated:
directory containing the actual completely self-contained
@@ -80,6 +85,7 @@
guides - Collection of guides
howtos - Collection of howtos
refs - Collection of reference pages
+ glossary - Collection of glossary items
images - All images
tmp - (not in CVS) Scratch and temporary file space
pending - A "pending" directory.
@@ -91,7 +97,6 @@
in with subdirectories containing Interchange releases
(say, 4.8.0/, 5.0.0/, 5.2.0, cvs-head/), then you can run
'make tmp/stattrees' to generate the source tree information.
- Both sources/ and its subdirectories can be symlinks.
Updating cache/:
@@ -119,11 +124,12 @@
files are filesystem interface to tree-level statistics, and can be
used in numerous ways, XInclude for example.
Like: Interchange consists of <xi:include file='.../total.files'> files.
+ (Currently this is not enabled).
The XML "preprocessor" tool:
- There's bin/pp tool which you can use to write XML more conveniently.
- See the script itself for usage notes.
+ There's bin/pp tool which you can use to write larger blocks of
+ XML more conveniently. See the script itself for usage notes.
Autogeneration of the reference pages: ** IMPORTANT **
@@ -139,9 +145,14 @@
other parts must be added manually by us.
Let's take an example of "post_page" pragma (but the principle is the same
- for any symbol). User-supplied information is found in refs/<symbol>/
- directory. Information which is needed to consider a symbol documentation
- complete includes:
+ for any symbol). User-supplied information is found in either:
+
+ o refs/<symbol>/ directory, or
+ o refs/<symbol> file, where multiple sections are defined using the
+ __NAME__ <section> and __END__ tokens (similar to IC profiles ;-).
+
+ Regardless of the way you document an item, the following information
+ is needed to consider the symbol documentation complete:
- autogenerated:
id, name, symbol type, availability, source occurences
@@ -151,8 +162,10 @@
purpose, synopsis, description, examples, see also
All of those fields can both be overriden or appended with user-supplied
- information.
+ information:
+ o refs/<symbol>/* method (one-directory, multiple-files):
+
To unconditionally override values and/or provide one-liner contents, use
refs/<symbol>/control file. It has pretty much inflexible "field: content"
line format, but # comments can be used.
@@ -176,6 +189,20 @@
but you can use XML comments <!-- commented section -->.
To avoid having to escape all HTML entities and everything, simply
enclose "dirty" blocks in <![CDATA[ ... ]]>.
+
+ o refs/<symbol> method (one-file):
+
+ All rules apply as above, except that instead of creating a new file
+ (say, refs/post_page/description), you add it to refs/post_page this way:
+
+ __NAME__ description
+ ...anything...
+ __END__
+
+ Over time it appeared we only want to append information and never
+ override it, so this method does not have a way to override a value
+ like refs/<symbol>/control file can do.
+
** To create the documentation for a yet non-existant item or modify an
** existing item, simply run bin/editem <name>. It will create all the
1.23 +4 -0 xmldocs/TODO
rev 1.23, prev_rev 1.22
Index: TODO
===================================================================
RCS file: /var/cvs/xmldocs/TODO,v
retrieving revision 1.22
retrieving revision 1.23
diff -u -r1.22 -r1.23
--- TODO 24 Sep 2004 12:05:09 -0000 1.22
+++ TODO 24 Sep 2004 21:00:59 -0000 1.23
@@ -7,6 +7,7 @@
- See why the autogenerated navigation links are so retarded (just home/up,
no next/prev)
- not to forget, fix cases where context goes to negative values
+- Source contexts get some weird values reported in header information
- In iccattut:
- under important file and directories, mention default username,
@@ -22,6 +23,9 @@
- refresh docbook/item-skel/* and provide support for one-file docs in
bin/editem
- in source contexts, wrap runaway lines
+
+HOWTOs:
+- how to delete item from cart in all possible ways
DOCUMENTATION SYSTEM:
- copy the definition for <example> to a
1.33 +39 -10 xmldocs/bin/refs-autogen
rev 1.33, prev_rev 1.32
Index: refs-autogen
===================================================================
RCS file: /var/cvs/xmldocs/bin/refs-autogen,v
retrieving revision 1.32
retrieving revision 1.33
diff -u -r1.32 -r1.33
--- refs-autogen 24 Sep 2004 12:05:09 -0000 1.32
+++ refs-autogen 24 Sep 2004 21:00:59 -0000 1.33
@@ -607,8 +607,10 @@
</refnamediv>
<refsect1 id='$ag{"name"}_synopsis'>
-<title>SYNOPSIS</title>
+<title>VALUE</title>
+<cmdsynopsis>
$ag{"synopsis"}
+</cmdsynopsis>
</refsect1>
<refsect1 id='$ag{"name"}_default'>
@@ -677,19 +679,48 @@
<refpurpose>$ag{"purpose"}</refpurpose>
</refnamediv>
+<refsect1 id='$ag{"name"}_description'>
+<title>DESCRIPTION</title>
+<para>$ag{"description"}</para>
+</refsect1>
+
<refsect1 id='$ag{"name"}_synopsis'>
-<title>SYNOPSIS</title>
+<title>PARAMETERS</title>
+
+<informaltable cellspacing='4' cellpadding='2' pgwide='1'>
+<tgroup cols='5' align='left' colsep='1' rowsep='1'>
+<colspec colname='arg'/>
+<colspec colname='pos'/>
+<colspec colname='req'/>
+<colspec colname='def'/>
+<colspec colname='dsc'/>
+
+<thead>
+<row>
+<entry>Argument</entry>
+<entry>Pos.</entry>
+<entry>Req.</entry>
+<entry>Default</entry>
+<entry>Description</entry>
+</row>
+</thead>
+<tbody>
$ag{"synopsis"}
+</tbody>
+</tgroup>
+</informaltable>
</refsect1>
+<!-- Disabled. I could remove it unless I do something useful with it.
<refsect1 id='$ag{"name"}_structure"}'>
<title>TAG STRUCTURE</title>
<para>$ag{"structure"}</para>
</refsect1>
+-->
-<refsect1 id='$ag{"name"}_description'>
-<title>DESCRIPTION</title>
-<para>$ag{"description"}</para>
+<refsect1 id='$ag{"name"}_notes'>
+<title>NOTES</title>
+<para>$ag{"notes"}</para>
</refsect1>
<refsect1 id='$ag{"name"}_examples'>
@@ -697,11 +728,6 @@
$ag{"example"}
</refsect1>
-<refsect1 id='$ag{"name"}_notes'>
-<title>NOTES</title>
-<para>$ag{"notes"}</para>
-</refsect1>
-
<refsect1 id='$ag{"name"}_availability'>
<title>AVAILABILITY</title>
<para>$ag{"name"} is available in Interchange versions:
@@ -721,10 +747,13 @@
<para>$ag{"author"}</para>
</refsect1>
+<!-- Removed because copyright is seen in Source (first few lines),
+ and the generated document starts with copyright notice
<refsect1 id='$ag{"name"}_copyright'>
<title>COPYRIGHT</title>
$ag{"copyright"}
</refsect1>
+-->
<refsect1 id='$ag{"name"}_seeAlso'>
<title>SEE ALSO</title>
1.10 +1 -1 xmldocs/docbook/common.xsl
rev 1.10, prev_rev 1.9
Index: common.xsl
===================================================================
RCS file: /var/cvs/xmldocs/docbook/common.xsl,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- common.xsl 21 Sep 2004 09:28:28 -0000 1.9
+++ common.xsl 24 Sep 2004 21:01:00 -0000 1.10
@@ -18,7 +18,7 @@
<xsl:param name="callout.graphics">1</xsl:param>
<xsl:param name="callout.graphics.path">./images/</xsl:param>
- <xsl:param name="use.extensions">1</xsl:param>
+ <xsl:param name="use.extensions">0</xsl:param>
<xsl:param name="textinsert.extension">1</xsl:param>
<!--<xsl:template match="tag"><xsl:text>[</xsl:text><xsl:call-template name="inline.monoseq"/><xsl:text>]</xsl:text></xsl:template>-->
1.14 +11 -0 xmldocs/docbook/xmldocs.css
rev 1.14, prev_rev 1.13
Index: xmldocs.css
===================================================================
RCS file: /var/cvs/xmldocs/docbook/xmldocs.css,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -r1.13 -r1.14
--- xmldocs.css 21 Sep 2004 11:40:26 -0000 1.13
+++ xmldocs.css 24 Sep 2004 21:01:00 -0000 1.14
@@ -300,3 +300,14 @@
color: #208cbd;
}
+
+thead {
+ background-color: black;
+ color: white;
+}
+
+table, tbody,thead,tfoot, tr,td {
+ border-color: #8F8F8F;
+ border: dotted 1px;
+}
+
1.2 +1 -1 xmldocs/docbook/item-skel/example
rev 1.2, prev_rev 1.1
Index: example
===================================================================
RCS file: /var/cvs/xmldocs/docbook/item-skel/example,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- example 21 Jul 2004 20:55:52 -0000 1.1
+++ example 24 Sep 2004 21:01:00 -0000 1.2
@@ -1,5 +1,5 @@
<!-- Template example. Fill in the title (in title), short description
- (in para) and actual program chunk (inside listing/cdata).
+ (in para) and actual program chunk (inside programlisting/cdata).
Delete those 3 lines of comments. -->
<example>
1.5 +18 -8 xmldocs/docbook/item-skel/synopsis
rev 1.5, prev_rev 1.4
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/docbook/item-skel/synopsis,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- synopsis 2 Sep 2004 19:15:16 -0000 1.4
+++ synopsis 24 Sep 2004 21:01:00 -0000 1.5
@@ -1,11 +1,21 @@
-<!-- Where applicable, show syntax in a way which is opposite of the
- default value.
+<!-- Syntax section appears to be very complex. The convention follows:
- Describe various options inside 'description' file, not here.
- Delete those comment lines.
+1. pragmas/globvars (context is <cmdsynopsis>):
+ <group choice='req'>
+ <arg choice='plain'>0</arg>
+ <arg choice='plain'>1</arg>
+ <arg choice='plain'><replaceable>string</replaceable></arg>
+ </group>
- ** If you're documenting a TAG, leave this file completely empty,
- syntax line for tags is autogenerated ** -->
+2. any kind of tags (context is <table> with all headers etc.):
+ <row>
+ <entry>SYMBOL_ARGUMENT_NAME</entry>
+ <entry>POSITIONAL ('Yes' or empty)</entry>
+ <entry>REQUIRED ('Yes' or empty)</entry>
+ <entry>DEFAULT (number, description or <literal>value</literal>)</entry>
+ <entry>DESCRIPTION</entry>
+ </row>
-<cmdsynopsis>
-</cmdsynopsis>
+
+Take out the template that suits you best, edit it and delete all other
+comments. -->
1.2 +28 -7 xmldocs/refs/var
rev 1.2, prev_rev 1.1
Index: var
===================================================================
RCS file: /var/cvs/xmldocs/refs/var,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- var 24 Sep 2004 12:05:09 -0000 1.1
+++ var 24 Sep 2004 21:01:00 -0000 1.2
@@ -1,15 +1,36 @@
__NAME__ purpose
-access global and catalog variables
+access local (catalog) and global Interchange variables
__END__
__NAME__ synopsis
-name=<replaceable>variable name</replaceable>
-global=<group choice='opt'>
- <arg choice='plain'>1</arg>
- <arg choice='plain'>2</arg>
- </group>
-filter=<replaceable>filter name</replaceable>
+<row>
+ <entry>
+ <arg choice='plain'>name</arg>
+ </entry>
+ <entry>Yes</entry><entry>Yes</entry>
+ <entry></entry>
+ <entry>Name of the Interchange variable to display.</entry>
+</row>
+<row>
+ <entry>
+ <arg choice='plain'>global</arg>
+ </entry>
+ <entry>Yes</entry><entry></entry>
+ <entry></entry>
+ <entry>Empty value only looks for a catalog variable. Value of 1 looks
+ only for a global variable. Value of 2 looks for the 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>Filter to apply.</entry>
+</row>
+
__END__
1.1 xmldocs/refs/button
rev 1.1, prev_rev 1.0
Index: button
===================================================================
__NAME__ purpose
create HTML or JavaScript form submit button
__END__
__NAME__ synopsis2
<row>
<entry>name</entry>
<entry>Yes</entry><entry></entry>
<entry><literal>mv_click</literal></entry>
<entry>Button name</entry>
</row>
<row>
<entry>src</entry>
<entry>Yes</entry><entry></entry>
<entry></entry>
<entry>
Image file to use. If the value starts with <literal>http</literal>,
it is used <emphasis>as-is</emphasis>. Otherwise the tag makes sure the
image file is reachable. Requires JavaScript.
</entry>
</row>
<row>
<entry>text</entry>
<entry>Yes</entry><entry></entry>
<entry></entry>
<entry>
Button text. Scratch variable of the same name is also created to
hold the code associated with the button.
</entry>
</row>
<row>
<entry>wait-text</entry>
<entry></entry><entry></entry>
<entry></entry>
<entry>
Button text to show while the next page is being loaded.
If defined, this is used for the scratch variable name instead of the
<arg choice='plain'>text</arg> argument value. Requires JavaScript.
</entry>
</row>
<row>
<entry>form</entry>
<entry></entry><entry></entry>
<entry>First form on the page (document.forms[0])</entry>
<entry>Form name that this button will submit.</entry>
</row>
<row>
<entry>confirm</entry>
<entry></entry><entry></entry>
<entry></entry>
<entry>
Text for the Yes/No confirmation window that will show up before
the client's browser starts with form submission.
Requires JavaScript.</entry>
</row>
<row>
<entry>getsize</entry>
<entry></entry><entry></entry>
<entry>0</entry>
<entry>
Use Image::Size to determine image size and add width= and height= parameters
to the image definition.
</entry>
</row>
<row>
<entry>alt</entry>
<entry></entry><entry></entry>
<entry>Value of <arg choice='plain'>text</arg></entry>
<entry>Alternate text for the window.status and balloons.</entry>
</row>
<row>
<entry>anchor</entry>
<entry></entry><entry></entry>
<entry>Value of <arg choice='plain'>text</arg></entry>
<entry>HTML anchor name.</entry>
</row>
<row>
<entry>hidetext</entry>
<entry></entry><entry></entry>
<entry>0</entry>
<entry>Hide button text.</entry>
</row>
<row>
<entry>extra</entry>
<entry></entry><entry></entry>
<entry></entry>
<entry>
Extra HTML parameters. Passed verbatim. Note that the CSS attributes
<arg choice='plain'>id</arg>, <arg choice='plain'>class</arg> and
<arg choice='plain'>style</arg>
<emphasis role='bold'>are</emphasis>
available separately. Use this only for custom purposes.
</entry>
</row>
<row>
<entry>border</entry>
<entry></entry><entry></entry>
<entry>0</entry>
<entry>Standard <img> property.</entry>
</row>
<row>
<entry>height</entry>
<entry></entry><entry></entry>
<entry></entry>
<entry>Standard <img> property.</entry>
</row>
<row>
<entry>width</entry>
<entry></entry><entry></entry>
<entry></entry>
<entry>Standard <img> property.</entry>
</row>
<row>
<entry>vspace</entry>
<entry></entry><entry></entry>
<entry></entry>
<entry>Standard <img> property.</entry>
</row>
<row>
<entry>hspace</entry>
<entry></entry><entry></entry>
<entry></entry>
<entry>Standard <img> property.</entry>
</row>
<row>
<entry>align</entry>
<entry></entry><entry></entry>
<entry></entry>
<entry>Standard <img> property.</entry>
</row>
<row>
<entry>id</entry>
<entry></entry><entry></entry>
<entry></entry>
<entry>CSS parameter</entry>
</row>
<row>
<entry>class</entry>
<entry></entry><entry></entry>
<entry></entry>
<entry>CSS parameter</entry>
</row>
<row>
<entry>style</entry>
<entry></entry><entry></entry>
<entry></entry>
<entry>CSS parameter</entry>
</row>
__END__
__NAME__ see also
env
__END__
__NAME__ description
This tag creates a <mv>mv_click</mv> form submit button.
</para><para>
Standard, text-only submit button is output in the form of
<![CDATA[<input type='submit' ...>]]>.
</para><para>
JavaScript submit button can contain an image in place of the standard
button text and is output as a combination of
<![CDATA[<a href=...>]]> and
<![CDATA[<img src=...>]]> HTML tags.
It can also produce other enhancements to the plain submit button, such
as confirmation popup windows.
</para><para>
See <xref linkend='button_examples'/> for illustrative presentation.
__END__
__NAME__ notes
<!-- This is preserved from old [button] docs but doesn't seem useful any more. -->
<!--
If your images stop showing on pages served over SSL, try using absolute
<arg choice='plain'>src</arg> option. Replace
<code>src="/tutorial/images/iclogo.png"</code> with
<code>src="http://myhost.mydomain.local/tutorial/images/iclogo.png"
</programlisting>
-->
__END__
__NAME__ example
<example>
<title>Submit button with an image and confirmation window</title>
<para>
Notice the tags used in the button body:
</para>
<programlisting>
[button text="Delete item" confirm="Are you sure?" src="delete.gif"]
[comment]
[button] element's body specifies the action code. It is what you would
put inside [set Delete item][/set] if you were creating the button
manually.
[/comment]
[mvtag] Use any Interchange tag here, i.e. ....[/mvtag]
[perl] # code to delete item [/perl]
[/button]
</programlisting>
</example>
__END__
__NAME__ example-inp
<example>
<title>Creating the submit button manually</title>
<para>
We are here to discuss the usage of the [button] tag, but let's take a
look at an
example equivalent to the one above, except that we create the button
manually:
</para>
<programlisting>
[set Delete item]
[comment]
[button] element's body specifies the action code.
[/comment]
[mvtag] Use any Interchange tag here, i.e. ....[/mvtag]
[perl] # code to delete item [/perl]
[/set]
<![CDATA[
<input type='submit' name='mv_click' value='Delete item'>
]]>
</programlisting>
</example>
__END__
__NAME__ example-js
<example>
<title>Simple button with an embedded custom JavaScript code</title>
<programlisting>
[button text="Click me"]
[javascript]onClick="myOwnOnClickFunction(this);"[/javascript]
[/button]
</programlisting>
</example>
__END__
1.4 +0 -2 xmldocs/refs/CGIWRAP_WORKAROUND/synopsis
rev 1.4, prev_rev 1.3
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/CGIWRAP_WORKAROUND/synopsis,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- synopsis 22 Sep 2004 21:13:05 -0000 1.3
+++ synopsis 24 Sep 2004 21:01:00 -0000 1.4
@@ -1,6 +1,4 @@
-<cmdsynopsis>
<group choice='req'>
<arg choice='plain'>0</arg>
<arg choice='plain'>1</arg>
</group>
-</cmdsynopsis>
1.4 +0 -2 xmldocs/refs/MV_BAD_LOCK/synopsis
rev 1.4, prev_rev 1.3
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_BAD_LOCK/synopsis,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- synopsis 22 Sep 2004 21:13:05 -0000 1.3
+++ synopsis 24 Sep 2004 21:01:00 -0000 1.4
@@ -1,6 +1,4 @@
-<cmdsynopsis>
<group choice='req'>
<arg choice='plain'>0</arg>
<arg choice='plain'>1</arg>
</group>
-</cmdsynopsis>
1.6 +0 -2 xmldocs/refs/MV_DOLLAR_ZERO/synopsis
rev 1.6, prev_rev 1.5
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_DOLLAR_ZERO/synopsis,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- synopsis 22 Sep 2004 21:13:05 -0000 1.5
+++ synopsis 24 Sep 2004 21:01:00 -0000 1.6
@@ -1,7 +1,5 @@
-<cmdsynopsis>
<group choice='req'>
<arg choice='plain'>0</arg>
<arg choice='plain'>1</arg>
<arg choice='plain'><replaceable>string</replaceable></arg>
</group>
-</cmdsynopsis>
1.3 +0 -2 xmldocs/refs/MV_FILE/synopsis
rev 1.3, prev_rev 1.2
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_FILE/synopsis,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- synopsis 2 Sep 2004 19:15:17 -0000 1.2
+++ synopsis 24 Sep 2004 21:01:00 -0000 1.3
@@ -1,3 +1 @@
-<cmdsynopsis>
@@MV_FILE@@
-</cmdsynopsis>
1.4 +0 -2 xmldocs/refs/MV_GETPPID_BROKEN/synopsis
rev 1.4, prev_rev 1.3
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_GETPPID_BROKEN/synopsis,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- synopsis 22 Sep 2004 21:13:05 -0000 1.3
+++ synopsis 24 Sep 2004 21:01:00 -0000 1.4
@@ -1,6 +1,4 @@
-<cmdsynopsis>
<group choice='req'>
<arg choice='plain'>0</arg>
<arg choice='plain'>1</arg>
</group>
-</cmdsynopsis>
1.5 +0 -2 xmldocs/refs/MV_HELO/synopsis
rev 1.5, prev_rev 1.4
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_HELO/synopsis,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- synopsis 22 Sep 2004 21:13:06 -0000 1.4
+++ synopsis 24 Sep 2004 21:01:01 -0000 1.5
@@ -1,3 +1 @@
-<cmdsynopsis>
<arg choice='req'><replaceable>host name</replaceable></arg>
-</cmdsynopsis>
1.4 +0 -2 xmldocs/refs/MV_HTML4_COMPLIANT/synopsis
rev 1.4, prev_rev 1.3
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_HTML4_COMPLIANT/synopsis,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- synopsis 22 Sep 2004 21:13:06 -0000 1.3
+++ synopsis 24 Sep 2004 21:01:01 -0000 1.4
@@ -1,6 +1,4 @@
-<cmdsynopsis>
<group choice='req'>
<arg choice='plain'>0</arg>
<arg choice='plain'>1</arg>
</group>
-</cmdsynopsis>
1.5 +0 -2 xmldocs/refs/MV_MAILFROM/synopsis
rev 1.5, prev_rev 1.4
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_MAILFROM/synopsis,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- synopsis 22 Sep 2004 21:13:06 -0000 1.4
+++ synopsis 24 Sep 2004 21:01:01 -0000 1.5
@@ -1,6 +1,4 @@
-<cmdsynopsis>
<group choice='req'>
<arg choice='plain'><replaceable>user name</replaceable></arg>
<arg choice='plain'><replaceable>e-mail address</replaceable></arg>
</group>
-</cmdsynopsis>
1.4 +0 -2 xmldocs/refs/MV_NO_CRYPT/synopsis
rev 1.4, prev_rev 1.3
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_NO_CRYPT/synopsis,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- synopsis 22 Sep 2004 21:13:06 -0000 1.3
+++ synopsis 24 Sep 2004 21:01:01 -0000 1.4
@@ -1,6 +1,4 @@
-<cmdsynopsis>
<group choice='req'>
<arg choice='plain'>0</arg>
<arg choice='plain'>1</arg>
</group>
-</cmdsynopsis>
1.3 +0 -2 xmldocs/refs/MV_PAGE/synopsis
rev 1.3, prev_rev 1.2
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_PAGE/synopsis,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- synopsis 2 Sep 2004 19:15:17 -0000 1.2
+++ synopsis 24 Sep 2004 21:01:01 -0000 1.3
@@ -1,3 +1 @@
-<cmdsynopsis>
@@MV_PAGE@@
-</cmdsynopsis>
1.3 +0 -2 xmldocs/refs/MV_PREV_PAGE/synopsis
rev 1.3, prev_rev 1.2
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_PREV_PAGE/synopsis,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- synopsis 2 Sep 2004 19:15:17 -0000 1.2
+++ synopsis 24 Sep 2004 21:01:01 -0000 1.3
@@ -1,3 +1 @@
-<cmdsynopsis>
@@MV_PREV_PAGE@@
-</cmdsynopsis>
1.5 +0 -2 xmldocs/refs/MV_SESSION_READ_RETRY/synopsis
rev 1.5, prev_rev 1.4
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_SESSION_READ_RETRY/synopsis,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- synopsis 22 Sep 2004 21:13:06 -0000 1.4
+++ synopsis 24 Sep 2004 21:01:01 -0000 1.5
@@ -1,3 +1 @@
-<cmdsynopsis>
<arg choice='req'><replaceable>count</replaceable></arg>
-</cmdsynopsis>
1.5 +0 -2 xmldocs/refs/MV_SMTPHOST/synopsis
rev 1.5, prev_rev 1.4
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_SMTPHOST/synopsis,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- synopsis 22 Sep 2004 21:13:06 -0000 1.4
+++ synopsis 24 Sep 2004 21:01:01 -0000 1.5
@@ -1,3 +1 @@
-<cmdsynopsis>
<arg choice='req'><replaceable>host name</replaceable></arg>
-</cmdsynopsis>
1.3 +0 -2 xmldocs/refs/MV_SUBJECT/synopsis
rev 1.3, prev_rev 1.2
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_SUBJECT/synopsis,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- synopsis 2 Sep 2004 19:15:18 -0000 1.2
+++ synopsis 24 Sep 2004 21:01:01 -0000 1.3
@@ -1,3 +1 @@
-<cmdsynopsis>
@@MV_SUBJECT@@
-</cmdsynopsis>
1.4 +19 -18 xmldocs/refs/area/synopsis
rev 1.4, prev_rev 1.3
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/area/synopsis,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- synopsis 22 Sep 2004 21:13:07 -0000 1.3
+++ synopsis 24 Sep 2004 21:01:01 -0000 1.4
@@ -1,18 +1,19 @@
-<cmdsynopsis>
- <arg choice='plain'>
- <arg choice='opt'>href=</arg><replaceable>path</replaceable>
- </arg>
- <arg choice='opt'>
- <arg choice='opt'>arg=</arg>
- <replaceable>arg1=value1/arg2=value2...</replaceable>
- </arg>
- <arg choice='opt'>
- secure='<group choice='plain'>
- <arg choice='plain'>0</arg>
- <arg choice='plain'>1</arg>
- </group>'
- </arg>
- <arg choice='opt'>
- form=<replaceable>form variables</replaceable>
- </arg>
-</cmdsynopsis>
+<row>
+ <entry>href</entry>
+ <entry>Yes</entry><entry>Yes</entry>
+ <entry></entry>
+ <entry>URL to link to.</entry>
+</row>
+<row>
+ <entry>arg</entry>
+ <entry>Yes</entry><entry></entry>
+ <entry></entry>
+ <entry>Argument list to pass onto the target page. Format of
+ the value is <replaceable>arg1=value1/arg2=value2...</replaceable></entry>
+</row>
+<row>
+ <entry>secure</entry>
+ <entry></entry><entry></entry>
+ <entry>0</entry>
+ <entry>Use HTTPS for the target page</entry>
+</row>
1.1 xmldocs/refs/env/synopsis
rev 1.1, prev_rev 1.0
Index: synopsis
===================================================================
<row>
<entry>
<group choice="opt">
<arg choice='plain'>arg</arg>
<arg choice='plain'>name</arg>
</group>
</entry>
<entry>Yes</entry><entry></entry>
<entry></entry>
<entry>Name of the environment variable to display, if any.</entry>
</row>
1.4 +0 -2 xmldocs/refs/init_page/synopsis
rev 1.4, prev_rev 1.3
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/init_page/synopsis,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- synopsis 22 Sep 2004 21:13:07 -0000 1.3
+++ synopsis 24 Sep 2004 21:01:01 -0000 1.4
@@ -1,3 +1 @@
-<cmdsynopsis>
<arg choice='req'><replaceable>subroutine name</replaceable></arg>
-</cmdsynopsis>
1.5 +0 -2 xmldocs/refs/no_html_parse/synopsis
rev 1.5, prev_rev 1.4
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/no_html_parse/synopsis,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- synopsis 22 Sep 2004 21:13:07 -0000 1.4
+++ synopsis 24 Sep 2004 21:01:02 -0000 1.5
@@ -1,6 +1,4 @@
-<cmdsynopsis>
<group choice='req'>
<arg choice='plain'>0</arg>
<arg choice='plain'>1</arg>
</group>
-</cmdsynopsis>
1.5 +0 -2 xmldocs/refs/no_image_rewrite/synopsis
rev 1.5, prev_rev 1.4
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/no_image_rewrite/synopsis,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- synopsis 22 Sep 2004 21:13:07 -0000 1.4
+++ synopsis 24 Sep 2004 21:01:02 -0000 1.5
@@ -1,6 +1,4 @@
-<cmdsynopsis>
<group choice='req'>
<arg choice='plain'>0</arg>
<arg choice='plain'>1</arg>
</group>
-</cmdsynopsis>
1.4 +0 -2 xmldocs/refs/post_page/synopsis
rev 1.4, prev_rev 1.3
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/post_page/synopsis,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- synopsis 22 Sep 2004 21:13:07 -0000 1.3
+++ synopsis 24 Sep 2004 21:01:02 -0000 1.4
@@ -1,3 +1 @@
-<cmdsynopsis>
<arg choice='req'><replaceable>subroutine name</replaceable></arg>
-</cmdsynopsis>
1.4 +0 -2 xmldocs/refs/pre_page/synopsis
rev 1.4, prev_rev 1.3
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/pre_page/synopsis,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- synopsis 22 Sep 2004 21:13:07 -0000 1.3
+++ synopsis 24 Sep 2004 21:01:02 -0000 1.4
@@ -1,3 +1 @@
-<cmdsynopsis>
<arg choice='req'><replaceable>subroutine name</replaceable></arg>
-</cmdsynopsis>
1.5 +0 -2 xmldocs/refs/safe_data/synopsis
rev 1.5, prev_rev 1.4
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/safe_data/synopsis,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- synopsis 22 Sep 2004 21:13:08 -0000 1.4
+++ synopsis 24 Sep 2004 21:01:02 -0000 1.5
@@ -1,6 +1,4 @@
-<cmdsynopsis>
<group choice='req'>
<arg choice='plain'>0</arg>
<arg choice='plain'>1</arg>
</group>
-</cmdsynopsis>
1.5 +0 -2 xmldocs/refs/strip_white/synopsis
rev 1.5, prev_rev 1.4
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/strip_white/synopsis,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- synopsis 22 Sep 2004 21:13:08 -0000 1.4
+++ synopsis 24 Sep 2004 21:01:02 -0000 1.5
@@ -1,6 +1,4 @@
-<cmdsynopsis>
<group choice='req'>
<arg choice='plain'>0</arg>
<arg choice='plain'>1</arg>
</group>
-</cmdsynopsis>
1.5 +0 -2 xmldocs/refs/substitute_table_image/synopsis
rev 1.5, prev_rev 1.4
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/substitute_table_image/synopsis,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- synopsis 22 Sep 2004 21:13:08 -0000 1.4
+++ synopsis 24 Sep 2004 21:01:02 -0000 1.5
@@ -1,6 +1,4 @@
-<cmdsynopsis>
<group choice='req'>
<arg choice='plain'>0</arg>
<arg choice='plain'>1</arg>
</group>
-</cmdsynopsis>
More information about the docs
mailing list