Documentation for the Freemarker functions provided by ccm-navigation
git-svn-id: https://svn.libreccm.org/ccm/trunk@6119 8810af33-2d31-482b-a856-94f89814c4dfmaster
jensp
parent
b15ccb1b41
commit
85cbe1b8c3
|
|
@ -0,0 +1,77 @@
|
|||
# Freemarker functions for ccm-navigation
|
||||
|
||||
Import Path
|
||||
: `/ccm-navigation/navigation.ftl`
|
||||
|
||||
## `getCategoryPath(): Sequence<Node>`
|
||||
|
||||
Returns the path of the current category.
|
||||
|
||||
## `isRootPage(): boolean`
|
||||
|
||||
Determines if the current page is a root page (the current category has no parent).
|
||||
|
||||
## `getSelectedCategory(): Node`
|
||||
|
||||
Returns the current category.
|
||||
|
||||
## `getSelectedCategoryId(): String`
|
||||
|
||||
Returns the ID of the current category.
|
||||
|
||||
## `getCategoryTitle(category: Node): String`
|
||||
|
||||
Returns the title of the provided category.
|
||||
|
||||
## `getCategoryUrl(category: Node): String`
|
||||
|
||||
Returns the URL of the provided category.
|
||||
|
||||
## `getCategoryId(category: Node): String`
|
||||
|
||||
Returns the ID of the provided category.
|
||||
|
||||
## `isCategorySelected(category: Node): String`
|
||||
|
||||
Determines if the provided category is the current category.
|
||||
|
||||
## `getNavigationRootUrl(navigationId: String = "categoryMenu"): String`
|
||||
|
||||
Gets the URL for the root of the category system.
|
||||
|
||||
## `getNavigationTitle(navigationId: String = "categoryMenu"): String`
|
||||
|
||||
Gets the title of the category system.
|
||||
|
||||
## `getCategoryMenu(menuId: String = "categoryMenu"): String`
|
||||
|
||||
Returns the root categories of the category menu. If the current page
|
||||
has more than on category menu component or the name of the category
|
||||
menu component is not `categoryMenu` the optional `menuId` parameter can be used to select the category menu component to use.
|
||||
|
||||
## `getCategoryHierachy(hierachyId: String = "categoryNav"): String`
|
||||
|
||||
Returns the root categories of the category hierarchy. If the current
|
||||
page has more than on category menu component or the name of the
|
||||
category menu component is not `categoryNav` the optional
|
||||
`hierachyId` parameter can be used to select the category menu
|
||||
component to use.
|
||||
|
||||
## `getSubCategories(ofCategory: Node): Sequence<Node>`
|
||||
|
||||
Returns the sub categories of the provided category.
|
||||
|
||||
## `getSubCategoriesOfCategoryWithId(categoryId: String): Sequence<Node>`
|
||||
|
||||
Returns the sub categories of the ID with the provided ID. The
|
||||
category must be available in one of the category menu components of
|
||||
the page.
|
||||
|
||||
## `getGreetingItem(): Node`
|
||||
|
||||
Returns the greeting/index item of the current category. The functions
|
||||
for proceesing content items can be used to process the returned value
|
||||
further.
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,157 @@
|
|||
# Freemarker function for ObjectLists
|
||||
|
||||
Import Path
|
||||
: `/ccm-navigation/object-list.ftl`
|
||||
|
||||
Many functions provided by this library have a parameter `listId`.
|
||||
In most cases the value is `itemList`.
|
||||
|
||||
## `getItems(listId: String): Sequence<Node>`
|
||||
|
||||
Returns the items in the object list with the provided ID.
|
||||
|
||||
## `getObjectCount(listId: String): number`
|
||||
|
||||
Returns then number of objects in the object list with the provided ID.
|
||||
|
||||
## `getPagniatorBaseUrl(listId: String): String`
|
||||
|
||||
Gets the base URL of the list paginator.
|
||||
|
||||
## `getPaginatorBegin(listId: String): Number`
|
||||
|
||||
Returns the index of the first item displayed.
|
||||
|
||||
## `getPaginatorEnd(listId: String): Number`
|
||||
|
||||
Returns the index of the last item displayed.
|
||||
|
||||
## `getPageCount(listId: String): Number`
|
||||
|
||||
Gets the number of pages of the object list with the provided ID.
|
||||
|
||||
## `getPageNumber(listId: String): Number`
|
||||
|
||||
Gets the number of page displayed.
|
||||
|
||||
## `getPageParam(listId: String): String`
|
||||
|
||||
Gets the name of the page param for the object list with the provided
|
||||
ID.
|
||||
|
||||
## `getPageSize(listId: String): Number`
|
||||
|
||||
Gets the number of objects per page for the object list with the
|
||||
provided ID.
|
||||
|
||||
## `getPrevPageLink(listId: String): String`
|
||||
|
||||
Gets the link to the previous page of the object list with the
|
||||
provided ID.
|
||||
|
||||
## `getNextPageLink(listId: String): String`
|
||||
|
||||
Gets the link to the next page of the object list with the provided
|
||||
ID.
|
||||
|
||||
## `getFirstPageLink(listId: String): String`
|
||||
|
||||
Gets the link to the first page of the object list with the provided
|
||||
ID.
|
||||
|
||||
## `getLastPageLink(listId: String): String`
|
||||
|
||||
Gets the link to the last page of the object list with the provided
|
||||
ID.
|
||||
|
||||
## `getItemTitle(item: Node): String`
|
||||
|
||||
Gets the title of a list item.
|
||||
|
||||
## `getItemLead(item: Node): String`
|
||||
|
||||
Gets the lead text of a list item.
|
||||
|
||||
## `getItemProperty(item: Node, property: String): String`
|
||||
|
||||
A generic function the get the value of the property with the name
|
||||
provided the `property` parameter.
|
||||
|
||||
## `hasImage(item: Node): boolean`
|
||||
|
||||
Determines if the provided list item has an image attachment.
|
||||
|
||||
## `getImageId(item: Node): String`
|
||||
|
||||
Gets the ID of the image attachment of the provided list item.
|
||||
|
||||
## `getImageUrl(item: Node): String`
|
||||
|
||||
Gets the URL of the image attachment of the provided list item.
|
||||
|
||||
## `getImageCaption(item: Node): String`
|
||||
|
||||
Gets the caption of the image attachment of the provided list item.
|
||||
|
||||
## `getFilters(listId: String): Sequence<Node>`
|
||||
|
||||
Returns the filters for the current list.
|
||||
|
||||
## `getFilterLabel(filter: Node): String`
|
||||
|
||||
Gets the label of the provided filter.
|
||||
|
||||
## `getFilterType(filter: Node): String`
|
||||
|
||||
Gets the type of the provided filter.
|
||||
|
||||
## `getSelectFilterOptions(filter: Node): Sequence<Node>`
|
||||
|
||||
Returns the options of the select filter. If the provided filter
|
||||
is not a filter of the type _select_ an empty sequence is returned.
|
||||
|
||||
## `getSelectFilterOptionLabel(option: Node): String`
|
||||
|
||||
Returns the label of the provided filter.
|
||||
|
||||
## `getCategoryFilterSearchString(filter: Node): String`
|
||||
|
||||
Returns the search string for the provided category filter.
|
||||
|
||||
## `getCategoryFilterSeparator(filter: Node): String`
|
||||
|
||||
Gets the separation character for the value of the provided
|
||||
category filter.
|
||||
|
||||
## `getCategoryFilterMultiple(filter: Node): boolean`
|
||||
|
||||
Determines if the provided category allows multiple selections.
|
||||
|
||||
## `getCategoryFilterCategories(filter: Node): Sequence<Node>`
|
||||
|
||||
Returns the categories for the provided category filter.
|
||||
|
||||
## `getCategoryFilterCategoryGroups(filter: Node): Sequence<Node>`
|
||||
|
||||
Returns the category groups of the provided category filter.
|
||||
|
||||
## `getCategoryGroupLabel(group: Node): String`
|
||||
|
||||
Returns the label of the provided category group.
|
||||
|
||||
## `getCategoryFilterCategoryGroupsCategories(groups: Sequence<Node>): Sequence<Node>`
|
||||
|
||||
Gets the categories of all category groups.
|
||||
|
||||
## `getCategoryFilterCategoryId(category: Node): String`
|
||||
|
||||
Gets the ID of the provided category of a category filter.
|
||||
|
||||
## `getCategoryFilterCategoryLabel(category: Node): String`
|
||||
|
||||
Gets the label of the provided category of a category filter.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Loading…
Reference in New Issue