Menu
▾
▴
[Maven-plugins-cvs] cvs commit: maven-plugins/schemaspy/xdocs properties.xml navigation.xml index.xml goals.xml
|
From: Eric P. <de...@us...> - 2006-04-25 17:47:01
|
dep4b 06/04/25 10:46:59
Added: schemaspy project.properties plugin.properties LICENSE.txt
plugin.jelly .cvsignore project.xml
schemaspy/xdocs properties.xml navigation.xml index.xml
goals.xml
Log:
Initial solution for running schemaspy in Maven 1 projects.
Revision Changes Path
1.1 maven-plugins/schemaspy/project.properties
<<Binary file>>
1.1 maven-plugins/schemaspy/plugin.properties
Index: plugin.properties
===================================================================
# -------------------------------------------------------------------
# Default Maven properties for the SchemaSpy plugin
# -------------------------------------------------------------------
# where to output HTML generated by SchemaSpy
maven.schemaspy.target.dir = ${maven.build.dir}/docs/schemaspy
# what database platform to use
maven.schemaspy.database.type=
# name of the database
maven.schemaspy.database.name=
# host name of databse
maven.schemaspy.database.host=
# database port
maven.schemaspy.database.port=
# user to login as
maven.schemaspy.database.user=
# password to login with
maven.schemaspy.database.password=
# Classpath to driver to use
# an example for mssql is:
# ${pom.getDependencyPath("mssqlserver:mssqlserver")}:${pom.getDependencyPath("mssqlserver:msbase")}:${pom.getDependencyPath("mssqlserver:msutil")}
# notice the ":" characters between elements.
maven.schemaspy.driver.classpath=
# optional schema to use
maven.schemaspy.driver.schema=
1.1 maven-plugins/schemaspy/LICENSE.txt
Index: LICENSE.txt
===================================================================
/* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2001 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Apache" and "Apache Software Foundation" and
* "Apache Wiki Maven Plugin" must not be used to endorse or promote products
* derived from this software without prior written permission. For
* written permission, please contact ap...@ap....
*
* 5. Products derived from this software may not be called "Apache",
* "Apache Interactive Maven Plugin", nor may "Apache" appear in their name, without
* prior written permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*
* ====================================================================
*/
1.1 maven-plugins/schemaspy/plugin.jelly
Index: plugin.jelly
===================================================================
<?xml version="1.0"?>
<project
xmlns:j="jelly:core"
xmlns:util="jelly:util"
xmlns:ant="jelly:ant"
xmlns:maven="jelly:maven">
<!-- ================================================================== -->
<!-- S C H E M A S P Y -->
<!-- ================================================================== -->
<goal name="schemaspy"
description="Create SchemaSpy documentation"
prereqs="schemaspy:info,maven-schemaspy-plugin:report">
</goal>
<!-- ================================================================== -->
<!-- I N I T -->
<!-- ================================================================== -->
<goal name="schemaspy:init">
</goal>
<!-- ================================================================== -->
<!-- I N F O -->
<!-- ================================================================== -->
<goal name="schemaspy:info" prereqs="schemaspy:init">
<echo>maven.schemaspy.database.name = ${maven.schemaspy.database.name}</echo>
<echo>maven.schemaspy.database.host = ${maven.schemaspy.database.host}</echo>
<echo>maven.schemaspy.database.type = ${maven.schemaspy.database.type}</echo>
<echo>maven.schemaspy.database.port = ${maven.schemaspy.database.port}</echo>
<echo>maven.schemaspy.database.username = ${maven.schemaspy.database.username}</echo>
<echo>maven.schemaspy.database.password = ${maven.schemaspy.database.password}</echo>
<echo>maven.schemaspy.database.schema = ${maven.schemaspy.database.schema}</echo>
<echo>maven.schemaspy.driver.classpath = ${maven.schemaspy.driver.classpath}</echo>
</goal>
<!-- ================================================================== -->
<!-- P R E P A R E F I L E S Y S T E M -->
<!-- ================================================================== -->
<goal name="schemaspy:prepare-filesystem" prereqs="schemaspy:init">
<attainGoal name="xdoc:init"/>
<!-- create target directory for generated documentation -->
<mkdir dir="${maven.schemaspy.target.dir}"/>
</goal>
<!-- ================================================================== -->
<!-- G E N E R A T E R E P O R T -->
<!-- ================================================================== -->
<goal
name="maven-schemaspy-plugin:report"
prereqs="schemaspy:prepare-filesystem"
description="Generate docs using schemaspy">
<echo>Generating schema documentation for database ${maven.schemaspy.database.name}</echo>
<java jar="${plugin.getDependencyPath('schemaspy')}" fork="yes" failonerror="true" dir="${maven.schemaspy.target.dir}">
<classpath>
<pathelement location="${plugin.getDependencyPath('schemaspy')}"/>
</classpath>
<classpath refid="maven.dependency.classpath"/>
<arg value="-cp"/>
<arg value="${maven.schemaspy.driver.classpath}"/>
<arg value="-o"/>
<arg value="${maven.schemaspy.target.dir}"/>
<arg value="-t"/>
<arg value="${maven.schemaspy.database.type}"/>
<arg value="-db"/>
<arg value="${maven.schemaspy.database.name}"/>
<arg value="-host"/>
<arg value="${maven.schemaspy.database.host}"/>
<arg value="-port"/>
<arg value="${maven.schemaspy.database.port}"/>
<arg value="-u"/>
<arg value="${maven.schemaspy.database.username}"/>
<arg value="-p"/>
<arg value="${maven.schemaspy.database.password}"/>
<arg value="-s"/>
<arg value="${maven.schemaspy.database.schema}"/>
</java>
</goal>
<!-- ================================================================== -->
<!-- R E G I S T E R R E P O R T -->
<!-- ================================================================== -->
<goal name="maven-schemaspy-plugin:register">
<doc:registerReport
name="SchemaSpy Report"
pluginName="maven-schemaspy-plugin"
description="Document database schema."
link="./schemaspy/"/>
</goal>
<!-- ================================================================== -->
<!-- D E R E G I S T E R R E P O R T -->
<!-- ================================================================== -->
<goal name="maven-findbugs-plugin:deregister">
<doc:deregisterReport name="SchemaSpy Report"/>
</goal>
</project>
1.1 maven-plugins/schemaspy/.cvsignore
Index: .cvsignore
===================================================================
target
.classpath
.project
1.1 maven-plugins/schemaspy/project.xml
Index: project.xml
===================================================================
<?xml version="1.0" encoding="UTF-8"?>
<project>
<extend>../plugin-project.xml</extend>
<!--pomVersion is in parent -->
<artifactId>maven-schemaspy-plugin</artifactId>
<name>SchemaSpy Plug-in</name>
<!-- groupId is in parent -->
<currentVersion>1.0-SNAPSHOT</currentVersion>
<!-- organization is in parent -->
<inceptionYear>2006</inceptionYear>
<!-- package, logo are in parent. no gumpRepositoryId -->
<description>A plugin to support running SchemaSpy to generate documentations about common databases including MySQL, MSSQL, Oracle.</description>
<shortDescription>MAVEN Plug-in for SchemaSpy</shortDescription>
<url>http://maven-plugins.sourceforge.net/${pom.artifactId}</url>
<!-- issueTrackingUrl, siteAddress are in parent -->
<repository>
<connection>scm:cvs:pserver:ano...@cv...:/cvsroot/maven-plugins:maven-plugins/schemaspy</connection>
<developerConnection>scm:cvs:ext:${maven.username}@cvs.sourceforge.net:/cvsroot/maven-plugins:maven-plugins/schemaspy</developerConnection>
<url>http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/maven-plugins/maven-plugins/schemaspy/</url>
</repository>
<versions>
</versions>
<branches></branches>
<!-- mailingLists are in parent -->
<developers>
<developer>
<name>Eric Pugh</name>
<id>epugh</id>
<email>epu...@op...</email>
<organization>OpenSource Connections</organization>
<roles>
<role>Developer</role>
</roles>
</developer>
</developers>
<dependencies>
<dependency>
<groupId>schemaspy</groupId>
<artifactId>schemaspy</artifactId>
<version>2.1.2</version>
</dependency>
</dependencies>
</project>
1.1 maven-plugins/schemaspy/xdocs/properties.xml
Index: properties.xml
===================================================================
<?xml version="1.0" encoding="ISO-8859-1"?>
<document>
<properties>
<title>Maven SchemaSpy Goals</title>
<author email="epu...@op...">Eric Pugh</author>
</properties>
<body>
<section name="RPM Plugin Properties">
<table>
<tr><th>Property</th><th>Default</th><th>Optional?</th><th>Description</th></tr>
<tr><td>maven.schemaspy.target.dir</td><td>${maven.build.dir}/docs/schemaspy</td><td>Yes</td><td>The directory where the documentation will be output.</td></tr>
<tr><td>maven.schemaspy.database.type</td><td></td><td>no</td><td>The database type to used. See SchemaSpy docs for options.</td></tr>
<tr><td>maven.schemaspy.database.name</td><td></td><td>no</td><td>The database name</td></tr>
<tr><td>maven.schemaspy.database.host</td><td></td><td>no</td><td>The database host</td></tr>
<tr><td>maven.schemaspy.database.port</td><td></td><td>no</td><td>The database port</td></tr>
<tr><td>maven.schemaspy.database.username</td><td></td><td>no</td><td>The database user to login as</td></tr>
<tr><td>maven.schemaspy.database.password</td><td></td><td>no</td><td>The database password to use</td></tr>
<tr><td>maven.schemaspy.database.schema</td><td></td><td>no</td><td>The database schema</td></tr>
<tr><td>maven.schemaspy.database.classpath</td><td>${pom.getDependencyPath("mssqlserver:mssqlserver")}:${pom.getDependencyPath("mssqlserver:msbase")}</td><td>no</td><td>The classpath to the driver. Notice the ":" seperating jars.</td></tr>
</table>
</section>
</body>
</document>
1.1 maven-plugins/schemaspy/xdocs/navigation.xml
Index: navigation.xml
===================================================================
<?xml version="1.0" encoding="ISO-8859-1"?>
<project>
<title>SchemaSpy Plugin</title>
<body>
<menu name="Overview">
<item name="Goals" href="/goals.html"/>
<item name="Properties" href="/properties.html"/>
<item name="SchemaSpy Home" href="http://schemaspy.sourceforge.net/"/>
</menu>
</body>
</project>
1.1 maven-plugins/schemaspy/xdocs/index.xml
Index: index.xml
===================================================================
<?xml version="1.0" encoding="ISO-8859-1"?>
<document>
<properties>
<title>Maven SchemaSpy Goals</title>
<author email="epu...@op...">Eric Pugh</author>
</properties>
<body>
<section name="RPM Plugin">
<p>
The RPM Plugin generates RPM Distributions from the project.
Those distributions include source distributions, binary distributions,
web applications distributions (if your project generates a web application).
</p>
<p>
The RPM plugin takes care for you about the dependencies, so that you can
easily install them and distribute them.
</p>
</section>
</body>
</document>
1.1 maven-plugins/schemaspy/xdocs/goals.xml
Index: goals.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Maven SchemaSpy Goals</title>
<author email="epu...@op...">Eric Pugh</author>
</properties>
<body>
<goals>
<goal>
<name>schemaspy</name>
<description>
Run schemaspy to generate documentation.
</description>
</goal>
<goal>
<name>schemaspy:info</name>
<description>
Display parameters being used.
</description>
</goal>
</goals>
</body>
</document>
|
