Documentation for the Freemarker functions provided by ccm-sci-types-institute

git-svn-id: https://svn.libreccm.org/ccm/trunk@6127 8810af33-2d31-482b-a856-94f89814c4df

ccm-sci-types-institute/doc/freemarker/ccm-sci-types-institute.md

@@ -0,0 +1,28 @@
+# Freemarker functions for SciDepartment items
+
+Import Path
+: `/ccm-sci-types-department.ftl`
+
+## `getDescription(data: Node): HtmlString`
+
+Returns the description of the institute.
+
+## `getShortDescription(data: Node): String`
+
+Returns the short description of the institute.
+
+## `getDepartments(data: Node): Sequence<Node>`
+
+Returns the departments assigned to a institute.
+
+## `getDepartmentOid(department: Node): String`
+
+Gets the OID of a department.
+
+## `getDepartmentTitle(department: Node): String`
+
+Gets the title of a department.
+
+## `getDepartmentLink(department: Node): String`
+
+Returns the link to the detail view of a department.