diff --git a/ccm-cms-assets-notes/doc/freemarker/ccm-cms-assets-notes.md b/ccm-cms-assets-notes/doc/freemarker/ccm-cms-assets-notes.md new file mode 100644 index 000000000..0a93e8dae --- /dev/null +++ b/ccm-cms-assets-notes/doc/freemarker/ccm-cms-assets-notes.md @@ -0,0 +1,31 @@ +### ccm-cms-assets-notes + +Functions for processing note assets assigned to a content item. + +#### getNotes + + getNotes(item) + +Returns the notes assigned to a content item. + +##### Parameters + +`item` The content item + +##### Returns + +A sequence of the notes assigned to the provided item. + +#### getContent + + getContent(note) + +Gets the content of a note. + +##### Parameters + +`note` The note. + +##### Returns + +The content of the note. \ No newline at end of file diff --git a/ccm-cms-assets-relatedlink/doc/freemarker/ccm-cms-assets-relatedlink.md b/ccm-cms-assets-relatedlink/doc/freemarker/ccm-cms-assets-relatedlink.md new file mode 100644 index 000000000..7a8da8fe0 --- /dev/null +++ b/ccm-cms-assets-relatedlink/doc/freemarker/ccm-cms-assets-relatedlink.md @@ -0,0 +1,109 @@ +### ccm-cms-assets-relatedlink + +Functions for processing the related links assigned to a content item. + +#### getRelatedLinks + + getRelatedLinks(item, linkListName="NONE") + +Retrieves the related links assigned to a content item. + +##### Parameters + +`item` The content item + +`linkListName` The related links of a content item can be organized in +link lists. The default list (if no other is used) is `NONE` which is +the default value of this parameter. Only the links which belong to the +provided group are returned. + +##### Returns + +The related links of the provided `linkListGroup` of the provided content +item. + +#### getLinkType + + getLinkType(link) + +Gets the type of the provided link which can either be `externalLink`, +`internalLink` or `caption`. + +##### Parameters + +`link` The link + +##### Returns + +The type of the provided link. + +#### getLinkTitle + + getLinkTitle(link) + +Gets the title of the provided link. + +##### Parameters + +`link` The link. + +##### Returns + +The title of the provided link. + +#### getLinkDescription + + getLinkDescription(link) + +Gets the description of the provided link. + +##### Parameters + +`link` The link. + +##### Returns + +The description of the provided link. + +#### getLinkOrder + + getLinkOrder(link) + +Gets the order value of the provided link. + +##### Parameters + +`link` The link. + +##### Returns + +The order value of the provided link. + +#### getInternalLinkParameters + + getLinkInternalLinkParameters(link) + +Gets the parameters of the of the provided link. + +##### Parameters + +`link` The link. + +##### Returns + +The parameters to add to the URL of the provided link. + +#### getTargetUri + + getTargetUri(link) + +Gets the URI of the target of the provided link. + +##### Parameters + +`link` The link. + +##### Returns + +The URI of the target of the provided link. + diff --git a/ccm-cms-publicpersonalprofile/doc/freemarker/ccm-cms-publicpersonalprofile.md b/ccm-cms-publicpersonalprofile/doc/freemarker/ccm-cms-publicpersonalprofile.md new file mode 100644 index 000000000..ab1bcabae --- /dev/null +++ b/ccm-cms-publicpersonalprofile/doc/freemarker/ccm-cms-publicpersonalprofile.md @@ -0,0 +1,272 @@ +### ccm-cms-publicpersonalprofile + +Functions for processing the data of a public personal profile. + +#### getProfileOwner + + getProfileOwner(data) + +Get the data about the profile owner. + +##### Parameters + +`data` The public personal profile data + +##### Returns + +The data about the owner of the profile. + +#### getProfileOwnerSurname + + getProfileOwnerSurname(owner) + +Gets the surname of a profile owner. + +##### Parameters + +`owner` The owner. + +##### Returns + +The surname of the provided profile owner. + +#### getProfileOwnerGivenName + + getProfileOwnerGivenName(owner) + +Gets the given name of a profile owner. + +##### Parameters + +`owner` The owner. + +##### Returns + +The given name of the provided profile owner. + +#### getProfileOwnerTitlePre + + getProfileOwnerTitlePre(owner) + +Gets the titles a profile owner. + +##### Parameters + +`owner` The owner. + +##### Returns + +The titles of the provided profile owner which preceed the name of the owner. + +#### getProfileOwnerTitlePost + + getProfileOwnerTitlePost(owner) + +Gets the titles a profile owner. + +##### Parameters + +`owner` The owner. + +##### Returns + +The titles of the provided profile owner which follow the name of the owner. + +#### getProfileOwnerContact + + getProfileOwnerContact(owner) + +Gets the contact data of the owner. + +##### Parameters + +`owner` The owner. + +##### Returns + +The contact data of the owner. The contact data are in the same format as a +content item of the type `ccm-cms-types-contact`. The returned data can be +processed further using the functions for content items of the type +`ccm-cms-types-contact?`. + +#### getProfileImage + + getProfileImage(data) + +Return the data of the image attached to the profile, if any. + +##### Parameters + +`data` The data of the profile. + +##### Returns + +The data about the image attached to the profile if an image was attached +to the profile. The returned data is a image attachement which can be +processed further by the functions provided for processing image assets +(see `ccm-cms-assets-imagestep`). + +#### getProfileOwnerName + + getProfileOwnerName(data) + +Gets the name of the profile owner. + +#### Parameters + +`data` The data of the profile. + +#### Returns + +The name of the content item of the type `Person` assigned to the profile. + +#### getPersonalPublications + + getPersonalPublications(data) + +Gets the data about the personal publications of the profile owner. + +#### Parameters + +`data` The data of the profile. + +#### Returns + +The data about the personal publications of the author, organized +in publications groups. + +#### getPersonalPublicationsAvailablePublicationGroups + + getPersonalPublicationsAvailablePublicationGroups(data) + +Get the available publications groups. + +##### Parameters + +`data` The data of the profile. + +##### Returns + +A sequence of the available publication groups. They can processed further +using `getPublicationGroupId` and `getPublicationGroupLink`. + +#### getPublicationGroupId + + getPublicationGroupId(group) + +##### Parameters + +`group` The publication group. + +##### Returns + +The ID of the publication group. + +#### getPublicationGroupLink + + getPublicationGroupLink(group) + +##### Parameters + +`group` The publication group. + +##### Returns + +The link for showing the publications of the group. + +#### getPublicationGroups + + getPublicationGroups(data) + +Get all publication groups currently displayed. + +##### Parameters + +`data` The data of the profile. + +##### Returns + +A sequence of the publication groups in the data of the profile. + +#### getPublicationsOfGroup + + getPublicationsOfGroup(data) + +Gets the publiations of a group. The publication can be processed +further by the functions provided by `ccm-sci-publications`. + +##### Parameters + +`data` The data of the group. + +##### Returns + +The publications of the group. + +#### getAvailableProjectGroups + + getAvailableProjectGroups(data) + +Get the available project groups. + +##### Parameters + +`data` The data of the profile. + +##### Returns + +A sequence of the available project groups. They can processed further +using `getProjectGroupId` and `getProjectGroupLink`. + +#### getProjectGroupId + + getProjectGroupId(group) + +##### Parameters + +`group` The Project group. + +##### Returns + +The ID of the Project group. + +#### getProjectGroupLink + + getProjectGroupLink(group) + +##### Parameters + +`group` The Project group. + +##### Returns + +The link for showing the Projects of the group. + +#### getProjectGroups + + getProjectGroups(data) + +Get all project groups currently displayed. + +##### Parameters + +`data` The data of the profile. + +##### Returns + +A sequence of the project groups in the data of the profile. + +#### getProjectsOfGroup + + getProjectOfGroup(data) + +Gets the projects of a group. The projects can be processed +further by the functions provided by `ccm-sci-types-project`. + +##### Parameters + +`data` The data of the group. + +##### Returns + +The projects of the group. \ No newline at end of file diff --git a/ccm-cms-publicpersonalprofile/web/themes/freemarker/ccm-cms-publicpersonalprofile.ftl b/ccm-cms-publicpersonalprofile/web/themes/freemarker/ccm-cms-publicpersonalprofile.ftl index a4f3ff642..71e1c30bc 100644 --- a/ccm-cms-publicpersonalprofile/web/themes/freemarker/ccm-cms-publicpersonalprofile.ftl +++ b/ccm-cms-publicpersonalprofile/web/themes/freemarker/ccm-cms-publicpersonalprofile.ftl @@ -69,7 +69,7 @@ <#return data["./publications"]> -<#function gtAvailableProjectGroups data> +<#function getAvailableProjectGroups data> <#return data["./ppp:profile/personalProjects/availableProjectGroups/availableProjectGroup"]> diff --git a/doc/themes-with-freemarker/makefile b/doc/themes-with-freemarker/makefile index fd3eaf9ea..d765972be 100644 --- a/doc/themes-with-freemarker/makefile +++ b/doc/themes-with-freemarker/makefile @@ -2,6 +2,9 @@ FILES = themes-with-freemarker.md FILES += ../../ccm-themedirector/doc/freemarker/ccm-themedirector.md FILES += ../../ccm-cms-assets-fileattachment/doc/freemarker/ccm-cms-assets-fileattachment.md FILES += ../../ccm-cms-assets-imagestep/doc/freemarker/ccm-cms-assets-imagestep.md +FILES += ../../ccm-cms-assets-notes/doc/freemarker/ccm-cms-assets-notes.md +FILES += ../../ccm-cms-assets-relatedlink/doc/freemarker/ccm-cms-assets-relatedlink.md +FILES += ../../ccm-cms-publicpersonalprofile/doc/freemarker/ccm-cms-publicpersonalprofile.md all: html pdf diff --git a/doc/themes-with-freemarker/themes-with-freemarker.html b/doc/themes-with-freemarker/themes-with-freemarker.html index 539b50b30..00f66ddf5 100644 --- a/doc/themes-with-freemarker/themes-with-freemarker.html +++ b/doc/themes-with-freemarker/themes-with-freemarker.html @@ -278,3 +278,201 @@

