|
|
| (289 intermediate revisions by 5 users not shown) |
| Line 1: |
Line 1: |
| [[File:Wmeph.png|thumb|right|250px]] | | <!-- ======================== |
| WME Place Harmonizer is a script originally written by {{Username|BMTG}}. WMEPH helps with all aspects of editing places except update requests. The script team is administered by {{Username|t0cableguy}}, and the lead developer is {{Username|MapOMatic}}.
| | ↓ EDITS TO THIS TABLE ARE MADE BELOW THE INSTRUCTIONS ↓ |
| | ============================== |
| | This page is only viewed directly in the Major Events table on the Closures subpage.--><noinclude>[[Category:{{RootPage2}}]] |
| | [{{fullurl:{{BasePage2}}/Closures|action{{=}}purge}} {{u|Click here to return to the {{RootPage2}}/Closures Subpage}}]<br/> |
|
| |
|
| The script validates, formats, and harmonizes the information for a selected place. It pulls standardized info for over 1800 chains from the PNH (Place Name Harmonization) data sheets. Places that are complete are automatically locked to the appropriate level based on category and location of the place (i.e. state/region/country rules are applied). Banners above the place information sidebar provide feedback on what is missing or out of spec with the place region's wiki guidance. Links to websites, search results, and PNH submission forms make working on places faster and easier. Hours can be added by pasting info from the place’s website or using shorthand entry. An optional yet highly useful highlighting feature shows places on the map needing work.
| | These rows fill the major Event table, and are modified using the template {{tl|Event/Item}}. If you are working on a Major Event in {{RootPage2}}, please add add that event to this table. If the event is already listed, please add your username to the row, preceded by a pipe (|), and change the date to today's date in the <code>updated=</code> parameter. |
| =Basic Functionality=
| |
| [[File:WMEPH banner and highlights.png|thumb|center|650px]]
| |
| *Color highlights and borders are placed on each place on the map according to the image above. Each type indicates a different problem, or completion level.
| |
|
| |
|
| *When "Run Wmeph" is pressed several items appear at the top of the Place panel and provide places for you to input the relevant information. You will search accordingly and input information into each field and click add. WMEPH formats and inserts the information into the right place in the place panel. Re running the checks by pressing "Run WMEPH" will recheck the fields and lock the place when the values are all present.
| |
|
| |
| *The script will match names to chains in the Place Name Harmonization list when matches are found.
| |
|
| |
|
| =Who can use it=
| | This template accepts many parameters which must be separated from each other using pipe characters (|), but can be placed in any order and will automatically the correct parts of the table. To use a parameter you must keep the name of parameter (the part before the equals sign (=) identical to this list, and only modify what goes after the equals sign (=). |
| Any editor rank 2 and up, editing in USA or Canada. (Some script options are restricted to higher ranked editors.)
| |
|
| |
|
| =How to use= | | ==Accepted parameters:== |
| Select a place in WME.
| |
|
| |
|
| Press the “Run WMEPH” button at the top of the sidebar [http://i.imgur.com/If6XVom.png Screenshot], or press the keyboard shortcut. The default is Alt-Shift-A; you can change this in the WMEPH preferences panel. (use a lowercase letter if you don't want the Shift key in the shortcut)
| | *<code>name=</code> The name of the event. |
| [http://i.imgur.com/goOquwO.png Screenshot]
| | *<code>area=</code> The county or are the event takes place in. |
| | *<code>date=</code> The estimated date(s) this event happens on. |
| | *<code>road=</code> The main road(s) affected by this event. |
| | *<code>pl=</code> A [[permalink]] to the affected road(s), or a link to documenting listing all the affected roads (usually a Waze event closure document). |
| | *<code>source=</code> A link to an official information source for this event, a government website, the hosting organizations webpage, etc. |
| | *<code>status=</code> Whether this event has been submitted to Waze yet for this season. It accepts the following options spelled only exactly as listed here in order to correctly change the color of the row, filled with anything else will display with a white background |
| | **<code>not submitted</code> produces a red background |
| | **<code>submitted</code> produces a light green background |
| | **<code>in progress</code> produces an orange background. |
| | *Up to six editors can be listed in the table for any event. These can be the editors who are working to get it submitted, maintain the segments, or just have special knowledge of the event/area. They are entered as unnamed parameters. Meaning they are to be entered between two pipe (|) characters of the adjacent parameters. Each editors name (without any spaces) should be separated with a pipe (|). |
| | *<code>updated=</code> the date this event was last updated in this table. This is used to keep the table current, and identify stale entries. |
|
| |
|
| The script will run on the place, and colored banners will appear at the top of the sidebar with information on the place status.
| |
|
| |
|
| <span style="color:#fff; background:#24ac24">Green</span> indicates no major issues were found and place is locked. [http://i.imgur.com/Vq2CMHy.png Screenshot] | | The updated parameter (<code>|updated=YY/MM(/DD)|</code>) should be updated any time you update a row. Put the date you are modifying the row after the equals sign (=). |
|
| |
|
| <span style="color:#fff; background:#3232e6">Blue</span> indicates that minor issues were found, but place is locked. [http://i.imgur.com/OfBoocB.png Screenshot]
| |
|
| |
|
| <span style="color:#fff; background:#d9ad2a">Orange</span> indicates that something was found that potentially needs editor attention. [http://i.imgur.com/R2YE4Pi.jpg Screenshot] | | The <code>|date=|</code>, and <code>|updated=|</code> parameters should use the format YY/MM/DD. The day of the month is optional. Using this format will make it easier to sort the list by updated date. This will help ensure the information on the list is current, and make it easy to find stale rows which may need to be adopted by other editors. |
|
| |
|
| <span style="color:#fff; background:#d33030">Red</span> means that an issue was found that prevented place locking. [http://i.imgur.com/jKp5Vxi.png Screenshot]
| |
| Banners contain buttons which do various things as described below
| |
|
| |
|
| The script doesn’t automatically save, so you can always undo the changes it has made using the normal WME undo button.
| | For example an Event row should look like this; |
| After running the script, fix any missing or incorrect info. You can run the script multiple times and it will adjust to the updated info.
| |
| Once the place info looks good, save !
| |
|
| |
|
| <span style="color:#FF0000; background:#fff">NOTE: The script sometimes offers links to search the web for a place's website. DO NOT copy and paste information from 3rd party sources like Google. Visit the place website and gather information from there instead.</span>
| | {{Tlx|Event/Item|name=''EVENT NAME''|date{{=}}14/10|in progress|username|updated{{=}}14/08}} |
|
| |
|
| ==Screencasts (Watch how it works!)==
| |
| [http://quick.as/02lyC77Yq Basic example of a non-chain place]
| |
| [http://quick.as/kV92U55qo Basic example of a chain place]
| |
| [http://quick.as/GR2vTzzPa Basic example of duplicate finder and error checking]
| |
| [http://quick.as/bRAqTOOr1 WMEPH Whitelisting Feature]
| |
| [http://quick.as/V21pC22zL Place Info Cloning Feature (Rank 3+)]
| |
|
| |
|
| =Feature List=
| | If there are multiple editors it should look like this |
| <span style="color#DD00DD">New in v. 1.1: Place Highlighter</span>:
| |
| Place highlighting for all map markers shows places that need work. The highlighting works with your whitelisting settings. At this time, it does not check chain-specific errors. Options allow for disabling the use of Whitelist data and also suppressing highlights for the Missing Hours flag. [http://i.imgur.com/623BwaQ.png Highlight Key] [http://i.imgur.com/oz8WnzH.jpg Sample Screenshot]
| |
|
| |
|
| ==For chains on the PNH data sheet== | | {{Tlx|Event/Item|name=''EVENT NAME''|date{{=}}14/10|in progress|username1|username2|updated{{=}}14/08}} |
| Names, Categories, and URL are updated from standard information, as long as the data has been approved by a moderator for your area. [http://i.imgur.com/hzS7Q9l.png Screenshot] New places and existing place approvals are always being added.
| |
| Note: The script matches places with PNH entries based on the place name. Some variation is accounted for, but misspellings and extraneous info in the place name may prevent a match. Feel free to report these to improve the matching algorithms.
| |
| Reminder messages for certain places are displayed, including hotel localization, special cases, alternate names, and optional place information. Some are easily applied with a single click [http://i.imgur.com/VkD6Upc.png Screenshot].
| |
| Places on the sheet but not approved for the state/region provide a link to an approval form.
| |
| New chains can be submitted through the banner button. [http://i.imgur.com/sg1gu4Q.png Screenshot]
| |
|
| |
|
| ==Place fields checked and updated==
| |
| ===Category===
| |
| * Unlikely and parent categories are flagged. [http://i.imgur.com/PZmkU4q.png Screenshot]
| |
| * Category-based reminders and options are provided. [http://i.imgur.com/17m4Vlh.png Screenshot] [http://i.imgur.com/73JUnyz.png Screenshot]
| |
| * Hospitals and Schools with unlikely names (dentist, etc.) are flagged with options to change to Offices or Pet/Vet Services. [http://i.imgur.com/kh0ukSE.png Hospital Screenshot] [http://i.imgur.com/Nfi4nFn.png School Screenshot]
| |
|
| |
|
| ===Name===
| |
| * Place names are automatically capitalized, with option to force full Title Casing
| |
| * Any alt-names are checked for search functionality, and unnecessary alt-names are removed (e.g., For Starbucks, starbuck and starbucks alts from the recent ad campaign are useless)
| |
|
| |
|
| ===Description===
| | '''Whenever you edit this table, please be sure to include the name of the event you are editing in the summary field under the edit box.''' |
| * Updated from PNH data where applicable
| | ———————————————————————————————————— |
| * Checked for special cases such as Pharmacy hours for some chains [http://i.imgur.com/YOR1J7I.png Screenshot]
| |
|
| |
|
| ===Lock level===
| |
| * Places with complete address information and no major flags are locked according to the place category and the locking rules of the state/region
| |
| * Places with invalid or bad info or not in line with wiki rules are not locked
| |
|
| |
|
| ===Point vs. Area===
| |
| * Places are checked for Point vs. Area based on the [https://wiki.waze.com/wiki/Places#When_to_use_Area_or_Point Places wiki] and flagged. [http://i.imgur.com/Ljg6j6p.png Screenshot]
| |
| * A button allows quick change to the right geometry type. When changing from area to point, the button uses the stop point as the location of the new point
| |
| * Exceptions for states/regions are incorporated into the script. Please report any discrepancies
| |
|
| |
|
| ===Address===
| | ''The actual contents of this page '''will only be visible''' in the [[{{BasePage2 }}/Closures|Major Events table]], or when editing this page.'' |
| * House numbers are checked for length and format, flagging anything out of spec, or if it’s missing. [http://i.imgur.com/WVXkrWm.png Screenshot]
| |
| * Street and City fields are flagged if missing.
| |
| * Checks HN against nearby addresses to see if there is a potential issue with the HN or street name
| |
| Places with “No Address” have no information at all, so the script uses nearest segments to infer country, state, city, and street information. This is used to refine searching, but also this can (optionally for R3+) be applied to the place point address fields. [http://i.imgur.com/21RdgLZ.jpg Screenshot]. (When running the script on PURs at low zoom, the script will not run on places with "No Address" since it needs to be zoomed to see the nearby streets. There is an option to enable auto-zoom for these cases.)
| |
|
| |
|
| ===Website=== | | ==TO EDIT THIS TABLE CLICK HERE >> == |
| * Unnecessary protocols such as http:// are stripped from URLs while https:// remains
| | </noinclude><includeonly><!-- |
| * Deep links (eg: store info pages) can be optionally preserved when matching from PNH data, as long as domains match
| | ------ DO NOT MODIFY ABOVE THIS LINE ----- |
| * URLs are formatted (WWW -> www, etc.)
| | ====== ====== |
| * Banner buttons provide links to the store website or store locator page (some of which auto-fill the place location). [http://i.imgur.com/ylkeOvU.jpg Store locator] [http://i.imgur.com/rW9wCto.jpg Web search] [http://i.imgur.com/ti69WFv.jpg Place website]
| | ====== ====== |
| | ====== ====== |
| | ====== DO NOT MODIFY ABOVE THIS LINE ====--> |
| | {{Event/Item|name=New Years Celebration|area=NYC|road=Times Sq/Coney Island|pl=https://docs.google.com/spreadsheets/d/1Ira6IdyS3x3YtAlTqoXbU1Muw4ANl8rq7af2zKLcCtM/edit#gid=1716991474|date=12/31-01/01 annual|status=submitted|Rfrsw101|jdelosa|johnsninja58|PesachZ|updated=2017/02/08}} |
|
| |
|
| ===Phone=== | | {{Event/Item|name=NYC 1/2 Marathon & St. Patricks' Day Parade|date=03 annual|pl=https://docs.google.com/spreadsheets/d/1Ira6IdyS3x3YtAlTqoXbU1Muw4ANl8rq7af2zKLcCtM/edit#gid=339510355|area=NYC|road=5 Boroughs|status=submitted|updated=2017/02/09|Rfrsw101|jdelosa|johnsninja58|PesachZ}} |
| * Validates phone field for invalid area codes and exchanges, or incorrect number of digits. [http://i.imgur.com/R2YE4Pi.jpg Screenshot]
| |
| * Flag Area codes that are out of state [http://i.imgur.com/aieKHAO.png Screenshot]
| |
| * Reformats phone into proper style for the country/region/state. [http://i.imgur.com/Nw5Idmn.png Screenshot]
| |
| * Alphanumeric phones like 1-800-CAR-4YOU can be entered in the phone field and the script will convert them.
| |
|
| |
|
| ===Services=== | | {{Event/Item|name=July 4th Celebration|area=NYC|status=submitted|updated=2017/02/12|Rfrsw101|jdelosa|johnsninja58|PesachZ|road=FDR Dr|date=07/04 annual|pl=https://docs.google.com/spreadsheets/d/1Ira6IdyS3x3YtAlTqoXbU1Muw4ANl8rq7af2zKLcCtM/edit#gid=1864894199|source=http://www.nyc.gov/html/dot/html/motorist/wkndtraf.shtml}} |
| * Common services based on category can be optionally added automatically
| |
| * Services can be toggled from the banners using clickable icons. [http://i.imgur.com/DPJnnHR.png Screenshot]
| |
|
| |
|
| ===Hours=== | | {{Event/Item|name=Summer Streets|road=Park Ave|pl=https://docs.google.com/spreadsheets/d/1Ira6IdyS3x3YtAlTqoXbU1Muw4ANl8rq7af2zKLcCtM/edit#gid=1984749524|source=http://www.nyc.gov/html/dot/summerstreets/html/home/home.shtml|date=08 First 3 Sundays|area=NYC|status=submitted|updated=2017/02/10|Rfrsw101|jdelosa|johnsninja58|PesachZ}} |
| * Places with unlikely hours are flagged. [http://i.imgur.com/t7bHQRI.png Screenshot]
| |
| * A 24/7 icon is available on the banners for quick addition of those hours. [http://i.imgur.com/zhH3tzY.png Screenshot]
| |
| * Places with missing hours are flagged and a text box is provided where you can enter the hours in two different ways. [http://i.imgur.com/z4F57Ts.png Screenshot]
| |
| <br />
| |
| Copy the hours from the place website and paste into the box. You can either add to the existing hours for sequential adding, or use the replace button to replace any existing hours. The script tries to parse the pasted info and if the text is reasonably well-formatted, it automatically updates the hours in the WME place. Auto-switching to the More Info tab allows you to verify
| |
| You can enter hours in the box by typing them. Typically, enter the days followed with the times using 24hr time and/or am/pm. Use dashes for ranges of days and hours. You can use single (MTWRFSU), double (MoTuWe etc) or triple letter (MonTueWed etc) abbreviations for the days.<br /><br />
| |
| Example: '''M-W 9-17 ThSu 10-4p FriSat 9a-9p''' would set up the hours<br />
| |
| Mon, Tue, Wed from 9a-5p<br />
| |
| Thu & Sun from 10a-4p<br />
| |
| Fri & Sat from 9a-9p
| |
|
| |
|
| ==Other Script Functions== | | {{Event/Item|name=West Indian Day Parade|date=09 Labor Day annual|area=Kings|road=Eastern Pkwy, Classon-Rochester St Johns-Empire|source=http://maps.nyc.gov/streetclosure/|pl=https://docs.google.com/spreadsheets/d/1Ira6IdyS3x3YtAlTqoXbU1Muw4ANl8rq7af2zKLcCtM/edit#gid=1605830763|status=submitted|Rfrsw101|jdelosa|johnsninja58|PesachZ|updated=2017/02/10}} |
| ===Gas Stations=== | |
| * Brands are checked and flagged if they do not match the primary name. One click to update the name and move the existing name to the alt-name. [http://i.imgur.com/XxVeTT2.png Screenshot]
| |
| * “Unbranded” is flagged, since it is not used
| |
| * Convenience Store category added to stations with one click, or optionally automatically. [http://i.imgur.com/Sf9teUv.png Screenshot]
| |
|
| |
|
| ===Residential Points=== | | {{Event/Item|name=TD 5 Boro Bike Tour|area=NYC|date=05 First Sunday annual|road=5 Boroughs|pl=https://docs.google.com/spreadsheets/d/1Ira6IdyS3x3YtAlTqoXbU1Muw4ANl8rq7af2zKLcCtM/edit#gid=790135118|Rfrsw101|jdelosa|johnsninja58|PesachZ|status=submitted|updated=2017/02/08}} |
| * Regular points with residential-type names such as “My House” are flagged
| |
| * Residential points are stripped of unneeded information and (optionally) locked
| |
|
| |
|
| ===Rest areas=== | | {{Event/Item|name=NYC TCS Marathon|area=NYC|date=11 First Weekend annual|pl=https://docs.google.com/spreadsheets/d/1Ira6IdyS3x3YtAlTqoXbU1Muw4ANl8rq7af2zKLcCtM/edit#gid=0|road=5 Boroughs|source=http://www.tcsnycmarathon.org/race-day/course|Rfrsw101|jdelosa|johnsninja58|PesachZ|status=submitted|updated=2017/02/07}} |
| * Detected based on names and categories
| |
| * Names are checked against Wiki specs
| |
|
| |
|
| ===Duplicate finder=== | | {{Event/Item|name=UN General Assembly|area=NYC|road=East Midtown|date=09 Last Two Weeks Annual|pl=https://docs.google.com/spreadsheets/d/1Ira6IdyS3x3YtAlTqoXbU1Muw4ANl8rq7af2zKLcCtM/edit#gid=1895099030|Rfrsw101|jdelosa|johnsninja58|PesachZ|status=submitted|updated=2017/02/08}} |
| * Highlights nearby places that have similar names, including whether they have photos on them. [http://i.imgur.com/ltG0mY4.jpg Screenshot]
| |
| * Optionally zooms and centers the map so that all nearby duplicates can be easily seen
| |
|
| |
|
| ===Place Whitelisting=== | | {{Event/Item|name=Macy's Thanksgiving Day Parade|area=NYC|road=Herald Square|pl=https://docs.google.com/spreadsheets/d/1Ira6IdyS3x3YtAlTqoXbU1Muw4ANl8rq7af2zKLcCtM/edit#gid=1774745119|date=11 Last Thursday Annual|source=http://social.macys.com/parade/#route|status=submitted|Rfrsw101|jdelosa|johnsninja58|PesachZ|updated=2017/02/08}} |
| * Whitelisting buttons (‘WL’) appear on some banner flags, which adds the field to a list so that the script doesn’t consider that piece of information missing or out of spec ever again. For example, a park may have no house number; after pressing the WL button, the script will no longer indicate a severe error. Places that don’t operate a website can be WL’d, etc. [http://i.imgur.com/N3BVGc5.png Screenshot]
| |
| * Whitelists can be backed up and merged, enabling sharing between editors in the same area to avoid editors researching the same information multiple times. [http://i.imgur.com/DBDpk8p.png Screenshot]
| |
| * To backup and/or share a list, press the pull button and copy the retrieved information from the text box. Save locally or email to fellow editors.
| |
| * To merge a list, first paste the list into the textbox and then press merge. Places on the new list will be added to any places already in your existing list, so no data is lost. This is also how you can restore a backup in case of data loss in the browser
| |
| * To share a list to a public Google sheet, use the Share button, which links to a form where you can submit the data (limited data capacity at present)
| |
| * To view your whitelist stats by state and country, use the Stats button
| |
| * To remove all WL data for a single state, enter the state name as shown in the stats list, and use the Remove State button
| |
| * Future feature: Whitelist info can be integrated with place highlighting so that editors can see which places still need review
| |
|
| |
|
| ===Place Cloning=== | | {{Event/Item|name=Chinese New Year Parades|date=01 or 02 annual|pl=https://docs.google.com/spreadsheets/d/1Ira6IdyS3x3YtAlTqoXbU1Muw4ANl8rq7af2zKLcCtM/edit#gid=1190958434|area=NYC|road=Chinatown/8th Avenue/Flushing|status=submitted|updated=2017/02/08|Rfrsw101|jdelosa|johnsninja58|PesachZ}} |
| ''Available for R3+''<br />
| | <!--- DO NOT MODIFY BELOW THIS LINE ------===== ===== |
| Copy information from a selected place, then paste selected info into other places that share the same information. Examples: businesses in malls that share the same address; college campuses where all buildings share address, url, and phone; businesses that share the same street and city name. To use, enable the tool in the settings tab. It will appear under the Run WMEPH button when you select a place. [http://i.imgur.com/tGtiY2Z.png Screenshot] Select the place with the info you want to use for other places, and press copy. Select a place you want to clone the info to, and check the boxes for the info you want to clone:<br /><br />
| | ===== ===== |
| HN = House Number<br />
| | ===== ===== |
| Str = Street<br />
| | ----- DO NOT MODIFY BELOW THIS LINE -----> |
| City = City, State, Country<br />
| | </includeonly> |
| URL<br />
| |
| Ph = Phone<br />
| |
| Desc = Description<br />
| |
| Serv = Services<br />
| |
| Hrs = Hours<br /><br />
| |
| 3 Buttons allow selection if all, none, or just the address fields. Then, press paste, and the info will be applied to the selected place. Repeat with as many places as desired. Copied info is removed when WME is reloaded.
| |
| | |
| ===Convenient Zooming=== | |
| * Press Ctrl-Alt-z. If you have a place selected, it zooms to the 50ft level and centers the place. If you don’t have a place selected, it zooms to the 200ft level, and centers it around where ever you have the mouse cursor at the time.
| |
| | |
| =Acknowledgements= | |
| *The current Dev Team: MapOMatic, RavenDT
| |
| | |
| *All the hard work by the previous development team in making this script a reality. You are all invited to rejoin the effort!
| |
| | |
| *Previous development team: bmtg, vtpearce, cardyin, jtsmith2, joyriding, fjsawicki, CoolCanuck, & sar851
| |
| | |
| *PNH admins: tonestertm, t0cableguy, & ialangford; CoolCanuck
| |
| | |
| *All the Beta testers and editors who submit bugs and feature requests
| |
| | |
| *rickzabel & slemmon2 for solving some Firefox issues
| |
| | |
| *All the WME script writers out there who have written many great codes.
| |
| | |
| | |
| =Development= | |
| If you have an interest in developing the script, or have an interest in helping us beta test any bugs or features while providing regular feedback please contact {{Username|t0cableguy}}
| |
| We also need help with localization, and ROW support. Anyone can fork and do a pull request at [https://github.com/WazeUSA/WME-Place-Harmonizer Github] with any bugfixes, or feature additions.
| |
| | |
| | |
| =Installation=
| |
| <!-- PLACE ALL SCRIPT DESCRIPTIONS ABOVE THIS LINE. DOWNLOAD LINKS GO BELOW -->
| |
| | |
| ↓ {{U|'''DOWNLOAD'''}} ↓
| |
| * [https://github.com/WazeUSA/WME-Place-Harmonizer/raw/master/WME-Place-Harmonizer.user.js WME Place Harmonizer]
| |
| | |
| {{Clear}}
| |
| {{ForumLink
| |
| |forum=https://www.waze.com/forum/viewtopic.php?f=819&t=215657<!-- place forum thread URL here-->}}
| |
