[docs] xmldocs - docelic modified 15 files

docs at icdevgroup.org docs at icdevgroup.org
Tue Dec 14 14:15:44 EST 2004


User:      docelic
Date:      2004-12-14 19:15:44 GMT
Modified:  refs     SessionType Suggest ValuesDefault VariableDatabase
Modified:           VendURL WideOpen banner bar-button button
Modified:           capture_page cart cgi.tag crypt.tag formel
Modified:           no_html_comment_embed
Log:
Fix the rest of items to adhere to new syntax in Example sections

Revision  Changes    Path
1.2       +2 -7      xmldocs/refs/SessionType


rev 1.2, prev_rev 1.1
Index: SessionType
===================================================================
RCS file: /var/cvs/xmldocs/refs/SessionType,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- SessionType	5 Dec 2004 23:11:51 -0000	1.1
+++ SessionType	14 Dec 2004 19:15:43 -0000	1.2
@@ -36,15 +36,10 @@
 reliability in most environments.
 __END__
 
-__NAME__ example
-<example>
-  <title>Setting SessionType</title>
-	<para>
-	Put the following in &ccf;:
-	</para>
+__NAME__ example: Setting SessionType
+Put the following in &ccf;:
 <programlisting>
 SessionExpire  session-data.lock
 </programlisting>
-</example>
 __END__
 



1.2       +2 -5      xmldocs/refs/Suggest


rev 1.2, prev_rev 1.1
Index: Suggest
===================================================================
RCS file: /var/cvs/xmldocs/refs/Suggest,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- Suggest	30 Nov 2004 22:46:22 -0000	1.1
+++ Suggest	14 Dec 2004 19:15:43 -0000	1.2
@@ -27,15 +27,12 @@
 warning message is shown.
 __END__
 
-__NAME__ example
-<example>
-  <title>Testing for features</title>
-<programlisting>
+__NAME__ example: Testing for features
+<pogramlisting>
 Suggest module    Archive::Zip
 Suggest usertag   table_editor
 Suggest globalsub file_info
 Suggest module    Business::UPS
 </programlisting>
-</example>
 __END__
 



1.2       +3 -12     xmldocs/refs/ValuesDefault


rev 1.2, prev_rev 1.1
Index: ValuesDefault
===================================================================
RCS file: /var/cvs/xmldocs/refs/ValuesDefault,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ValuesDefault	30 Nov 2004 22:46:22 -0000	1.1
+++ ValuesDefault	14 Dec 2004 19:15:43 -0000	1.2
@@ -21,27 +21,18 @@
 of his preferences for the current session), the defaults will be used.
 __END__
 
-__NAME__ example
-<example>
-  <title>Defining default values</title>
-	<para>
-	Put the following in &ccf;:
-	</para>
+__NAME__ example: Defining default values
+Put the following in &ccf;:
 <programlisting>
 ValuesDefault fname New lname User
 ValuesDefault country HR
 </programlisting>
-	<para>
-	Create a test page:
-	</para>
+Create a test page:
 <programlisting><![CDATA[
 Welcome!<br/>
 Your first name is: [value fname]<br/>
 Your last name is: [value lname]<br/>
 Your country code is: [value country]
 ]]></programlisting>
-<para>
-</para>
-</example>
 __END__
 



1.3       +4 -15     xmldocs/refs/VariableDatabase


rev 1.3, prev_rev 1.2
Index: VariableDatabase
===================================================================
RCS file: /var/cvs/xmldocs/refs/VariableDatabase,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- VariableDatabase	30 Nov 2004 22:46:22 -0000	1.2
+++ VariableDatabase	14 Dec 2004 19:15:43 -0000	1.3
@@ -40,34 +40,23 @@
 __END__
 
 
-__NAME__ example
-<example>
-  <title>Enabling VariableDatabase</title>
-	<para>
-	Save the following as <filename>products/variables.txt</filename>:
-	</para>
+__NAME__ example: Enabling VariableDatabase
+Save the following as <filename>products/variables.txt</filename>:
 <programlisting>
 code	Variable
 HELLO	Hi
 ANON	Guest
 </programlisting>
-	<para>
-	Put the following lines in &ccf;:
-	</para>
+Put the following lines in &ccf;:
 <programlisting>
 Database  variables variables.txt TAB
 VariableDatabase variables
 </programlisting>
