[docs] xmldocs - docelic modified 21 files
docs at icdevgroup.org
docs at icdevgroup.org
Sun Dec 12 19:04:42 EST 2004
User: docelic
Date: 2004-12-13 00:04:42 GMT
Modified: refs SocketPerms css delete_cart download
Modified: dynamic_variables dynamic_variables_file_only email
Modified: email-raw formel fortune get-url history-scan image
Modified: jsq jsqn load_cart no_locale_parse rand save_cart
Modified: values-space var
Log:
- Fixed example sections of those items to adhere to new, lightweight
example syntax.
Strange, but I thought I already did this? Maybe I didn't check-in...
Revision Changes Path
1.3 +3 -6 xmldocs/refs/SocketPerms
rev 1.3, prev_rev 1.2
Index: SocketPerms
===================================================================
RCS file: /var/cvs/xmldocs/refs/SocketPerms,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- SocketPerms 9 Nov 2004 23:16:16 -0000 1.2
+++ SocketPerms 13 Dec 2004 00:04:41 -0000 1.3
@@ -27,12 +27,9 @@
__END__
-__NAME__ example
-<example>
- <title></title>
- <programlisting>
+__NAME__ example: Setting SocketPerms
+<programlisting>
SocketPerms 0666
- </programlisting>
-</example>
+</programlisting>
__END__
1.10 +10 -20 xmldocs/refs/css
rev 1.10, prev_rev 1.9
Index: css
===================================================================
RCS file: /var/cvs/xmldocs/refs/css,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- css 25 Nov 2004 15:30:04 -0000 1.9
+++ css 13 Dec 2004 00:04:41 -0000 1.10
@@ -126,29 +126,20 @@
__END__
-__NAME__ example
-<example>
- <title>Simplest tag example</title>
- <programlisting>
+__NAME__ example: Simplest tag example
+<programlisting>
[css THEME_CSS]
</programlisting>
- <para>
- In the example above, the <tag>css</tag> will look for the
- <filename>images/theme_css.css</filename>, and generate a HTML link to it
- (<link rel="stylesheet" href="/images/theme_css.css">).
- </para>
-</example>
+In the example above, the <tag>css</tag> will look for the
+<filename>images/theme_css.css</filename>, and generate a HTML link to it
+(<link rel="stylesheet" href="/images/theme_css.css">).
__END__
-__NAME__ example2
-<example>
- <title>Using literal</title>
- <para>
- You can either save your CSS in a &glos-scratch;
- variable, or provide it
- directly in-place. Here are both variants:
- </para>
- <programlisting>
+__NAME__ example2: Using literal
+You can either save your CSS in a &glos-scratch;
+variable, or provide it
+directly in-place. Here are both variants:
+<programlisting>
[set my_css]
.title { background-color: #336699; }
[/set]
@@ -156,7 +147,6 @@
[css name="test_css1" literal="[scratch my_css]"]
[css name="test_css2" literal="body { background-color: yellow; }"]
</programlisting>
-</example>
__END__
__NAME__ author
1.8 +3 -8 xmldocs/refs/delete_cart
rev 1.8, prev_rev 1.7
Index: delete_cart
===================================================================
RCS file: /var/cvs/xmldocs/refs/delete_cart,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- delete_cart 4 Dec 2004 22:47:23 -0000 1.7
+++ delete_cart 13 Dec 2004 00:04:41 -0000 1.8
@@ -29,18 +29,13 @@
__END__
-__NAME__ example
-<example>
- <title>Delete cart "test"</title>
- <para>
- Put the following on your page:
- </para>
- <programlisting>
+__NAME__ example: Delete cart "test"
+Put the following on your page:
+<programlisting>
[seti cartname]test[/seti]
[delete_cart nickname="[scratch cartname]"]
</programlisting>
-</example>
__END__
1.7 +4 -9 xmldocs/refs/download
rev 1.7, prev_rev 1.6
Index: download
===================================================================
RCS file: /var/cvs/xmldocs/refs/download,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- download 4 Dec 2004 22:47:23 -0000 1.6
+++ download 13 Dec 2004 00:04:41 -0000 1.7
@@ -34,15 +34,10 @@
__END__
-__NAME__ example
-<example>
- <title>Disable download pragma on a page</title>
- <para>
- Put the following anywhere on your specific page:
- </para>
- <programlisting>
+__NAME__ example: Disable download pragma on a page
+Put the following anywhere on your specific page:
+<programlisting>
[pragma download 0]
- </programlisting>
-</example>
+</programlisting>
__END__
1.4 +4 -9 xmldocs/refs/dynamic_variables
rev 1.4, prev_rev 1.3
Index: dynamic_variables
===================================================================
RCS file: /var/cvs/xmldocs/refs/dynamic_variables,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- dynamic_variables 9 Nov 2004 23:16:16 -0000 1.3
+++ dynamic_variables 13 Dec 2004 00:04:41 -0000 1.4
@@ -26,16 +26,11 @@
__END__
-__NAME__ example
-<example>
- <title>Enable dynamic_variables pragma catalog-wide</title>
- <para>
- Put the following in your <filename>catalog.cfg</filename>:
- </para>
- <programlisting>
+__NAME__ example: Enable dynamic_variables pragma catalog-wide
+Put the following in your <filename>catalog.cfg</filename>:
+<programlisting>
Pragma dynamic_variables
- </programlisting>
-</example>
+</programlisting>
__END__
1.3 +4 -9 xmldocs/refs/dynamic_variables_file_only
rev 1.3, prev_rev 1.2
Index: dynamic_variables_file_only
===================================================================
RCS file: /var/cvs/xmldocs/refs/dynamic_variables_file_only,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- dynamic_variables_file_only 6 Oct 2004 20:50:16 -0000 1.2
+++ dynamic_variables_file_only 13 Dec 2004 00:04:41 -0000 1.3
@@ -28,16 +28,11 @@
__END__
-__NAME__ example
-<example>
- <title>Enable dynamic_variables_file_only pragma catalog-wide</title>
- <para>
- Put the following in your <filename>catalog.cfg</filename>:
- </para>
- <programlisting>
+__NAME__ example: Enable dynamic_variables_file_only pragma catalog-wide
+Put the following in your <filename>catalog.cfg</filename>:
+<programlisting>
Pragma dynamic_variables_file_only
- </programlisting>
-</example>
+</programlisting>
__END__
1.4 +4 -9 xmldocs/refs/email
rev 1.4, prev_rev 1.3
Index: email
===================================================================
RCS file: /var/cvs/xmldocs/refs/email,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- email 16 Oct 2004 18:23:26 -0000 1.3
+++ email 13 Dec 2004 00:04:41 -0000 1.4
@@ -65,20 +65,15 @@
__END__
-__NAME__ example
-<example>
- <title>Simple e-mail message</title>
- <para>
- Put the following on a test page:
- </para>
- <programlisting>
+__NAME__ example: Simple e-mail message
+Put the following on a test page:
+<programlisting>
[email
to="root at mydomain.local"
subject="Greetings"
]
Hello, World!
[/email]
- </programlisting>
-</example>
+</programlisting>
__END__
1.3 +4 -11 xmldocs/refs/email-raw
rev 1.3, prev_rev 1.2
Index: email-raw
===================================================================
RCS file: /var/cvs/xmldocs/refs/email-raw,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- email-raw 16 Oct 2004 13:23:10 -0000 1.2
+++ email-raw 13 Dec 2004 00:04:41 -0000 1.3
@@ -24,13 +24,9 @@
__END__
-__NAME__ example
-<example>
- <title>Simple raw e-mail message</title>
- <para>
- Put the following on a test page:
- </para>
- <programlisting>
+__NAME__ example: Simple raw e-mail message
+Put the following on a test page:
+<programlisting>
[email-raw]
From: test at localhost
To: root at localhost
@@ -49,12 +45,9 @@
BUSINESS DEMANDS AND HOPE YOU WILL NOT BETRAY THE TRUST AND CONFIDENCE WHICH
WE REPOSE IN YOU.
[/email-raw]
- </programlisting>
- <para>
+</programlisting>
We hope you will recognize an attempt at humor in the example above, and
won't use it as an idea for
<ulink url="http://spam.abuse.net/">spamming</ulink> activities.
- </para>
-</example>
__END__
1.4 +6 -11 xmldocs/refs/formel
rev 1.4, prev_rev 1.3
Index: formel
===================================================================
RCS file: /var/cvs/xmldocs/refs/formel,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- formel 28 Oct 2004 10:29:14 -0000 1.3
+++ formel 13 Dec 2004 00:04:41 -0000 1.4
@@ -178,19 +178,14 @@
</example>
__END__
-__NAME__ example2
-<example>
- <title>Displaying the label and form element in two passes</title>
- <para>
- If you had specific requirements, you could,
- by using a little trickery, display the form element label and the
- element itself in two passes:
- </para>
- <programlisting>
+__NAME__ example2: Displaying the label and form element in two passes
+If you had specific requirements, you could,
+by using a little trickery, display the form element label and the
+element itself in two passes:
+<programlisting>
[formel label=Username: name=login format="%s"]
[formel name=login order=1 format="%s"]
- </programlisting>
-</example>
+</programlisting>
__END__
__NAME__ author
1.3 +4 -9 xmldocs/refs/fortune
rev 1.3, prev_rev 1.2
Index: fortune
===================================================================
RCS file: /var/cvs/xmldocs/refs/fortune,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- fortune 6 Oct 2004 20:50:16 -0000 1.2
+++ fortune 13 Dec 2004 00:04:41 -0000 1.3
@@ -68,15 +68,10 @@
__END__
-__NAME__ example
-<example>
- <title>Display short fortune saying</title>
- <para>
- Put the following on your page:
- </para>
- <programlisting>
+__NAME__ example: Display short fortune saying
+Put the following on your page:
+<programlisting>
[fortune 1]
- </programlisting>
-</example>
+</programlisting>
__END__
1.5 +4 -14 xmldocs/refs/get-url
rev 1.5, prev_rev 1.4
Index: get-url
===================================================================
RCS file: /var/cvs/xmldocs/refs/get-url,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- get-url 9 Nov 2004 23:16:16 -0000 1.4
+++ get-url 13 Dec 2004 00:04:41 -0000 1.5
@@ -106,11 +106,7 @@
__NAME__ example
-<example>
- <title></title>
- <para>
- </para>
- <programlisting>
+<programlisting>
[get-url
url="valid_url"
method="POST"
@@ -121,16 +117,11 @@
authpass="password"
useragent="useragent string"
]
- </programlisting>
-</example>
+</programlisting>
__END__
__NAME__ example2
-<example>
- <title></title>
- <para>
- </para>
- <programlisting>
+<programlisting>
[get-url
url="http://www.icdevgroup.org"
method=POST
@@ -140,7 +131,6 @@
boo=The red's the thing.
|
]
- </programlisting>
-</example>
+</programlisting>
__END__
1.7 +7 -17 xmldocs/refs/history-scan
rev 1.7, prev_rev 1.6
Index: history-scan
===================================================================
RCS file: /var/cvs/xmldocs/refs/history-scan,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- history-scan 8 Dec 2004 14:46:33 -0000 1.6
+++ history-scan 13 Dec 2004 00:04:41 -0000 1.7
@@ -124,10 +124,8 @@
__END__
-__NAME__ example
-<example>
- <title>"Continue Shopping" button</title>
- <programlisting>
+__NAME__ example: "Continue Shopping" button
+<programlisting>
[button
text="Continue shopping"
src="__THEME_IMG_DIR__/continueshopping.gif"
@@ -139,21 +137,14 @@
default=index]']
mv_nextpage=nothing
[/button]
- </programlisting>
- <para>
+</programlisting>
This example was provided by Jeff Dafoe.
- </para>
-</example>
__END__
-__NAME__ example2
-<example>
- <title>"Continue" after login</title>
- <para>
- Here's a simple login form that returns the user to the previous page
- after successful login:
- </para>
- <programlisting><![CDATA[
+__NAME__ example2: "Continue" after login
+Here's a simple login form that returns the user to the previous page
+after successful login:
+<programlisting><![CDATA[
<form action="[process secure=1]" method="post">
<input type="hidden" name="mv_todo" value="return>
<input type="hidden" name="mv_click" value="Login">
@@ -167,6 +158,5 @@
<input type="submit" name="submit" value="Log In">
</form>
]]></programlisting>
-</example>
__END__
1.9 +11 -18 xmldocs/refs/image
rev 1.9, prev_rev 1.8
Index: image
===================================================================
RCS file: /var/cvs/xmldocs/refs/image,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- image 4 Dec 2004 21:39:08 -0000 1.8
+++ image 13 Dec 2004 00:04:41 -0000 1.9
@@ -274,29 +274,22 @@
__END__
-__NAME__ example
-<example>
- <title>Simple image</title>
- <para>
- Let's suppose there'a product SKU os29000 present in your
- <database>products</database> database and the
- <database class='field'>image</database> field contains value
- <literal>os29000.png</literal>. Place the <tag>image</tag> on a test
- page:
- </para>
- <programlisting>
+__NAME__ example: Simple image
+Let's suppose there'a product SKU os29000 present in your
+<database>products</database> database and the
+<database class='field'>image</database> field contains value
+<literal>os29000.png</literal>. Place the <tag>image</tag> on a test
+page:
+<programlisting>
[image os29000]
- </programlisting>
- <para>
- The tag would produce something like:
- </para>
- <programlisting><![CDATA[
+</programlisting>
+The tag would produce something like:
+<programlisting><![CDATA[
<img src="/standard/images/os29000.png"
width="120"
height="150"
alt="3' Step Ladder"
title="3' Step Ladder">
- ]]></programlisting>
-</example>
+]]></programlisting>
__END__
1.3 +8 -15 xmldocs/refs/jsq
rev 1.3, prev_rev 1.2
Index: jsq
===================================================================
RCS file: /var/cvs/xmldocs/refs/jsq,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- jsq 9 Oct 2004 11:30:29 -0000 1.2
+++ jsq 13 Dec 2004 00:04:41 -0000 1.3
@@ -19,32 +19,25 @@
<tag>jsquote</tag> is an alias for <tag>jsq</tag>.
__END__
-__NAME__ example
-<example>
- <title>Basic example</title>
- <para>
- Here's an example of JavaScript code and the output it would generate,
- once expanded by Interchange:
- </para>
- <programlisting><![CDATA[
+__NAME__ example: Basic example
+Here's an example of JavaScript code and the output it would generate,
+once expanded by Interchange:
+<programlisting><![CDATA[
<script>
var astring = 'just an insert';
var somevar = [jsq] Big long string you don't
want to have to quote for JS, and you want to
insert the variable $astring.[/jsq];
</script>
- ]]></programlisting>
- <para>
- Expands to:
- </para>
- <programlisting><![CDATA[
+]]></programlisting>
+Expands to:
+<programlisting><![CDATA[
<script>
var astring = 'just an insert';
var somevar = " Big long string you don't" +
' want to have to quote for JS, and you want to' +
' insert the variable ' + astring + '.';
</script>
- ]]></programlisting>
-</example>
+]]></programlisting>
__END__
1.3 +8 -15 xmldocs/refs/jsqn
rev 1.3, prev_rev 1.2
Index: jsqn
===================================================================
RCS file: /var/cvs/xmldocs/refs/jsqn,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- jsqn 9 Oct 2004 11:30:29 -0000 1.2
+++ jsqn 13 Dec 2004 00:04:41 -0000 1.3
@@ -17,32 +17,25 @@
This is mostly used for long strings which are hard to prepare manually.
__END__
-__NAME__ example
-<example>
- <title>Basic example</title>
- <para>
- Here's an example of JavaScript code and the output it would generate,
- once expanded by Interchange:
- </para>
- <programlisting><![CDATA[
+__NAME__ example: Basic example
+Here's an example of JavaScript code and the output it would generate,
+once expanded by Interchange:
+<programlisting><![CDATA[
<script>
var astring = 'just an insert';
var somevar = [jsqn] Big long string you don't
want to have to quote for JS, and you don't want to
insert the variable $astring.[/jsqn];
</script>
- ]]></programlisting>
- <para>
- Expands to:
- </para>
- <programlisting><![CDATA[
+]]></programlisting>
+Expands to:
+<programlisting><![CDATA[
<script>
var astring = 'just an insert';
var somevar = " Big long string you don't" +
' want to have to quote for JS, and you don't want to' +
' insert the variable $astring.';
</script>
- ]]></programlisting>
-</example>
+]]></programlisting>
__END__
1.4 +4 -9 xmldocs/refs/load_cart
rev 1.4, prev_rev 1.3
Index: load_cart
===================================================================
RCS file: /var/cvs/xmldocs/refs/load_cart,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- load_cart 4 Dec 2004 22:47:23 -0000 1.3
+++ load_cart 13 Dec 2004 00:04:41 -0000 1.4
@@ -40,15 +40,10 @@
one</emphasis>.
__END__
-__NAME__ example
-<example>
- <title>Merge a saved cart to the current one</title>
- <para>
- Place the following on an Interchange page:
- </para>
- <programlisting>
+__NAME__ example: Merge a saved cart to the current one
+Place the following on an Interchange page:
+<programlisting>
[load_cart nickname="mycart:990102732:c"]
- </programlisting>
-</example>
+</programlisting>
__END__
1.6 +4 -9 xmldocs/refs/no_locale_parse
rev 1.6, prev_rev 1.5
Index: no_locale_parse
===================================================================
RCS file: /var/cvs/xmldocs/refs/no_locale_parse,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- no_locale_parse 9 Nov 2004 23:16:16 -0000 1.5
+++ no_locale_parse 13 Dec 2004 00:04:41 -0000 1.6
@@ -27,15 +27,10 @@
__END__
-__NAME__ example
-<example>
- <title>Enable no_locale_parse pragma page-wide</title>
- <para>
- Put the following anywhere on your page:
- </para>
- <programlisting>
+__NAME__ example: Enable no_locale_parse pragma page-wide
+Put the following anywhere on your page:
+<programlisting>
[pragma no_locale_parse]
- </programlisting>
-</example>
+</programlisting>
__END__
1.2 +4 -9 xmldocs/refs/rand
rev 1.2, prev_rev 1.1
Index: rand
===================================================================
RCS file: /var/cvs/xmldocs/refs/rand,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- rand 14 Oct 2004 20:14:01 -0000 1.1
+++ rand 13 Dec 2004 00:04:41 -0000 1.2
@@ -47,17 +47,12 @@
__END__
-__NAME__ example
-<example>
- <title>Return one random word</title>
- <para>
- Put the following on a test page:
- </para>
- <programlisting>
+__NAME__ example: Return one random word
+Put the following on a test page:
+<programlisting>
[rand separator=" "]
Foo Bar Baz Quux Toad Stool
[/rand]
- </programlisting>
-</example>
+</programlisting>
__END__
1.4 +4 -9 xmldocs/refs/save_cart
rev 1.4, prev_rev 1.3
Index: save_cart
===================================================================
RCS file: /var/cvs/xmldocs/refs/save_cart,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- save_cart 4 Dec 2004 22:47:23 -0000 1.3
+++ save_cart 13 Dec 2004 00:04:41 -0000 1.4
@@ -47,15 +47,10 @@
with the same nickname, an index will be added.
__END__
-__NAME__ example
-<example>
- <title>Save cart to UserDB</title>
- <para>
- Place the following on an Interchange page:
- </para>
- <programlisting>
+__NAME__ example: Save cart to UserDB
+Place the following on an Interchange page:
+<programlisting>
[save_cart mycart]
- </programlisting>
-</example>
+</programlisting>
__END__
1.5 +3 -7 xmldocs/refs/values-space
rev 1.5, prev_rev 1.4
Index: values-space
===================================================================
RCS file: /var/cvs/xmldocs/refs/values-space,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- values-space 9 Nov 2004 23:16:16 -0000 1.4
+++ values-space 13 Dec 2004 00:04:41 -0000 1.5
@@ -64,15 +64,11 @@
__END__
-__NAME__ example
-<example>
- <title>Switch and display namespaces</title>
- <programlisting>
+__NAME__ example: Switch and display namespaces
+<programlisting>
Current namespace is: [values-space] <sbr/>
Switching to namespace 'basket': [values-space basket] <sbr/>
Switching [values-space name=checkout show=1 clear=1] to clear [values-space] <sbr/>
-
- </programlisting>
-</example>
+</programlisting>
__END__
1.7 +4 -9 xmldocs/refs/var
rev 1.7, prev_rev 1.6
Index: var
===================================================================
RCS file: /var/cvs/xmldocs/refs/var,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- var 23 Nov 2004 18:01:00 -0000 1.6
+++ var 13 Dec 2004 00:04:41 -0000 1.7
@@ -54,16 +54,11 @@
__END__
-__NAME__ example
-<example>
- <title>Direct access equivalency example</title>
- <para>
- Note that the following two lines are identical in effect:
- </para>
- <programlisting>
+__NAME__ example: Direct access equivalency example
+Note that the following two lines are identical in effect:
+<programlisting>
[image src="[var IMAGE_DIR]/items/[cgi item_id]" border=0 extra="id='item_img'"]
[image src="__IMAGE_DIR__/items/[cgi item_id]" border=0 extra="id='item_img'"]
- </programlisting>
-</example>
+</programlisting>
__END__
More information about the docs
mailing list