You are viewing a plain text version of this content. The canonical link for it is here.
Posted to taglibs-dev@jakarta.apache.org by gl...@apache.org on 2001/06/30 15:44:22 UTC
cvs commit: jakarta-taglibs/regexp/xml intro.xml regexp.xml
glenn 01/06/30 06:44:22
Added: regexp/xml intro.xml regexp.xml
Log:
Switch over to using the taglib documentation template
Revision Changes Path
1.1 jakarta-taglibs/regexp/xml/intro.xml
Index: intro.xml
===================================================================
<?xml version="1.0"?>
<document url="./intro.xml">
<properties>
<author>Glenn Nielsen</author>
<title>The Jakarta-Taglibs Project: Regexp Tag Library</title>
</properties>
<body>
<section name="Regexp Tag Library" href="Welcome">
<p>The Regexp custom tag library contains tags which can
be used to perform Perl syntax regular expressions.</p>
<p>These tags implement the 3 most common Perl5 operations
involving regular expressions:</p>
<ul>
<li>[m]/pattern/[i][m][s][x] </li>
<li>s/pattern/replacement/[g][i][m][o][s][x] </li>
<li>and split() </li>
</ul>
<p>As with Perl, any non-alphanumeric character can be used
in lieu of the slashes.</p>
</section>
<section name="Regexp News" href="News">
<news>
<newsitem date="06/20/2001">
Version 1.0 of the Regexp Tag Library released.
</newsitem>
</news>
</section>
<section name="Documentation" href="Documentation">
<p>For more information about the Regexp Tag Library,
look at the on-line documentation:</p>
<ul>
<!-- Uncomment this section and modify as needed when you start
doing releases of the taglib, a link can be made to each
available release.
<li>View the current release <a href="regexp/index.html">Regexp <release-version> Taglib Documentation</a></li>
-->
<li>View the development version of the <a href="index.html">Regexp Taglib Documentation</a></li>
</ul>
<p>For information on how to use the distributions,
look at the following documentation:</p>
<ul>
<li>Using the Jakarta-Taglibs <a href="http://jakarta.apache.org/taglibs/binarydist.html">Binary Distribution</a></li>
<li>Using the Jakarta-Taglibs <a href="http://jakarta.apache.org/taglibs/sourcedist.html">Source Distribution</a></li>
</ul>
</section>
<section name="Download" href="Download">
<!-- Uncomment this section and modify as needed when you start
doing releases of the taglib.
<p>Download a binary distribution of a Regexp Tag Library release</p>
<ul>
<li><strong>Download a <a href="http://jakarta.apache.org/builds/jakarta-taglibs/releases/regexp/">Regexp Tag Library release</a></strong></li>
</ul>
-->
<p>A download of the nightly development build for the Regexp Tag Library as a binary distribution is available</p>
<ul>
<li><strong>Download <a href="http://jakarta.apache.org/builds/jakarta-taglibs/nightly/projects/regexp/">Regexp Tag Library build</a></strong></li>
</ul>
<p>Nightly build distributions of the development version for all the Jakarta-Taglibs are available for download:</p>
<ul>
<li>Download <a href="http://jakarta.apache.org/builds/jakarta-taglibs/nightly/src/">Jakarta-Taglibs Source</a></li>
<li>Download entire <a href="http://jakarta.apache.org/builds/jakarta-taglibs/nightly">Jakarta-Taglibs Distribution</a></li>
</ul>
</section>
<section name="Contributors" href="Contributors">
<p>List of contributors:</p>
<ul>
<li>Glenn Nielsen</li>
</ul>
</section>
</body>
</document>
1.1 jakarta-taglibs/regexp/xml/regexp.xml
Index: regexp.xml
===================================================================
<?xml version="1.0" ?>
<!-- Change all instances of {taglib-name} with the jakarta-taglib
name for this tag library.
Change all instances of {display-name} with the name to use
for things such as titles in the tag library documentation.
Change <prefix>foo</prefix> below to a short prefix for this
tag library.
-->
<document url="./regexp.xml">
<!-- More properties can be added. Good place to stick loose
data needed elsewhere. -->
<properties>
<!-- The name here is used in the HTML <meta name="author"...> tag -->
<author>Glenn Nielsen</author>
</properties>
<!-- The following defines elements uses both to create the taglib
documentation and the tag library descriptor .tld file. The
elements used are those from the JSP 1.2 TLD DTD and special
elements used when creating the tagib documentation. Although
the JSP1.2 TLD DTD is used, this document can be used to
generate both a JSP 1.1 and a JSP 1.2 TLD.
-->
<taglib>
<!-- The following elements are from the JSP 1.2 TLD DTD -->
<!-- Version number of this tagib -->
<tlibversion>1.0</tlibversion>
<!-- Minimum version of JSP spec required -->
<jspversion>1.1</jspversion>
<!-- jakarta-taglib name of this tag library -->
<shortname>regexp</shortname>
<!-- URI of taglib -->
<uri>http://jakarta.apache.org/taglibs/regexp-1.0</uri>
<!-- The name to use in titles, etc. for the taglib -->
<display-name>Regexp Tag library</display-name>
<!-- JSP 1.2 tag library DTD only, not used for generating
documentation.
<large-icon></large-icon>
<small-icon></small-icon>
-->
<!-- Used for generating Overview section of HTML documentation
and for the description element for a JSP 1.2 TLD.
Enter information here as straight XHTML paragraphs. Inside the
paragraphs regular XHTML can be used (but an external CSS is
encouraged). The information is copied into the generated HTML doc,
and the <p> elements are essential for that. -->
<description>
<p>The Regexp custom tag library contains tags which can
be used to perform Perl syntax regular expressions.</p>
<p>These tags implement the three most common Perl5 operations
involving regular expressions:</p>
<ul>
<li>[m]/pattern/[i][m][s][x]</li>
<li>s/pattern/replacement/[g][i][m][o][s][x]</li>
<li>split()</li>
</ul>
<p>As with Perl, any non-alphanumeric character can be used
in lieu of the slashes.</p>
<p>For more information on how to use Perl syntax regular expressions
you can start at the
<a href="http://www.perl.com/pub/doc/manual/html/pod/perlre.html">
Perl Regular Expression</a> page. If you
<a href="http://www.google.com/search?q=perl+regular+expression">
search</a>
the web you can find thousands of web sites documenting how to use
perl regular expressions.</p>
</description>
<!-- The following elements are for JSP 1.2 tag libraries only,
and are not used for generating documentation yet.
<validator>
</validator>
<listener>
</listener>
-->
<!-- The taglib-location is used to fill in the web.xml configuration
information in the HTML doc. -->
<taglib-location>/WEB-INF/regexp.tld</taglib-location>
<!-- The prefix is used to fill in the taglib directive
configuration information in the HTML doc. -->
<prefix>rx</prefix>
<!-- This date must be straight text and is copied right into
the "Requirements" section of the HTML doc. -->
<requirements-info>
This custom tag library requires no software other than a servlet container
that supports the JavaServer Pages Specification, version 1.1 or higher.
And Version 2.0 of the <a href="http://jakarta.apache.org/oro/">
Jakarta ORO</a> Perl Regular Expression package.
</requirements-info>
<!-- The tagtoc element provides the ability to categorize the
tags in the tag library. There must be at least one tagtoc.
1 .. N tags can be nested within a tagtoc.
-->
<tagtoc name="Regexp Tags">
<tag>
<name>regexp</name>
<tagclass>org.apache.taglibs.regexp.RegexpTag</tagclass>
<bodycontent>JSP</bodycontent>
<display-name>regexp</display-name>
<description>
Create a regular expression script variable.
</description>
<!-- The next three non-standard elements are used to inform the relevant
sections of the HTML doc. See, for example, the Regexp
taglib docs for examples of the output. -->
<!-- One line summary of what tag does for Tag Summary section -->
<summary>Create a regular expression script variable.</summary>
<!-- Version of taglib when this tag became available,
deprecated is a possible value. -->
<availability>1.0</availability>
<!-- Any restrictions on use of the tag -->
<restrictions>
The body of the tag is assigned to a script variable
as a regular expression.
</restrictions>
<!-- Declaration of scripting variables created by tag.
Used for generating HTML documentation and for
JSP 1.2 DTD. -->
<variable>
<!-- name-given or name-from-attribute must be declared
<name-given>foo</name-given>
-->
<name-from-attribute>id</name-from-attribute>
<!-- Optional variable declarations -->
<!-- Package and class name of variable, default java.lang.String -->
<variable-class>org.apache.taglibs.regexp.RegexpData</variable-class>
<!-- Usage for declare is not clear in JSP1.2PFD, default true -->
<declare>true</declare>
<!-- scope of scripting variable, default NESTED -->
<scope>AT_BEGIN</scope>
<!-- description of scripting variable -->
<description>Regular Expression Bean</description>
<!-- Used for the HTML documentation only.
Version of taglib when this script variable became available,
deprecated is a possible value. -->
<availability>1.0</availability>
<!-- If the tag creates a script variable or attribute which
is a bean, the following declarations can be used to generate
HTML documentation for 0 .. N properties. -->
<beanprop>
<name>regexp</name>
<get>Yes</get>
<set>No</set>
<description>
Returns the text of the regular expression.
</description>
<availability>1.0</availability>
</beanprop>
</variable>
<attribute>
<name>id</name>
<required>true</required>
<rtexprvalue>false</rtexprvalue>
<!-- The following element is non-standard, but probably will be
standard in final JSP 1.2. For now it is only used for the HTML
doc. -->
<description>
Script variable id for use with standard <b>jsp:getProperty</b>
tag and as an attribute to other tags in this tag library.
</description>
<availability>1.0</availability>
</attribute>
<!-- The entire example section is for usage examples that you want to
have added to the HTML doc under "Example" for each tag. The
example section is also included with a JSP 1.2 TLD. The
contents of these elements are rendered into a simple form of
syntax highlighting by the XSL sheet. Multiple usage sections
are allowed, and each will be display as a separate example
in the resultant HTML. -->
<example>
<usage>
<!--Enter a JSP comment without the opening and closing tags.
Those will be added by the XSL. Put no HTML mark-up in here.
Currently, only one comment per usage section is supported. -->
<comment>
Create a match regular expression scripting variable.
</comment>
<!-- The code element is for an example of using the tag. I
normally put these in CDATA sections so that the XSL
transform to HTML will turn the angle brackets into the
appropriate < and > entities automatically. Only
one code element per usage element is supported.
The resultant HTML is formatted and colorized. -->
<code>
<![CDATA[<rx:regexp id="rx1">m/test1/mi</rx:regexp>
The regular expression is:
<jsp:getProperty name="rx1" property="regexp"/>]]>
</code>
</usage>
</example>
</tag>
<tag>
<name>text</name>
<tagclass>org.apache.taglibs.regexp.TextTag</tagclass>
<bodycontent>JSP</bodycontent>
<display-name>text</display-name>
<description>
Create a text string script variable for use with a regexp.
</description>
<summary>
Create a text string script variable for use with a regexp.
</summary>
<availability>1.0</availability>
<restrictions>
The body of the tag is assigned to a script variable
as a text string.
</restrictions>
<!-- Declaration of scripting variables created by tag.
Used for generating HTML documentation and for
JSP 1.2 DTD. -->
<variable>
<!-- name-given or name-from-attribute must be declared
<name-given>foo</name-given>
-->
<name-from-attribute>id</name-from-attribute>
<!-- Optional variable declarations -->
<!-- Package and class name of variable, default java.lang.String -->
<variable-class>org.apache.taglibs.regexp.TextData</variable-class>
<!-- Usage for declare is not clear in JSP1.2PFD, default true -->
<declare>true</declare>
<!-- scope of scripting variable, default NESTED -->
<scope>AT_BEGIN</scope>
<!-- description of scripting variable -->
<description>Text String Bean</description>
<!-- Used for the HTML documentation only.
Version of taglib when this script variable became available,
deprecated is a possible value. -->
<availability>1.0</availability>
<!-- If the tag creates a script variable or attribute which
is a bean, the following declarations can be used to generate
HTML documentation for 0 .. N properties. -->
<beanprop>
<name>text</name>
<get>Yes</get>
<set>No</set>
<description>Returns the text string.</description>
<availability>1.0</availability>
</beanprop>
</variable>
<attribute>
<name>id</name>
<required>true</required>
<rtexprvalue>false</rtexprvalue>
<description>
Script variable id for use with standard <b>jsp:getProperty</b>
tag and as an attribute to other tags in this tag library.
</description>
<availability>1.0</availability>
</attribute>
<example>
<usage>
<comment>Create a text string scripting variable.</comment>
<code>
<![CDATA[<rx:text id="tx1">This is a test string.</rx:regexp>
The text string is:
<jsp:getProperty name="tx1" property="text"/>]]>
</code>
</usage>
</example>
</tag>
<tag>
<name>existsmatch</name>
<tagclass>org.apache.taglibs.regexp.ExistsMatchTag</tagclass>
<bodycontent>JSP</bodycontent>
<display-name>existsmatch</display-name>
<description>
Uses a regexp to determine if a match exists in the text.
</description>
<summary>
Uses a regexp to determine if a match exists in the text.
</summary>
<availability>1.0</availability>
<restrictions>None</restrictions>
<attribute>
<name>regexp</name>
<required>true</required>
<rtexprvalue>false</rtexprvalue>
<description>
Script variable id of <b>regexp</b> to use for match.
</description>
<availability>1.0</availability>
</attribute>
<attribute>
<name>text</name>
<required>true</required>
<rtexprvalue>false</rtexprvalue>
<description>
Script variable id of <b>text</b> to check for a match.
</description>
<availability>1.0</availability>
</attribute>
<attribute>
<name>value</name>
<required>false</required>
<rtexprvalue>false</rtexprvalue>
<description>
If value is set to false the existsmatch tag includes body
of tag if a match does not exist.
</description>
<availability>1.0</availability>
</attribute>
<example>
<usage>
<comment>
Determine if a match can be found in a text string using a
regular expression.
</comment>
<code>
<![CDATA[<%-- create the match regexp "m/test1/mi" --%>
<rx:regexp id="rx1">m/test1/mi</rx:regexp>
<%-- set the text to match on --%>
<rx:text id="test">
This is a
test of regular expression matching.
</rx:text>
See if a match exists...<br>
<rx:existsmatch regexp="rx1" text="test">
A match was found!<br>
</rx:existsmatch>
<rx:existsmatch regexp="rx1" text="test" value="false">
A match was not found!<br>
</rx:existsmatch>]]>
</code>
</usage>
</example>
</tag>
<tag>
<name>substitute</name>
<tagclass>org.apache.taglibs.regexp.SubstituteTag</tagclass>
<bodycontent>JSP</bodycontent>
<display-name>substitute</display-name>
<description>
Performs a string substitution on text using a regexp.
</description>
<summary>Performs a string substitution on text using a regexp.</summary>
<availability>1.0</availability>
<restrictions>None</restrictions>
<attribute>
<name>regexp</name>
<required>true</required>
<rtexprvalue>false</rtexprvalue>
<description>
Script variable id of <b>regexp</b> to use for substitute.
</description>
<availability>1.0</availability>
</attribute>
<attribute>
<name>text</name>
<required>true</required>
<rtexprvalue>false</rtexprvalue>
<description>
Script variable id of <b>text</b> to perform substitution on.
</description>
<availability>1.0</availability>
</attribute>
<example>
<usage>
<comment>
Substitute "test2" for "test1" in a text string.
</comment>
<code>
<![CDATA[<%-- create the substitute regexp "s/test1/test2/gmi" --%>
<rx:regexp id="rx2">s/test1/test2/gmi</rx:regexp>
<%-- set the text to match on --%>
<rx:text id="test">
This is
test1 of regular expression substitution.
</rx:text>
Here is the text after substitution...<br>
<rx:substitute regexp="rx2" text="test"/>]]>
</code>
</usage>
</example>
</tag>
<tag>
<name>split</name>
<tagclass>org.apache.taglibs.regexp.SplitTag</tagclass>
<teiclass>org.apache.taglibs.regexp.SplitTEI</teiclass>
<bodycontent>JSP</bodycontent>
<display-name>split</display-name>
<description>
Implements a perl style split on the text.
</description>
<summary>Implements a perl style split on the text.</summary>
<availability>1.0</availability>
<restrictions>None</restrictions>
<!-- Declaration of scripting variables created by tag.
Used for generating HTML documentation and for
JSP 1.2 DTD. -->
<variable>
<!-- name-given or name-from-attribute must be declared
<name-given>foo</name-given>
-->
<name-from-attribute>id</name-from-attribute>
<!-- Optional variable declarations -->
<!-- Package and class name of variable, default java.lang.String -->
<variable-class>org.apache.taglibs.regexp.SplitTag</variable-class>
<!-- Usage for declare is not clear in JSP1.2PFD, default true -->
<declare>true</declare>
<!-- scope of scripting variable, default NESTED -->
<scope>NESTED</scope>
<!-- description of scripting variable -->
<description>Split Data Bean</description>
<!-- Used for the HTML documentation only.
Version of taglib when this script variable became available,
deprecated is a possible value. -->
<availability>1.0</availability>
<!-- If the tag creates a script variable or attribute which
is a bean, the following declarations can be used to generate
HTML documentation for 0 .. N properties. -->
<beanprop>
<name>split</name>
<get>Yes</get>
<set>No</set>
<description>
Returns the string split out from text.
</description>
<availability>1.0</availability>
</beanprop>
</variable>
<attribute>
<name>id</name>
<required>true</required>
<rtexprvalue>false</rtexprvalue>
<description>
Script variable id for use with standard <b>jsp:getProperty</b> tag.
</description>
<availability>1.0</availability>
</attribute>
<attribute>
<name>regexp</name>
<required>true</required>
<rtexprvalue>false</rtexprvalue>
<description>
Script variable id of <b>regexp</b> to use for split.
</description>
<availability>1.0</availability>
</attribute>
<attribute>
<name>text</name>
<required>true</required>
<rtexprvalue>false</rtexprvalue>
<description>
Script variable id of <b>text</b> to perform split on.
</description>
<availability>1.0</availability>
</attribute>
<attribute>
<name>limit</name>
<required>false</required>
<rtexprvalue>false</rtexprvalue>
<description>
Set a limit for the number of strings split out from text.
</description>
<availability>1.0</availability>
</attribute>
<example>
<usage>
<comment>
First perform a split of a text string on the word "test",
then perform a split on the character ','.
</comment>
<code>
<![CDATA[<%-- set the text to split --%>
<rx:text id="test">
This is
test1 of a regular expression split,
on whitespace, and then on a comma.
</rx:text>
<ul>
<rx:split id="split" text="test">
<jsp:getProperty name="split" property="split"/><br>
</rx:split>
</ul>
<%-- now split the text using a comma with limit of 2 --%>
<rx:regexp id="rx3">/,/m</rx:regexp>
<ul>
<rx:split id="split" text="test" regexp="rx3" limit="2">
<jsp:getProperty name="split" property="split"/><br>
</rx:split>
</ul>]]>
</code>
</usage>
</example>
</tag>
<tag>
<name>match</name>
<tagclass>org.apache.taglibs.regexp.MatchTag</tagclass>
<teiclass>org.apache.taglibs.regexp.MatchTEI</teiclass>
<bodycontent>JSP</bodycontent>
<display-name>match</display-name>
<description>
Loops through each match found in a text string by a regexp.
</description>
<summary>
Loops through each match found in a text string by a regexp.
</summary>
<availability>1.0</availability>
<restrictions>None</restrictions>
<variable>
<!-- name-given or name-from-attribute must be declared
<name-given>foo</name-given>
-->
<name-from-attribute>id</name-from-attribute>
<!-- Optional variable declarations -->
<!-- Package and class name of variable, default java.lang.String -->
<variable-class>org.apache.taglibs.regexp.MatchTag</variable-class>
<!-- Usage for declare is not clear in JSP1.2PFD, default true -->
<declare>true</declare>
<!-- scope of scripting variable, default NESTED -->
<scope>NESTED</scope>
<!-- description of scripting variable -->
<description>Match Data Bean</description>
<!-- Used for the HTML documentation only.
Version of taglib when this script variable became available,
deprecated is a possible value. -->
<availability>1.0</availability>
<!-- If the tag creates a script variable or attribute which
is a bean, the following declarations can be used to generate
HTML documentation for 0 .. N properties. -->
<beanprop>
<name>match</name>
<get>Yes</get>
<set>No</set>
<description>
Returns the entire string that was matched on.
</description>
<availability>1.0</availability>
</beanprop>
<beanprop>
<name>prematch</name>
<get>Yes</get>
<set>No</set>
<description>
Returns the string preceding the current match.
</description>
<availability>1.0</availability>
</beanprop>
<beanprop>
<name>postmatch</name>
<get>Yes</get>
<set>No</set>
<description>
Returns the string after the current match.
</description>
<availability>1.0</availability>
</beanprop>
</variable>
<attribute>
<name>id</name>
<required>true</required>
<rtexprvalue>false</rtexprvalue>
<description>
Script variable id for use with standard <b>jsp:getProperty</b> tag.
</description>
<availability>1.0</availability>
</attribute>
<attribute>
<name>regexp</name>
<required>true</required>
<rtexprvalue>false</rtexprvalue>
<description>
Script variable id of <b>regexp</b> to use for match.
</description>
<availability>1.0</availability>
</attribute>
<attribute>
<name>text</name>
<required>true</required>
<rtexprvalue>false</rtexprvalue>
<description>
Script variable id of <b>text</b> to perform match on.
</description>
<availability>1.0</availability>
</attribute>
<example>
<usage>
<comment>
Use match to find all words in a text string that start with the
letter 'i'.
</comment>
<code>
<![CDATA[<%-- set the text to perform match --%>
<rx:text id="test">
This is
test1 of a regular expression match,
on words that start with 'i' like item and
index.
</rx:text>
<%-- create the match regexp "m/\si[^\s]*\s/mi" --%>
<rx:regexp id="rx4">m/\si[^\s]*\s/mi</rx:regexp>
<pre>
<rx:match id="mtch" text="test" regexp="rx4">
Match: <jsp:getProperty name="mtch" property="match"/><br>
Pre Match: <jsp:getProperty name="mtch" property="prematch"/><br>
Post Match: <jsp:getProperty name="mtch" property="postmatch"/><br>
</rx:match>]]>
</code>
</usage>
</example>
</tag>
<tag>
<name>group</name>
<tagclass>org.apache.taglibs.regexp.GroupTag</tagclass>
<bodycontent>empty</bodycontent>
<display-name>group</display-name>
<description>
Get the value of a single parenthesized group within a single match.
</description>
<summary>
Get the value of a single parenthesized group within a single match.
</summary>
<availability>1.0</availability>
<restrictions>Must be nested inside a <b>match</b> tag.</restrictions>
<attribute>
<name>number</name>
<required>true</required>
<rtexprvalue>false</rtexprvalue>
<description>
Parenthesised group number to get from match.
</description>
<availability>1.0</availability>
</attribute>
<example>
<usage>
<comment>
Use the group tag to get the next word in a text string after a word
that starts with the letter 'i'.
</comment>
<code>
<![CDATA[<%-- set the text to perform match --%>
<rx:text id="test">
This is
test1 of a regular expression match,
on words that start with 'i' like item and
index, the group tag will be used to get the
next word after the word starting with 'i'.
</rx:text>
<%-- create the match regexp "m/\si[^\s]*\s([^\s]+)/mi" --%>
<rx:regexp id="rx4">m/\si[^\s]*\s([^\s]+)/mi</rx:regexp>
<pre>
<rx:match id="mtch" text="test" regexp="rx4">
Match: <jsp:getProperty name="mtch" property="match"/><br>
Parenthesized Group 1: <rx:group number="1"/>
</rx:match></pre>]]>
</code>
</usage>
</example>
</tag>
</tagtoc>
</taglib>
<revision release="Development" date="11/05/2000">
<description>
The Regexp tag library is still considered in development,
but no changes have been made since the above date.
</description>
</revision>
</document>