[docs] xmldocs - docelic modified 25 files

docs at icdevgroup.org docs at icdevgroup.org
Thu Sep 2 15:15:19 EDT 2004 

User:      docelic
Date:      2004-09-02 19:15:18 GMT
Modified:  docbook/item-skel synopsis
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 description 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
Log:
- Use <cmdsynopsis> instead of plain <synopsis> and adjust
  all synopsis line appropriately

Revision  Changes    Path
1.4       +3 -12     xmldocs/docbook/item-skel/synopsis


rev 1.4, prev_rev 1.3
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/docbook/item-skel/synopsis,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- synopsis	13 Aug 2004 21:09:16 -0000	1.3
+++ synopsis	2 Sep 2004 19:15:16 -0000	1.4
@@ -1,13 +1,4 @@
-<!-- Synopsis is a CDATA block (it's <pre>formatted), so you're pretty
-     much free to construct the synopsis any way you want. Try to keep it
-     along the lines of (if not describing Tags for which this scheme is
-     not usable): 
-
-      literal - literal text
-      <text>  - mandatory value
-      [text]  - optional text
-
-     Where applicable, show syntax in a way which is opposite of the
+<!-- Where applicable, show syntax in a way which is opposite of the
      default value.
 
      Describe various options inside 'description' file, not here.
@@ -16,5 +7,5 @@
      ** If you're documenting a TAG, leave this file completely empty,
         syntax line for tags is autogenerated **                     -->
 
-<synopsis><![CDATA[
-]]></synopsis>
+<cmdsynopsis>
+</cmdsynopsis>



1.2       +7 -3      xmldocs/refs/CGIWRAP_WORKAROUND/synopsis


rev 1.2, prev_rev 1.1
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/CGIWRAP_WORKAROUND/synopsis,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- synopsis	28 Jul 2004 15:35:31 -0000	1.1
+++ synopsis	2 Sep 2004 19:15:16 -0000	1.2
@@ -1,3 +1,7 @@
-<synopsis><![CDATA[
-Variable CGIWRAP_WORKAROUND <0|1>
-]]></synopsis>
+<cmdsynopsis>
+Variable CGIWRAP_WORKAROUND
+  <group choice='req'>
+    <arg choice='plain'>0</arg>
+    <arg choice='plain'>1</arg>
+  </group>
+</cmdsynopsis>



1.2       +7 -3      xmldocs/refs/MV_BAD_LOCK/synopsis


rev 1.2, prev_rev 1.1
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_BAD_LOCK/synopsis,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- synopsis	28 Jul 2004 15:35:31 -0000	1.1
+++ synopsis	2 Sep 2004 19:15:16 -0000	1.2
@@ -1,3 +1,7 @@
-<synopsis><![CDATA[
-Variable MV_BAD_LOCK <0|1>
-]]></synopsis>
+<cmdsynopsis>
+Variable MV_BAD_LOCK
+  <group choice='req'>
+    <arg choice='plain'>0</arg>
+    <arg choice='plain'>1</arg>
+  </group>
+</cmdsynopsis>



1.4       +8 -3      xmldocs/refs/MV_DOLLAR_ZERO/synopsis


rev 1.4, prev_rev 1.3
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_DOLLAR_ZERO/synopsis,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- synopsis	24 Aug 2004 18:26:43 -0000	1.3
+++ synopsis	2 Sep 2004 19:15:17 -0000	1.4
@@ -1,3 +1,8 @@
-<synopsis><![CDATA[
-Variable MV_DOLLAR_ZERO <0|1|any string>
-]]></synopsis>
+<cmdsynopsis>
+Variable MV_DOLLAR_ZERO
+  <group choice='req'>
+    <arg choice='plain'>0</arg>
+    <arg choice='plain'>1</arg>
+    <arg choice='plain'><replaceable>string</replaceable></arg>
+  </group>
+</cmdsynopsis>



1.2       +2 -2      xmldocs/refs/MV_FILE/synopsis


rev 1.2, prev_rev 1.1
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_FILE/synopsis,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- synopsis	28 Jul 2004 15:35:31 -0000	1.1
+++ synopsis	2 Sep 2004 19:15:17 -0000	1.2
@@ -1,3 +1,3 @@
-<synopsis><![CDATA[
+<cmdsynopsis>
 @@MV_FILE@@
-]]></synopsis>
+</cmdsynopsis>



1.2       +7 -3      xmldocs/refs/MV_GETPPID_BROKEN/synopsis


rev 1.2, prev_rev 1.1
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_GETPPID_BROKEN/synopsis,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- synopsis	28 Jul 2004 15:35:31 -0000	1.1
+++ synopsis	2 Sep 2004 19:15:17 -0000	1.2
@@ -1,3 +1,7 @@
-<synopsis><![CDATA[
-Variable MV_GETPPID_BROKEN <0|1>
-]]></synopsis>
+<cmdsynopsis>
+Variable MV_GETPPID_BROKEN
+  <group choice='req'>
+    <arg choice='plain'>0</arg>
+    <arg choice='plain'>1</arg>
+  </group>
+</cmdsynopsis>



1.3       +4 -3      xmldocs/refs/MV_HELO/synopsis


rev 1.3, prev_rev 1.2
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_HELO/synopsis,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- synopsis	8 Aug 2004 20:05:23 -0000	1.2
+++ synopsis	2 Sep 2004 19:15:17 -0000	1.3
@@ -1,3 +1,4 @@
-<synopsis><![CDATA[
-Variable MV_HELO <host name>
-]]></synopsis>
+<cmdsynopsis>
+Variable MV_HELO
+  <arg choice='req'><replaceable>host name</replaceable></arg>
+</cmdsynopsis>



1.2       +7 -3      xmldocs/refs/MV_HTML4_COMPLIANT/synopsis


rev 1.2, prev_rev 1.1
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_HTML4_COMPLIANT/synopsis,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- synopsis	28 Jul 2004 20:53:39 -0000	1.1
+++ synopsis	2 Sep 2004 19:15:17 -0000	1.2
@@ -1,3 +1,7 @@
-<synopsis><![CDATA[
-Variable MV_HTML4_COMPLIANT <0|1>
-]]></synopsis>
+<cmdsynopsis>
+Variable MV_HTML4_COMPLIANT
+  <group choice='req'>
+    <arg choice='plain'>0</arg>
+    <arg choice='plain'>1</arg>
+  </group>
+</cmdsynopsis>



1.3       +4 -3      xmldocs/refs/MV_MAILFROM/synopsis


rev 1.3, prev_rev 1.2
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_MAILFROM/synopsis,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- synopsis	8 Aug 2004 20:05:23 -0000	1.2
+++ synopsis	2 Sep 2004 19:15:17 -0000	1.3
@@ -1,3 +1,4 @@
-<synopsis><![CDATA[
-Variable MV_MAILFROM <user name>
-]]></synopsis>
+<cmdsynopsis>
+Variable MV_MAILFROM
+  <arg choice='req'>user name</arg>
+</cmdsynopsis>



1.2       +7 -3      xmldocs/refs/MV_NO_CRYPT/synopsis


rev 1.2, prev_rev 1.1
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_NO_CRYPT/synopsis,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- synopsis	28 Jul 2004 20:53:39 -0000	1.1
+++ synopsis	2 Sep 2004 19:15:17 -0000	1.2
@@ -1,3 +1,7 @@
-<synopsis><![CDATA[
-Variable MV_NO_CRYPT <0|1>
-]]></synopsis>
+<cmdsynopsis>
+Variable MV_NO_CRYPT
+  <group choice='req'>
+    <arg choice='plain'>0</arg>
+    <arg choice='plain'>1</arg>
+  </group>
+</cmdsynopsis>



1.2       +2 -2      xmldocs/refs/MV_PAGE/synopsis


rev 1.2, prev_rev 1.1
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_PAGE/synopsis,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- synopsis	28 Jul 2004 20:53:39 -0000	1.1
+++ synopsis	2 Sep 2004 19:15:17 -0000	1.2
@@ -1,3 +1,3 @@
-<synopsis><![CDATA[
+<cmdsynopsis>
 @@MV_PAGE@@
-]]></synopsis>
+</cmdsynopsis>



1.2       +2 -2      xmldocs/refs/MV_PREV_PAGE/synopsis


rev 1.2, prev_rev 1.1
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_PREV_PAGE/synopsis,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- synopsis	28 Jul 2004 20:53:39 -0000	1.1
+++ synopsis	2 Sep 2004 19:15:17 -0000	1.2
@@ -1,3 +1,3 @@
-<synopsis><![CDATA[
+<cmdsynopsis>
 @@MV_PREV_PAGE@@
-]]></synopsis>
+</cmdsynopsis>



1.3       +4 -3      xmldocs/refs/MV_SESSION_READ_RETRY/synopsis


rev 1.3, prev_rev 1.2
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_SESSION_READ_RETRY/synopsis,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- synopsis	8 Aug 2004 20:05:24 -0000	1.2
+++ synopsis	2 Sep 2004 19:15:17 -0000	1.3
@@ -1,3 +1,4 @@
-<synopsis><![CDATA[
-Variable MV_SESSION_READ_RETRY <count>
-]]></synopsis>
+<cmdsynopsis>
+Variable MV_SESSION_READ_RETRY
+  <arg choice='req'><replaceable>count</replaceable></arg>
+</cmdsynopsis>



1.3       +4 -3      xmldocs/refs/MV_SMTPHOST/synopsis


rev 1.3, prev_rev 1.2
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_SMTPHOST/synopsis,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- synopsis	8 Aug 2004 20:05:24 -0000	1.2
+++ synopsis	2 Sep 2004 19:15:17 -0000	1.3
@@ -1,3 +1,4 @@
-<synopsis><![CDATA[
-Variable MV_SMTPHOST <host name>
-]]></synopsis>
+<cmdsynopsis>
+Variable MV_SMTPHOST
+  <arg choice='req'>host name</arg>
+</cmdsynopsis>



1.2       +1 -1      xmldocs/refs/MV_SUBJECT/description


rev 1.2, prev_rev 1.1
Index: description
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_SUBJECT/description,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- description	29 Aug 2004 20:55:38 -0000	1.1
+++ description	2 Sep 2004 19:15:18 -0000	1.2
@@ -1,3 +1,3 @@
 The global variable <varname>MV_SUBJECT</varname>, set before interpolating
 any special page, is a more secure alternative to the
-<tagname>subject</tagname> pseudo-tag.
+<tag>subject</tag> pseudo-tag.



1.2       +2 -2      xmldocs/refs/MV_SUBJECT/synopsis


rev 1.2, prev_rev 1.1
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_SUBJECT/synopsis,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- synopsis	28 Jul 2004 20:53:40 -0000	1.1
+++ synopsis	2 Sep 2004 19:15:18 -0000	1.2
@@ -1,3 +1,3 @@
-<synopsis><![CDATA[
+<cmdsynopsis>
 @@MV_SUBJECT@@
-]]></synopsis>
+</cmdsynopsis>



1.2       +18 -3     xmldocs/refs/area/synopsis


rev 1.2, prev_rev 1.1
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/area/synopsis,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- synopsis	31 Aug 2004 14:58:36 -0000	1.1
+++ synopsis	2 Sep 2004 19:15:18 -0000	1.2
@@ -1,3 +1,18 @@
-<synopsis>
-[area href=<replaceable>page</replaceable> arg=<replaceable>argument</replaceable>]
-</synopsis>
+<cmdsynopsis>
+area
+  <arg choice='plain'>
+    href='<replaceable>path</replaceable>'
+  </arg>
+  <arg choice='opt'>
+    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>



1.2       +4 -3      xmldocs/refs/init_page/synopsis


rev 1.2, prev_rev 1.1
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/init_page/synopsis,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- synopsis	21 Jul 2004 20:24:52 -0000	1.1
+++ synopsis	2 Sep 2004 19:15:18 -0000	1.2
@@ -1,3 +1,4 @@
-<synopsis><![CDATA[
-Pragma init_page=<subroutine name>
-]]></synopsis>
+<cmdsynopsis>
+Pragma init_page=
+  <arg choice='req'><replaceable>subroutine name</replaceable></arg>
+</cmdsynopsis>



1.3       +7 -3      xmldocs/refs/no_html_parse/synopsis


rev 1.3, prev_rev 1.2
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/no_html_parse/synopsis,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- synopsis	24 Aug 2004 18:26:44 -0000	1.2
+++ synopsis	2 Sep 2004 19:15:18 -0000	1.3
@@ -1,3 +1,7 @@
-<synopsis><![CDATA[
-Pragma no_html_parse <0|1>
-]]></synopsis>
+<cmdsynopsis>
+Pragma no_html_parse
+  <group choice='req'>
+    <arg choice='plain'>0</arg>
+    <arg choice='plain'>1</arg>
+  </group>
+</cmdsynopsis>



1.3       +7 -3      xmldocs/refs/no_image_rewrite/synopsis


rev 1.3, prev_rev 1.2
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/no_image_rewrite/synopsis,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- synopsis	24 Aug 2004 18:26:44 -0000	1.2
+++ synopsis	2 Sep 2004 19:15:18 -0000	1.3
@@ -1,3 +1,7 @@
-<synopsis><![CDATA[
-Pragma no_image_rewrite <0|1>
-]]></synopsis>
+<cmdsynopsis>
+Pragma no_image_rewrite
+  <group choice='req'>
+    <arg choice='plain'>0</arg>
+    <arg choice='plain'>1</arg>
+  </group>
+</cmdsynopsis>



1.2       +4 -3      xmldocs/refs/post_page/synopsis


rev 1.2, prev_rev 1.1
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/post_page/synopsis,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- synopsis	21 Jul 2004 20:55:52 -0000	1.1
+++ synopsis	2 Sep 2004 19:15:18 -0000	1.2
@@ -1,3 +1,4 @@
-<synopsis><![CDATA[
-Pragma post_page=<subroutine name>
-]]></synopsis>
+<cmdsynopsis>
+Pragma post_page=
+  <arg choice='req'><replaceable>subroutine name</replaceable></arg>
+</cmdsynopsis>



1.2       +4 -3      xmldocs/refs/pre_page/synopsis


rev 1.2, prev_rev 1.1
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/pre_page/synopsis,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- synopsis	21 Jul 2004 20:24:52 -0000	1.1
+++ synopsis	2 Sep 2004 19:15:18 -0000	1.2
@@ -1,3 +1,4 @@
-<synopsis><![CDATA[
-Pragma pre_page=<subroutine name>
-]]></synopsis>
+<cmdsynopsis>
+Pragma pre_page=
+  <arg choice='req'><replaceable>subroutine name</replaceable></arg>
+</cmdsynopsis>



1.3       +7 -3      xmldocs/refs/safe_data/synopsis


rev 1.3, prev_rev 1.2
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/safe_data/synopsis,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- synopsis	24 Aug 2004 18:26:45 -0000	1.2
+++ synopsis	2 Sep 2004 19:15:18 -0000	1.3
@@ -1,3 +1,7 @@
-<synopsis><![CDATA[
-Pragma safe_data <0|1>
-]]></synopsis>
+<cmdsynopsis>
+Pragma safe_data
+  <group choice='req'>
+    <arg choice='plain'>0</arg>
+    <arg choice='plain'>1</arg>
+  </group>
+</cmdsynopsis>



1.3       +7 -3      xmldocs/refs/strip_white/synopsis


rev 1.3, prev_rev 1.2
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/strip_white/synopsis,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- synopsis	24 Aug 2004 18:26:45 -0000	1.2
+++ synopsis	2 Sep 2004 19:15:18 -0000	1.3
@@ -1,3 +1,7 @@
-<synopsis><![CDATA[
-Pragma strip_white <0|1>
-]]></synopsis>
+<cmdsynopsis>
+Pragma strip_white
+  <group choice='req'>
+    <arg choice='plain'>0</arg>
+    <arg choice='plain'>1</arg>
+  </group>
+</cmdsynopsis>



1.3       +7 -3      xmldocs/refs/substitute_table_image/synopsis


rev 1.3, prev_rev 1.2
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/substitute_table_image/synopsis,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- synopsis	24 Aug 2004 18:26:45 -0000	1.2
+++ synopsis	2 Sep 2004 19:15:18 -0000	1.3
@@ -1,3 +1,7 @@
-<synopsis><![CDATA[
-Pragma substitute_table_image <0|1>
-]]></synopsis>
+<cmdsynopsis>
+Pragma substitute_table_image
+  <group choice='req'>
+    <arg choice='plain'>0</arg>
+    <arg choice='plain'>1</arg>
+  </group>
+</cmdsynopsis>

More information about the docs mailing list