Field Buttons

From TNG_Wiki
Revision as of 01:48, 20 August 2019 by Robinrichm (talk | contribs) (Mod version 3)

Jump to: navigation, search
Field Buttons
Summary This strictly optional utility mod installs a Javascript library that supports "Field Buttons" that are placed in HTML forms by other mods.
Validation
Mod Updated 18 Aug 2019
Download link
Beta: v12.0.0.3
TNG 12.0
v12.0.0.2
TNG 12.0
Download stats
Author(s) Robin Richmond
Homepage Robin Richmond's Genealogy Database
Mod Support My Mod Support form or TNG Community Forums
Contact Developer My Mod Support form
Latest Mod v12.0.0.3
Min TNG V 10.1
Max TNG V at least 12.1
Files modified
Modifies admin_genconfig.php, admin_updateconfig.php, genstyle.css, English cust_text.php;
Installs js/fieldbuttonsmod.js
Related Mods
Notes
This is a utility mod that supports other mods, but is not required by them.


Purpose of the Mod

To support the use of configurable "Field Buttons" by other mods, by installing

  • A Javascript library that is used by various TNG programs only if this mod has been installed, and
  • A mod option that control whether each type of field button is active.

This mod is needed only if a TNG site administrator,

  • Installs at least one mod that places Field Buttons in HTML forms, and
  • Wants to see Field Buttons in forms.

That is, if this mod has not been installed, no errors will occur; Field Buttons that have been defined by various other mods will simply not appear.

The buttons are configurable in that

  • The one-character labels for the field buttons are defined in cust_text.php, and can be changed for different languages.
    • The button labels change be changed - even given multple-character labels - by overriding the button definition string ($admtext['rrfb-buttonlabels']) in the English cust_text.php files
  • Any of the four types of field buttons can be disabled through a mod option at Admin >> Setup >> General Settings >> Robin's Mods. (See documentation of this new subform)

Field Buttons

Field Buttons are hyperlinks formatted as buttons, that act as shortcuts to common editing tasks. With a single click on a field button, a particular value to will be assigned to the "attached" form field. There are four types of field buttons:

  • X - Clear the field
  • R - Reset/Reload the initial value; the value that was in place when the form was loaded.
  • D - Default; Set the value to a default that was defined elsewhere, such as by a TNG system parameter or Mod Manager option.
  • A - Set an 'All items' value. (At this writing, A buttons have been used only with "Results Per Page" fields on search forms)

Note that it would be very rare for all four buttons to be attached to one form field. Only the applicable buttons should be attached to any given form field.

The four letters X, R, D, and A are used in documentation and in code to identify the field buttons, and they are the default on-screen labels for the buttons. But the labels are configurable through a translation string. In addition, a set of four fields in the Admin >> Setup >> General Settings >> Miscellaneous screen allow individual buttons to be suppressed in all forms on the TNG site.

Buttons are "attached" to a form field in that

  • They follow it without intervening spaces, and the form field and its field buttons are wrapped by a tag that doesn't allow line breaks, and
  • The buttons' field names are based on the fieldname of the field that they are attached to. The buttons' field names are essentially what causes them to modify their form field.

Visualizations

This screen clip illustrates 5 field buttons on 2 fields in the Admin>>Reports program that has been modified by the Admin_Reports_Search mod.

  1. The search field has X and R buttons. There is no meaning in the search field to a default value (remember, the initial value is covered by the R button) or an "all items" value (which would just be an empty search field).
  2. The 'Results per page" field has R, D, and A buttons.
    • You never want an empty 'Result per page' field, so there is no X Button.
    • The R button restores the initial value - the value that was present when the form was loaded.
    • The D button sets a default value, which, in this case, is the TNG system variable $maxsearchresults.
    • The A button sets a value that represents 'All Items'. That value is the word 'all' (or its translation).

Fieldbuttons-fig1.jpg

Note that

  • the X button is not needed when a field value is already empty,
  • the R button is not needed when the current value is the initial value,
  • the D button is not needed when current value is the default value, and
  • the R button is not needed when the current value is the 'All Items' value.

When a button is not needed, it is shaded out, but still physically present on the screen.

We can tell just by looking a the screen clip above that is does not represent the initial state of a form, because we can see the R buttons. R buttons are always shaded out when the form is first loaded, because, by definition, the form field values when the form is loaded are the initial values. Here's what the same form might look like when first loaded, if the search value is empty, and the Results per page value is the site default value (in this case, 30).
Fieldbuttons-fig2.jpg
The search field's R and X buttons are both shaded out, but still present (and barely visible). The 'Results per page' field's R and D buttons are also shaded out, and only its A button is visible.

