Simple:Press Documentation

Plugin: Quicktags HTML Editor

64Plugin Description –

This Simple:Press plugin is a basic HTML editor based on WordPress ‘Quicktags’ which features one-click buttons that insert code for you.

This editor allows the direct edit of the HTML in posts and pages. This editing mode is aimed at users who are comfortable working with HTML.

Plugin Overview

  • Provides the option for the forum Admin to select the “HTML (QuickTags) editor or other installed editors as the default on the site.
  • Provides the option for users in their profiles to select to use the “QuickTags- HTML” editor on new Add Topic posts and Add Reply posts even if the forum Admin has not set it as the default.0
  • Provides an HTML editor on new Topic posts and Reply posts, if selected by the forum Admin and/or the logged-in user via profile options.

Plugin Features

Installing this Simple:Press plugin adds:

  • A new Editor QuickTags HTML section in the “Available Plugins – Install Simple:Press Plugins” panel under the forum Admin menu path Forum > Plugins > Available Plugins. From this panel the plugin can be activated, or deleted by the admin.
  • When properly installed, a new folder in the “forum-plugin” folder named “quicktags-html” containing the plugin’s files.

Activating this plugin provides:

  • A change to the new “Editor QuickTags HTML” section in the Plugin Management panel under the Admin menu path Forum > Plugins > Available Plugins so the plugin can be deactivated.
    • There are no options for this plugin, per se, but the editor must be selected for use by either:
      • The forum admin as the site “default editor” in the “Post Editing” section of the the “Options – Global Settings” Admin panel, or
      • The individual forum user on the “Edit Posting Options” sub-tab in the logged-in user’s profile.
    • The “Getting Started” link associated with the “Deactivate” selections should be selected to view the pertinent information regarding the plugin.
  • A new check box for “HTML (QuickTags) under the “Post Editing” section on the “Options – Global Settings” Admin panel where the Admin can select the HTML (QuickTags) editor as the default editor for the site.
    • The selection is available from the Admin panel by navigating to Forum > Options > Global Settings.
  • A new check box for “HTML – QuickTags” under “Preferred Editor” on the users’ profile where they can select to use the HTML (QuickTags) editor.
    • The selection is available after the logged-in users select the “Profile” button to be able to view or edit their profile, select the “Options” tab, and then the “Edit Posting Options” sub-menu button.
  • If the “HTML – QuickTags editor is selected for use, above the text input section of the “Add Topic” or “Add Reply” post forms, the post author sees a “HTML” identifier along with the “default” edit buttons available in the editor.
    Note:
    Simple:Press allows the following HTML codes even though some are not part of the “default” set having buttons in the editor.

    • address, a, abbr, acronym, area, article, aside,
    • b, big, blockquote, br, caption, cite, class, code, col,
    • del, details, dd, div, dl, dt, em,
    • figure, figcaption, footer, font,
    • h1, h2, h3, h4, h5, h6, header, hgroup, hr,
    • i, img, ins, kbd, li, map, ol, p, pre, q,
    • s, section, small, span, strike, strong, sub, summary, sup,
    • table, tbody, td, tfoot, th, thead, tr, tt, u, ul, var

    Some codes are not allowed for security reasons. These include:

    • embed, frame, iframe, form, input, object, textarea and any others
    • The default HTML buttons available are:
      • B or /B for start of Bold and end of Bold
      • I or /I for start of italics and end of italics
      • U or /U for start of underline and end of underline
      • LINK with popup window for listing the URL to link with
      • B-QUOTE and /B-QUOTE for start of blockquote and end of blockquote
      • IMG with popup window for listing the URL of the image file
      • UL and /UL for an unordered list
      • OL and /OL for an ordered list
      • LI and /LI for a list item
      • SPOILER and /SPOILER for start of spoiler and end of spoiler
      • CODE and /CODE for start of code and end of code
      • CLOSE TAGS to close all open tags in the post

There are no new permissions added to the permission sets.

Plugin Requirements

Simple:Press version 5.6.4 and above is required.

This plugin must be installed, and activated before it is operational.

As part of the installation, a “Editor QuickTags HTML” section is added to the Plugin Management panel under the admin menu Forum > Plugins > Available Plugins. From this panel the plugin can be activated, deactivated, or deleted.

  • There are no options that need be set up for this plugin, per se, but the editor must be selected for use by either:
    • The forum admin as the site “default editor” in the “Post Editing” section of the the “Options – Global Settings” Admin panel, or
    • The individual forum user on the “Edit Posting Options” sub-tab in the logged-in user’s profile.

