Harmonizes, formats, and locks a selected place
As of
Place Harmonizer documentation;
developed by bmtg, vtpearce;
comments for this version to: bmtg (PM), bmtg_4 (Slack DM)
Description:
This script acts on a single selected place. It will generally clean up many place details, harmonize names and details of many chains, and, if the place is complete according to standards, it will lock to an appropriate level. Full feature list is below.
----------------
Installation:
Use tampermonkey / greasemonkey
-------------
Usage:
Select a place in WME, and press the shortcut key (Shift-Alt-A). Place will be updated. Banner message appears over editing pane, with status of place. Verify changes, adjust as needed, save. If the place has a website, the link will appear in the banner so you can collect more info.
-------------
Examples (before and after using the script): see images at bottom
-------------
Current features:
-- Upon running the script, a banner will appear above the place editing panel, color coded by severity. Green: Place is complete including phone & URL; Blue: Place is complete and locked, but missing phone and/or URL or may need manual confirmation of details; Orange: Place is formatted and locked, but the editor is urged to examine the message provided to verify the place details; Red: major issue with place, such as no address or name, or incorrect place/area setting for category. Basic formatting and harmonization still occurs, but the editor likely needs to add information to complete the place. In all cases where the place has a website, the link will appear in the banner. Some sites even have custom links that open the store finder, possibly with the area of your place point preloaded.
-- Regional Localization: Script will automatically detect the region of the selected place: Currently USA regions are fully recognized. For SE and SAT, regional locking rules, place formats, and Phone# formats are applied. For other regions, these are kept to the basic locking at 3 and (xxx) phone format (until other regions' rules are brought in, in the future). **Note that for some app-submitted places, no state name is stored. In these cases, you have to enter at least a city and/or street in the address field for the state field to populate and allow the script to run.
-- Country Localization: Script only works in the USA, but can be expanded to other countries in the future.
-- Place name harmonization: An ongoing project is to harmonize place names for chains. This mostly involves having the same primary name, alt-name(s), category(s), and website address for every place from that chain. This script will harmonize the current place based on the detected place name and the place harmonization sheet, for many chains on the sheet (more places added with each new update). When using the script, if the script finds a match for a place on the harm. sheet, it will auto correct the name to the standard name, add any alt-names if needed, put in the correct category(s), and put in the standardized url for the chain.
--(Currently disabled:) Common services are added for several categories. For example, Schools receive Restroom, Parking, AC, Wheelchair services. Any existing checked services are preserved.
-- Gas station correction: This script will do the following to places that have the gas station category:
1) If the primary name doesn't match the brand, then the primary name is moved to the alt name, and the brand is set as the primary name. Example: A place named CIRCLE K that has a brand of Shell, will be changed so that Shell is the Primary name, and Circle K is the alt name. If there is no brand, then there is no change to the name. The brand field is never changed by this script; if a station has changed brands, that edit needs to be done manually, after which the script can be run. If the name is changed, the script will send up a red banner alerting the user to check the info before saving.
2) The category "Convenience Store" is added to the place. Very few stations do not have a convenience store, so this adds a likely category. If your station doesn't have a convenience store, then simply X out the convenience store category after running the script. If the station had the categories of ATM or Car Wash already in the place, this will preserve them. Any other categories are wiped out, since they usually should be given their own place point.
3) (Currently Disabled:) Services check boxes are set automatically to : Restrooms, Credit Cards, Air Conditioning, Parking, and Wheelchair Accessible.
4) Special stations that are subsets of a larger store are treated slightly differently; At present the script handles Costco, BJ's and Sam's Club stations so that the primary name has "Gasoline" after the name. Rules 1, 2, and 3 just above are not applied to these places, and also the text "Members only" is added to the description. Services are limited to Credit Cards, Parking, and Wheelchair Accessible.
-- Place name Title casing:
1) If there are any lower case letters in any word, then it will Title Case that word. Example: john's Pass BakERY -> John's Pass Bakery
2) If there is an ALL CAPS word ALONG with other words that are not in all caps, then the ALL CAPS word will be left ALL CAPS while the others are title cased. Examples: ALCCO store -> ALCCO Store; QVN Pharmacy -> QVN Pharmacy
3) If the _entire_ place name is in ALL CAPS, then the script will change the entire name to Title Case. Examples: ALLCO -> Allco; JOHN'S PASS BAKERY -> John's Pass Bakery.
4) Some common articles and prepositions are kept lowercase. (an, the, of, for, and so forth)
5) Some common ALL CAPS words are made/kept all caps (USA, IRS, BMW)
6) McXxxx type words capitalize the letter after the Mc, as with O'Xxxxxx, L'Xxxxx, and D'Xxxxx
7) Chain name harmonization overrides title case processing, keeping chain specific capitalization in place
** As you can see, some single word ALL CAPS place names might be correct as ALL CAPS. Additionally, some places have internal caps, like CollegeUSA. Unless they are in the chain list, they will be Title cased. Please observe the name as you use the script and correct as necessary.
-- Phone correction: If the phone field contains 10 digits, and the digits are not in the format (XXX) XXX-XXXX, then they will be put into that format. Regional variation can be included (eg, SE region allows and favors XXX-XXX-XXXX). Those phone numbers that are already in the correct format are not altered. A leading 1 will be stripped.
-- url correction: If there is an http:// or https:// at the start of the website address, it will remove that from the website and keep the rest.
-- Basic info validation: The following checks are done prior to locking
1) Place area vs. point checking:
Script will check for area vs. point according to wiki guidance (including SE deviation for US Post Offices). If the place is a point but is supposed to be an area, then the script will pop up an alert. For categories that are not supposed to be mapped (junctions, water features), the script will pop up a warning instead of locking, and suggest manual locking if the place is truly valid. (The reverse check, saying that an area place should be a point, is not performed except for car dealerships, because many of the "point" categories are used inside of valid area places. Convenience store in a gas station area, for example.)
2) Name checking: the place has to have a name, or it will pop up a red banner.
3) Address checking: If the HN or the street field are not filled, the script pops up a red banner.
4) Places with weird HNs are flagged for manual check and lock (eg: 8133455678, 123A, 31-2)
** Note: the name and address checks look to see that the info is there, but they don't say if it's correct (i.e., a wrong HN can't be detected by a script like this). The Harmonization part of the script can autocorrect some misspellings for chains but the editor needs to make sure that the name and address are the correct ones for the place.
-- Applying a lock: If a place satisfies the 3 checks above, then the script will lock the place at the correct level. The level is determined from regional locking guidelines. In the absence of regional guidelines, the default is to lock all places to 3. In SE, for example, hospitals are locked at 5; Places in the College Campus Project are locked according to those standards as much as possible. Notes: If your editor rank is lower than the lock required, then the script locks it to your rank. Also, the script will never down-lock a place. Please recognize that not all cases can be scripted. For example, park-and-ride lots which are locked to 5 in some regions are not easy to distinguish from regular parking lots in a script, so they are locked to 3 in this case. So use your judgement. This is just an (imperfect but hopefully useful) tool!
-- Alerts about potentially incorrect information in the place info
-- Post Office category gives a warning that the category is only used for USPS. Populates the url and alt name, warns to check that it's really a USPS or use other category, and adds services: creditcards, AC, parking, wheelchair
-- Reminders for Stadium and Hospital categories, that they are only used in certain cases
-- Places like banks and certain businesses that have similar names now pop up an alert to the editor so they can verify that the script selected the right harmonization.
