[docs] xmldocs - docelic modified 11 files

docs at icdevgroup.org docs at icdevgroup.org
Sat Apr 30 18:56:53 EDT 2005


User:      docelic
Date:      2005-04-30 22:56:53 GMT
Modified:  glossary ITL
Modified:  refs     bar-button base-url.tag button capture_page cart
Modified:           catch.tag cgi.tag convert-date.tag counter.tag
Added:     refs     br.tag
Log:
Little fixes, some more docs, nice series altogether.

Revision  Changes    Path
1.10      +4 -2      xmldocs/glossary/ITL


rev 1.10, prev_rev 1.9
Index: ITL
===================================================================
RCS file: /var/cvs/xmldocs/glossary/ITL,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- ITL	6 Mar 2005 11:51:28 -0000	1.9
+++ ITL	30 Apr 2005 22:56:52 -0000	1.10
@@ -341,7 +341,9 @@
 <arg choice='plain'>reparse</arg> attributes here. <emphasis role='bold'>
 It is very important to remember that the behavior of the
 <arg choice='plain'>interpolate</arg> attribute (unfortunately) differs,
-depending on whether a tag is stand-alone or a container. In addition,
+depending on whether a tag is <emphasis>stand-alone</emphasis> or a
+<emphasis>container</emphasis>.
+In addition,
 the <arg choice='plain'>reparse</arg> attribute is only used with
 container tags (because its function is performed by
 <arg choice='plain'>interpolate</arg> in stand-alone tags).
@@ -352,7 +354,7 @@
 specifies whether the <emphasis>tag body</emphasis> will be
 &glos-interpolate;d before being passed to the tag. 
 <!-- </para><para> -->
-With stand-alone tags, the <arg choice='plain'>interpolate</arg> attribute
+With non-container tags, the <arg choice='plain'>interpolate</arg> attribute
 specifies whether the <emphasis>output</emphasis> of the tag will be
 &glos-interpolate;d. This is very confusing because it's not intuitive, but
 once you get to remember it a few times in practice, it will stop being a 



1.6       +2 -1      xmldocs/refs/bar-button


rev 1.6, prev_rev 1.5
Index: bar-button
===================================================================
RCS file: /var/cvs/xmldocs/refs/bar-button,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- bar-button	14 Dec 2004 19:15:43 -0000	1.5
+++ bar-button	30 Apr 2005 22:56:53 -0000	1.6
@@ -23,7 +23,8 @@
 	Name of the current page. Usually you do not want to override the default.
 	</entry>
 </row>
-
+&ROW_INTERPOLATE_0;
+&ROW_REPARSE_1;
 __END__
 
 



1.3       +0 -1      xmldocs/refs/base-url.tag


rev 1.3, prev_rev 1.2
Index: base-url.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/base-url.tag,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- base-url.tag	8 Mar 2005 11:43:13 -0000	1.2
+++ base-url.tag	30 Apr 2005 22:56:53 -0000	1.3
@@ -9,7 +9,6 @@
 
 __NAME__ synopsis
 &ROW_INTERPOLATE_0;
-&ROW_REPARSE_1;
 __END__
 
 



1.10      +7 -0      xmldocs/refs/button


rev 1.10, prev_rev 1.9
Index: button
===================================================================
RCS file: /var/cvs/xmldocs/refs/button,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- button	14 Dec 2004 19:15:43 -0000	1.9
+++ button	30 Apr 2005 22:56:53 -0000	1.10
@@ -91,11 +91,18 @@
 &ROW_EXTRA_none;
 &ROW_HTML_std;
 &ROW_CSS_std;
+&ROW_INTERPOLATE_0;
+&ROW_REPARSE_1;
 __END__
 
 
 __NAME__ see also
 env
+__END__
+
+
+__NAME__ notes
+The &tag-button; tag can work with unnamed forms.
 __END__
 
 



1.9       +1 -0      xmldocs/refs/capture_page


rev 1.9, prev_rev 1.8
Index: capture_page
===================================================================
RCS file: /var/cvs/xmldocs/refs/capture_page,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- capture_page	14 Dec 2004 19:15:43 -0000	1.8
+++ capture_page	30 Apr 2005 22:56:53 -0000	1.9
@@ -62,6 +62,7 @@
 </row>
 &ROW_UMASK_none;
 &ROW_HIDE_0;
