Difference between revisions of "Browsemedia Search Form"

From TNG_Wiki
Jump to navigation Jump to search
(TNG14.0.4.4e and relinked TNG14.0.0.4c)
 
Line 45: Line 45:
 
== Related Mods ==
 
== Related Mods ==
 
<ol>
 
<ol>
<li> {{RobinBoilerplate |text=msb}}</li>
+
<li> {{RobinBoilerplate |text=msbmod}
 +
<ul><li>{{RobinBoilerplate |text=msb2}</li>
 +
<li>{{RobinBoilerplate |text=imm}</li>
 
<li> [[Browsemedia Medialinks]] also changes browsemedia.php. [[Browsemedia Medialinks]] focuses on the Media Links column of the search form, whereas Browsemedia Search Form focuses on the search form and the positioning of the search results navigation menu above and below the search results.
 
<li> [[Browsemedia Medialinks]] also changes browsemedia.php. [[Browsemedia Medialinks]] focuses on the Media Links column of the search form, whereas Browsemedia Search Form focuses on the search form and the positioning of the search results navigation menu above and below the search results.
<ul><li>Still, both mods make certain identical tweaks to the search results. As a result of these duplicated changes, if you install both mods, the second mod that you install will cause the first mod to be "Partially  Installed". But uninstalling the second mod restores the first mod to "Installed" status.</li>
+
<ul><li>Acually, both mods make identical changes to the "Links" column in the results table. But they do so by adding stye classes rather than changing the HTML code, and the duplicated style does not cause any problems</li>
 
</ul></li>
 
</ul></li>
 
</ol>
 
</ol>
Line 58: Line 60:
 
==Installation==
 
==Installation==
 
{{RobinBoilerplate |text=language}}
 
{{RobinBoilerplate |text=language}}
 +
=== Files Modified ===
 +
# browsemedia.php - The End-user program that displays media items (for all media collections)
 +
# admin_genconfig.php - The form at Admin>>Setup>>General&nbsp;Settings, which contains all Mod Settings Blocks.
 +
# admin_genconfig.php - The form at Admin>>Setup>>General&nbsp;Settings, which contains all Mod Settings Blocks.
 +
# admin_updateconfig.php - The admin_genconfig.php action script that saves the Admin>>Setup>>General&nbsp;Settings form, including all Mod Settings Blocks
 
{{RobinBoilerplate |text=install}}
 
{{RobinBoilerplate |text=install}}
  

Latest revision as of 17:51, 15 April 2024

Browsemedia Search Form
Summary Adds elements to the search form, moves elements of the search form and page navigation widget so that they are more logically placed. If this mod is installed, you can edit its options.
Validation
Mod Updated 25 Mar 2024
Download link v14.0.4.4e
TNG 14.0.4
v14.0.0.4c
TNG 14.0.3
TNG 14.0
See the Revision History for older versions
Download stats
Author(s) Robin Richmond
Homepage Robinnd's Roots
Mod Support My Mod Support form
Contact Developer My Mod Support form
Latest Mod 14.0.4.4e
Min TNG V 12.0
Max TNG V 14.0.4
Files modified
browsemedia.php, admin_updateconfig.php, admin_genconfig.php
Related Mods
Notes

Purpose of the Mod

  1. To make the layout of the browsemedia.php search form and results table more more like other TNG search pages, and to improve its appearance and usability in small ways:
    1. Moves the tree selection box into the search form.
    2. Moves the page navigation widget out of the search form and positions it above and below the results table.
    3. Moves the "See Gallery" (or ) and Slide Show buttons out of the search form, and positions them below the search form but above the navigation widget.
  2. Other presentation tweaks
    1. Adds a "Tree" column if there is more than one tree and the user has not selected a tree.
    2. Adds a "Collection" drop down box that is just a bit handier the "Media" drop-down menu
    3. Reduces the width of the "Linked To" column, with a style rule that uses "max-width" rather than "width".
    4. Reduces the width of the Headstones "Status" column in the same way.
    5. Adds help text to describe TNG Collections and the Gallery view.

Mod Options

The mod configuration variables for Browsemedia Search Form are

  1. Whether to display a help icon for the search string. The help text describes the searchable fields and TNG Collections.
  2. Whether to display a help icon for the "Galleries" button. The help text describes the differences between thumbnail gallery and the tabular descripive view of search results.

The help icons and help textare illustrated in visualizations below.

These options are defined and edited in a "Mod Settings Block". Each mod that puts it mod configuration variables at Admin>>Setup>>General Settings, in the new subform "Mod Settings Blocks". As with ordinary mod options, the mod settings block is accessible from the Mod Manager "Edit Options" button, but that button is not available if the mod is only Partially Installed. However, three other links to the mod settings block work even if the mod is in a Partially Installed state (which, as described under the Related Mods heading, is not necessarily an error condition).

  • From the mod description in the status cell of the Browsemedia Search Form row of the Mod Manager List
  • From the Inner Mod Menu that this mod installs on browsemedia.php (see a visualation below), and
  • From the "Mod Settings Block" subform at Admin>>Setup>>General Settings

Related Mods

  1. {{RobinBoilerplate |text=msbmod}
    • {{RobinBoilerplate |text=msb2}
    • {{RobinBoilerplate |text=imm}
    • Browsemedia Medialinks also changes browsemedia.php. Browsemedia Medialinks focuses on the Media Links column of the search form, whereas Browsemedia Search Form focuses on the search form and the positioning of the search results navigation menu above and below the search results.
      • Acually, both mods make identical changes to the "Links" column in the results table. But they do so by adding stye classes rather than changing the HTML code, and the duplicated style does not cause any problems

Conflicts

I have checked the TNG Wiki mods that say that they change browsemedia.php. I could not download three of them. Of the others, only one presented a conflict:

  • Media display columns mod, which changes results table column sizes in six end-user programs. I don't understand why it does what it does to browsemedia, and I don't see a way to resolve the incompatibility.

If you find any other incompatibilities, please let me know.

Installation

This mod includes a typical mod subfolder, with the same base name as the mod's .cfg file. The subfolder is atypical in that no files in it are installed to working TNG folders. However, it does contain critical files that contain the mod's language strings, which the mod does not add to standard cust_text.php files. Instead, the PHP code modified by this mod loads the language strings from files in the mod's languages/ subfolder. Read more about this technique.

Files Modified

  1. browsemedia.php - The End-user program that displays media items (for all media collections)
  2. admin_genconfig.php - The form at Admin>>Setup>>General Settings, which contains all Mod Settings Blocks.
  3. admin_genconfig.php - The form at Admin>>Setup>>General Settings, which contains all Mod Settings Blocks.
  4. admin_updateconfig.php - The admin_genconfig.php action script that saves the Admin>>Setup>>General Settings form, including all Mod Settings Blocks

[Show Standard Installation Process]

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]

Visualizations

Search Form BEFORE: The tree selection field is not present if there is only one tree. When it is present, a change to the selected tree refreshes the screen and clears the search string.
Browsemedia search form-before3.png
Search Form AFTER:

Again, the Tree selection field is not displayed if there is only one tree.

  1. The Tree selection field does not refresh the page; it is just part of the form.
  2. The visibility of the search field help icon is controlled by a mod parameter.
  3. The visibility of the Gallery button help icon is controlled by a separate mod parameter.
  4. The search form is now separate from the Gallery/Descriptive view/Slide Show widget, and from the page navigation widget.
Browsemedia search form-after-selectedtree.png
Results Columns AFTER:
  1. There is now a Tree column if there is more than one tree and the user has not selected a tree.
  2. There is now a Collection column if the user is on the All Media version of the program or has selected all media collections.
  3. The width of the "Linked To" column has been reduced, with a style rule that uses "max-width" rather than "width".
  4. The same is true of the "Status" column (not shown) for Headstones.
Browsemedia search form-after-TreeAndCollection.png
Help Text Popup AFTER:
  • The information icon next to the search field pops up a TNG LITBox that explains Media Collections. It can be suppressed by a mod option. The pop-up text is defined as a language string.
Browsemedia search form-after-searchhelp.png
Help Text Popup AFTER:
  • The information icon next to the Gallery button pops up a TNG LITBox that explains Media Collections. It can be suppressed by a mod option. The pop-up text is defined as a language string.
Browsemedia search form-after-galleryhelp.png
The Mod Settings Block AFTER:

A Mod Settings Block is an outlined subform within an Admin>>Setup program that contains the options for a single mod. What is most notable about a Mod Settings Block is that a hyperlink directly to a Mod Settings Block displays only that block (i.e. only one mod's options), not all of the other options in the form or subform.

Here, you see the this mod's Mod Settings Block, in admin_genconfig.php, at Admin>>Setup>>General Settings. The triangular arrow next to the subfolder heading Mod Settings Blocks is pointing to the right, meaning that the subform is not open, and that your site's other mod settings blocks are not visible. If you were to open the subform by clicking on the heading, you would see the mod settings blocks for other mods that you have installed.

Browsemedia search form-msb.jpg

Revision History

Mod Version TNG Version Date Note
v14.0.4.4e]] 14.0.4 25Mar2024 Updated the mod to TNGv14. Added an info icon next to the Media Collection selection box and updated all help text. Depends on MSB 14.0.4.4d
v14.0.0.4c]] 14.0-14.0.3 21Nov2023 Updated the mod to TNGv14. Fixed undefined subscript errors.
v13.0.0.4a 13 12Oct2020 Upgraded to TNGv13 and added coordination with Browsemedia Medialinks
v12.0.0.4 12.0-12.3 15Mar2020
  1. Inserted a Mod Manager tag that had been optional but is required by TNGv12.3
  2. Added optional help text for the Gallery button and search string.
  3. Modified the width of the Linked To field and the Headstones Status field.
  4. Added a "Collection" column when all Collections (mediatypes) are being shown.
v12.0.0.2 12.0 - 12.0.2+ 25 Jan 2019 - Added a Mediatype field,

- Changed tree dropdown so that it
Does not autoselect,
Defaults to the user's branch if there is a branch restriction

v12.0.0.1a 12.0+ 15 May 2018 No functional changes; made compatible with TNGv12.
10.1.0.1a 10.1-11.1.1+ 8 May 2017 New mod with typo corrected

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 14.0.0.4c

rrgip

English
The Cole / Tanner Family Tree David Cole Public/Private see here see here EN, DE, FR, ES, NL