Documentation for the Freemarker functions provided by ccm-cms-types-image

git-svn-id: https://svn.libreccm.org/ccm/trunk@6114 8810af33-2d31-482b-a856-94f89814c4df

ccm-cms-types-image/doc/freemarker/ccm-cms-types-image.md

@@ -0,0 +1,84 @@
+# Freemarker functions for Image items
+
+Import Path
+: `/ccm-cms-types-image.ftl`
+
+## `getArtist(item: Node): String`
+
+Returns the name of the artist how created the image.
+
+## `getCopyright(item: Node): String`
+
+Returns the value of the `copyright` property of the image.
+
+## `getDescription(item: Node): String`
+
+Returns the description of the image.
+
+## `getLicense(item: Node): String`
+
+Returns the license text for the image.
+
+## `getMaterial(item: Node): String`
+
+Gets the value of the `material` property of the image.
+
+## `getPublishDate(item: Node): String`
+
+Gets the publish date of the image.
+
+## `getWidth(item: Node): String`
+
+Gets the value of the `width` property of the image.
+
+## `getHeight(item: Node): String`
+
+Gets the value of the `height` property of the image.
+
+## `getMainText(item: Node): HTMLString`
+
+Gets the main text describing the image.
+
+## `getOrigin(item: Node): String`
+
+Gets the value of the `origin` property of the image.
+
+## `getOriginalSize(item: Node): String`
+
+Gets the original size of the image.
+
+## `getUrl(item: Node): String
+
+Returns the URL of the image resource.
+
+## `getCaption(item: Node): String`
+
+Returns the caption of the image.
+
+## `getImageId(item: Node): String`
+
+Gets the ID of the image resource.
+
+## `getThumbnailId(item: Node): String`
+
+Gets the ID of the thumbnail image.
+
+## `getThumbnailWidth(item: Node): String`
+
+Gets the width of the thumbnail.
+
+## `getThumbnailHeight(item: Node): String`
+
+Gets the height of the thumbnail.
+
+## `getSite(item: Node): String`
+
+Gets the value of the `site` property of the image.
+
+## `getSource(item: Node): String`
+
+Gets the value of the `source` property of the image.
+
+## `getTechnique(item: Node): String`
+
+Gets the value of the `technique` property of the image.