From d1ff704fa1d842b47908487d9c53f46bcdc88f75 Mon Sep 17 00:00:00 2001
From: jensp <jensp@8810af33-2d31-482b-a856-94f89814c4df>
Date: Thu, 9 Oct 2014 18:04:44 +0000
Subject: [PATCH] Some improvments for documentation

git-svn-id: https://svn.libreccm.org/ccm/trunk@2907 8810af33-2d31-482b-a856-94f89814c4df
---
 .../themes/foundry/doc/styles/foundry-doc.css |  3 +++
 .../lib/template-tags/content-items.xsl       | 22 ++++++++++++----
 .../foundry/lib/template-tags/data-tags.xsl   |  6 ++++-
 .../lib/template-tags/foundry-doc-tags.xsl    | 25 +++++++++++++------
 .../foundry/lib/template-tags/html-tags.xsl   | 12 +++++++++
 5 files changed, 54 insertions(+), 14 deletions(-)

diff --git a/ccm-sci-bundle/web/themes/foundry/doc/styles/foundry-doc.css b/ccm-sci-bundle/web/themes/foundry/doc/styles/foundry-doc.css
index 273c31d39..49b8269f8 100644
--- a/ccm-sci-bundle/web/themes/foundry/doc/styles/foundry-doc.css
+++ b/ccm-sci-bundle/web/themes/foundry/doc/styles/foundry-doc.css
@@ -162,3 +162,6 @@ nav {
     width: 16em;
 }
 
+pre, code {
+    font-family: liberation_mono;
+}
diff --git a/ccm-sci-bundle/web/themes/foundry/foundry/lib/template-tags/content-items.xsl b/ccm-sci-bundle/web/themes/foundry/foundry/lib/template-tags/content-items.xsl
index 7204530b2..32ec8427d 100644
--- a/ccm-sci-bundle/web/themes/foundry/foundry/lib/template-tags/content-items.xsl
+++ b/ccm-sci-bundle/web/themes/foundry/foundry/lib/template-tags/content-items.xsl
@@ -36,8 +36,10 @@
     <foundry:doc section="user" type="template-tag">
         <foundry:doc-desc>
             <p>
-                This tags inserts the HTML representation of the current content item, either 
-                as greeting item or normal item.
+                The <code>content-item</code> tag with the attribute <code>mode</code> set the 
+                <code>detail</code> or without the attribute inserts the HTML representation of the 
+                detail view of the current content item. The content item can either be the greeting 
+                item or normal item.
             </p>
             <p>
                 The HTML representation of a content item is defined using special templates
@@ -83,10 +85,10 @@
                     The content-type of the item.
                 </dd>
             </dl>
-            <foundry:doc-see-also>
-                <foundry:doc-link href="#layout-templates">The template system</foundry:doc-link>
-            </foundry:doc-see-also>
         </foundry:doc-desc>
+        <foundry:doc-see-also>
+            <foundry:doc-link href="#layout-templates">The template system</foundry:doc-link>
+        </foundry:doc-see-also>
     </foundry:doc>
     <xsl:template match="content-item[@mode = 'detail' or not(@mode)]">
         <xsl:if test="$data-tree/cms:contentPanel or $data-tree/nav:greetingItem">
@@ -257,6 +259,16 @@
         </xsl:if>
     </xsl:template>
     
+    <foundry:doc section="user" type="template-tag">
+        <foundry:doc-desc>
+            <p>
+                The <code>content-item</code> with the <code>mode</code> attribute set to
+                <code>link</code> insert the HTML representation of a content item. In this case
+                the content item to show is provided using by a XSL parameter which has to be 
+                provided by a surrounding tag like <code>related-link</code>.
+            </p>
+        </foundry:doc-desc>
+    </foundry:doc>
     <xsl:template match="content-item[@mode = 'link']">
         <xsl:param name="contentitem-tree" tunnel="yes"/>
         
diff --git a/ccm-sci-bundle/web/themes/foundry/foundry/lib/template-tags/data-tags.xsl b/ccm-sci-bundle/web/themes/foundry/foundry/lib/template-tags/data-tags.xsl
index 7696c0bc8..85c10d992 100644
--- a/ccm-sci-bundle/web/themes/foundry/foundry/lib/template-tags/data-tags.xsl
+++ b/ccm-sci-bundle/web/themes/foundry/foundry/lib/template-tags/data-tags.xsl
@@ -31,7 +31,11 @@
             the title of the content item. For more details please refer to 
             the documentation of the <code>foundry:title</code> function.
         </foundry:doc-desc>