If the user enters the search string "children", and click on the A button, we'll see this:
Fieldbuttons-fig3.jpg
where the search field's X button is visible because the search field has a non-empty value, both R buttons are visible because both fields have changed, and the 'Results per page' field's D button is visible because the field's value is not the default of 30. Now, only the A button is shaded out.

If the X button is clicked, it will disappear, as will the value in the attached field:
Fieldbuttons-fig4.jpg

If we then do a search, the next page will look like this:
Fieldbuttons-fig5.jpg which is very similar to figure 3.

Another Field Buttons example: The Mod Comparison Report kickoff form, just after being loaded, showing three fields that have X, R, and D buttons. (All three have default values that are defined by the Mod Manager Options.)
  • In the 'Author to search for field', the default value is being displayed, and it is not empty, so X is visible, and R and D are hidden.
  • In the 'Include mods whose names contain' field, the default value is empty and is being displayed, so all three buttons are hidden.
  • In the 'Exclude mods whose names contain' field, the value being displayed is not the default, and is not empty, so X and D are displayed, but, as is always the case when a form has just been displayed, D is hidden.

Fieldbuttons-after.jpg

The Admin>>Setup>>General Settings>>Miscellaneous Form after the Field Buttons mod has been installed. The four fields define the active status of each of the four types of field button. The four values are saved in one comma-delimited string, typically as '1,1,1,1'.

Fieldbuttons-after-options.jpg
(In truth, I'm not sure that it will ever make sense for just one or two buttons types to be deactivated. Deactivating all four button types has the same effect as uninstalling the mod, but it could be useful to deactivate the field buttons temporarily without having to uninstall and later reinstall the mod.)

Related Mods

Mods that implement Field Buttons include

Compatibility & Dependencies With Other Mods

No mods are strictly dependent on this mod, but there is a functional dependency in that, when other mods define Field Buttons in their HTML forms, this mod must be installed for those field buttons to be visible. No errors will occur if the Field Buttons mod is not installed in conjunction with mods that define Field Buttons. The forms will simple act as if the Field Buttons were not defined in the first place.

Installation

This mod uses the standard installation procedure, though it should be noted that this mod contains a mod subfolder that is shared with other mods that implement the "Inner Mod Menu" and that put their options in Admin >> Setup >> General Settings >> Robin's Mods. As a result, as you unzip or copy the mod, you might get a warning noting that a folder already exists. You can just ignore that warning.

[Show Installation Details]

Requirements

  • A working TNG installation.
  • An installed current version of the Mod Manager.
  • You should backup files listed in the panel on the right.

Procedure

  1. Remove and delete previous version of this mod.
  2. Backup the files updated by this mod. They are listed in the panel at the upper right.
  3. Download the .zip file, Extract its .cfg file to the mods folder.
  4. Follow the normal automated installation for Mod Manager, as shown in the example Mod Manager - Installing Config Files.

Problems?

  1. Try using the Mod Manager Remove capability
  2. Contact me through My Mod Support form.
[Hide Details]

Language Strings

This mod defines several strings for the Admin program that defines my mod options, but two language strings that are used for the operation of field buttons are worth mentioning here.

  • $admtext['rrfb-buttonlabels'] = "X,R,D,A"; defines the four letters that identify the four types of field buttons.
  • $admtext['rrfb-all'] = "all"; defines the value that represents "All Items" to 'Results per page' fields implemented by several options.


Revision History

Mod Version TNG Version Date Note
12.0.0.3 12.0+ 18 Aug 2019 The field buttons behave as they did before, but the Field Buttons API has changed slightly.
  • The previous version allowed (actually, required) some mods to directly access the library's internal variables.
  • The previous version didn't accommodate some situations where changes to HTML form fields should change the state of the form fields' field buttons.
  • Mods written for Field Buttons version 2 can sometimes result in program crashes if the Field Buttons mod is not installed.
  • Mods released before August, 2019 should be able to work with version 3 of the Field Buttons mod.
  • Mods released after August 1, 2019 cannot work with version 2 of the mod.
12.0.0.2 12.0+ 15 May 2018 No functional changes; made compatible with TNGv12.
v10.1.0.2 10.1 - 11.1.2+ 9 Jan 2018 Field buttons can now have multi-character button labels.
10.1.0.1 10.1 - 11.1.2+ 28 Dec 2017 New mod

Sites using this mod

If you download and install this mod, please add your site to the table below.=

URL User Note Mod-Version TNG-Version User-language
Robin Richmond's Genealogy Database Robin Richmond Mod developer 11.0.0.1 11.1.2 English
Cole / Tanner Family Tree David Cole Public/Private see here see here English