dion 2002/06/06 10:10:24
Added: src/test-xslt developersguide.xml
Log:
no message
Revision Changes Path
1.1 jakarta-turbine-maven/src/test-xslt/developersguide.xml
Index: developersguide.xml
===================================================================
<!--
<?xml-stylesheet type="text/css"
href="file:/usr/java/xxe-m13p1-bin/css/docbook41.css"
?>
<?xml-stylesheet type="text/css"
href="file:/usr/java/xxe-m13p1-bin/css/docbook.css"
title="Previous docbook stylesheet"
alternate="yes"
?>
-->
<!--"file:/usr/java/xxe-m13p1-bin/dtd/docbook/docbookx.dtd"-->
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.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>
<sect1 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>
</sect1>
<sect1 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<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></para>
</sect1>
<sect1 id="development">
<title>Development</title>
<sect2 id="building">
<title>Building</title>
<para>To do:<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></para>
</sect2>
<sect2 id="cvs">
<title>Code Versioning (using CVS)</title>
<para>To do:<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>
<para>To do:</para>
</sect2>
<sect2 id="CodingStandards">
<title>Coding Standards</title>
<para>To do:<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></para>
</sect2>
<sect2 id="templates">
<title>Template File</title>
<para>To do:<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></para>
</sect2>
<sect2 id="logging">
<title>Logging</title>
<para>To do:<itemizedlist><listitem><para>Talk about log4j, links
to</para></listitem><listitem><para></para></listitem><listitem><para></para></listitem><listitem><para></para></listitem></itemizedlist></para>
</sect2>
<sect2 id="testing">
<title>Testing</title>
<para>To do:<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></para>
</sect2>
<sect2>
<title>Documentation</title>
<para>To do:<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></para>
</sect2>
</sect1>
<sect1 id="tools">
<title>Development Tools</title>
<sect2 id="netbeans">
<title>Netbeans</title>
<para>To do:<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></para>
</sect2>
</sect1>
</article>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
