Author: jvanzyl
Date: Sat Mar 17 22:11:24 2007
New Revision: 519555
URL: http://svn.apache.org/viewvc?view=rev&rev=519555
Log: (empty)
Added:
maven/doxia/trunk/doxia-modules/doxia-module-docbook-simple/src/test/resources/
maven/doxia/trunk/doxia-modules/doxia-module-docbook-simple/src/test/resources/guide.xml
(with props)
maven/doxia/trunk/doxia-modules/doxia-module-itext/src/test/resources/apt/apt.apt
(with props)
Removed:
maven/doxia/trunk/doxia-modules/doxia-module-docbook-simple/src/test/site/
Modified:
maven/doxia/trunk/doxia-modules/pom.xml
Added:
maven/doxia/trunk/doxia-modules/doxia-module-docbook-simple/src/test/resources/guide.xml
URL:
http://svn.apache.org/viewvc/maven/doxia/trunk/doxia-modules/doxia-module-docbook-simple/src/test/resources/guide.xml?view=auto&rev=519555
==============================================================================
---
maven/doxia/trunk/doxia-modules/doxia-module-docbook-simple/src/test/resources/guide.xml
(added)
+++
maven/doxia/trunk/doxia-modules/doxia-module-docbook-simple/src/test/resources/guide.xml
Sat Mar 17 22:11:24 2007
@@ -0,0 +1,153 @@
+<?xml version='1.0' encoding='UTF-8' ?>
+<!--
+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.
+-->
+
+<!DOCTYPE article PUBLIC "-//OASIS//DTD Simplified DocBook XML V1.0CR2//EN"
+ "http://www.oasis-open.org/docbook/xml/simple/1.0CR2/sdocbook.dtd";>
+
+<article id="index">
+ <articleinfo>
+ <title>Geotools2 Developer Guide</title>
+
+ <author>
+ <firstname>Cameron</firstname>
+
+ <surname>Shorter</surname>
+ </author>
+
+ <date>22 May 2002</date>
+
+ <abstract>
+ <para>Guide to aid <filename>geotools2</filename> development.</para>
+ </abstract>
+ </articleinfo>
+
+ <section id="intro">
+ <title>Introduction</title>
+
+ <para>This document aims to help new geotools developers get up to speed
+ and track practices of existing developers in order to keep the project
+ consistent.</para>
+
+ <para>If you feel something is missing, feel free to contribute a new
+ section.</para>
+ </section>
+
+ <section id="design">
+ <title>Design</title>
+ <figure>
+ <title>Geotools Logo</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/developersguide/geotools_logo.png"
+ format="PNG"/>
+ </imageobject>
+ <textobject><phrase>Geotools Logo</phrase></textobject>
+ </mediaobject>
+ </figure>
+
+ <para>To do: Explain</para><itemizedlist><listitem><para>Key design
structure
+ (core interfaces, data sources, rendering,
tools)</para></listitem><listitem><para>Design
+ Drivers (Our design goals: modular, derives structure from netbeans,
+ support multiple version of java,
..)</para></listitem><listitem><para>Directory
+
structure</para></listitem><listitem><para></para></listitem></itemizedlist>
+ </section>
+
+ <section id="development">
+ <title>Development</title>
+
+ <section id="building">
+ <title>Building</title>
+
+ <para>To do:</para><itemizedlist><listitem><para>using
ant</para></listitem><listitem><para>what
+ ant checks</para></listitem><listitem><para>insert the
+ "howto-build.html" doc into
here</para></listitem><listitem><para></para></listitem></itemizedlist>
+ </section>
+
+ <section id="cvs">
+ <title>Code Versioning (using CVS)</title>
+
+ <para>To do:</para><itemizedlist><listitem><para>Point to sourceforge
CVS howto
+ links.</para></listitem><listitem><para>Also point to some HOWTOs for
+ windows users.</para></listitem><listitem><para>What is acceptable to
+ commit to CVS, what is not. (Ie, code should
compile)</para></listitem><listitem><para>Talk
+ about version numbering convention, use of branches, etc (if we decide
+ to do this).</para></listitem></itemizedlist>
+
+ <para>To do:</para>
+ </section>
+
+ <section id="CodingStandards">
+ <title>Coding Standards</title>
+
+ <para>To do:</para><itemizedlist><listitem><para>Using Sun's coding
+ standard, need to note any exceptions to
it.</para></listitem><listitem><para>Note
+ the auto checking of coding
standards.</para></listitem><listitem><para>Javadocs</para></listitem><listitem><para></para></listitem></itemizedlist>
+ </section>
+
+ <section id="templates">
+ <title>Template File</title>
+
+ <para>To do:</para><itemizedlist><listitem><para>Provide a template
file.</para></listitem><listitem><para>Link
+ it to sections explaining the different parts of the
template.</para></listitem><listitem><para>Include
+ headers, footers, example logging, example coding style, CVS key tags,
+ sample
javadocs.</para></listitem><listitem><para></para></listitem></itemizedlist>
+ </section>
+
+ <section id="logging">
+ <title>Logging</title>
+
+ <para>To do:</para><itemizedlist><listitem><para>Talk about log4j, links
to</para></listitem><listitem><para></para></listitem><listitem><para></para></listitem><listitem><para></para></listitem></itemizedlist>
+ </section>
+
+ <section id="testing">
+ <title>Testing</title>
+
+ <para>To do:</para><itemizedlist><listitem><para>Explain use of junit.
Might be
+ a link to another web
site.</para></listitem><listitem><para></para></listitem><listitem><para></para></listitem><listitem><para></para></listitem></itemizedlist>
+ </section>
+
+ <section>
+ <title>Documentation</title>
+
+ <para>To do:</para><itemizedlist><listitem><para>Talk about docbook, why
we
+ decided to use it (most commonly used format of LDP, converts to
+ multiple formats, tools coming which can support it. Need to mention
+ which version of docbook we are
using.</para></listitem><listitem><para>Mention
+ tools that can be used.</para></listitem><listitem><para>Links to
+ docbook references.</para></listitem><listitem><para>Process for
+ updating this document.</para></listitem><listitem><para>How to use ant
+ tools to build doc.</para></listitem></itemizedlist>
+ </section>
+ </section>
+
+ <section id="tools">
+ <title>Development Tools</title>
+
+ <section id="netbeans">
+ <title>Netbeans</title>
+
+ <para>To do:</para><itemizedlist><listitem><para>Where to get
it.</para></listitem><listitem><para>Aim
+ is to make geotools a module within
Netbeans</para></listitem><listitem><para>How
+ to setup getools to fit the multiple directory
structure</para></listitem><listitem><para>The
+ extra Netbeans modules that are useful and should be
downloaded.</para></listitem></itemizedlist>
+ </section>
+ </section>
+</article>
+
Propchange:
maven/doxia/trunk/doxia-modules/doxia-module-docbook-simple/src/test/resources/guide.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange:
maven/doxia/trunk/doxia-modules/doxia-module-docbook-simple/src/test/resources/guide.xml
------------------------------------------------------------------------------
svn:keywords = "Author Date Id Revision"
Added:
maven/doxia/trunk/doxia-modules/doxia-module-itext/src/test/resources/apt/apt.apt
URL:
http://svn.apache.org/viewvc/maven/doxia/trunk/doxia-modules/doxia-module-itext/src/test/resources/apt/apt.apt?view=auto&rev=519555
==============================================================================
---
maven/doxia/trunk/doxia-modules/doxia-module-itext/src/test/resources/apt/apt.apt
(added)
+++
maven/doxia/trunk/doxia-modules/doxia-module-itext/src/test/resources/apt/apt.apt
Sat Mar 17 22:11:24 2007
@@ -0,0 +1,207 @@
+ ------
+ Guide to uploading artifacts to Ibiblio
+ ------
+ Jason van Zyl
+ ------
+ 12 October 2005
+ ------
+
+Guide to uploading artifacts to Ibiblio
+
+ In order for users of Maven to utilize artifacts produced by your project you
must deploy them to
+ a remote repository. Many open source projects want to allow users of their
projects who build with
+ Maven to have transparent access to their project's artifacts. In order to
allow for this a project
+ must have their artifacts deployed the Ibiblio which acts as Maven's central
global repostory.
+
+* Step 1: Create an upload bundle
+
+ Use the repository plugin provided with the standard Maven distribution to
create an upload bundle:
+
++----+
+
+ mvn repository:bundle-create
+
++----+
+
+ The bundle will be created in your <<<target>>> directory of the form:
+ <<<${pom.artifactId}-${pom.currentVersion}-bundle.jar>>>
+
+ If you want to include a jar with java sources in your upload (recommended,
unless your license doesn't
+ allow sources to be redistributed) the command to run is:
+
++----+
+
+ mvn source:jar repository:bundle-create
+
++----+
+
+ If you are not using maven as your build system but want something
+ uploaded to Ibiblio then you just need to make a JAR (using the <<<jar>>>
executable,
+ not <<<zip>>>, <<<pkzip>>> or equivalent) with the following format:
+
++----+
+
+pom.xml
+foo-1.0.jar (or whatever artifact is referred to in the pom.xml)
+foo-1.0-sources.jar (optional, jar containing java sources)
+
++----+
+
+ Note that the bundle will be read by a script, so it must follow the above
format. Also,
+ the <<<pom.xml>>> should at least contain the following elements:
+
+ * modelVersion
+
+ * groupId
+
+ * artifactId
+
+ * packaging
+
+ * name
+
+ * version
+
+ * url
+
+ * licenses
+
+ * scm url
+
+ * description
+
+ * dependencies
+
+
+ A basic sample:
+
++----+
+
+<project>
+ <modelVersion>4.0.0</modelVersion>
+ <groupId>org.apache.maven</groupId>
+ <artifactId>maven</artifactId>
+ <version>2.0</version>
+ <packaging>jar</packaging>
+ <name>Maven core</name>
+ <url>http://maven.apache.org</url>
+ <description>The maven main core project description</description>
+ <licenses>
+ <license>
+ <name>The Apache Software License, Version 2.0</name>
+ <url>http://www.apache.org/licenses/LICENSE-2.0.txt</url>
+ <distribution>repo</distribution>
+ </license>
+ </licenses>
+ <scm>
+ <url>http://svn.apache.org/viewcvs.cgi/maven</url>
+ </scm>
+ <dependencies>
+ <dependency>
+ <groupId>...</groupId>
+ <artifactId>...</artifactId>
+ <version>...</version>
+ </dependency>
+ ...
+ </dependencies>
+</project>
+
++----+
+
+ []
+
+ Some considerations about the <<groupId>>: it will identify your project
uniquely across all
+ projects, so we need to enforce a naming schema. For projects with artifacts
already uploaded to ibiblio it can
+ be equal to the previous used, but for new projects it has to follow the
package name rules, what
+ means that has to be at least as a domain name you control, and you can
create as many subgroups
+ as you want.
+ There are a lot of poorly defined package names so you have to provide proof
that you control the domain that
+ matches the package name. Provide proof means that the project is hosted at
that domain or they own it although
+ not using it. eg. If you use a com.sun.xyz package name we expect that the
project is hosted at http://xyz.sun.com.
+
+ Look at
{{{http://java.sun.com/docs/books/jls/third_edition/html/packages.html#7.7}
+ More information about package names}}. Check also the guide about
+ {{{guide-naming-conventions.html}Maven naming conventions}}
+
+ Examples:
+
+ * www.springframework.org -> org.springframework
+
+ * oness.sf.net -> net.sf.oness
+
+ []
+
+* Step 2: Posting the request
+
+ Post your request to
{{{http://jira.codehaus.org/secure/CreateIssue.jspa?pid=10367&issuetype=3}JIRA}}.
+ In the description you should write the URL of the upload bundle
+ (if you're uploading more than one bundle please add all the urls under the
same issue),
+ then leave a blank line and provide the following:
+
+ * a url where the project can be found.
+
+ * if you are one of its developers, a url where your name or email can be
found inside the project site.
+
+ []
+
+ This will speed up the uploading process.
+
+ You can place any additional comments you wish in the following paragraph. So
the description field might look like:
+
++----+
+
+http://wiggle.sourceforge.net/downloads/wiggle-1.0-bundle.jar
+
+http://wiggle.sourceforge.net
+http://wiggle.sourceforge.net/team-list.html
+
+Wiggle is a fantastic new piece of software for automating the
+clipping of nose hairs. Please upload!
+
++----+
+
+* Explanation
+
+ Some folks have asked why do we require the POM and license each time an
artifact is deployed so here's a small explanation. The POM
+ being deployed with the artifact is part of the process to make transitive
dependencies a reality in Maven. The logic for getting
+ transitive dependencies working is really not that hard, the problem is
getting the data. The other applications
+ that may be possible having all the POMs available for artifacts are vast, so
by placing them into the repository as part of the
+ process we open up the doors to new ideas that involve unified
+ access to project POMs.
+
+ We also ask for a license now because it is possible that your project's
license may change in the course of
+ its life time and we are trying create tools to help normal people sort out
licensing issues. For example, knowing all the licenses
+ for a particular graph of artifacts we could have some strategies that would
identify potential licensing problems.
+
+* Maven partners
+
+ The following sites sync automatically their project repository with the
central one.
+ If you want a project from any of this sites to be uploaded to ibiblio you'll
have to
+ contact the project maintainers.
+
+ * {{{http://www.apache.org}The Apache Software Foundation}}
+
+ * {{{http://www.codehaus.org}Codehaus}}
+
+ * {{{http://jetty.mortbay.org}MortBay Jetty}}
+
+ * {{{http://www.opensymphony.com/}OpenSymphony}}
+
+ * {{{http://www.osjava.org}OS Java}}
+
+
+*-------------------------+---------+----------+-----------+
+| | Mirrors | Checksum | Signature |
+*-------------------------+---------+----------+-----------+
+| Maven 2.0.3 (tar.bz2) |
{{{http://www.apache.org/dyn/closer.cgi/maven/binaries/maven-2.0.3-bin.tar.bz2}
maven-2.0.3-bin.tar.bz2}} |
{{{http://www.apache.org/dist/maven/binaries/maven-2.0.3-bin.tar.bz2.md5}
maven-2.0.3-bin.tar.bz2.md5}} |
{{{http://www.apache.org/dist/maven/binaries/maven-2.0.3-bin.tar.bz2.asc}
maven-2.0.3-bin.tar.bz2.asc}} |
+*-------------------------+---------+----------+-----------+
+| Maven 2.0.3 (tar.gz) |
{{{http://www.apache.org/dyn/closer.cgi/maven/binaries/maven-2.0.3-bin.tar.gz}
maven-2.0.3-bin.tar.gz}} |
{{{http://www.apache.org/dist/maven/binaries/maven-2.0.3-bin.tar.gz.md5}
maven-2.0.3-bin.tar.gz.md5}} |
{{{http://www.apache.org/dist/maven/binaries/maven-2.0.3-bin.tar.gz.asc}
maven-2.0.3-bin.tar.gz.asc}} |
+*-------------------------+---------+----------+-----------+
+| Maven 2.0.3 (zip) |
{{{http://www.apache.org/dyn/closer.cgi/maven/binaries/maven-2.0.3-bin.zip}
maven-2.0.3-bin.zip}} |
{{{http://www.apache.org/dist/maven/binaries/maven-2.0.3-bin.zip.md5}
maven-2.0.3-bin.zip.md5}} |
{{{http://www.apache.org/dist/maven/binaries/maven-2.0.3-bin.zip.asc}
maven-2.0.3-bin.zip.asc}} |
+*-------------------------+---------+----------+-----------+
+| Maven 2.0.3 Tasks for Ant |
{{{http://www.apache.org/dyn/closer.cgi/maven/binaries/maven-artifact-ant-2.0.3-dep.jar}
maven-artifact-ant-2.0.3-dep.jar}} |
{{{http://www.apache.org/dist/maven/binaries/maven-artifact-ant-2.0.3-dep.jar.md5}
maven-artifact-ant-2.0.3-dep.jar.md5}} |
{{{http://www.apache.org/dist/maven/binaries/maven-artifact-ant-2.0.3-dep.jar.asc}
maven-artifact-ant-2.0.3-dep.jar.asc}} |
+*-------------------------+---------+----------+-----------+
+| Maven 2.0.3 Embedder |
{{{http://www.apache.org/dyn/closer.cgi/maven/binaries/maven-embedder-2.0.3-dep.jar}
maven-embedder-2.0.3-dep.jar}} |
{{{http://www.apache.org/dist/maven/binaries/maven-embedder-2.0.3-dep.jar.md5}
maven-embedder-2.0.3-dep.jar.md5}} |
{{{http://www.apache.org/dist/maven/binaries/maven-embedder-2.0.3-dep.jar.asc}
maven-embedder-2.0.3-dep.jar.asc}} |
+*-------------------------+---------+----------+-----------+
+Table caption
+
Propchange:
maven/doxia/trunk/doxia-modules/doxia-module-itext/src/test/resources/apt/apt.apt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange:
maven/doxia/trunk/doxia-modules/doxia-module-itext/src/test/resources/apt/apt.apt
------------------------------------------------------------------------------
svn:keywords = "Author Date Id Revision"
Modified: maven/doxia/trunk/doxia-modules/pom.xml
URL:
http://svn.apache.org/viewvc/maven/doxia/trunk/doxia-modules/pom.xml?view=diff&rev=519555&r1=519554&r2=519555
==============================================================================
--- maven/doxia/trunk/doxia-modules/pom.xml (original)
+++ maven/doxia/trunk/doxia-modules/pom.xml Sat Mar 17 22:11:24 2007
@@ -1,5 +1,4 @@
<?xml version="1.0" encoding="UTF-8"?>
-
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
@@ -17,9 +16,7 @@
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
--->
-
-<project xmlns="http://maven.apache.org/POM/4.0.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
http://maven.apache.org/maven-v4_0_0.xsd";>
+--><project xmlns="http://maven.apache.org/POM/4.0.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
http://maven.apache.org/maven-v4_0_0.xsd";>
<modelVersion>4.0.0</modelVersion>
<parent>
<artifactId>doxia</artifactId>
@@ -33,13 +30,11 @@
<dependency>
<groupId>org.apache.maven.doxia</groupId>
<artifactId>doxia-core</artifactId>
- <version>1.0-alpha-9-SNAPSHOT</version>
</dependency>
<dependency>
<groupId>org.apache.maven.doxia</groupId>
<artifactId>doxia-core</artifactId>
- <version>1.0-alpha-9-SNAPSHOT</version>
- <type>test-jar</type>
+ <classifier>tests</classifier>
</dependency>
</dependencies>
<modules>
@@ -47,5 +42,11 @@
<module>doxia-module-docbook-simple</module>
<module>doxia-module-twiki</module>
<module>doxia-module-itext</module>
+ <module>doxia-module-apt</module>
+ <module>doxia-module-fml</module>
+ <module>doxia-module-latex</module>
+ <module>doxia-module-rtf</module>
+ <module>doxia-module-xdoc</module>
+ <module>doxia-module-xhtml</module>
</modules>
-</project>
+</project>
\ No newline at end of file
