LibreCCM
/
libreccm-legacy
3
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Documentation for the Freemarker functions provided by ccm-cms-assets-imagestep 

git-svn-id: https://svn.libreccm.org/ccm/trunk@6106 8810af33-2d31-482b-a856-94f89814c4df
master
jensp 2019-06-05 15:42:39 +00:00
parent 7e4dab8465
commit da9b2fe4e2
1 changed files with 13 additions and 92 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

105
ccm-cms-assets-imagestep/doc/freemarker/ccm-cms-assets-imagestep.md
View File

@ -1,8 +1,9 @@
### ccm-cms-assets-imagestep
# Freemarker functions for Image Attachments
Provides functions for dealing with image attachments of a content item.
Import path: `<#import "/ccm-cms-assets-imagestep.ftl" as Images>`
Import path
: `/ccm-cms-assets-imagestep.ftl"`
Example usage:
@ -29,115 +30,35 @@ Example usage:
</#list>
```
#### getImageAttachments
## `getImageAttachments(item: Node): Sequence<Node>`
getImageAttachments(item)
Get the image attachments of the provided content item.
Get the image attachments of a content item
## `getImageId(image: Node): String`
##### Parameters
Gets the ID of the provided image.
`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)
## `getImageName(image: Node): String`
Gets the name of the provided image.
##### Parameters
`image` The image.
##### Returns
The name of the image.
#### getImageCaption
getImageCaption(image)
## `getImageCaption(image: Node): String`
Gets the caption of the provided image.
##### Parameters
`image` The image.
##### Returns
The caption of the image.
#### getImageSortKey
getImageSortKey(image)
#### `getImageSortKey(image: Node): String`
Gets the sort key of the provided image.
##### Parameters
`image` The image.
##### Returns
The sort key of the provided image.
#### getImageWidth
getImageWidth(image)
## `getImageWidth(image: Node): String`
Gets the width of the provided image.
##### Parameters
`image` The image.
##### Returns
The width of the provided image.
#### getImageHeight
getImageHeight(image)
#### `getImageHeight(image: Node): String`
Gets the height of the provided image.
##### Parameters
`image` The image.
##### Returns
The height of the provided image.
#### getImageUrl
getImageUrl(image)
## `getImageUrl(image: Node): String`
Gets the URL of the provided image.
##### Parameters
`image` The image.
##### Returns
The URL of the provided image.