image The image.

Returns

The URL of the provided image.

+

ccm-cms-assets-notes

+

Functions for processing note assets assigned to a content item.

+

getNotes

+
getNotes(item)
+

Returns the notes assigned to a content item.

+
Parameters
+

item The content item

+
Returns
+

A sequence of the notes assigned to the provided item.

+

getContent

+
getContent(note)
+

Gets the content of a note.

+
Parameters
+

note The note.

+
Returns
+

The content of the note. ### ccm-cms-assets-relatedlink

+

Functions for processing the related links assigned to a content item.

+ +
getRelatedLinks(item, linkListName="NONE")
+

Retrieves the related links assigned to a content item.

+
Parameters
+

item The content item

+

linkListName The related links of a content item can be organized in link lists. The default list (if no other is used) is NONE which is the default value of this parameter. Only the links which belong to the provided group are returned.

+
Returns
+

The related links of the provided linkListGroup of the provided content item.

+

getLinkType

+
getLinkType(link)
+

Gets the type of the provided link which can either be externalLink, internalLink or caption.

+
Parameters
+

link The link

+
Returns
+

The type of the provided link.

+

getLinkTitle

+
getLinkTitle(link)
+

Gets the title of the provided link.

+
Parameters
+

link The link.

+
Returns
+

The title of the provided link.