+&ROW_INTERPOLATE_0;
 __END__
 
 __NAME__ description



1.3       +6 -0      xmldocs/refs/cart


rev 1.3, prev_rev 1.2
Index: cart
===================================================================
RCS file: /var/cvs/xmldocs/refs/cart,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- cart	14 Dec 2004 19:15:43 -0000	1.2
+++ cart	30 Apr 2005 22:56:53 -0000	1.3
@@ -34,6 +34,10 @@
 <tag>nitems</tag>).
 __END__
 
+__NAME__ notes
+See the &glos-cart; glossary entry.
+__END__
+
 __NAME__ example: Set new default cart name
 Place the following on an Interchange page:
 <programlisting>
@@ -41,3 +45,5 @@
 </programlisting>
 __END__
 
+__NAME__ see also
+__END__



1.3       +6 -19     xmldocs/refs/catch.tag


rev 1.3, prev_rev 1.2
Index: catch.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/catch.tag,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- catch.tag	8 Mar 2005 18:15:51 -0000	1.2
+++ catch.tag	30 Apr 2005 22:56:53 -0000	1.3
@@ -100,25 +100,7 @@
 	</entry>
 
 </row> 
-<row>
-
-	<entry>
-	hide
-	</entry>
-	<entry>
-	<!-- POS -->
-	</entry>
-	<entry>
-	<!-- REQ -->
-	</entry>
-	<entry>
-	<!-- DFL -->
-	</entry>
-	<entry>
-	<!-- DSC -->
-	</entry>
-
-</row> 
+&ROW_HIDE_0;
 &ROW_INTERPOLATE_0;
 &ROW_REPARSE_1;
 __END__
@@ -190,3 +172,8 @@
 </programlisting>
 __END__
 
+
+
+__NAME__ missing
+description for exact, joiner, error_set, error_scratch options
+__END__



1.5       +1 -0      xmldocs/refs/cgi.tag


rev 1.5, prev_rev 1.4
Index: cgi.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/cgi.tag,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- cgi.tag	14 Dec 2004 19:15:43 -0000	1.4
+++ cgi.tag	30 Apr 2005 22:56:53 -0000	1.5
@@ -60,6 +60,7 @@
 </row>
 &ROW_FILTER_none;
 &ROW_HIDE_0;
+&ROW_INTERPOLATE_0;
 __END__
 
 



1.2       +33 -2     xmldocs/refs/convert-date.tag


rev 1.2, prev_rev 1.1
Index: convert-date.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/convert-date.tag,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- convert-date.tag	17 Feb 2005 23:25:39 -0000	1.1
+++ convert-date.tag	30 Apr 2005 22:56:53 -0000	1.2
@@ -2,6 +2,28 @@
 <row>
 
 	<entry>
+	<group choice='opt'>
+	<arg choice='plain'>adjust</arg>
+	<arg choice='plain'>days</arg>
+	</group>
+	</entry>
+	<entry>
+	Yes
+	</entry>
+	<entry>
+	<!-- REQ -->
+	</entry>
+	<entry>
+	<!-- DFL -->
+	</entry>
+	<entry>
+	<!-- DSC -->
+	</entry>
+
+</row> 
+<row>
+
+	<entry>
 	raw
 	</entry>
 	<entry>
@@ -21,7 +43,10 @@
 <row>
 
 	<entry>
-	format
+	<group choice='opt'>
+	<arg choice='plain'>format</arg>
+	<arg choice='plain'>fmt</arg>
+	</group>
 	</entry>
 	<entry>
 	<!-- POS -->
@@ -77,4 +102,10 @@
 </row> 
 &ROW_INTERPOLATE_0;
 &ROW_REPARSE_1;
-__END__
\ No newline at end of file
+__END__
+
+
+__NAME__ missing
+option descriptions
+__END__
+



1.2       +352 -225  xmldocs/refs/counter.tag


rev 1.2, prev_rev 1.1
Index: counter.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/counter.tag,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- counter.tag	17 Feb 2005 23:25:39 -0000	1.1
+++ counter.tag	30 Apr 2005 22:56:53 -0000	1.2
@@ -1,232 +1,359 @@
 __NAME__ synopsis 
 <row>
 
