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 index 66ba5c169..dfbb928b7 100644 --- a/ccm-sci-types-institute/doc/freemarker/ccm-sci-types-institute.md +++ b/ccm-sci-types-institute/doc/freemarker/ccm-sci-types-institute.md @@ -1,7 +1,7 @@ # Freemarker functions for SciDepartment items Import Path -: `/ccm-sci-types-department.ftl` +: `/ccm-sci-types-institute.ftl` ## `getDescription(data: Node): HtmlString` diff --git a/ccm-sci-types-project/doc/freemarker/ccm-sci-types-project.md b/ccm-sci-types-project/doc/freemarker/ccm-sci-types-project.md new file mode 100644 index 000000000..27cf8727c --- /dev/null +++ b/ccm-sci-types-project/doc/freemarker/ccm-sci-types-project.md @@ -0,0 +1,109 @@ +# Freemarker functions for SciProject items + +Import Path +: `/ccm-sci-types-project.ftl` + +## `getBegin(item: Node): DateNode` + +Returns the begin date of the project. To format the date the +`formatDateTime` function provided by `ccm-themedirector` should be +used. + +## `getEnd(item: Node): DateNode` + +Returns the end date of the project. To format the date the +`formatDateTime` function provided by `ccm-themedirector` should be +used. + +## `getDescription(item: Node): HtmlString` + +Gets the description of the project. + +## `getShortDescription(item: Node): String` + +Gets the short description of the project. + +## `getSponsors(item: Node): Sequence` + +Returns the sponsors of the project. + +## `getSponsorName(sponsor: Node): String` + +Returns the name of the sponsor. + +## `hasSponsorFundingCode(sponsor: Node): boolean` + +Determines if the sponsor has assigned a funding code to the project. + +## `getSponsorFundingCode(sponsor: Node): String` + +Returns the funding code of the project assigned by the sponsor. + +## `getSponsorLink(sponsor: Node): String` + +Gets the link to the homepage of the sponsor. + +## `hasFunding(item: Node): String` + +Determines if the project has a text describing the funding +of the project. + +## `getFunding(item: Node): HtmlString` + +Gets the text describing the funding of the project. + +## `hasFundingVolume(item: Node): boolean` + +Determines if the project has a value for the `fundingVolume` property. + +## `getFundingVolume(item: Node): String` + +Returns the value of the `fundingVolume` property. + +## `getMembers(item: Node): Sequence` + +Returns the members of the project. + +## `getMemberRole(member: Node): String` + +Gets the role of the member. + +## `getMemberStatus(member: Node): String` + +Gets the status of the member. + +## `getMemberId(member: Node): String` + +Gets the ID of the member. + +## `getMemberLink(member: Node): String` + +Gets a link to the detail view of the member. + +## `getMemberSurname(member: Node): String` + +Gets the surname of the member. + +## `getMemberGivenName(member: Node): String` + +Gets the given name of the member. + +## `getMemberTitlePre(member: Node): String` + +Gets the value of the `titlePre` property of the member. + +## `getMemberTitlePost(member: Node): String` + +Gets the value of the `titlePost` property of the member. + +## `getInvolvedOrganizations(item: Node): Sequence` + +Gets the organizations involved in the project. + +## `getInvolvedOrganizationName(orga: Node): String` + +Gets the name of the organization. + +## `getInvolvedOrganizationLink(orga: Node): String` + +Gets the link to the homepage of the organization. \ No newline at end of file