+

getLinkDescription

+
getLinkDescription(link)
+

Gets the description of the provided link.

+
Parameters
+

link The link.

+
Returns
+

The description of the provided link.

+

getLinkOrder

+
getLinkOrder(link)
+

Gets the order value of the provided link.

+
Parameters
+

link The link.

+
Returns
+

The order value of the provided link.

+

getInternalLinkParameters

+
getLinkInternalLinkParameters(link)
+

Gets the parameters of the of the provided link.

+
Parameters
+

link The link.

+
Returns
+

The parameters to add to the URL of the provided link.

+

getTargetUri

+
getTargetUri(link)
+

Gets the URI of the target of the provided link.

+
Parameters
+

link The link.

+
Returns
+

The URI of the target of the provided link.

+

ccm-cms-publicpersonalprofile

+

Functions for processing the data of a public personal profile.

+

getProfileOwner

+
getProfileOwner(data)
+

Get the data about the profile owner.

+
Parameters
+

data The public personal profile data

+
Returns
+

The data about the owner of the profile.

+

getProfileOwnerSurname

+
getProfileOwnerSurname(owner)
+

Gets the surname of a profile owner.

+
Parameters
+

owner The owner.

+
Returns
+

The surname of the provided profile owner.

+

getProfileOwnerGivenName

