Simple:Press Documentation

Plugin: Polls

Plugin Description –

This Simple:Press plugin provides the ability to add polls to posts in the forums.

Note:
If forum polling activities are to be awarded points in the WordPress (WP) CubePoints system, the WP CubePoints plugin and the Simple:Press (SP) Cubepoints Integration plugin must be active on the site.

  • Please see the SP Codex page Plugin: CubePoints Integration for details of downloading, installing, and setting up that SP plugin and information on the WP plugin.

If forum polling activities are to be awarded points in the WordPress (WP) myCRED system, the WP myCRED plugin and the SP myCred Integration plugin must be active on the site.

  • Please see the SP Codex page Plugin: myCred Integration for details of downloading, installing, and setting up that SP plugin and information on the WP plugin.

Plugin Overview

  • Provides a new forum Admin panel for setting up polling options.
    • What posts can have polls, default poll duration, if results hidden until complete, voter tracking relative to multiple voting, sorting answers and results, and results bar appearance.
  • Provides a new forum Admin panel for managing polls.
    • Simple stats on polls in forum, logs for each poll (who voted and how), ability to edit and delete polls.
  • Adds new enable that needs to be set in each forum where polls are to be allowed.
  • Adds a check box on an existing forum Admin panel where forum Admins or Moderators can be allowed to “Manage Polls”.
  • Adds permissions for who can create a poll and who can vote in polls.
  • Adds a “Poll” button in the appropriate post creation form(s) where users with permission can create polls.
  • Adds a “Vote” button in the “poll” post where users with permission can vote in the post’s poll.
  • Allows polling activities to be awarded points in the WP myCRED point system if the necessary plugins are active.
  • Allows polling activities to be awarded points in the WP CubePoints point system if the necessary plugins are active.

Plugin Features

Installing this Simple:Press plugin adds:

  • A new “Polls” 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 “polls” containing the plugin’s files.

Activating this plugin provides:

    • A change to the new “Polls” section in the “Available Plugins – Install Simple:Press Plugins” panel under the Admin menu path Forum > Plugins > Available Plugins so the Simple:Press plugin can be deactivated, uninstalled, or have its Options set up.
      • The Options link goes to the new “Polls – Options” forum Admin panel where the plugin’s options can be set.
      • The “Getting Started” link associated with the “Deactivate/Uninstall/Options” selections should be selected to view the pertinent information regarding the plugin.
    • A new forum Admin menu entry, “Polls” with sub-menu entries, “Options” and “Manage Polls”.
      • The “Options” sub-menu entry is linked to the “Polls – Options” forum Admin panel where the polls options can be set up.
      • The “Manage Polls” sub-menu entry is linked to the “Polls – Poll Stats” forum Admin panel where poll statistics, the list of forum polls, and poll logs can be viewed. The polls can be edited and deleted there.
      • The “Polls” forum Admin menu entry is accessed from the WP Admin menu at Forum > Polls.
    • A new “Polls – Options” forum Admin panel with “Options”, “Tracking Options”, “Answer Sorting”, “Results Sorting”, and “Results Display” sections where the polls options are set up.
      • The “Polls – Options” forum Admin panel can be accessed from WP Admin menu at:
        • Forum > Polls > Options
        • Forum > Plugins > Available Plugins > Polls > Options
    • A new “Polls – Poll Stats” forum Admin panel with “Stats”, and “Polls” sections where the poll statistics can be view, and forum poll specifics can be viewed, edited, or deleted.
Note:
If in the “Polls” section under the “Manage” column for a poll:

  • the “Poll Log” icon is selected, the “Poll Logs” section for that poll will also be displayed.
  • the “Edit Poll” icon is selected, the “Poll Edit” section for that poll will also be displayed.
  • the “Delete Poll” icon is selected, the poll can be deleted.
      • The “Polls – Poll Stats” forum Admin panel can be accessed from WP Admin menu at:
        • Forum > Polls > Manage Polls
    • A new check box “Enable polls on this forum” in the “Extended Forum Options” section of the existing “Forums – Manage Groups and Forums” forum Admin panel where the forum Admin can select to allow polls in a specific forum.
      • The “Forums – Manage Groups and Forums” forum Admin panel is accessed from the Forum Admin menu at Forum > Forums > Manage Groups And Forums and then by clicking on the “Edit This Forum” button associated with the forum receiving the ability to have polls.
    • A new check box “Manage Polls” for each forum Admin or Moderator listed on the “Admins – Manage Admins and Moderators” forum Admin panel where the ability to manage polls can be allowed.
      • The “Admins – Manage Admins and Moderators” forum Admin panel is accessed from the Forum Admin menu at Forum > Admins > Manage Admins.