There are no new permissions added to the permission sets due to this plugin.

The plugin does not have template tags so no recommendation regarding Custom or Child Themes is being made.

Plugin Installation and Activation

Please see Using Plugins on how to obtain and install this Simple:Press plugin.

  • Whatever method is used to add the Simple:Press plugin, the folder that should have been added to the forum plugin folder is named “quicktags-html“.
  • If using the “Simple:Press Upload Plugin – Upload a Simple:Press Plugin” panel at the forum Admin menu Forum > Plugins > Plugin Uploader, the folder to browse for after downloading it from the Simple:Press site is “quicktags-html.zip” before clicking the “Upload Now” button.

As mentioned there the default location for Simple:Press plugin folders is …/wp-content/sp-resources/forum-plugins. If this path is changed, it is important to note that the plugin’s folder and its content need to reside in the forum plugins folder wherever it has been moved and however it has been renamed. See Storage Locations for more information.

Activation is accomplished from the Admin Dashboard panel menu by selecting Forum > Plugins > Available Plugins from the drop down forum Admin menu. On the “Available Plugins – Install Simple:Press Plugins” panel select the Editor QuickTags HTML plugin and click on “Activate”. The “Activate/Delete” label changes to “Deactivate” with a “Get Started” Link.

  • The “Getting Started” link associated with the “Deactivate” selections should be selected to view the pertinent information regarding the plugin.

To deactivate the plugin, click on “Deactivate”. The “Deactivate” label changes to “Activate/Delete”.
To re-activated the plugin, click on on “Activate”. The “Activate/Delete” label changes to “Deactivate”.

Plugin Administrative Options

After installing and activating, there are no Administrative Options to be set for this plugin, per se, but the HTML – QuickTags editor can be set up as the “default” editor for the site.

The forum Admin can select which of the installed editors is to be used as the default editor on the “Options – Global Settings” Admin panel. The process is discussed below and on the Plugin: Editors Codex page.

  • Selecting the Default Editor
  • Navigate to Forum > Options > Global Settings to see the “Options – Global Settings” Admin panel with its “Post Editing” section.
  • In the “Post Editing” section under “Select Default Editor:”
  • Click on the check box to the left of “HTML (QuickTags)” to use the HTML – QuickTags editor as the default.
    • The check box is selected if it contains a green check mark.
  • Click on one of the other editor selections if the HTML – QuickTags editor is NOT to be used as the default.
    • The other editor’s check box is selected if it contains a green check mark.
  • If there are no other selections to be made on the panel, click on the “Update Global Options” button at the bottom of the panel to save the selections.

To be complete for multilingual forums, the language translation files for this plugin should be installed or downloaded/properly placed in the appropriate forum-language folder for SP plugins using one of the procedures below in the “Plugin Language Translation” section of this page.

 

Plugin Language Translation

A plugin may not have language translation files, but in general each Simple:Press plugin has its own language translation files each with multiple pages for translating the forum plugin’s message strings.

Forum Plugin translation files are to reside in a unique forum folder location as defined by the “Simple:Press Plugin Language Files” entry on the “Integration – Storage Locations” forum Admin panel available through the forum Admin menu at Forum > Integration > Storage Locations.

  • The default location for forum plugin translation files is the folder “…/wp-content/sp-resources/forum-language/sp-plugins”.

Information regarding downloading language files, “mo’ language file placement, and translation (language localization) is found at Localization.

WARNING: On the Localization page, the Language Translation “.mo” Files Overview should be reviewed and well understood for naming convention and language translation file placement.

More information is available regarding translation files at Simple:Press Translations. which is the repository for Simple:Press language translation files. On the base page, select the “Getting Started Guide” link for basics about it’s use. On that page, select the “register a username here” link to obtain a password to the site. Use the “Contact Form” link to request the desired language if it is not currently available. The “Contact Form” link may also be used to volunteer to be a validator for a translation project.

