+
+```
+
+#### getFileAttachments
+
+ getFileAttachments(item: ContentItemNode): Sequence
+
+Return the file attachments of a content items
+
+##### Parameters
+
+`item` The content item from which the file attachments are retrieved.
+
+##### Returns
+
+A sequence of the file attachments of the provided content item.
+
+#### getFileType
+
+ getFileType(file)
+
+Returns the type of the file attachments which is either `caption` or `file`.
+
+##### Parameters
+
+`file` The file attachment
+
+##### Returns
+
+The type of the file attachment.
+
+#### getMimeType
+
+ getMimeType(file)
+
+Returns the mime type of the file.
+
+##### Parameters
+
+`file` The file
+
+##### Returns
+
+The mime type of the file.
+
+#### getMimeTypeFileExtension
+
+ getMimeTypeFileExtension(file)
+
+Returns the usual file extension for the mime type of the file.
+
+##### Parameters
+
+`file` The file
+
+##### Returns
+
+The usual file extension for the mime type of the file.
+
+#### getFileSize
+
+ getFileSize(file unit="byte")
+
+Returns the size of the file in the provided unit.
+
+##### Parameters
+
+`file`The file
+
+`unit` Optional parameter for unit in which the size is returned. Default
+value is `byte`. Supported values are `byte`, `kB` `KiB`, `MB` and `MiB`.
+All other values are interpreted as `byte`.
+
+##### Returns
+
+The size of the file in the provided unit.
+
+
+#### getFileId
+
+ getFileId(file)
+
+Returns the ID of the file.
+
+##### Parameters
+
+`file` The file
+
+##### Returns
+
+The ID of the file.
+
+#### getFileName
+
+ getFileName(file)
+
+Returns the name of file.
+
+##### Parameters
+
+`file` The file
+
+##### Returns
+
+The name of the file.
+
+#### getFileDescription
+
+ getFileDescription(file)
+
+Returns the name of file.
+
+##### Parameters
+
+`file` The file
+
+##### Returns
+
+The description of the file.
+
+#### getFileUrl
+
+ getFileUrl(file)
+
+Returns the name of file.
+
+##### Parameters
+
+`file` The file
+
+##### Returns
+
+The URL of the file.
diff --git a/ccm-cms-assets-imagestep/doc/freemarker/ccm-cms-assets-imagestep.md b/ccm-cms-assets-imagestep/doc/freemarker/ccm-cms-assets-imagestep.md
new file mode 100644
index 000000000..0de2ec64e
--- /dev/null
+++ b/ccm-cms-assets-imagestep/doc/freemarker/ccm-cms-assets-imagestep.md
@@ -0,0 +1,143 @@
+### ccm-cms-assets-imagestep
+
+Provides functions for dealing with image attachments of a content item.
+
+Import path: `<#import "/ccm-cms-assets-imagestep.ftl" as Images>`
+
+Example usage:
+
+```
+<#import "/ccm-cms-assets-imagestep.ftl" as Images>
+
+<#list Images.getImageAttachments(item)>
+
+
+```
+
+#### getImageAttachments
+
+ getImageAttachments(item)
+
+Get the image attachments of a content item
+
+##### Parameters
+
+`item` The content item.
+
+##### Returns
+
+A sequence of the image attachments of the provided content item.
+
+#### getImageId
+
+ getImageId(image)
+
+Get the ID of the provided image.
+
+##### Parameters
+
+`image` The image.
+
+##### Returns
+
+The id of the image.
+
+#### getImageName
+
+ getImageName(image)
+
+Gets the name of the provided image.
+
+##### Parameters
+
+`image` The image.
+
+##### Returns
+
+The name of the image.
+
+#### getImageCaption
+
+ getImageCaption(image)
+
+Gets the caption of the provided image.
+
+##### Parameters
+
+`image` The image.
+
+##### Returns
+
+The caption of the image.
+
+#### getImageSortKey
+
+ getImageSortKey(image)
+
+Gets the sort key of the provided image.
+
+##### Parameters
+
+`image` The image.
+
+##### Returns
+
+The sort key of the provided image.
+
+#### getImageWidth
+
+ getImageWidth(image)
+
+Gets the width of the provided image.
+
+##### Parameters
+
+`image` The image.
+
+##### Returns
+
+The width of the provided image.
+
+#### getImageHeight
+
+ getImageHeight(image)
+
+Gets the height of the provided image.
+
+##### Parameters
+
+`image` The image.
+
+##### Returns
+
+The height of the provided image.
+
+#### getImageUrl
+
+ getImageUrl(image)
+
+Gets the URL of the provided image.
+
+##### Parameters
+
+`image` The image.
+
+##### Returns
+
+The URL of the provided image.
+
diff --git a/ccm-bookmarks/web/themes/freemarker/ccm-cms-types-bookmark.ftl b/ccm-cms-types-bookmark/web/themes/freemarker/ccm-cms-types-bookmark.ftl
similarity index 100%
rename from ccm-bookmarks/web/themes/freemarker/ccm-cms-types-bookmark.ftl
rename to ccm-cms-types-bookmark/web/themes/freemarker/ccm-cms-types-bookmark.ftl
diff --git a/ccm-themedirector/doc/freemarker/ccm-themedirector.md b/ccm-themedirector/doc/freemarker/ccm-themedirector.md
index 9af9cb2a0..29c813db8 100644
--- a/ccm-themedirector/doc/freemarker/ccm-themedirector.md
+++ b/ccm-themedirector/doc/freemarker/ccm-themedirector.md
@@ -2,7 +2,7 @@
#### Language related
-Import path: `<#import /utils.ftl as Utils>`
+Import path: `<#import /language.ftl as Lang>`
##### `getAvailableLanguages`
@@ -22,3 +22,107 @@ This example uses the `list` directive from Freemarker to iterate over the avail
check if the curent language is the selected language. If this is the case
a CSS class is added to the HTML.
+#### Basic functions
+
+Import path: `<#import /utils.ftl as Utils>`
+
+##### getPageApplication
+
+ getPageApplication()
+
+Return the application of the current page.
+
+##### getPageTitle
+
+ getPageTitle()
+
+Returns the title of the current page
+
+##### getSiteHostName
+
+ getSiteHostName()
+
+Returns the name of the host serving the site.
+
+##### getSiteName
+
+ getSiteName()
+
+Returns the name of the site.
+
+##### getBooleanAttrValue
+
+ getBooleanAttrValue(fromNode: Node attrName: String)
+
+A helper function which tries to convert the value of the attribute `attrName` of the node `fromNode` to a boolean. The following values
+are interpreted as true: `true`, `yes`. All other values are interpreted
+as `false`.
+
+###### Parameters
+
+`fromNode` A XML node
+
+`attrName` The name of attribute to interpret as boolean
+
+###### Returns
+
+A boolean for the value of the attribute. If the attribute is not present
+in the provided node the function returns `false`.
+
+##### formatDateTime
+
+ formatDateTime(style: String date: Node)
+
+Formats the value of date/time value node according to the provided
+`style`. The is defined in the theme manifest in the `date-time-formats`
+section. It is possible to define different styles for different languages.
+The style definition in the theme manifest must be in the format expected by the Java
+[DateTimeFormatter](https://docs.oracle.com/javase/8/docs/api/index.html?java/time/format/DateTimeFormatter.html) class.
+
+
+###### Parameters
+
+`style` A date-time format defined in the theme manifest. The format must be formatted as expected by the [DateTimeFormatter](https://docs.oracle.com/javase/8/docs/api/index.html?java/time/format/DateTimeFormatter.html) class.
+
+`date` The node providing the data of the date to format.
+
+###### Returns
+
+A date formatted as defined in `style`.
+
+###### Examples
+
+In the theme manifest in the following format is defined:
+
+```
+"date-time-formats": [
+ ...
+ {
+ "style": "news",
+ "lang": "de",
+ "format": "dd.MM.YYYY"
+ },
+ {
+ "style": "news",
+ "lang": "en",
+ "format": "MM/dd/YY"
+ },
+ ...
+]
+```
+
+The use this format:
+
+```
+Utils.formatDateTime('news', News.getDateTime(item))
+```
+
+`News.getDateTime` gets the date of a news item. If the date of the news is 2019-04-01 the return value of the function for german is
+
+ 01.04.2019
+
+and for english:
+
+ 4/1/19
+
+
diff --git a/doc/themes-with-freemarker/makefile b/doc/themes-with-freemarker/makefile
index ac74b5e15..fd3eaf9ea 100644
--- a/doc/themes-with-freemarker/makefile
+++ b/doc/themes-with-freemarker/makefile
@@ -1,7 +1,12 @@
+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
+
all: html pdf
html:
- pandoc -t html -o themes-with-freemarker.html themes-with-freemarker.md ../../ccm-themedirector/doc/freemarker/ccm-themedirector.md
+ pandoc -t html -o themes-with-freemarker.html ${FILES}
pdf:
- pandoc -t latex -o themes-with-freemarker.pdf themes-with-freemarker.md ../../ccm-themedirector/doc/freemarker/ccm-themedirector.md
+ pandoc -t latex -o themes-with-freemarker.pdf ${FILES}
diff --git a/doc/themes-with-freemarker/themes-with-freemarker.html b/doc/themes-with-freemarker/themes-with-freemarker.html
index 511888698..539b50b30 100644
--- a/doc/themes-with-freemarker/themes-with-freemarker.html
+++ b/doc/themes-with-freemarker/themes-with-freemarker.html
@@ -39,8 +39,8 @@
Functions and Macros
Common functions
Language related
-
Import path: <#import /utils.ftl as Utils>
-
Sequence getAvailableLanguages
+
Import path: <#import /language.ftl as Lang>
+
getAvailableLanguages
Sequence getAvailableLanguages()
Returns the available languages for the current document as sequence. These sequence can be used for creating links for selecting the language:
This example uses the list directive from Freemarker to iterate over the available languages returned by getAvailableLanguages The Freemarker build-in ?then is used together with the negotiatedLanguage variable to check if the curent language is the selected language. If this is the case a CSS class is added to the HTML.
A helper function which tries to convert the value of the attribute attrName of the node fromNode to a boolean. The following values are interpreted as true: true, yes. All other values are interpreted as false.
+
Parameters
+
fromNode A XML node
+
attrName The name of attribute to interpret as boolean
+
Returns
+
A boolean for the value of the attribute. If the attribute is not present in the provided node the function returns false.
+
formatDateTime
+
formatDateTime(style: String date: Node)
+
Formats the value of date/time value node according to the provided style. The is defined in the theme manifest in the date-time-formats section. It is possible to define different styles for different languages. The style definition in the theme manifest must be in the format expected by the Java DateTimeFormatter class.
+
Parameters
+
style A date-time format defined in the theme manifest. The format must be formatted as expected by the DateTimeFormatter class.
+
date The node providing the data of the date to format.
+
Returns
+
A date formatted as defined in style.
+
Examples
+
In the theme manifest in the following format is defined:
item The content item from which the file attachments are retrieved.
+
Returns
+
A sequence of the file attachments of the provided content item.
+
getFileType
+
getFileType(file)
+
Returns the type of the file attachments which is either caption or file.
+
Parameters
+
file The file attachment
+
Returns
+
The type of the file attachment.
+
getMimeType
+
getMimeType(file)
+
Returns the mime type of the file.
+
Parameters
+
file The file
+
Returns
+
The mime type of the file.
+
getMimeTypeFileExtension
+
getMimeTypeFileExtension(file)
+
Returns the usual file extension for the mime type of the file.
+
Parameters
+
file The file
+
Returns
+
The usual file extension for the mime type of the file.
+
getFileSize
+
getFileSize(file unit="byte")
+
Returns the size of the file in the provided unit.
+
Parameters
+
fileThe file
+
unit Optional parameter for unit in which the size is returned. Default value is byte. Supported values are byte, kBKiB, MB and MiB. All other values are interpreted as byte.
+
Returns
+
The size of the file in the provided unit.
+
getFileId
+
getFileId(file)
+
Returns the ID of the file.
+
Parameters
+
file The file
+
Returns
+
The ID of the file.
+
getFileName
+
getFileName(file)
+
Returns the name of file.
+
Parameters
+
file The file
+
Returns
+
The name of the file.
+
getFileDescription
+
getFileDescription(file)
+
Returns the name of file.
+
Parameters
+
file The file
+
Returns
+
The description of the file.
+
getFileUrl
+
getFileUrl(file)
+
Returns the name of file.
+
Parameters
+
file The file
+
Returns
+
The URL of the file.
+
ccm-cms-assets-imagestep
+
Provides functions for dealing with image attachments of a content item.
+
Import path: <#import "/ccm-cms-assets-imagestep.ftl" as Images>
})
+
+