For Forum Admins and Forum Users with the “Can create a forum poll within a post” permission in forums with polling enabled

    • A new “Poll” button in the options section (below the post text input section) of the “Add Topic” post form linked to the new “Add A Poll” popup window where the post author can create a poll in the topic being added.
    • A new “Poll” button in the options section (below the post text input section) of the “Add Reply” post form linked to the new “Add A Poll” popup window where the post author can create a poll in the reply being added.
Note:
If the “Restrict new poll creation to new topics” is selected by the forum Admin in the “Options” section of the “Polls – Options” forum Admin panel, the “Poll” button will not be present in the “Add Reply” post form.
    • A new “Add A Poll” popup window where a new poll can be created with input box or check box for:
      • A Poll Question
      • Two (2) or more Poll Answers
      • A Poll Expiration date (if desired other than default duration)
      • A maximum number of answers per vote
      • Hiding Poll Results selection, if the “Allow poll results to be hidden” check box has been selected in the “Options” section of the “Polls – Options” forum Admin panel.

For Forum Admins and Forum Users with the “Can vote in a forum poll within a post” permission in forums with polling enabled

    • Check boxes for each answer to a poll question in the text section of a post with a poll where the forum users can select the answer(s) they wish to vote for.
    • A new “Vote” button in the text section of a post where the forum users can submit the answer(s) they selected in the poll.
    • A new “View Poll Results” message linked to the current results for the poll in the post.
Note:
If the “Allow post results to be hidden” is selected by the forum Admin in the “Options” section of the “Polls – Options” forum Admin panel, the “View Poll Results” button will not be present in the poll post.

There are two (2) new permissions added to the permission sets due to this plugin.

  • Can create a forum poll within a post
  • Can vote in a forum poll within a post
  • The permissions on the “Permissions – Manage Permissions” forum Admin panel can be accessed from the WP Admin panel at:
    • Forum > Permissions > Manage Permission Sets and clicking the “Edit Permission” button for the permission sets to have the permissions enabled or disabled.

If the WP CubePoints plugin and the SP CubePoints Integration plugin are active

  • New entries “Points for creating a poll:”, “Points for voting in a poll:”, and “Points for user’s poll getting a vote:” on the SP “CubePoints Integration” forum Admin panel where points in the CubePoint System can be assigned for poll activities in forums.
    • The SP “CubePoints Integration” forum Admin panel can be accessed from the Admin menu at:
      • Forum > Plugins > Available Plugins > CubePoints Integration > Options
      • Forum > Components > CubePoints

If the WP myCRED plugin and the SP myCred Integration plugin are active

  • New entries “… for Creating a Poll:”, “…for Voting in a Poll:”, and “…for your Poll receiving Votes” and their respective log messages on the WP “Simple:Press Extension” WP Admin panel where points in the myCRED System and WP myCRED log entries can be assigned for poll activities in forums.
    • The “Simple:Press Extension” WP Admin panel can be accessed from the Admin menu at:
      • myCRED > Hooks > Simple:Press Extensions

Plugin Requirements

If forum polling activities are to be awarded points in the WordPress (WP) CubePoints system, the WP CubePoints plugin and the Simple:Press (SP) Cubepoints Integration plugin must be active on the site.

  • Please see the SP Codex page Plugin: CubePoints Integration for details of downloading, installing, and setting up that SP plugin and information on the WP plugin.

If forum polling activities are to be awarded points in the WordPress (WP) myCRED system, the WP myCRED plugin and the SP myCred Integration plugin must be active on the site.

  • Please see the SP Codex page Plugin: myCred Integration for details of downloading, installing, and setting up that SP plugin and information on the WP plugin.

Simple:Press version 5.6.2 and above is required.

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

As part of the installation, a “Polls” 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, uninstalled, deleted, or its options set using its “Activate/Delete” and “Deactivate/Uninstall/Options” selections.

  • The Options link goes to the new “Polls – Options” forum Admin panel with its many sections.

