Author: buildbot
Date: Fri Mar 20 19:30:56 2015
New Revision: 944518
Log:
Staging update by buildbot for sis
Modified:
websites/staging/sis/trunk/content/ (props changed)
websites/staging/sis/trunk/content/source.html
Propchange: websites/staging/sis/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Fri Mar 20 19:30:56 2015
@@ -1 +1 @@
-1668122
+1668126
Modified: websites/staging/sis/trunk/content/source.html
==============================================================================
--- websites/staging/sis/trunk/content/source.html (original)
+++ websites/staging/sis/trunk/content/source.html Fri Mar 20 19:30:56 2015
@@ -115,12 +115,14 @@ For fetching the source code, choose one
</li>
<li><a href="#javadoc">Documentation formatting</a><ul>
<li><a href="#javadoc-tags">Javadoc annotations</a></li>
-<li><a href="#html">HTML elements</a></li>
-<li><a href="#mathml">MathML elements</a></li>
+<li><a href="#html">HTML elements</a><ul>
<li><a href="#paragraph">Paragraphs</a></li>
<li><a href="#css">Javadoc CSS</a></li>
</ul>
</li>
+<li><a href="#mathml">MathML elements</a></li>
+</ul>
+</li>
</ul>
</div>
<h1 id="ide">Opening Apache SIS in an IDE</h1>
@@ -282,11 +284,21 @@ 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>
-<p>The following HTML tags can be used:</p>
+<h3 id="paragraph">Paragraphs</h3>
+<p>Usages of the <code><p></code> 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 <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>,
+or <code>{@preformat}</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>
+<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>
<thead>
<tr>
-<th>HTML element</th>
+<th>HTML tag</th>
<th>Description</th>
</tr>
</thead>
@@ -297,27 +309,39 @@ For example:</p>
</tr>
<tr>
<td><code><div class="note"></code></td>
-<td>Note or example (use smaller font).</td>
+<td>Indented text with smaller font, used for notes or examples.</td>
+</tr>
+<tr>
+<td><code><div class="warning"></code></td>
+<td>Text in red color, used for warning about probable API changes.</td>
</tr>
<tr>
-<td><code><ul></code> or <code><ol></code></td>
-<td>Start a list with few space between the items (useful for short
descriptions).</td>
+<td><code><ul></code> and <code><ol></code></td>
+<td>Default list styles with few space between items (suitable for compact
lists).</td>
</tr>
<tr>
<td><code><ul class="verbose"></code></td>
-<td>Start a list with more space between the items (useful for long
descriptions).</td>
+<td>A list style with space between items. Used for lists having verbose
(multi-lines) items.</td>
+</tr>
+<tr>
+<td><code><table class="compact"></code></td>
+<td>Table without border and no space between rows. Used for lists with
columns alignment.</td>
</tr>
<tr>
<td><code><table class="sis"></code></td>
-<td>Table with a blue header row and some space between the cells</td>
+<td>Table with a border, blue headers, light background and some space between
columns.</td>
</tr>
<tr>
-<td><code><table class="compact"></code></td>
-<td>Table without vertical space between the cells.</td>
+<td><code><th class="hsep"></code></td>
+<td>In SIS tables, draw a line on the top border. Used for drawing table
section separators.</td>
+</tr>
+<tr>
+<td><code><th class="sep"></code></td>
+<td>In SIS tables, draw a bright line on the left border. Used for drawing
column separators.</td>
</tr>
<tr>
<td><code><td class="sep"></code></td>
-<td>Table cell with a vertical line on the left side.</td>
+<td>In SIS tables, draw a bright line on the left border. Used for drawing
column separators.</td>
</tr>
</tbody>
</table>
@@ -336,62 +360,6 @@ 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>
-<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>,
-or <code>{@preformat}</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>
-<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>
-<thead>
-<tr>
-<th>HTML tag</th>
-<th>Description</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td><code><table class="sis"></code></td>
-<td>Table with a border, blue headers, light background and some space between
columns.</td>
-</tr>
-<tr>
-<td><code><th class="hsep"></code></td>
-<td>In SIS tables, draw a line on the top border. Used for drawing table
section separators.</td>
-</tr>
-<tr>
-<td><code><th class="sep"></code></td>
-<td>In SIS tables, draw a bright line on the left border. Used for drawing
column separators.</td>
-</tr>
-<tr>
-<td><code><td class="sep"></code></td>
-<td>In SIS tables, draw a bright line on the left border. Used for drawing
column separators.</td>
-</tr>
-<tr>
-<td><code><table class="compact"></code></td>
-<td>Table without border and no space between rows. Used for lists with
columns alignment.</td>
-</tr>
-<tr>
-<td><code><ul></code> and <code><ol></code></td>
-<td>Default list styles without space between items (suitable for compact
lists).</td>
-</tr>
-<tr>
-<td><code><ul class="verbose"></code></td>
-<td>A list style with space between items. Used for lists having verbose
(multi-lines) items.</td>
-</tr>
-<tr>
-<td><code><div class="note"></code></td>
-<td>Indented text with smaller font, used for notes or examples.</td>
-</tr>
-<tr>
-<td><code><div class="warning"></code></td>
-<td>Text in red color, used for warning about probable API changes.</td>
-</tr>
-</tbody>
-</table>
</article>
</section>
</div><!--/span-->
