Live Events

Documentation of the Live Events plugin for WordPress

Table of Contents

  1. Video Tutorials
  2. Installation (Single Site)
  3. Installation (Multisite)
  4. Update (Single Site)
  5. Update (Multisite)
  6. Create an Event
  7. Create a Timeline Section
  8. Create a Timeline Item
  9. Create a Timeline Item with an image
  10. Create a Timeline Item with a tweet
  11. Create a Timeline Item with custom HTML
  12. Create and use Timeline Icons
  13. Create a Stat Section
  14. Create a Stat Group
  15. Create a “Single Data” Stat Item
  16. Create a “Single Visual” Stat Item
  17. Create a “Comparison Data” Stat Item
  18. Create a “Comparison Visual” Stat Item
  19. Create a Comment Section
  20. Create a Comment Item
  21. Publish an Event
  22. Update a Timeline Section
  23. Update a Stat Section
  24. Update a Comment Section
  25. Credits
  26. FAQ

1) Video Tutorials

This video series covers the functionalities of the Live Events plugin.

2) Installation (Single Site)

With this procedure, you will be able to install the Live Events plugin on your WordPress website.

  1. Visit the Plugins -> Add New menu.
  2. Click on the Upload Plugin button and select the zip file you just downloaded.
  3. Click on Install Now.
  4. Click on Activate Plugin.

3) Installation (Multisite)

This plugin supports both a Network Activation (the plugin will be activated on all the sites of your WordPress Network) and a Single Site Activation in a WordPress Network environment (the plugin will be activated on a single site of the network). With this procedure, you will be able to perform a Network Activation:

  1. Visit the Plugins -> Add New menu.
  2. Click on the Upload Plugin button and select the zip file you just downloaded.
  3. Click on Install Now.
  4. Click on Network Activate.

With this procedure, you will be able to perform a Single Site Activation in a WordPress Network environment:

  1. Visit the specific site of the WordPress Network where you want to install the plugin.
  2. Visit the Plugins menu.
  3. Click on the Activate button.

4) Update (Single Site)

With this procedure, you will be able to update the Live Events plugin:

  1. Visit the Plugins menu.
  2. Click on Deactivate.
  3. Update the plugin files with your favorite FTP client. (delete the files of the old version and add the files of the new version)
  4. Click on Activate.

5) Update (Multisite)

To update the plugin in all the sites of your WordPress Network, follow this procedure:

  1. Visit the Plugins menu.
  2. Click on Network Deactivate.
  3. Update the plugin files with your favorite FTP client. (delete the files of the old version and add the files of the new version)
  4. Click on Network Activate.

To update the plugin on single sites of the WordPress Network, follow this procedure:

  1. Visit the specific site of the WordPress Network where you want to update the plugin.
  2. Visit the Plugins menu.
  3. Click on Deactivate.
  4. Update the plugin files with your favorite FTP client. (skip this step if you have already updated the plugin files during the plugin update of another single site of the WordPress Network)
  5. Click on Activate

6) Create an Event

To create an Event, follow this procedure:

  1. Visit the Live Events -> Events menu.
  2. Enter the Name of the Event.
  3. Enter the Description of the Event.
  4. With the Live option, select “Yes” if you want to automatically update the data of the Event, or “No” if you want to generate a static event.
  5. Click the Add Event button.

7) Create a Timeline Section

To create a Timeline Section, follow this procedure:

  1. Visit the Live Events -> Timeline Sections menu.
  2. Select the Event that includes the Timeline Section.
  3. Enter the Name of the Timeline Section.
  4. Enter the Description of the Timeline Section.
  5. Enter the Label of the Timeline Section.
  6. With the Show Icon option, select if you want to display icons associated with the Timeline Items.
  7. With the Time Mode option, select if you want to manually enter or automatically generate the time of the Timeline Items.
  8. With the Index option, you can determine the position of this Timeline Section in the tabs of the Event.
  9. Click the Add Timeline Section button.

8) Create a Timeline Item

To create a Timeline Item, follow this procedure:

  1. Visit the Live Events -> Timeline Items menu.
  2. Select the Timeline Section that includes the Timeline Item.
  3. With the Extra option, select None.
  4. Enter a Time for the Timeline Item.
  5. Enter a Title for the Timeline Item.
  6. Enter the Content of the Timeline Item.
  7. Click the Add Timeline Item button.

9) Create a Timeline Item with an image

To create a Timeline Item with an Image, follow this procedure:

  1. Visit the Live Events -> Timeline Items menu.
  2. Select the Timeline Section that includes the Timeline Item.
  3. With the Extra option, select Image.
  4. Enter a Time for the Timeline Item.
  5. Enter a Title for the Timeline Item.
  6. Enter the Content of the Timeline Item.
  7. Select an Image.
  8. Click the Add Timeline Item button.