-	<para>
-	Create a test page:
-	</para>
+Create a test page:
 <programlisting><![CDATA[
 [tmp user][either][data session username][or]__ANON__[/either][/tmp]
 
 __HELLO__, [scratch user]!
 ]]></programlisting>
-<para>
-</para>
-</example>
 __END__
 



1.2       +2 -7      xmldocs/refs/VendURL


rev 1.2, prev_rev 1.1
Index: VendURL
===================================================================
RCS file: /var/cvs/xmldocs/refs/VendURL,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- VendURL	29 Nov 2004 19:51:09 -0000	1.1
+++ VendURL	14 Dec 2004 19:15:43 -0000	1.2
@@ -29,15 +29,10 @@
 __END__
 
 
-__NAME__ example
-<example>
-  <title>Setting VendURL</title>
-	<para>
-	Put the following lines in &ccf;:
-	</para>
+__NAME__ example: Setting VendURL
+Put the following lines in &ccf;:
 <programlisting>
 VendURL http://&def-hostname;/cgi-bin/ic/tutorial
 </programlisting>
-</example>
 __END__
 



1.2       +2 -7      xmldocs/refs/WideOpen


rev 1.2, prev_rev 1.1
Index: WideOpen
===================================================================
RCS file: /var/cvs/xmldocs/refs/WideOpen,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- WideOpen	29 Nov 2004 19:51:09 -0000	1.1
+++ WideOpen	14 Dec 2004 19:15:43 -0000	1.2
@@ -32,16 +32,11 @@
 __END__
 
 
-__NAME__ example
-<example>
-  <title>Enabling WideOpen directive</title>
-	<para>
-	Put any of the following lines in &ccf;:
-	</para>
+__NAME__ example: Enabling WideOpen directive
+Put any of the following lines in &ccf;:
 <programlisting>
 WideOpen 1
 WideOpen Yes
 </programlisting>
-</example>
 __END__
 



1.7       +4 -11     xmldocs/refs/banner


rev 1.7, prev_rev 1.6
Index: banner
===================================================================
RCS file: /var/cvs/xmldocs/refs/banner,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- banner	22 Nov 2004 00:18:43 -0000	1.6
+++ banner	14 Dec 2004 19:15:43 -0000	1.7
@@ -171,16 +171,9 @@
 __END__
 
 
-__NAME__ example
-	<example>
-		<title>
-		Banner Ads
-		</title>
-		<para>
-		For the relevant supplemental description and all ready-to-use examples,
-		see the <olink targetdoc='howtos' targetptr='implementbanners'>
-		Implement Banner Ads</olink> HOW-TO.
-		</para>
-	</example>
+__NAME__ example: Banner Ads
+For the relevant supplemental description and all ready-to-use examples,
+see the <olink targetdoc='howtos' targetptr='implementbanners'>
+Implement Banner Ads</olink> HOW-TO.
 __END__
 



1.5       +6 -11     xmldocs/refs/bar-button


rev 1.5, prev_rev 1.4
Index: bar-button
===================================================================
RCS file: /var/cvs/xmldocs/refs/bar-button,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- bar-button	28 Oct 2004 10:29:14 -0000	1.4
+++ bar-button	14 Dec 2004 19:15:43 -0000	1.5
@@ -43,16 +43,12 @@
 __END__
 
 
