sis-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From desruisse...@apache.org
Subject svn commit: r1866065 - in /sis/site/trunk: content/code-patterns.mdtext content/coding-conventions.mdtext content/index.mdtext content/release-management.mdtext content/source.mdtext content/team-list.mdtext templates/skeleton.html
Date Thu, 29 Aug 2019 10:46:39 GMT
Author: desruisseaux
Date: Thu Aug 29 10:46:39 2019
New Revision: 1866065

URL: http://svn.apache.org/viewvc?rev=1866065&view=rev
Log:
Web site cleanup:
- Move Alexis Manin from contributors to developers list.
- Extract coding conventions to a separated page.
- Omit "code patterns" page from the quick links, since it provides few value.
- Update copyright year.

Added:
    sis/site/trunk/content/coding-conventions.mdtext
      - copied, changed from r1866061, sis/site/trunk/content/source.mdtext
Modified:
    sis/site/trunk/content/code-patterns.mdtext
    sis/site/trunk/content/index.mdtext
    sis/site/trunk/content/release-management.mdtext
    sis/site/trunk/content/source.mdtext
    sis/site/trunk/content/team-list.mdtext
    sis/site/trunk/templates/skeleton.html

Modified: sis/site/trunk/content/code-patterns.mdtext
URL: http://svn.apache.org/viewvc/sis/site/trunk/content/code-patterns.mdtext?rev=1866065&r1=1866064&r2=1866065&view=diff
==============================================================================
--- sis/site/trunk/content/code-patterns.mdtext (original)
+++ sis/site/trunk/content/code-patterns.mdtext Thu Aug 29 10:46:39 2019
@@ -54,7 +54,7 @@ Georeference images with affine transfor
 --------------------------------------------------------------------------------
 
 Many users define the geographic extent of an image by its corner locations.
