You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sis.apache.org by bu...@apache.org on 2013/07/23 22:53:40 UTC

svn commit: r870876 - in /websites/staging/sis/trunk/content: ./ index.html source.html

Author: buildbot
Date: Tue Jul 23 20:53:39 2013
New Revision: 870876

Log:
Staging update by buildbot for sis

Modified:
    websites/staging/sis/trunk/content/   (props changed)
    websites/staging/sis/trunk/content/index.html
    websites/staging/sis/trunk/content/source.html

Propchange: websites/staging/sis/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Tue Jul 23 20:53:39 2013
@@ -1 +1 @@
-1506264
+1506276

Modified: websites/staging/sis/trunk/content/index.html
==============================================================================
--- websites/staging/sis/trunk/content/index.html (original)
+++ websites/staging/sis/trunk/content/index.html Tue Jul 23 20:53:39 2013
@@ -89,6 +89,15 @@ The SIS storage modules will provide a c
 simple imagery as to many dimensional data structures.</p>
 <h2 id="using-sis">Using SIS</h2>
 <p>SIS requires a Java 6 Runtime Environment. The latest release is 0.3. The version under development is 0.4-SNAPSHOT.</p>
+<h2 id="sis-developer-documentation">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="branches.html">Branches</a>: trunk, JDK6, JDK7.</li>
+<li><a href="http://issues.apache.org/jira/browse/SIS">Issue tracking</a> (JIRA)</li>
+<li><a href="http://reviews.apache.org/groups/sis">Code review</a></li>
+<li><a href="release-management.html">Release management</a> (for release managers)</li>
+<li><a href="site-management.html">Web site management</a> (for release managers and site maintainers)</li>
+</ul>
             </article>
           </section>
         </div><!--/span-->

Modified: websites/staging/sis/trunk/content/source.html
==============================================================================
--- websites/staging/sis/trunk/content/source.html (original)
+++ websites/staging/sis/trunk/content/source.html Tue Jul 23 20:53:39 2013
@@ -109,7 +109,7 @@ For fetching the source code, choose one
 </li>
 </ul>
 </li>
-<li><a href="#some-coding-practices">Some coding practices</a><ul>
+<li><a href="#code-formatting">Code formatting</a><ul>
 <li><a href="#html-elements">HTML elements</a></li>
 <li><a href="#paragraphs">Paragraphs</a></li>
 <li><a href="#javadoc-css">Javadoc CSS</a></li>
@@ -225,7 +225,7 @@ by Apache SIS.</p>
 <h3 id="the-sis-library-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>
-<h1 id="some-coding-practices">Some coding practices</h1>
+<h1 id="code-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>
@@ -255,7 +255,7 @@ For example:</p>
 <p>Usages of the <code>&lt;p&gt;</code> tag should be relatively rare.
 Do <strong>not</strong> use <code>&lt;p&gt;</code> for the first paragraph in a package, class or member documentation,
 or for the first paragraph after a <code>&lt;/ul&gt;</code>, <code>&lt;/ol&gt;</code>, <code>&lt;/table&gt;</code>, <code>&lt;/blockquote&gt;</code>, <code>&lt;/pre&gt;</code>,
-<code>\{@preformat\}</code> or <code>\{@section\}</code> element.
+<code>{@preformat}</code> or <code>{@section}</code> element.
 The <code>&lt;p&gt;</code> tag shall be used only for separating a new paragraph from a previous one.
 In such cases, <code>&lt;p&gt;</code> shall have a matching <code>&lt;/p&gt;</code> tag at the paragraph end in order to form valid HTML.</p>
 <h2 id="javadoc-css">Javadoc CSS</h2>
@@ -312,7 +312,8 @@ Instead, rely on styling. Some HTML tags
 <li>Use 2 space indents for XML files, because <abbr title="International Organization for Standardization">ISO</abbr>/<abbr title="Open Geospatial Consortium">OGC</abbr> XML schemas tend to have a very deep structure.</li>
 </ul>
 </li>
-<li><strong>Line wrapping:</strong> Use 120-column line width for Java code and Javadoc.</li>
+<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>
             </article>
           </section>