Update of /cvsroot/metamorphosis/krysalis-version/src/documentation/content/xdocs/ant/nested
In directory sc8-pr-cvs1:/tmp/cvs-serv18959/src/documentation/content/xdocs/ant/nested
Modified Files:
constraintSet.xml version.xml constraint.xml
Added Files:
defaultAttributes.xml attribute.xml
Log Message:
Docs & also Constraints
--- NEW FILE: defaultAttributes.xml ---
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "./dtd/document-v11.dtd">
<document>
<header>
<title>Krysalis-Version: 'defaultAttributes' Nested Ant Element</title>
<authors>
<person id="arb_jack" name="Adam R. B. Jack" email="[email protected]"/>
</authors>
</header>
<body>
<section><title>Description</title>
<p>Represent a predefined set of named attribute values. Typically these are extracted
from the ant/JVM system properties and set as attributes.</p>
<table>
<tr><th>Name</th><th>Value</th><th>Description</th></tr>
<tr><td>org.krysalis.version.build.jvm</td><td>${java.vm.version}</td><td>JVM built against.</td></tr>
<tr><td>org.krysalis.version.build.user</td><td>${user.name}</td><td>User performing build.</td></tr>
<tr><td>org.krysalis.version.build.date</td><td>${build.date}</td><td>Build Date</td></tr>
<tr><td>org.krysalis.version.build.host</td><td>InetAddress. getLocalHost(). getHostName()</td><td>Build Machine</td></tr>
</table>
</section>
<section><title>Parameters</title>
<p>None</p>
</section>
<section><title>Parameters specified as nested elements</title>
<p>None</p>
</section>
<section>
<title>Parameters specified as text content</title>
<p>None</p>
</section>
</body>
</document>
--- NEW FILE: attribute.xml ---
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "./dtd/document-v11.dtd">
<document>
<header>
<title>Krysalis-Version: 'attribute' Nested Ant Element</title>
<authors>
<person id="arb_jack" name="Adam R. B. Jack" email="[email protected]"/>
</authors>
</header>
<body>
<section><title>Description</title>
<p>Represent a named attribute value (e.g. org.krysalis.version.build.user = 'arb_jack')</p>
</section>
<section><title>Parameters</title>
<p>TODO</p>
<table>
<tr><th>Attribute</th><th>Description</th><th>Required</th><th>Default</th></tr>
<tr><td>name</td><td>Unique Attribute Name</td><td>Yes</td><td></td></tr>
<tr><td>value</td><td>Attribute Value</td><td>Yes</td><td></td></tr>
</table>
</section>
<section><title>Parameters specified as nested elements</title>
<p>None</p>
</section>
<section>
<title>Parameters specified as text content</title>
<p>None</p>
</section>
</body>
</document>
Index: constraintSet.xml
===================================================================
RCS file: /cvsroot/metamorphosis/krysalis-version/src/documentation/content/xdocs/ant/nested/constraintSet.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** constraintSet.xml 17 Feb 2003 06:27:28 -0000 1.1
--- constraintSet.xml 17 Feb 2003 18:54:55 -0000 1.2
***************
*** 29,32 ****
--- 29,33 ----
<tr><td><link href="constraint.html">LessThanOrEqualTo</link></td><td>Version Exists and is <strong>Less Than Or Equal To</strong> a given Version</td></tr>
<tr><td><link href="constraint.html">EqualTo</link></td><td>Version Exists and is <strong>Equal To</strong> a given Version</td></tr>
+ <tr><td><link href="constraint.html">CompatibleWith</link></td><td>Version Exists and is <strong>Compatible With</strong> a given Version</td></tr>
<tr><td><link href="constraint.html">NotEqualTo</link></td><td>Version Exists and is <strong>Not Equal To</strong> a given Version</td></tr>
<tr><td><link href="constraint.html">GreaterThanOrEqualTo</link></td><td>Version Exists and is <strong>Greater Than Or Equal To</strong> a given Version</td></tr>
Index: version.xml
===================================================================
RCS file: /cvsroot/metamorphosis/krysalis-version/src/documentation/content/xdocs/ant/nested/version.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** version.xml 17 Feb 2003 06:27:28 -0000 1.3
--- version.xml 17 Feb 2003 18:54:55 -0000 1.4
***************
*** 17,32 ****
<table>
<tr><th>Attribute</th><th>Description</th><th>Required</th><th>Default</th></tr>
! <tr><td>versionId</td><td>Version Identifier</td><td>Yes*</td><td>From Parent</td></tr>
! <tr><td>version</td><td>Version String</td><td>No</td><td>N/A</td></tr>
! <tr><td>major</td><td>Major Number</td><td>No</td><td>N/A</td></tr>
</table>
<note><strong>Parameter Option Groups</strong>. Collections of parameters, optional groups, are evaluated in the following order.</note>
! <section><title>String Format</title>
<table>
<tr><th>Attribute</th><th>Description</th><th>Required</th><th>Default</th></tr>
! <tr><td>version</td><td>Version String</td><td>Yes</td><td>N/A</td></tr>
</table>
</section>
! <section><title>Compound Format</title>
<table>
<tr><th>Attribute</th><th>Description</th><th>Required</th><th>Default</th></tr>
--- 17,30 ----
<table>
<tr><th>Attribute</th><th>Description</th><th>Required</th><th>Default</th></tr>
! <tr><td><link href="../versionId.html">versionId</link></td><td>Version Identifier</td><td>Yes*</td><td>From Parent</td></tr>
</table>
<note><strong>Parameter Option Groups</strong>. Collections of parameters, optional groups, are evaluated in the following order.</note>
! <section><title>Formatted Version</title>
<table>
<tr><th>Attribute</th><th>Description</th><th>Required</th><th>Default</th></tr>
! <tr><td>version</td><td>Version (Formatted) String</td><td>No</td><td>N/A</td></tr>
</table>
</section>
! <section><title>Compound Version</title>
<table>
<tr><th>Attribute</th><th>Description</th><th>Required</th><th>Default</th></tr>
Index: constraint.xml
===================================================================
RCS file: /cvsroot/metamorphosis/krysalis-version/src/documentation/content/xdocs/ant/nested/constraint.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** constraint.xml 17 Feb 2003 06:27:28 -0000 1.1
--- constraint.xml 17 Feb 2003 18:54:55 -0000 1.2
***************
*** 4,8 ****
<document>
<header>
! <title>Krysalis-Version: Operation Nested Ant Elements</title>
<authors>
<person id="arb_jack" name="Adam R. B. Jack" email="[email protected]"/>
--- 4,8 ----
<document>
<header>
! <title>Krysalis-Version: Constraint Nested Ant Elements</title>
<authors>
<person id="arb_jack" name="Adam R. B. Jack" email="[email protected]"/>
***************
*** 11,15 ****
<body>
<section><title>Description</title>
! <p>Constraints specifications...</p>
</section>
<section><title>Parameters</title>
--- 11,28 ----
<body>
<section><title>Description</title>
! <p>Constraints specifications...</p>
! <section><title>Aliases</title>
! <table>
! <tr><th>Nested Element Name</th><td>Description</td></tr>
! <tr><td>Exists</td><td>Version Exists</td></tr>
! <tr><td>LessThan</td><td>Version Exists and is <strong>Less Than</strong> a given Version</td></tr>
! <tr><td>LessThanOrEqualTo</td><td>Version Exists and is <strong>Less Than Or Equal To</strong> a given Version</td></tr>
! <tr><td>EqualTo</td><td>Version Exists and is <strong>Equal To</strong> a given Version</td></tr>
! <tr><td>CompatibleWith</td><td>Version Exists and is <strong>Compatible With</strong> a given Version</td></tr>
! <tr><td>NotEqualTo</td><td>Version Exists and is <strong>Not Equal To</strong> a given Version</td></tr>
! <tr><td>GreaterThanOrEqualTo</td><td>Version Exists and is <strong>Greater Than Or Equal To</strong> a given Version</td></tr>
! <tr><td>GreaterThan</td><td>Version Exists and is <strong>Greater Than</strong> a given Version</td></tr>
! </table>
! </section>
</section>
<section><title>Parameters</title>
***************
*** 22,26 ****
</section>
<section><title>Parameters specified as nested elements</title>
! <note>A <strong>Constraint Set</strong> is a collection of constraints. Constraints can be produced using any number of the following nested elements. </note>
<section><title>Version</title>
<p>See: <link href="version.html">version</link></p>
--- 35,39 ----
</section>
<section><title>Parameters specified as nested elements</title>
! <note>A <strong>Constraint</strong> is an 'assertion' over version data. Constraints can be produced using any number of the following nested elements, with the primary ones linsted here. </note>
<section><title>Version</title>
<p>See: <link href="version.html">version</link></p>
-------------------------------------------------------
This sf.net email is sponsored by:ThinkGeek
Welcome to geek heaven.
http://thinkgeek.com/sf
lmpx.com only provides a reader for public news (NNTP) servers. It is not
affiliated with the servers or forums shown here and is not responsible for
the content of articles, which is written by their respective authors.