Author: niclas
Date: Mon May 31 08:10:11 2004
New Revision: 20690
Modified:
avalon/trunk/central/site/src/xdocs/central/download.xml
avalon/trunk/central/site/src/xdocs/central/laboratory/magic/plugins/artifact/properties.xml
avalon/trunk/central/site/src/xdocs/central/laboratory/magic/plugins/prepare/index.xml
avalon/trunk/central/site/src/xdocs/central/laboratory/magic/plugins/prepare/methods.xml
avalon/trunk/central/site/src/xdocs/central/laboratory/magic/plugins/prepare/properties.xml
avalon/trunk/central/site/src/xdocs/central/laboratory/magic/plugins/xdoc/index.xml
avalon/trunk/central/site/src/xdocs/central/laboratory/magic/plugins/xdoc/methods.xml
avalon/trunk/central/site/src/xdocs/central/laboratory/magic/plugins/xdoc/properties.xml
Log:
download.cgi wasn't handled properly.
Modified: avalon/trunk/central/site/src/xdocs/central/download.xml
==============================================================================
--- avalon/trunk/central/site/src/xdocs/central/download.xml (original)
+++ avalon/trunk/central/site/src/xdocs/central/download.xml Mon May 31
08:10:11 2004
@@ -116,13 +116,13 @@
<tr>
<td><a href="/logkit/">Avalon-Logkit</a></td>
<td><a href="[preferred]/avalon/logkit/binaries">binaries</a></td>
- <td><a href="[preferred]/avalon/logkit/source">broswe</a></td>
+ <td><a href="[preferred]/avalon/logkit/source">browse</a></td>
<td><a href="[preferred]/avalon/logkit/jars">jars</a></td>
</tr>
<tr>
<td><a href="/merlin/">Avalon-Merlin</a></td>
<td><a href="[preferred]/avalon/merlin/binaries">binaries</a></td>
- <td><a href="[preferred]/avalon/merlin/source">broswe</a></td>
+ <td><a href="[preferred]/avalon/merlin/source">browse</a></td>
<td><a href="[preferred]/avalon/merlin/jars">jars</a></td>
</tr>
</table>
@@ -140,13 +140,13 @@
<tr>
<td><a href="/excalibur/fortress/">Avalon-Fortress</a></td>
<td><a
href="[preferred]/avalon/avalon-fortress/binaries">binaries</a></td>
- <td><a
href="[preferred]/avalon/avalon-fortress/source">broswe</a></td>
+ <td><a
href="[preferred]/avalon/avalon-fortress/source">browse</a></td>
<td><a href="[preferred]/avalon/avalon-fortress/jars">jars</a></td>
</tr>
<tr>
<td><a href="/phoenix/">Avalon-Phoenix</a></td>
<td><a href="[preferred]/avalon/phoenix/binaries">binaries</a></td>
- <td><a href="[preferred]/avalon/phoenix/source">broswe</a></td>
+ <td><a href="[preferred]/avalon/phoenix/source">browse</a></td>
<td><a href="[preferred]/avalon/phoenix/jars">jars</a></td>
</tr>
</table>
Modified:
avalon/trunk/central/site/src/xdocs/central/laboratory/magic/plugins/artifact/properties.xml
==============================================================================
---
avalon/trunk/central/site/src/xdocs/central/laboratory/magic/plugins/artifact/properties.xml
(original)
+++
avalon/trunk/central/site/src/xdocs/central/laboratory/magic/plugins/artifact/properties.xml
Mon May 31 08:10:11 2004
@@ -45,6 +45,8 @@
${user.home}/.maven/repository
</td>
<td>
+ The local repository where artifacts will be downloaded to, and
+ included from in builds.
</td>
</tr>
<tr>
@@ -55,6 +57,7 @@
http://www.ibiblio.org/maven
</td>
<td>
+ The remote repository where the artifact will be downloaded from.
</td>
</tr>
</table>
Modified:
avalon/trunk/central/site/src/xdocs/central/laboratory/magic/plugins/prepare/index.xml
==============================================================================
---
avalon/trunk/central/site/src/xdocs/central/laboratory/magic/plugins/prepare/index.xml
(original)
+++
avalon/trunk/central/site/src/xdocs/central/laboratory/magic/plugins/prepare/index.xml
Mon May 31 08:10:11 2004
@@ -23,13 +23,17 @@
<properties>
<author email="[EMAIL PROTECTED]">Niclas Hedhman</author>
- <title>Magic Prepare Plugin</title>
+ <title>Avalon Magic</title>
</properties>
<body>
<section name="About Prepare Plugin">
<p>
+ The Prepare Plugin is a plugin shared by most other plugins. It will
+ copy the sources, with and without filtering, from the source
+ directories, to the build directories. The plugin also establishes
+ a couple of global properties that many other plugins utilizes.
</p>
</section>
</body>
Modified:
avalon/trunk/central/site/src/xdocs/central/laboratory/magic/plugins/prepare/methods.xml
==============================================================================
---
avalon/trunk/central/site/src/xdocs/central/laboratory/magic/plugins/prepare/methods.xml
(original)
+++
avalon/trunk/central/site/src/xdocs/central/laboratory/magic/plugins/prepare/methods.xml
Mon May 31 08:10:11 2004
@@ -23,12 +23,12 @@
<properties>
<author email="[EMAIL PROTECTED]">Niclas Hedhman</author>
- <title>Magic Prepare Plugin</title>
+ <title>Avalon Magic</title>
</properties>
<body>
- <section name="Magic Prepare Plugin - Methods">
+ <section name="Prepare Plugin - Methods">
<p>
It is not meant for humans to directly invoke the Prepare plugin,
but for other plugins to request its service.
Modified:
avalon/trunk/central/site/src/xdocs/central/laboratory/magic/plugins/prepare/properties.xml
==============================================================================
---
avalon/trunk/central/site/src/xdocs/central/laboratory/magic/plugins/prepare/properties.xml
(original)
+++
avalon/trunk/central/site/src/xdocs/central/laboratory/magic/plugins/prepare/properties.xml
Mon May 31 08:10:11 2004
@@ -23,7 +23,7 @@
<properties>
<author email="[EMAIL PROTECTED]">Niclas Hedhman</author>
- <title>Magic Prepare Plugin</title>
+ <title>Avalon Magic</title>
</properties>
<body>
@@ -45,6 +45,9 @@
src/
</td>
<td>
+ The source directories. The <code>init</code> method will copy all
+ the content from these directories to the ${prepare.build.src.dir}
+ with and without filtering enabled, depending on file type.
</td>
</tr>
<tr>
@@ -55,6 +58,7 @@
target/
</td>
<td>
+ The top destination directory for all build outputs.
</td>
</tr>
<tr>
@@ -65,6 +69,10 @@
${prepare.dest.dir}/src/
</td>
<td>
+ This is the directory where the sources will be copied to before
+ processed. The copy procedure allows for filtering, where the
+ content of the source files have 'tags' in them that will be
+ replaced by build-time information.
</td>
</tr>
<tr>
@@ -75,6 +83,13 @@
**/*.xml, **/*.java, **/*.html, **/*.sh, **/*.bat, **/*.prop*
</td>
<td>
+ A comma-separated list of files that will be filtered. All other
+ files copied will be copied without filtering enabled. All
+ properties will be converted from their typical lower-case format
+ to an upper-case equivalent, and any properties surrounded by the @
+ character is a tag, that will be replaced by its build value. For
+ instance, @PREPARE.DEST.DIR@ will be replaced by the value of the
+ ${prepare.dest.dir} property, default "target/".
</td>
</tr>
</table>
Modified:
avalon/trunk/central/site/src/xdocs/central/laboratory/magic/plugins/xdoc/index.xml
==============================================================================
---
avalon/trunk/central/site/src/xdocs/central/laboratory/magic/plugins/xdoc/index.xml
(original)
+++
avalon/trunk/central/site/src/xdocs/central/laboratory/magic/plugins/xdoc/index.xml
Mon May 31 08:10:11 2004
@@ -23,22 +23,21 @@
<properties>
<author email="[EMAIL PROTECTED]">Niclas Hedhman</author>
- <category>Merlin Magic - XDoc Plugin</category>
- <title>Merlin Magic - XDoc Plugin</title>
+ <title>Avalon Magic</title>
</properties>
<body>
- <section name="About Merlin Magic XDoc Plugin">
- <p>
-Welcome to the Merlin Magic XDoc Plugin.
- </p>
+ <section name="About XDoc Plugin">
<p>
The XDoc Plugin allows you to create the project documentation using
XML, in the so called Anakia format, and automatically generate the
look from a <em>theme</em>. A <em>theme</em> is a predefined XSLT
template that the XDoc Plugin will use to generate the HTML and PDF
- (optional) outputs.
+ (future) outputs.
+ </p>
+ <p>
+ The theme must be located in the ${project.system}/theme directory.
</p>
</section>
</body>
Modified:
avalon/trunk/central/site/src/xdocs/central/laboratory/magic/plugins/xdoc/methods.xml
==============================================================================
---
avalon/trunk/central/site/src/xdocs/central/laboratory/magic/plugins/xdoc/methods.xml
(original)
+++
avalon/trunk/central/site/src/xdocs/central/laboratory/magic/plugins/xdoc/methods.xml
Mon May 31 08:10:11 2004
@@ -23,12 +23,12 @@
<properties>
<author email="[EMAIL PROTECTED]">Niclas Hedhman</author>
- <title>Merlin Magic - XDoc Plugin</title>
+ <title>Avalon Magic</title>
</properties>
<body>
- <section name="Merlin Magic XDoc Plugin - Methods">
+ <section name="XDoc Plugin - Methods">
<p>
The following methods has been defined in the XDoc Plugin.
</p>
@@ -47,7 +47,7 @@
</td>
<td>
The <strong>generate</strong> method generates the documentation
- from residing in the xdoc.src.dir directory.
+ from residing in the ${xdoc.src.dir} directory.
</td>
</tr>
</table>
Modified:
avalon/trunk/central/site/src/xdocs/central/laboratory/magic/plugins/xdoc/properties.xml
==============================================================================
---
avalon/trunk/central/site/src/xdocs/central/laboratory/magic/plugins/xdoc/properties.xml
(original)
+++
avalon/trunk/central/site/src/xdocs/central/laboratory/magic/plugins/xdoc/properties.xml
Mon May 31 08:10:11 2004
@@ -23,11 +23,11 @@
<properties>
<author email="[EMAIL PROTECTED]">Niclas Hedhman</author>
- <title>Merlin Magic - XDoc Plugin</title>
+ <title>Avalon Magic</title>
</properties>
<body>
- <section name="Merlin Magic XDoc Plugin - Properties">
+ <section name="XDoc Plugin - Properties">
<p>
The following properties are used by the XDoc Plugin.
</p>
@@ -45,6 +45,22 @@
src/xdocs
</td>
<td>
+ The source directory where the XDoc documents are expected to be
+ found.
+ </td>
+ </tr>
+ <tr>
+ <td>
+ xdoc.build.src.dir
+ </td>
+ <td>
+ target/src/xdocs
+ </td>
+ <td>
+ The directory where the source documents will be copied before
+ processed. This directory structure is also where the navigation
+ aggregation will occur, and the intermediary files can be found
+ here.
</td>
</tr>
<tr>
@@ -55,6 +71,7 @@
target/docs
</td>
<td>
+ The output directory where the generated files will be stored.
</td>
</tr>
<tr>
@@ -62,12 +79,196 @@
xdoc.theme.name
</td>
<td>
- merlin
+ avalon2
+ </td>
+ <td>
+ Name of the theme to use. The themes must located in
+ ${project.system}/themes.
+ </td>
+ </tr>
+ <tr>
+ <td>
+ xdoc.resources.dir
+ </td>
+ <td>
+ src/resources/
+ </td>
+ <td>
+ The directory where other resources are stored. These resources
+ will be copied into the destination directory ${xdoc.dest.dir}.
+ </td>
+ </tr>
+ <tr>
+ <td>
+ xdoc.output.format
+ </td>
+ <td>
+ html
+ </td>
+ <td>
+ The output format of the generated content. Only 'html' is
supported
+ at the moment.
+ </td>
+ </tr>
+ <tr>
+ <td>
+ xdoc.fail.on.error
+ </td>
+ <td>
+ true
+ </td>
+ <td>
+ If "true", the generation will halt when an error of any kind has
+ occurred. If not "true", then generation will continue.
+ </td>
+ </tr>
+ <tr>
+ <td>
+ xdoc.print.stack.trace
+ </td>
+ <td>
+ true
</td>
<td>
+ If "true" a stack trace will be printed out if an error occurs.
+ If not "true", then only the message of the exception will be
+ printed.
+ </td>
+ </tr>
+ <tr>
+ <td>
+ xdoc.public.root.xdocs
+ </td>
+ <td>
+
https://svn.apache.org/repos/asf/avalon/trunk/central/site/src/xdocs
+ </td>
+ <td>
+ This is the 'anchor' of the source documents root, which is used
for
+ the source icon, where one can easily retrieve the xml source.
+ </td>
+ </tr>
+ <tr>
+ <td>
+ xdoc.footer.copyright.text
+ </td>
+ <td>
+ Copyright ${magic.year}, The Apache Software Foundation. All
rights reserved.
+ </td>
+ <td>
+ Text of the footer to be generated on each page.
+ </td>
+ </tr>
+ <tr>
+ <td>
+ xdoc.footer.copyright.url
+ </td>
+ <td>
+ http://www.apache.org/
+ </td>
+ <td>
+ If this property is not an empty string a link will be created
around
+ the copyright notice. I.e. <a
href="${xdoc.footer.copyright.url}">
+ ${xdoc.footer.copyright.text}</a>.
+ </td>
+ </tr>
+ <tr>
+ <td>
+ xdoc.logo.left.file
+ </td>
+ <td>
+ images/feather.jpg
+ </td>
+ <td>
+ The image name of the logo that will be generated in the top-left
+ corner of the page.
+ </td>
+ </tr>
+ <tr>
+ <td>
+ xdoc.logo.left.url
+ </td>
+ <td>
+ <empty string>
+ </td>
+ <td>
+ If this property is not an empty string, the top-left image will be
+ link to this URL. I.e.
+ <a href="${xdoc.footer.copyright.url}">
+ <img src="${xdoc.logo.left.file}" />
+ </a>.
+ </td>
+ </tr>
+ <tr>
+ <td>
+ xdoc.logo.right.file =
+ </td>
+ <td>
+ <empty string>
+ </td>
+ The image name of the logo that will be generated in the top-right
+ corner of the page.
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ xdoc.logo.right.url
+ </td>
+ <td>
+ <empty string>
+ </td>
+ <td>
+ If this property is not an empty string, the top-right image will
be
+ link to this URL. I.e.
+ <a href="${xdoc.footer.copyright.url}">
+ <img src="${xdoc.logo.right.file}" />
+ </a>.
+ </td>
+ </tr>
+ <tr>
+ <td>
+ xdoc.logo.middle.file =
+ </td>
+ <td>
+ <empty string>
+ </td>
+ <td>
+ The image name of the logo that will be generated in the top-middle
+ corner of the page.
+ </td>
+ </tr>
+ <tr>
+ <td>
+ xdoc.logo.middle.url =
+ </td>
+ <td>
+ <empty string>
+ </td>
+ <td>
+ If this property is not an empty string, the top-middle image will
be
+ link to this URL. I.e.
+ <a href="${xdoc.footer.copyright.url}">
+ <img src="${xdoc.logo.middle.file}" />
+ </a>.
+ </td>
+ </tr>
+ <tr>
+ <td>
+ xdoc.brand.name
+ </td>
+ <td>
+ Apache Avalon
+ </td>
+ <td>
+ This is the "brand name" to be generated in the middle section of
+ the top panel, above the document title.
</td>
</tr>
</table>
</section>
</body>
</document>
+
+
+
+
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
