You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sis.apache.org by de...@apache.org on 2021/05/14 09:57:58 UTC

[sis-site] 09/39: Publishing the side menu

This is an automated email from the ASF dual-hosted git repository.

desruisseaux pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/sis-site.git

commit 672980de9d4452c6922297aa88abe0fdd86993ac
Author: Suresh Marru <sm...@apache.org>
AuthorDate: Wed Aug 7 02:56:41 2013 +0000

    Publishing the side menu
    
    git-svn-id: https://svn.apache.org/repos/infra/websites/production/sis/content@873268 90ea9780-b833-de11-8433-001ec94261de
---
 branches.html                 |   2 ++
 code-patterns.html            |   2 ++
 downloads.html                |   2 ++
 faq.html                      |   2 ++
 img/logo-feather.jpg          | Bin 0 -> 17090 bytes
 img/logo-large.png            | Bin 0 -> 123179 bytes
 index.html                    |   2 ++
 license.html                  |   2 ++
 mail-lists.html               |   2 ++
 release-management-setup.html |   2 ++
 release-management.html       |   2 ++
 release-notes/0.1.html        |   4 ++++
 release-notes/0.2.html        |   4 ++++
 release-notes/0.3.html        |   5 +++++
 site-management.html          |   2 ++
 source.html                   |  19 +++++++++++++++++++
 team-list.html                |   2 ++
 17 files changed, 54 insertions(+)

diff --git a/branches.html b/branches.html
index 48040ee..01b5c17 100644
--- a/branches.html
+++ b/branches.html
@@ -35,6 +35,7 @@
                   <li><a href="https://issues.apache.org/jira/browse/SIS">Issue Tracker</a></li>
                   <li><a href="faq.html">FAQ</a></li>
                   <li><a href="release-management.html">Release Management</a></li>
+                  <li><a href="site-management.html">Edit WebSite</a></li>
                 </ul>
               </li>
               <li class="dropdown"> <a class="dropdown-toggle" data-toggle="dropdown">ASF <b class="caret"></b></a>
@@ -68,6 +69,7 @@
               <li><a href="https://issues.apache.org/jira/browse/SIS">Issue Tracker</a></li>
               <li><a href="faq.html">FAQ</a></li>
               <li><a href="release-management.html">Release Management</a></li>
+              <li><a href="site-management.html">Edit WebSite</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>
diff --git a/code-patterns.html b/code-patterns.html
index 6a7ae8a..038614d 100644
--- a/code-patterns.html
+++ b/code-patterns.html
@@ -35,6 +35,7 @@
                   <li><a href="https://issues.apache.org/jira/browse/SIS">Issue Tracker</a></li>
                   <li><a href="faq.html">FAQ</a></li>
                   <li><a href="release-management.html">Release Management</a></li>
+                  <li><a href="site-management.html">Edit WebSite</a></li>
                 </ul>
               </li>
               <li class="dropdown"> <a class="dropdown-toggle" data-toggle="dropdown">ASF <b class="caret"></b></a>
@@ -68,6 +69,7 @@
               <li><a href="https://issues.apache.org/jira/browse/SIS">Issue Tracker</a></li>
               <li><a href="faq.html">FAQ</a></li>
               <li><a href="release-management.html">Release Management</a></li>
+              <li><a href="site-management.html">Edit WebSite</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>
diff --git a/downloads.html b/downloads.html
index af0764f..1418bdf 100644
--- a/downloads.html
+++ b/downloads.html
@@ -35,6 +35,7 @@
                   <li><a href="https://issues.apache.org/jira/browse/SIS">Issue Tracker</a></li>
                   <li><a href="faq.html">FAQ</a></li>
                   <li><a href="release-management.html">Release Management</a></li>
+                  <li><a href="site-management.html">Edit WebSite</a></li>
                 </ul>
               </li>
               <li class="dropdown"> <a class="dropdown-toggle" data-toggle="dropdown">ASF <b class="caret"></b></a>
@@ -68,6 +69,7 @@
               <li><a href="https://issues.apache.org/jira/browse/SIS">Issue Tracker</a></li>
               <li><a href="faq.html">FAQ</a></li>
               <li><a href="release-management.html">Release Management</a></li>
