You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@myfaces.apache.org by lf...@apache.org on 2006/09/07 21:35:11 UTC
svn commit: r441187 - in /myfaces/tomahawk/trunk/sandbox/core/src/site:
site.xml xdoc/CSVvalidator.xml xdoc/validateCSV.xml
Author: lfrohman
Date: Thu Sep 7 12:35:11 2006
New Revision: 441187
URL: http://svn.apache.org/viewvc?view=rev&rev=441187
Log:
minor change to sandbox documentation
Added:
myfaces/tomahawk/trunk/sandbox/core/src/site/xdoc/validateCSV.xml
Removed:
myfaces/tomahawk/trunk/sandbox/core/src/site/xdoc/CSVvalidator.xml
Modified:
myfaces/tomahawk/trunk/sandbox/core/src/site/site.xml
Modified: myfaces/tomahawk/trunk/sandbox/core/src/site/site.xml
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/sandbox/core/src/site/site.xml?view=diff&rev=441187&r1=441186&r2=441187
==============================================================================
--- myfaces/tomahawk/trunk/sandbox/core/src/site/site.xml (original)
+++ myfaces/tomahawk/trunk/sandbox/core/src/site/site.xml Thu Sep 7 12:35:11 2006
@@ -47,6 +47,7 @@
<menu name="Validators">
<item name="validateCompareTo" href="validateCompareTo.html"/>
+ <item name="validateCSV" href="validateCSV.html"/>
</menu>
Added: myfaces/tomahawk/trunk/sandbox/core/src/site/xdoc/validateCSV.xml
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/sandbox/core/src/site/xdoc/validateCSV.xml?view=auto&rev=441187
==============================================================================
--- myfaces/tomahawk/trunk/sandbox/core/src/site/xdoc/validateCSV.xml (added)
+++ myfaces/tomahawk/trunk/sandbox/core/src/site/xdoc/validateCSV.xml Thu Sep 7 12:35:11 2006
@@ -0,0 +1,87 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+ <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation Maven//EN" "http://maven.apache.org/dtd/maven-xdoc.dtd">
+
+ <!--
+This is a standard template meant to be used for the documentation of all custom
+components.
+--><document>
+
+ <body>
+ <!-- Description -->
+ <section name="Description">
+
+ <p>
+ Validate by separating comma (or custom separator) separated values (CSV) and validating them individually with a given validator
+ </p>
+ </section>
+ <!-- screen shot -->
+ <section name="Screen Shot">
+
+ <p>Not Available</p> <!-- replace with either a figure or Not Available -->
+ </section>
+ <!-- API -->
+ <section name="API">
+
+ <table>
+ <tr>
+ <td colspan="1" rowspan="1">validatorId</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.validator.csv</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">validator-class</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.custom.csvvalidator.CSVValidator</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">tag-class</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.custom.csvvalidator.ValidateCSVTag</td>
+ </tr>
+ </table>
+ </section>
+
+ <!-- Usage -->
+ <section name="Usage">
+
+ <source xml:space="preserve">
+ <f:verbatim>enter credit card numbers, separated by a period:</f:verbatim>
+ <h:inputText id="creditCardNumber" value="#{backingBean.creditCardNumbers}" required="true">
+ <s:validateCSV subvalidatorId="org.apache.myfaces.validator.CreditCard" separator="\\." />
+ </h:inputText>
+ </source>
+ </section>
+
+ <!-- Syntax -->
+ <section name="Syntax">
+
+ <blockquote><h3><s:validateCSV/></h3>
+ <code>subvalidatorId - Required validator ID of actual validator.</code><br/>
+ <code>separator = Optional custom separator (default is ,)</code><br/>
+ </blockquote>
+ </section>
+
+ <!-- Instructions -->
+ <section name="Instructions">
+
+ <p>
+ Use this validator to allow users to enter multiple input values in a single input,
+ separated by a comma, semicolon, or other custom separator. The CSVValidator will
+ separate the input values and call the subvalidator for each of those values.
+ </p>
+ <p>See "myfaces-example-sandbox/validatecsv.jsp" for an example.</p>
+ </section>
+
+ <!-- Additional Information -->
+ <section name="Known issues">
+
+ <p>
+ The separator, if specified, must be a valid regex for separating the input String, eq "\\."
+ </p>
+ <p>
+ Parameters cannot be passed.
+ </p>
+ </section>
+
+ </body>
+
+
+</document>