sis-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From desruisse...@apache.org
Subject svn commit: r1506963 - /sis/site/trunk/content/site-management.mdtext
Date Thu, 25 Jul 2013 13:40:03 GMT
Author: desruisseaux
Date: Thu Jul 25 13:40:03 2013
New Revision: 1506963

URL: http://svn.apache.org/r1506963
Log:
Some tip about writing mdtext file for SIS.

Modified:
    sis/site/trunk/content/site-management.mdtext

Modified: sis/site/trunk/content/site-management.mdtext
URL: http://svn.apache.org/viewvc/sis/site/trunk/content/site-management.mdtext?rev=1506963&r1=1506962&r2=1506963&view=diff
==============================================================================
--- sis/site/trunk/content/site-management.mdtext [UTF-8] (original)
+++ sis/site/trunk/content/site-management.mdtext [UTF-8] Thu Jul 25 13:40:03 2013
@@ -17,8 +17,7 @@ Notice: Licensed to the Apache Software 
         under the License.
 
 
-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.
+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.
 
 General documentation about Apache Content Management System (CMS) can be found in the [CMS
reference][cms] page.
@@ -74,7 +73,27 @@ Once a staging site has been approved, i
 Content    {#content}
 =====================
 
-(...TODO: clarify here the relationship with Maven site)
+All `.mdtext` files should starts as below (replace the `<...>` block by the corresponding
content):
+
+    :::markdown
+    Title:  <put the page title here>
+    Notice: <copy the notice from an existing page>
+
+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:
+
+    :::markdown
+    [TOC]
+
+The first header appears after the Table Of Content.
+For each header, and anchor should be specified using the `{#...}` syntax.
+Do not rely on automatically generated anchors, since they may not be stable if some text
in the header is modified.
+Example:
+
+    :::markdown
+    My first header in my page    {#firstHeader}
+    ============================================
 
 
 



Mime
View raw message