The “Enable polls on this forum” entry in the “Extended Forum Options” section of the forum’s “Forums – Manage Groups and Forums” Admin panel must be enabled in each forum to be allowed to have polls in its posts.

There are two (2) new permissions added to the permission sets due to this plugin.

  • Can create a forum poll within a post
  • Can vote in a forum poll within a post

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

Plugin Installation and Activation

For any supporting SP plugin to be installed and activated, please see that plugin’s SP Codex page.

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 “polls“.
  • 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 “polls.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 Polls plugin and click on “Activate”. The “Activate/Delete” label changes to “Deactivate/Uninstall/Options” with a “Getting 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”.
To re-activated the plugin, click on on “Activate”. The “Activate/Delete” label changes to “Deactivate/Uninstall/Options”.

Plugin Administrative Options

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

Note:
Options are selected or deselected as follows:
Single check box items:

  • Clicking a check box without a green check mark selects that option and puts a green check mark in the box.
  • Clicking a check box containing a green check mark deselects that option, and removes the green check mark.

Multiple check box items:

  • Clicking a check box not containing a green check mark selects that option, puts a green check mark in that check box, and if there was a previously selected check box, deselects it and removes the green check mark from it.
    • Setting Up “Options” Section
      • Go to the “Options” section of the Admin panel.
        • Please click on the section’s “Help” link for more information on this section’s feature(s).
      • Click the check box to the left of “Restrict new poll creation to new topics” to select this option. Otherwise polls can be created in any post in the topic.
      • Put in the integer number of MONTHS the poll is to be open in the data input box to the right of “Default number of months to run poll (0 for 25 expiration):” to define the poll run time if the poll creator does not specify a different duration.
        • The plugin’s default value is 25 months.
Warning:
A poll creator CANNOT terminate a poll early unless they have the ability to “Manage Polls” which is generally reserved for forum Admins or possibly forum Moderators. Please select the DEFAULT poll run time wisely.
      • Click the check box to the left of “Allow poll results to be hidden” to select this option. This gives the poll creator a choice of whether or not to hide the poll results until the poll expires. After the poll expires, the results are visible in the post.
      • In the text input box below “Hidden poll results message” input the message to be displayed after a forum user votes in a poll with results being hidden.
        • The default is, “Thank you for voting. Poll results will be available when the poll has closed.”
      • If there are no other options in the section or other sections to select, click on the “Update” button at the bottom of the panel to save the selection.
      • Otherwise, continue making selections.

 

    • Setting Up “Tracking Options” Section
      • Go to the “Tracking Options” section of the Admin panel.
Note:
If using cookies and/or IP, different users will not be able to vote from the same machine.
        • The Tracking Options are:
        • None
        • Cookie
        • IP
        • Cookie and IP
        • User ID
      • In the data input box to the right of “Cookie expiration in seconds, if using (0 = disable):” input the integer number of seconds for cookie expiration.
        • The default is “0” which disables cookie expiration.
      • If there are no other options in the section or other sections to select, click on the “Update” button at the bottom of the panel to save the selection.
      • Otherwise, continue making selections.

 

    • Setting Up “Answer Sorting” Section
      • Go to the “Answer Sorting” section of the Admin panel.
        • Please click on the section’s “Help” link for more information on this section’s feature(s).

Select sort criteria for displaying poll answers:

      • Click the check box to the left of the one (1) sort criteria option desired.
        • The Sort Criteria options are:
        • Answer creation order
        • Alphanumeric
        • Random

Select sort order for displaying poll answers:

      • Click the check box to the left of the one (1) sort order option desired.
        • The Sort Order options are:
        • Ascending
        • Descending
      • If there are no other options in the section or other sections to select, click on the “Update” button at the bottom of the panel to save the selection.
      • Otherwise, continue making selections.

 

    • Setting Up “Results Sorting” Section
      • Go to the “Results Sorting” section of the Admin panel.
        • Please click on the section’s “Help” link for more information on this section’s feature(s).

Select sort criteria for displaying poll results:

      • Click the check box to the left of the one (1) sort criteria option desired.
        • The Sort Criteria options are:
        • Answer creation order
        • Alphanumeric
        • Votes
        • Random

