Volunteer Sign Up Sheets Customizer documentation

The Volunteer Sign Up Sheets Customizer plugin is an extension for the free Volunteer Sign Up Sheets plugin, that allows you to modify most of the public side text that the main plugin generates, as well as easily changing styles for the sheet and task/signups list tables, and error/success messages.

GENERAL INFO

Features

  • Modify or Disable all the Public Text strings output by the main plugin.
  • Table header text that you modify can also be applied to the admin side lists of signups, so your custom text can be used in exporting or printing
  • Choose from Default, Compact, or Custom layout styles for public side list tables
  • For Custom layouts, you can specify font size, cell padding, border size and color, filled row background color, as well as background & text colors for error and success messages

Overview

This plugin lets you easily modify, or even disable, most of the public side text that the main plugin generates, without having to setup custom translation files or using PHP code snippets. Version 2 adds layout options with default, compact, and custom layout styles. Default doesn’t change anything (uses styles from main plugin, or your own manual styles if you disable the main plugin’s CSS). Compact makes the font size and cell padding smaller on the public side list tables to allow you to fit more columns/info in one row (especially helpful for themes with large default font sizes). Custom allows you to specify your own parameters for font size, cell padding, border size and color, filled row background color, as well as background & text colors for error and success messages. The Custom Styles work with either the original Table layout view, or the newer table styled Divs layout.

CUSTOMIZER SETTINGS

Customizer Page

A new submenu page is added to the Sign-up Sheets menu called “Customizer”. This page is where you will find all the settings for the Customizer. The page is split into 3 tabs:

  • Public Text – This section is where you can modify, or disable, just about any public side text generated by the main plugin
  • Settings – This section has general options, as well as the Layout Settings
  • License – This section contains the license form to activate your license for the plugin.

Changing or Disabling Public Text

In the public text section, you will see a long list table of all the public side text you can modify.

The first column shows the “Filter ID” tag (used in the WordPress PHP filter hook), which is unique for each text string output on the public side.

The second column shows the “Screen” where that text appears, which can include: “Main Sheets List”, “Sheet Details”, “Sign Up Form”, and “Multiple” (for text that appears in more than one “Screen” location).

The third column contains a text input box, which is blank by default. Underneath each text input is a longer description of where the text appears, as well as the Default value that the plugin outputs. If you want to change the text shown on the public side, enter the text you want shown in the text input for that text string, and then scroll to the bottom of the table and hit “Submit”.

The fourth column is a Check Box input that you can use to disable the output of that text. Since an empty value in the text input will result in the default text being shown, you check the check box if you do not want anything to show for that particular text string.

The last column shows any Variables used within the text string, such as the number of remaining slots for a task. It’s empty for most text strings that don’t show any variable values. For those that do have a variable, you use XXXX as a placeholder in your custom text to indicate where you want that variable’s value shown. For example for the text that shows the number of slots remaining for a task (when consolidating open slots), the default value is: XXXX Remaining. But, you could change it to something like: Only XXXX positions left!

Settings Tab and Layout/Style Settings

As of right now, there is only one “Setting” on this page: Modify Admin Table Headers?  Checking the box for this setting will modify the text on the Admin side for any signups table headers you changed in the Public Text settings, such as Start Time and End Time for start and end time headers. You may want these to be changed when you are going to export or print out the list of signups using those features of the DataTables display added in version 3 of the main plugin.

Below that single setting checkbox, there will be a select box for Layout Style. If you leave this set to default, the main plugin’s CSS file will be used for the public side table lists, if you haven’t already disabled CSS in the main plugin and replaced it with your own. The second option is “Compact”, which uses the same default CSS as the main plugin, but makes the font size “smaller” and decreases the cell padding amount for the table cells and divs. This allows you to squeeze additional columns into your limited screen space, especially if additional columns are being added to the public display via the Custom Fields or Groups plugin.

The third layout option is “Custom”. If you select that, you’ll see additional fields revealed that allow you to set various properties and colors for the public side display, which should all be self-explanatory. Note that these layout options will apply to both the original table html layout, as well as the newer divs layout, of the main plugin.

In addition, if you have NOT disabled the main plugin’s CSS, you will see a notice about that above the select box. It is highly recommended that you disable the main plugin’s CSS file if you are going to use either the “Compact” or “Custom” layout options offered by the Customizer… this will avoid conflicts and redundant CSS.

License

The final tab of the Customizer admin page has a simple form for entering your license key and activating your license. Although the plugin will operate just fine without the license being activated, you need an active license in order to do automatic updates of the plugin, as well as to receive support.