-	<entry>
-	start
-	</entry>
-	<entry>
-	<!-- POS -->
-	</entry>
-	<entry>
-	<!-- REQ -->
-	</entry>
-	<entry>
-	<!-- DFL -->
-	</entry>
-	<entry>
-	<!-- DSC -->
-	</entry>
-
-</row> 
-<row>
-
-	<entry>
-	sql
-	</entry>
-	<entry>
-	<!-- POS -->
-	</entry>
-	<entry>
-	<!-- REQ -->
-	</entry>
-	<entry>
-	<!-- DFL -->
-	</entry>
-	<entry>
-	<!-- DSC -->
-	</entry>
-
-</row> 
-<row>
-
-	<entry>
-	inc_routine
-	</entry>
-	<entry>
-	<!-- POS -->
-	</entry>
-	<entry>
-	<!-- REQ -->
-	</entry>
-	<entry>
-	<!-- DFL -->
-	</entry>
-	<entry>
-	<!-- DSC -->
-	</entry>
-
-</row> 
-<row>
-
-	<entry>
-	bypass
-	</entry>
-	<entry>
-	<!-- POS -->
-	</entry>
-	<entry>
-	<!-- REQ -->
-	</entry>
-	<entry>
-	<!-- DFL -->
-	</entry>
-	<entry>
-	<!-- DSC -->
-	</entry>
-
-</row> 
-<row>
-
-	<entry>
-	dsn
-	</entry>
-	<entry>
-	<!-- POS -->
-	</entry>
-	<entry>
-	<!-- REQ -->
-	</entry>
-	<entry>
-	<!-- DFL -->
-	</entry>
-	<entry>
-	<!-- DSC -->
-	</entry>
-
-</row> 
-<row>
-
-	<entry>
-	user
-	</entry>
-	<entry>
-	<!-- POS -->
-	</entry>
-	<entry>
-	<!-- REQ -->
-	</entry>
-	<entry>
-	<!-- DFL -->
-	</entry>
-	<entry>
-	<!-- DSC -->
-	</entry>
-
-</row> 
-<row>
-
-	<entry>
-	pass
-	</entry>
-	<entry>
-	<!-- POS -->
-	</entry>
-	<entry>
-	<!-- REQ -->
-	</entry>
-	<entry>
-	<!-- DFL -->
-	</entry>
-	<entry>
-	<!-- DSC -->
-	</entry>
-
-</row> 
-<row>
-
-	<entry>
-	attr
-	</entry>
-	<entry>
-	<!-- POS -->
-	</entry>
-	<entry>
-	<!-- REQ -->
-	</entry>
-	<entry>
-	<!-- DFL -->
-	</entry>
-	<entry>
-	<!-- DSC -->
-	</entry>
-
-</row> 
-<row>
-
-	<entry>
-	date
-	</entry>
-	<entry>
-	<!-- POS -->
-	</entry>
-	<entry>
-	<!-- REQ -->
-	</entry>
-	<entry>
-	<!-- DFL -->
-	</entry>
-	<entry>
-	<!-- DSC -->
-	</entry>
-
-</row> 
-<row>
-
-	<entry>
-	dec_routine
-	</entry>
-	<entry>
-	<!-- POS -->
-	</entry>
-	<entry>
-	<!-- REQ -->
-	</entry>
-	<entry>
-	<!-- DFL -->
-	</entry>
-	<entry>
-	<!-- DSC -->
-	</entry>
-
-</row> 
-<row>
-
-	<entry>
-	value
-	</entry>
-	<entry>
-	<!-- POS -->
-	</entry>
-	<entry>
-	<!-- REQ -->
-	</entry>
-	<entry>
-	<!-- DFL -->
-	</entry>
-	<entry>
-	<!-- DSC -->
-	</entry>
-
-</row> 
-<row>
-
-	<entry>
-	decrement
-	</entry>
-	<entry>
-	<!-- POS -->
-	</entry>
-	<entry>
-	<!-- REQ -->
-	</entry>
-	<entry>
-	<!-- DFL -->
-	</entry>
-	<entry>
-	<!-- DSC -->
-	</entry>
+  <entry>
+  <group choice='opt'>
+  <arg choice='plain'>name</arg>
+  <arg choice='plain'>file</arg>
+  </group>
+  </entry>
+  <entry>
+  Yes
+  </entry>
+  <entry>
+  <!-- REQ -->
+  </entry>
+  <entry>
+  <filename>&glos-CATROOT;/etc/counter</filename>
+  </entry>
+  <entry>
+  Counter file to use. Taken relatively to &glos-CATROOT; unless absolute
+  pathname is specified.
+  </entry>
+
+</row> 
+<row>
+
+  <entry>
+  start
+  </entry>
+  <entry>
+  <!-- POS -->
+  </entry>
+  <entry>
+  <!-- REQ -->
+  </entry>
+  <entry>
+  <!-- DFL -->
+  </entry>
+  <entry>
+  Counter start value
+  </entry>
+
+</row> 
+<row>
+
+  <entry>
+  sql
+  </entry>
+  <entry>
+  <!-- POS -->
+  </entry>
+  <entry>
+  <!-- REQ -->
+  </entry>
+  <entry>
+  <!-- DFL -->
+  </entry>
+  <entry>
+  A <literal><replaceable>table</replaceable>:<replaceable>field</replaceable></literal> specification, if &tag-counter; is to increment a field in an SQL database.
+  </entry>
+
+</row> 
+<row>
+
+  <entry>
+  inc_routine
+  </entry>
+  <entry>
+  <!-- POS -->
+  </entry>
+  <entry>
+  <!-- REQ -->
+  </entry>
+  <entry>
+  <!-- DFL -->
+  </entry>
+  <entry>
+  Routine to use to increase the counter.
+  The routine should be an
+  existing &PERL; function, catalog subroutine, or global subroutine
+  </entry>
+
+</row> 
+<row>
+
+  <entry>
+  bypass
+  </entry>
+  <entry>
+  <!-- POS -->
+  </entry>
+  <entry>
+  <!-- REQ -->
+  </entry>
+  <entry>
+  0
+  </entry>
+  <entry>
+  Bypass the existing database connection, and instead connect to the database 
+  anew, if <arg choice='plain'>sql</arg> attribute is used.
+  </entry>
+
+</row> 
+<row>
+
+  <entry>
+  dsn
+  </entry>
+  <entry>
+  <!-- POS -->
+  </entry>
+  <entry>
+  <!-- REQ -->
+  </entry>
+  <entry>
+  <varname>DBI_DSN</varname>
+  </entry>
+  <entry>
+  DSN information to connect to the SQL database, if
+  <arg choice='plain'>sql</arg> attribute is used
+  </entry>
+
+</row> 
+<row>
+
+  <entry>
+  user
+  </entry>
+  <entry>
+  <!-- POS -->
+  </entry>
+  <entry>
+  <!-- REQ -->
+  </entry>
+  <entry>
+  <!-- DFL -->
+  </entry>
+  <entry>
+  User to connect to the database as, if 
+  <arg choice='plain'>sql</arg> attribute is used
+  </entry>
+
+</row> 
+<row>
+
+  <entry>
+  pass
+  </entry>
+  <entry>
+  <!-- POS -->
+  </entry>
+  <entry>
+  <!-- REQ -->
+  </entry>
+  <entry>
+  <!-- DFL -->
+  </entry>
+  <entry>
+  Password to provide during connection to the database, if 
+  <arg choice='plain'>sql</arg> attribute is used
+  </entry>
+
+</row> 
+<row>
+
+  <entry>
+  attr
+  </entry>
+  <entry>
+  <!-- POS -->
+  </entry>
+  <entry>
+  <!-- REQ -->
+  </entry>
+  <entry>
+  <!-- DFL -->
+  </entry>
+  <entry>
+  Extra content for the <function>DBI->connect</function> call
+  </entry>
+
+</row> 
+<row>
+
+  <entry>
+  date
+  </entry>
+  <entry>
+  <!-- POS -->
+  </entry>
+  <entry>
+  <!-- REQ -->
+  </entry>
+  <entry>
+  </entry>
+  <entry>
+  Date-based counter? Set to any true value, or <literal>gmt</literal> to 
+  also signify GMT date
+  </entry>
+
+</row> 
+<row>
+
+  <entry>
+  dec_routine
+  </entry>
+  <entry>
+  <!-- POS -->
+  </entry>
+  <entry>
+  <!-- REQ -->
+  </entry>
+  <entry>
+  <!-- DFL -->
+  </entry>
+  <entry>
+  Routine to use to decrease the counter
+  The routine should be an
+  existing &PERL; function, catalog subroutine, or global subroutine
+  </entry>
+
+</row> 
+<row>
+
+  <entry>
+  value
+  </entry>
+  <entry>
+  <!-- POS -->
+  </entry>
+  <entry>
+  <!-- REQ -->
+  </entry>
+  <entry>
+  <!-- DFL -->
+  </entry>
+  <entry>
+  Literal value to set counter to
+  </entry>
+
+</row> 
+<row>
+
+  <entry>
+  decrement
+  </entry>
+  <entry>
+  <!-- POS -->
+  </entry>
+  <entry>
+  <!-- REQ -->
+  </entry>
+  <entry>
+  0
+  </entry>
+  <entry>
+  Decrement instead of incrementing the counter?
+  </entry>
 
 </row> 
 &ROW_INTERPOLATE_0;
 &ROW_REPARSE_1;
