More documentation for using Freemarker
git-svn-id: https://svn.libreccm.org/ccm/trunk@5996 8810af33-2d31-482b-a856-94f89814c4dfmaster
jensp
parent
6fc54d213e
commit
4d117fe2dc
|
|
@ -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.
|
||||||
|
|
@ -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.
|
||||||
|
|
||||||
|
|
@ -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.
|
||||||
|
|
@ -69,7 +69,7 @@
|
||||||
<#return data["./publications"]>
|
<#return data["./publications"]>
|
||||||
</#function>
|
</#function>
|
||||||
|
|
||||||
<#function gtAvailableProjectGroups data>
|
<#function getAvailableProjectGroups data>
|
||||||
<#return data["./ppp:profile/personalProjects/availableProjectGroups/availableProjectGroup"]>
|
<#return data["./ppp:profile/personalProjects/availableProjectGroups/availableProjectGroup"]>
|
||||||
</#function>
|
</#function>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,9 @@ FILES = themes-with-freemarker.md
|
||||||
FILES += ../../ccm-themedirector/doc/freemarker/ccm-themedirector.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-fileattachment/doc/freemarker/ccm-cms-assets-fileattachment.md
|
||||||
FILES += ../../ccm-cms-assets-imagestep/doc/freemarker/ccm-cms-assets-imagestep.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
|
all: html pdf
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -278,3 +278,201 @@
|
||||||
<p><code>image</code> The image.</p>
|
<p><code>image</code> The image.</p>
|
||||||
<h5 id="returns-18">Returns</h5>
|
<h5 id="returns-18">Returns</h5>
|
||||||
<p>The URL of the provided image.</p>
|
<p>The URL of the provided image.</p>
|
||||||
|
<h3 id="ccm-cms-assets-notes">ccm-cms-assets-notes</h3>
|
||||||
|
<p>Functions for processing note assets assigned to a content item.</p>
|
||||||
|
<h4 id="getnotes">getNotes</h4>
|
||||||
|
<pre><code>getNotes(item)</code></pre>
|
||||||
|
<p>Returns the notes assigned to a content item.</p>
|
||||||
|
<h5 id="parameters-19">Parameters</h5>
|
||||||
|
<p><code>item</code> The content item</p>
|
||||||
|
<h5 id="returns-19">Returns</h5>
|
||||||
|
<p>A sequence of the notes assigned to the provided item.</p>
|
||||||
|
<h4 id="getcontent">getContent</h4>
|
||||||
|
<pre><code>getContent(note)</code></pre>
|
||||||
|
<p>Gets the content of a note.</p>
|
||||||
|
<h5 id="parameters-20">Parameters</h5>
|
||||||
|
<p><code>note</code> The note.</p>
|
||||||
|
<h5 id="returns-20">Returns</h5>
|
||||||
|
<p>The content of the note. ### ccm-cms-assets-relatedlink</p>
|
||||||
|
<p>Functions for processing the related links assigned to a content item.</p>
|
||||||
|
<h4 id="getrelatedlinks">getRelatedLinks</h4>
|
||||||
|
<pre><code>getRelatedLinks(item, linkListName="NONE")</code></pre>
|
||||||
|
<p>Retrieves the related links assigned to a content item.</p>
|
||||||
|
<h5 id="parameters-21">Parameters</h5>
|
||||||
|
<p><code>item</code> The content item</p>
|
||||||
|
<p><code>linkListName</code> The related links of a content item can be organized in link lists. The default list (if no other is used) is <code>NONE</code> which is the default value of this parameter. Only the links which belong to the provided group are returned.</p>
|
||||||
|
<h5 id="returns-21">Returns</h5>
|
||||||
|
<p>The related links of the provided <code>linkListGroup</code> of the provided content item.</p>
|
||||||
|
<h4 id="getlinktype">getLinkType</h4>
|
||||||
|
<pre><code>getLinkType(link)</code></pre>
|
||||||
|
<p>Gets the type of the provided link which can either be <code>externalLink</code>, <code>internalLink</code> or <code>caption</code>.</p>
|
||||||
|
<h5 id="parameters-22">Parameters</h5>
|
||||||
|
<p><code>link</code> The link</p>
|
||||||
|
<h5 id="returns-22">Returns</h5>
|
||||||
|
<p>The type of the provided link.</p>
|
||||||
|
<h4 id="getlinktitle">getLinkTitle</h4>
|
||||||
|
<pre><code>getLinkTitle(link)</code></pre>
|
||||||
|
<p>Gets the title of the provided link.</p>
|
||||||
|
<h5 id="parameters-23">Parameters</h5>
|
||||||
|
<p><code>link</code> The link.</p>
|
||||||
|
<h5 id="returns-23">Returns</h5>
|
||||||
|
<p>The title of the provided link.</p>
|
||||||
|
<h4 id="getlinkdescription">getLinkDescription</h4>
|
||||||
|
<pre><code>getLinkDescription(link)</code></pre>
|
||||||
|
<p>Gets the description of the provided link.</p>
|
||||||
|
<h5 id="parameters-24">Parameters</h5>
|
||||||
|
<p><code>link</code> The link.</p>
|
||||||
|
<h5 id="returns-24">Returns</h5>
|
||||||
|
<p>The description of the provided link.</p>
|
||||||
|
<h4 id="getlinkorder">getLinkOrder</h4>
|
||||||
|
<pre><code>getLinkOrder(link)</code></pre>
|
||||||
|
<p>Gets the order value of the provided link.</p>
|
||||||
|
<h5 id="parameters-25">Parameters</h5>
|
||||||
|
<p><code>link</code> The link.</p>
|
||||||
|
<h5 id="returns-25">Returns</h5>
|
||||||
|
<p>The order value of the provided link.</p>
|
||||||
|
<h4 id="getinternallinkparameters">getInternalLinkParameters</h4>
|
||||||
|
<pre><code>getLinkInternalLinkParameters(link)</code></pre>
|
||||||
|
<p>Gets the parameters of the of the provided link.</p>
|
||||||
|
<h5 id="parameters-26">Parameters</h5>
|
||||||
|
<p><code>link</code> The link.</p>
|
||||||
|
<h5 id="returns-26">Returns</h5>
|
||||||
|
<p>The parameters to add to the URL of the provided link.</p>
|
||||||
|
<h4 id="gettargeturi">getTargetUri</h4>
|
||||||
|
<pre><code>getTargetUri(link)</code></pre>
|
||||||
|
<p>Gets the URI of the target of the provided link.</p>
|
||||||
|
<h5 id="parameters-27">Parameters</h5>
|
||||||
|
<p><code>link</code> The link.</p>
|
||||||
|
<h5 id="returns-27">Returns</h5>
|
||||||
|
<p>The URI of the target of the provided link.</p>
|
||||||
|
<h3 id="ccm-cms-publicpersonalprofile">ccm-cms-publicpersonalprofile</h3>
|
||||||
|
<p>Functions for processing the data of a public personal profile.</p>
|
||||||
|
<h4 id="getprofileowner">getProfileOwner</h4>
|
||||||
|
<pre><code>getProfileOwner(data)</code></pre>
|
||||||
|
<p>Get the data about the profile owner.</p>
|
||||||
|
<h5 id="parameters-28">Parameters</h5>
|
||||||
|
<p><code>data</code> The public personal profile data</p>
|
||||||
|
<h5 id="returns-28">Returns</h5>
|
||||||
|
<p>The data about the owner of the profile.</p>
|
||||||
|
<h4 id="getprofileownersurname">getProfileOwnerSurname</h4>
|
||||||
|
<pre><code>getProfileOwnerSurname(owner)</code></pre>
|
||||||
|
<p>Gets the surname of a profile owner.</p>
|
||||||
|
<h5 id="parameters-29">Parameters</h5>
|
||||||
|
<p><code>owner</code> The owner.</p>
|
||||||
|
<h5 id="returns-29">Returns</h5>
|
||||||
|
<p>The surname of the provided profile owner.</p>
|
||||||
|
<h4 id="getprofileownergivenname">getProfileOwnerGivenName</h4>
|
||||||
|
<pre><code>getProfileOwnerGivenName(owner)</code></pre>
|
||||||
|
<p>Gets the given name of a profile owner.</p>
|
||||||
|
<h5 id="parameters-30">Parameters</h5>
|
||||||
|
<p><code>owner</code> The owner.</p>
|
||||||
|
<h5 id="returns-30">Returns</h5>
|
||||||
|
<p>The given name of the provided profile owner.</p>
|
||||||
|
<h4 id="getprofileownertitlepre">getProfileOwnerTitlePre</h4>
|
||||||
|
<pre><code>getProfileOwnerTitlePre(owner)</code></pre>
|
||||||
|
<p>Gets the titles a profile owner.</p>
|
||||||
|
<h5 id="parameters-31">Parameters</h5>
|
||||||
|
<p><code>owner</code> The owner.</p>
|
||||||
|
<h5 id="returns-31">Returns</h5>
|
||||||
|
<p>The titles of the provided profile owner which preceed the name of the owner.</p>
|
||||||
|
<h4 id="getprofileownertitlepost">getProfileOwnerTitlePost</h4>
|
||||||
|
<pre><code>getProfileOwnerTitlePost(owner)</code></pre>
|
||||||
|
<p>Gets the titles a profile owner.</p>
|
||||||
|
<h5 id="parameters-32">Parameters</h5>
|
||||||
|
<p><code>owner</code> The owner.</p>
|
||||||
|
<h5 id="returns-32">Returns</h5>
|
||||||
|
<p>The titles of the provided profile owner which follow the name of the owner.</p>
|
||||||
|
<h4 id="getprofileownercontact">getProfileOwnerContact</h4>
|
||||||
|
<pre><code>getProfileOwnerContact(owner)</code></pre>
|
||||||
|
<p>Gets the contact data of the owner.</p>
|
||||||
|
<h5 id="parameters-33">Parameters</h5>
|
||||||
|
<p><code>owner</code> The owner.</p>
|
||||||
|
<h5 id="returns-33">Returns</h5>
|
||||||
|
<p>The contact data of the owner. The contact data are in the same format as a content item of the type <code>ccm-cms-types-contact</code>. The returned data can be processed further using the functions for content items of the type <code>ccm-cms-types-contact?</code>.</p>
|
||||||
|
<h4 id="getprofileimage">getProfileImage</h4>
|
||||||
|
<pre><code>getProfileImage(data)</code></pre>
|
||||||
|
<p>Return the data of the image attached to the profile, if any.</p>
|
||||||
|
<h5 id="parameters-34">Parameters</h5>
|
||||||
|
<p><code>data</code> The data of the profile.</p>
|
||||||
|
<h5 id="returns-34">Returns</h5>
|
||||||
|
<p>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 <code>ccm-cms-assets-imagestep</code>).</p>
|
||||||
|
<h4 id="getprofileownername">getProfileOwnerName</h4>
|
||||||
|
<pre><code>getProfileOwnerName(data)</code></pre>
|
||||||
|
<p>Gets the name of the profile owner.</p>
|
||||||
|
<h4 id="parameters-35">Parameters</h4>
|
||||||
|
<p><code>data</code> The data of the profile.</p>
|
||||||
|
<h4 id="returns-35">Returns</h4>
|
||||||
|
<p>The name of the content item of the type <code>Person</code> assigned to the profile.</p>
|
||||||
|
<h4 id="getpersonalpublications">getPersonalPublications</h4>
|
||||||
|
<pre><code>getPersonalPublications(data)</code></pre>
|
||||||
|
<p>Gets the data about the personal publications of the profile owner.</p>
|
||||||
|
<h4 id="parameters-36">Parameters</h4>
|
||||||
|
<p><code>data</code> The data of the profile.</p>
|
||||||
|
<h4 id="returns-36">Returns</h4>
|
||||||
|
<p>The data about the personal publications of the author, organized in publications groups.</p>
|
||||||
|
<h4 id="getpersonalpublicationsavailablepublicationgroups">getPersonalPublicationsAvailablePublicationGroups</h4>
|
||||||
|
<pre><code>getPersonalPublicationsAvailablePublicationGroups(data)</code></pre>
|
||||||
|
<p>Get the available publications groups.</p>
|
||||||
|
<h5 id="parameters-37">Parameters</h5>
|
||||||
|
<p><code>data</code> The data of the profile.</p>
|
||||||
|
<h5 id="returns-37">Returns</h5>
|
||||||
|
<p>A sequence of the available publication groups. They can processed further using <code>getPublicationGroupId</code> and <code>getPublicationGroupLink</code>.</p>
|
||||||
|
<h4 id="getpublicationgroupid">getPublicationGroupId</h4>
|
||||||
|
<pre><code>getPublicationGroupId(group)</code></pre>
|
||||||
|
<h5 id="parameters-38">Parameters</h5>
|
||||||
|
<p><code>group</code> The publication group.</p>
|
||||||
|
<h5 id="returns-38">Returns</h5>
|
||||||
|
<p>The ID of the publication group.</p>
|
||||||
|
<h4 id="getpublicationgrouplink">getPublicationGroupLink</h4>
|
||||||
|
<pre><code>getPublicationGroupLink(group)</code></pre>
|
||||||
|
<h5 id="parameters-39">Parameters</h5>
|
||||||
|
<p><code>group</code> The publication group.</p>
|
||||||
|
<h5 id="returns-39">Returns</h5>
|
||||||
|
<p>The link for showing the publications of the group.</p>
|
||||||
|
<h4 id="getpublicationgroups">getPublicationGroups</h4>
|
||||||
|
<pre><code>getPublicationGroups(data)</code></pre>
|
||||||
|
<p>Get all publication groups currently displayed.</p>
|
||||||
|
<h5 id="parameters-40">Parameters</h5>
|
||||||
|
<p><code>data</code> The data of the profile.</p>
|
||||||
|
<h5 id="returns-40">Returns</h5>
|
||||||
|
<p>A sequence of the publication groups in the data of the profile.</p>
|
||||||
|
<h4 id="getpublicationsofgroup">getPublicationsOfGroup</h4>
|
||||||
|
<pre><code>getPublicationsOfGroup(data)</code></pre>
|
||||||
|
<p>Gets the publiations of a group. The publication can be processed further by the functions provided by <code>ccm-sci-publications</code>.</p>
|
||||||
|
<h5 id="parameters-41">Parameters</h5>
|
||||||
|
<p><code>data</code> The data of the group.</p>
|
||||||
|
<h5 id="returns-41">Returns</h5>
|
||||||
|
<p>The publications of the group.</p>
|
||||||
|
<h4 id="getavailableprojectgroups">getAvailableProjectGroups</h4>
|
||||||
|
<pre><code>getAvailableProjectGroups(data)</code></pre>
|
||||||
|
<p>Get the available project groups.</p>
|
||||||
|
<h5 id="parameters-42">Parameters</h5>
|
||||||
|
<p><code>data</code> The data of the profile.</p>
|
||||||
|
<h5 id="returns-42">Returns</h5>
|
||||||
|
<p>A sequence of the available project groups. They can processed further using <code>getProjectGroupId</code> and <code>getProjectGroupLink</code>.</p>
|
||||||
|
<h4 id="getprojectgroupid">getProjectGroupId</h4>
|
||||||
|
<pre><code>getProjectGroupId(group)</code></pre>
|
||||||
|
<h5 id="parameters-43">Parameters</h5>
|
||||||
|
<p><code>group</code> The Project group.</p>
|
||||||
|
<h5 id="returns-43">Returns</h5>
|
||||||
|
<p>The ID of the Project group.</p>
|
||||||
|
<h4 id="getprojectgrouplink">getProjectGroupLink</h4>
|
||||||
|
<pre><code>getProjectGroupLink(group)</code></pre>
|
||||||
|
<h5 id="parameters-44">Parameters</h5>
|
||||||
|
<p><code>group</code> The Project group.</p>
|
||||||
|
<h5 id="returns-44">Returns</h5>
|
||||||
|
<p>The link for showing the Projects of the group.</p>
|
||||||
|
<h4 id="getprojectgroups">getProjectGroups</h4>
|
||||||
|
<pre><code>getProjectGroups(data)</code></pre>
|
||||||
|
<p>Get all project groups currently displayed.</p>
|
||||||
|
<h5 id="parameters-45">Parameters</h5>
|
||||||
|
<p><code>data</code> The data of the profile.</p>
|
||||||
|
<h5 id="returns-45">Returns</h5>
|
||||||
|
<p>A sequence of the project groups in the data of the profile.</p>
|
||||||
|
<h4 id="getprojectsofgroup">getProjectsOfGroup</h4>
|
||||||
|
<pre><code>getProjectOfGroup(data)</code></pre>
|
||||||
|
<p>Gets the projects of a group. The projects can be processed further by the functions provided by <code>ccm-sci-types-project</code>.</p>
|
||||||
|
<h5 id="parameters-46">Parameters</h5>
|
||||||
|
<p><code>data</code> The data of the group.</p>
|
||||||
|
<h5 id="returns-46">Returns</h5>
|
||||||
|
<p>The projects of the group.</p>
|
||||||
|
|
|
||||||
Binary file not shown.
Loading…
Reference in New Issue