krysalis-version/src/documentation/content/xdocs/ant overview.xml,NONE,1.1 quickstart.xml,NONE,1.1 faq.xml,NONE,1.1 cut-n-paste.xml,NONE,1.1 book.xml,1.3,1.4

[email protected] Wed, 12 Feb 2003 12:52:21 -0800
Newsgroups	gmane.comp.krysalis.sandbox
Message-ID	<[email protected]>
Update of /cvsroot/metamorphosis/krysalis-version/src/documentation/content/xdocs/ant
In directory sc8-pr-cvs1:/tmp/cvs-serv27988/src/documentation/content/xdocs/ant

Modified Files:
	book.xml 
Added Files:
	overview.xml quickstart.xml faq.xml cut-n-paste.xml 
Log Message:
Document updates for ant tasks

--- NEW FILE: overview.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 Ant Tasks - Overview</title>
    <authors>
      <person id="arb_jack" name="Adam R. B. Jack" email="[email protected]"/>
    </authors>
  </header>
  <body>
    <section><title>Overview</title>
      <p>Krysalis-Version <link href="http://ant.apache.org">Ant</link> Tasks are designed to
      enable <strong>versioning tasks</strong> with the minimal of developer effort, and the maximum of flexibility.</p>
      <p>The ant tasks fall roughly into two camps -- <strong>management</strong> (typically for developers to version their packages before distribution) and <strong>runtime</strong> (tools against versions in the current environment)</p>
    </section>
    <section><title>Management Tasks</title>
    	<p>Management tasks help you manage the versions and constraints you generate within your own developments.
    	</p>
    </section> 
    <section><title>Runtime Tasks</title>
    	    	<p>Runtime tasks help you work with the version you depend upon within your own developments.
    	</p>
    	</section>
  </body>
</document>

--- NEW FILE: quickstart.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 Ant Tasks - Overview</title>
    <authors>
      <person id="arb_jack" name="Adam R. B. Jack" email="[email protected]"/>
    </authors>
  </header>
  
  <body>
  	<section>
  		<title>Intro</title>
  	<p>Not interested in reading anything you don't have to, but want to be able to run this and know what is what? This is the place for you...</p>
  	<note>Even less to read in the <link href="cut-n-paste.html">cut-n-paste section</link></note>
  	<p>Basically, you need to define the ant tasks to ant (ensuring the Krysalis Version JAR is in your path) and then call those tasks, providing your configuration. 
  		Krysalis Ant tasks are both simple, and flexible, with a lot of choices. 
  		That said, hopefully the most used/useful are the simplest/easiest.</p>
  	</section>
    <section>
    	<title>1 -- &lt;taskdef resource="version"&gt;</title>
      <p>Entering this into your ant script (prior to calling any of the version tasks) to register them with Ant.</p>
      <p><strong>&lt;taskdef resource="version"&gt;</strong></p>
    </section>
    <section>
    	<title>2 -- enter the task</title>
      <p>Call the appropriate task</p>
       <p><strong>&lt;version-brand dest="${project.src}" versionId="personal.my.stuff" version="1.2"&gt;</strong></p>
   </section>
    <section><title>3 -- run ant...</title>
    </section>
  </body>
</document>

--- NEW FILE: faq.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 Ant Tasks - FAQ</title>
    <authors>
      <person id="arb_jack" name="Adam R. B. Jack" email="[email protected]"/>
    </authors>
  </header>
  
  <body>
     <section><title>FAQ</title>
    	<section><title>How do I define these tasks to ant?</title></section>
    	<section><title>How do I ...</title></section>
    </section>
  </body>
</document>

--- NEW FILE: cut-n-paste.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 Ant Tasks - Cut-n-Paste</title>
    <authors>
      <person id="arb_jack" name="Adam R. B. Jack" email="[email protected]"/>
    </authors>
  </header>
  <body>  
    	<section><title>Generate a Version into your source tree -- string format</title>
    	<source>
&lt;taskdef resource="version"&gt;
&lt;version-brand 
		dest="src" 
		versionId="personal.my.stuff" 
		version="1.2" 
		overWrite="true"&gt;
    	</source>
    	</section>	   	
    		
    	<section><title>Generate a Version into your source tree -- compound format</title>
    	<source>
&lt;taskdef resource="version"&gt;
&lt;version-brand 
			dest="src" 
			versionId="personal.my.stuff" 
			overWrite="true"&gt;
		&lt;version major="1" minor="2"/&gt;
    	</source>
    	</section></body>
</document>

Index: book.xml
===================================================================
RCS file: /cvsroot/metamorphosis/krysalis-version/src/documentation/content/xdocs/ant/book.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** book.xml	11 Feb 2003 23:45:59 -0000	1.3
--- book.xml	12 Feb 2003 20:51:47 -0000	1.4
***************
*** 7,10 ****
--- 7,18 ----
        xmlns:xlink="http://www.w3.org/1999/xlink">
   
+   <menu label="Documentation">
+     <menu-item label="Overview"     href="overview.html"/>     
+     <menu-item label="Quick Start"     href="quickstart.html"/>     
+     <menu-item label="Cut &amp; Paste"     href="cut-n-paste.html"/>     
+     <menu-item label="FAQ"     href="faq.html"/>     
+     <menu-item label="Having Problems?"     href="troubleshooting.html"/>     
+   </menu>
+ 
    <menu label="Management">
      <menu-item label="version-brand"     href="brand.html"/>     




-------------------------------------------------------
This sf.net email is sponsored by:ThinkGeek
Welcome to geek heaven.
http://thinkgeek.com/sf