RoxenCMS 5.4Web Developer ManualEmit Tags

   

<emit>
<emit ac-identities>
<emit ac-identity-data>
<emit ac-identity-extras>
<emit ac-permissions>
<emit ac-zones>
<emit atlas>
<emit authors>
<emit captcha>
<emit category>
<emit category-document>
<emit cimg>
<emit dir>
<emit dir>(SB)
<emit event>
<emit event-dates>
<emit event-locations>
<emit exec>
<emit fonts>
<emit imgs>
<emit js-dynamic-popup>
<emit js-hide-popup>
<emit languages>
<emit ldap>
<emit path>
<emit poll>
<emit sb-dir>
<emit sb-file-languages>
<emit sb-languages>
<emit sb-log>
<emit sb-referring-pages>
<emit sb-search>
<emit sb-stationeries>
<emit sb-wizard>
<emit search-database-profiles>
<emit scopes>
<emit site-news>
<emit sources>
<emit spellcheck>
<emit sql>
<emit timerange>
<emit values>
<emit workflow>
<emit ws-dir>
<emit xml-db>

<emit source="category"></emit>

Provided by module: CMS: Category

This emit plug-in can be used to display category trees with associated links.

If no attributes are given, category trees available in the current directory and all parent directories will be listed by the &_.file; entity.

List of all category trees (files of type CMS Category Tree) in this or any parent directory:
<ul> <nocache> <emit source='category'> <li>&_.file;</li> </emit> </nocache> </ul>

Complete category tree view:
<define tag='category-listing' scope='list'> <ul> <emit source='category' file='&list.file;' node='&_.node;' category=''> <li> &_.name; <category-listing file='&list.file;' node='&_.node;'/> </li> </emit> <emit source='category' file='&list.file;' node='&_.node;' related=''> <li> <i>Related:</i> <emit source='category' file='&list.file;' node='&_.node;' history=''> &_.name; <delimiter>&gt;</delimiter> </emit> </li> </emit> <emit source='category' file='&list.file;' node='&_.node;' document=''> <li> <i>Document:</i> <emit source='dir' file='&_.ref;' notitle='yes'> <a href='&dir.path;'> <if variable='dir.title is '>&dir.path;</if> <else>&dir.title;</else> </a> </emit> </li> </emit> </ul> </define> <ul> <nocache> <emit source='category'> <li> <p><b>&_.file;</b></p> <category-listing file='&_.file;' node='&_.node;'/> </li> </emit> </nocache> </ul>

Complete category file view:
<ul> <nocache> <emit source='category' ref='*'> <li> &_.ref;: <emit source='category' file='&_.file;' node='&_.node;' history=''> &_.name; <delimiter>&gt;</delimiter> </emit> (from &_.file;) </li> </emit> </nocache> </ul>

Display node name for a node:
<nocache> <emit source='category' file='/your-tree.xml' node='your-node-id'> <p>Node name for &_.node; is &_.name;.</p> </emit> </nocache>


Attributes

file="category tree file path"

Category tree file path.


ref="string"

Comma-separated list of reference (typically a path) globs.


not-ref="string"

Comma-separated list of reference (typically a path) globs not to include.


node="node id"

Lists categories, relations and/or files associated with a given category node or tree node. The empty value is the same as the tree root node.


invisible

Allows files which are time based published to be listed.


undelete

Allows deleted files to be listed. (Not implemented.)


history

Lists all super-category node id:s to a given node. Used together with the node attribute.


category

Provides all sub-category node id:s to a given node list. Used together with the node attribute.


category-transitive

Recursively provides all sub-category node id:s to a given node list. Used together with the node attribute.


related

Provides all related category node id:s to a given node list. Used together with the node attribute.


document

Provides all document paths to a given node list. Used together with the node attribute, and optionally with the ref and not-ref attributes.


&_.file; (provided by CMS: Category)

Category tree file path.


&_.name; (provided by CMS: Category)

Category name, or category tree name when trees are listed.


&_.node; (provided by CMS: Category)

Category node id.


&_.ref; (provided by CMS: Category)

Reference (typically a path).