10) Create a Timeline Item with a tweet

To create a Timeline Item with a tweet, follow this procedure:

  1. Visit the Live Events -> Timeline Items menu.
  2. Select the Timeline Section that includes the Timeline Item.
  3. With the Extra options, select Tweet.
  4. Enter a Time for the Timeline Item.
  5. Enter a Title for the Timeline Item.
  6. Enter the Content of the Timeline Item.
  7. In the Tweet field, enter the tweet ID, the tweet URL, or the tweet embed code.
  8. Click the Add Timeline Item button.

11) Create a Timeline Item with custom HTML

To create a Timeline Item with custom HTML, follow this procedure:

  1. Visit the Live Events -> Timeline Items menu.
  2. Select the Timeline Section that includes the Timeline Item.
  3. With the Extra option, select HTML.
  4. Enter a Time for the Timeline Item.
  5. Enter a Title for the Timeline Item.
  6. Enter the Content of the Timeline Item.
  7. In the HTML field, enter your custom HTML. (this field can be used to include elements such as YouTube videos, Instagram posts, advertising, iframes, and more)
  8. Click the Add Timeline Item button.

12) Create and use Timeline Icons

To create and use Timeline Icons, follow this procedure:

  1. Visit the Live Events -> Timeline Icons menu.
  2. Enter the Name of the Timeline Icon.
  3. Enter the Description of the Timeline Icon.
  4. Select an Image.
  5. Click the Add Timeline Icon button.
  6. Visit the Live Events -> Timeline Sections menu and enable the use of Timeline Icons associated with Timeline Items with the Show Icon option.
  7. In the Live Events -> Timeline Items menu with the Icon option, you can now associate Timeline Icons with Timeline Items.

13) Create a Stat Section

To create a Stat Section, follow this procedure:

  1. Visit the Live Events -> Stat Sections menu.
  2. Select the Event that includes the Stat Section.
  3. Enter the Name of the Stat Section.
  4. Enter the Description of the Stat Section.
  5. Enter the Label of the Stat Section.
  6. With the Index option, you can determine the position of this Stat Section in the tabs of the Event.
  7. Click the Add Stat Section button.

14) Create a Stat Group

To create a Stat Group, follow this procedure:

  1. Visit the Live Events -> Stat Groups menu.
  2. Select the Stat Section that includes the Stat Group.
  3. Enter the Name of the Stat Group.
  4. Enter the Description of the Stat Group.
  5. Enter the Label of the Stat Group.
  6. With the Index option, you can determine the position of this Stat Group in the Stat Section.
  7. Click the Add Stat Group button.

15) Create a “Single Data” Stat Item

To create a “Single Data” Stat Item, follow this procedure:

  1. Visit the Live Events -> Stat Items menu.
  2. Select the Stat Group that includes the Stat Item.
  3. With the Type option, select Single Data.
  4. Enter the Subject of the Stat Item.
  5. Enter the Value 1 of the Stat Item.
  6. With the Percentage option, select if the percentage symbol should be displayed.
  7. With the Index option, you can determine the position of this Stat Item in the Stat Group.
  8. Click the Add Stat Item button.

16) Create a “Single Visual” Stat Item

To create a “Single Visual” Stat Item, follow this procedure:

  1. Visit the Live Events -> Stat Items menu.
  2. Select the Stat Group that includes the Stat Item.
  3. With the Type option, select Single Visual.
  4. Enter the Subject of the Stat Item.
  5. Enter the Value 1 of the Stat Item.
  6. With the Percentage option, select if the percentage symbol should be displayed
  7. With the Index option, you can determine the position of this Stat Item in the Stat Group.
  8. Click the Add Stat Item button.

17) Create a “Comparison Data” Stat Item

To create a “Comparison Data” Stat Item, follow this procedure:

  1. Visit the Live Events -> Stat Items menu.
  2. Select the Stat Group that includes the Stat Item.
  3. With the Type option, select Comparison Data.
  4. Enter the Subject of the Stat Item.
  5. Enter the Value 1 of the Stat Item.
  6. Enter the Value 2 of the Stat Item.
  7. With the Percentage option, select if the percentage symbol should be displayed
  8. With the Index option, you can determine the position of this Stat Item in the Stat Group.
  9. Click the Add Stat Item button.

18) Create a “Comparison Visual” Stat Item

To create a “Comparison Visual” Stat Item, follow this procedure:

  1. Visit the Live Events -> Stat Items menu.
  2. Select the Stat Group that includes the Stat Item.
  3. With the Type option, select Comparison Visual.
  4. Enter the Subject of the Stat Item.
  5. Enter the Value 1 of the Stat Item.
  6. Enter the Value 2 of the Stat Item.
  7. With the Percentage option, select if the percentage symbol should be displayed
  8. With the Index option, you can determine the position of this Stat Item in the Stat Group.
  9. Click the Add Stat Item button.