Select sort order for displaying poll results:

      • Click the check box to the left of the one (1) sort order option desired.
        • The Sort Order options are:
        • Ascending
        • Descending
      • If there are no other options in the section or other sections to select, click on the “Update” button at the bottom of the panel to save the selection.
      • Otherwise, continue making selections.

 

    • Setting Up “Results Display” Section
      • Go to the “Results Display” section of the Admin panel.
        • Please click on the section’s “Help” link for more information on this section’s feature(s).

Poll results bar background color:

      • Select the background color for the results bar(s) in the poll by one of these methods:
        • Inputting the desired color’s hex code after the “#” in the bar beneath “Poll results bar background color:”

OR

      • The combination of:
      • Placing the cursor over the small circle within the “Color Circle” and moving the small circle around for the basic color, and
      • Placing the cursor over the small circle within the “Color Box” and moving the small circle around for the exact color.
    • The default value is #7ca6d8

Poll results bar border color:

      • Select the border color for the results bar(s) in the poll by one of these methods:
        • Inputting the desired color’s hex code after the “#” in the bar beneath “Poll results bar border color:”

OR

      • The combination of:
      • Placing the cursor over the small circle within the “Color Circle” and moving the small circle around for the basic color, and
      • Placing the cursor over the small circle within the “Color Box” and moving the small circle around for the exact color.
    • The default value is #003562
    • If there are no other options in the section or other sections to select, click on the “Update” button at the bottom of the panel to save the selection.
    • Otherwise, continue making selections.

Each Forum to be allowed polls must have the capability enabled. From the Forum Admin menu on the left of admin pages, select Forums > Manage Groups And Forums to see the list of groups and forums within the groups to select forums in which to allow polls.

  • Enable Ability To Have Polls in a Forum
    Note:
    This option is also available on the new forum creation form to allow polls in new forums.
    • Allowing polls in a forum is controlled by the forum Admin.
    • Each forum that is to have this ability must have the permission turned on.
    • This is accomplished from the Simple:Press Administration panel forum Admin menu by clicking/opening Forums > Manage Groups And Forums, then clicking on the “Edit This Forum” button associated within the forum to be given the permission to view the forum’s “Forum – Manage Groups and Forums” forum Admin panel.
    • Scroll down the panel to the “Extended Forum Options” section.
    • Click the check box next to “Enable polls on this forum” to set/enable the permission. When enabled, the check box contains a green check mark.
    • If there are no other forum permissions to set, click the “Update Forum” button 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 forum to have this permission.

Each forum Admin or Moderator who is to have the ability to “Manage Polls” must have that ability enabled. From the Forum Admin menu on the left of admin pages, select Forum > Admins > Manage Admins to see the current list of forum Admin and Moderators.

Warning:
A poll creator CANNOT terminate a poll early or modify the poll unless they have the ability to “Manage Polls” which is generally reserved for forum Admins or possibly forum Moderators. Select the forum Admins and Moderators who can manage polls with care.
Note:
New forum Admins can be added from the Forum Admin menu at Forum > Admins > Manage Admins using the “Manage Admins – Add Admins” Forum Admin panel by selecting the member from the “Eligible Member” list, clicking the “Move to Selected List” button, clicking in the capability check boxes to give capabilities to the new admin (“Manage Polls, in particular), and clicking the “Add New Admins” button.New forum Moderators can be added from the Forum Admin menu at Forum > User Groups > Manage User Groups by clicking the “Add New” button for the “Moderators” user group, selecting the member from the “Eligible Member” list, clicking the “Move to Selected List” button, and clicking the “Add Members” button.
    • Enable the Ability to “Manage Polls”
      • Go to the “Current Admins and Moderators” section of the Admin panel.
        • Please click on the section’s “Help” link for more information on this section’s feature(s).
Note:
Please read the “Help” paragraphs closely to understand the “back end” or “front end” capabilities given even if “Manage Polls” is the only manage tasks being allowed.
    • Find the sub-section showing the available manage options for the forum Admin or Moderator to have the ability to “Manage Polls”.
    • If not already a green check mark in the check box to the left of “Manage Polls”, click on the check box to select it.
      • A check box is selected if it contains a green check mark.
    • If there are no other forum Admins or Moderators to be allowed to manage polls, click on the “Update Admin Capabilities” button at the bottom of the “Current Admins and Moderators” section to save the setting.
    • Otherwise repeat the steps for the next forum Admin or Moderator to be allowed to manage polls.

