Simple:Press Documentation

Plugin: Private Posts

Plugin Description

Plugin: Private Posts – This Simple:Press plugin allows users with permission to mark posts within a topic as private, or view the contents of private posts, or both.

Plugin Features

Installing this Simple:Press plugin adds:

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

Activating this plugin provides:

  • A change to the new “Private Posts” section in the “Available Plugins – Install Simple:Press Plugins” panel under the Admin menu path Forum > Plugins > Available Plugins so the Simple:Press “Private Post” plugin can be deactivated, uninstalled, or have its Options set up.
    • The Options link goes to the “Options – Content Settings” forum Admin panel.
    • The “Getting Started” link associated with the “Deactivate/Uninstall/Options” selections should be selected to view the pertinent information regarding the plugin.
  • A new “Private Post Options” section in the “Options – Content Settings” forum Admin panel where
      • the banner message displayed on all private posts in addition to the originators words is created. For user not allowed to view private messages this banner message is all that is displayed for post content.
      • the options are selected for how to handle messages marked as private if the “Private Posts” plugin is uninstalled.
    • The “Help” link should be used for assistance in setting up the options.
    • The “Options – Content Settings” forum Admin panel can also be accessed under the Admin menu path Forum > Options > Content Settings
  • Two (2) new permissions are added due to this plugin:
    • A new permission “Can make a private post” that must be enabled by the forum Admin in the permissions sets for usergroups being allowed to create/mark posts as private. A permission set is edited from the forum Admin menu at Forum > Permissions > Manage Permission Sets by clicking on the “Edit Permission” button associated with the permission set.
    • A new permission “Can view posts marked as private” that must be enabled by the forum Admin in the permissions sets for usergroups being allowed to view posts marked as private. A permission set is edited from the forum Admin menu at Forum > Permissions > Manage Permission Sets by clicking on the “Edit Permission” button associated with the permission set.
  • For forum users with the “Can make a private post” permission:
    • In the topic creation template in Forum View a new “Mark this post private” check box in the “Options” section that the topic creator can select by clicking on to mark the originating post as private. The check box is selected when it contains a green check mark.
    • In the topic reply template in Topic View a new “Mark this post private’ check box in the “Options” section that the reply post creator can select by clicking on to mark the originating post as private. The check box is selected when it contains a green check mark.
  • Forum users with the “Can view posts marked as private” permission are able to view the content of private posts in the forums to which they have access.
  • Forum users without the “Can view posts marked as private” permission are able to view the private posts in the forums to which they have access, but the original content is not displayed only the private post banner message specified by the forum Admin in the “Private Post Options” section of the “Options – Content Settings” forum Admin panel.
  • Forum Admins have new “Unmark post private” or “Mark post private” options in the “Forum Tools” to change the classification of a post. The “Forum Toolset” can be accessed on each post by hovering the cursor over the body of the post to make the “forum toolset icon” (the default is a screwdriver crossed over a wrench) appear in the left column of the post along with the tooltip message “Open the forum toolset”.

Plugin Requirements

Simple:Press version 5.5.7 and above is required.

The Simple:Press plugin must be installed, activated, and its options set before it is operational.

  • As part of the installation, a “Private Post” section is added to the “Available Plugins – Install Simple:Press Plugins” panel under the admin menu Forum > Plugins > Available Plugins. From this panel the “Private Post” plugin can be activated, deactivated, uninstalled, deleted, or its options set using its “Activate/Delete” and “Deactivate/Uninstall/options” selections.
    • The Options link goes to the “Options – Content Settings” forum Admin panel.

There are two (2) permissions added to the permission sets due to this plugin that must be set up.

The plugin has no (0) template tags so there are no recommendations made regarding developing Child Themes or Custom Themes to accommodate changes to template tags.

Plugin Installation and Activation

Please see Using Plugins on how to obtain and install the Simple:Press “Private Posts” 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 “private-posts“.
  • 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 “private-posts.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 “Private Posts” plugin and click on “Activate”. The “Activate/Delete” label changes to “Deactivate/Uninstall/Options” with a “Get Started” Link.

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

To deactivate the plugin, click on “Deactivate”. The “Deactivate/Uninstall/Options” label changes to “Activate/Delete”.

