From 3e2047dce6adca960978df0cee5feb8708c4e6c2 Mon Sep 17 00:00:00 2001 From: jensp Date: Wed, 5 Jun 2019 18:03:59 +0000 Subject: [PATCH] Documentation of Freemarker functions for ccm-cms-assets-notes git-svn-id: https://svn.libreccm.org/ccm/trunk@6107 8810af33-2d31-482b-a856-94f89814c4df --- .../doc/freemarker/ccm-cms-assets-notes.md | 29 ++++--------------- 1 file changed, 6 insertions(+), 23 deletions(-) diff --git a/ccm-cms-assets-notes/doc/freemarker/ccm-cms-assets-notes.md b/ccm-cms-assets-notes/doc/freemarker/ccm-cms-assets-notes.md index 0a93e8dae..feb8fcfb0 100644 --- a/ccm-cms-assets-notes/doc/freemarker/ccm-cms-assets-notes.md +++ b/ccm-cms-assets-notes/doc/freemarker/ccm-cms-assets-notes.md @@ -1,31 +1,14 @@ -### ccm-cms-assets-notes +# Freemarker functions for Sidenote assets Functions for processing note assets assigned to a content item. -#### getNotes +Import path +: `/ccm-cms-assets-notes.ftl` - getNotes(item) +## `getNotes(item: Node): Sequence` Returns the notes assigned to a content item. -##### Parameters +## `getContent(item: Node): String -`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. \ No newline at end of file +Gets the content of a note. The return value is the HTML content of the node. \ No newline at end of file