====== Schedule ======

===== Description =====

Versatile and flexible plug-in designed primarily for TV/Radio program schedule, but it can be used to schedule anything you want - events, cinema projections or sport matches on a sport season schedule. You can make nodes (articles) appear (and recur) on the schedule on a particular date and be automatically removed from the schedule on another date. In other words, you can set a TV show that will start on next Wednesday at 7PM and will broadcast once a week at the same time. Each episode lasts 90 minutes and the show will stop showing in 7 months. This all can be set at once and the show will be on the TV schedule on Wednesday at 7PM until it stops showing on TV.

===== How to Install? =====

You need to access the Plug-ins section. Click on the Plug-ins link which is located in Main menu at the top of your administrator panel.

{{:user_manual:plugin-manual:admin_menu.jpg|Admin menu}}

A list of all plug-ins currently registered to the system is displayed on the right hand side of the screen on **Downloaded plug-ins** tab. 

To install Schedule plug-in you need to click on the install icon on the right side of the plug-ins name.

{{:user_manual:plugin_manual:schedule_install.jpg|Schedule install}}

This will take you to the page with the installation link: Click here to Install the plug-in

{{:user_manual:plugin_manual:schedule_install_step_1.jpg|Schedule install step 1}}

After you run the installation, you will be informed that the plug-in was successfully installed.

You may easily go back to the Plug-ins page, by following the link: Click here to go to Plug-in

{{:user_manual:plugin_manual:schedule_install_step_2.jpg|Schedule install step 2}}

===== How to Uninstall? =====

To uninstall Schedule plug-in you need to click on the uninstall icon on the right side of the plug-in name.

{{:user_manual:plugin_manual:schedule_uninstall.jpg|Schedule uninstall}}

This will take you to the page with the link for uninstall: Click here to uninstall the plug-in

{{:user_manual:plugin_manual:schedule_uninstall_step_1.jpg|Schedule uninstall step 1}}

You will be informed that the plug-in was successfully uninstalled and you may return to the Plug-ins page by clicking the link: Click here to return to Plug-in home page.

{{:user_manual:plugin_manual:schedule_uninstall_step_2.jpg|Schedule uninstall step 2}}

===== Access =====

The path to the Scheduler plug-in:

Click on the **Plug-ins** link (which is located in Main menu at the top of your administrator panel).

Choose **Scheduler** plug-in from the list of all installed plug-ins (on the left side of the screen).

===== User level =====

This plug-in can be accessed only by users belonging to groups that are allowed to manage Scheduler plug-in. 

===== Actions =====

==== Plug-in preferences ====

{{:user_manual:plugin-manual:schedule_preferences.png|Schedule preferences}}


  * **Schedule URL** -> Schedule is by default accessible via %%http://www.example.com/schedule%% however you can rename this URL on Preferences tab and place something like TV-program, radio-schedule etc. 

  * **Schedule Template** -> Choose a layout for the schedule from the drop-down list. 

<note tip>Create custom schedule template and upload it to **VIVVO_TEMPLATE_DIR/schedule/** folder</note>

  * **User groups with access to Schedule article tab** -> By default only users with admin privileges can access Schedule tab. Optionally choose additional usergroups that will be able to manage the schedule.

==== Set topics and tags ====

Use tags/topics for grouping items that has something in common (like channel or rating) so you can, for example, see a program for any particular channel or list only horror movies or even make a selection of all documentary movies with HD quality on a program this weekend. 

For better understanding a couple of topics/tags are predefined and come with the plug-in installation.

{{:user_manual:plugin-manual:schedule_topics.jpg|Schedule topics}}

Click on **+Add new topic** to create new topic with tags or just choose one topic from a list of existing topics and click on its name or edit icon to change its settings. Topic's preferences will show on the right hand side of the screen.

{{:user_manual:plugin-manual:schedule_edit_topic.png|Schedule edit topic}}

  * **Name** -> First choose a name for the topic. It has to be unique.

  * Click on **Advanced options** to expand/collapse a couple of options you may leave intact, like **SE Friendly URL** for the topic (a page that lists all items marked with this topic will be created on %%http://www.example.com/topic_sefURL%%) or **template** for tag/topic/article pages.

  * **Add tags** -> Finally, enter different tags for the topic. Use a comma when entering multiple tags.

Click on **Save** button when you are done. 

You probably noticed that a couple of tags are colored orange - clicking on any of them provides to Article section where articles tagged with the chosen tag are listed. 

==== Schedule an article ====

Choose Articles section from your Vivvo administration and click on the 'Add new article' link if you want to add a new article with schedule, or choose to edit an article from the list if you want to schedule an existing article. **Schedule** tab should appear next to 'Edit article' tab, just click on it to edit schedule preferences for the article you are creating/editing. 

{{:user_manual:plugin-manual:schedule_tab.jpg|Schedule tab}}

  * **Scheduled for** -> Automatically picks current date and time and by clicking on the calendar icon you edit the day and time the item starts.

{{:user_manual:plugin-manual:schedule_starttime.png|Scheduled for}}

  * **Duration** -> Enter how many minutes the item lasts.

  * **Recurrence** and **Terminates** -> These optional fields refer to items that recur, for example, every day, every working day, once a week etc. First choose a recurrence interval, then choose an ending date the same way you picked the starting date. In case that you don't specify Terminates date, that article will be recurring for ever.

==== Recurrence interval ====

There is a special format for entering article recurrence:

**Minute Hour Day Month Weekday** (each must be separated by space)

For easier setting recurrence interval there is a scheduler dialog where you'll select when the article will recur. Just click on the scheduler icon {{:user_manual:maintenance_cron_time_icon.jpg|Scheduler}} and in a pop-up window you'll be able to choose minute, hour, day, weekday and month.

  * Minute - Minute of the hour, 00 to 59. 
  * Hour - Hour of the day in 24-hour format, 00 to 23. 
  * Day - Day of the month, 1 to 31 (the job will not run if the day doesn't exist in the current month). 
  * Month - Month of the year, 1 to 12. 
  * Weekday - Day of the week, Mon to Sun.

You have some predefined values but you may also define time that fits you best and schedule your article to recur as often as you need. 

**Example:**

We want the article to recur every day at 2AM (every day/weekday and every month)

{{:user_manual:plugin-manual:schedule_dialog.png|Article recurrence example}}

  * **Tags** -> Choose appropriate tags for the item - start entering a name of existing tag and all tags containing characters you entered will be listed below, then just click on the chosen one. 

{{:user_manual:plugin-manual:schedule_tags.jpg|Tags}}

In our example we scheduled a show that will broadcast 10 months every working day starting from June 26 at 11:00 AM and each episode lasts 30 minutes. We tagged the show with the ABC channel, Animation genre and HD quality.

{{:user_manual:plugin-manual:schedule_example.png|Example}}