-__END__
\ No newline at end of file
+__END__
+
+
+__NAME__ description
+The tag provides an interface to the counter functionality within &IC;.
+The counters are usually kept as text files, but can also be sequences in
+&glos-SQL; tables.
+</para><para>
+&tag-counter; can increase and decrease counters, or set them to specific
+values. In addition, custom increment or decrement functions can be
+used.
+__END__
+
+
+__NAME__ notes
+The SQL field-updating routine is database-dependent; please see the tag
+source for details.
+</para><para>
+Date-based counters cannot be decremented.
+__END__
+
+__NAME__ example: Basic counter file
+The following creates a counter file,
+<filename>counter.basic</filename> in your catalog root directory.
+The counter starts at <literal>10</literal>.
+<programlisting>
+[counter file=counter.basic start=10]
+</programlisting>
+__END__
+
+
+__NAME__ example: Basic date-based counter file
+The following creates two date-based counter files,
+<filename>counter.loc</filename> and
+<filename>counter.gmt</filename> in your catalog root directory.
+<programlisting>
+[counter file=counter.loc date=1]
+[counter file=counter.gmt date=gmt]
+</programlisting>
+__END__
+
+
+
+__NAME__ example: Counter using steps of +2 and -2, with in-place subroutine specification
+The following creates two counter files,
+<filename>counter.p2</filename> and
+<filename>counter.m2</filename> in your catalog root directory.
+Counters initially start at <literal>20</literal>; one adds
+<literal>2</literal> and one subtracts <literal>2</literal> each time
+they're called.
+<programlisting>
+[counter
+  file=counter.p2
+  start=20
+  inc-routine=`sub { shift(@_) + 2 }`
+]
+[counter
+  file=counter.m2
+  start=20
+  decrement=1
+  dec-routine=`sub { shift(@_) - 2 }`
+]
+</programlisting>
+__END__
+
+
+
+__NAME__ example: Counter using steps of +3 and -3, with Sub or GlobalSub routine specification
+The following creates two counter files,
+<filename>counter.p3g</filename> and
+<filename>counter.m3g</filename> in your catalog root directory.
+Counters initially start at <literal>20</literal>; one adds
+<literal>3</literal> and one subtracts <literal>3</literal> each time
+they're called.
+</para><para>
+You need the following in &ccf; or &gcf;:
+<programlisting><![CDATA[
+Sub three_steps_forward <<EOR
+sub {
+  my $val = shift; $val += 3; return $val;
+}
+EOR
+
+Sub three_steps_back <<EOR
+sub {
+  my $val = shift; $val -= 3; return $val;
+}
+EOR
+]]></programlisting>
+</para><para>
+And the following on an &IC; page:
+<programlisting>
+[counter file=counter.p3 start=20 inc-routine=three_steps_forward ]
+[counter file=counter.m3 start=20 decrement=1 dec-routine=three_steps_back]
+</programlisting>
+__END__
+



1.1                  xmldocs/refs/br.tag


rev 1.1, prev_rev 1.0
Index: br.tag
===================================================================
__NAME__ purpose
insert HTML BR (break) element
__END__

__NAME__ see also
__END__


__NAME__ synopsis
&ROW_INTERPOLATE_0;
__END__


__NAME__ description
The tag simply inserts the &glos-HTML; BR (break) element.
The tag is lowercased and, if the <varname>Vend::Xtrailer</varname>
variable is set, terminated with <literal>/</literal> to satisfy 
XHTML convention.
__END__

__NAME__ example: Inserting HTML BR
<programlisting>
Line 1[br]
Line 2[br]
</programlisting>
__END__









More information about the docs mailing list