From 431f2b7040b8d91d84d8f5eb5b520e73512f761e Mon Sep 17 00:00:00 2001
From: jensp <jensp@8810af33-2d31-482b-a856-94f89814c4df>
Date: Mon, 18 May 2015 12:09:20 +0000
Subject: [PATCH] Foundry: Some more documentation

git-svn-id: https://svn.libreccm.org/ccm/trunk@3410 8810af33-2d31-482b-a856-94f89814c4df
---
 .../content-items/sciinstitute.xsl            | 61 +++++++++++++++++++
 1 file changed, 61 insertions(+)

diff --git a/ccm-core/web/themes/foundry/foundry/lib/template-tags/content-items/sciinstitute.xsl b/ccm-core/web/themes/foundry/foundry/lib/template-tags/content-items/sciinstitute.xsl
index cbdb92bf2..a9222357f 100644
--- a/ccm-core/web/themes/foundry/foundry/lib/template-tags/content-items/sciinstitute.xsl
+++ b/ccm-core/web/themes/foundry/foundry/lib/template-tags/content-items/sciinstitute.xsl
@@ -28,6 +28,23 @@
                 exclude-result-prefixes="xsl xs bebop cms foundry nav ui"
                 version="2.0">
     
+    <foundry:doc-file>
+        <foundry:doc-file-title>Tags for ccm-sci-types-institute</foundry:doc-file-title>
+        <foundry:doc-file-desc>
+            <p>
+                The tags in this file are used to output the special properties
+                of the SciInstitute content type.
+            </p>
+        </foundry:doc-file-desc>
+    </foundry:doc-file>
+    
+    <foundry:doc section="user" typ="template-tag">
+        <foundry:doc-desc>
+            <p>
+                Display the description of a SciInstitute.
+            </p>
+        </foundry:doc-desc>
+    </foundry:doc>
     <xsl:template match="content-item-layout//*[starts-with(name(), 'orgaunit')]//sciinstitute-desc">
         <xsl:param name="orgaunit-data" tunnel="yes"/>
         
@@ -43,6 +60,13 @@
         </xsl:choose>
     </xsl:template>
     
+    <foundry:doc section="user" type="template-tag">
+        <foundry:doc-desc>
+            <p>
+                Root tag for generating a list of members of a SciInstitute.
+            </p>
+        </foundry:doc-desc>
+    </foundry:doc>
     <xsl:template match="content-item-layout//*[starts-with(name(), 'orgaunit')]//sciinstitute-members">
         <xsl:param name="orgaunit-data" tunnel="yes"/>
         
@@ -53,6 +77,13 @@
         </xsl:apply-templates>
     </xsl:template>
     
+    <foundry:doc section="user" type="template-tag">
+        <foundry:doc-desc>
+            <p>
+                Outputs the short description of a institute.
+            </p>
+        </foundry:doc-desc>
+    </foundry:doc>
     <xsl:template match="content-item-layout//*[starts-with(name(), 'orgaunit')]//sciinstitute-shortdesc">
         <xsl:param name="orgaunit-data" tunnel="yes"/>
         
@@ -66,6 +97,14 @@
         </xsl:choose>
     </xsl:template>
 
+    <foundry:doc section="user" type="template-tag">
+        <foundry:doc-desc>
+            <p>
+                Root tag for rendering a list of the departments of an 
+                institute.
+            </p>
+        </foundry:doc-desc>
+    </foundry:doc>
     <xsl:template match="content-item-layout//*[starts-with(name(), 'orgaunit')]//sciinstitute-departments">
         <xsl:param name="orgaunit-data" tunnel="yes"/>
         
@@ -78,6 +117,13 @@
         </xsl:if>
     </xsl:template>
     
+    <foundry:doc section="user" type="template-tag">
+        <foundry:doc-desc>
+            <p>
+                Encloses the tags for showing a department.
+            </p>
+        </foundry:doc-desc>
+    </foundry:doc>
     <xsl:template match="content-item-layout//*[starts-with(name(), 'orgaunit')]//sciinstitute-departments//department">
         <xsl:param name="departments" tunnel="yes"/>
         
@@ -91,6 +137,14 @@
         </xsl:for-each>
     </xsl:template>
     
+    <foundry:doc section="user" type="template-tag">
+        <foundry:doc-desc>
+            <p>
+                Extracts the link to detail view of a department and passes
+                it to the enclosed tags.
+            </p>
+        </foundry:doc-desc>
+    </foundry:doc>
     <xsl:template match="content-item-layout//*[starts-with(name(), 'orgaunit')]//sciinstitute-departments//department//department-link">
         <xsl:param name="oid" tunnel="yes"/>
         
@@ -101,6 +155,13 @@
         </xsl:apply-templates>
     </xsl:template>
     
+    <foundry:doc section="user" type="template-tag">
+        <foundry:doc-desc>
+            <p>
+                Outputs the name of the current department.
+            </p>
+        </foundry:doc-desc>
+    </foundry:doc>
     <xsl:template match="content-item-layout//*[starts-with(name(), 'orgaunit')]//sciinstitute-departments//department//department-name">
         <xsl:param name="title" tunnel="yes"/>