commit 3bbe63cd7e12717560f928660a9e69c9a5681f33
author Dennis Lundberg <dennisl@apache.org> Mon Jan 18 17:55:17 2010 +0000
committer Dennis Lundberg <dennisl@apache.org> Mon Jan 18 17:55:17 2010 +0000
tree 9faa2251f6bc54b4eba15b72dd5f8887dc1f1b7f
parent feba45ebd04381431a7a56af7d3334279f2cce42

o Generate the xml schema as part of the site, to make it easy to copy to its final destination.
o Document how to use the xml schema, and use it in the example.

git-svn-id: https://svn.apache.org/repos/asf/maven/plugins/trunk@900478 13f79535-47bb-0310-9956-ffa450edef68

pom.xml

diff --git a/pom.xml b/pom.xml
index 2d2d228..671803c 100644
--- a/pom.xml
+++ b/pom.xml
@@ -75,10 +75,21 @@
         <artifactId>modello-maven-plugin</artifactId>
         <executions>
           <execution>
+            <id>generate-xsd-site</id>
+            <phase>pre-site</phase>
             <goals>
+              <goal>xsd</goal>
+            </goals>
+            <configuration>
+              <outputDirectory>${project.reporting.outputDirectory}/xsd</outputDirectory>
+            </configuration>
+          </execution>
+          <execution>
+            <id>standard</id>
+            <goals>
+              <goal>java</goal>
               <goal>xpp3-reader</goal>
               <goal>xpp3-writer</goal>
-              <goal>java</goal>
             </goals>
           </execution>
           <execution>
@@ -86,7 +97,6 @@
             <phase>pre-site</phase>
             <goals>
               <goal>xdoc</goal>
-              <goal>xsd</goal>
             </goals>
           </execution>
         </executions>

src/main/mdo/verifications.mdo

diff --git a/src/main/mdo/verifications.mdo b/src/main/mdo/verifications.mdo
index bdfe2cc..4931ded 100644
--- a/src/main/mdo/verifications.mdo
+++ b/src/main/mdo/verifications.mdo
@@ -17,7 +17,11 @@
 under the License.
 -->
 
-<model>
+<model xmlns="http://modello.codehaus.org/MODELLO/1.0.0"
+       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+       xsi:schemaLocation="http://modello.codehaus.org/MODELLO/1.0.0 http://modello.codehaus.org/xsd/modello-1.0.0.xsd"
+       xsd.namespace="http://maven.apache.org/verifications/1.0.0"
+       xsd.targetNamespace="http://maven.apache.org/verifications/1.0.0">
   <id>verifications</id>
   <name>Verifications</name>
   <description><![CDATA[

src/site/apt/examples/sample-verifications.apt

diff --git a/src/site/apt/examples/sample-verifications.apt b/src/site/apt/examples/sample-verifications.apt
index 50837e8..7a3c328 100644
--- a/src/site/apt/examples/sample-verifications.apt
+++ b/src/site/apt/examples/sample-verifications.apt
@@ -3,7 +3,7 @@
  ------
  Denis Cabasson
  ------
- 20 july 2006
+ 2010-01-18
  ------
 
 Sample Verifications
@@ -11,7 +11,9 @@
   Here is an example of what a <<<verifications.xml>>> file can look like:
 
 +--------
-<verifications>
+<verifications xmlns="http://maven.apache.org/verifications/1.0.0"
+               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+               xsi:schemaLocation="http://maven.apache.org/verifications/1.0.0 http://maven.apache.org/xsd/verifications-1.0.0.xsd">
   <files>
     <file>
       <location>src/main/resources/file1.txt</location>
@@ -32,6 +34,6 @@
 
   * checks that the file <<<src/main/resources/file1.txt>>> is present.
 
-  * checks that the file <<<src/main/resources/file2.txt>>> is present and match the regexp <aaaabbbb>.
+  * checks that the file <<<src/main/resources/file2.txt>>> is present and matches the regular expression <aaaabbbb>.
 
   * checks that the file <<<src/main/resources/file3.txt>>> is <<not>> present.

src/site/apt/using-xsd.apt

diff --git a/src/site/apt/using-xsd.apt b/src/site/apt/using-xsd.apt
new file mode 100644
index 0000000..982099a
--- /dev/null
+++ b/src/site/apt/using-xsd.apt
@@ -0,0 +1,43 @@
+ -----
+ Using the XML Schema Verifications 1.0.0
+ -----
+ Dennis Lundberg
+ ------
+ 2010-01-18
+ ------
+
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements.  See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership.  The ASF licenses this file
+~~ to you under the Apache License, Version 2.0 (the
+~~ "License"); you may not use this file except in compliance
+~~ with the License.  You may obtain a copy of the License at
+~~
+~~   http://www.apache.org/licenses/LICENSE-2.0
+~~
+~~ Unless required by applicable law or agreed to in writing,
+~~ software distributed under the License is distributed on an
+~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+~~ KIND, either express or implied.  See the License for the
+~~ specific language governing permissions and limitations
+~~ under the License.
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/doxia/references/apt-format.html
+
+Using the XML Schema Verifications 1.0.0
+
+  The Verifications XSD is located {{{http://maven.apache.org/xsd/verifications-1.0.0.xsd}here}}.
+
+  Your favorite IDE probably supports validation and/or syntax highlighting for
+  XML files by using XSD schemas. For this to work you need to specify the
+  schema in your <<<verifications.xml>>> file:
+
++-----+
+<verifications xmlns="http://maven.apache.org/verifications/1.0.0"
+               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+               xsi:schemaLocation="http://maven.apache.org/verifications/1.0.0 http://maven.apache.org/xsd/verifications-1.0.0.xsd">
+...
+</verifications>
++-----+

src/site/site.xml

diff --git a/src/site/site.xml b/src/site/site.xml
index d527d50..ea417b9 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -28,6 +28,7 @@
       <item name="Goals" href="plugin-info.html"/>
       <item name="Usage" href="usage.html"/>
       <item name="FAQ" href="faq.html"/>
+      <item name="Using the XML Schema" href="using-xsd.html"/>
     </menu>
     <menu name="Examples">
       <item name="Sample Verifications" href="examples/sample-verifications.html"/>