RoxenCMS 5.4Web Developer ManualSite Keywords

   

<emit site-keywords>
<site-keywords-delete>
<site-keywords-insert>

<emit source="site-keywords"></emit>

Provided by module: CMS: Site Keywords

List references and keywords.

The number of returned entries are by default limited to 100. You can change this by setting the maxrows attribute.

<nocache> <emit source='values' split=',' scope='char' values='A,B,C,D,E,F,G,H,I,J,K,L,M,N,O,P,Q,R,S,T,U,V,W,X,Y,Z'> <set variable='var.has_keywords' value='no'/> <emit source='site-keywords' keyword='&char.value;*'> <set variable='var.has_keywords' value='yes'/> </emit> <if variable='var.has_keywords = yes'> <if variable='form.char = &char.value;'> <b>&_.value;</b> </if> <else> <a href='?char=&_.value;'>&_.value;</a> </else> </if> <else> &_.value; </else> </emit> <hr/> <if variable='form.char'> <emit source='site-keywords' keyword='&form.char;*'> &_.keyword; - <emit source='dir' file='&_.ref;'> <a href='&dir.path;'>&dir.title;</a></emit> <br/> </emit> </if> </nocache>

A note on efficiency: The case with a sort attribute that is either "*path" or "-*path", possibly combined with maxrows and/or skiprows, is handled efficiently by making an optimized query to the underlying SQL table.


Attributes

keyword="string"

Comma-separated list of keyword globs. Searches are case insensitive.


ref="string"

Comma-separated list of reference globs. A file reference is a path starting with a / (slash).


not-ref="string"

Comma-separated list of reference globs not to include. A file reference is a path starting with a / (slash).


invisible

Allows files, which are time based published and not currently visible, to be listed.


cloud

Generates a tag cloud where the font size for each keyword will represent the number of occurrences, i.e. a keyword that have many occurrences will have a bigger font then a keyword with fewer occurrences.

<nocache> <emit source='site-keywords' cloud='' max-size='2.2' min-size='0.8'> <span style='font-size:&_.fontsize;em'>&_.keyword; (&_.occurrences;)</span> <delimiter>, </delimiter> </emit> </nocache>

max-size="float"

Specifies the maximum font size for the tag cloud. Default 2.0.


min-size="float"

Specifies the minimum font size for the tag cloud. Default 0.8.


&_.fontsize; (provided by CMS: Site Keywords)

Only available if the cloud attribute has been specified.


&_.keyword; (provided by CMS: Site Keywords)

Keyword, sorted case insensitive.


&_.occurrences; (provided by CMS: Site Keywords)

The number of occurrences of the keyword. Only available if the cloud attribute has been specified.


&_.ref; (provided by CMS: Site Keywords)

Reference (typically a path).