Simple:Press Documentation

Plugin: Topic Redirect

Plugin Description

Plugin: Topic Redirect – This Simple:Press plugin allows for creating a forum topic which is a simple redirect to a URL. This is useful for pinning topics which might link to static pages such as forum rules and/or information, or many other possibilities.

Plugin Features

Installing this Simple:Press plugin adds:

  • A new “Topic Redirect” section in the Plugin Management panel under the Admin menu path Forum – Plugins – Available Plugins. From this panel the Simple:Press “Topic Redirect” plugin can be activated, or deleted by the admin.

Activating this plugin provides:

  • A change to the new “Topic Redirect” section in the Plugin Management panel under the Admin menu path Forum – Plugins – Available Plugins so the Simple:Press “Topic Redirect” plugin can be deactivated, or uninstalled.
  • A new permission “Can create new topic redirects” that must be enabled in the permissions sets for usergroups being allowed to create topic redirects.
  • A new radio button “Create a Topic Redirect” in the “Options” section in the input screen for a New Topic below the text input section where the originator can select to use the new topic as a redirect. This radio button will only show up for new topic originators having the new permission enabled in their usergroup permission set.
    • When the new radio button is selected (radio button turned green in color), a new text input box below the radio button appears where text about the new topic and its link can be input. Directions for putting the URL for the redirect into the post text box is also displayed.

There are no option settings associated with this plugin.

Plugin Requirements

Simple:Press version 5.5.9 and above is required.

The Simple:Press plugin must be installed and activated before it is operational.

As part of the installation, a “Topic Redirect” section is added to the Plugin Management panel under the admin menu Forum – Plugins – Available Plugins. From this panel the Topic Redirect plugin can be activated, deactivated, uninstalled, and deleted.

There is a new permission added to the permission sets due to this plugin that must be enabled.

There are no option settings associated with this plugin.

The plugin does not have template tags incorporated into current themes so developing a Custom or Child Theme to accommodate any desired template tag changes is not needed before installing this plugin. Information on Child Themes is located on our Creating a Child Theme page. Information on creating and installing themes is located on our Creating a Custom Theme page.

Plugin Installation and Activation

Please see Using Plugins on how to obtain and install the Simple:Press Topic Redirect plugin.

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” and then “Plugins” from the drop down Forum Admin menu. On the Simple:Press Administration panel select the “Topic Redirect” plugin on the “Plugin Management” panel and click on “Activate”. The “Activate/Delete” label changes to “Deactivate/Uninstall”. To deactivate the plugin, click on “Deactivate”. The “Deactivate/Uninstall” label changes to “Activate/Delete”.

Plugin Administrative Options

From the Forum Admin menu on the left of admin pages, open the “Permissions” entry, to see the sub-menu and select “Manage Permission Sets”.

  • Assigning Permissions
    • Allowing users to use the topic redirect capability is controlled by their group permissions.
    • Each member group that is to have the ability to topic redirect must have a new permission turned on.
    • This is accomplished from the Admin menu by navigating to Forum – Permissions and selecting “Manage Permissions Sets” in its sub-menu.
    • Select “Edit Permission” for the permission set to be updated to view the “Permissions – Manage Permissions” panel.
    • Under “Creating” click the radio button next to the new permission “Can create new topic redirects” to set/enable the permission. When enabled, the radio button is green in color.
    • Click “Update Permission” at the bottom of the permission set to have the selection saved.
    • At a later time clicking a radio button when it is green removes the green color and will remove the permission when followed by clicking “Update Permission” to save the revised selection.
    • Repeat the process above for each permission set to have the permissions updated to allow topic redirecting.

Plugin Language Translation

A plugin’s message strings can be translated from English to other languages and then the translation displayed if language translation files are available. Some plugins may not have such files.

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

More information is available regarding translation files at Simple:Press Translations. 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.

The Topic Redirect plugin’s available language translation files with translation statistics, and message translations can be viewed at Topic Redirect Translations. Select the Version link to see the languages available. Select the link for the desired language to see forum messages and their available translations. If available, export the file for the selected language to its proper forum language sub-folder as a “mo” file using the export link at the bottom of the page displaying the actual message translations for the language selected.

The default location for plugin language files is …/wp-content/sp-resources/forum-language/sp-plugins. If this path is changed, it is important to note that the plugin’s language file needs to reside in the language sub-folder for sp plugins wherever it has been moved and however it has been renamed. See Storage Locations for more information.

Plugin Usage

Forum admins use this plugin to enable the new permission in the permission sets for usergroups being allowed to use the Topic Redirect capability.

Forum users having “Can create new topic redirects” permission can create new topic redirects.

  • Creating a new Topic Post as a Topic Redirect
    • After installation and activation of the plugin, the new topic input form displayed to users with the “Can create new topic redirects” permission has an additional radio button “Create a Topic Redirect” in the “Options” field below the post input text box (editor window).
    • After scrolling down to the “Options” section, click on the radio button to the left of “Create a Topic Redirect” to select the capability and have displayed below the radio button directions for filling in the editor window (post text input box) and adding optional text to the post in the “Optional Description” text input box provided. The radio button indicates it is selected by turning green in color. Clicking the radio button when it is green will deselect it. The radio button indicates it is deselected by turning gray in color.
    • Input the optional text in the “Optional Description” text box.
    • Scroll up to the new topic form editor window (post text input box) and input the redirect URL – and ONLY the URL in the editor window.
      • For example to redirect to the Simple:Press About Us page, put in https://simple-press.com/about or simple-press.com/about
      • NOTE: Adding any other text or characters may corrupt the link.
    • After any other selections or necessary actions for the new topic post have been made including adding a title, click the “Submit Topic” button at the bottom of the input forum to submit the new topic as a topic redirect.
  • Following a new Topic Redirect
    • When the post appears in the forum, clicking on the title will redirect the user to the destination webpage at the URL input by the topic originator in the editor window.

Plugin Special Notes

None

Template Tags Used in the Plugin

There are no Template Tags available for this plugin that allows the admin to further customize it’s usage or otherwise customize the website.

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 for this plugin.

Plugin and Template Tag Changelog

Since Simple:Press version 5.5.1.

Codex page sync’d to code version 5.5.3.

More Topics In SimplePress: Plugins


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