-        <foundry:doc-see-also>#foundry:title</foundry:doc-see-also>
+        <foundry:doc-see-also>
+            <foundry:doc-link href="#foundry:title">
+                <code>foundry:title</code>
+            </foundry:doc-link>
+        </foundry:doc-see-also>
     </foundry:doc>
     <xsl:template match="show-page-title">
         <xsl:value-of select="foundry:title()"/>
diff --git a/ccm-sci-bundle/web/themes/foundry/foundry/lib/template-tags/foundry-doc-tags.xsl b/ccm-sci-bundle/web/themes/foundry/foundry/lib/template-tags/foundry-doc-tags.xsl
index a40eb4801..a34e2fb6a 100644
--- a/ccm-sci-bundle/web/themes/foundry/foundry/lib/template-tags/foundry-doc-tags.xsl
+++ b/ccm-sci-bundle/web/themes/foundry/foundry/lib/template-tags/foundry-doc-tags.xsl
@@ -175,14 +175,23 @@
     <xsl:template match="xsl:import" mode="doc">
         <xsl:param name="section-generate" tunnel="yes"/>
         
-        <xsl:message>
+        <!--<xsl:message>
             <xsl:value-of select="concat('parsing ', ./@href)"/>
-        </xsl:message>
-        <xsl:apply-templates select="document(./@href)//xsl:import" mode="doc"/>
-        <xsl:apply-templates select="document(./@href)//foundry:doc[@section=$section-generate]" 
-                             mode="doc">
-            <xsl:sort select="./following::xsl:template[1]/@match"/>
-        </xsl:apply-templates>
+        </xsl:message>-->
+        <section>
+            <h1>
+                <xsl:value-of select="document(./@href)/xsl:stylesheet/foundry:doc-file/foundry:doc-file-title"/>
+            </h1>
+            <xsl:copy-of select="document(./@href)/xsl:stylesheet/foundry:doc-file/foundry:doc-file-desc"/>
+            
+            <xsl:apply-templates select="document(./@href)//xsl:import" mode="doc">
+                <xsl:sort select="./@href"/>
+            </xsl:apply-templates>
+            <xsl:apply-templates select="document(./@href)//foundry:doc[@section=$section-generate]" 
+                                 mode="doc">
+                <xsl:sort select="./following::xsl:template[1]/@match"/>
+            </xsl:apply-templates>
+        </section>
     </xsl:template>
     
     <xsl:template match="foundry:doc[@type='function']" mode="doc">
@@ -368,7 +377,7 @@
     
     <xsl:template match="doc-see-also-link-list">
         <xsl:param name="doc-see-also" tunnel="yes"/>
-        
+   
         <xsl:if test="$doc-see-also">
             <xsl:apply-templates/>
         </xsl:if>
diff --git a/ccm-sci-bundle/web/themes/foundry/foundry/lib/template-tags/html-tags.xsl b/ccm-sci-bundle/web/themes/foundry/foundry/lib/template-tags/html-tags.xsl
index d603ad5fd..9e89f73ab 100644
--- a/ccm-sci-bundle/web/themes/foundry/foundry/lib/template-tags/html-tags.xsl
+++ b/ccm-sci-bundle/web/themes/foundry/foundry/lib/template-tags/html-tags.xsl
@@ -28,6 +28,18 @@
                 exclude-result-prefixes="xsl bebop foundry ui"
                 version="2.0">
 
+    <foundry:doc-file>
+        <foundry:doc-file-title>HTML tags</foundry:doc-file-title>
+        <foundry:doc-file-desc>
+            <p>
+                These tags are generating the equivalent HTML tags. In most cases the tags have
+                the same name and same attributes as their HTML counterparts, but some work
+                in a slightly different way, for example by using values provided by other 
+                surrounding tags which are passed the them as XSL parameters.
+            </p>
+        </foundry:doc-file-desc>
+    </foundry:doc-file>
+    
     <foundry:doc section="user" type="template-tag">
         <foundry:doc-desc>
             <p>