Difference between revisions of "Admin Places Search"
Robinrichm (talk | contribs) |
Robinrichm (talk | contribs) |
||
(42 intermediate revisions by 5 users not shown) | |||
Line 1: | Line 1: | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
{{TNGmod | {{TNGmod | ||
| mod_name = Admin Places Search | | mod_name = Admin Places Search | ||
| mod_summary = Adds search options and results details to the Admin>>Places>>Search program | | mod_summary = Adds search options and results details to the Admin>>Places>>Search program | ||
| mod_validation = | | mod_validation = | ||
− | | download_link = | + | | mod_last_update = 26 Feb 2020 |
− | + | | download_link = [[Media:admin_places_search_v12.0.0.4b.zip|12.0.0.4b]]{{Tv120}} | |
+ | <div style='font-size:90%;'>See [[#Revision_History|the Revision History]] for older versions</div> | ||
| download_stats = | | download_stats = | ||
| mod_author = [[User:Robinrichm|Robin Richmond]] | | mod_author = [[User:Robinrichm|Robin Richmond]] | ||
Line 19: | Line 11: | ||
| mod_contact = [http://www.robinrichmond.com/family/mod_support.php My Mod Support form] | | mod_contact = [http://www.robinrichmond.com/family/mod_support.php My Mod Support form] | ||
| mod_support = [http://www.robinrichmond.com/family/mod_support.php My Mod Support form] or [http://tng.community/ TNG Community Forums] | | mod_support = [http://www.robinrichmond.com/family/mod_support.php My Mod Support form] or [http://tng.community/ TNG Community Forums] | ||
− | | mod_version = | + | | mod_version = 12.0.0.4b |
| min_TNG_ver = 11.0 | | min_TNG_ver = 11.0 | ||
− | | max_TNG_ver = | + | | max_TNG_ver = 12.3 |
− | | TNG_file_list = admin_places.php, cust_text.php English | + | | TNG_file_list = admin_places.php, cust_text.php English. Installs shared files: rrinnermodmenu1.php, admin_genconfig.php, admin_updateconfig.php, rrsetup_modoptions1_include.php, img/rrmodadmin_wikilogo.png |
− | | related_mods = [[Admin Places Geocode]] | + | <br>Installs shared files: rrinnermodmenu1_include.php, rrmodoptions1.php, img/rrmodadmin_wikilogo.png |
+ | | related_mods = [[Admin Places Geocode]], [[Admin Places Date]] | ||
| notes = | | notes = | ||
}} | }} | ||
+ | == Purpose of the Mod == | ||
+ | Adds features to the '''Admin >> Places >> Search''' form and results list as follows: | ||
{| style="margin-right:0.5 em;" align="right" | {| style="margin-right:0.5 em;" align="right" | ||
| __TOC__ | | __TOC__ | ||
|} | |} | ||
− | |||
− | |||
− | |||
# Adds 3 search options: | # Adds 3 search options: | ||
## "Results Per Page", which overrides the system value ($maxresults) | ## "Results Per Page", which overrides the system value ($maxresults) | ||
− | ## Show Place Notes, which are displayed in a new column | + | ## "Show Place Notes", which are displayed in a new column. |
− | ## Show Cemetery Links, which are displayed in a new column | + | ## "Show Cemetery Links", which are displayed as an HTML entity in a new column. When the Cemetery Links column is displayed, a table footnote describes that column. |
− | # Allows the Regular Expression anchor characters ^ and $ to be placed at the beginning and/or the end of the search string. (See the | + | # Allows the Regular Expression anchor characters ^ and $ to be placed at the beginning and/or the end of the search string. (See the visualizations for a specific example.) |
# Adds a Placeholder text message in the Search field to note that the anchor characters can be used there. | # Adds a Placeholder text message in the Search field to note that the anchor characters can be used there. | ||
# Draws a fieldset around the search form to help distinguish it from the action/pagination form. | # Draws a fieldset around the search form to help distinguish it from the action/pagination form. | ||
# Displays the tree and searchstring parameters (if they have values) at the top of the results table. | # Displays the tree and searchstring parameters (if they have values) at the top of the results table. | ||
− | # Rounds longitude and latitude values to | + | # Rounds longitude and latitude values to the number of decimal digits supplied by a mod option defined by the optional [[Admin Places Geocode]] mod. |
− | # In the Placelevel column, displays descriptive names such as Location | + | # In the Placelevel column, displays descriptive names such as Location and City/Town). Will also display the numeric Placelevel value if directed by a mod option. |
# Omits the Tree column if a tree was selected | # Omits the Tree column if a tree was selected | ||
− | + | # Adds text describing these changes to the Places Help file. | |
− | # Adds | + | # Adds an information icon next to the Search field that hyperlinks to new text in the Places Help file. |
− | # Adds an information icon next to the Search field that hyperlinks to | ||
− | == | + | == Mod Options == |
− | + | All options are custom TNG settings, which are defined and edited in the form at Admin>>Setup>>General Settings, in the new subform '''Robin's Mods''', where the options for various mods are organized into '''[https://tng.lythgoes.net/wiki/index.php?title=Mod_Settings_Blocks Mod Settings Blocks]'''. | |
− | |||
− | + | This mod has one option. The mod displays Place Level names (Not Set, Address, Location, City/Town, etc.) in the Place Level results column, where the native code just displays the Place Level number. The option is whether to show the Place Level number ''in addition to'' the Place Level description. | |
− | This mod | ||
− | + | * In version 3 of the mod, this option is a "mod parameter", defined by the Mod Manager <code>%parameter</code> tag, and edited within the Mod Manager. | |
− | + | * In version 4, this option is a custom TNG setting, defined and edited in the form at Admin>>Setup>>General Settings, in the new subform '''[https://tng.lythgoes.net/wiki/index.php?title=Mod_Settings_Blocks Robin's Mods]''' | |
− | == | + | == Compatibility == |
− | + | This mod is compatible with [[Admin Places Geocode]], [[Places Subject to Deletion]], and [[TreeID-One Column]], as well as with two mods, [[Google Maps - More Place Levels Mod]] and [[Google maps 15]] that add Placelevel definitions. It is '''not compatible with''' [[Tree ID Mod]], but '''is compatible with''' [[TreeID-One Column]], which accomplishes the same purpose as [[Tree ID Mod]]. [[TreeID-One Column]] just uses one column instead of two to display the Tree ID and Tree Name, and avoids a couple of mod conflicts. | |
− | |||
− | |||
− | == | + | == Related Mods == |
− | + | * '''[[Admin Places Geocode]]''' | |
− | + | ** Defines the Placelevel value of -1 to mean "Do not Geocode". This mod defines the string "Do not Geocode" that is displayed when it sees a value of -1 for the Placelevel. | |
− | + | ** Installs a mod option that controls the number of decimal digits in Latitude and Longitude values. If that option has been defined, then this mod rounds the Latitude and Longitude as they are read from the database, and as they are written to the database. | |
− | + | * '''[[Admin Places Date]]''' also affects ''Admin>>Places'', and coordinates with this mod in that when this mod adds field buttons to the form field it creates, it also adds field buttons for the "Creation Date" form field field that is added by [[Admin Places Date]] - well, ''if'' that field is present in the form when admin_places.php runs. | |
+ | * This mod uses the '''[[Field Buttons]]''' mod to attach small 'field buttons' to several text fields, ''but it is not dependent on [[Field Buttons]]''. Field buttons are configurable (and generally one-character) buttons that are attached to HTML form fields, and that reduce the typing or mouse movements needed to perform several common editing tasks. This mod is not compatible with Field Buttons mod versions earlier than version 3. | ||
+ | * This mod saves data that can be used by the ''optional'' '''[[Show Mod Names]]''' utility mod. | ||
− | == | + | == Installation == |
− | + | This mod uses the standard installation procedure, though it should be noted that this mod contains an atypical mod subfolder. The folder '''RR-shared_mod_includes_v12.0.0.4''' contains files that support mod option management in many of my mods. Those files are: | |
− | # | + | # '''rrshared_innermodmenu4.php''' - [https://tng.lythgoes.net/wiki/index.php?title=Inner_Mod_Menus Inner Mod Menus] |
+ | # '''rrshared_modsettingsblocks4.php''' - [https://tng.lythgoes.net/wiki/index.php?title=Mod_Settings_Blocks Mod Settings Blocks] | ||
+ | # '''img/rrshared_wikilogo.gif''' - An icon that links to a mod's TNG Wiki page from an Inner Mod Menu or Mod Settings Block | ||
+ | The shared folder is packaged with several mods, each of which will (try to) install the .gif file and at least one of the .php files. Once a file from this folder has been installed (by any mod), that file will not be overwritten or removed by the subsequent installation or un-installation of any mod (including this one), nor will its presence generate any Mod Manager errors. | ||
− | + | If you unzip mod distribution files directly into your mods folder, then the presence of this second subfolder and the installation of its files should be invisible to you. But if you generally ''copy'' mod subfolders to your mods folder, you need to make sure to copy the folder '''RR-shared_mod_includes_v12.0.0.4''' (well, unless you are confident that it is already in your mods folder because it was part of another mod).<br>{{RobinInstallationBoilerplate}} | |
+ | == Visualizations == | ||
+ | (These visualizations are from mod version 3a, but most of them also apply well to mod version 4. See update notes in the [[#Revision_History|Revision History]] section of this article.) | ||
{| border="1" cellspacing="1" cellpadding="2" class="wikitable" | {| border="1" cellspacing="1" cellpadding="2" class="wikitable" | ||
|- | |- | ||
− | | style="border:thin solid black;" | '''<span style="color: red">BEFORE:</span> The Pristine Admin >> Places screen, with the system variable $maxresults (Results per page) set to 30.''' | + | | style="border:thin solid black;" | '''<span style="color: red">BEFORE:</span> The Pristine Admin >> Places screen, with the system variable $maxresults (Results per page) set to 30.'''<br/>Note that |
− | <br>Note | ||
* The three checkboxes immediately below the search string are implemented by the Pristine TNG code and | * The three checkboxes immediately below the search string are implemented by the Pristine TNG code and | ||
− | * The Place Level of -1 (meaning "Don't geocode") for the Placename "(none)" is implemented by the Admin Places Geocode mod. | + | * The Place Level of -1 (meaning "Don't geocode") for the Placename "(none)" is implemented by the Admin Places Geocode mod.<br/>[[Image:admin_places_search-before.png]] |
− | [[Image:admin_places_search-before.png]] | ||
|- | |- | ||
− | | style="border:thin solid black;" | '''<span style="color: red">AFTER:</span> Search results without a search string, highlighting some of the new features | + | | style="border:thin solid black;" | '''<span style="color: red">AFTER:</span> Search results without a search string, highlighting some of the new features'''<br/> |
− | + | [[Image:admin_places_search-after1.png]]<br/> | |
− | |||
− | |||
− | |||
* In the Place Level column where you see the descriptive names rather than numbers, the text value "Don't Geocode" is supplied by this mod to support the internal value -1 that is implemented by the Admin Places Geocode mod, | * In the Place Level column where you see the descriptive names rather than numbers, the text value "Don't Geocode" is supplied by this mod to support the internal value -1 that is implemented by the Admin Places Geocode mod, | ||
− | * This mod rounds the ''display'' of Latitude and Longitude to | + | * This mod rounds the ''display'' of Latitude and Longitude (to the precision specified by a mod parameter), but the Admin Places Geocode mod adds features that round the ''stored'' Latitude and Longitude. |
− | |||
|- | |- | ||
| style="border:thin solid black;" | '''<span style="color: red">AFTER:</span> Results for the search string "cemetery", with the "Show notes" and "Show Cemetery Links" options selected.'''<br/> | | style="border:thin solid black;" | '''<span style="color: red">AFTER:</span> Results for the search string "cemetery", with the "Show notes" and "Show Cemetery Links" options selected.'''<br/> | ||
[[Image:admin_places_search-after2.png]] | [[Image:admin_places_search-after2.png]] | ||
+ | |- | ||
+ | | style="border:thin solid black;" | '''<span style="color: red">AFTER:</span> When the "Missing Latitude or Longitude" option is selected.'''<br/> | ||
+ | [[Image:admin_places_search-after3.png]] | ||
|- | |- | ||
| style="border:thin solid black;" | '''<span style="color: red">AFTER:</span> The help text added by this mod'''<br/> | | style="border:thin solid black;" | '''<span style="color: red">AFTER:</span> The help text added by this mod'''<br/> | ||
[[Image:admin_places_search-help.png]] | [[Image:admin_places_search-help.png]] | ||
+ | |- | ||
+ | | style="border:thin solid black;" | '''<span style="color: red">AFTER:</span> Field Buttons'''<br/> | ||
+ | [[Image:admin_places_search-fieldbuttons1.jpg]]<br> | ||
+ | * For the search string field: | ||
+ | ** The X button will clear the search string value. | ||
+ | ** The R button will restore the field to the value it had when the page was loaded. | ||
+ | * For the Results per page field: | ||
+ | ** The R button will restore the field to the value it had when the page was loaded. | ||
+ | ** The D button will assign a default value to the field. In this case, the default value is the TNG system parameter "Max Search Results". | ||
+ | ** The A button will assign a value that means "All Items". In this case, that value is 'all'. | ||
+ | Field buttons are described further in the [[Field Button]] mod article. The Field Buttons mod is necessary to make the field buttons visible. | ||
+ | |||
+ | Buttons that would not change the value are shaded out, as shown below.<br/> | ||
+ | [[Image:admin_places_search8-fieldbuttons2.jpg]]<br> | ||
+ | In this screen clip, a search has been done with no search string, and with 35 Results per page. As a result: | ||
+ | * For the search string field: | ||
+ | ** The X button is shaded out because there is no value to clear. | ||
+ | ** The R button is shaded out because we just loaded the page, and the field value is still in its initial state. | ||
+ | * For the Results per page field: | ||
+ | ** The R button is shaded out because we just loaded the page. | ||
+ | ** The D button is shaded out because the the field does not have the the default value (the value of the TNG system parameter "Max Search Results"). | ||
+ | ** The A button is visible because the value is not 'all'. | ||
|} | |} | ||
− | == | + | == Revision History == |
{| border="0" cellspacing="1" cellpadding="2" class="wikitable" | {| border="0" cellspacing="1" cellpadding="2" class="wikitable" | ||
|- | |- | ||
− | ! Mod Version | + | ! Mod Version !! TNG Versions !! Date !! Note |
− | ! TNG | + | |- style="vertical-align:top;" <!-- ############################################################## --> |
− | ! | + | | [[Media:admin_places_search_v12.0.0.4b.zip|12.0.0.4b]] |
− | ! | + | | 12.0-12.3 |
− | |- | + | | 26Feb2020 |
+ | | | ||
+ | * Added a missing %end:% and broken %replace:% in the .cfg file, as required by TNGv12.3 | ||
+ | * Uses version 4 of my [[Mod Settings Blocks#Shared_Mod_Libraries|shared mod libraries]]. | ||
+ | * Fixed a bug that affected searches for missing placelevels | ||
+ | * Changed the "Place level not set" checkbox into three radio buttons for "Placelevel: yes/no/either" | ||
+ | |||
+ | |- style="vertical-align:top;" <!-- ############################################################## --> | ||
+ | | [[Media:admin_places_search_v12.0.0.4.zip|12.0.0.4]] (beta) | ||
+ | | 12.0+ | ||
+ | | 18Aug2019 | ||
+ | | No significant changes to the search and display functionality. | ||
+ | * Visible Changes: | ||
+ | ** An '''[https://tng.lythgoes.net/wiki/index.php?title=Inner_Mod_Menus Inner Mod Menu]''' is now floated to the right end of the admin_places.php Inner Menu. | ||
+ | ** The mod's parameter is now a TNG option, defined through '''Admin>>Setup>>General Settings''', in a new subform named '''[https://tng.lythgoes.net/wiki/index.php?title=Mod_Settings_Blocks Mod Settings Blocks]'''. | ||
+ | ** The search form row that contains display options now starts with the label "Display Options". | ||
+ | ** New help text that is triggered by an information icon next to the searchstring field. | ||
+ | * Internal Changes include: | ||
+ | ** Improvements to the implementation of [[Field Buttons]] requires version 3 or higher of the '''[[Field Buttons]]'' mod. (Well, that is, if the optional [[Field Buttons]] mod is installed at all.) | ||
+ | ** The implementation of the Latitude and Longitude rounding option requires version 4 of '''[[Admin Places Geocode]]]'''. (Again - if the optional [[Admin Places Geocode mod is installed at all.) | ||
+ | |- style="vertical-align:top;" <!-- ############################################################## --> | ||
+ | | [[Media:admin_places_search_v12.0.0.3a.zip|12.0.0.3a]] | ||
+ | | 12.0+ | ||
+ | | 14Nov2018 | ||
+ | | No functional changes; made compatible with TNGv12. | ||
+ | |- style="vertical-align:top;" <!-- ############################################################## --> | ||
+ | | [[Media:admin_places_search_v11.0.0.3a.zip|11.0.0.3a]] | ||
+ | | 11.0+ | ||
+ | | 28Dec2017 | ||
+ | | Visibly, added "field buttons". Technical changes include | ||
+ | * Removed the Geocode Decimal Digits mod parameter. The code now looks for the TNG system parameter $tngconfig['rrgeocodedecimals'] (installed by Admin Places Geocode) | ||
+ | * Added a "don't print on printer" class to the tab menu and innermenu, and the Action and Select columns of the results table. | ||
+ | * A number of the changes to HTML element attributes are now implemented through a (Document).ready function. | ||
+ | |- style="vertical-align:top;" <!-- ############################################################## --> | ||
+ | | 11.0.0.2a | ||
+ | | 11.0+ | ||
+ | | 30May2017 | ||
+ | | Added the Insert Links function to the Place Notes so that URLs and and FindAGrave ID's are displayed as hyperlinks. First non-beta version | ||
+ | |- style="vertical-align:top;" <!-- ############################################################## --> | ||
| 11.0.0.2 | | 11.0.0.2 | ||
| 11.0+ | | 11.0+ | ||
− | | | + | | 26May2017 |
− | | Now compatible with [[Google Maps - More Place Levels Mod]] and [[Google maps 15]]. | + | | Now compatible with [[Google Maps - More Place Levels Mod]] and [[Google maps 15]]. Also added the two mod parameters. |
− | |- | + | |- style="vertical-align:top;" <!-- ############################################################## --> |
| 11.0.0.1 | | 11.0.0.1 | ||
| 11.0+ | | 11.0+ | ||
− | | | + | | 13Apr2017 |
| New mod. | | New mod. | ||
|} | |} | ||
Line 132: | Line 183: | ||
| [[User:Robinrichm|Robin Richmond]] | | [[User:Robinrichm|Robin Richmond]] | ||
| Mod developer | | Mod developer | ||
− | | 11.0.0. | + | | 11.0.0.3a |
| 11.1.1 | | 11.1.1 | ||
| English | | English | ||
Line 138: | Line 189: | ||
| [https://www.royandboucher.com/tng/ Our Roy and Boucher Family] | | [https://www.royandboucher.com/tng/ Our Roy and Boucher Family] | ||
| [[User:KenRoy|Ken Roy]] | | [[User:KenRoy|Ken Roy]] | ||
− | | Modified to display correct Place Level description to support [[Google Maps - More Place Levels Mod]] and [[Google maps 15]]. | + | | Modified to display correct Place Level description to support [[Google Maps - More Place Levels Mod]] and [[Google maps 15]]. |
| 11.0.0.1 | | 11.0.0.1 | ||
| 11.1.1 | | 11.1.1 | ||
| English, French | | English, French | ||
+ | |- | ||
+ | | [http://colegenealogy.dynu.net/ Cole / Tanner Family Tree] | ||
+ | | [[User:dlcole|David Cole]] | ||
+ | | Public/Private | ||
+ | | [[User:Dlcole|see here]] | ||
+ | | [[User:Dlcole|see here]] | ||
+ | | English | ||
|} | |} | ||
+ | [[Category:Mods for TNG v12]] | ||
[[Category:Mods for TNG v11]] | [[Category:Mods for TNG v11]] | ||
[[Category:admin_places.php mods]] | [[Category:admin_places.php mods]] | ||
[[Category:cust_text.php English mods]] | [[Category:cust_text.php English mods]] | ||
+ | [[Category:admin_genconfig.php mods]] | ||
+ | [[Category:admin_updateconfig.php mods]] |
Revision as of 18:57, 23 March 2020
Admin Places Search | ||
---|---|---|
Summary | Adds search options and results details to the Admin>>Places>>Search program | |
Validation | ||
Mod Updated | 26 Feb 2020 | |
Download link | 12.0.0.4b
See the Revision History for older versions | |
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 | 12.0.0.4b | |
Min TNG V | 11.0 | |
Max TNG V | 12.3 | |
Files modified | admin_places.php, cust_text.php English. Installs shared files: rrinnermodmenu1.php, admin_genconfig.php, admin_updateconfig.php, rrsetup_modoptions1_include.php, img/rrmodadmin_wikilogo.png
Installs shared files: rrinnermodmenu1_include.php, rrmodoptions1.php, img/rrmodadmin_wikilogo.png | |
Related Mods | ||
Notes |
Purpose of the Mod
Adds features to the Admin >> Places >> Search form and results list as follows:
- Adds 3 search options:
- "Results Per Page", which overrides the system value ($maxresults)
- "Show Place Notes", which are displayed in a new column.
- "Show Cemetery Links", which are displayed as an HTML entity in a new column. When the Cemetery Links column is displayed, a table footnote describes that column.
- Allows the Regular Expression anchor characters ^ and $ to be placed at the beginning and/or the end of the search string. (See the visualizations for a specific example.)
- Adds a Placeholder text message in the Search field to note that the anchor characters can be used there.
- Draws a fieldset around the search form to help distinguish it from the action/pagination form.
- Displays the tree and searchstring parameters (if they have values) at the top of the results table.
- Rounds longitude and latitude values to the number of decimal digits supplied by a mod option defined by the optional Admin Places Geocode mod.
- In the Placelevel column, displays descriptive names such as Location and City/Town). Will also display the numeric Placelevel value if directed by a mod option.
- Omits the Tree column if a tree was selected
- Adds text describing these changes to the Places Help file.
- Adds an information icon next to the Search field that hyperlinks to new text in the Places Help file.
Mod Options
All options are custom TNG settings, which are defined and edited in the form at Admin>>Setup>>General Settings, in the new subform Robin's Mods, where the options for various mods are organized into Mod Settings Blocks.
This mod has one option. The mod displays Place Level names (Not Set, Address, Location, City/Town, etc.) in the Place Level results column, where the native code just displays the Place Level number. The option is whether to show the Place Level number in addition to the Place Level description.
- In version 3 of the mod, this option is a "mod parameter", defined by the Mod Manager
%parameter
tag, and edited within the Mod Manager. - In version 4, this option is a custom TNG setting, defined and edited in the form at Admin>>Setup>>General Settings, in the new subform Robin's Mods
Compatibility
This mod is compatible with Admin Places Geocode, Places Subject to Deletion, and TreeID-One Column, as well as with two mods, Google Maps - More Place Levels Mod and Google maps 15 that add Placelevel definitions. It is not compatible with Tree ID Mod, but is compatible with TreeID-One Column, which accomplishes the same purpose as Tree ID Mod. TreeID-One Column just uses one column instead of two to display the Tree ID and Tree Name, and avoids a couple of mod conflicts.
Related Mods
- Admin Places Geocode
- Defines the Placelevel value of -1 to mean "Do not Geocode". This mod defines the string "Do not Geocode" that is displayed when it sees a value of -1 for the Placelevel.
- Installs a mod option that controls the number of decimal digits in Latitude and Longitude values. If that option has been defined, then this mod rounds the Latitude and Longitude as they are read from the database, and as they are written to the database.
- Admin Places Date also affects Admin>>Places, and coordinates with this mod in that when this mod adds field buttons to the form field it creates, it also adds field buttons for the "Creation Date" form field field that is added by Admin Places Date - well, if that field is present in the form when admin_places.php runs.
- This mod uses the Field Buttons mod to attach small 'field buttons' to several text fields, but it is not dependent on Field Buttons. Field buttons are configurable (and generally one-character) buttons that are attached to HTML form fields, and that reduce the typing or mouse movements needed to perform several common editing tasks. This mod is not compatible with Field Buttons mod versions earlier than version 3.
- This mod saves data that can be used by the optional Show Mod Names utility mod.
Installation
This mod uses the standard installation procedure, though it should be noted that this mod contains an atypical mod subfolder. The folder RR-shared_mod_includes_v12.0.0.4 contains files that support mod option management in many of my mods. Those files are:
- rrshared_innermodmenu4.php - Inner Mod Menus
- rrshared_modsettingsblocks4.php - Mod Settings Blocks
- img/rrshared_wikilogo.gif - An icon that links to a mod's TNG Wiki page from an Inner Mod Menu or Mod Settings Block
The shared folder is packaged with several mods, each of which will (try to) install the .gif file and at least one of the .php files. Once a file from this folder has been installed (by any mod), that file will not be overwritten or removed by the subsequent installation or un-installation of any mod (including this one), nor will its presence generate any Mod Manager errors.
If you unzip mod distribution files directly into your mods folder, then the presence of this second subfolder and the installation of its files should be invisible to you. But if you generally copy mod subfolders to your mods folder, you need to make sure to copy the folder RR-shared_mod_includes_v12.0.0.4 (well, unless you are confident that it is already in your mods folder because it was part of another mod).
[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
- Remove and delete previous version of this mod.
- Backup the files updated by this mod. They are listed in the panel at the upper right.
- Download the .zip file, Extract its .cfg file to the mods folder.
- Follow the normal automated installation for Mod Manager, as shown in the example Mod Manager - Installing Config Files.
Problems?
- Try using the Mod Manager Remove capability
- Contact me through My Mod Support form.
Visualizations
(These visualizations are from mod version 3a, but most of them also apply well to mod version 4. See update notes in the Revision History section of this article.)
BEFORE: The Pristine Admin >> Places screen, with the system variable $maxresults (Results per page) set to 30. Note that |
AFTER: Search results without a search string, highlighting some of the new features
|
AFTER: Results for the search string "cemetery", with the "Show notes" and "Show Cemetery Links" options selected. |
AFTER: When the "Missing Latitude or Longitude" option is selected. |
AFTER: The help text added by this mod |
AFTER: Field Buttons
Field buttons are described further in the Field Button mod article. The Field Buttons mod is necessary to make the field buttons visible. Buttons that would not change the value are shaded out, as shown below.
|
Revision History
Mod Version | TNG Versions | Date | Note |
---|---|---|---|
12.0.0.4b | 12.0-12.3 | 26Feb2020 |
|
12.0.0.4 (beta) | 12.0+ | 18Aug2019 | No significant changes to the search and display functionality.
|
12.0.0.3a | 12.0+ | 14Nov2018 | No functional changes; made compatible with TNGv12. |
11.0.0.3a | 11.0+ | 28Dec2017 | Visibly, added "field buttons". Technical changes include
|
11.0.0.2a | 11.0+ | 30May2017 | Added the Insert Links function to the Place Notes so that URLs and and FindAGrave ID's are displayed as hyperlinks. First non-beta version |
11.0.0.2 | 11.0+ | 26May2017 | Now compatible with Google Maps - More Place Levels Mod and Google maps 15. Also added the two mod parameters. |
11.0.0.1 | 11.0+ | 13Apr2017 | 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.3a | 11.1.1 | English |
Our Roy and Boucher Family | Ken Roy | Modified to display correct Place Level description to support Google Maps - More Place Levels Mod and Google maps 15. | 11.0.0.1 | 11.1.1 | English, French |
Cole / Tanner Family Tree | David Cole | Public/Private | see here | see here | English |