-This approach is not sufficient as it does not specify if the (<var>x</var>,<var>y</var>)
axes are interchanged
+This approach may be ambiguous as it does not specify whether the (<var>x</var>,<var>y</var>)
axes are interchanged
 (see the [axis order issue](faq.html#axisOrder)) or if the <var>y</var> axis
is oriented downward.
 All images in SIS shall be georeferenced by at least an affine transform (more complex transforms
are also possible),
 never by a rectangle or bounding box.
@@ -75,13 +75,13 @@ Specify timezone    {#timezone}
 Geospatial data often cover a wide geographic area, spanning many time zones.
 Timezone are sometime specified as metadata in the header of data files to be read,
 or is sometime fixed to UTC by applications managing world-wide data.
-Many SIS objects have `Locale` and `TimeZone` fields.
-Such locale and timezone shall be given to `java.text.DateFormat` or `java.util.Calendar`
constructors.
+Some Apache SIS objects have `Locale` and `TimeZone` information.
+Such locale and timezone are given to `java.text.DateFormat` or `java.util.Calendar` constructors
among others.
 
 When reading dates or timestamps from a JDBC database, always use the `ResultSet` method
 accepting a `Calendar` argument, when such method is available.
 For example prefer the `getTimestamp(int, Calendar)` method instead than `getTimestamp(int)`.
-The `Calendar` object shall has been created with the appropriate timezone.
+The `Calendar` object should has been created with the appropriate timezone.
 
 
 
@@ -102,7 +102,7 @@ Loop over character sequences using code
 Since Java 1.5, characters are no longer restricted to 16 bits.
 Some "characters" are actually represented using two consecutive `char` elements.
 Those "characters" are called <cite>code points</cite>.
-Consequently, when iterating over characters in a string, the following pattern shall be
used:
+Consequently, when iterating over characters in a string, the following pattern should be
used:
 
     :::java
     for (int i=0; i<string.length();) {
@@ -117,32 +117,14 @@ Consequently, when iterating over charac
 Logging    {#logging}
 =====================
 
-Apache SIS uses the `java.util.logging` framework with one minor difference:
-instead of invoking the `getLogger(String)` method provided by the `java.util.logging.Logger`
class,
-we rather invoke the method provided by the `apache.sis.util.logging.Logging` class.
-The result is identical by default,
-but the SIS method gives a chance to redirect the logging to an other framework like Log4J
if desired.
-The difference between the SIS approach and other facades like `common-logging` is that SIS
uses the
-standard Java API (except for the above-cited `getLogger` method) instead than defining a
new API.
-
-
-
-Logger name    {#logger-name}
------------------------------
-
-The name given in argument to the `getLogger(String)` method is usually the package name
of the class
-emitting the log messages, but not necessarily. In particular, we do not follow this convention
if the class
-is located in an internal package (`org.apache.sis.internal.*`) since those packages are
considered privates.
-In such cases, the logger name should be the package name of the public class that use the
internal class.
-
-The reason for the above rule is that logger names are considered part of the public API,
+Apache SIS uses the `java.util.logging` framework, but with a [mechanism allowing users to
redirect
+to another framework](http://sis.apache.org/apidocs/org/apache/sis/util/logging/LoggerFactory.html).
+The logger names are usually the package name of the class emitting log messages, but not
necessarily.
+In particular, we do not follow this convention if the class is located in an internal package
+(`org.apache.sis.internal.*`) since those packages are considered privates.
+In such cases, the logger name should be the package name of the public class invoking the
internal methods.
+The reason for that rule is that logger names are considered part of the public API,
 since developers use them for configuring their logging (verbosity, destination, <i>etc.</i>).
-Note that the "real" package name of the emitter is available by `LogRecord.getSourceClassName()`.
-
-
-
-Logging level    {#logging-level}
----------------------------------
 
 All logging at `Level.INFO` or above shall be targeted to users or administrators, not to
developers.
 In particular `Level.SEVERE` shall be reserved for critical errors that compromise the application
stability —

Copied: sis/site/trunk/content/coding-conventions.mdtext (from r1866061, sis/site/trunk/content/source.mdtext)
URL: http://svn.apache.org/viewvc/sis/site/trunk/content/coding-conventions.mdtext?p2=sis/site/trunk/content/coding-conventions.mdtext&p1=sis/site/trunk/content/source.mdtext&r1=1866061&r2=1866065&rev=1866065&view=diff
==============================================================================
--- sis/site/trunk/content/source.mdtext [UTF-8] (original)
+++ sis/site/trunk/content/coding-conventions.mdtext [UTF-8] Thu Aug 29 10:46:39 2019
@@ -17,162 +17,12 @@ Notice: Licensed to the Apache Software
         under the License.
 
 
-Apache SIS source code is maintained using [Git][git] version control.
-Additional data not included in SIS releases are maintained separately using [Subversion][subversion]
version control.
-Those data include in particular the [EPSG geodetic dataset](epsg.html) and are subject to
different licensing terms.
-The Git repository is [mirrored on GitHub][github-sis] and the non-free data can be [browsed
online][viewvc-non-free].
-For fetching the source code and those additional data, use the following commands:
-
-    :::bash
-    git clone https://gitbox.apache.org/repos/asf/sis
-    svn checkout https://svn.apache.org/repos/asf/sis/data/non-free/
-
-The source code repository contains `geoapi-3.1` and `geoapi-4.0` branches in addition of
`master`.
-The Apache SIS releases are created from the code on `master` only.
-However the actual development occurs on the `geoapi-4.0` branch before to be merged to `master`.
-Those branches exist in order to experiment early new API and technologies — since it may
impact
-the library design — while keeping the releases compatible with officially released environments.
-The remaining of this page gives some guidelines about the way SIS source code is organized.
+This page describes some coding conventions applied in Apache SIS development.
 
 [TOC]
 
 
 
-Development branches    {#development}
-======================================
-
-Users who want stability are encouraged to build from the `master`.
-The master depends on GeoAPI 3.0.1,
-which is the [latest GeoAPI][geoapi-stable] released by the Open Geospatial Consortium (OGC).
-Developers who want to contribute to Apache SIS are encouraged to use the `geoapi-4.0` branch
for now.
-
-
-
-GeoAPI 4.0 branch    {#geoapi-4.0}
-----------------------------------
-
-The `geoapi-4.0` branch is the recommended development branch for now.
-This branch implements the interfaces defined in GeoAPI 4.0 snapshot milestones.
-This branch uses new interfaces introduced in GeoAPI 4.0-SNAPSHOT and contains upgrades for
changes in existing GeoAPI interfaces.
-Some changes in GeoAPI 4.0-SNAPSHOT interfaces are incompatible with GeoAPI 3.0.1 interfaces.
-They are caused by changes in the underlying international standards, or by evolution of
Java technology.
-The content of this branch may be fully merged to `master` in the future, depending on new
GeoAPI releases from OGC.
-
-
-
-GeoAPI 3.1 branch    {#geoapi-3.1}
-----------------------------------
-
-The `geoapi-3.1` branch implements the interfaces defined in [GeoAPI 3.1 snapshot][geoapi-snapshot]
milestones.
-It has the same content that the `geoapi-4.0` branch, excluding changes that are incompatible
with GeoAPI 3.0.1.
-Developments happen on `geoapi-4.0` and are periodically merged to `geoapi-3.1` with the
necessary modifications.
-This branch is used merely as an intermediate step between the development branch (`geoapi-4.0`)
and `master`.
-Its content may be fully merged to `master` in the future, after new GeoAPI releases from
OGC.
-
-
-
-Master    {#master}
--------------------
-
-The master is a merge of `geoapi-3.1` branch ported to the interfaces defined by the [GeoAPI
stable release][geoapi-stable].
-This is the code which is built by the continuous integration system and deployed on the
Maven repository.
-**Commits on master can not be removed, since `git push --force` are not allowed on this
branch.**
-Commits should be pushed on above-cited development branch first,
-so they can be rearranged if needed before merge to `master`.
-
-
-### Code differences    {#differences}
-
-The main differences (apart version number) between `master` and `geoapi-3.1/4.0` branches
-are the modifications necessary for implementing an older version of GeoAPI interfaces.
-In particular, usages of non-released GeoAPI interfaces may be replaced
-by direct usages of the corresponding Apache SIS implementation classes.
-
-For security reasons and for avoiding misleading information, the following functionalities
are disabled on master for now
-(but are still enabled on branches as experimental features). In particular the `Supervisor.ENABLED`
flag controls
-whether the MBeans documented in the `org.apache.sis.console` package are enabled or not.
-
-  * In `core/sis-utility/src/main/java/org/apache/sis/internal/system/Supervisor.java`, the
`ENABLED` flag is set to `false`.
-  * In `core/sis-utility/src/main/java/org/apache/sis/internal/util/TemporalUtilities.java`,
the `REPORT_MISSING_MODULE` flag is set to `false`.
-
-
-### Behavioral differences    {#behavior}
-
-Because of changes between GeoAPI 3.0 and GeoAPI 4.0-SNAPSHOT, the following aspects need
special care:
-
-  * If `op` is an instance of `PassThroughOperation`, then the `if (op instanceof SingleOperation)`
expression
-    evaluates to `true` on master but to `false` on SIS development branches.
-
-
-
-History    {#history}
----------------------
-
-All developments and tags prior Apache SIS 1.0 were done on a [Subversion][subversion] repository
-and can be [browsed online][viewvc].
-Tags for Apache SIS versions 0.1 to 0.8 should be fetched from the [SVN repository][svn-sis-tags].
-The development branches on that repository were named `JDK8`, `JDK7`, `JDK6` and `trunk`.
-
-
-
-Opening Apache SIS in an IDE    {#ide}
-======================================
-
-Different SIS branches are available depending on the GeoAPI versions.
-The alternatives are listed in [above section](#development).
-One thing to take in consideration can be summarized as below:
-
-   * There is no need to build GeoAPI prior working on SIS master.
-   * When working on a SIS development branch, we recommend to build GeoAPI 4.0-SNAPSHOT
locally first.
-
-While the primarily SIS build system is Maven, the project provides some IDE configuration
files for developers convenience.
-Before opening the project in an IDE, the source code needs to be downloaded from the source
repository
-and the project built at least once using Maven:
-
-    :::bash
-    git clone https://gitbox.apache.org/repos/asf/sis.git
-    cd sis
-    mvn install
-
-
-
-NetBeans    {#netbeans}
------------------------
-
-NetBeans can open Maven projects natively. This is the recommended approach for casual working
in a small amount of SIS modules.
-For extensive work on Apache SIS or for work impacting many modules, it may be more convenient
and faster to open Apache SIS as a NetBeans project.
-Such pre-configured NetBeans project is available in the `ide-project/NetBeans` directory.
-This project will fetch dependencies directly from the `.m2/repository` local directory,
-and will refer to the resources `*.utf` files compiled by Maven in the `sis-*/target` directories.
-Consequently it is important to run `mvn install` before opening the project
-and after any change in the project dependencies or in the resources.
-
-Users can customize their project configuration by editing the `ide-project/NetBeans/nbproject/private/config.properties`
file.
-The `private` directory is excluded by the versioning system, so it okay to put user-specific
information there.
-For example in order to overwrite the default location of the local Maven repository and
to define a system property at execution time,
-one can use:
-
-    :::properties
-    maven.repository = /path/to/my/local/repository
-    run.jvmargs = -DmyProperty=myValue
-
-
-
-Eclipse    {#eclipse}
----------------------
-
-Execute the `svn checkout` to `mvn install` commands documented in the beginning of this
section,
-then execute the following steps:
-
-   * Execute `mvn eclipse:eclipse` on the command line.
-   * Open Eclipse in a new workspace.
-   * Go to _Eclipse_ → _Preferences_ → _General_ → _Workspace_.
-   * Change _Text file encoding_ to _Other: UTF-8_, press _Apply_, then _Ok_.
-   * Go to _File_ → _Import_ → _General_ → _Existing Projects in Workspace_.
-   * Choose the `sis` directory and import.
-
-
-
 
 License header    {#license}
 ============================
@@ -412,12 +262,6 @@ Note that a [JavaScript display engine][
 *[ISO]: International Organization for Standardization
 *[OGC]: Open Geospatial Consortium
 
-[viewvc]:           http://svn.apache.org/viewvc/sis/
-[viewvc-non-free]:  http://svn.apache.org/viewvc/sis/data/non-free/
-[subversion]:       http://subversion.apache.org
-[git]:              http://git-scm.com
-[github-sis]:       https://github.com/apache/sis
-[svn-sis-tags]:     https://svn.apache.org/repos/asf/sis/tags/
 [srcheaders]:       http://www.apache.org/legal/src-headers.html
 [JLS-order]:        http://docs.oracle.com/javase/specs/jls/se8/html/jls-8.html#jls-8.1.1
 [mathml-wolfram]:   http://reference.wolfram.com/mathematica/XML/tutorial/MathML.html
@@ -425,5 +269,3 @@ Note that a [JavaScript display engine][
 [mathml-fonts]:     http://developer.mozilla.org/en-US/docs/Mozilla/MathML_Project/Fonts
 [mathml-plugin-ie]: http://www.dessci.com/en/products/mathplayer/download.htm
 [mathml-mathjax]:   http://www.mathjax.org/
-[geoapi-stable]:    http://www.geoapi.org/3.0/index.html
-[geoapi-snapshot]:  http://www.geoapi.org/snapshot/index.html

Modified: sis/site/trunk/content/index.mdtext
URL: http://svn.apache.org/viewvc/sis/site/trunk/content/index.mdtext?rev=1866065&r1=1866064&r2=1866065&view=diff
==============================================================================
--- sis/site/trunk/content/index.mdtext [UTF-8] (original)
+++ sis/site/trunk/content/index.mdtext [UTF-8] Thu Aug 29 10:46:39 2019
@@ -29,7 +29,7 @@ The SIS storage modules provide a common
 Some Apache SIS features are:
 
   * Geographic metadata (ISO 19115-1:2014)
-    * Read from or written to ISO 19139 compliant XML documents.
+    * Read from or written to ISO 19115-3 compliant XML documents, or the previous version
(ISO 19139:2007).
     * Read from netCDF, GeoTIFF, Landsat, GPX and Moving Feature CSV encoding.
     * Automatic conversions between the model published in 2003 and the revision published
in 2014.
   * Referencing by coordinates (ISO 19111:2007)
@@ -53,7 +53,8 @@ Using Apache SIS    {#user}
 The latest SIS release is 0.8, released November 2017.
 Apache SIS requires a Java 7 or 8 Runtime Environment.
 There is known incompatibilities with Java 9, which will be fixed in next version.
-The EPSG geodetic dataset (optional but recommended) can be [installed separately](epsg.html).
+The EPSG geodetic dataset is optional for licensing reasons, but recommended.
+EPSG database installation is [described in a separated page](epsg.html).
 
 Apache SIS is a Java library for use by other applications.
 Leveraging the full SIS capabilities or getting the best performance require that users write
their own applications on top of SIS.
@@ -67,12 +68,13 @@ However a command-line tool is provided
 
 
 
-Apache SIS developer documentation    {#developer}
---------------------------------------------------
+Developing Apache SIS    {#developer}
+-------------------------------------
 Following links are for those who wish to contribute to Apache SIS:
 
   * [New contributor](contributor.html): background knowledge.
-  * [Source code](source.html): fetching the code, choosing a branch, opening in an IDE,
formatting.
+  * [Source code](source.html): fetching the code, choosing a branch, opening in an IDE.
+  * [Coding conventions](coding-conventions.html): source code formatting.
   * [Build](build.html): build from the source, create the distribution file.
   * [Issue tracking][JIRA]: JIRA.
   * [Release management](release-management.html) (for release managers)

Modified: sis/site/trunk/content/release-management.mdtext
URL: http://svn.apache.org/viewvc/sis/site/trunk/content/release-management.mdtext?rev=1866065&r1=1866064&r2=1866065&view=diff
==============================================================================
--- sis/site/trunk/content/release-management.mdtext [UTF-8] (original)
+++ sis/site/trunk/content/release-management.mdtext [UTF-8] Thu Aug 29 10:46:39 2019
@@ -312,6 +312,8 @@ In addition to testing, execution of an
 
 Open the `pom.xml` file of all modules in the `non-free` group.
 Set their version numbers and their SIS dependencies to `$NEW_VERSION` without `-SNAPSHOT`
suffix.
+In the root `pom.xml` file, remove the `<scope>provider</scope>` line.
+Create tags and trunk directories.
 Commit and built:
 
     :::bash

Modified: sis/site/trunk/content/source.mdtext
URL: http://svn.apache.org/viewvc/sis/site/trunk/content/source.mdtext?rev=1866065&r1=1866064&r2=1866065&view=diff
==============================================================================
--- sis/site/trunk/content/source.mdtext [UTF-8] (original)
+++ sis/site/trunk/content/source.mdtext [UTF-8] Thu Aug 29 10:46:39 2019
@@ -173,242 +173,6 @@ then execute the following steps:
 
 
 
-
-License header    {#license}
-============================
-
-All Java source files (`*.java`) shall begin with the current ASF license header as described
in [ASF Source Header][srcheaders].
-Properties source files (`*.properties`) used as inputs to some processor (e.g. the resource
compiler)
-shall have the same license header, but with lines prefixed by `#` instead of `*`.
-Properties files distributed as-is in the JAR files can summarize the license on a single
line for saving space,
-as below:
-
-    :::text
-    # Licensed to the Apache Software Foundation (ASF) under one or more contributor license
agreements.
-
-
-
-
-Naming convention    {#naming}
-==============================
-
-Classes that do not implement an interface are usually not prefixed, even if abstract.
-Classes implementing GeoAPI interfaces usually (but not always) begin with `Abstract`, `Default`,
`Simple` or `General` prefix.
-
-  * The `Abstract` prefix is used when a class is abstract according ISO specifications —
it may or may not be be abstract in the Java sense.
-  * The `General` 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 `1D`,
`2D`, `3D` or `4D` rather than being prefixed.
-
-Example: `GeneralEnvelope` class is an implementation of `Envelope` interface for the multi-dimensional
case.
-`Envelope2D` is another implementation of the same interface specialized for the two-dimensional
case.
-
-
-
-Internal packages    {#internal}
---------------------------------
-
-All classes in `org.apache.sis.internal` sub-packages are for SIS usage only and may change
without warning in any future release.
-Those classes are excluded from Javadoc and will not be exported by SIS Jigsaw modules.
-Those packages may be renamed after SIS upgraded to JDK 9.
-
-
-
-Substitution for non-existent classes    {#substitutions}
----------------------------------------------------------
-
-When using a JDK 9 class that does not exist on JDK 8, define a class of the same name in
a
-`org.apache.sis.internal` sub-package with the minimal amount of needed functionalities,
-provided that it can be done with reasonable effort.
-Otherwise just delete the JDK9-dependent code from the development branch.
-
-
-
-Code formatting    {#formatting}
-================================
-
-Apache SIS uses the standard Java conventions, except for the 80 characters line length restriction.
-The conventions listed below are guidelines. Some exceptions to those conventions can occur
but should
-be rare (see [exceptions to coding conventions](#tabular-formatting)).
-
-For making merges between branches easier, refrain from doing massive code reformatting unless:
-
-  * the modified files do not yet exist on the other branches;
-  * or the modified lines are known to be identical on all active branches (merges work well
in such cases);
-  * or the committer is willing to resolve the merge conflicts.
-
-
-
-Import statements    {#imports}
--------------------------------
-
-Isolate at the end of the imports section any import statements that are specific to a platform.
-This separation allows any branch to re-arrange the common import statements without generating
-conflicts with the platform-dependent import statements. Example:
-
-    :::java
-    import java.io.File;
-    import java.util.List;
-    import org.opengis.metadata.Metadata;
-
-    // Branch-specific imports
-    import org.opengis.feature.Feature;
-
-
-
-Spaces and line length    {#spaces}
------------------------------------
-
-  * **Indentation:** Use a consistent space indents and never use tabs.
-    + Use 4 space indents for Java files.
-    + Use 2 space indents for XML files, because ISO/OGC XML schemas tend to have a very
deep structure.
-  * **Space after keyword:** Put a space after `if`, `else`, `for`, `try`, `catch` and similar
keywords
-    (not after method names).
-  * **Trailing Whitespaces:** Remove all trailing whitespaces.
-    + Eclipse users can use the _Source_ - _Cleanup_ option to accomplish this.
-    + NetBeans users can use the use the _Source_ - _Remove trailing spaces_ on a file-by-file
basis,
-      or set the _Preferences_ - _Editor_ - _On Save_ - _Remove trailing whitespaces_ option.
-  * **Line wrapping:** 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.
-
-
-
-Brackets    {#brackets}
------------------------
-
-  * **Curly brackets:** The `{` and `}` brackets are mandatory for `if`, `else`, `while`
and other blocks,
-    except if the instruction after the keyword is on the same line (e.g. `else if`).
-
-
-
-Member declarations    {#declarations}
---------------------------------------
-
-  * Class, method and field declarations shall use the keywords in the following order.
-    This is known as the "customary order" in the [Java Language Specification][JLS-order]:
-    + `public`, `protected` or `private`,
-    + `abstract` or `static`,
-    + `final`,
-    + `strictfp` (should be applied on all test classes).
-  * Member fields do not have any particular prefix (no `m_` prefix).
-
-
-
-Exceptions to coding conventions    {#tabular-formatting}
----------------------------------------------------------
-
-Many mathematical operations in a two-dimensional space (or more) have symmetry.
-Formatting the code in a way that emphase their symmetrical nature, for example
-aligning identical terms in columns, can help to understand the overall pattern
-and to identify bugs. Example:
-
-    :::java
-    if (x < xmin) xmin = x;
-    if (x > xmax) xmax = x;
-    if (y < ymin) ymin = y;
-    if (y > ymax) ymax = y;
-
-The decision to use standard or tabular format is made on a case-by-case basis.
-Of course, tabular format shall not be abused.
-
-
-
-
-Documentation formatting    {#javadoc}
-======================================
-
-Apache SIS uses the standard Javadoc conventions, except for the 80 characters line length
restriction.
-Javadoc lines should not exceed 120 characters, but exceptions to this rule may exist for
preserving the
-structure of `<table>` elements.
-
-
-
-Javadoc annotations    {#javadoc-tags}
---------------------------------------
-
-SIS uses standard javadoc annotations. The meaning of some tags are refined as below:
-
-  * `@since`   - the SIS version when the annotated element (class, method, <i>etc.</i>)
was first introduced.
-  * `@version` - the last SIS version when the code of the annotated class got a significant
change.
-  * `@author`  - developer name in <var>FirstName</var> <var>LastName</var>
(<var>Organization</var>) format.
-                 A separated `@author` tag is added for each developer.
-                 The intent is to allow other developers to know to who to ask questions
if needed.
-
-In addition, the `sis-build-helper` modules provides the following custom javadoc taglets:
-
-Javadoc tag    | Description
--------------- | -------------------------------------------------------------------------------------------
-`@module`      | Create links to the module where the class is defined, source code and Maven
artifacts.
-`{@include}`   | Include the content of a given HTML file below a `<h2>` section having
the given title.
-`{@preformat}` | An inline taglet for pre-formatted text. The first word inside the taglet
shall be one of `java`, `xml`, `sql`, `wkt`, `text`, `math` or `shell`.
-
-
-
-HTML elements    {#html}
-------------------------
-
-HTML tags and entities shall be used only when there is no equivalent Javadoc tag.
-For example:
-
-   * Instead of "`<code>✎</code>`", use "`{@code ✎}`".
-   * Instead of "`a &lt; b &lt; c`", use "`{@literal a < b < c}`".
-   * Instead of "`<pre>✎</pre>`" for a Java listing, use "`{@preformat java
✎}`"
-     (this Javadoc tag is specific to Apache SIS — see above table).
-
-
-
-### Paragraphs    {#paragraph}
-
-Usages of the `<p>` tag should be relatively rare, since we use CSS styles (see below)
-as much as possible for controlling the margin between elements like lists and tables.
-Do **not** use `<p>` for the first paragraph in a package, class or member documentation,
-or for the first paragraph after a `</ul>`, `</ol>`, `</table>`, `</blockquote>`,
`</pre>`,
-or `{@preformat}` element.
-The `<p>` tag shall be used only for separating a new paragraph from a previous one.
-In such cases, `<p>` shall have a matching `</p>` tag at the paragraph end in
order to form valid HTML.
-
-
-
-### Javadoc CSS    {#css}
-
-Avoid using HTML attributes other than `class` as much as possible.
-Instead, rely on styling. Some HTML tags having a style definition in Apache SIS are:
-
-HTML tag                  | Description
-------------------------- | -------------------------------------------------------------------------------------------
-`<div class="section">`   | Header of a sub-section in a package, class or member description.
-`<div class="note">`      | Indented text with smaller font, used for notes or examples.
-`<div class="warning">`   | Text in red color, used for warning about probable API
changes.
-`<ul>` and `<ol>`         | Default list styles with few space between items
(suitable for compact lists).
-`<ul class="verbose">`    | A list style with space between items. Used for lists having
verbose (multi-lines) items.
-`<table class="compact">` | Table without border and no space between rows. Used for
lists with columns alignment.
-`<table class="sis">`     | Table with a border, blue headers, light background and
some space between columns.
-`<th class="hsep">`       | In SIS tables, draw a line on the top border. Used for
drawing table section separators.
-`<th class="sep">`        | In SIS tables, draw a bright line on the left border. Used
for drawing column separators.
-`<td class="sep">`        | In SIS tables, draw a bright line on the left border. Used
for drawing column separators.
-
-
-
-MathML elements    {#mathml}
-----------------------------
-
-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).
-For examples of MathML usage in SIS, search for the `<math …>` XML tag in Java source
files
-(note: there is also legacy `{@preformat math …}` custom Javadoc tags, but they may be
phased out as MathML adoption increase).
-For an introduction to MathML, see:
-
-   * [A Gentle Introduction to MathML][mathml-dessci] on Design Science
-   * [Working with MathML][mathml-wolfram] on Wolfram Mathematica
-
-MathML is supported natively in Firefox, Safari and Opera.
-Internet Explorer users need to [install a plugin][mathml-plugin-ie].
-Firefox users can optionally install the [fonts for Mozilla's MathML engine][mathml-fonts]
for better results.
-Note that a [JavaScript display engine][mathml-mathjax] is available for all browsers, but
not yet used by SIS.
-
-
-
 *[ISO]: International Organization for Standardization
 *[OGC]: Open Geospatial Consortium
 
@@ -418,12 +182,5 @@ Note that a [JavaScript display engine][
 [git]:              http://git-scm.com
 [github-sis]:       https://github.com/apache/sis
 [svn-sis-tags]:     https://svn.apache.org/repos/asf/sis/tags/
-[srcheaders]:       http://www.apache.org/legal/src-headers.html
-[JLS-order]:        http://docs.oracle.com/javase/specs/jls/se8/html/jls-8.html#jls-8.1.1
-[mathml-wolfram]:   http://reference.wolfram.com/mathematica/XML/tutorial/MathML.html
-[mathml-dessci]:    http://www.dessci.com/en/reference/mathml/
-[mathml-fonts]:     http://developer.mozilla.org/en-US/docs/Mozilla/MathML_Project/Fonts
-[mathml-plugin-ie]: http://www.dessci.com/en/products/mathplayer/download.htm
-[mathml-mathjax]:   http://www.mathjax.org/
 [geoapi-stable]:    http://www.geoapi.org/3.0/index.html
 [geoapi-snapshot]:  http://www.geoapi.org/snapshot/index.html

Modified: sis/site/trunk/content/team-list.mdtext
URL: http://svn.apache.org/viewvc/sis/site/trunk/content/team-list.mdtext?rev=1866065&r1=1866064&r2=1866065&view=diff
==============================================================================
--- sis/site/trunk/content/team-list.mdtext [UTF-8] (original)
+++ sis/site/trunk/content/team-list.mdtext [UTF-8] Thu Aug 29 10:46:39 2019
@@ -46,6 +46,7 @@ Committers    {#committers}
 Committers are peoples with write access to the source code repository.
 All PMC members are implicitly committers.
 
+* Alexis Manin
 * Christina Hough
 * Rémi Maréchal
 
@@ -57,7 +58,6 @@ Contributors are peoples who contributed
 or other means.
 
 * Adrian Custer
-* Alexis Manin
 * Antoine Hnawia
 * Bich Thuy Do
 * Cédric Briançon

Modified: sis/site/trunk/templates/skeleton.html
URL: http://svn.apache.org/viewvc/sis/site/trunk/templates/skeleton.html?rev=1866065&r1=1866064&r2=1866065&view=diff
==============================================================================
--- sis/site/trunk/templates/skeleton.html (original)
+++ sis/site/trunk/templates/skeleton.html Thu Aug 29 10:46:39 2019
@@ -36,7 +36,6 @@
                   <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>
@@ -74,7 +73,6 @@
               <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>
@@ -99,7 +97,7 @@
 
   <footer class="footer">
     <div class="container">
-      <p>Copyright &copy; 2013-2018 The Apache Software Foundation, Licensed under
the
+      <p>Copyright &copy; 2013-2019 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>



Mime
View raw message