# You must use a tab-size of 4 spaces to edit this file.
---
author_name: Tribal Systems
copyright_info: © Tribal Limited
editions: ProBusiness, Enterprise
start_running_on_install: false
license_info: 'Modified BSD License'
display_name: Videos Front End & Admin
category: pluggable
description: |
    <p>Allows you to present a library of videos, which are stored on YouTube or Vimeo, but managed in Organizer by the Zenario Videos Manager module (zenario_videos_manager).</p>
    <h3>How to set up a video gallery</h3>

    <ol><li>For a simple video gallery, you should start this module and navigate to the HTML content item on which you want to display videos. Create a new one if you need to.</li>
    <li>Locate the slot where you want the videos to be shown. A wide slot is best. In Content item view, use the slot inspector to add a nest.</li>
    <li>Create a nest, choosing Conductor-type. Place it in a slot on a content item.</li>
    <li>Use the slot inspector to view the nest's plugins and settings. Initially the nest will have one slide. Select this slide and add a Videos FEA plugin. In the plugin settings choose the "List videos" mode. Under "Item-specific buttons", make sure the "View video" checkbox is checked, so that is makes a link to the viewing mode.</li>
    <li>Add a second slide, and on the slide settings choose "Show a Back button".</li>
    <li>Select the second slide and add a Videos FEA plugin to it. This time choose "View video" mode in its plugin settings.</li>
    <li>Open the Conductor state diagram, and set up a path from slide 1 to slide 2. Select "view_video" as the command. Then create a path back from slide 2 to slide 1 with "back" as the command.</li>
    <li>Close the nest editor and return to the page. You should now find that your videos are displayed there, and that you can click a video on the list or grid and go to a larger view of that video so as to play it.
    </ol>
    <p>The above procedure should allow you to create a setup whereby visitors can see a list or grid of the site's videos, and play them one at a time. If you have a large library, you may want to improve the setup by adding a filiter to the first slide's plugin so as to restrict videos by a given category.</p>
    <h3>Further possibilities: editing</h3>
    <p>This plugin is powerful enough to support editing of a list of videos by extranet users, such as in a "superuser" group. This way, privileged users can edit the library without needing Organizer access as an administrator.</p>

# Reminder: you need to increment the LATEST_REVISION_NO in this module's
# latest_revision_no.inc.php file if you change any of the fields below:
is_pluggable: true
can_be_plugged_into:
    content_items: false
    layouts: false
    regular_nests: true
    slideshows: false
    ajax_nests_without_conductor: false
    ajax_nests_with_conductor: true
default_framework: standard
default_instance_name: Videos FEA

# Warning: adding a new dependency to an existing module will break any existing sites
# where the dependency is not running.
# You can fix this on a per-site basis by manually running the dependency, i.e. by running
#   UPDATE zenario_modules SET status = 'module_running' WHERE class_name = 'dependency'
# in MySQL and then going to /admin/ to apply database updates.
# If this is a core module, consider using runNewModuleDependency() in a 
# database-revision in zenario/admin/db_updates/step_4_migrate_the_data/plugins.inc.php
# to fix it automatically for every site.
dependencies:
    zenario_abstract_fea: true
    zenario_abstract_nest: true
    zenario_videos_manager: true
inheritance:
    include_javascript_from_module: zenario_abstract_fea

# Conductor uses paths between slides to control its navigation.
# When creating a path, the admin can specify a command for that path. The path will then be followed
# when your plugin issues this command.
# You should define the command that your plugin uses below. For each command, you should give it a
# label, and list which modes it's used in (no list means every mode), and the request_vars it uses.
# Note that you will need to increment the LATEST_REVISION_NO in this module's latest_revision_no.inc.php file
# every time you add or change the request_vars properties, to have them re-read by the CMS.
path_commands:
    new_video:
        label: New video
        modes:
            - list_videos
        request_vars:
            - videoId
    view_video:
        label: View video
        modes:
            - list_videos
            - search_videos
        request_vars:
            - videoId
    edit_video:
        label: Edit video
        modes:
            - list_videos
            - view_video
        request_vars:
            - videoId