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="event"></emit>

Provided by module: CMS Event: Event tags

Emit that displays events that has event dates that are within the specified date period.

If the event has several event dates, it is enough that one of the event dates are within the specified date period

If no arguments are given to the emit, the current month's events will be displayed.

category, not-category, cancelled, only-cancelled and path arguments are also available when using the <emit source="timerange" plugin="event">. The date period that is wanted is handled by the arguments to the <emit#timerange>. All entities listed here are also available in <emit#timerange>'s scope.


Attributes

from-iso-time="YYYY-MM-DDThh:mm:ss"

YYYY-MM-DDThh:mm:ss where only YYYY-MM-DD part of the date is mandatory

This argument expects to-iso-time argument.


to-iso-time="YYYY-MM-DDThh:mm:ss"

YYYY-MM-DDThh:mm:ss where only YYYY-MM-DD part of the date is mandatory

This argument expects from-iso-time argument.


week="YYYY-WW"

If this argument is empty, current week's events will be listed. Otherwise displays the events in the week supplied, i.e. first week of 2004 would be: 2004-01


month="YYYY-MM"

If this argument is empty, current month's events will be listed. Otherwise displays the events in the month supplied, i.e. December 2004 would be: 2004-12


week="YYYY-WW"

If this argument is empty, current week's events will be listed. Otherwise displays the events in the week supplied, i.e. first week of 2004 would be: 2004-01


path="path-1,path-2,*path-3*"

This attribute filter the result on files matching the path or paths values. Can contain global patterns, such as */event/*,*-event/*/*. The first matches e.g. /department-1/event/meetings/2004-08-12/index.xml and the second matches e.g. /department-2/calendar-event/2004-12-12/index.xml but not /department-2/calendar-event/index.xml


not-path="path-1,path-2,*path-3*"

The resulting events should not be from this or these paths. The same type of values as path


category="{category-1,category-2,category-tree-filepath*, none}"

The resulting events should belong to this or these categories. If /path-to-category-tree/file.xml* is supplied you will get all events belonging to that catogory tree. Otherwise the global expression is no use. The none keyword is used for events that does not have a category belonging.

Note!

The category is only used as a filter. It cannot be retrieved in the resulting rows. This is because the category belongings is attached to the file. So you'd have to use the <emit#category> to extract that data.

cancelled

Will also list events that are cancelled within the date period.


only-cancelled

List only cancelled events within the date period.


language="lang"

This controls which language you want the calendar dates in and it affects entities such as &_.date-range.1.month-name;.


&_.cancelled; (provided by CMS Event: Event tags)

If the event is cancelled this variable exists. Usefull to test if the event is cancelled when the cancelled argument is used to the emit.


&_.date-range; (provided by CMS Event: Event tags)

Cannot be used directly since it is an array of date ranges and will be retrieved through its index, starting at 1. This is a special type of entity, and fairly different from any other entities in Roxen.


&_.date-range-items; (provided by CMS Event: Event tags)

Number of date ranges the &_.date-range; has.
<emit source="event"> &_.title; event happens on &_.date-range-items; occations in the period &_.date-range.1.from-date; - <insert variable="_.date-range.&_.date-range-items;.to-date"/> <br /> </emit>


&_.date-range.n.from-date; (provided by CMS Event: Event tags)

E.g. '2010-02-13'.


&_.date-range.n.from-day; (provided by CMS Event: Event tags)

Day in month, e.g. '23'.


&_.date-range.n.from-hour; (provided by CMS Event: Event tags)

E.g. '14' - 24 hour clock.


&_.date-range.n.from-minute; (provided by CMS Event: Event tags)

E.g. '46'.


&_.date-range.n.from-month-name; (provided by CMS Event: Event tags)

E.g. 'January'.


&_.date-range.n.from-month-short-name; (provided by CMS Event: Event tags)

E.g. 'Jan'.


&_.date-range.n.from-second; (provided by CMS Event: Event tags)

E.g. '46'. The event component's interface only shows hours and minutes though support for seconds exists.


&_.date-range.n.from-time; (provided by CMS Event: Event tags)

E.g. '14:14' - 24 hour clock.


&_.date-range.n.from-unix-time; (provided by CMS Event: Event tags)

Seconds since 1970-01-01 00:00. E.g. '1268902972'.


&_.date-range.n.from-week; (provided by CMS Event: Event tags)

E.g. '3'.


&_.date-range.n.from-week-day; (provided by CMS Event: Event tags)

E.g. '1' Calendar dependent (Sunday is 1 in the Gregorian calendar), Monday is 1 in the ISO calendar type.


&_.date-range.n.from-week-day-name; (provided by CMS Event: Event tags)

E.g. 'Monday'.


&_.date-range.n.from-week-day-short-name; (provided by CMS Event: Event tags)

E.g. 'Mon'.


&_.date-range.n.from-year; (provided by CMS Event: Event tags)

E.g. '2010'.


&_.date-range.n.from-ymd; (provided by CMS Event: Event tags)

E.g. '2010-02-13'.


&_.date-range.n.from-ymd-short; (provided by CMS Event: Event tags)

E.g. '20100213'.


&_.date-range.n.from_*; (provided by CMS Event: Event tags)

Provides backward compatibility with older modules and works the the same as &_.date-range.n.from-*; above.


&_.date-range.n.to-*; (provided by CMS Event: Event tags)

Same entities as &_.date-range.n.from-*; above.


&_.date-range.n.to_*; (provided by CMS Event: Event tags)

Provides backward compatibility with older modules and works the the same as &_.date-range.n.to-*; above.


&_.event-id; (provided by CMS Event: Event tags)

The component id of the event.


&_.id; (provided by CMS Event: Event tags)

An integer representing the event's internal id in the database. You may use it, knowing it will be removed when the event XML document is deleted, purged or moved. Recommended is that you uses the &_.event-id; together with &_.path;.


&_.in-short; (provided by CMS Event: Event tags)

The metadata description of the page.


&_.location-id; (provided by CMS Event: Event tags)

The location id the event is tied to, use the <emit#event-location> to retrieve the location information.


&_.path; (provided by CMS Event: Event tags)

The path to the event's XML document.


&_.title; (provided by CMS Event: Event tags)

The metadata title of the page.


&_.visible-from; (provided by CMS Event: Event tags)

Its visibility, date and time (YYYY-MM-DDThh:mm) value.