From b5f30a78845760b2d501b286f127330d9b2b51e3 Mon Sep 17 00:00:00 2001 From: jensp Date: Mon, 10 Jun 2019 17:28:50 +0000 Subject: [PATCH] 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 --- .../doc/freemarker/ccm-sci-types-institute.md | 28 +++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 ccm-sci-types-institute/doc/freemarker/ccm-sci-types-institute.md diff --git a/ccm-sci-types-institute/doc/freemarker/ccm-sci-types-institute.md b/ccm-sci-types-institute/doc/freemarker/ccm-sci-types-institute.md new file mode 100644 index 000000000..66ba5c169 --- /dev/null +++ b/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` + +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. \ No newline at end of file