+
getProfileOwnerGivenName(owner)
+

Gets the given name of a profile owner.

+
Parameters
+

owner The owner.

+
Returns
+

The given name of the provided profile owner.

+

getProfileOwnerTitlePre

+
getProfileOwnerTitlePre(owner)
+

Gets the titles a profile owner.

+
Parameters
+

owner The owner.

+
Returns
+

The titles of the provided profile owner which preceed the name of the owner.

+

getProfileOwnerTitlePost

+
getProfileOwnerTitlePost(owner)
+

Gets the titles a profile owner.

+
Parameters
+

owner The owner.

+
Returns
+

The titles of the provided profile owner which follow the name of the owner.

+

getProfileOwnerContact

+
getProfileOwnerContact(owner)
+

Gets the contact data of the owner.

+
Parameters
+

owner The owner.

+
Returns
+

The contact data of the owner. The contact data are in the same format as a content item of the type ccm-cms-types-contact. The returned data can be processed further using the functions for content items of the type ccm-cms-types-contact?.

+

getProfileImage

+
getProfileImage(data)
+

Return the data of the image attached to the profile, if any.

+
Parameters
+

data The data of the profile.

+
Returns
+

The data about the image attached to the profile if an image was attached to the profile. The returned data is a image attachement which can be processed further by the functions provided for processing image assets (see ccm-cms-assets-imagestep).

+

getProfileOwnerName

+
getProfileOwnerName(data)
+

Gets the name of the profile owner.

+

Parameters

+

data The data of the profile.

+

Returns

+

The name of the content item of the type Person assigned to the profile.

+

getPersonalPublications

+
getPersonalPublications(data)
+

Gets the data about the personal publications of the profile owner.

+

Parameters

+

data The data of the profile.

+

Returns

+

The data about the personal publications of the author, organized in publications groups.

+

getPersonalPublicationsAvailablePublicationGroups

+
getPersonalPublicationsAvailablePublicationGroups(data)
+

Get the available publications groups.

+
Parameters
+

data The data of the profile.

+
Returns
+

A sequence of the available publication groups. They can processed further using getPublicationGroupId and getPublicationGroupLink.

+

getPublicationGroupId

+
getPublicationGroupId(group)
+
Parameters
+

group The publication group.

+
Returns
+

The ID of the publication group.

+ +
getPublicationGroupLink(group)
+
Parameters
+

group The publication group.

+
Returns
+

The link for showing the publications of the group.

+

getPublicationGroups

+
getPublicationGroups(data)
+

Get all publication groups currently displayed.

+
Parameters
+

data The data of the profile.

+
Returns
+

A sequence of the publication groups in the data of the profile.

+

getPublicationsOfGroup

+
getPublicationsOfGroup(data)
+

Gets the publiations of a group. The publication can be processed further by the functions provided by ccm-sci-publications.

+
Parameters
+

data The data of the group.

+
Returns
+

The publications of the group.

+

getAvailableProjectGroups

+
getAvailableProjectGroups(data)
+

Get the available project groups.

+
Parameters
+

data The data of the profile.

+
Returns
+

A sequence of the available project groups. They can processed further using getProjectGroupId and getProjectGroupLink.

+

getProjectGroupId

+
getProjectGroupId(group)
+
Parameters
+

group The Project group.

+
Returns
+

The ID of the Project group.

+ +
getProjectGroupLink(group)
+
Parameters
+

group The Project group.

+
Returns
+

The link for showing the Projects of the group.

+

getProjectGroups

+
getProjectGroups(data)
+

Get all project groups currently displayed.

+
Parameters
+

data The data of the profile.

+
Returns
+

A sequence of the project groups in the data of the profile.

+

getProjectsOfGroup

+
getProjectOfGroup(data)
+

Gets the projects of a group. The projects can be processed further by the functions provided by ccm-sci-types-project.

+
Parameters
+

data The data of the group.

+
Returns
+

The projects of the group.

diff --git a/doc/themes-with-freemarker/themes-with-freemarker.pdf b/doc/themes-with-freemarker/themes-with-freemarker.pdf index 639c4a168..0c0971388 100644 Binary files a/doc/themes-with-freemarker/themes-with-freemarker.pdf and b/doc/themes-with-freemarker/themes-with-freemarker.pdf differ