-__NAME__ example
-<example>
-	<title>Create 3-button menubar</title>
-	<para>
-	Create three different pages,
-	<filename>page1.html</filename>,
-	<filename>page2.html</filename> and
-	<filename>page3.html</filename>, each with the identical content:
-	</para>
-	<programlisting><![CDATA[
+__NAME__ example: Create 3-button menubar
+Create three different pages,
+<filename>page1.html</filename>,
+<filename>page2.html</filename> and
+<filename>page3.html</filename>, each with the identical content:
+<programlisting><![CDATA[
 <table><tr>
 
 [bar-button page=page1]
@@ -78,6 +74,5 @@
 
 </tr></table>
 ]]></programlisting>
-</example>
 __END__
 



1.9       +14 -27    xmldocs/refs/button


rev 1.9, prev_rev 1.8
Index: button
===================================================================
RCS file: /var/cvs/xmldocs/refs/button,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- button	28 Nov 2004 23:04:07 -0000	1.8
+++ button	14 Dec 2004 19:15:43 -0000	1.9
@@ -115,13 +115,9 @@
 See <xref linkend='button_examples'/> for illustrative presentation.
 __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>
+__NAME__ example: Submit button with an image and confirmation window
+Notice the tags used in the button body:
+<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
@@ -131,20 +127,15 @@
   [mvtag] Use any Interchange tag here, i.e. ....[/mvtag]
   [perl] # code to delete item [/perl]
 [/button]
-	</programlisting>
-</example>
+</programlisting>
 __END__
 
-__NAME__ example-inp
-<example>
-	<title>Creating the submit button manually</title>
-	<para>
-	We are here to discuss the usage of the <tag>button</tag> tag, but let's
-	take a look at an 
-	example equivalent to the one above, except that we create the button
-	manually:
-	</para>
-	<programlisting>
+__NAME__ example-inp: Creating the submit button manually
+We are here to discuss the usage of the <tag>button</tag> tag, but let's
+take a look at an 
+example equivalent to the one above, except that we create the button
+manually:
+<programlisting>
 [set Delete item]
   [comment]
     [button] element's body specifies the action code.
@@ -155,18 +146,14 @@
 <![CDATA[
 <input type='submit' name='mv_click' value='Delete item'>
 ]]>
-  </programlisting>
-</example>
+</programlisting>
 __END__
 
-__NAME__ example-js
-<example>
-  <title>Simple button with an embedded custom JavaScript code</title>
-  <programlisting>
+__NAME__ example-js: Simple button with an embedded custom JavaScript code
+ <programlisting>
 [button text="Click me"]
   [javascript]onClick="myOwnOnClickFunction(this);"[/javascript]
 [/button]
-  </programlisting>
-</example>
+</programlisting>
 __END__
 



1.8       +14 -26    xmldocs/refs/capture_page


rev 1.8, prev_rev 1.7
Index: capture_page
===================================================================
RCS file: /var/cvs/xmldocs/refs/capture_page,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- capture_page	9 Nov 2004 23:16:16 -0000	1.7
+++ capture_page	14 Dec 2004 19:15:43 -0000	1.8
@@ -83,39 +83,27 @@
 __END__
 
 
-__NAME__ example
-<example>
-	<title>Basic static page example</title>
-	<para>
-	Create page named <filename>make-static.html</filename> with the following
-	content:
-	</para>
-	<programlisting>
-	[capture-page page=index file=static/index.html umask=022 auto_create_dir=1]
-	</programlisting>
-	<para>
-	This would create the <filename class='directory'>static/</filename>
-	directory in your catalog root, and a snapshot of
-	<filename>index.html</filename> in it.
-	</para>
-</example>
+__NAME__ example: Basic static page example
+Create page named <filename>make-static.html</filename> with the following
+content:
+<programlisting>
+[capture-page page=index file=static/index.html umask=022 auto_create_dir=1]
+</programlisting>
+This would create the <filename class='directory'>static/</filename>
+directory in your catalog root, and a snapshot of
+<filename>index.html</filename> in it.
 __END__
 
-__NAME__ example2
-<example>
-	<title>Static page example using scan=</title>
-	<para>
-	Create page named <filename>make-static2.html</filename> with the following
-	content:
-	</para>
-	<programlisting>
+__NAME__ example2: Static page example using scan=
+Create page named <filename>make-static2.html</filename> with the following
+content:
+<programlisting>
 [loop list="Levels,Rulers,Squares"]
   [capture-page page="[loop-code]" file="static/cats/[loop-code].html"
     scan="fi=products/st=db/co=yes/sf=category/se=[loop-code]"
     auto_create_dir=1]
 [/loop]
-	</programlisting>
-</example>
+</programlisting>
 __END__
 
 __NAME__ author



1.2       +4 -9      xmldocs/refs/cart


rev 1.2, prev_rev 1.1
Index: cart
===================================================================
RCS file: /var/cvs/xmldocs/refs/cart,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- cart	16 Oct 2004 21:53:36 -0000	1.1
+++ cart	14 Dec 2004 19:15:43 -0000	1.2
@@ -34,15 +34,10 @@
 <tag>nitems</tag>).
 __END__
 
-__NAME__ example
-<example>
-  <title>Set new default cart name</title>
-	<para>
-	Place the following on an Interchange page:
-	</para>
-  <programlisting>
+__NAME__ example: Set new default cart name
+Place the following on an Interchange page:
+<programlisting>
 [cart NEW]
-  </programlisting>
-</example>
+</programlisting>
 __END__
 



1.4       +6 -11     xmldocs/refs/cgi.tag


rev 1.4, prev_rev 1.3
Index: cgi.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/cgi.tag,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- cgi.tag	20 Nov 2004 14:40:40 -0000	1.3
+++ cgi.tag	14 Dec 2004 19:15:43 -0000	1.4
@@ -85,20 +85,15 @@
 __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>
+__NAME__ example: Accessing CGI variables
+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.
+<programlisting>
 <![CDATA[
 Value of 'foo': [cgi foo]<br/>
 Value of 'toad': [cgi name=toad]<br/>
 ]]>
-  </programlisting>
-</example>
+</programlisting>
 __END__
 



1.3       +5 -10     xmldocs/refs/crypt.tag


rev 1.3, prev_rev 1.2
Index: crypt.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/crypt.tag,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- crypt.tag	28 Nov 2004 23:04:07 -0000	1.2
+++ crypt.tag	14 Dec 2004 19:15:43 -0000	1.3
@@ -49,14 +49,10 @@
 __END__
 
 
-__NAME__ online
-<example>
-	<title>Crypt a string and verify it</title>
-	<para>
-	Note that this example is of little use in practice, but does show the
-	components you can re-use:
-	</para>
-	<programlisting><![CDATA[
+__NAME__ online: Crypt a string and verify it
+Note that this example is of little use in practice, but does show the
+components you can re-use:
+<programlisting><![CDATA[
 <p>
 [seti salt][perl]join '', ('.', '/', 0..9, 'A'..'Z', 'a'..'z')[rand 64, rand 64][/perl][/seti]
 String "test" crypted with salt "[scratch salt]": [crypt value="test" salt="[scratch salt]"]
@@ -73,7 +69,6 @@
   "Password matches." : "Password does not match."
 [/perl]
 </p>
-	]]></programlisting>
-</example>
+]]></programlisting>
 __END__
 



1.5       +5 -10     xmldocs/refs/formel


rev 1.5, prev_rev 1.4
Index: formel
===================================================================
RCS file: /var/cvs/xmldocs/refs/formel,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- formel	13 Dec 2004 00:04:41 -0000	1.4
+++ formel	14 Dec 2004 19:15:43 -0000	1.5
@@ -162,20 +162,15 @@
 <para>
 __END__
 
-__NAME__ example
-<example>
-	<title>Define tag defaults with form values</title>
-	<programlisting><![CDATA[
+__NAME__ example: Define tag defaults with form values
+<programlisting><![CDATA[
 [value name="mv_formel_cause"  set=" (<I>%s</I>)" hide=1]
 [value name="mv_formel_format" set="<tr><td>%s</td><td>%s</td></tr>" hide=1]
 [value name="mv_formel_order"  set=1 hide=1]
 [value name="mv_formel_signal" set="<blink>%s</blink>" hide=1]
-	]]></programlisting>
-	<para>
-	Note that the values, once you set them, remain persistant during the
-	user's session.
-	</para>
-</example>
+]]></programlisting>
+Note that the values, once you set them, remain persistant during the
+user's session.
 __END__
 
 __NAME__ example2: Displaying the label and form element in two passes



1.6       +4 -9      xmldocs/refs/no_html_comment_embed


rev 1.6, prev_rev 1.5
Index: no_html_comment_embed
===================================================================
RCS file: /var/cvs/xmldocs/refs/no_html_comment_embed,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- no_html_comment_embed	20 Nov 2004 14:40:40 -0000	1.5
+++ no_html_comment_embed	14 Dec 2004 19:15:43 -0000	1.6
@@ -47,16 +47,11 @@
 __END__
 
 
-__NAME__ example
-<example>
-	<title>Enable no_html_comment_embded pragma page-wide</title>
-	<para>
-	Put the following anywhere on your page:
-	</para>
-	<programlisting>
+__NAME__ example: Enable no_html_comment_embded pragma page-wide
+Put the following anywhere on your page:
+<programlisting>
 [pragma no_html_comment_embed]
-	</programlisting>
-</example>
+</programlisting>
 __END__
 
 








More information about the docs mailing list