# 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: Forum
description: |
    <p>This Module lets you set up and Manage Forums (message boards) on your website.</p>
            <p>Visitors will be able to read threads (topics), create new threads and reply to them.</p>
            <p>The Posts editor is equipped with a rich text editor, the features of which can be enabled or
                disabled in this Module's settings.</p>
            <p>You can restrict posting privileges to Extranet Users, or Users of selected Group(s).
                You can allow users to modify and/or delete their own posts and report an offensive comment.</p>
            <p>There are also moderation tools for members of Employee-type Groups, allowing them to edit
                or remove offending messages.</p>
            <p>When setting up, you can select the information that should be displayed about the people who post:
                name, online status, post count, sign-up date, job titles and avatars.</p>
            <p>Every time a new thread or message is created or an existing message is edited, an email notification can be set to a specified
                email address (typically the Forum/Website administrator). You can create and select your own Email
                Templates and these will be used to send the reports. The selected Email Templates can contain various
                Merge Fields that will be replaced by real values when the email is sent. You can use the following
                fields in the Emails sent by the Forum Module:</p>
            <ul>
                <li>[[cms_url]] - The URL to the website.</li>
                <li>[[forum_link]] - A link to the page that Forum is on.</li>
                <li>[[forum_title]] - The title of the Forum (this is the same as the page title).</li>
                <li>[[message]] - The message that was just created or edited.</li>
                <li>[[thread_link]] - A link to the thread that was just created or replied to.</li>
                <li>[[thread_title]] - The title of the thread that was just created or replied to.</li>
                <li>[[poster_screen_name]] - The screen name of the user who posted the message.
                    (Note that this will only appear if screen names are enabled in the Site Settings.)</li>
                <li>[[poster_username]] - The username of the user who posted the message.</li>
            </ul>
            <p>If the subscription feature is enabled, Extranet Users can subscribed to a thread to receive notifications
                of any new replies made there, or subscribe to a Forum and receive notifications of any new threads created there.
                Each subscriber will be sent an email when a reply/thread is posted.
                These emails also use an Email Template, in which you can use any of the fields above (except for
                [[poster_username]] as Usernames are private), and in addition the following fields:</p>
            <ul>
                <li>[[subscriber_email]] - The email of the subscribing user.</li>
                <li>[[subscriber_title]] - The salutation of the subscribing user.</li>
                <li>[[subscriber_first_name]] - The first name of the subscribing user.</li>
                <li>[[subscriber_middle_name]] - The middle name of the subscribing user.</li>
                <li>[[subscriber_last_name]] - The last name of the subscribing user.</li>
                <li>[[subscriber_screen_name]] - The screen name of the subscribing user.</li>
                <li>[[subscriber_username]] - The username of the subscribing user.</li>
category: management
keywords: >
    chat, chatroom, community, discuss, discussion, forum,
    message, post, user

# 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:
vlp_class_name: zenario_forum
css_class_name: zenario_comments
is_pluggable: true
can_be_plugged_into:
    content_items: true
    layouts: false
    regular_nests: false
    slideshows: false
    ajax_nests_without_conductor: false
    ajax_nests_with_conductor: false
default_framework: standard
default_instance_name: Forum

# 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_extranet: true
    zenario_comments: true
inheritance:
    inherit_frameworks_from_module: zenario_comments
    include_javascript_from_module: zenario_comments
signals:
    -
        name: eventUserDeleted
        static: true
    -
        name: deleteUserDataGetInfo
        static: true