From the Forum Admin menu on the left of admin pages, select Forum > Permissions > Manage Permission Sets to see the permission sets available to select usergroups to have the permission to create polls or vote in polls on new topics posts and possibly reply posts in forums where polls are enabled.

Note:
The ability for users to create polls in reply posts is selected by the forum Admin in the “Polls – Options” forum Admin panel by deselecting the “Restrict new poll creation to new topics” option.
    • Assigning New Permissions
      • “Can create a forum poll within post” permission
        • Allowing users to create polls in a topic post or possibly a reply post in a forum is controlled by their group permissions.
        • Each usergroup that is to have this ability 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 create a forum poll within post” to set/enable the permission. When enabled, the check box contains a green check mark.
        • If there are no other permissions to set, click the “Update Permission” button at the bottom of the page to have the selection saved. Otherwise continue to the next permission to be selected within the set.
        • 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.

 

    • “Can vote in a forum poll within a post” permission
      • Allowing users to vote in polls in a topic post or possibly a reply post in a forum is controlled by their group permissions.
      • Each usergroup that is to have this ability 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 “General” click the check box next to “Can vote in a forum poll within a post” to set/enable the permission. When enabled, the check box contains a green check mark.
      • If there are no other permissions to set, click the “Update Permission” button at the bottom of the page to have the selection saved. Otherwise continue to the next permission to be selected within the set.
      • 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.

If poll activities in forums are to result in forum users being awarded points in the WP CubePoints System and both required plugins are active, the poll award values must be set up on the SP “CubePoints Integration” forum Admin panel.

    • After activation of the Simple:Press CubePoints Integration plugin,

a)

    • on the aforementioned “Available Plugins – Install Simple:Press Plugins” panel, click “Options” on the

CubePoints Integration

    • plugin section or

b)

    • under the

Components

    • entry on the forum menu on the left side forum admin page click the

CubePoints

    • sub-menu item to get the “

CubePoints Integration

    ” Admin panel with its “CubePoints Options” section.
  • Go to the “CubePoints Options” section of the Admin panel.
    • Please click on the section’s “Help” link for more information on this section’s feature(s).
Note:
If points are not be be awarded for an activity, put in zero (0) or leave the input box ‘blank’.
  • In the data input box to the right of “Points for creating a poll:” enter the integer number of points to award for this activity in the forum.
  • In the data input box to the right of “Points for voting in a poll:” enter the integer number of points to award for this activity in the forum.
  • In the data input box to the right of “Points for users poll getting a vote:” enter the integer number of points to award for this activity in the forum.
  • If there are no other options to select in the panel, click on the “Update” button at the bottom of the panel to save the settings. Otherwise, go on to specify the additional options.

If poll activities in forums are to result in forum users being awarded points in the WP MyCRED System and both required plugins are active, the poll award values must be set up on the WP “Simple:Press Extensions” forum Admin panel.

    • After activation of the Simple:Press MyCred Integration plugin,

a)

    • on the aforementioned “Available Plugins – Install Simple:Press Plugins” panel, click “Options” on the

MyCred Integration

    • plugin section or

b)

    • in the WP Admin menu under the

myCRED

    • entry on the left side of the WP admin page click the

Hooks

    • sub-menu item to get the “

myCRED Hooks

    ” Admin panel with its “Simple:Press Extensions” menu item.
    • Click on the “Simple:Press Extensions” menu item or icon to see the “Award/deduct points for various Simple:Press actions” drop down expansion that includes the MyCRED points for poll activities.
      • Be sure to select the check box to the right of “Enable” so the forum poll activities will be counted in the WP MyCRED System.
        • The check box is selected if there is a “check mark” in the check box.
