Update of /cvsroot/metamorphosis/krysalis-version/src/documentation/content/xdocs/standard
In directory sc8-pr-cvs1:/tmp/cvs-serv8349/src/documentation/content/xdocs/standard
Modified Files:
index.xml
Added Files:
basic.xml appendix.xml
Log Message:
Docs, docs, and more docs .... but probably still insufficient/immature...
--- NEW FILE: basic.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: Basic Interface</title>
<authors>
<person id="arb_jack" name="Adam R. B. Jack" email="[email protected]"/>
</authors>
</header>
<body>
<p><strong>Basic Interface</strong></p>
<p>
The <strong>Dynamic Version Interface</strong> is a convention and codeless interface specification that allows version information to be communicated between classes without code linkage. For example, a version reporting system (perhaps a dynamic 'about' box in an Eclipse plug-in) can extract versions from packages (Javasoft, Jakarta, etc.) without having statically link code to create it.
</p>
<section><title>Example #1: Simple 'Field' Form</title>
<source>
package personal.my.stuff.version;
public class Version
{
// Major = 3, Minor = 0, Point = 1, Release Level = beta
public static final String VERSION_STRING = "3.0.1-beta";
}
</source>
</section>
</body>
</document>
--- NEW FILE: appendix.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: </title>
<authors>
<person id="arb_jack" name="Adam R. B. Jack" email="[email protected]"/>
</authors>
</header>
<body>
<section><title>Appendix -- Examples</title>
<section><title>Example #1: Simple 'Field' Form</title>
<source>
package personal.my.stuff.version;
public class Version
{
// Major = 3, Minor = 0, Point = 1, Release Level = beta
public static final String VERSION_STRING = "3.0.1-beta";
}
</source>
</section>
<section><title>Example #2: Explicit Simple 'Field' Form</title>
<source>
package personal.my.stuff.version;
public class Version
{
// For versioning of versions...
// *Optional*
public static final String VERSION_FORMAT = "Krysalis Version";
// *Optional*
public static final String VERSION_VERSION = "1.0.1-alpha";
// Major = 3, Minor = 0, Point = 1, Release Level = beta
public static final String VERSION_STRING = "3.0.1-beta";
}
</source>
</section>
<section><title>Example #3: Simple Method Form</title>
<source>
package personal.my.stuff.version;
public class Version
{
public getVersion() { return "3.0.1-beta"; }
}
</source>
</section>
<section><title>Example #3: Compound Form</title>
<source>
package personal.my.stuff.version;
// 3.2.1-alpha
public class Version
{
public int getMajor(){ return 3; }
public int getMinor(){ return 2; }
public String getMinor(){ return "alpha"; }
public int getPoint(){ return 1; }
}
</source>
</section>
</section>
<section><title>Example Extensions</title>
<ul>
<li>Attributes -- user defined extensions</li>
</ul>
<section><title>Attributes</title>
<p>
To allow the addition of "arbitrary" pices on information (such as build date, build user) the "Attribute" extension is allowed.
</p>
<source>
public HashMap getAttributes()
{
HashMap attributes = new HashMap();
// Store some settings...
attributes.put( "org.krysalis.version.build.date", new Date());
attributes.put( "org.krysalis.version.build.user", "[email protected]");
return attributes;
}
</source>
</section>
</section>
</body>
</document>
Index: index.xml
===================================================================
RCS file: /cvsroot/metamorphosis/krysalis-version/src/documentation/content/xdocs/standard/index.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** index.xml 12 Feb 2003 20:51:48 -0000 1.2
--- index.xml 13 Feb 2003 23:45:57 -0000 1.3
***************
*** 29,35 ****
<tr><th>Class Naming Convention</th><td>{...}.version.Version</td></tr>
<tr><th>Interface (Signatures)</th><td>{...}.getVersionString()</td></tr>
! <tr><th>Version Formats</th><td>1.1.1-alpha</td></tr>
</table>
! <section><title>Class Naming Convention</title>
<p>
--- 29,35 ----
<tr><th>Class Naming Convention</th><td>{...}.version.Version</td></tr>
<tr><th>Interface (Signatures)</th><td>{...}.getVersionString()</td></tr>
! <tr><th>Version Layouts</th><td>1.1.1-alpha</td></tr>
</table>
! <section><title>Class Naming</title>
<p>
***************
*** 76,80 ****
<note>Extension interfaces (signatures) are allowed (to describe location, or add attributes) but these are 100% optional.</note>
</section>
! <section><title>Version Formats</title>
<p>
If not, we've need a number of "version format" choices (and perhaps even
--- 76,80 ----
<note>Extension interfaces (signatures) are allowed (to describe location, or add attributes) but these are 100% optional.</note>
</section>
! <section><title>Version Layouts</title>
<p>
If not, we've need a number of "version format" choices (and perhaps even
***************
*** 160,168 ****
<section><title>References</title>
<table >
! <tr><th>Ruper</th><td><link href="http://krysalis.org/cgi-bin/krywiki.pl?Ruper">http://krysalis.org/cgi-bin/krywiki.pl?Ruper</link></td></tr>
! <tr><th>Krysalis Version</th><td><link href="http://metamorphosis.krysalis.org/cgi-bin/mmorphosiswiki.pl?Version">http://metamorphosis.krysalis.org/cgi-bin/mmorphosiswiki.pl?Version</link></td></tr>
! <tr><th>Apache Commons Versioning</th><td><link href="http://jakarta.apache.org/commons/versioning.html">http://jakarta.apache.org/commons/versioning.html</link></td></tr>
! <tr><th>Javasoft JAR (Manifest) Specification</th><td><link href="http://java.sun.com/j2se/1.4.1/docs/api/java/util/jar/Manifest.html">http://java.sun.com/j2se/1.4.1/docs/api/java/util/jar/Manifest.html</link></td></tr>
! <tr><th>Javasoft Optional Package Versioning</th><td><link href="http://java.sun.com/j2se/1.4/docs/guide/extensions/versioning.html">http://java.sun.com/j2se/1.4/docs/guide/extensions/versioning.html</link></td></tr>
</table>
</section>
--- 160,168 ----
<section><title>References</title>
<table >
! <tr><th>Ruper</th><td><fork href="http://krysalis.org/cgi-bin/krywiki.pl?Ruper">http://krysalis.org/cgi-bin/krywiki.pl?Ruper</fork></td></tr>
! <tr><th>Krysalis Version</th><td><fork href="http://metamorphosis.krysalis.org/cgi-bin/mmorphosiswiki.pl?Version">http://metamorphosis.krysalis.org/cgi-bin/mmorphosiswiki.pl?Version</fork></td></tr>
! <tr><th>Apache Commons Versioning</th><td><fork href="http://jakarta.apache.org/commons/versioning.html">http://jakarta.apache.org/commons/versioning.html</fork></td></tr>
! <tr><th>Javasoft JAR (Manifest) Specification</th><td><fork href="http://java.sun.com/j2se/1.4.1/docs/api/java/util/jar/Manifest.html">http://java.sun.com/j2se/1.4.1/docs/api/java/util/jar/Manifest.html</fork></td></tr>
! <tr><th>Javasoft Optional Package Versioning</th><td><fork href="http://java.sun.com/j2se/1.4/docs/guide/extensions/versioning.html">http://java.sun.com/j2se/1.4/docs/guide/extensions/versioning.html</fork></td></tr>
</table>
</section>
-------------------------------------------------------
This SF.NET email is sponsored by: FREE SSL Guide from Thawte
are you planning your Web Server Security? Click here to get a FREE
Thawte SSL guide and find the answers to all your SSL security issues.
http://ads.sourceforge.net/cgi-bin/redirect.pl?thaw0026en
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.