If uninstalling the plugin and posts absolutely must remain and retain private post content, each post to remain with original content must be manually marked as not being private before uninstalling the plugin. The Changing the Post’s “Private” Classification procedure above can be used.

Plugin Administrative Options

After activation, a) on the aforementioned “Available Plugins – Install Simple:Press Plugins” panel, click “Options” on the “Private Posts” plugin section or b) under the “Options” entry on the forum menu on the left side forum admin page click the “Content Settings” sub-menu item to get the “Options – Content Settings” panel with the “Private Posts Options” section.

    • Creating the Message To Display on all Posts Marked as Private

In this option the text to be shown in the banner message on all posts that have been marked private is defined. This banner message is all users will see who have not been given permission to view the content of private posts. HTML is allowed.

      • The default banner message is “This post is marked private.”
        • If the default banner message is sufficient, no action is required for this input. Proceed to the save the setting.
        • If a different banner message is desired, enter the desired text in the text box to the right of “Message to display for posts that have been marked as private:”.
      • If there are no other “Private Post Options” to select, click on the “Update Content Options” button at the bottom of the page to save the settings. Otherwise, proceed to the next option to select.
    • Selecting How to Handle Private Posts When (or If) Uninstalling the Plugin

In this option what will happen to private posts if/when the “Private Post” plugin is uninstalled is specified. One of the two option must be selected. The private post can either be deleted entirely or the post content can be permanently blanked out.

Note: If posts absolutely must remain and retain private post content when uninstalling the “Private Post” plugin, each post to remain with original content must be manually marked as not being private before uninstalling the plugin. The Changing the Post’s “Private” Classification procedure below can be used.
    • If the private posts are to be deleted, click in the check box to the left of “Delete private posts” if it does not already have a green check mark in it.
      • The check box is selected if it has a green check mark in it.
    • If the private posts are to remain with post content blank, click in the check box to the left of “Set private post content to blank” if it does not already have a green check mark in it.
      • The check box is selected if it has a green check mark in it.
    • If there are no other “Private Post Options” to select, click on the “Update Content Options” button at the bottom of the page to save the settings. Otherwise, proceed to the next option to select.

From the Forum Admin menu on the left of admin pages, select Forum > Permissions > Manage Permission Sets to see the permission sets available.

  • Assigning New Permissions
    • Make A Private Post permission
    • Allowing users to mark a post as private when they create it is controlled by their group permissions.
    • Each member group that is to have the ability to create a private post must have the permission turned on.
    • This is accomplished from the Simple:Press Administration panel Admin menu by clicking/opening Forum > Permissions > Manage Permission Sets.
    • Select “Edit Permission” for the permission set to be updated to view the “Permissions – Manage Permissions” panel.
    • Under “Creating” click the check box next to “Can make a private post” to set/enable the permission. When enabled, the check box contains a green check mark.
    • Click “Update Permission” at the bottom of the page to have the selection saved.
    • At a later time clicking the check box when it has a green check mark removes the check mark and will remove the permission when followed by clicking “Update Permission” to save the revised selection.
    • Repeat these steps on each usergroup to have this permission.
    • View A Private Post permission
    • Allowing users to view the content of a private post is controlled by their group permissions.
    • Each member group that is to have the ability to view private posts must have the permission turned on.
    • This is accomplished from the Simple:Press Administration panel Admin menu by clicking/opening Forum > Permissions > Manage Permission Sets.
    • Select “Edit Permission” for the permission set to be updated to view the “Permissions – Manage Permissions” panel.
    • Under “Viewing” click the check box next to “Can view posts marked as private” to set/enable the permission. When enabled, the check box contains a green check mark.
    • Click “Update Permission” at the bottom of the page to have the selection saved.
    • At a later time clicking the check box when it has a green check mark removes the check mark and will remove the permission when followed by clicking “Update Permission” to save the revised selection.
    • Repeat these steps on each usergroup to have this permission.

To be complete for multilingual forums, the language translation files for this plugin, “Private Post” 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.