Note:
If points are not be be awarded for an activity listed below, put in zero (0) or leave the input box ‘blank’.
    • In the data input box to the right of “…for Creating a Poll” enter the integer number of points to award for this activity in the forum.
    • In the data input box below “Log template“, enter the message to be displayed in the WP MyCRED log when points are awarded for creating a forum poll.
    • In the data input box to the right of “… for Voting in a Poll” enter the integer number of points to award for this activity in the forum.
    • In the data input box below “Log template“, enter the message to be displayed in the WP MyCRED log when points are awarded for voting in a forum poll.
    • In the data input box to the right of “… for your Poll receiving Votes” enter the integer number of points to award for this activity in the forum.
    • In the data input box below “Log template“, enter the message to be displayed in the WP MyCRED log when points are awarded for a user’s poll receiving votes.
    • If there are no other options to select in the panel, click on the “Update Changes” button at the bottom of the panel to save the settings. Otherwise, go on to specify the additional options.

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 Polls 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 “Polls” 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 “Polls” 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 moderators with the “Manage Polls” capability can review, edit, close (make “inactive”), or delete polls.

    • Managing and Viewing Polls
    • From the WP Admin menu select Forum > Polls > Manage Polls to see the “Polls – Polls Stats” forum Admin panel.
      • Reviewing Poll Statistics
      • Go to the “Stats” section of the forum Admin panel.
      • The following poll statistics are displayed:
        • Number of Polls: – the number of polls currently in the forum.
        • Number of active polls: – the number of polls currently active in the forum.
        • Number votes cast: – the total number of votes that have been cast in the forum polls.
        • Number of voters: – the number of voters who have cast votes in forum polls.

 

      • Viewing Poll Characteristics
      • Go to the “Polls” section of the forum Admin panel.
        • Please click on the section’s “Help” link for more information on this section’s feature(s).
Note:
The filter settings below are remembered while on the panel. To clear any filters (searches or polls/page), click on the “Show all polls” link in this section to show all polls.
      • The polls can be searched by Poll Question by putting the specific poll question in the text input box to the left of “Search Poll Questions” and then clicking the “Search Poll Questions” button.
      • The number of polls displayed on each page of this panel can be set by clicking on the down arrowhead to the right of “Polls per page:”, selecting the desired number from the drop down menu, and clicking the associated “Apply” button.
      • The following specifics are displayed for each poll in the forum:
        • Poll ID – the integer number identifying the poll.
        • Question – the poll question.
        • #Votes – the number of votes cast in the poll.
        • #Voters – the number of voters casting votes in the poll.
        • Start Date – the start date of the poll.
        • Expiration Date – the expiration date of the poll.
        • Hidden Results – the flag indicating if the results are being hidden until the poll expires.
        • Status – active or inactive (expired/closed).
        • Manage – the three (3) icons when clicked allow Viewing Poll Logs, Editing a Poll, and Deleting a Poll (see Managing Individual Poll immediately below).

         

      • Managing Individual Poll
      • Go to the “Polls” section of the forum Admin panel.
        • Please click on the section’s “Help” link for more information on this section’s feature(s).
      • Under the “Manage” column for each poll there are three (3) icons with links to additional poll admin sub-panels.
          • Viewing Poll Logs
          • Click on the first (1st) icon to see the message “Poll Log” and then to view the “Poll Logs” sub-panel for the poll.
            • The poll logs will appear in a new section below the list of polls.
        Note:
        The filter setting below are remembered while on the panel. To clear any filters (search or logs/page), click on the “Show all polls” link in the “Polls” section and reload the “Poll Logs” page by clicking the “Poll Log” icon for the poll again.
          • The logs can be filtered by answers by clicking on the down arrowhead to the right of “Filter by answer:”, selecting the desired answer from the drop down menu, and clicking the associated “Apply” button.
          • The number of logs on a page can be set by clicking on the down arrowhead to the right of “Log entries per page:”, selecting the desired number from the drop down menu, and clicking the associated “Apply” button.
          • The entries shown for each log are:
            • Answer – the answer selected in the poll.
            • User ID – the ID (user display name) of the user voting in the poll.
            • Date – the date the vote was cast.
            • IP – the IP address used when voting.
            • Manage – the individual poll log can be deleted by clicking on the icon for the log.
        Note:
        Removing the poll log files DOES NOT change the poll results.
          • All the logs for a poll can be deleted by clicking on the “Delete ALL Logs for this Poll” button.

         

          • Editing A Poll
          • Click on the second (2nd) icon to see the message “Edit Poll” and then to view the “Poll Edit” sub-panel the poll.
            • The poll information will appear in a new section below the list of polls.
        Note:
        If new answers are added and given votes or vote counts adjusted, consider whether or not the number of poll voters needs to be adjusted manually to keep the poll consistent.

        • The voter count cannot be done automatically because it is possible that forum users are being allowed to vote multiple times or being allowed multiple answers per vote.

        The total vote count will be auto calculated base on the sum of the answer votes.

    • The individual poll entries can be edited by inputting the desired information in the input box associated with each listed poll characteristic and clicking the “Save Poll” button. The individual poll entries are:
      • The poll question.
      • Each poll answer.
      • Each poll answer’s number of votes.
      • Poll voters – the number of poll voters.
      • Poll date – the poll’s creation date.
      • Poll expiration – the poll’s expiration date.
      • Poll creator – the poll creator’s forum User ID number.
      • Poll max answers – the number of answers that can be selected for each voting session.
    • Another Answer can be added by clicking the “Add an Answer” button to obtain a blank answer row, putting in the new answer in the text input box, and clicking the “Save Poll” button.
    • A check mark in the check box to the left of “Hide results until poll closed” causes the polls results to be hidden while the poll is active.
      • Clicking on the check box containing a check mark will remove the check mark and cause the results to be made visible during the poll after the “Save Poll” button is clicked.
    • A check mark in the check box to the left of “Poll Active” causes the poll to be active and allow continued voting.
      • Clicking on the check box containing a check mark will remove the check mark and cause the poll to end thus ending the voting and changing the poll’s status to “Inactive” after the “Save Poll” button is clicked.

 

    • Deleting A Poll
    • Click on the third (3rd) icon to delete the poll.
    • A popup box appears asking “Are you sure you want to delete this poll?”
      • Click the “OK” button to delete the poll. If the poll is deleted:
        • Its information is removed from the forum Admin panels including its contribution to the overall poll statistics.
        • The forum post originating the poll remains, but the poll information in the post is replaced with the banner “Poll ID invalid”.
