Magnolia Templating for JSP – Tag reference report.

Tag reference sheet

Tag library reference for the following tag libraries:

Magnolia Templating CMS Tag Support (cmsUtilTaglib.tld) - uri:cmsUtilTaglib
Magnolia Templating Functions Tag Support (cmsfn.tld) - uri:http://magnolia-cms.com/taglib/templating-components/cmsfn
Magnolia Templating CMS Tag Support (cms.tld) - uri:http://magnolia-cms.com/taglib/templating-components/cms

Magnolia Templating CMS Tag Support - version 2.1

Expose migrated custom tags.

Namespace definition: xmlns:cmsUtilTaglib="cmsUtilTaglib"

Tags

breadcrumb Outputs "breadcrumbs" with links to parents of the current page
newlines Converts text in the body of the tag adding tags at new lines or wrapping lines in paragraphs
poweredBy A simple tag which can display the version and edition of the running Magnolia instance
scaleImage Creates a scaled copy of an image
searchResultSnippet Output a set of snippets taken from any paragraph in the given page mathing any of the search term
simpleNavigation Draws a simple, css based, navigation menu
txt2img Tag that converts text into PNG images, and outputs a div element containing a set of img elements

Required attributes are marked with a*

<cmsUtilTaglib:breadcrumb>

Outputs "breadcrumbs" with links to parents of the current page.

Can contain:empty

This tag has no attributes.

<cmsUtilTaglib:newlines>

Converts text in the body of the tag adding tags at new lines or wrapping lines in paragraphs.

Can contain:JSP

This tag has no attributes.

<cmsUtilTaglib:poweredBy>

A simple tag which can display the version and edition of the running Magnolia instance.

Can contain:empty

This tag has no attributes.

<cmsUtilTaglib:scaleImage>

Creates a scaled copy of an image. The maximum width and height of the images can be specified via the attributes. If the scaled image with the specified name does not exist in the repository, then this tag will create it and save it. If the scaled image already exists, then it will not be recreated. The name of the node that contains the original image is set by the attribute 'parentContentNode', and the name of the nodeData for the image is set by the attribute 'parentNodeDataName'. If 'parentContentNode' is null, the local content node is used. The name of the content node that contains the new scaled image is set by the attribute 'imageContentNodeName'. This node is created under the original image node. This ensures that, if the original images is deleted, so are all the scaled versions. This tag writes out the handle of the content node that contains the image.

Can contain:empty

This tag has no attributes.

<cmsUtilTaglib:searchResultSnippet>

Output a set of snippets taken from any paragraph in the given page mathing any of the search term.

Can contain:empty

This tag has no attributes.

<cmsUtilTaglib:simpleNavigation>

Draws a simple, css based, navigation menu. The menu layout can then be customized using css, and the default menu should be enough for most uses. Two following page properties will also be used in the menu: <ul> <li><code>navTitle</code>: a title to use for the navigation menu, if different from the real page title</li> <li><code>accessKey</code>: an optional access key which will be added to the link</li> <li><code>wrappingElement</code>: an optional html element (div, span, p, etc) to go within the <a> tag wrapping the anchor text</li> </ul>

Can contain:empty

This tag has no attributes.

<cmsUtilTaglib:txt2img>

Tag that converts text into PNG images, and outputs a div element containing a set of img elements. The font face, text color, text size and background color can be set via the tag attributes. The images are saved under the node specified by the attribute parentContentNodeName. Under this parent node, a new node is created, with the name specified by the attribute imageContentNodeName. Under this node, each image will have it own node. The names of the image node are based on the text that they contain. (Special characters such as &, /, chinese characters, etc. are replaces by codes to ensure that these names are legal.) If the images for the specified text do not exist in the repository under the specified parent node, then the this tag will create the images and save them. If the images for the text already exist, then they will not be recreated. The text to be converted into images can be split in three ways. If the attribute textSplit is null or is set to TEXT_SPLIT_NONE, then a single image will be created of the text on one line. If textSplit is set to TEXT_SPLIT_WORDS, then the text is plit into words (i.e. wherever there is a space). Finally, if textSplit is set to TEXT_SPLIT_CHARACTERS, then a seperate image is created for each letter. The tag outputs a div that contains one or more img's. The CSS class applied to the div is specified by the divCSS attribute. The CSS applied to the images depends on how the text was split. For text that was not split, the CSS applied is set to CSS_TEXT_IMAGE, for words it is CSS_WORD_IMAGE, and for characters it is CSS_CHARACTER_IMAGE. Any spacing that is required between images will need to be set in your css stylesheet. The textFontFace attribute may either be a font name of a font installed on the server, or it may be a path to a TTF file. The class to generate PNG images from TrueType font strings is originally by Philip McCarthy - http://chimpen.com (http://chimpen.com/things/archives/001139.php). I have made a couple of small changes.

Can contain:empty

This tag has no attributes.

Magnolia Templating Functions Tag Support - version 2.1

Templating functions (cmsfn) Tag Library exposes most of the utility methods defined in info.magnolia.templating.functions.TemplatingFunctions as JSP functions.

Namespace definition: xmlns:cmsfn="http://magnolia-cms.com/taglib/templating-components/cmsfn"

EL Functions

ancestors() * info
asContentMap() * javax
asContentMapList() * java
asJCRNode() * info
asNodeList() * java
children() * info
content() Return the Node for the Given Path from the given repository
contentByIdentifier() Return the Node for the given identifier from the given repository
createHtmlAttribute() Util method to create html attributes name="value"
decode() Removes escaping of HTML on properties
externalLink() Returns an external link prepended with http:// in case the protocol is missing or an empty String if the link does not exist
externalLinkTitle() Return a link title based on the @param linkTitlePropertyName
inherit() * info
inheritList() * info
inheritProperty() * info
isAuthorInstance()
isEditMode()
isFromCurrentPage() * info
isInherited() * info
isPreviewMode()
isPublicInstance()
language() Get the language used currently
link() * info
linkForProperty() FIXME Add a LinkUtil
linkForWorkspace() Create link for the Node identified by nodeIdentifier in the specified workspace
metaData() Returns the string representation of a property from the metaData of the node or null if the node has no Magnolia metaData or if no matching property is found
page() Returns the page's {@link ContentMap} of the passed {@link ContentMap}
parent() * info
root() * info
search() * java
siblings() Returns an instance of SiblingsHelper for the given contentMap
simpleSearch() * java

Required attributes are marked with a*