19) Create a Comment Section

To create a Comment Section, follow this procedure:

  1. Visit the Live Events -> Comment Sections menu.
  2. Select the Event that includes the Comment Section.
  3. Enter the Name of the Comment Section.
  4. Enter the Description of the Comment Section.
  5. Enter the Label of the Comment Section.
  6. With Closed, select whether to suppress or not the ability to add new comments.
  7. With Avatar, select whether to display or not the avatar of the user.
  8. With the Index option, you can determine the position of this Comment Section in the tabs of the Event.
  9. Click the Add Comment Section button.

20) Create a Comment Item

To create a Comment Item, follow this procedure:

  1. Visit the Live Events -> Comment Items menu.
  2. Select the Author of the Comment Item.
  3. Enter the Content of the Comment Item.
  4. With Approved, select the moderation status of the Comment Item.
  5. Click the Add Comment Item button.

21) Publish an Event

Please follow this procedure to include an Event in a post with a block:

  1. Edit a post, page, or custom post type.
  2. Select the Visual Editor mode.
  3. Add the Event block.
  4. Search or select an Event with the provided select box.

Please follow this procedure to include an Event in a post with the TinyMCE editor:

  1. Edit a post, page, or custom post type.
  2. Set the editor in Visual mode.
  3. Click the Live Events button.
  4. Search or select an Event with the provided select box.
  5. Click the Add Event button.

22) Update a Timeline Section

To update a Timeline Section, follow this procedure:

  1. Visit the Live Events -> Events menu.
  2. Verify that the Live option of the specific Event is set to “Yes”.
  3. Visit the Live Events -> Timeline Items menu.
  4. Create new Timeline Items.

23) Update a Stat Section

To update a Stat Section, follow this procedure:

  1. Visit the Live Events -> Events menu.
  2. Verify that the Live option of the specific Event is set to “Yes”.
  3. Visit the Live Events -> Stat Items menu.
  4. Update existing Stat Items.

24) Update a Comment Section

To update a Comment Section, follow this procedure:

  1. Visit the Live Events -> Events menu.
  2. Verify that the Live option of the specific Event is set to “Yes”.
  3. Visit the Live Events -> Comment Items menu.
  4. Create or update Comment Items.

25) Credits

This plugin makes use of the following resources:

26) FAQ

Which actions can be performed in a live event?

In a live event (an event where the Live Events -> Events -> Live option is set to “Yes”), you will be able to perform the following actions:

  • Create, update and delete timeline items.
  • Update stat items.
  • Create, update and delete comment items.

The following actions will not be allowed:

  • Create, update and delete timeline sections.
  • Create, update and delete stat sections.
  • Create, update and delete stat groups.
  • Create and delete stat items.
  • Create, update and delete comment sections.

How to decrease the server load caused by the AJAX requests used to update live an event?

The following two options allow you to decrease the server load caused by the AJAX requests used to update live an Event.

Update Time

This option determines the time interval expressed in seconds between the AJAX requests sent to the server to retrieve the live event data.

Please note that a short time interval generates a high number of HTTP requests. This behavior might not be suitable for a website hosted on a shared server or for a website with high traffic.

Transient Expiration

When a transient is available, the responses to the AJAX requests sent to your server will not be generated with queries on your database but retrieved directly from the transient associated with the specific Event.

Set a high value to improve the live event performance and to avoid an excessive load on the server. Set a low value to have frequent updates of the live event data. Set “0” to not use a transient.

For more information about the transients, please visit the Transients API page.

How to use the index field available in the Timeline Sections, Stat Sections, and Comment Sections?

The index field available in the Timeline SectionsStat Sections, and Comment Sections should be used to manually order from left to right the tabs available in an event.

If all the sections have the same index, the Timeline Sections have priority over the Stat Sections, and the Stat Sections have priority over the Comment Sections.

If multiple sections of the same type (for example, multiple Timeline Sections) have the same index, the order will be established based on the order in which the Timeline SectionsStat Sections or Comment Sections have been created.

How to use the index field available in the Stat Groups and Stat Items?

The index field available in the Stat Groups and Stat Items should be used to manually order how these elements are displayed in the layout of a Stat Section from top to bottom.

If multiple Stat Groups or Stat Items have the same index, the order will be established based on the order in which the Stat Groups or Stat Items have been created.

How to hide the social section of the Event?

To hide the social section of the Event, set to “Disabled” the following options available in the Live Events -> Options -> Social tab:

  • Facebook
  • Twitter
  • Google Plus
  • Pinterest
  • Linkedin
  • Tumblr
  • Email

Which versions of PHP are supported?

PHP 5.3 and later versions are supported.

Which versions of WordPress are supported?

WordPress 4.5 and later versions are supported.