[interchange-docs] xmldocs - docelic modified 2 files
docs at icdevgroup.org
docs at icdevgroup.org
Sat Aug 12 17:14:40 EDT 2006
User: docelic
Date: 2006-08-12 21:14:40 GMT
Modified: refs PageSelectField error.tag
Log:
- Small update to PageSelectField
- Work on [error] tag
Revision Changes Path
1.2 +1 -1 xmldocs/refs/PageSelectField
rev 1.2, prev_rev 1.1
Index: PageSelectField
===================================================================
RCS file: /var/cvs/xmldocs/refs/PageSelectField,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- PageSelectField 25 May 2005 09:36:50 -0000 1.1
+++ PageSelectField 12 Aug 2006 21:14:40 -0000 1.2
@@ -14,7 +14,7 @@
Sets a <database>products</database> database column which can be used to
select the on-the-fly template page (the &glos-flypage;). This allows
multiple flypages to be defined and selected automatically. If the field
-is empty (no spaces!), the default will be used.
+is empty (no spaces!), the default, <literal>flypage</literal>, will be used.
__END__
__NAME__ example: Setting PageSelectField
1.4 +82 -22 xmldocs/refs/error.tag
rev 1.4, prev_rev 1.3
Index: error.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/error.tag,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- error.tag 29 Mar 2006 12:34:10 -0000 1.3
+++ error.tag 12 Aug 2006 21:14:40 -0000 1.4
@@ -12,13 +12,14 @@
Yes
</entry>
<entry>
- <!-- REQ -->
+ Yes
</entry>
<entry>
- <!-- DFL -->
+ <literal>default</literal>
</entry>
<entry>
- name of error variable, usually corresponds to an input field
+ Name of the error, usually corresponds to the name of a &glos-form; input
+ field in which the error ocurred.
</entry>
</row>
@@ -34,10 +35,12 @@
<!-- REQ -->
</entry>
<entry>
- <!-- DFL -->
+ No
</entry>
<entry>
- overwrite existing error messages instead of appending
+ Overwrite existing error messages for the specified
+ <literal>name</literal>? If this option is unset, the new error text
+ will be appended with the word "<literal> AND </literal>".
</entry>
</row>
@@ -56,7 +59,7 @@
<!-- DFL -->
</entry>
<entry>
- <!-- DSC -->
+ Error text to set.
</entry>
</row>
@@ -72,10 +75,11 @@
<!-- REQ -->
</entry>
<entry>
- <!-- DFL -->
+ Yes
</entry>
<entry>
- <!-- DSC -->
+ Preserve the error after display? (The error is otherwise automatically
+ deleted as soon as you retrieve its value.)
</entry>
</row>
@@ -110,10 +114,11 @@
<!-- REQ -->
</entry>
<entry>
- <!-- DFL -->
+ Yes if <literal>auto</literal> is enabled
</entry>
<entry>
- <!-- DSC -->
+ Display all error messages instead of just one pointed to by
+ <literal>name</literal>?
</entry>
</row>
@@ -129,10 +134,10 @@
<!-- REQ -->
</entry>
<entry>
- <!-- DFL -->
+ Yes if <literal>auto</literal> is enabled
</entry>
<entry>
- display errors
+ Show actual error messages instead of just reporting their count?
</entry>
</row>
@@ -151,7 +156,24 @@
<!-- DFL -->
</entry>
<entry>
- <!-- DSC -->
+ <!--
+
+ H4: {{CMD[id="error_std_label"]std_label}}
+
+ std_label=<label string for error message>
+
+ used with 'required' to display a standardized
+ error format. The HTML formatting can be set
+ via the global variable MV_ERROR_STD_LABEL with
+ the default being:
+
+ > <FONT COLOR=RED>{LABEL}<SMALL><I>(%s)</I></SMALL></FONT>
+
+ where {LABEL} is what you set std_label to and %s
+ is substituted with the error message. This option
+ can not be used with the text= option.
+
+ -->
</entry>
</row>
@@ -167,10 +189,10 @@
<!-- REQ -->
</entry>
<entry>
- <!-- DFL -->
+ Yes if <literal>auto</literal> is enabled
</entry>
<entry>
- whether to show variable name
+ Include error name in the display?
</entry>
</row>
@@ -186,10 +208,12 @@
<!-- REQ -->
</entry>
<entry>
- <!-- DFL -->
+ <literal><li></literal> if <literal>auto</literal> is enabled,
+ a newline (<literal>\n</literal>) otherwise
</entry>
<entry>
- <!-- DSC -->
+ Join element to use if multiple errors are to be displayed at once,
+ such as when <literal>all</literal> is enabled.
</entry>
</row>
@@ -208,7 +232,9 @@
<!-- DFL -->
</entry>
<entry>
- <!-- DSC -->
+ Optional string in which the actual error message should be embedded.
+ If the literal <literal>%s</literal> is present in the string, it will be
+ substituted for the message. Otherwise the error text is just appended.
</entry>
</row>
@@ -281,10 +307,18 @@
<!-- REQ -->
</entry>
<entry>
- <!-- DFL -->
+ No
</entry>
<entry>
- <!-- DSC -->
+ <!--
+ show_label=1 causes the field label set by a previous [error] tag's std_label attribute (see below) to be included as part of the error message, like this:
+ E:First Name: blank
+
+ If no std_label was set, the variable name will be used instead. This can also be used in combination with show_var to show both the label and the variable name.
+
+ show_label was added in 4.7.0.
+
+ -->
</entry>
</row>
@@ -319,15 +353,41 @@
<!-- REQ -->
</entry>
<entry>
- <!-- DFL -->
+ No
</entry>
<entry>
- <!-- DSC -->
+ Used for display purposes, as a hint to <literal>std_label</literal>.
+ Enabling this attribute allows the label to be printed differently for
+ required form fields. In the default label template, this means
+ <emphasis role='bold'>bold</emphasis> text, but in your custom labels
+ the behavior is, of course, arbitrary.
</entry>
</row>
&ROW_INTERPOLATE_0;
&ROW_REPARSE_1;
+__END__
+
+
+__NAME__ description
+The &tag-__FILENAME__; tag was designed to report meaningful error
+messages to the users, should an error ocurr in the &glos-form; processing
+action (such as missing or invalid field values entered).
+</para><para>
+It can work in conjunction with the definitions set in a &glos-profile;,
+and can generate error messages in any format you desire.
+<!--
+</para><para>
+Generally, if the variable in question passes order profile checking,
+the will
+output a label, by default B<bold> text if the item is required,
+or normal text if not (controlled by the <require> parameter. If
+the variable fails one or more order checks, the error message
+will be substituted into a template and the error cleared from
+the user's session.
+
+$Vend::Session-gt;{errors};
+-->
__END__
__NAME__ example
More information about the docs
mailing list