Note:
Although not required, it is suggested that the post having its poll deleted be edited or be removed from the forum.

Forum Admins, Moderators, and forum Users with the “Can create a forum poll within a post” permission can create a poll within a forum post in forums where polls are allowed.

    • Creating A Poll in a Forum Post
Note:
If the “Restrict new poll creation to new topics” is selected by the forum Admin in the “Options” section of the “Polls – Options” forum Admin panel, the “Poll” button will not be present in the “Add Reply” post form.
      • Go to the forum / topic of interest and click on the “Add Topic” button OR go to the topic of interest and click on the “Add Reply” button to display the Add Topic form or the Add Reply form, respectively.
      • At some point during creation of the post, click on the “Poll” button in the options section of the form below the post text section to have the “Add A Poll” popup displayed.
      • In the appropriate text boxes enter the poll Question, all poll answers, and the maximum number of answers per vote.
        • An example of a question might be, “What is your favorite Pizza Topping?
        • Examples of individual answers might be, “Pepperoni”, “Sausage”, “Mushrooms”, “Anchovies”.
          • The “ADD AN ANSWER” button is clicked to allow adding additional answers above the basic two (2), one at a time.
        • An example for number of answers per vote might be, “3” allowing any 3 of the 4 topping possibilities to be selected.
      • Click in the input box below “Poll Expiration (Leave Blank for No Expiration)” to display the popup calendar where the date for ending the poll can be selected.
        • If poll results are to be hidden during the polling period, the date selected MUST be in the future.
          • The poll results will be shown on the post after the poll has expired.
        • No additional voting is allowed after the poll expiration date (date and time of day).
Warning:
A poll creator CANNOT terminate a poll early or modify the poll unless they have the ability to “Manage Polls” which is generally reserved for forum Admins or possibly forum Moderators.

  • The poll creator should select the poll expiration with care especially if the poll results are to be hidden until the poll closes.
  • The poll creator should be prepared to contact the forum Admin or an appropriate forum Moderator if the poll needs to close before the expiration date specified.
        • Leaving the date field blank will result in the poll being open for the number of months specified by the forum Admin on the “Poll – Options” forum Admin panel.
          • If the forum Admin has not specified a duration the poll will be open for the default “25 months”.
      • Click on the check box to the right of “Hide Poll Results Until Closed” if the poll results are to be hidden until the poll is closed.
        • The check box is selected if there is a green check mark in the check box.
        • Clicking on the check box containing a green check mark deselects the check box and removes the check mark.
      • Click on the “Create Poll” button when the inputs are complete to save the poll information and return to the post creation form.
        • Displayed in the post will be something similar to [[sp_show_poll id=”1″]] which identifies the poll shortcode.
