Table of Contents

.bookmarks

1 Introduction

• 1.1 Document Overview
• 1.2 System Overview
• 1.3 Documentation License
• 1.4 Source License

2 Building

• 2.1 Language — Java 1.5 extended with JAI and ImageIO
• 2.2 Dependencies — download and install
  • 1 Java Install
  • 2 Maven Install
  • 3 Subversion Optional Install
  • 4 Oracle Optional Dependency
• 2.3 Source Code — obtain the geotools source code
• 2.4 Using Subversion — helpful subversion tips
• 2.5 Using Maven — an easy-to-use build tool
  • 2.5.1 Build All Modules
  • 2.5.2 Maven Local Settings and Repository
  • 2.5.3 Building an individual module
  • 2.5.4 Doing things other than building
  • 2.5.5 Project Object Model (POM) Files
  • 2.5.6 Remote Repository and Files
  • 2.5.7 Testing with Maven
  • 2.5.8 Maven Eclipse Plugin Goals
  • 2.5.9 Working with Others
• 2.6 Generating Javadoc
• 2.7 Generating Maven reports

3 Communication

• 3.1 Internet Relay Chat
• 3.2 Email
• 3.3 Issue Tracker
  • How to Create a new Issue
• 3.4 Websites

4 Roles and Responsibilities

• 1 Contributors
• 2 Committers
• 3 Module Maintainers
• 4 Project Management Committee

5 Project Conventions

• 5.1 Coding Guidelines
  • 5.1.1 Coding Conventions — use Jalopy
  • 5.1.2 Do not return null
  • 5.1.3 Logging
  • 5.1.4 Exception handling
  • 5.1.5 Avoid assumptions
  • 5.1.6 Converting URLs to Files
  • 5.1.7 Use of Assertions, IllegalArgumentException and NPE
• 5.2 Naming Conventions — use PMD
• 5.3 Module Directory Structure
• 5. 5 Refactoring
• 5. 6 Code Profiling
• 5. 7 Testing — JUnit
  • Online Test Fixtures
• 5. 8 Test Data
• 5. 9 Versioning

6 Documentation

• 01 User Guide Welcome
• 02 User Guide
• 05 Confluence Tips and Tricks
• 06 GeoTools 2.0 Documentation

7 Project Procedures

• Continuous Integration
• Creating your own Module
• GeoTools change proposal
• Gold Star Quality Assurance Check
• Hacking
• How to add a 3rd party jar
• How to cut a release
  • Announcement
• Making a major API shift
• Supporting your module
• Working on a stable branch

8 Design and Architecture

• 8.1 Architecture
  • Detailed Model
  • Plugin Extension Model
• 8.2 Modular Design
  • Module Categories
• 8.4 Data Access
• 8.5 Patterns
  • Abstract Factory

9 Tools

• Eclipse Developers Guide
  • Eclipse FAQ
  • Eclipse Setup and Build
• IDEA4
• IDEA Project File Generation with Maven
• ImageIO
• NetBeans developers guide
• Omondo
• YourKit profiler

A Reference

• Version
  • ArcSDE
  • DB2
  • JAI
  • JDK
  • JRE
  • Maven
  • Oracle

Editors' Corner

Export and Print

You can export printable pdf as a guide to the GeoTools Community and Development Practices.

1. Create an account and login to this wiki
2. Click Browse Space > Advanced on the left hand side
3. Select &Export Space*
4. Select how you would like to download this space HTML or PDF
5. Press the Export button .. and wait.

Progress of this documentation project:

• Docs: 4 issues

Writing Guidelines:

• Use parent/child relationships for table of contents
• Use a number to start your page name for order
• Provide definitions as child pages of Glosary
• InkScape for digrams (attach svg and png to page)
• Target audience are geotools committers

Notes:

• Navigation

_{(Child pages Home)}

Focus