+              <li><a href="site-management.html">Edit WebSite</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>
diff --git a/faq.html b/faq.html
index 89fcd96..2dc2dca 100644
--- a/faq.html
+++ b/faq.html
@@ -35,6 +35,7 @@
                   <li><a href="https://issues.apache.org/jira/browse/SIS">Issue Tracker</a></li>
                   <li><a href="faq.html">FAQ</a></li>
                   <li><a href="release-management.html">Release Management</a></li>
+                  <li><a href="site-management.html">Edit WebSite</a></li>
                 </ul>
               </li>
               <li class="dropdown"> <a class="dropdown-toggle" data-toggle="dropdown">ASF <b class="caret"></b></a>
@@ -68,6 +69,7 @@
               <li><a href="https://issues.apache.org/jira/browse/SIS">Issue Tracker</a></li>
               <li><a href="faq.html">FAQ</a></li>
               <li><a href="release-management.html">Release Management</a></li>
+              <li><a href="site-management.html">Edit WebSite</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>
diff --git a/img/logo-feather.jpg b/img/logo-feather.jpg
new file mode 100644
index 0000000..65b6d38
Binary files /dev/null and b/img/logo-feather.jpg differ
diff --git a/img/logo-large.png b/img/logo-large.png
new file mode 100644
index 0000000..bd31c34
Binary files /dev/null and b/img/logo-large.png differ
diff --git a/index.html b/index.html
index 89d1db0..66ca7f0 100644
--- a/index.html
+++ b/index.html
@@ -35,6 +35,7 @@
                   <li><a href="https://issues.apache.org/jira/browse/SIS">Issue Tracker</a></li>
                   <li><a href="faq.html">FAQ</a></li>
                   <li><a href="release-management.html">Release Management</a></li>
+                  <li><a href="site-management.html">Edit WebSite</a></li>
                 </ul>
               </li>
               <li class="dropdown"> <a class="dropdown-toggle" data-toggle="dropdown">ASF <b class="caret"></b></a>
@@ -68,6 +69,7 @@
               <li><a href="https://issues.apache.org/jira/browse/SIS">Issue Tracker</a></li>
               <li><a href="faq.html">FAQ</a></li>
               <li><a href="release-management.html">Release Management</a></li>
+              <li><a href="site-management.html">Edit WebSite</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>
diff --git a/license.html b/license.html
index 67b570a..0990e43 100644
--- a/license.html
+++ b/license.html
@@ -35,6 +35,7 @@
                   <li><a href="https://issues.apache.org/jira/browse/SIS">Issue Tracker</a></li>
                   <li><a href="faq.html">FAQ</a></li>
                   <li><a href="release-management.html">Release Management</a></li>
+                  <li><a href="site-management.html">Edit WebSite</a></li>
                 </ul>
               </li>
               <li class="dropdown"> <a class="dropdown-toggle" data-toggle="dropdown">ASF <b class="caret"></b></a>
@@ -68,6 +69,7 @@
               <li><a href="https://issues.apache.org/jira/browse/SIS">Issue Tracker</a></li>
               <li><a href="faq.html">FAQ</a></li>
               <li><a href="release-management.html">Release Management</a></li>
+              <li><a href="site-management.html">Edit WebSite</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>
diff --git a/mail-lists.html b/mail-lists.html
index b67280f..7adc9cf 100644
--- a/mail-lists.html
+++ b/mail-lists.html
@@ -35,6 +35,7 @@
                   <li><a href="https://issues.apache.org/jira/browse/SIS">Issue Tracker</a></li>
                   <li><a href="faq.html">FAQ</a></li>
                   <li><a href="release-management.html">Release Management</a></li>
+                  <li><a href="site-management.html">Edit WebSite</a></li>
                 </ul>
               </li>
               <li class="dropdown"> <a class="dropdown-toggle" data-toggle="dropdown">ASF <b class="caret"></b></a>
@@ -68,6 +69,7 @@
               <li><a href="https://issues.apache.org/jira/browse/SIS">Issue Tracker</a></li>
               <li><a href="faq.html">FAQ</a></li>
               <li><a href="release-management.html">Release Management</a></li>