Note:
To use the same poll in other forums, copy the poll shortcode, in this example [[sp_show_poll id=”1″]] (without the MOST outside brackets), before submitting the post, then paste the shortcode into a new post in other forums (one at a time) after submitting the original post.

  • The votes from those posts in all forums will be added together in the results.
  • The combined results will be shown or hidden in each forum consistent with the selection made on the original poll at creation.
      • The poll question and possible answers will not be displayed until the post is submitted.
    • When the post is complete, click on the “Submit Topic” button or “Submit Reply” button, respectively, to save the post and display the poll question with possible answers.
      • At this time the poll originator can vote in the poll or can wait until a later time to vote.

Forum Admins, Moderators, and forum Users with the “Can vote in a forum poll within a post” permission can vote in forum polls.

    • Voting in a Forum Poll
      • Go to the forum post of interest that contains a poll.
      • The poll question and the available poll answers are displayed.
      • If the results are not being hidden and if desired, click on the “View Poll Results” to view the existing results before the logged in user votes.
        • Click on “Vote in Poll” on the results page to get back to the poll with its available answers.
      • Click in the check box or check boxes associated with the desired answers up to the maximum number of answers allowed.
Note:
When clicking the “Vote” button if more answers have been selected that are allowed, a popup window displays “You have entered more than the maximum allowed votes”.

  • Click “OK” to return to the poll post and reduce the number of answers selected until they are less than or equal to the allowed number.
  • The logged in user has not actually voted until the results after the logged in user’s vote are shown or the below message is displayed (depending on whether or not poll results are being hidden).
    • Click on the “Vote” button to save the vote selections.
    • If the results are being displayed, the results including the current forum user’s selection(s) will be display.
    • If the results are not being displayed, the message, “Thank you for voting. Poll results will be available when the poll has closed.” is displayed on the post.

If poll activities in forums are resulting in forum users being awarded points in the WP CubePoints System and both required plugins are active, the Admin can view the poll award transactions in the WP Admin “CubePoints – Log” panel.

  • The “CubePoints – Log” WP Admin panel can be access from the WP Admin menu at CubePoints > Logs.
  • Please see the SP Codex page Plugin: CubePoints Integration for more information regarding the SP CubePoints Integration plugin and a pointer to information on the WP CubePoints plugin.

If poll activities in forums are resulting in forum users being awarded points in the WP MyCRED System and both required plugins are active, the Admin can view the poll award transactions in the WP Admin “MyCRED Log” panel.

  • The “MyCRED Log” WP Admin panel can be access from the WP Admin menu at MyCRED > Log.
  • Please see the SP Codex page Plugin: myCred Integration for more information regarding the SP myCred Integration plugin and a pointer to information on the WP MyCRED plugin.

Plugin Special Notes

None

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 other Actions and Hooks available in this plugin to modify aspects of this plugin.
In file ‘sp-polls-admin-options.php‘:

  • do_action(‘sph_polls_admin_left_panel’) – Hook fired after the left admin panel on the “Polls – Options” panel is set up. Allows modification before the left panel is output.
  • do_action(‘sph_polls_admin_right_panel’) – Hook fired after the right admin panel on the “Polls – Options” panel is set up. Allows modification before the right panel is output.

In file ‘sp-polls-ahah-manage.php‘:

  • do_action(‘sph_poll_created’, $response, $spThisUser->ID) – Hook fired after the poll has been created. Allows modification before the response is returned.
  • do_action(‘sph_poll_voted’, $poll_id, $spThisUser->ID, $poll->user_id) – Hook fired after a user has voted and the results have been displayed.

In file ‘sp-polls-components.php‘:

  • apply_filters(‘sph_sph_polls_vote_percent’, $percent, $poll, $answer) – Allows modification of the “%” results for poll answers before the results are displayed.

Plugin and Template Tag Changelog

Since Simple:Press version 5.1.2.

Codex page sync’d to code version 5.6.8 and plugin version 1.5.18.

More Topics In SimplePress: Plugins


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