Update of /cvsroot/metamorphosis/ruper2/src/documentation/content/xdocs/ant
In directory sc8-pr-cvs1:/tmp/cvs-serv25526/src/documentation/content/xdocs/ant
Added Files:
quickstart.xml cut-n-paste.xml sample_scripts.xml faq.xml
updateModule.xml index.xml troubleshooting.xml todo.xml
book.xml overview.xml files.ent
Log Message:
1) Copied over Ruper1 documentation to work on
2) Worked on RepositoryTool [command line] to list groups/resoruces
3) Ignore .* files, and associate .MD5 w/ original. [Later check hash]
--- 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-Ruper 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 Ruper 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>Register the tasks</title>
<p>Entering this into your ant script (prior to calling any of the Ruper tasks) to register them with Ant.</p>
<source>
<typedef resource="krysalis-ruper-types">
<taskdef resource="krysalis-ruper">
</source>
</section>
<section>
<title>Call the tasks</title>
<p>Call the appropriate task or tasks</p>
<p><strong><Ruper file="${project.src}/myjar.jar"></strong></p>
<note>See <link href="cut-n-paste.html">cut-n-paste section</link> for examples.</note>
</section>
<section><title>Run...</title>
<p>Run ant. The tasks will report their activity, and attempt to throw meaningful exceptions is you
have invalid or insufficient parameters.</p>
</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-Ruper Ant Tasks - Cut-n-Paste</title>
<authors>
<person id="arb_jack" name="Adam R. B. Jack" email="[email protected]"/>
</authors>
</header>
<body>
<section><title>TODO</title> </section>
</body>
</document>
--- NEW FILE: sample_scripts.xml ---
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "./dtd/document-v11.dtd"
[<!ENTITY files
SYSTEM "files.ent">]
>
<document>
<header>
<title>Krysalis-Ruper Samples</title>
<authors>
<person id="arb_jack" name="Adam Jack" email="[email protected]"/>
</authors>
</header>
<body>
<section><title>Ant Script Samples</title>
<p>Sample ant scripts for various aspects.</p>
</section>
<section><title>Files</title>
&files;
</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-Ruper Ant Tasks - FAQ</title>
<authors>
<person id="arb_jack" name="Adam R. B. Jack" email="[email protected]"/>
</authors>
</header>
<body>
<note>Ask and they'll be added...</note>
<section><title>How do I define these tasks to ant?</title>
<p>Use:</p>
<source><taskdef resource="krysalis-ruper"></source>
<p>Basically this looks for a file called 'krysalis-ruper' in the classpath, and hopefully finds it in
the Krysalis-Ruper JAR. That is a simple text file that defines the various tasks to ant.
</p>
<note>Krysalis-Ruper must be in your classpath, and available to be loaded.</note>
</section>
<section><title>These ant tasks have so many parameters, how do I know what I need?</title>
<p>Although the tasks do have a lot of flexibility they are intended primarily for simple usage (with just a few parameters) and
allow you to tweak things. Try what makes common sense and let the task tell you if it needs
more. If you feel something is non-intuitative let us know, we'll look into it.</p>
<note>See <link href="cut-n-paste.html">cut-n-paste section</link> for examples.</note>
</section>
</body>
</document>
--- NEW FILE: updateModule.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-Ruper: 'updateModule' Ant Task</title>
<authors>
<person id="arb_jack" name="Adam R. B. Jack" email="[email protected]"/>
</authors>
</header>
<body>
<section><title>Description</title>
<p>Ruper the contents of a 'module'</p>
</section>
<section><title>Parameters</title>
<table>
<tr><th>Attribute</th><th>Description</th><th>Required</th><th>Default</th></tr>
<tr><td>module</td><td>module.xml filename</td><td>No</td><td></td></tr>
<tr><td>target</td><td>Target for the results</td><td>No</td><td>false</td></tr>
<tr><td>action</td><td>What to do when something is out of date: display|warn|error|update</td><td>No</td><td>display</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>
--- NEW FILE: index.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-Ruper Ant Tasks</title>
<authors>
<person id="arb_jack" name="Adam R. B. Jack" email="[email protected]"/>
</authors>
</header>
<body>
<section><title>Ant Tasks</title>
<p>Krysalis-Ruper <fork href="http://ant.apache.org">Ant</fork> Tasks are designed to
enable <strong>resource updating</strong> with the minimal of developer effort.
</p>
<p>It implements the following ANT tasks:</p>
<fixme author="arb_jack">To be completed...</fixme>
<p>See <link href="sample_scripts.html">Sample Scripts</link></p>
</section>
</body>
</document>
--- NEW FILE: troubleshooting.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-Ruper Ant Tasks - Troubleshooting</title>
<authors>
<person id="arb_jack" name="Adam R. B. Jack" email="[email protected]"/>
</authors>
</header>
<body>
<section>
<title>RuperException</title>
<p><strong>Krysalis Ruper</strong> attempts to throw meaningful and descriptive
exceptions. If on JDK1.4 or above look at the 'cause' behind the ant BuildException.</p>
</section>
<section>
<title>-verbose</title>
<p>The ant tasks respect this with ant command line parameter, and give appropriate information.</p>
</section>
<section>
<title>Logging</title>
<p><code>-D org.krysalis.version.logging=true</code> enables <strong>Krysalis Version</strong> logging.</p>
</section>
<section>
<title>Contact us</title>
<p>If all else fails contact us via <link href="http://www.krysalis.org">http://www.krysalis.org</link>.</p>
</section>
</body>
</document>
--- NEW FILE: todo.xml ---
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "./dtd/document-v11.dtd">
<document>
<header>
<title>:TODO:</title>
<authors>
<person id="arb_jack" name="Adam R. B. Jack" email="[email protected]"/>
</authors>
</header>
<body>
<section><title>:TODO:</title>
<fixme author="chalko">Add documentation</fixme>
</section>
</body>
</document>
--- NEW FILE: book.xml ---
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//APACHE//DTD Cocoon Documentation Book V1.0//EN" "dtd/book-cocoon-v10.dtd">
<book software="Krysalis Ruper"
title="Krysalis Ruper Ant"
copyright="2002-@year@ Krysalis Project"
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 & Paste" href="cut-n-paste.html"/>
<menu-item label="Sample Scripts" href="sample_scripts.html"/>
<menu-item label="FAQ" href="faq.html"/>
<menu-item label="Having Problems?" href="troubleshooting.html"/>
</menu>
<menu label="Tasks">
<menu-item label="updateResource" href="updateResource.html"/>
<menu-item label="updateModule" href="updateModule.html"/>
<menu-item label="updateProject" href="updateProject.html"/>
<menu-item label="updatePath" href="updatePath.html"/>
</menu>
</book>
--- 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-Ruper 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-Ruper <link href="http://ant.apache.org">Ant</link> Tasks are designed to
enable <strong>resource updating</strong>.</p>
</section>
</body>
</document>
--- NEW FILE: files.ent ---
<!-- Fri Jun 27 15:09:30 MDT 2003 -->
<section><title>todo</title>
</section>
-------------------------------------------------------
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.