# You must use a tab-size of 4 spaces to edit this file.
---
author_name: Tribal Systems
copyright_info: © Tribal Limited
editions: Community, Pro, ProBusiness, Enterprise
start_running_on_install: true  # N.b. changing this property won't do anything as this module is hard-coded in the installer to run on install.
license_info: 'Modified BSD License'
display_name: WYSIWYG Editor
description: |
    <p>The WYSIWYG Editor ("what you see is what you get") module is usually placed on a layout, and then can be used for version-controlled content editing.</p>
    <p>The editor allows administrators to enter formatted content, with images, hyperlinks and other HTML.</p>
    <p>In such a situation - when not stored as a plugin - the content that is written within the editor is specific to each content item that uses that layout (which can be HTML Pages, News, Events, and other content types). The content is version-controlled, going live when the content item it's on is published.</p>
    <h3>Usage as a plugin</h3>
    <p>It is also possible to create a WYSIWYG Editor as a plugin.</p>
    <p>When a plugin of this module is created, the content written in the editor is stored in a centralised way (i.e. not version-controlled), and the same content can then appear on one or more content items. The administrator just needs to pick the plugin and insert it into a nest.</p>
    <h3>Usage in a nest</h3>
    <p>A further usage is to create a plugin that goes in a nest. This can be helpful, for example, if you would like an accordion, or a tabbed nest, with formatted text (i.e. one plugin with a block of HTML) on each slide of the nest.</p>
category: pluggable
keywords: edit, editor, format, html, page, toolbar, wysiwyg

# 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:
css_class_name: zenario_html_snippet
is_pluggable: true
can_be_version_controlled: true
can_be_plugged_into:
    content_items: true
    layouts: true
    regular_nests: true
    slideshows: false
    ajax_nests_without_conductor: true
    ajax_nests_with_conductor: true
default_framework: standard
default_instance_name: Untitled Block of HTML

# 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_html_snippet: true
inheritance:
    inherit_frameworks_from_module: zenario_html_snippet
