Author: buildbot
Date: Tue Dec 23 07:12:40 2014
New Revision: 933723
Log:
Staging update by buildbot for sis
Added:
websites/staging/sis/trunk/content/contributor.html
Modified:
websites/staging/sis/trunk/content/ (props changed)
websites/staging/sis/trunk/content/book/en/developer-guide.html
websites/staging/sis/trunk/content/index.html
websites/staging/sis/trunk/content/source.html
websites/staging/sis/trunk/content/team-list.html
Propchange: websites/staging/sis/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Tue Dec 23 07:12:40 2014
@@ -1 +1 @@
-1641873
+1647492
Modified: websites/staging/sis/trunk/content/book/en/developer-guide.html
==============================================================================
Binary files - no diff available.
Added: websites/staging/sis/trunk/content/contributor.html
==============================================================================
--- websites/staging/sis/trunk/content/contributor.html (added)
+++ websites/staging/sis/trunk/content/contributor.html Tue Dec 23 07:12:40 2014
@@ -0,0 +1,238 @@
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <title>New contributor</title>
+ <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+ <link rel="stylesheet" type="text/css" media="screen"
href="css/bootstrap.min.css">
+ <link rel="stylesheet" type="text/css" media="screen"
href="http://www.apache.org/css/code.css";>
+ <link rel="stylesheet" type="text/css" media="screen" href="css/sis.css">
+
+
+
+
+ <!-- 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. -->
+ </head>
+
+ <body>
+ <div class="navbar navbar-inverse navbar-fixed-top">
+ <div class="navbar-inner">
+ <div class="container">
+ <a class="brand" href="/index.html"> Apache SIS™ </a>
+ <div class="nav-collapse">
+ <ul class="nav">
+ <li class="dropdown"> <a class="dropdown-toggle"
data-toggle="dropdown">About<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="mail-lists.html">Mailing Lists</a></li>
+ <li><a href="license.html">Project License</a></li>
+ <li><a href="team-list.html">Project Team</a></li>
+ </ul>
+ </li>
+ <li class="dropdown"> <a class="dropdown-toggle"
data-toggle="dropdown">Project Documentation<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="book/en/developer-guide.html">Developer
guide</a></li>
+ <li><a href="apidocs/index.html">Online Javadoc</a></li>
+ <li><a href="downloads.html">Downloads</a></li>
+ <li><a href="source.html">Source Code</a></li>
+ <li><a href="code-patterns.html">Code patterns</a></li>
+ <li><a href="faq.html">FAQ</a></li>
+ <li><a
href="https://issues.apache.org/jira/browse/SIS";>Issue Tracker</a></li>
+ </ul>
+ </li>
+ <li class="dropdown"> <a class="dropdown-toggle"
data-toggle="dropdown">ASF <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="http://www.apache.org";>The Foundation</a></li>
+ <li><a
href="http://www.apache.org/foundation/thanks.html";>Thanks</a></li>
+ <li><a
href="http://www.apache.org/foundation/sponsorship.html";>Become a
Sponsor</a></li>
+ <li><a
href="http://www.apache.org/security/";>Security</a></li>
+ </ul>
+ </li>
+ </ul>
+ </div> <!-- /.nav-collapse -->
+ </div><!-- /.container -->
+ </div><!-- /.navbar-inner -->
+ </div>
+
+ <div class="container-fluid">
+ <div class="row-fluid">
+ <div class="span2">
+ <img src="img/logo.png"/>
+ <div class="well sidebar-nav">
+ <ul class="nav nav-list">
+ <li class="active"><a href="index.html">Home</a></li>
+ <li><a href="mail-lists.html">Mailing Lists</a></li>
+ <li><a href="license.html">Project License</a></li>
+ <li><a href="team-list.html">Project Team</a></li>
+ <li class="nav-header">Project Documentation</li>
+ <li><a href="book/en/developer-guide.html">Developer
guide</a></li>
+ <li><a href="apidocs/index.html">Online Javadoc</a></li>
+ <li><a href="downloads.html">Downloads</a></li>
+ <li><a href="source.html">Source Code</a></li>
+ <li><a href="code-patterns.html">Code patterns</a></li>
+ <li><a href="faq.html">FAQ</a></li>
+ <li><a href="https://issues.apache.org/jira/browse/SIS";>Issue
Tracker</a></li>
+ <li class="nav-header">ASF</li>
+ <li><a href="http://www.apache.org";>The Foundation</a></li>
+ <li><a
href="http://www.apache.org/foundation/thanks.html";>Thanks</a></li>
+ <li><a
href="http://www.apache.org/foundation/sponsorship.html";>Become a
Sponsor</a></li>
+ <li><a href="http://www.apache.org/security/";>Security</a></li>
+ </ul>
+ </div><!--/.well -->
+ </div><!--/span-->
+ <div class="span10">
+ <section id="content" class="row">
+ <article class="span12">
+ <p class="page-title">New contributor</p>
+ <p>Improving and extending SIS requires extensive knowledge of
geographic information science,
+object oriented programming, the Java language, and of the library itself.
Contributors should
+expect that they will need to learn a great deal before being able to become
productive.
+However, the effort required to become productive should improve the
contributor's understanding
+and knowledge of geographic information systems, of geodetic and geographic
science, and of
+effective computer programming.</p>
+<p>This document is expected to evolve as the SIS project develops its own
mode of operation.</p>
+<div class="toc">
+<ul>
+<li><a href="#knowledge">Background Knowledge</a><ul>
+<li><a href="#science">Geographic Information Systems and Science</a></li>
+<li><a href="#ogc">The ISO/OGC Geospatial Model</a></li>
+<li><a href="#java">Object-Oriented Programming in Java</a></li>
+<li><a href="#math">Mathematical Background</a></li>
+<li><a href="#geoapi">The GeoAPI Interfaces</a></li>
+<li><a href="#modules">The SIS library modules</a></li>
+</ul>
+</li>
+<li><a href="#source">Fetching and editing source code</a><ul>
+<li><a href="#svn-config">Configuring Subversion properties</a></li>
+</ul>
+</li>
+</ul>
+</div>
+<h1 id="knowledge">Background Knowledge</h1>
+<p>All contributors arrive to the project with different knowledge bases, some
with scientific
+backgrounds, some with a background in computer science, and others with
geographic backgrounds
+or even no training in geographic information science at all. By sharing the
richness of our
+individual backgrounds we have acquired a list of subjects which we consider
critical to fully
+understanding the SIS project. New contributors are highly encouraged to
explore these
+areas if they have no or little knowledge of them.</p>
+<h2 id="science">Geographic Information Systems and Science</h2>
+<p>While a background in the field is not required, it nonetheless proves
exceedingly useful along the way.
+GIS has developed its own language and has particular concerns which return
frequently.
+Issues of spatial representation, data size, spatial scale, information
workflows and other topics
+arise frequently and are worth understanding.</p>
+<p>A good general introduction to the field is the book <em>Geographic
Information Systems and Science</em>
+by Paul A. Longley, Michael F. Goodchild, David J. Maguire and David W. Rhind
published in its
+second edition by John Wiley and Sons Ltd. in 2004.</p>
+<h2 id="ogc">The <abbr title="International Organization for
Standardization">ISO</abbr>/<abbr title="Open Geospatial Consortium">OGC</abbr>
Geospatial Model</h2>
+<p>SIS builds on the standards developed through a collaboration between the
International
+Organization for Standardization (<abbr title="International Organization for
Standardization">ISO</abbr>) and the Open Geospatial Consortium (<abbr
title="Open Geospatial Consortium">OGC</abbr>).
+Contributors to SIS should have at least a basic understanding of the model
developed in the
+<abbr title="International Organization for Standardization">ISO</abbr> 19000
series of specifications, starting with the Abstract model and working through
the
+<em>Feature</em> model. While the <abbr title="International Organization for
Standardization">ISO</abbr> specifications are sold, the <abbr title="Open
Geospatial Consortium">OGC</abbr> releases its own, essentially
+identical versions of standards which have evolved from the collaboration. The
<abbr title="Open Geospatial Consortium">OGC</abbr> specifications
+are available for the <a href="http://www.opengeospatial.org/standards";><abbr
title="Open Geospatial Consortium"><abbr title="Open Geospatial
Consortium">OGC</abbr></abbr> standards and specification</a> page.</p>
+<p>As time progresses, we hope to develop documentation material to introduce
the <abbr title="International Organization for Standardization">ISO</abbr>
19000 specification series.
+Most of this documentation can be found in the <a
href="book/en/developer-guide.html">Apache SIS developer guide</a>.</p>
+<h2 id="java">Object-Oriented Programming in Java</h2>
+<p>SIS is a library designed to be used by other programmers. To play this
role effectively,
+SIS must consider the various ways that users can reuse Java code: not only
through object
+instantiation and method calls but also through inheritance. SIS pays special
attention to
+accessibility constraints ensuring that only the classes and methods which are
offered for
+use are publicly accessible and that these methods are fully and correctly
documented in javadoc.</p>
+<p>Contributors are highly recommended to read the book <em>Effective
Java</em> by Joshua Block, published
+in its second edition by Addison-Wesley in 2008. The book explains the
importance of certain
+elements in the Java language and discusses subtleties of the language and its
use.
+Most importantly, the book reveals the full scope a programmer must consider
when developing a code library.</p>
+<p>The <a href="code-patterns.html">Recommended code patterns</a> page also
discusses some elements
+of special importance to Apache SIS.</p>
+<h2 id="math">Mathematical Background</h2>
+<p>SIS frequently deals with complex calculations using relatively simple
mathematics of
+trigonometry and matrix algebra. The coordinate operations of the Referencing
modules involve
+trigonometric transformations on a flattened ellipsoid of rotation, the image
transformations in
+the Coverage modules and in the Rendering system involve extensive use of
Affine transforms, and
+the Analytic modules often use their own mathematical operations.
+These mathematics cannot be simplified â they reflect the richness of the
world around us.</p>
+<p>Affine transformations are not particularly complex but critically
important both to the
+geo-referencing operations of the Referencing modules and to the image
transformations of the
+Coverage modules. Affines transform coordinates through translation, scaling,
rotations, and
+shear, though this latter component is used infrequently in the library.
Mathematically,
+affine transformations are usually applied as a matrix operation applied to a
coordinate vector.
+There are numerous introductions to affine transformations available on the
World Wide Web since
+the concept is central to all graphics programming.</p>
+<h2 id="geoapi">The GeoAPI Interfaces</h2>
+<p>SIS is build partially as an implementation of the GeoAPI interfaces.
GeoAPI defines a set
+of objects offering particular methods thereby providing an interpretation of
the <abbr title="International Organization for
Standardization">ISO</abbr>/<abbr title="Open Geospatial Consortium">OGC</abbr>
+standards in the Java language. GeoAPI therefore defines the core of the model
implemented
+by Apache SIS.</p>
+<p>GeoAPI can most easily be learned by exploring the <a
href="http://www.geoapi.org/3.0/javadoc/index.html";>GeoAPI Javadoc</a>.</p>
+<h2 id="modules">The SIS library modules</h2>
+<p>Contributors should gain a basic understanding of the core library
including the separation into modules,
+the functionality available in the base module, and the functioning of the
modules of interest.</p>
+<h1 id="source">Fetching and editing source code</h1>
+<p>Different SIS <a href="branches.html">branches</a> are available depending
on the target platforms.
+Unless working on a SIS port (e.g. to the Android platform), contributors are
encouraged
+to work on the SIS branch targeting the most recent JDK platform (currently
JDK8):</p>
+<div class="codehilite"><pre>svn checkout
https://svn.apache.org/repos/asf/sis/branches/JDK8 sis
+<span class="nb">cd </span>sis
+mvn install
+</pre></div>
+
+
+<h2 id="svn-config">Configuring Subversion properties</h2>
+<p>Subversion can associate properties to each tracked files. Those properties
tell to Subversion
+how to handle platform-specific aspects like end-of-line characters, and how
to serve the files
+to web browsers (MIME type, encoding, <etc.>).
+Those properties are typically set when a new file is added, not during
modifications.
+Developers can specify default properties for all their Subversion working
copies as below:</p>
+<ul>
+<li>Open <code>~/.subversion/config</code> in an editor, where <code>~</code>
is the user home directory.</li>
+<li>Set the <code>enable-auto-props</code> value to <code>yes</code>.</li>
+<li>
+<p>Scroll down to the <code>[auto-props]</code> section and add the following
lines:</p>
+<p>:::text
+<em>.java = svn:mime-type=text/plain;svn:eol-style=native
+</em>.sql = svn:mime-type=text/plain;svn:eol-style=native
+<em>.txt = svn:mime-type=text/plain;svn:eol-style=native
+</em>.properties = svn:mime-type=text/plain;svn:eol-style=native
+<em>.xml = svn:mime-type=text/xml;svn:eol-style=native
+</em>.xsd = svn:mime-type=text/xml;svn:eol-style=native
+<em>.sld = svn:mime-type=text/xml;svn:eol-style=native
+</em>.gml = svn:mime-type=text/xml;svn:eol-style=native
+<em>.xsl = svn:mime-type=text/xsl;svn:eol-style=native
+</em>.html = svn:mime-type=text/html;svn:eol-style=native
+<em>.xhtml = svn:mime-type=text/html;svn:eol-style=native
+</em>.css = svn:mime-type=text/css;svn:eol-style=native
+<em>.bat = svn:eol-style=CRLF
+</em>.sh = svn:eol-style=native;svn:executable
+<em>.bmp = svn:mime-type=image/bmp
+</em>.png = svn:mime-type=image/png
+<em>.jpg = svn:mime-type=image/jpeg
+</em>.jpeg = svn:mime-type=image/jpeg
+<em>.gif = svn:mime-type=image/gif
+</em>.tif = svn:mime-type=image/tiff
+<em>.tiff = svn:mime-type=image/tiff
+</em>.zip = svn:mime-type=application/zip
+<em>.utf = svn:mime-type=application/octet-stream
+</em>.shp = svn:mime-type=application/octet-stream
+<em>.shx = svn:mime-type=application/octet-stream
+</em>.dbf = svn:mime-type=application/octet-stream
+README = svn:mime-type=text/plain;svn:eol-style=native</p>
+</li>
+</ul>
+ </article>
+ </section>
+ </div><!--/span-->
+ </div><!--/row-fluid-->
+ </div><!--/container-fluid-->
+
+ <footer class="footer">
+ <div class="container">
+ <p>Copyright © 2013-2014 The Apache Software Foundation, Licensed
under the
+ <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License,
Version 2.0</a>.<br />
+ Apache SIS, Apache, the Apache feather logo are trademarks of The
Apache Software Foundation.</p>
+ </div>
+ </footer>
+
+ <script src="js/jquery-1.9.1.min.js"></script>
+ <script src="js/bootstrap.min.js"></script>
+
+</body>
+</html>
Modified: websites/staging/sis/trunk/content/index.html
==============================================================================
--- websites/staging/sis/trunk/content/index.html (original)
+++ websites/staging/sis/trunk/content/index.html Tue Dec 23 07:12:40 2014
@@ -102,11 +102,12 @@ The version under development is 0.5-SNA
<li>Developer guide (<a href="book/en/developer-guide.html">English</a> | <a
href="book/fr/developer-guide.html">French</a>) - note that this is work in
progress.</li>
<li><a href="command-line.html">Command-line interface</a> for an overview of
a command-line tool.</li>
<li><a href="http://cwiki.apache.org/confluence/display/SIS";>SIS Wiki</a> for
"drawing board" and roadmap.</li>
-<li><a href="code-patterns.html">Recommended code patterns</a></li>
+<li><a href="code-patterns.html">Recommended code patterns</a> for writing
more robust applications.</li>
</ul>
<h2 id="developer">SIS developer documentation</h2>
<ul>
-<li><a href="source.html">Source code</a>: fetching the code, opening in an
IDE, developing, formatting.</li>
+<li><a href="contributor.html">New contributor</a>: background knowledge.</li>
+<li><a href="source.html">Source code</a>: fetching the code, opening in an
IDE, formatting.</li>
<li><a href="build.html">Build</a>: build from the source, create the PACK200
file.</li>
<li><a href="branches.html">Branches</a>: trunk, JDK6, JDK7, JDK8.</li>
<li><a href="http://issues.apache.org/jira/browse/SIS";>Issue tracking</a>:
JIRA.</li>
Modified: websites/staging/sis/trunk/content/source.html
==============================================================================
--- websites/staging/sis/trunk/content/source.html (original)
+++ websites/staging/sis/trunk/content/source.html Tue Dec 23 07:12:40 2014
@@ -95,7 +95,8 @@ For fetching the source code, choose one
</pre></div>
-<p>The remaining of this page provides tips for SIS developers.</p>
+<p>The remaining of this page provides tips for SIS developers.
+Committers are encouraged to read the <a href="contributor.html">new
contributors</a>.</p>
<div class="toc">
<ul>
<li><a href="#ide">Opening Apache SIS in an IDE</a><ul>
@@ -103,16 +104,7 @@ For fetching the source code, choose one
<li><a href="#eclipse">Eclipse</a></li>
</ul>
</li>
-<li><a href="#developing">Developing Apache SIS</a><ul>
-<li><a href="#knowledge">Background Knowledge</a><ul>
-<li><a href="#science">Geographic Information Systems and Science</a></li>
-<li><a href="#ogc">The ISO/OGC Geospatial Model</a></li>
-<li><a href="#java">Object-Oriented Programming in Java</a></li>
-<li><a href="#math">Mathematical Background</a></li>
-<li><a href="#geoapi">The GeoAPI Interfaces</a></li>
-<li><a href="#modules">The SIS library modules</a></li>
-</ul>
-</li>
+<li><a href="#classes-naming">Classes naming convention</a></li>
<li><a href="#formatting">Code formatting</a><ul>
<li><a href="#javadoc-tags">Javadoc annotations</a></li>
<li><a href="#html">HTML elements</a></li>
@@ -123,9 +115,6 @@ For fetching the source code, choose one
</ul>
</li>
</ul>
-</li>
-<li><a href="#classes-naming">Classes naming convention</a></li>
-</ul>
</div>
<h1 id="ide">Opening Apache SIS in an IDE</h1>
<p>Different SIS branches are available depending on the target platforms
(JDK6 versus JDK7 or JDK8, or GeoAPI versions).
@@ -169,74 +158,16 @@ then execute the following steps:</p>
<li>Go to <em>File</em> â <em>Import</em> â <em>General</em> â
<em>Existing Projects in Workspace</em>.</li>
<li>Choose the <code>sis</code> directory and import.</li>
</ul>
-<h1 id="developing">Developing Apache SIS</h1>
-<p>Improving and extending SIS requires extensive knowledge of geographic
information science,
-object oriented programming, the Java language, and of the library itself.
Contributors should
-expect that they will need to learn a great deal before being able to become
productive.
-However, the effort required to become productive should improve the
contributor's understanding
-and knowledge of geographic information systems, of geodetic and geographic
science, and of
-effective computer programming.</p>
-<p>This document is expected to evolve as the SIS project develops its own
mode of operation.</p>
-<h2 id="knowledge">Background Knowledge</h2>
-<p>All contributors arrive to the project with different knowledge bases, some
with scientific
-backgrounds, some with a background in computer science, and others with
geographic backgrounds
-or even no training in geographic information science at all. By sharing the
richness of our
-individual backgrounds we have acquired a list of subjects which we consider
critical to fully
-understanding the SIS project. New contributors are highly encouraged to
explore these
-areas if they have no or little knowledge of them.</p>
-<h3 id="science">Geographic Information Systems and Science</h3>
-<p>While a background in the field is not required, it nonetheless proves
exceedingly useful along the way.
-GIS has developed its own language and has particular concerns which return
frequently.
-Issues of spatial representation, data size, spatial scale, information
workflows and other topics
-arise frequently and are worth understanding.</p>
-<p>A good general introduction to the field is the book <em>Geographic
Information Systems and Science</em>
-by Paul A. Longley, Michael F. Goodchild, David J. Maguire and David W. Rhind
published in its
-second edition by John Wiley and Sons Ltd. in 2004.</p>
-<h3 id="ogc">The <abbr title="International Organization for
Standardization">ISO</abbr>/<abbr title="Open Geospatial Consortium">OGC</abbr>
Geospatial Model</h3>
-<p>SIS builds on the standards developed through a collaboration between the
International
-Organization for Standardization (<abbr title="International Organization for
Standardization">ISO</abbr>) and the Open Geospatial Consortium (<abbr
title="Open Geospatial Consortium">OGC</abbr>).
-Contributors to SIS should have at least a basic understanding of the model
developed in the
-<abbr title="International Organization for Standardization">ISO</abbr> 19000
series of specifications, starting with the Abstract model and working through
the
-<em>Feature</em> model. While the <abbr title="International Organization for
Standardization">ISO</abbr> specifications are sold, the <abbr title="Open
Geospatial Consortium">OGC</abbr> releases its own, essentially
-identical versions of standards which have evolved from the collaboration. The
<abbr title="Open Geospatial Consortium">OGC</abbr> specifications
-are available for the <a href="http://www.opengeospatial.org/standards";><abbr
title="Open Geospatial Consortium"><abbr title="Open Geospatial
Consortium">OGC</abbr></abbr> standards and specification</a> page.</p>
-<p>As time progresses, we hope to develop documentation material to introduce
the <abbr title="International Organization for Standardization">ISO</abbr>
19000 specification series.</p>
-<h3 id="java">Object-Oriented Programming in Java</h3>
-<p>SIS is a library designed to be used by other programmers. To play this
role effectively,
-SIS must consider the various ways that users can reuse Java code: not only
through object
-instantiation and method calls but also through inheritance. SIS pays special
attention to
-accessibility constraints ensuring that only the classes and methods which are
offered for
-use are publicly accessible and that these methods are fully and correctly
documented in javadoc.</p>
-<p>Contributors are highly recommended to read the book <em>Effective
Java</em> by Joshua Block, published
-in its second edition by Addison-Wesley in 2008. The book explains the
importance of certain
-elements in the Java language and discusses subtleties of the language and its
use.
-Most importantly, the book reveals the full scope a programmer must consider
when developing a code library.</p>
-<p>The <a href="code-patterns.html">Recommended code patterns</a> page also
discusses some elements
-of special importance to Apache SIS.</p>
-<h3 id="math">Mathematical Background</h3>
-<p>SIS frequently deals with complex calculations using relatively simple
mathematics of
-trigonometry and matrix algebra. The coordinate operations of the Referencing
modules involve
-trigonometric transformations on a flattened ellipsoid of rotation, the image
transformations in
-the Coverage modules and in the Rendering system involve extensive use of
Affine transforms, and
-the Analytic modules often use their own mathematical operations.
-These mathematics cannot be simplified â they reflect the richness of the
world around us.</p>
-<p>Affine transformations are not particularly complex but critically
important both to the
-geo-referencing operations of the Referencing modules and to the image
transformations of the
-Coverage modules. Affines transform coordinates through translation, scaling,
rotations, and
-shear, though this latter component is used infrequently in the library.
Mathematically,
-affine transformations are usually applied as a matrix operation applied to a
coordinate vector.
-There are numerous introductions to affine transformations available on the
World Wide Web since
-the concept is central to all graphics programming.</p>
-<h3 id="geoapi">The GeoAPI Interfaces</h3>
-<p>SIS is build partially as an implementation of the GeoAPI interfaces.
GeoAPI defines a set
-of objects offering particular methods thereby providing an interpretation of
the <abbr title="International Organization for
Standardization">ISO</abbr>/<abbr title="Open Geospatial Consortium">OGC</abbr>
-standards in the Java language. GeoAPI therefore defines the core of the model
implemented
-by Apache SIS.</p>
-<p>GeoAPI can most easily be learned by exploring the <a
href="http://www.geoapi.org/3.0/javadoc/index.html";>GeoAPI Javadoc</a>.</p>
-<h3 id="modules">The SIS library modules</h3>
-<p>Contributors should gain a basic understanding of the core library
including the separation into
-modules, the functionality available in the base module, and the functioning
of the modules of interest.</p>
-<h2 id="formatting">Code formatting</h2>
+<h1 id="classes-naming">Classes naming convention</h1>
+<p>Implementations of GeoAPI interfaces usually (but not always) begin with
<code>Abstract</code>, <code>Default</code>, <code>Simple</code> or
<code>General</code> prefixes.</p>
+<ul>
+<li>The <code>Abstract</code> prefix is used when a class is abstract
according <abbr title="International Organization for
Standardization">ISO</abbr> specifications â it may or may not be be abstract
in the Java sense.</li>
+<li>The <code>General</code> prefix is used when an implementation is designed
for use in the general case,
+ as opposed to other implementations specialized for a fixed number of
dimensions or other conditions.</li>
+<li>Implementations specialized for a fixed number of dimensions are suffixed
with <code>1D</code>, <code>2D</code>, <code>3D</code> or <code>4D</code>
rather than being prefixed.</li>
+</ul>
+<p>Classes that do not implement an interface are usually not prefixed, even
if abstract.</p>
+<h1 id="formatting">Code formatting</h1>
<p>Apache SIS uses the standard Java conventions, except for the 80 characters
line length restriction.
Other exceptions to the coding conventions may occur when tabular formatting
can improve readability,
as in the example below:</p>
@@ -252,7 +183,7 @@ Formatting the code in a way that emphas
aligning identical terms in columns, can help to understand the overall pattern
and to identify bugs. The decision to use standard or tabular format is made on
a case-by-case basis. Of course, tabular format shall not be abused.</p>
-<h3 id="javadoc-tags">Javadoc annotations</h3>
+<h2 id="javadoc-tags">Javadoc annotations</h2>
<p>SIS uses standard javadoc annotations. The meaning of some tags are refined
as below:</p>
<ul>
<li><code>@since</code> - the SIS version when the annotated element (class,
method, <i>etc.</i>) was first introduced.</li>
@@ -288,7 +219,7 @@ a case-by-case basis. Of course, tabular
</tr>
</tbody>
</table>
-<h3 id="html">HTML elements</h3>
+<h2 id="html">HTML elements</h2>
<p>HTML tags and entities shall be used only when there is no equivalent
Javadoc tag.
For example:</p>
<ul>
@@ -297,7 +228,7 @@ For example:</p>
<li>Instead of "<code><pre>â</pre></code>" for a Java listing,
use "<code>{@preformat java â}</code>"
(this Javadoc tag is specific to Apache SIS â see above table).</li>
</ul>
-<h3 id="mathml">MathML elements</h3>
+<h2 id="mathml">MathML elements</h2>
<p>The source code occasionally uses MathML for formulas that are difficult to
render with only Unicode characters.
PNG images are not extensively used for formulas because they are difficult to
edit after creation,
and their content are invisible to search operations (for example when a
variable is renamed).
@@ -312,14 +243,14 @@ For an introduction to MathML, see:</p>
Internet Explorer users need to <a
href="http://www.dessci.com/en/products/mathplayer/download.htm";>install a
plugin</a>.
Firefox users can optionally install the <a
href="http://developer.mozilla.org/en-US/docs/Mozilla/MathML_Project/Fonts";>fonts
for Mozilla's MathML engine</a> for better results.
Note that a <a href="http://www.mathjax.org/";>JavaScript display engine</a> is
available for all browsers, but not yet used by SIS.</p>
-<h3 id="paragraph">Paragraphs</h3>
+<h2 id="paragraph">Paragraphs</h2>
<p>Usages of the <code><p></code> tag should be relatively rare.
Do <strong>not</strong> use <code><p></code> for the first paragraph in
a package, class or member documentation,
or for the first paragraph after a <code></ul></code>,
<code></ol></code>, <code></table></code>,
<code></blockquote></code>, <code></pre></code>,
<code>{@preformat}</code> or <code>{@section}</code> element.
The <code><p></code> tag shall be used only for separating a new
paragraph from a previous one.
In such cases, <code><p></code> shall have a matching
<code></p></code> tag at the paragraph end in order to form valid
HTML.</p>
-<h3 id="css">Javadoc CSS</h3>
+<h2 id="css">Javadoc CSS</h2>
<p>Avoid using HTML attributes other than <code>class</code> as much as
possible.
Instead, rely on styling. Some HTML tags having a style definition in Apache
SIS are:</p>
<table>
@@ -368,7 +299,7 @@ Instead, rely on styling. Some HTML tags
</tr>
</tbody>
</table>
-<h3 id="miscellaneous">Miscellaneous</h3>
+<h2 id="miscellaneous">Miscellaneous</h2>
<ul>
<li><strong>License Header:</strong> Always add the current ASF license header
as described in <a href="http://www.apache.org/legal/src-headers.html";>ASF
Source Header</a>.</li>
<li><strong>Trailing Whitespaces:</strong> Remove all trailing whitespaces.<ul>
@@ -384,12 +315,6 @@ Instead, rely on styling. Some HTML tags
<li><strong>Line wrapping:</strong> Use 120-column line width for Java code
and Javadoc.
Some exceptions to this rule may exist for preserving tabular structures,
but should be rare.</li>
</ul>
-<h1 id="classes-naming">Classes naming convention</h1>
-<p>Implementations of GeoAPI interfaces usually (but not always) begin with
<code>Abstract</code>, <code>Default</code>, <code>Simple</code> or
<code>General</code> prefixes.
-The <code>Abstract</code> prefix is used when a class is abstract according
<abbr title="International Organization for Standardization">ISO</abbr>
specifications â it may or may not be be abstract in the Java sense.
-The <code>General</code> prefix is used when an implementation is designed for
use in the general case,
-as opposed to other implementations specialized for a fixed number of
dimensions or other conditions.
-Implementations specialized for a fixed number of dimensions are suffixed with
<code>1D</code>, <code>2D</code>, <code>3D</code> or <code>4D</code> rather
than being prefixed.</p>
</article>
</section>
</div><!--/span-->
Modified: websites/staging/sis/trunk/content/team-list.html
==============================================================================
--- websites/staging/sis/trunk/content/team-list.html (original)
+++ websites/staging/sis/trunk/content/team-list.html Tue Dec 23 07:12:40 2014
@@ -87,6 +87,7 @@
<li>Adam Estrada</li>
<li>Andrew Hart</li>
<li>Charitha</li>
+<li>Marc Le Bihan</li>
<li>Martin Desruisseaux</li>
<li>Gregory D. Reddin</li>
<li>Ian Holsman</li>
