Simple:Press Documentation

Plugin: Timezone On Registration

Plugin Description

Plugin: Timezone On Registration – This Simple:Press plugin allows new forum users to set their timezone when registering.

Plugin Features

Installing this Simple:Press plugin adds:

  • A new “Timezone On Registration” 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 plugin can be activated, or deleted by the admin.
  • When properly installed, a new folder in the forum plugin folder named “timezone” containing this plugin’s files.

Activating this plugin provides:

  • A change to the new “Timezone On Registration” section in the “Available Plugins – Install Simple:Press Plugins” panel under the Admin menu path Forum > Plugins > Available Plugins so the plugin can be deactivated or uninstalled.
    • There are no options associated with this plugin.
    • The “Getting Started” link should be selected to view the pertinent information regarding the plugin.
  • On the WordPress Registration page, a new “Select Your Timezone” entry along with a timezone drop down menu where the new forum users can select their timezone when they register.

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

Plugin Requirements

Simple:Press version 5.5.7 and above is required.

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

  • As part of the installation, a “Timezone On Registration” section is added to the “Available Plugins – Install Simple:Press Plugins” panel under the admin menu Forum > Plugins > Available Plugins. From this panel the plugin can be activated, deactivated, uninstalled or deleted using its “Activate/Delete” and “Deactivate/Uninstall” selections.
    • There are no options associated with this plugin.

There are no new 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 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 “timezone“.
  • 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 “timezone.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 “Timezone On Registration” plugin and click on “Activate”. The “Activate/Delete” label changes to “Deactivate/Uninstall” with a “Get Started” Link.

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

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

Plugin Administrative Options

There are no administrative options with this plugin.

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 Timezone Registration 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 “Timezone Registration” 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 “Timezone Registration” 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

New forum users can select their timezone when registering.

  • New Forum User Setting the Timezone On Registation
    • Click on the “Register” button in the header of the forum page.
      • If the “Registration policy” page comes up, read the policy and then, if necessary, accept the policy by clicking the check box to the left of “Accept policy to register” to select it.
        • The check box is selected if it has a green check mark in it.
      • Click the “Register” button on the “Registration policy” page to continue to the registration form.
    • Fill out the registration form “Username”, and “E-mail” sections.
    • Under the “Select Your Timezone” heading, click on the down arrowhead to the right of current timezone in the timezone box to display the drop down menu having the world timezone options.
    • Scroll down the list to select the desired timezone by causing it to be highlighted and to replace the original timezone in the timezone box.
    • Input the answer to the math question in the associated text input box.
    • Click the “Register” button on the Registration Page to register.

Plugin Special Notes

Although not part of this plugin:

  • A user’s timezone can be seen on the “Profile” tab on the user’s “Profile” page by clicking the “Profile” button in the header of the forum page.
  • Users Changing Their Timezone
    • From the forum page, click on the “Profile” button in the page header for the users see their profile page.
    • Click on the “Options” tab to have option sub-tabs displayed which include an “Edit Display Options” sub-tab.
    • Click on the “Edit Display Options” sub-tab to see the user’s Display Option Preferences.
    • To the right of “Select your Timezone:” click on the down arrowhead to the right of the current timezone in the timezone box to display the drop down menu having the world timezone options.
    • Scroll down the list to select the desired timezone by causing it to be highlighted and to replace the original timezone in the timezone box.
    • Click on the “Update Display Options” button at the bottom of the page to save the selection.

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.7.

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

More Topics In SimplePress: Plugins


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