+              <li><a href="site-management.html">Edit WebSite</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>
diff --git a/release-management-setup.html b/release-management-setup.html
index 0b5df32..e18fb2b 100644
--- a/release-management-setup.html
+++ b/release-management-setup.html
@@ -35,6 +35,7 @@
                   <li><a href="https://issues.apache.org/jira/browse/SIS">Issue Tracker</a></li>
                   <li><a href="faq.html">FAQ</a></li>
                   <li><a href="release-management.html">Release Management</a></li>
+                  <li><a href="site-management.html">Edit WebSite</a></li>
                 </ul>
               </li>
               <li class="dropdown"> <a class="dropdown-toggle" data-toggle="dropdown">ASF <b class="caret"></b></a>
@@ -68,6 +69,7 @@
               <li><a href="https://issues.apache.org/jira/browse/SIS">Issue Tracker</a></li>
               <li><a href="faq.html">FAQ</a></li>
               <li><a href="release-management.html">Release Management</a></li>
+              <li><a href="site-management.html">Edit WebSite</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>
diff --git a/release-management.html b/release-management.html
index 9347a55..1631bad 100644
--- a/release-management.html
+++ b/release-management.html
@@ -35,6 +35,7 @@
                   <li><a href="https://issues.apache.org/jira/browse/SIS">Issue Tracker</a></li>
                   <li><a href="faq.html">FAQ</a></li>
                   <li><a href="release-management.html">Release Management</a></li>
+                  <li><a href="site-management.html">Edit WebSite</a></li>
                 </ul>
               </li>
               <li class="dropdown"> <a class="dropdown-toggle" data-toggle="dropdown">ASF <b class="caret"></b></a>
@@ -68,6 +69,7 @@
               <li><a href="https://issues.apache.org/jira/browse/SIS">Issue Tracker</a></li>
               <li><a href="faq.html">FAQ</a></li>
               <li><a href="release-management.html">Release Management</a></li>
+              <li><a href="site-management.html">Edit WebSite</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>
diff --git a/release-notes/0.1.html b/release-notes/0.1.html
index 2bbaec8..d743ef9 100644
--- a/release-notes/0.1.html
+++ b/release-notes/0.1.html
@@ -5,6 +5,10 @@
     <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
   </head>
   <body>
+    <table width="100%"><tr>
+      <td align="left" >Previous release</td>
+      <td align="right"><a href="0.2.html">Next release</a></td>
+    </tr></table>
     <h1>SIS 0.1-incubating Release notes</h1>
 
 <h2>New Features</h2>
diff --git a/release-notes/0.2.html b/release-notes/0.2.html
index b4ec4f2..412c074 100644
--- a/release-notes/0.2.html
+++ b/release-notes/0.2.html
@@ -5,6 +5,10 @@
     <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
   </head>
   <body>
+    <table width="100%"><tr>
+      <td align="left" ><a href="0.1.html">Previous release</a></td>
+      <td align="right"><a href="0.3.html">Next release</a></td>
+    </tr></table>
     <h1>SIS 0.2-incubating Release notes</h1>
 
 <h2>New Features</h2>
diff --git a/release-notes/0.3.html b/release-notes/0.3.html
index 139288e..9294d1e 100644
--- a/release-notes/0.3.html
+++ b/release-notes/0.3.html
@@ -5,6 +5,10 @@
     <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
   </head>
   <body>
+    <table width="100%"><tr>
+      <td align="left" ><a href="0.2.html">Previous release</a></td>
+      <td align="right">Next release</td>
+    </tr></table>
     <h1>SIS 0.3 Release notes</h1>
 
 <h2>New Features</h2>
@@ -19,6 +23,7 @@
 
 <h2>Improvements</h2>
 <ul>
+  <li>[<a href='http://issues.apache.org/jira/browse/SIS-57'>SIS-57</a>] - A Logo for SIS</li>
   <li>[<a href='http://issues.apache.org/jira/browse/SIS-31'>SIS-31</a>] - Website needs a facelift</li>
   <li>[<a href='http://issues.apache.org/jira/browse/SIS-38'>SIS-38</a>] - Add the missing documentation comments for SIS-core storage</li>
   <li>[<a href='http://issues.apache.org/jira/browse/SIS-40'>SIS-40</a>] - Add the missing documentation comments for SIS WS layer</li>
