eyepin Documentation

Last Update: 2023-11-16

Files

With an event template, two distinct pages can be designed. The first page contains the subscription form with all dates, the detail page contains more information about a single event date.

`event_index.php`	Main page with subscription form
`event_detail.php`	Detail page for individual info to event dates

Event Tags

Usable in both event_index.php and event_detail.php.

`<!--EVENT_TITLE//-->`	Will be replaced with the title of the event or of an event date.
`<!--EVENT_OPENER//-->`	Will be replaces with the teaser text of the event.
`<!--EVENT_PICTURE//-->`	Will be replaced with the URL for the event image.
`<!--CUSTOM:num//-->`	Up to 10 custom fields can be defined (event custom fields are setup in event_config.xml).

Event Index

The main page of an event is contained by event_index.php. It shows the form created at the event's website and handles the subscription.

Tags usable in `event_index.php`

`<!--FEEDBACK//-->`	Will be replaced with success and error messages, when applicable.
`<!--EVENT_FORM_BEGIN//-->`	Defines begin and end of the HTML-Code for the registration form. Everything between these tags will not be shown, after successful registration.
`<!--EVENT_FORM_END//-->`
`<!--EVENT_FORM//-->`	Will be replaced with the registration form of the event.
`<!--EVENT_BUTTON_SUBSCRIBE//-->`	Will be replaced with the submit button.
`<!--EVENT_BUTTON_CANCEL//-->`	Will be replaced with the cancel button.
`<!--EVENT_LINK_SUBSCRIBE_OTHER//-->`	Will be replaced with an anchor link to empty subscrition form.
`<!--EVENT_LINK_SUBSCRIBE_OTHER_URL//-->`	Will be replaced with URL to empty subscrition form.

Example `event_index.php`

<div class="container">

  <!--IF:EVENT_PICTURE//-->
  <img src="<!--EVENT_PICTURE//-->" width="100%" border="0">
  <!--ENDIF:EVENT_PICTURE//-->

  <!--IF:EVENT_TITLE//-->
    <h1 class="title ep-event-title"><!--EVENT_TITLE//--></h1>
  <!--ENDIF:EVENT_TITLE//-->

  <!--IF:EVENT_OPENER//-->
    <p class="text ep-event-opener"><!--EVENT_OPENER//--></p>
  <!--ENDIF:EVENT_OPENER//-->


  <!--IF:FEEDBACK//-->
    <br>
    <p class="feedback"><!--FEEDBACK//--></p>
  <!--ENDIF:FEEDBACK//-->

  <!--EVENT_FORM_BEGIN//-->
    <div class="ep-form-container">
      <!--EVENT_FORM//-->
      <div class="mod_form_buttons">
        <!--EVENT_BUTTON//-->
      </div>
    </div>
  <!--EVENT_FORM_END//-->

</div>

Event Detail

If an event has multiple dates, event_detail.php is used as landing page of a single event date. If a description is set to an event, the link "Details" will appear, linking to the landing page of the event date.

Tags usable in `event_detail.php`

`<!--EVENTITEM_DESCRIPTION//-->`	Will be replaced with the description of the event.
`<!--EVENTITEM_DATE//-->`	Will be replaced with the START-date of the event.
`<!--EVENTITEM_DATETILL//-->`	Will be replaced with the END-Date of the event.
`<!--EVENTITEM_TIME//-->`	Will be replaced with the START-time of the event.
`<!--EVENTITEM_TIMETILL//-->`	Will be replaced with the END-time of the event.
`<!--EVENTITEM_LOCATION//-->`	Will be replaced with the location of the event.
`<!--EVENTITEM_STATUS//-->`	Will be replaced with the state of the user (registered, canceled, etc.).

Example `event_detail.php`

<div class="container">

  <!--IF:EVENT_TITLE//-->
    <h1 class="title ep-event-title"><!--EVENT_TITLE//--></h1>
  <!--ENDIF:EVENT_TITLE//-->

    <p class="text ep-event-info">
      <!--IF:EVENTITEM_DATE//-->
      <span class="ep-info-date">
        <!--EVENTITEM_DATE//-->
        <!--IF:EVENTITEM_DATETILL//--> - <!--EVENTITEM_DATETILL//--> <!--ENDIF:EVENTITEM_DATETILL//-->
      </span><br>
      <!--ENDIF:EVENTITEM_DATE//-->

      <!--IF:EVENTITEM_TIME//-->
      <span class="ep-info-time">
        <!--EVENTITEM_TIME//-->
        <!--IF:EVENTITEM_TIMETILL//--> - <!--EVENTITEM_TIMETILL//--> <!--ENDIF:EVENTITEM_TIMETILL//-->
      </span><br>
      <!--ENDIF:EVENTITEM_TIME//-->

      <!--IF:EVENTITEM_LOCATION//-->
      <span class="ep-info-location"><!--EVENTITEM_LOCATION//--></span><br>
      <!--ENDIF:EVENTITEM_LOCATION//-->

      <!--IF:EVENTITEM_LOCATION//-->
      <span class="ep-success ep-info-status">Event status: <!--EVENTITEM_LOCATION//--></span><br>
      <!--ENDIF:EVENTITEM_LOCATION//-->
    </p>

  <!--IF:EVENTITEM_DESCRIPTION//-->
    <p class="text ep-event-opener"><!--EVENTITEM_DESCRIPTION//--></p>
  <!--ENDIF:EVENTITEM_DESCRIPTION//-->

</div>

Event Config XML

Event custom fields and snipplets are defined in event_config.xml.

Info: You can use customfield and snipplet options from config XML

Event CSS Classes

The following classes can be used to style generated form elements in event subscription form.

