sis-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From build...@apache.org
Subject svn commit: r871158 - in /websites/staging/sis/trunk/content: ./ site-management.html
Date Thu, 25 Jul 2013 13:40:07 GMT
Author: buildbot
Date: Thu Jul 25 13:40:06 2013
New Revision: 871158

Log:
Staging update by buildbot for sis

Modified:
    websites/staging/sis/trunk/content/   (props changed)
    websites/staging/sis/trunk/content/site-management.html

Propchange: websites/staging/sis/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Thu Jul 25 13:40:06 2013
@@ -1 +1 @@
-1506957
+1506963

Modified: websites/staging/sis/trunk/content/site-management.html
==============================================================================
--- websites/staging/sis/trunk/content/site-management.html (original)
+++ websites/staging/sis/trunk/content/site-management.html Thu Jul 25 13:40:06 2013
@@ -80,8 +80,7 @@
           <section id="content" class="row">
             <article class="span12">
               <p class="page-title">Site management</p>
-              <p>This page explains how the Apache SIS web site is created, the relationship
with the Maven site,
-the policy about where to put content, and how to update the site.
+              <p>This page explains how the Apache SIS web site is created and how
to update the site.
 The intended audiences are SIS release managers and SIS web site maintainers.</p>
 <p>General documentation about Apache Content Management System (CMS) can be found
in the <a href="http://www.apache.org/dev/cmsref.html">CMS reference</a> page.
 The remaining of this page is specific to the SIS project.</p>
@@ -137,7 +136,28 @@ Once a staging site has been approved, i
 <li>Click on <em>Publish sis site</em>.</li>
 </ul>
 <h1 id="content">Content</h1>
-<p>(...TODO: clarify here the relationship with Maven site)</p>
+<p>All <code>.mdtext</code> files should starts as below (replace the <code>&lt;...&gt;</code>
block by the corresponding content):</p>
+<div class="codehilite"><pre><span class="n">Title</span><span
class="p">:</span>  <span class="o">&lt;</span><span class="n">put</span>
<span class="n">the</span> <span class="n">page</span> <span class="n">title</span>
<span class="n">here</span><span class="o">&gt;</span>
+<span class="n">Notice</span><span class="p">:</span> <span class="o">&lt;</span><span
class="n">copy</span> <span class="n">the</span> <span class="n">notice</span>
<span class="n">from</span> <span class="n">an</span> <span class="n">existing</span>
<span class="n">page</span><span class="o">&gt;</span>
+</pre></div>
+
+
+<p>The title will appear both in the browser window title bar, and as a header at the
beginning of the generated HTML page.
+The notice should be followed by a short abstract of the page content (typically a single
paragraph),
+then a Table Of Content to be automatically generated:</p>
+<div class="codehilite"><pre><span class="p">[</span><span class="n">TOC</span><span
class="p">]</span>
+</pre></div>
+
+
+<p>The first header appears after the Table Of Content.
+For each header, and anchor should be specified using the <code>{#...}</code>
syntax.
+Do not rely on automatically generated anchors, since they may not be stable if some text
in the header is modified.
+Example:</p>
+<div class="codehilite"><pre><span class="n">My</span> <span class="n">first</span>
<span class="n">header</span> <span class="n">in</span> <span class="n">my</span>
<span class="n">page</span>    <span class="p">{</span>#<span class="n">firstHeader</span><span
class="p">}</span>
+<span class="o">============================================</span>
+</pre></div>
+
+
 <h1 id="style-sheets">Style sheets</h1>
 <p>The following table lists the style sheets used by Apache SIS.
 The Maven and Javadoc style sheets are mentioned for completeness, but are not located on
the web site repository.



Mime
View raw message