diff --git a/site-management.html b/site-management.html
index acd7ffa..c799b1f 100644
--- a/site-management.html
+++ b/site-management.html
@@ -35,6 +35,7 @@
                   <li><a href="https://issues.apache.org/jira/browse/SIS">Issue Tracker</a></li>
                   <li><a href="faq.html">FAQ</a></li>
                   <li><a href="release-management.html">Release Management</a></li>
+                  <li><a href="site-management.html">Edit WebSite</a></li>
                 </ul>
               </li>
               <li class="dropdown"> <a class="dropdown-toggle" data-toggle="dropdown">ASF <b class="caret"></b></a>
@@ -68,6 +69,7 @@
               <li><a href="https://issues.apache.org/jira/browse/SIS">Issue Tracker</a></li>
               <li><a href="faq.html">FAQ</a></li>
               <li><a href="release-management.html">Release Management</a></li>
+              <li><a href="site-management.html">Edit WebSite</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>
diff --git a/source.html b/source.html
index 224eb3e..7527079 100644
--- a/source.html
+++ b/source.html
@@ -35,6 +35,7 @@
                   <li><a href="https://issues.apache.org/jira/browse/SIS">Issue Tracker</a></li>
                   <li><a href="faq.html">FAQ</a></li>
                   <li><a href="release-management.html">Release Management</a></li>
+                  <li><a href="site-management.html">Edit WebSite</a></li>
                 </ul>
               </li>
               <li class="dropdown"> <a class="dropdown-toggle" data-toggle="dropdown">ASF <b class="caret"></b></a>
@@ -68,6 +69,7 @@
               <li><a href="https://issues.apache.org/jira/browse/SIS">Issue Tracker</a></li>
               <li><a href="faq.html">FAQ</a></li>
               <li><a href="release-management.html">Release Management</a></li>
+              <li><a href="site-management.html">Edit WebSite</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>
@@ -112,12 +114,14 @@ For fetching the source code, choose one of the following commands:</p>
 </ul>
 </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>
 <li><a href="#paragraph">Paragraphs</a></li>
 <li><a href="#css">Javadoc CSS</a></li>
 <li><a href="#miscellaneous">Miscellaneous</a></li>
 </ul>
 </li>
+<li><a href="#classes-naming">Classes naming</a></li>
 </ul>
 </li>
 </ul>
@@ -247,6 +251,15 @@ 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. 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>
+<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>
+<li><code>@version</code> - the last SIS version when the code of the annotated class got a significant change.</li>
+<li><code>@author</code>  - developer name in <var>FirstName</var> <var>LastName</var> (<var>Organization</var>) format.
+                 A separated <code>@author</code> tag is added for each developer.
+                 The intend is to allow other developers to know to who to ask questions if needed.</li>
+</ul>
 <h3 id="html">HTML elements</h3>
 <p>HTML tags and entities shall be used only when there is no equivalent Javadoc tag.
 In addition to the standard Javadoc tags, a few <a href="http://builds.apache.org/job/sis-trunk/site/sis-build-helper/index.html">SIS-specific Javadoc tags</a> are available.
@@ -321,6 +334,12 @@ Instead, rely on styling. Some HTML tags having a style definition in Apache SIS
 <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>
+<h2 id="classes-naming">Classes naming</h2>
+<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-->
diff --git a/team-list.html b/team-list.html
index 0ce911b..6497582 100644
--- a/team-list.html
+++ b/team-list.html
@@ -35,6 +35,7 @@
                   <li><a href="https://issues.apache.org/jira/browse/SIS">Issue Tracker</a></li>
                   <li><a href="faq.html">FAQ</a></li>
                   <li><a href="release-management.html">Release Management</a></li>
+                  <li><a href="site-management.html">Edit WebSite</a></li>
                 </ul>
               </li>
               <li class="dropdown"> <a class="dropdown-toggle" data-toggle="dropdown">ASF <b class="caret"></b></a>
@@ -68,6 +69,7 @@
               <li><a href="https://issues.apache.org/jira/browse/SIS">Issue Tracker</a></li>
               <li><a href="faq.html">FAQ</a></li>
               <li><a href="release-management.html">Release Management</a></li>
+              <li><a href="site-management.html">Edit WebSite</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>