This plugin’s available language translation files with translation statistics, and message translations can be viewed at Quicktags HTML within the repository for Simple:Press language translation files.

  • Installing this Simple:Press Plugin’s Language Translation “.mo” files
    The plugin’s language translations files for each language can be correctly located in two ways.

    • Using the Admin Word:Press “Site Language” and Simple:Press “Language Translation” Features
      WARNING: On the Localization codex page, the Language Translation “.mo” Files Overview should be reviewed and well understood for naming convention and language translation file placement.
        • Under the “Language Translation Selection Sequences” heading, the “Coordinated Language Translation File Download Using the Simple:Press ‘Language Translation’ Selection” section, follow the instructions at “Adding its Translation File(s) After Downloading/Activating a Simple:Press Theme or Simple:Press Plugin”.
          • Follow the instructions to select the “Site Language” and then get to the admin page with the “Integration – Language Translations” section where there should be an entry for “Editor QuickTags HTML” along with an “Install” button.
          • Click on the “Install” button for this plugin to install the language translation file for the current “Site Language” language.
            • Note: If the message “No Translation Project Exists” is displayed rather than the “Install” button, a translation file for that language could not be found in GlotPress at this time. Consider posting in the Simple:Press forum if it is felt there needs to be one added.
          • Be sure to verify the locale (filename) for the “.mo” file matches the language code for the language as referenced in the “Warning” above. If it does not, change it to match.
          • As called out in the section, continue to change the “Site Language” language and repeat the process until all desired translation files for this plugin have been installed.

       

    • Manually Finding and Storing Simple:Press Plugin’s Language Translation ‘mo’ files
    • WARNING: On the Localization codex page, the Language Translation “.mo” Files Overview should be reviewed and well understood for naming convention and language translation file placement.
      • After reviewing the material discussed under the “Language Translation Selection Sequences” heading, the “Manual Installation of Simple:Press Language Translation Files section, follow the steps outlined at “Finding and Storing ANY Simple:Press Plugin’s Language Translation ‘mo’ files”.
      • Each time through the process at the step, “Scroll down the list and click on the name of the plugin whose language files are being sought to see the translation file Version Number available”, substitute “Quicktags HTML” for the phrase “the name of the plugin whose language files are being sought”.
      • Be sure to verify the locale (filename) for the “.mo” file matches the language code for the language as referenced in the “Warning” above. If it does not, change it to match.
      • Repeat the steps for each language it is desired to have a translation file (french, spanish, etc.) for the plugin on the website.

Plugin Usage

Forum Admins and forum users can select the HTML (QuickTags) editor even it is not the default editor selected by the forum Admin or they can deselect it if it is the default editor if they do not want to use it. The process is discussed below and on the Plugin: Editors Codex page.

  • Users Selecting the HTML (QuickTags) Editor for Posts
  • On the forum page header users select the “Profile” button to be able to view or edit their profile.
  • Then select the “Options” tab.
  • Finally select the “Edit Posting Options” sub-menu to see the “Edit Posting Options” items.
  • Under “Preferred Editor:”
    • To use the HTML (QuickTags) editor click on the check box to the left of “HTML – QuickTags”
      • The check box is selected if it contains a green check mark.
    • To NOT use the HTML (QuickTags) editor, click on the check box to the left of one of the other editor options shown.
      • The HTML (QuickTags) editor check box is NOT selected if it does NOT contain a green check mark.
      • The selected editor’s check box is selected if it does contain a green check mark.
    • Click on the “Update Posting Options” button at the bottom of the panel to save the settings.

If the HTML (QuickTags) editor is selected for use, the HTML editor edit options are available to the forum user when developing posts.

  • Using HTML Editor Edit Options
    • In a forum, click on the “Add Topic” button or “Add Reply” button to get their respective post creation forms.
    • If the HTML editor is selected for use, above the text input section of the post forms the post author sees the label “HTML” along with the edit buttons available in the HTML editor.
    • To use a HMTL editor function:
      • Click on their associated button above the post text input area on the form if it is in the “default” set.
      • Type the HTML tag where appropriate in the post text.
    • After completing the form, click on the “Submit Topic” or “Submit Reply” button to submit the post.

Plugin Special Notes

The HMTL (QuickTags) editor is one of several available as a plugin for the forum. Please see the Plugin: Editors Codex page for more information on the available editors.

Template Tags Used in the Plugin

There are no Template Tags used in this plugin.

Actions and Hooks Used in the Plugin

There are no Actions and Hooks available in Template Tags for this plugin.

There are no other Actions and Hooks available in this plugin to modify aspects of this plugin.

Plugin and Template Tag Changelog

Since Simple:Press version 4.0.2.

Codex page sync’d to code version 5.6.4 and plugin version 1.3.2

More Topics In SimplePress: Plugins


Copyright © 2006-2019 Simple:Press. All Rights Reserved.