The “Private Posts” plugin’s available language translation files with translation statistics, and message translations can be viewed at Private Posts within the repository for Simple:Press language translation files.

  • Installing the Simple:Press “Private Post” Plugin Language Translation “.mo” files
    The “Private Posts” plugin 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 this plugin should have an entry.
          • Click on the “Install” button for this plugin, “Private Posts” to install the language translation file for the current “Site Language” language.
            • Note: If a translation file for the language actually exists, but has no translations in it yet, the message “No Translation Project Exists” may be displayed rather than the “Install” button. Consider starting the translations.
          • 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 “Private Post” plugin translation files have been installed.

       

    • Manually Finding and Storing the Simple:Press “Private Post” Plugin 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 “Private Post” 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

Once set only forum Admins can change a “Private” post to be “non-private” or a “non-private” post to “Private” using the Forum Toolset.

Note: If posts absolutely must remain and retain private post content when uninstalling the “Private Post” plugin, each post to remain with original content must be manually marked as not being private before uninstalling the plugin. The procedure below can be used.
  • Changing the Post “Private” Classification
    • Navigate in the forum to the Topic View for the topic containing the post of interest.
    • Hover the cursor over the body of the post to allow the “Forum Toolset” icon (crossed screwdriver and wrench) to be displayed in the left column of the post along with the popup message, “Open the forum toolset”.
    • Click the “Forum Toolset” icon to provide a drop down menu with “Unmark post private” in the list of selections if the post is “private” and “Mark post private” if the post is not private.
      • If the post is private, click on “Unmark post private” to make the post not private. The private post “banner” is removed from the post and the entry in the Forum Toolset changes to “Mark post private”.
      • If the post is not private, click on “Mark post private” to make the post private. The private post “banner” is added to the post and the entry in the Forum Toolset changes to “Unmark post private”.
      • Clicking in the top input box (date selection box) provides a popup calendar where the new month, year, and date for the topic to expire can be specified. If no expiration date is desired, select the contents of the box and delete the contents so the box is blank.
      • Clicking on the down arrow to the right of the lower input box (destination forum selection box) provides a dropdown menu of possible forums into which the topic can be moved upon its expiration. Highlight/select the desired forum.
      • Clicking the “Update Topic Expiration” box will result in the topic’s expiration date and destination forum being changed to the new values.

Forum Users with proper permission may mark a post as private when creating it or view private posts or both.

    • Creating a New Topic Private Post
    • After installation and activation of the plugin, the input form displayed to users with permission when entering a new topic has an additional input field where the originator may mark the original post in the topic as private.
    • In the forum view after clicking on the “Add Topic” button the “Add Topic” form is displayed.
    • At some point during the creation of the post, scroll down to the “Options” section of the form containing the text “Mark this post private” and an associated check box.
    • To mark the post as private, click in check box to the right of “Mark this post private” if the check box does not already contain a green check mark.
      • The checkbox is selected if it contains a green check mark.
    • After completing all of the inputs and selections associated with the new topic post, click on the “Submit Topic” button found at the bottom of the form.

 

  • Creating a Topic Reply Private Post
  • After installation and activation of the plugin, the input form displayed to users with permission when entering a topic reply has an additional input field where the originator may mark the reply post in the topic as private.
  • In the forum view after clicking on the “Add Reply” button the “Add Reply” form is displayed.
  • At some point during the creation of the reply post, scroll down to the “Options” section of the form containing the text “Mark this post private” and an associated check box.
  • To mark the post as private, click in check box to the right of “Mark this post private” if the check box does not already contain a green check mark.
    • The checkbox is selected if it contains a green check mark.
  • After completing all of the inputs and selections associated with the reply post, input the answer to the “Math Required” question and then click on the “Submit Reply” button found at the bottom of the form.

Plugin Special Notes

If posts absolutely must remain and retain private post content when uninstalling the “Private Post” plugin, each post to remain with original content must be manually marked as not being private before uninstalling the plugin. The Changing the Post’s “Private” Classification procedure above can be used.

Template Tags Used in the Plugin

There are no (0) template tags available for this plugin that allows further customization of the plugin’s usage or otherwise customize the website.

Action and Hooks Used in the Plugin

There are no Actions and Hooks available in the Plugin’s Template Tags because there are no template tags.
There are no other Actions and Hooks available for this plugin.

Plugin and Template Tag Changelog

Since Simple:Press version 5.5.5.

Codex page sync’d to code version 5.5.6 and plugin version 1.0.

More Topics In SimplePress: Plugins


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