[interchange-docs] xmldocs - docelic modified 41 files
docs at icdevgroup.org
docs at icdevgroup.org
Wed Dec 13 17:48:12 EST 2006
User: docelic
Date: 2006-12-13 22:48:12 GMT
Modified: . TODO
Modified: bin stattree
Modified: docbook literals.ent
Modified: refs Database Require assign.tag assume-identity.tag
Modified: auto-wizard.tag captcha.tag cgi.tag charge.tag
Modified: check-upload.tag checked.tag comment.tag
Modified: component.tag content-info.tag content-modify.tag
Modified: control-set.tag control.tag convert-date.tag
Modified: counter.tag db-hash.tag db_columns.tag dbinfo.tag
Modified: diff.tag directive_value.tag discount
Modified: export-database.tag export.tag fcounter.tag
Modified: handling.tag harness.tag html-table.tag import.tag
Modified: include.tag log.tag page.tag time.tag
Added: refs CAPTCHA_IMAGE_LOCATION CAPTCHA_IMAGE_PATH
Added: CAPTCHA_IMAGE_SUBDIR
Log:
- Added a few todo items and small fixes here and there
- Added lists of attributes used for a number of tags
Revision Changes Path
1.100 +9 -0 xmldocs/TODO
rev 1.100, prev_rev 1.99
Index: TODO
===================================================================
RCS file: /var/cvs/xmldocs/TODO,v
retrieving revision 1.99
retrieving revision 1.100
diff -u -r1.99 -r1.100
--- TODO 6 Nov 2006 18:41:20 -0000 1.99
+++ TODO 13 Dec 2006 22:48:11 -0000 1.100
@@ -17,6 +17,15 @@
- note in configuration glossentry to use '' to skip values
- Check ConfigDatabase and DirectiveDatabase. Is description correct? One seems to be wrong
- preprocessor directives in configuration ?
+- FAQ should be desintegrated to other places
+- what doesn't racke like with WHATSNEW
+- replace itemlists with sections or tables
+- component tag has wrong source context
+Entities to create:
+- \0 null char
+- table/column/key should be defined in docbook/literals.ent as ROW_TABLE...
+- DEFAULT_JOINER_N for \n
+- SAFE_DATA
Outstanding:
=======
1.54 +54 -0 xmldocs/bin/stattree
rev 1.54, prev_rev 1.53
Index: stattree
===================================================================
RCS file: /var/cvs/xmldocs/bin/stattree,v
retrieving revision 1.53
retrieving revision 1.54
diff -u -r1.53 -r1.54
--- stattree 19 Jun 2006 00:15:59 -0000 1.53
+++ stattree 13 Dec 2006 22:48:11 -0000 1.54
@@ -353,6 +353,8 @@
line_findPragmas(\%c); # See if there's a pragma on the line
line_findGlobVars(\%c); # See if there's a global var on the line
line_findCatVars(\%c); # You get the point ....
+ #line_findGlobConfs(\%c); # Read info above the function definition
+ line_findCatConfs(\%c);
} else {
die "IMPOSSIBLE case in $file:$c{file}:$c{lnum} -- $c{line}\n";
@@ -424,6 +426,8 @@
# For example, this should find PGP_HOME
line_findGlobVars(\%c, {group => $c{fsubtype}, name=>$tn});
line_findCatVars(\%c, {group => $c{fsubtype}, name=>$tn});
+ #line_findGlobConfs(\%c); # Read above function definition
+ line_findCatConfs(\%c);
line_findFunctionName(\%c, {group => $c{fsubtype}, name=>$tn});
}
next;
@@ -751,6 +755,56 @@
}
$hash{total}{globvars}++;
+ }
+}
+
+#
+# XXX For CatConfs and GlobConfs, the following two functions don't actually
+# discover them in the code. (We don't need discovery routines since all
+# the catalog & global config directives are listed in Config.pm, which we
+# parse with a special routine). So the code here is named that way only
+# for the same look & feel as the rest, but it does only a subset of what
+# the similarly-named routines for other symbol types do. Namely, it only
+# discovers that conf vars are used as part of some perl code, and lists
+# them in reference pages for the respective items that use them.
+#
+
+sub line_findCatConfs {
+ ######################################################
+ # Diskover catalog directives
+ my %c = %{ (shift) };
+ my $context_data = shift;
+
+ my $name;
+
+ if (
+ ($c{line} =~ /(()|\$())\$(::)?Cfg(->\2|\3){(\w+?)}/ and $name=$6)
+ or ($c{line} =~ /(()|\$())\$(::)?Config(->\2|\3){(\w+?)}/ and $name=$6)
+ ) {
+
+ push(
+ @{$hash{uses}{$$context_data{group}}{$$context_data{name}}{catconf}},
+ $name) unless grep {/^$name$/}
+ @{$hash{uses}{$$context_data{group}}{$$context_data{name}}{catconf}}
+ }
+}
+
+sub line_findGlobConfs {
+ ######################################################
+ # Diskover global config directives
+ my %c = %{ (shift) };
+ my $context_data = shift;
+
+ my $name;
+
+ if (
+ ($c{line} =~ /(()|\$())\$(::)?Vend::Cfg(->\2|\3){(\w+?)}/ and $name=$6)
+ ) {
+
+ push(
+ @{$hash{uses}{$$context_data{group}}{$$context_data{name}}{globconf}},
+ $name) unless grep {/^$name$/}
+ @{$hash{uses}{$$context_data{group}}{$$context_data{name}}{globconf}}
}
}
1.46 +4 -0 xmldocs/docbook/literals.ent
rev 1.46, prev_rev 1.45
Index: literals.ent
===================================================================
RCS file: /var/cvs/xmldocs/docbook/literals.ent,v
retrieving revision 1.45
retrieving revision 1.46
diff -u -r1.45 -r1.46
--- literals.ent 29 Nov 2006 23:07:45 -0000 1.45
+++ literals.ent 13 Dec 2006 22:48:11 -0000 1.46
@@ -316,3 +316,7 @@
<!ENTITY CAs "<emphasis>CommonAdjust string</emphasis>">
<!ENTITY P "<replaceable>PREFIX</replaceable>">
+
+<!ENTITY NEWLINE "A newline (<literal>\n</literal>)">
+<!ENTITY TAB "A TAB (<literal>\t</literal>)">
+
1.9 +1 -1 xmldocs/refs/Database
rev 1.9, prev_rev 1.8
Index: Database
===================================================================
RCS file: /var/cvs/xmldocs/refs/Database,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- Database 30 Nov 2006 14:34:53 -0000 1.8
+++ Database 13 Dec 2006 22:48:11 -0000 1.9
@@ -23,7 +23,7 @@
__NAME__ description
</para><para>
The directive registers a database table for use with &IC;.
-<literal>name</literal> specifies an arbitrary name — name
+<literal>table_name</literal> specifies an arbitrary name — name
that will be used to refer to the table within &IC;. Names can be composed
of alphanumeric characters including underscore, and we recommend they're in
all lower- or upper-case.
1.10 +2 -2 xmldocs/refs/Require
rev 1.10, prev_rev 1.9
Index: Require
===================================================================
RCS file: /var/cvs/xmldocs/refs/Require,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- Require 6 Nov 2006 18:41:21 -0000 1.9
+++ Require 13 Dec 2006 22:48:11 -0000 1.10
@@ -30,8 +30,8 @@
<literal>module</literal>.
</para>
<para>
-This directive can also used to implicitly load &PERL; modules. If you add
-a directory name as a fourth argument, the directory will included in Perl's
+This directive can also be used to implicitly load &PERL; modules. If you add
+a directory name as a fourth argument, the directory will be included in Perl's
module search path.
__END__
1.3 +4 -2 xmldocs/refs/assign.tag
rev 1.3, prev_rev 1.2
Index: assign.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/assign.tag,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- assign.tag 29 Nov 2006 23:07:45 -0000 1.2
+++ assign.tag 13 Dec 2006 22:48:11 -0000 1.3
@@ -1,5 +1,5 @@
__NAME__ purpose
-assign direct values for certain steps of the checkout procedure instead of performing calculations
+assign direct values for certain steps of checkout instead of performing calculations
__END__
__NAME__ synopsis
@@ -134,7 +134,8 @@
active assignments. To clear an individual assignment, set its value
<emphasis>to an empty string</emphasis>.
(Beware, a specification such as <literal>handling=0</literal> actually sets
-handling costs to zero, it does not clear the assignment).
+handling costs to zero, it does not clear the assignment. To clear the
+assignment, you must use <literal>handling=""</literal>).
__END__
@@ -145,6 +146,7 @@
Assigning any value other than a number (or an empty string, when clearing
assignments), will result in an error being reported and the
assignment for the "subsystem" in question cleared.
+</para><para>
<emphasis role='bold'>An assignment is allowed to be a
negative number</emphasis>.
</para><para>
1.2 +36 -9 xmldocs/refs/assume-identity.tag
rev 1.2, prev_rev 1.1
Index: assume-identity.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/assume-identity.tag,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- assume-identity.tag 17 Feb 2005 23:25:39 -0000 1.1
+++ assume-identity.tag 13 Dec 2006 22:48:11 -0000 1.2
@@ -1,23 +1,50 @@
+__NAME__ purpose
+override value of MV_PAGE on a page
+__END__
+
__NAME__ synopsis
<row>
-
<entry>
- name
+ <arg choice='plain'>file</arg>
</entry>
<entry>
- <!-- POS -->
+ Yes
</entry>
<entry>
- <!-- REQ -->
</entry>
<entry>
- <!-- DFL -->
</entry>
<entry>
- <!-- DSC -->
+ .
</entry>
-
</row>
-&ROW_INTERPOLATE_0;
+<row>
+ <entry>
+ <arg choice='plain'>name</arg>
+ </entry>
+ <entry>
+ </entry>
+ <entry>
+ </entry>
+ <entry>
+ </entry>
+ <entry>
+ .
+ </entry>
+</row>
+&ROW_LOCALE_1;
+&ROW_INTERPOLATE_1;
&ROW_REPARSE_1;
-__END__
\ No newline at end of file
+__END__
+
+__NAME__ description
+__END__
+
+__NAME__ author
+&mheins;
+__END__
+
+* Allow a page to change its path in MV_PAGE, "assuming an identity". This is
+ designed to allow virtual pages to be indistinguishable from pages that
+ have files existant.
+
1.2 +47 -10 xmldocs/refs/auto-wizard.tag
rev 1.2, prev_rev 1.1
Index: auto-wizard.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/auto-wizard.tag,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- auto-wizard.tag 17 Feb 2005 23:25:39 -0000 1.1
+++ auto-wizard.tag 13 Dec 2006 22:48:11 -0000 1.2
@@ -2,6 +2,24 @@
<row>
<entry>
+ name
+ </entry>
+ <entry>
+ Yes
+ </entry>
+ <entry>
+ </entry>
+ <entry>
+ <literal>default</literal>
+ </entry>
+ <entry>
+ Survey name.
+ </entry>
+
+</row>
+<row>
+
+ <entry>
already_title
</entry>
<entry>
@@ -11,7 +29,7 @@
<!-- REQ -->
</entry>
<entry>
- <!-- DFL -->
+ <literal>You already did that survey!</literal>
</entry>
<entry>
<!-- DSC -->
@@ -30,7 +48,7 @@
<!-- REQ -->
</entry>
<entry>
- <!-- DFL -->
+ <literal>Thanks for completing the survey!</literal>
</entry>
<entry>
<!-- DSC -->
@@ -49,7 +67,7 @@
<!-- REQ -->
</entry>
<entry>
- <!-- DFL -->
+ <literal>We only want to collect information once from each person. Thank you.</literal>
</entry>
<entry>
<!-- DSC -->
@@ -68,7 +86,7 @@
<!-- REQ -->
</entry>
<entry>
- <!-- DFL -->
+ <literal>Your survey is complete. Thank you.</literal>
</entry>
<entry>
<!-- DSC -->
@@ -97,6 +115,25 @@
<row>
<entry>
+ survey_file
+ </entry>
+ <entry>
+ <!-- POS -->
+ </entry>
+ <entry>
+ <!-- REQ -->
+ </entry>
+ <entry>
+ <literal>logs/survey/<option>name</option>.txt</literal>
+ </entry>
+ <entry>
+ <!-- DSC -->
+ </entry>
+
+</row>
+<row>
+
+ <entry>
survey_counter
</entry>
<entry>
@@ -106,7 +143,7 @@
<!-- REQ -->
</entry>
<entry>
- <!-- DFL -->
+ <literal>logs/survey/<option>name</option>.cnt</literal>
</entry>
<entry>
<!-- DSC -->
@@ -116,7 +153,7 @@
<row>
<entry>
- survey_file
+ survey_counter_sql
</entry>
<entry>
<!-- POS -->
@@ -144,7 +181,7 @@
<!-- REQ -->
</entry>
<entry>
- <!-- DFL -->
+ <literal>Response to <option>name</option></literal>
</entry>
<entry>
<!-- DSC -->
@@ -448,7 +485,7 @@
<!-- REQ -->
</entry>
<entry>
- <!-- DFL -->
+ <literal>page_title</literal>
</entry>
<entry>
<!-- DSC -->
@@ -467,7 +504,7 @@
<!-- REQ -->
</entry>
<entry>
- <!-- DFL -->
+ <literal>page_banner</literal>
</entry>
<entry>
<!-- DSC -->
@@ -476,4 +513,4 @@
</row>
&ROW_INTERPOLATE_0;
&ROW_REPARSE_1;
-__END__
\ No newline at end of file
+__END__
1.2 +1 -1 xmldocs/refs/captcha.tag
rev 1.2, prev_rev 1.1
Index: captcha.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/captcha.tag,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- captcha.tag 11 Aug 2006 14:24:04 -0000 1.1
+++ captcha.tag 13 Dec 2006 22:48:11 -0000 1.2
@@ -1,5 +1,5 @@
__NAME__ purpose
-Handles captcha images used for authentication
+handle captcha images used for authentication
__END__
__NAME__ synopsis
1.6 +1 -1 xmldocs/refs/cgi.tag
rev 1.6, prev_rev 1.5
Index: cgi.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/cgi.tag,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- cgi.tag 30 Apr 2005 22:56:53 -0000 1.5
+++ cgi.tag 13 Dec 2006 22:48:11 -0000 1.6
@@ -1,5 +1,5 @@
__NAME__ purpose
-get or set current value of the specified CGI input variable
+get or set value of CGI input variables
__END__
1.2 +96 -1 xmldocs/refs/charge.tag
rev 1.2, prev_rev 1.1
Index: charge.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/charge.tag,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- charge.tag 17 Feb 2005 23:25:39 -0000 1.1
+++ charge.tag 13 Dec 2006 22:48:11 -0000 1.2
@@ -2,6 +2,44 @@
<row>
<entry>
+ route
+ </entry>
+ <entry>
+ Yes
+ </entry>
+ <entry>
+ <!-- REQ -->
+ </entry>
+ <entry>
+ <!-- DFL -->
+ </entry>
+ <entry>
+ <!-- DSC -->
+ </entry>
+
+</row>
+<row>
+
+ <entry>
+ amount
+ </entry>
+ <entry>
+ <!-- POS -->
+ </entry>
+ <entry>
+ <!-- REQ -->
+ </entry>
+ <entry>
+ <!-- DFL -->
+ </entry>
+ <entry>
+ <!-- DSC -->
+ </entry>
+
+</row>
+<row>
+
+ <entry>
gateway
</entry>
<entry>
@@ -18,6 +56,63 @@
</entry>
</row>
+<row>
+
+ <entry>
+ cyber_mode
+ </entry>
+ <entry>
+ <!-- POS -->
+ </entry>
+ <entry>
+ <!-- REQ -->
+ </entry>
+ <entry>
+ <!-- DFL -->
+ </entry>
+ <entry>
+ <!-- DSC -->
+ </entry>
+
+</row>
+<row>
+
+ <entry>
+ log_to_error
+ </entry>
+ <entry>
+ <!-- POS -->
+ </entry>
+ <entry>
+ <!-- REQ -->
+ </entry>
+ <entry>
+ <!-- DFL -->
+ </entry>
+ <entry>
+ <!-- DSC -->
+ </entry>
+
+</row>
+<row>
+
+ <entry>
+ hash
+ </entry>
+ <entry>
+ <!-- POS -->
+ </entry>
+ <entry>
+ <!-- REQ -->
+ </entry>
+ <entry>
+ No
+ </entry>
+ <entry>
+ Return results as a hash reference?
+ </entry>
+
+</row>
&ROW_INTERPOLATE_0;
&ROW_REPARSE_1;
-__END__
\ No newline at end of file
+__END__
1.2 +41 -0 xmldocs/refs/check-upload.tag
rev 1.2, prev_rev 1.1
Index: check-upload.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/check-upload.tag,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- check-upload.tag 17 Feb 2005 23:25:39 -0000 1.1
+++ check-upload.tag 13 Dec 2006 22:48:11 -0000 1.2
@@ -0,0 +1,41 @@
+__NAME__ synopsis
+<row>
+
+ <entry>
+ file
+ </entry>
+ <entry>
+ Yes
+ </entry>
+ <entry>
+ Yes
+ </entry>
+ <entry>
+ <!-- DFL -->
+ </entry>
+ <entry>
+ <!-- DSC -->
+ </entry>
+
+</row>
+<row>
+
+ <entry>
+ same
+ </entry>
+ <entry>
+ Yes
+ </entry>
+ <entry>
+ </entry>
+ <entry>
+ <!-- DFL -->
+ </entry>
+ <entry>
+ <!-- DSC -->
+ </entry>
+
+</row>
+&ROW_INTERPOLATE_0;
+&ROW_REPARSE_1;
+__END__
1.3 +7 -7 xmldocs/refs/checked.tag
rev 1.3, prev_rev 1.2
Index: checked.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/checked.tag,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- checked.tag 18 Dec 2005 11:32:11 -0000 1.2
+++ checked.tag 13 Dec 2006 22:48:11 -0000 1.3
@@ -49,7 +49,7 @@
<!-- REQ -->
</entry>
<entry>
- <!-- DFL -->
+ <literal>on</literal>
</entry>
<entry>
<!-- DSC -->
@@ -68,17 +68,17 @@
<!-- REQ -->
</entry>
<entry>
- <!-- DFL -->
+ No
</entry>
<entry>
- <!-- DSC -->
+ Preserve case for field names and values?
</entry>
</row>
<row>
<entry>
- delimiter
+ multiple
</entry>
<entry>
<!-- POS -->
@@ -97,7 +97,7 @@
<row>
<entry>
- multiple
+ delimiter
</entry>
<entry>
<!-- POS -->
@@ -106,10 +106,10 @@
<!-- REQ -->
</entry>
<entry>
- <!-- DFL -->
+ <literal>\0</literal>
</entry>
<entry>
- <!-- DSC -->
+ This option implies <literal>multiple=1</literal>.
</entry>
</row>
1.2 +14 -4 xmldocs/refs/comment.tag
rev 1.2, prev_rev 1.1
Index: comment.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/comment.tag,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- comment.tag 20 Oct 2005 14:09:50 -0000 1.1
+++ comment.tag 13 Dec 2006 22:48:11 -0000 1.2
@@ -1,5 +1,5 @@
__NAME__ purpose
-comment parts of code or HTML pages
+comment (disable) parts of Interchange or HTML code
__END__
__NAME__ see also
@@ -12,7 +12,8 @@
__NAME__ description
The tag comments parts of &glos-ITL; or &glos-HTML; code.
Content enclosed in the &tag-comment; block will not be processed
-in any way, and will be stripped out of the pages.
+in any way, and will be stripped out of the final data sent to
+the clients.
</para><para>
You can use comment sections to provide code commentary, or
effectively disable parts of code.
@@ -28,10 +29,19 @@
&tag-comment; blocks can be nested.
__END__
-__NAME__ example: Sending a message to debug log
+__NAME__ example: Using comment
<programlisting>
[comment]
- Have no fear, for this is the one comment area!
+ Have no fear, for this is just one comment area!
+[/comment]
+</programlisting>
+__END__
+
+__NAME__ example: Disabling ITL code
+This &tag-nitems; tag below will never execute:
+<programlisting>
+[comment]
+ You have [nitems] items in your cart.
[/comment]
</programlisting>
__END__
1.2 +1 -1 xmldocs/refs/component.tag
rev 1.2, prev_rev 1.1
Index: component.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/component.tag,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- component.tag 17 Feb 2005 23:25:39 -0000 1.1
+++ component.tag 13 Dec 2006 22:48:11 -0000 1.2
@@ -77,4 +77,4 @@
</row>
&ROW_INTERPOLATE_0;
&ROW_REPARSE_1;
-__END__
\ No newline at end of file
+__END__
1.3 +22 -6 xmldocs/refs/content-info.tag
rev 1.3, prev_rev 1.2
Index: content-info.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/content-info.tag,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- content-info.tag 2 Nov 2006 10:45:09 -0000 1.2
+++ content-info.tag 13 Dec 2006 22:48:11 -0000 1.3
@@ -53,10 +53,26 @@
</row>
<row>
-<entry>
- no-none
-</entry>
-<entry>
-</entry>
+<entry>no_none</entry>
+<entry></entry>
+<entry></entry>
+<entry></entry>
+<entry></entry>
</row>
-__END__
\ No newline at end of file
+
+<row>
+<entry>structure-none</entry>
+<entry></entry>
+<entry></entry>
+<entry></entry>
+<entry></entry>
+</row>
+
+<row>
+<entry>show_class</entry>
+<entry></entry>
+<entry></entry>
+<entry></entry>
+<entry></entry>
+</row>
+__END__
1.2 +102 -0 xmldocs/refs/content-modify.tag
rev 1.2, prev_rev 1.1
Index: content-modify.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/content-modify.tag,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- content-modify.tag 17 Feb 2005 23:25:39 -0000 1.1
+++ content-modify.tag 13 Dec 2006 22:48:11 -0000 1.2
@@ -0,0 +1,102 @@
+
+__NAME__ synopsis
+
+<row>
+<entry>op</entry>
+<entry>Yes</entry>
+<entry></entry>
+<entry></entry>
+<entry></entry>
+</row>
+
+<row>
+<entry>name</entry>
+<entry>Yes</entry>
+<entry></entry>
+<entry></entry>
+<entry></entry>
+</row>
+
+<row>
+<entry>type</entry>
+<entry>Yes</entry>
+<entry></entry>
+<entry></entry>
+<entry></entry>
+</row>
+
+<row>
+<entry>values_ref</entry>
+<entry>0</entry>
+<entry></entry>
+<entry></entry>
+<entry></entry>
+</row>
+
+<row>
+<entry>templates</entry>
+<entry>0</entry>
+<entry></entry>
+<entry></entry>
+<entry></entry>
+</row>
+
+<row>
+<entry>components</entry>
+<entry></entry>
+<entry></entry>
+<entry></entry>
+<entry></entry>
+</row>
+
+<row>
+<entry>delimiter</entry>
+<entry></entry>
+<entry></entry>
+<entry><literal>,</literal></entry>
+<entry></entry>
+</row>
+
+<row>
+<entry>code</entry>
+<entry></entry>
+<entry></entry>
+<entry></entry>
+<entry></entry>
+</row>
+
+<row>
+<entry>label</entry>
+<entry></entry>
+<entry></entry>
+<entry></entry>
+<entry></entry>
+</row>
+
+<row>
+<entry>no_none</entry>
+<entry></entry>
+<entry></entry>
+<entry></entry>
+<entry></entry>
+</row>
+
+<row>
+<entry>structure</entry>
+<entry></entry>
+<entry></entry>
+<entry></entry>
+<entry></entry>
+</row>
+
+<row>
+<entry>show_class</entry>
+<entry></entry>
+<entry></entry>
+<entry></entry>
+<entry></entry>
+</row>
+__END__
+
+
+
1.2 +28 -0 xmldocs/refs/control-set.tag
rev 1.2, prev_rev 1.1
Index: control-set.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/control-set.tag,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- control-set.tag 17 Feb 2005 23:25:39 -0000 1.1
+++ control-set.tag 13 Dec 2006 22:48:11 -0000 1.2
@@ -0,0 +1,28 @@
+__NAME__ purpose
+Retrieve component attributes
+__END__
+
+__NAME__ synopsis
+<row>
+ <entry>
+ index
+ </entry>
+ <entry>
+ Yes
+ </entry>
+ <entry>
+ </entry>
+ <entry>
+ </entry>
+ <entry>
+ </entry>
+</row>
+
+&ROW_INTERPOLATE_0;
+&ROW_REPARSE_1;
+__END__
+
+
+__NAME__ see also
+control
+__END__
1.3 +2 -2 xmldocs/refs/control.tag
rev 1.3, prev_rev 1.2
Index: control.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/control.tag,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- control.tag 2 Nov 2006 11:04:45 -0000 1.2
+++ control.tag 13 Dec 2006 22:48:11 -0000 1.3
@@ -98,5 +98,5 @@
__NAME__ see also
-component
-__END__
\ No newline at end of file
+control-set, component
+__END__
1.3 +2 -2 xmldocs/refs/convert-date.tag
rev 1.3, prev_rev 1.2
Index: convert-date.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/convert-date.tag,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- convert-date.tag 30 Apr 2005 22:56:53 -0000 1.2
+++ convert-date.tag 13 Dec 2006 22:48:11 -0000 1.3
@@ -2,7 +2,7 @@
<row>
<entry>
- <group choice='opt'>
+ <group>
<arg choice='plain'>adjust</arg>
<arg choice='plain'>days</arg>
</group>
@@ -43,7 +43,7 @@
<row>
<entry>
- <group choice='opt'>
+ <group>
<arg choice='plain'>format</arg>
<arg choice='plain'>fmt</arg>
</group>
1.6 +1 -1 xmldocs/refs/counter.tag
rev 1.6, prev_rev 1.5
Index: counter.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/counter.tag,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- counter.tag 28 Sep 2006 16:34:56 -0000 1.5
+++ counter.tag 13 Dec 2006 22:48:11 -0000 1.6
@@ -6,7 +6,7 @@
<row>
<entry>
- <group choice='opt'>
+ <group>
<arg choice='plain'>name</arg>
<arg choice='plain'>file</arg>
</group>
1.2 +58 -1 xmldocs/refs/db-hash.tag
rev 1.2, prev_rev 1.1
Index: db-hash.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/db-hash.tag,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- db-hash.tag 17 Feb 2005 23:25:39 -0000 1.1
+++ db-hash.tag 13 Dec 2006 22:48:11 -0000 1.2
@@ -2,6 +2,63 @@
<row>
<entry>
+ table
+ </entry>
+ <entry>
+ Yes
+ </entry>
+ <entry>
+ <!-- REQ -->
+ </entry>
+ <entry>
+ <!-- DFL -->
+ </entry>
+ <entry>
+ <!-- DSC -->
+ </entry>
+
+</row>
+<row>
+
+ <entry>
+ column
+ </entry>
+ <entry>
+ Yes
+ </entry>
+ <entry>
+ <!-- REQ -->
+ </entry>
+ <entry>
+ <!-- DFL -->
+ </entry>
+ <entry>
+ <!-- DSC -->
+ </entry>
+
+</row>
+<row>
+
+ <entry>
+ key
+ </entry>
+ <entry>
+ Yes
+ </entry>
+ <entry>
+ <!-- REQ -->
+ </entry>
+ <entry>
+ <!-- DFL -->
+ </entry>
+ <entry>
+ <!-- DSC -->
+ </entry>
+
+</row>
+<row>
+
+ <entry>
value
</entry>
<entry>
@@ -77,4 +134,4 @@
</row>
&ROW_INTERPOLATE_0;
&ROW_REPARSE_1;
-__END__
\ No newline at end of file
+__END__
1.2 +143 -0 xmldocs/refs/db_columns.tag
rev 1.2, prev_rev 1.1
Index: db_columns.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/db_columns.tag,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- db_columns.tag 17 Feb 2005 23:25:39 -0000 1.1
+++ db_columns.tag 13 Dec 2006 22:48:11 -0000 1.2
@@ -0,0 +1,143 @@
+__NAME__ synopsis
+<row>
+
+ <entry>
+ <group>
+ <arg>name</arg>
+ <arg>table</arg>
+ </group>
+ </entry>
+ <entry>
+ Yes
+ </entry>
+ <entry>
+ <!-- REQ -->
+ </entry>
+ <entry>
+ <!-- DFL -->
+ </entry>
+ <entry>
+ <!-- DSC -->
+ </entry>
+
+</row>
+<row>
+
+ <entry>
+ <group>
+ <arg>fields</arg>
+ <arg>columns</arg>
+ </group>
+ </entry>
+ <entry>
+ Yes
+ </entry>
+ <entry>
+ <!-- REQ -->
+ </entry>
+ <entry>
+ <!-- DFL -->
+ </entry>
+ <entry>
+ <!-- DSC -->
+ </entry>
+
+</row>
+<row>
+
+ <entry>
+ joiner
+ </entry>
+ <entry>
+ Yes
+ </entry>
+ <entry>
+ <!-- REQ -->
+ </entry>
+ <entry>
+ <literal>\n</literal>
+ </entry>
+ <entry>
+ <!-- DSC -->
+ </entry>
+
+</row>
+<row>
+
+ <entry>
+ passed_order
+ </entry>
+ <entry>
+ <!-- POS -->
+ </entry>
+ <entry>
+ <!-- REQ -->
+ </entry>
+ <entry>
+ <!-- DFL -->
+ </entry>
+ <entry>
+ <!-- DSC -->
+ </entry>
+
+</row>
+<row>
+
+ <entry>
+ show_error
+ </entry>
+ <entry>
+ <!-- POS -->
+ </entry>
+ <entry>
+ <!-- REQ -->
+ </entry>
+ <entry>
+ <!-- DFL -->
+ </entry>
+ <entry>
+ <!-- DSC -->
+ </entry>
+
+</row>
+<row>
+
+ <entry>
+ keys
+ </entry>
+ <entry>
+ <!-- POS -->
+ </entry>
+ <entry>
+ <!-- REQ -->
+ </entry>
+ <entry>
+ <!-- DFL -->
+ </entry>
+ <entry>
+ <!-- DSC -->
+ </entry>
+
+</row>
+<row>
+
+ <entry>
+ joiner
+ </entry>
+ <entry>
+ <!-- POS -->
+ </entry>
+ <entry>
+ <!-- REQ -->
+ </entry>
+ <entry>
+ <!-- DFL -->
+ </entry>
+ <entry>
+ <!-- DSC -->
+ </entry>
+
+</row>
+&ROW_INTERPOLATE_0;
+&ROW_REPARSE_1;
+__END__
1.2 +3 -0 xmldocs/refs/dbinfo.tag
rev 1.2, prev_rev 1.1
Index: dbinfo.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/dbinfo.tag,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- dbinfo.tag 17 Feb 2005 23:25:39 -0000 1.1
+++ dbinfo.tag 13 Dec 2006 22:48:11 -0000 1.2
@@ -0,0 +1,3 @@
+__NAME__ purpose
+(obsolete)
+__END__
1.2 +45 -1 xmldocs/refs/diff.tag
rev 1.2, prev_rev 1.1
Index: diff.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/diff.tag,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- diff.tag 17 Feb 2005 23:25:39 -0000 1.1
+++ diff.tag 13 Dec 2006 22:48:11 -0000 1.2
@@ -2,6 +2,50 @@
<row>
<entry>
+ <group choice='opt'>
+ <arg>current</arg>
+ <arg>curr</arg>
+ </group>
+ </entry>
+ <entry>
+ Yes
+ </entry>
+ <entry>
+ <!-- REQ -->
+ </entry>
+ <entry>
+ <!-- DFL -->
+ </entry>
+ <entry>
+ <!-- DSC -->
+ </entry>
+
+</row>
+<row>
+
+ <entry>
+ <group choice='opt'>
+ <arg>previous</arg>
+ <arg>prev</arg>
+ </group>
+ </entry>
+ <entry>
+ Yes
+ </entry>
+ <entry>
+ <!-- REQ -->
+ </entry>
+ <entry>
+ <!-- DFL -->
+ </entry>
+ <entry>
+ <!-- DSC -->
+ </entry>
+
+</row>
+<row>
+
+ <entry>
flags
</entry>
<entry>
@@ -96,4 +140,4 @@
</row>
&ROW_INTERPOLATE_0;
&ROW_REPARSE_1;
-__END__
\ No newline at end of file
+__END__
1.2 +42 -0 xmldocs/refs/directive_value.tag
rev 1.2, prev_rev 1.1
Index: directive_value.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/directive_value.tag,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- directive_value.tag 17 Feb 2005 23:25:39 -0000 1.1
+++ directive_value.tag 13 Dec 2006 22:48:11 -0000 1.2
@@ -0,0 +1,42 @@
+__NAME__ synopsis
+<row>
+
+ <entry>
+ <arg>name</arg>
+ </entry>
+ <entry>
+ Yes
+ </entry>
+ <entry>
+ <!-- REQ -->
+ </entry>
+ <entry>
+ <!-- DFL -->
+ </entry>
+ <entry>
+ <!-- DSC -->
+ </entry>
+
+</row>
+<row>
+
+ <entry>
+ <arg>unparse</arg>
+ </entry>
+ <entry>
+ Yes
+ </entry>
+ <entry>
+ <!-- REQ -->
+ </entry>
+ <entry>
+ <!-- DFL -->
+ </entry>
+ <entry>
+ <!-- DSC -->
+ </entry>
+
+</row>
+&ROW_INTERPOLATE_0;
+&ROW_REPARSE_1;
+__END__
1.8 +38 -0 xmldocs/refs/discount
rev 1.8, prev_rev 1.7
Index: discount
===================================================================
RCS file: /var/cvs/xmldocs/refs/discount,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- discount 5 Oct 2006 10:08:20 -0000 1.7
+++ discount 13 Dec 2006 22:48:11 -0000 1.8
@@ -3,6 +3,44 @@
implement per-customer item or order discounts
__END__
+__NAME__ synopsis
+<row>
+ <entry>code</entry>
+ <entry>Yes</entry>
+ <entry></entry>
+ <entry></entry>
+ <entry></entry>
+</row>
+<row>
+ <entry>
+ <group choice='opt'>
+ <arg>discount_space</arg>
+ <arg>space</arg>
+ </group>
+ </entry>
+ <entry></entry>
+ <entry></entry>
+ <entry></entry>
+ <entry></entry>
+</row>
+<row>
+ <entry>subtract</entry>
+ <entry></entry>
+ <entry></entry>
+ <entry></entry>
+ <entry></entry>
+</row>
+<row>
+ <entry>level</entry>
+ <entry></entry>
+ <entry></entry>
+ <entry></entry>
+ <entry></entry>
+</row>
+ROW_INTERPOLATE_0;
+ROW_REPARSE_1;
+__END__
+
__NAME__ description
The tag is used to implement per-customer discounts. Discounts can
be applied to individual items, groups of items, or total orders.
1.2 +58 -1 xmldocs/refs/export-database.tag
rev 1.2, prev_rev 1.1
Index: export-database.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/export-database.tag,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- export-database.tag 17 Feb 2005 23:25:39 -0000 1.1
+++ export-database.tag 13 Dec 2006 22:48:11 -0000 1.2
@@ -2,6 +2,63 @@
<row>
<entry>
+ table
+ </entry>
+ <entry>
+ Yes
+ </entry>
+ <entry>
+ <!-- REQ -->
+ </entry>
+ <entry>
+ <!-- DFL -->
+ </entry>
+ <entry>
+ <!-- DSC -->
+ </entry>
+
+</row>
+<row>
+
+ <entry>
+ file
+ </entry>
+ <entry>
+ Yes
+ </entry>
+ <entry>
+ <!-- REQ -->
+ </entry>
+ <entry>
+ <!-- DFL -->
+ </entry>
+ <entry>
+ <!-- DSC -->
+ </entry>
+
+</row>
+<row>
+
+ <entry>
+ type
+ </entry>
+ <entry>
+ Yes
+ </entry>
+ <entry>
+ <!-- REQ -->
+ </entry>
+ <entry>
+ <!-- DFL -->
+ </entry>
+ <entry>
+ <!-- DSC -->
+ </entry>
+
+</row>
+<row>
+
+ <entry>
delete
</entry>
<entry>
@@ -77,4 +134,4 @@
</row>
&ROW_INTERPOLATE_0;
&ROW_REPARSE_1;
-__END__
\ No newline at end of file
+__END__
1.4 +1 -1 xmldocs/refs/export.tag
rev 1.4, prev_rev 1.3
Index: export.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/export.tag,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- export.tag 24 Jan 2006 16:06:47 -0000 1.3
+++ export.tag 13 Dec 2006 22:48:11 -0000 1.4
@@ -6,7 +6,7 @@
<row>
<entry>
- <group choice='opt'>
+ <group>
<arg choice='plain'>table</arg>
<arg choice='plain'>database</arg>
<arg choice='plain'>base</arg>
1.2 +49 -0 xmldocs/refs/fcounter.tag
rev 1.2, prev_rev 1.1
Index: fcounter.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/fcounter.tag,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- fcounter.tag 17 Feb 2005 23:25:39 -0000 1.1
+++ fcounter.tag 13 Dec 2006 22:48:11 -0000 1.2
@@ -0,0 +1,49 @@
+__NAME__ purpose
+__END__
+
+__NAME__ synopsis
+<row>
+
+ <entry>
+ <arg choice='plain'>file</arg>
+ </entry>
+ <entry>
+ Yes
+ </entry>
+ <entry>
+ <!-- REQ -->
+ </entry>
+ <entry>
+ </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>
+ </entry>
+ <entry>
+ </entry>
+
+</row>
+&ROW_INTERPOLATE_0;
+&ROW_REPARSE_1;
+__END__
+
+
+__NAME__ description
+__END__
+
+
1.2 +54 -30 xmldocs/refs/handling.tag
rev 1.2, prev_rev 1.1
Index: handling.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/handling.tag,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- handling.tag 17 Feb 2005 23:25:39 -0000 1.1
+++ handling.tag 13 Dec 2006 22:48:11 -0000 1.2
@@ -1,42 +1,66 @@
-__NAME__ synopsis
-<row>
+__NAME__ purpose
+calculate and display handling costs
+__END__
- <entry>
- default
- </entry>
- <entry>
- <!-- POS -->
- </entry>
- <entry>
- <!-- REQ -->
- </entry>
- <entry>
- <!-- DFL -->
- </entry>
- <entry>
- <!-- DSC -->
- </entry>
-</row>
+__NAME__ synopsis
<row>
-
<entry>
- handling
- </entry>
+ <group>
+ <arg choice='plain'>mode</arg>
+ <arg choice='plain'>modes</arg>
+ <arg choice='plain'>name</arg>
+ </group>
+ </entry>
+ <entry>Yes</entry><entry></entry>
+ <entry></entry>
+ <entry>.</entry>
+</row>
+<row>
<entry>
- <!-- POS -->
- </entry>
+ <group>
+ <arg choice='plain'>cart</arg>
+ <arg choice='plain'>carts</arg>
+ </group>
+ </entry>
+ <entry></entry><entry></entry>
+ <entry></entry>
+ <entry>.</entry>
+</row>
+<row>
<entry>
- <!-- REQ -->
- </entry>
+ <group>
+ <arg choice='plain'>table</arg>
+ <arg choice='plain'>tables</arg>
+ </group>
+ </entry>
+ <entry></entry><entry></entry>
+ <entry></entry>
+ <entry>.</entry>
+</row>
+&ROW_CURRENCYNOFORMAT;
+<row>
<entry>
- <!-- DFL -->
+ <arg choice='plain'>convert</arg>
</entry>
+ <entry></entry><entry></entry>
+ <entry></entry>
+ <entry>.</entry>
+</row>
+<row>
<entry>
- <!-- DSC -->
+ <arg choice='plain'>default</arg>
</entry>
-
-</row>
+ <entry></entry><entry></entry>
+ <entry></entry>
+ <entry>.</entry>
+</row>
&ROW_INTERPOLATE_0;
&ROW_REPARSE_1;
-__END__
\ No newline at end of file
+__END__
+
+
+__NAME__ description
+__END__
+
+
1.2 +83 -1 xmldocs/refs/harness.tag
rev 1.2, prev_rev 1.1
Index: harness.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/harness.tag,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- harness.tag 17 Feb 2005 23:25:39 -0000 1.1
+++ harness.tag 13 Dec 2006 22:48:11 -0000 1.2
@@ -39,4 +39,86 @@
</row>
&ROW_INTERPOLATE_0;
&ROW_REPARSE_1;
-__END__
\ No newline at end of file
+__END__
+
+
+
+H2: harness
+
+Test harness block. Similar to try/catch. Interprets the body text and checks the return value against expected and explicitly bad cases.
+
+Returns DIED, OK, or NOT OK message along with your result if not the expected value.
+
+H3: Summary
+
+!block example;
+ [B<harness> I<other_named_attributes>]
+!endblock
+
+!block table; colvaligns="TTT"; format="262"
+Parameters|Description|Default
+{{CMD[jump="#harness_expected"]expected}}|<<
+Tagname for delimiting your expected return value (default "OK")
+>>|DEFAULT_VALUE
+{{CMD[jump="#harness_name"]name}}|<<
+This will appear in your output message (useful for distinguishing harness tags from one another) (default "testI<nnn>")
+>>|DEFAULT_VALUE
+!endblock
+
+!block table; colvaligns="TT"
+Attributes|Default
+{{CMD[jump="#attr_interpolate"]interpolate}}|I<No>
+{{CMD[jump="#attr_reparse"]reparse}}|I<Yes>
+!endblock
+
+!block table; headings=1; colvaligns="TT"
+A|B
+Other_Characteristics|
+Invalidates cache|I<no>
+Container tag|I<Yes>
+Has Subtags|I<No>
+Nests|I<No>
+!endblock
+
+
+B<Tag expansion example:>
+
+!block example
+ [harness]
+---
+ TODO: (tag result)
+!endblock
+
+
+B<ASP-like Perl call:>
+
+!block example; lang="Perl"
+ $Tag->harness( {
+}, $body );
+!endblock
+
+or similarly with positional parameters,
+
+!block example; lang="Perl"
+ $Tag->harness(, $attribute_hash_reference, $body);
+!endblock
+
+H3: Description
+
+
+Test harness block. Similar to try/catch. Interprets the body text and checks the return value against expected and explicitly bad cases.
+
+Returns DIED, OK, or NOT OK message along with the harness name and your result if not the expected value.
+
+
+
+# BEGIN ############ harness Subsections ##############
+H4: {{CMD[id="harness_expected"]expected}}
+
+Tagname for delimiting your expected return value (default "OK")
+
+
+H4: {{CMD[id="harness_name"]name}}
+
+This will appear in your output message (useful for distinguishing harness tags from one another) (default "testI<nnn>")
+
1.2 +151 -9 xmldocs/refs/html-table.tag
rev 1.2, prev_rev 1.1
Index: html-table.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/html-table.tag,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- html-table.tag 17 Feb 2005 23:25:39 -0000 1.1
+++ html-table.tag 13 Dec 2006 22:48:11 -0000 1.2
@@ -1,3 +1,7 @@
+__NAME__ purpose
+output HTML table
+__END__
+
__NAME__ synopsis
<row>
@@ -14,7 +18,9 @@
<!-- DFL -->
</entry>
<entry>
- <!-- DSC -->
+ Names for the columns, separated by whitespace (<literal>\s+</literal>).
+ If the <option>th</option> attribute is used, this one is ignored, so the
+ column names must be passed as the first row of table input data.
</entry>
</row>
@@ -30,10 +36,11 @@
<!-- REQ -->
</entry>
<entry>
- <!-- DFL -->
+ <literal>\t</literal>
</entry>
<entry>
- <!-- DSC -->
+ Field delimiter to use if the data is provided in-place (in the tag
+ body) instead of as an &glos-array; reference.
</entry>
</row>
@@ -49,15 +56,51 @@
<!-- REQ -->
</entry>
<entry>
- <!-- DFL -->
+ <literal>\n</literal>
</entry>
<entry>
- <!-- DSC -->
+ Record delimiter to use if the data is provided in-place (in the tag
+ body) instead of as an &glos-array; reference.
</entry>
</row>
<row>
-
+ <entry>
+ tr
+ </entry>
+ <entry>
+ <!-- POS -->
+ </entry>
+ <entry>
+ <!-- REQ -->
+ </entry>
+ <entry>
+ <!-- DFL -->
+ </entry>
+ <entry>
+ Extra arguments for each table row. Any arguments you place
+ here will render as <tr <replaceable>ARGUMENTS</replaceable>>.
+ </entry>
+</row>
+<row>
+ <entry>
+ td
+ </entry>
+ <entry>
+ <!-- POS -->
+ </entry>
+ <entry>
+ <!-- REQ -->
+ </entry>
+ <entry>
+ <!-- DFL -->
+ </entry>
+ <entry>
+ Extra arguments for each table cell. Any arguments you place
+ here will render as <td <replaceable>ARGUMENTS</replaceable>>.
+ </entry>
+</row>
+<row>
<entry>
th
</entry>
@@ -71,10 +114,109 @@
<!-- DFL -->
</entry>
<entry>
- <!-- DSC -->
+ Extra arguments for table header. Any arguments you place
+ here will render as <th <replaceable>ARGUMENTS</replaceable>>.
+ When this attribute is used, <option>columns</option> is ignored.
+ </entry>
+</row>
+<row>
+ <entry>
+ fc
+ </entry>
+ <entry>
+ <!-- POS -->
+ </entry>
+ <entry>
+ <!-- REQ -->
+ </entry>
+ <entry>
+ <!-- DFL -->
+ </entry>
+ <entry>
+ Extra arguments for the first table column. Any arguments you place
+ here will render as <td <replaceable>ARGUMENTS</replaceable>>.
+ </entry>
+</row>
+<row>
+ <entry>
+ fr
+ </entry>
+ <entry>
+ <!-- POS -->
+ </entry>
+ <entry>
+ <!-- REQ -->
+ </entry>
+ <entry>
+ <!-- DFL -->
+ </entry>
+ <entry>
+ Extra arguments for the first table row. Any arguments you place
+ here will render as <tr <replaceable>ARGUMENTS</replaceable>>.
</entry>
-
</row>
&ROW_INTERPOLATE_0;
&ROW_REPARSE_1;
-__END__
\ No newline at end of file
+__END__
+
+
+
+__NAME__ description
+This tag creates an &glos-HTML; table by auto-inserting the appropriate
+HTML markup. Table data can either be provided in-place (within the
+tag body), or passed as a &glos-array; reference.
+</para><para>
+The enclosing <table> &glos-HTML; tag is not included, you have
+to include it yourself.
+__END__
+
+
+
+__NAME__ notes
+Since the tag body responds to TABs (<literal>\t</literal>) and
+newlines (<literal>\n</literal>) by default, make sure that the table
+input data is not indented.
+</para><para>
+Separate fields using exactly one field delimiter (one TAB, for example);
+multiple delimiters in a row will imply empty cells.
+__END__
+
+
+__NAME__ online: Creating an HTML table using in-place data
+<programlisting><![CDATA[
+<table width="90%" border="1">
+
+[html-table fc="bgcolor='red'" fr="bgcolor='blue'" th="bgcolor='yellow'"]
+title1 title2 title3
+r1c1 r1c2 r1c3
+r2c1 r2c2 r2c3
+r3c1 r3c2 r3c3
+[/html-table]
+
+</table>
+]]></programlisting>
+__END__
+
+__NAME__ online: Creating an HTML table using an array reference
+<programlisting><![CDATA[
+
+[calc]
+ $Scratch->{table} = (
+ [qw/title1 title2 title3/],
+ ['r1c1', 'r1c2', 'r1c3'],
+ [qw/r2c1 r2c2 r2c3/],
+ [qw/r3c1 r3c2 r3c3/],
+ );
+[/calc]
+
+<table width="90%" border="1">
+[html-table body=`$Scratch->{table}` /]
+</table>
+
+]]></programlisting>
+__END__
+
+
+__NAME__ missing
+The arry-passing example is not working
+__END__
1.2 +112 -0 xmldocs/refs/import.tag
rev 1.2, prev_rev 1.1
Index: import.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/import.tag,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- import.tag 17 Feb 2005 23:25:39 -0000 1.1
+++ import.tag 13 Dec 2006 22:48:11 -0000 1.2
@@ -0,0 +1,112 @@
+__NAME__ purpose
+import records into database
+__END__
+
+
+__NAME__ synopsis
+<row>
+ <entry>
+ <group>
+ <arg choice='plain'>table</arg>
+ <arg choice='plain'>base</arg>
+ <arg choice='plain'>database</arg>
+ </group>
+ </entry>
+ <entry>Yes</entry><entry>Yes</entry>
+ <entry></entry>
+ <entry>.</entry>
+</row>
+<row>
+ <entry><arg choice='plain'>type</arg></entry>
+ <entry>Yes</entry><entry></entry>
+ <entry></entry>
+ <entry>
+ </entry>
+</row>
+<row>
+ <entry><arg choice='plain'>continue</arg></entry>
+ <entry></entry><entry></entry>
+ <entry></entry>
+ <entry>
+ </entry>
+</row>
+<row>
+ <entry><arg choice='plain'>separator</arg></entry>
+ <entry></entry><entry></entry>
+ <entry></entry>
+ <entry>
+ </entry>
+</row>
+<row>
+ <entry><arg choice='plain'>file</arg></entry>
+ <entry></entry><entry></entry>
+ <entry></entry>
+ <entry>.</entry>
+</row>
+&ROW_INTERPOLATE_0;
+&ROW_REPARSE_1;
+__END__
+
+
+__NAME__ see also
+export
+__END__
+
+
+__NAME__ notes
+__END__
+
+
+__NAME__ description
+The &tag-__FILENAME__; tag is used to import records into a
+&glos-database;.
+</para><para>
+The <option>table</option> (database) must already be registered
+with &IC; using the &conf-Database; directive; tables cannot be created
+on the fly.
+__END__
+
+
+
+
+Named attributes:
+
+> [import table=table_name
+> type=(TAB|PIPE|CSV|%%|LINE)
+> continue=(NOTES|UNIX|DITTO)
+> separator=c]
+
+Import one or more records into a database. The C<type> is any
+of the valid Interchange delimiter types, with the default being defined
+by the setting of the database I<DELIMITER>. The table must already be a defined
+Interchange database table; it cannot be created on the fly. (If you need
+that, it is time to use SQL.)
+
+The C<type> of C<LINE> and C<continue> setting of C<NOTES> is particularly
+useful, for it allows you to name your fields and not have to remember
+the order in which they appear in the database. The following two imports
+are identical in effect:
+
+> [import table=orders]
+> code: [value mv_order_number]
+> shipping_mode: [shipping-description]
+> status: pending
+> [/import]
+>
+> [import table=orders]
+> shipping_mode: [shipping-description]
+> status: pending
+> code: [value mv_order_number]
+> [/import]
+
+The C<code> or key must always be present, and is always named C<code>.
+
+If you do not use C<NOTES> mode, you must import the fields in the
+same order as they appear in the ASCII source file.
+
+The C<[import ....] TEXT [/import]> region may contain multiple records.
+If using C<NOTES> mode, you must use a separator, which by default is
+a form-feed character (^L).
+
+
+
1.3 +4 -17 xmldocs/refs/include.tag
rev 1.3, prev_rev 1.2
Index: include.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/include.tag,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- include.tag 9 Aug 2005 17:01:01 -0000 1.2
+++ include.tag 13 Dec 2006 22:48:11 -0000 1.3
@@ -16,25 +16,11 @@
<!-- DFL -->
</entry>
<entry>
- Filename to include. Can't be arbitrary file
+ Filename to include. Can only be a relative filename
if &conf-NoAbsolute; is set.
</entry>
</row>
-<row>
- <entry>
- locale
- </entry>
- <entry>
- </entry>
- <entry>
- </entry>
- <entry>
- 1
- </entry>
- <entry>
- Honor locales?
- </entry>
-</row>
+&ROW_LOCALE_1;
&ROW_INTERPOLATE_1;
&ROW_REPARSE_1;
__END__
@@ -47,7 +33,8 @@
are not allowed if the &IC; server administrator
has enabled &conf-NoAbsolute;.
</para><para>
-File contents are inserted and reparsed for tags.
+File contents are inserted and then, by default, reparsed for &glos-ITL;
+tags.
</para><para>
The maximum number of circular inclusions is controlled by the
&conf-Limit; directive, using key <literal>include_depth</literal>.
1.4 +40 -32 xmldocs/refs/log.tag
rev 1.4, prev_rev 1.3
Index: log.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/log.tag,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- log.tag 12 Jul 2006 15:10:35 -0000 1.3
+++ log.tag 13 Dec 2006 22:48:11 -0000 1.4
@@ -1,12 +1,15 @@
__NAME__ purpose
-write custom message to log file
+write custom message to arbitrary log file
__END__
__NAME__ synopsis
<row>
<entry>
- file
+ <group>
+ <arg choice='plain'>file</arg>
+ <arg choice='plain'>arg</arg>
+ </group>
</entry>
<entry>
Yes
@@ -18,7 +21,7 @@
<!-- DFL -->
</entry>
<entry>
- <!-- DSC -->
+ Name of the log file.
</entry>
</row>
@@ -34,10 +37,11 @@
<!-- REQ -->
</entry>
<entry>
- <!-- DFL -->
+ No. Yes if <option>file</option> begins with
+ "<literal>></literal>".
</entry>
<entry>
- <!-- DSC -->
+ Create the log file if it doesn't exist?
</entry>
</row>
@@ -53,10 +57,14 @@
<!-- REQ -->
</entry>
<entry>
- <!-- DFL -->
+ Strip leading and trailing whitespace, "normalize" newlines.
</entry>
<entry>
- <!-- DSC -->
+ Special actions to perform on the log message before writing to the
+ log file. By default, this includes removing leading and trailing whitespace,
+ and forcing every <literal>\r\n</literal> sequence to a single Unix
+ line-feed character (<literal>\n</literal>). Use "<literal>nostrip</literal>"
+ to prevent stripping.
</entry>
</row>
@@ -75,7 +83,15 @@
<!-- DFL -->
</entry>
<entry>
- <!-- DSC -->
+ Log type to produce. Possible options are <literal>text</literal>
+ (the usual), <literal>quot</literal> (quotes each field, where fields
+ are separated by <option>record_delim</option>), <literal>error</literal>
+ (formats and logs message like standard Interchange error message) and
+ <literal>debug</literal> (formats and logs message like standard
+ Interchange debug message). Options <literal>error</literal> and
+ <literal>debug</literal> actually invoke &IC;'s
+ <function>logError</function> or <function>logDebug</function> functions
+ in addition to writing to the specified log file.
</entry>
</row>
@@ -91,10 +107,10 @@
<!-- REQ -->
</entry>
<entry>
- <!-- DFL -->
+ &NEWLINE;
</entry>
<entry>
- <!-- DSC -->
+ Record delimiter.
</entry>
</row>
@@ -113,33 +129,25 @@
<!-- DFL -->
</entry>
<entry>
- <!-- DSC -->
- </entry>
-
-</row>
-<row>
-
- <entry>
- hide
- </entry>
- <entry>
- <!-- POS -->
- </entry>
- <entry>
- <!-- REQ -->
- </entry>
- <entry>
- <!-- DFL -->
- </entry>
- <entry>
- <!-- DSC -->
+ Line delimiter.
</entry>
</row>
+&ROW_HIDE_0;
&ROW_INTERPOLATE_0;
&ROW_REPARSE_1;
__END__
__NAME__ see also
-LogFile
-__END__
\ No newline at end of file
+LogFile, DEBUG
+__END__
+
+__NAME__ description
+The &tag-__FILENAME__; tag is used to write custom, possibly multiline,
+log messages to arbitrary log files.
+__END__
+
+
+__NAME__ missing
+in sub log (Interpolate), qw/delim record_delim/ should be qw/delimiter record_delim/, right ?
+__END__
1.3 +2 -1 xmldocs/refs/page.tag
rev 1.3, prev_rev 1.2
Index: page.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/page.tag,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- page.tag 29 Nov 2006 23:07:45 -0000 1.2
+++ page.tag 13 Dec 2006 22:48:11 -0000 1.3
@@ -57,7 +57,8 @@
after typing in the link text. There is a <code>[/page]</code> macro
in existence, but it translates directly to <literal></a></literal>
— which means typing <literal></a></literal> directly
-saves parser a little work. In any case, the use of this macro is discouraged.
+saves parser a little work. The use of this macro is discouraged
+and you should always insert "<literal></a></literal>" directly.
__END__
1.10 +1 -1 xmldocs/refs/time.tag
rev 1.10, prev_rev 1.9
Index: time.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/time.tag,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- time.tag 2 Nov 2006 21:19:00 -0000 1.9
+++ time.tag 13 Dec 2006 22:48:11 -0000 1.10
@@ -138,7 +138,7 @@
<row>
<entry>
- <group choice='opt'>
+ <group>
<arg choice='plain'>format</arg><arg choice='plain'>fmt</arg>
</group>
</entry>
1.1 xmldocs/refs/CAPTCHA_IMAGE_LOCATION
rev 1.1, prev_rev 1.0
Index: CAPTCHA_IMAGE_LOCATION
===================================================================
__NAME__ purpose
specify directory containing generated "captcha" images
__END__
__NAME__ synopsis
<replaceable>directory_name</replaceable>
__END__
__NAME__ description
The variable specifies a directory where the generated &glos-captcha;
image files should be saved to.
</para><para>
This directory must also be available as a web server location.
__END__
__NAME__ example
<programlisting>
Variable __FILENAME__ __DOCROOT__/images/captcha/
</programlisting>
__END__
__NAME__ see also
DOCROOT
__END__
1.1 xmldocs/refs/CAPTCHA_IMAGE_PATH
rev 1.1, prev_rev 1.0
Index: CAPTCHA_IMAGE_PATH
===================================================================
__NAME__ purpose
specify web server path containing "captcha" images
__END__
__NAME__ synopsis
<replaceable>location</replaceable>
__END__
__NAME__ description
The variable specifies a web server location where the generated
&glos-captcha; image files are found, and from where they can
be requested by clients.
__END__
__NAME__ example
<programlisting>
Variable __FILENAME__ /images/captcha/
</programlisting>
__END__
__NAME__ see also
DOCROOT, CAPTCHA_IMAGE_LOCATION
__END__
1.1 xmldocs/refs/CAPTCHA_IMAGE_SUBDIR
rev 1.1, prev_rev 1.0
Index: CAPTCHA_IMAGE_SUBDIR
===================================================================
__NAME__ purpose
specify subdirectory containing "captcha" images
__END__
__NAME__ synopsis
<replaceable>subdirectory_name</replaceable>
__END__
__NAME__ description
The variable specifies just a subdirectory name where the generated
&glos-captcha; image are to be saved, and from where they can
be requested by clients.
__END__
__NAME__ example
<programlisting>
Variable __FILENAME__ captcha/
</programlisting>
__END__
__NAME__ see also
DOCROOT, CAPTCHA_IMAGE_LOCATION, CAPTCHA_IMAGE_PATH
__END__
More information about the docs
mailing list