CSS Class	used for
Layout:
.form_item_template_1	wrapper table of a vertical element
.form_item_template_3	wrapper table of a horizontal element
.title	container of headline and title of fields
.text	container of text and fields
.col	column of table

Form elements:
.feld	form all input fields
.mod_formitem_field	single line text input (not address data field)
.mod_formitem_textarea	multi line text input
.mod_formitem_select	dropdown input
.mod_formitem_textarea	multi line text input
.mod_formitem_option	container of radio/checkbox
.ep-radio-container	container of radio input
.ep-checkbox-container	container of checkbox input
.ep-checkbox-single	container of single checkbox input
.mod_form_button	form button
.mod_formitem_title	title of input fields
.mod_formitem_description	desctiption text for fields
.mod_formitem_text	text elements
.ep-file-upload	file input field
.ep-label	label of radio/checkbox
.ep-conditions	container of conditions checkbox
.gallery	container of gallery
.readonly	disabled input

Event dates:
.ep-event-item-list	container of event date(s)
.ep-container	container of all event date information
.ep-container-input	container of event date checkbox
.ep-event-item-list-title	container of event date title
.ep-event-item-list-infos	container of event date, time and location
.ep-eventitem-action	container of event date actions and status
.ep-container-hasescort	container of event date escort options
.ep-event-item-list-actions	container of event date detail link
.ep-container-ics	container of event date calender file link

Advanced controlls

Most tags above can be combined with IF/IFNOT controlls. If you need more options to manipulate the template according to specific states, you can use the following tags:

`<!--IF:EVENT_TYPESUBSCRIBEOTHER_DEACTIVATED//-->`	Check for settings `Subscribe Other`
`<!--IF:EVENT_TYPESUBSCRIBEOTHER_REGISTRATION//-->`	Check if current subscription form is via `Subscribe Other`
`<!--IF:EVENT_MULTIPLEDATES//-->`	Check if event hast multiple dates
`<!--IF:EVENT_STATUS_SUBSCRIBED//-->`	Check if person has subscribed
`<!--IF:EVENT_STATUS_SUBSCRIBED_WAITINGLIST//-->`	Check if person is on waitinglist
`<!--IF:EVENT_STATUS_CANCEL//-->`	Check if person has canceled

Confirmation Mail

For events with multiple dates only applicable in confirmation mail for all dates

If non of the following placeholders is used, a default block with all subscribed dates is rendered at the end of .

`<!--EVENT_SUBSCRIBER_INFO_CONFIRMED//-->`	Renders a block with all dates where the user is subscribed
`<!--EVENT_SUBSCRIBER_INFO_WAITINGLIST//-->`	Renders a block with all dates where the user on the waitinglist
`<!--EVENT_SUBSCRIBER_INFO_REFUSED//-->`	Renders a block with all dates where the user has refused
`<!--EVENTITEM_BEGIN//-->` `<!--EVENTITEM_END//-->`	To render a customomized block of all dates where the user has any status. See all available placeholders that can be used between begin and end in the table below.
	aaa

Placeholders for use in between  and 

`<!--EVENTITEM_TITLE//-->`	Title of date
`<!--EVENTITEM_LOCATION//-->`	Location o date
`<!--EVENTITEM_DATETIME_FROMTILL_FORMATTED//-->`	From-Till date and time formated
`<!--EVENTITEM_DATETIME//-->`	From-Till date and time `(YYYY-mm-dd HH:ii:ss)`
`<!--EVENTITEM_DATETIME_FORMATTED //-->`	From date and time formatted
`<!--EVENTITEM_DATE//-->`	From date `(YYYY-mm-dd)`
`<!--EVENTITEM_DATE_FORMATTED//-->`	From date formatted
`<!--EVENTITEM_TIME//-->`	From time `(HH:ii)`
`<!--EVENTITEM_DATETIME_TILL//-->`	Till date and time `(YYYY-mm-dd HH:ii:ss)`
`<!--EVENTITEM_DATETIME_TILL_FORMATTED//-->`	Till date and time
`<!--EVENTITEM_DATE_TILL//-->`	Till date `(YYYY-mm-dd)`
`<!--EVENTITEM_DATE_TILL_FORMATTED//-->`	Till date formatted
`<!--EVENTITEM_TIME_TILL//-->`	Till time `(HH:ii)`
`<!--EVENTITEM_SUBSCRIBER_STATUS//-->`	Status `0 .. notrepsonded 1 .. confirmed 2 .. waitinglist 3 .. refused 4 .. participated 5 .. accreditation`
`<!--IF:EVENTITEM_SUBSCRIBER_NOTRESPONDED//-->`	Has user not responded yet
`<!--IF:EVENTITEM_SUBSCRIBER_CONFIRMED//-->`	Has user a confirmed subscription
`<!--IF:EVENTITEM_SUBSCRIBER_WAITINGLIST//-->`	Is user on the waitinglist
`<!--IF:EVENTITEM_SUBSCRIBER_REFUSED//-->`	Has user refused the subscription
`<!--IF:EVENTITEM_SUBSCRIBER_PARTICIPATED//-->`	Has user already participated
`<!--IF:EVENTITEM_SUBSCRIBER_ACCREDITATION//-->`	Has user status "Accreditation"
`<!--IF:EVENTITEM_SUBSCRIBER_HASESCORT//-->`	Has user an escort person
`<!--EVENTITEM_SUBSCRIBER_NUMESCORT//-->`	Number of escort persons
`<!--EVENTITEM_SUBSCRIBER_ESCORTNAME//-->`	Name of escort person

Für Rückfragen stehen wir Ihnen jederzeit gerne unter support@eyepin.com zur Verfügung.