Scripts/URComments

From Wazeopedia
This page is an element displayed as a section on the Scripts page. The content should be edited on this page, click here to view it on the main page.



by dBsooner (PM)  Profile L2.png through WazeDev. WazeDev owns the script and all information attached to it.

On this page, you will find a brief overview of the features of the WME URComments-Enhanced script. Within WME, holding the mouse over any of the items will show tool tips describing the function or displaying the text to be used.

Note: URC-E is a replacement for URC and URC companion add-on scripts. With URC-E you no longer need URC or any of the different comment list add-on scripts. All current add-on scripts have been ported and work natively within URC-E. You may disable and/or remove URC and the add-on scripts. However, if you use your own "Custom" local list, you will still need to keep that add-on installed and enabled to use the "Custom" drop down. Hey, this could be a time to discuss converting to the new system? *wink* *wink*

Note 2: All features that URO+ applies to URs (filtering, map marker replacement, mouseover tooltip popup, etc.) have been included in URC-E.


Updates

Version: 2019.08.27.01

Assistance

Should you require any assistance on this script, or want to propose new features, please post a message in the following forum thread: URC-E (in English).

Features

WME URComments UR pill.PNG
Primary Features
  • Comment lists are maintained by list owners via a Google Sheet. Changes made are instantly live within URC-E. No need to update the script for a comment change.
  • 100% I18n translations compliant. NOTE: Translators needed! Please PM or Discord DM dBsooner if you are fluent in any language other than English and wish to help!
  • Auto switch comment list: Automatically switch to the comment list designated for the area the UR is in, if there is a list associated with the area. Opening a UR in an area that does not have a list associated will use the ""Comment List"" you have selected above.
  • Two UI styles: Default and UR Style
  • Tag email: Some comment lists have specific comments that use a replacement tag. The replacement tag is used to specify an email address to send correspondence to. If you are setup to use one of these email addresses, please specify it here. If not, leave it blank.
  • Comment List drop down on Comment list tab: You can change the currently loaded comment list using this drop down. Changing this drop down will not be saved as a setting and will not change your default list (located on the settings tab). This is only to allow you to quickly switch between lists.
  • Enable append comment mode: Enabling append comment mode will allow you to append a comment to the existing text in the new-comment box. The comment is appended with a blank line between the existing text and the new text. The status of the UR is set to the status of the new comment you clicked to append. If the comment would end up being longer than 2000 characters, append mode will give a warning and not alter the text in the comment box, but the status would have been changed.
  • Per comment list settings: The settings located in this box are customizable per comment list. By default, all comment lists use the "URC-E Master Settings" setting for each of the "Per comment list" settings. The box on the far right is the "Use URC-E Master Setting setting" for each given setting and list. (See more info below)
  • Restriction system: Gives the ability for region leadership to enforce certain features to be enabled or disabled. Region leadership has the option of enabling this system by state or country.
  • Tools tab:
    • Backup / restore / reset settings system - Backup your settings to a JSON file. Restore settings from this JSON file (do not modify the JSON file directly!). Reset URC-E back to default settings (pretty much everything disabled).
    • Create your own custom comment list with a Google spreadsheet!
    • Convert your current custom comment list to a Google spreadsheet!
  • Custom variables! See end of this post.
WME UI Tweaks
  • Widen UR Panel to 300px to keep 'Submitted on' date from wrapping.
  • UR marker pill with # comments, # days ago, etc. (See Marker preferences)
  • UR marker replacement with URO+ style marker icons for tagged URs.
  • URO+ style marker mouse-over tooltip popup with some additions:
  • Added "First comment: X days ago by editor_name (rank)"
  • Added "Last comment: X days ago by editor_name (rank)"
  • Added "Reporter has commented: Yes/No
  • Changed line breaks and spacing.
  • Added (UR ID) to header title of UR panel.
  • Added (x days ago) to each comment in UR panel.
  • Replace Next UR with Done OR hide altogether (in UR panel).
  • Added shortcuts to UR Panel for text insertion. See the end of this post for list.
URC-E Preferences
  • Auto center on UR: Auto center the map to the selected UR at the current map zoom level.
  • Auto click open, solved or not identified: Suppress the message about recent pending questions to the reporter and then, depending on the choice set for that comment, automatically select Open, Solved or Not Identified.
  • Auto close UR panel: Automatically close the UR panel after you click send on a comment.
  • Auto save after solved or NI comment: If 'Auto Click Open, Solved or Not Identified' is also checked, this will automatically click the save button after you click send on a comment that set the UR to Solved or Not Identified.
  • Auto send reminders: Automatically send the reminder comment to the URs in the map window (as you pan around) you were the last to comment on and it has reached the days specified in 'Reminder Days'. !!WARNING!! AUTOMATICALLY SEND REMINDERS at the reminder days setting. This only happens when they are visible on your screen. NOTE: When using this feature you should not leave URs open unless you asked a question that needs a response from the reporter, as this script will send reminders to all open URs after 'Reminder days'.
  • Auto set new UR comment (without description): Automatically set the default UR comment for the UR type on new (do not already have comments) URs that do not have descriptions.
  • Auto set new UR comment (SLURs): Automatically set the default UR comment for new (do not already have comments) SLURs.
  • Auto set new UR comment (with description): Automatically set the default UR comment for the UR type on new (do not already have comments) URs that do have descriptions.
  • Auto set reminder UR comment: Automatically set the UR reminder comment for URs that are older than the 'Reminder days' setting and have only one comment.
  • Auto switch to the URC-E tab: Automatically switch to the URComments-Enhanced tab when opening a UR. When the UR panel is closed you will be switched back to your previous tab.
  • Auto zoom in on new UR: Automatically zoom in when opening new (no comments) URs.
  • Auto zoom out after comment: Automatically zoom the map back to the previous zoom after clicking clicking send on a UR comment.
  • Disable Done / Next UR button: Disable the done / next buttons at the bottom of the UR panel.
  • Replace Next UR button with Done: Replace the Next Update Request button with a Done button.
  • Double click link - Not Identified comments: Add an image (extra link) to the 'not identified' comments. When double clicked it will automatically set and send the UR comment of the one you double clicked, and then launch all of the other options that are enabled.
  • Double click link - Open comments: Add an image (extra link) to the 'open' comments. When double clicked it will automatically set and send the UR comment of the one you double clicked, and then launch all of the other options that are enabled.
  • Double click link - Solved comments: Add an image (extra link) to the 'solved' comments. When double clicked it will automatically set and send the UR comment of the one you double clicked, and then launch all of the other options that are enabled.
  • Hide zoom out links: Hide the zoom out links on the comments tab.
  • Unfollow UR after send: Unfollow the UR after sending a comment.
  • Enable UR overflow handling: If this setting is enabled and there are more than 499 URs on the screen, URC-E will attempt to gather more URs and add them to the map, if they do not already exist. WME does not display more than 500 URs on a single screen on its own. This setting follows the WME Layer setting for hide / show closed URs.
  • Enable auto refresh on zoom / pan: Reloads the map data when zooming or panning to show URs that may have been missed due to WME's 500 UR limit. Will only reload if the zoom level is between 3 and 10, there are not pending edits, and there are more than 499 URs loaded.
  • Tag email: Some comment lists have specific comments that use a replacement tag. The replacement tag is used to specify an email address to send correspondence to. If you are setup to use one of these email addresses, please specify it here. If not, leave it blank.
  • Reminder days: Number of days to use when calculating UR filtering and when setting and/or sending the reminder comment. This is the number of days since the first comment. Set to 0 if you do not use reminders.
  • Close days: Number of days to use when calculating UR filtering. This is the number of days since the last comment. Example: If you close 4 days after the last comment, set to 4. Anything less than this time will be considered 'waiting' as long as there is at least one comment already.
  • Custom tagline: This is to allow users to have a single "tagline" that can be added to the end of each comment they want. A managed list might use this and tell you what to do. An example of a custom tagline: "If you still have issues after this report is closed. Please feel free to email me at my@email.com." Then a comment would have the variable $CUSTOMTAGLINE$ in it and would insert your tagline there. The custom tagline is a "per comment list" setting. Meaning you can have a different one for each comment list, or have them use the "master" setting.
UR Marker Preferences:
  • Enable UR pill counts: Enable or disable the pill with UR counts on the map marker.
  • Disable UR marker popup: Do not show the UR popup tooltip when you mouse over a UR marker.
  • UR marker popup delay: The number of milliseconds (* 100) to delay before the UR marker tooltip will be displayed.
  • UR marker popup timeout: Specify the number of seconds to leave the UR marker tooltip displayed, while hovering over the marker. Leaving the marker, unless to the tooltip itself, will cause the tooltip to close. Entering the tooltip will cancel the timer and leaving the tooltip will close the tooltip. Double click to quickly close.
  • Don't show tag name on pill: Do not show the tag name on the pill where there is a tag. Example: [NOTE]
  • Replace tag name with editor name: When a UR has the logged in editors name in the description or any of the comments of the UR (not the name Waze automatically adds when commenting), replace the tag type with the editors name.
  • Unstack markers: Attempt to unstack markers by offsetting them. Similar to how URO+ unstacks markers. Markers not involved in the current "stack" will be temporarily hidden until restacking.
    • Unstack sensitivity: Specify the sensitivity for which markers are considered stacked. Default: 15.
    • Unstack disable when zoom level <: Disabled unstacking when zoomed out wider than the specified zoom. Default: 3.
  • Use Custom Markers for: Replace default UR marker with custom marker for the URs with these tags in the description or comments:
[BOG] / [BOTG]
[CLOSURE]
[CONSTRUCTION]
[DIFFICULT]
[EVENT]
[NOTE]
[ROADWORKS]
[WSLM]
Native speed limits
Custom: You specify.
UR Filtering Preferences
  • Enable URC-E UR filtering: Enable or disable URComments-Enhanced built-in UR filtering.
  • Invert filters: When enabled, changes all filters to be "show" instead of "hide".
  • Hide outside editable area: Hide URs outside your editable area.
  • Do not filter tagged URs: Do not filter URs that are tagged with a [] tag. Example: [NOTE]
  • Do not hide selected UR: Do not hide a UR if it is currently being selected.
  • Disable filtering when zoom level <: Disabled UR filtering when zoomed out wider than the specified zoom level. Set to '0' to enable all filtering.
  • Disable filtering when zoom level >: Disable UR filtering when zoomed in tighter than the specified zoom level. Set to '10' to enable all filtering.
  • Hide/show by lifecycle status:
    • Waiting: If you use reminders (Reminder days > 0), waiting is any UR with more than 1 comment and less than the close days from the last comment. I.E. The URs that do not need work.
    • Close needed: Any UR with more than 1 comment (if using reminders) or at least 1 comment (if not using reminders) and last comment is older than close days ago.
    • Reminders needed: If using reminders, any UR with only 1 comment and that comment was greater than reminder days ago.
  • Hide/show by status: Hide/show URs by their current status.
    • Open
    • Closed
    • Not identified
    • Solved
    • Closed by: Command separated listed of username(s).
  • Hide/show by type: Hide/show URs based on their Waze UR type (note some of these are not used by Waze at the moment).
    • Closed road
    • General error
    • Incorrect address
    • Incorrect junction
    • Incorrect route
    • Incorrect street prefix or suffix
    • Incorrect turn
    • Missing bridge overpass
    • Missing exit
    • Missing Place
    • Missing or invalid speed limit
    • Missing road
    • Missing roundabout
    • Missing street name
    • Turn not allowed
    • Undefined
    • Waze automatic
    • Improper / Poor navigation instructions
  • Hide/show by tagged: Hide/show all URs with the specified TAG in description or comments.
[BOG] / [BOTG]
[CLOSURE]
[CONSTRUCTION]
[DIFFICULT]
[EVENT]
[NOTE]
[ROADWORKS]
[WSLM]
  • Hide/show by age of submission:
    • Less than days: Hide/show URs that were originally created less than specified number of days ago.
    • More than days: Hide/show URs that were originally created more than specified number of days ago.
  • Hide/show by description, comment, following:
    • Following / Not following: Hide/show URs you are following or not following.
    • Description With / Without: Hide/show URs with or without descriptions.
    • Comments from me With / Without: Hide/show URs with or without comments from you.
    • First comment by me Yes / No: Hide/show URS where the first comment was by you or not by you.
    • Last comment by me Yes / No: Hide/show URs where the last comment was by you or not by you.
    • Last comment by reporter Yes / No: Hide/show URs where the last comment was by the reporter or not.
    • Less than comments: Hide/show URs that contain less comments than the number specified.
    • More than comments: Hide/show URs that contain more comments than the number specified.
    • First comment less than days: Hide/show URs where the first comment is less than the days specified ago.
    • First comment more than days: Hide/show URs where the first comment is more than the days specified ago.
    • Last comment less than days: Hide/show URs where the last comment is less than the days specified ago.
    • Last comment more than days: Hide/show URs where the last comment is more than the days specified ago.
    • Including keyword: Hide/show URs that include the custom word / text specified.
    • Not including keyword: Hide/show URs that do not include the custom word / text specified.
    • Case-insensitive keyword matches: If enabled, searching for the above including or not including keywords will be done using case insensitive searching.
    • With comment by: Hide/show URs that have been commented on by the specified user(s). Use a comma (",") to separate usernames.
    • Without comment by: Hide/show URs that have note been commented on by the specified user(s). Use a comma (",") to separate usernames.

The per comment list settings additionally have the following occurring on them:

  1. When you check / uncheck the "Use URC-E Master Settings setting" checkbox for a given per comment list setting, URC-E will update that per-comment list setting to match what is currently set for the URC-E Master Settings setting.
  2. When you change a per comment list setting, it is only changed for the currently loaded / selected comment list. These settings are saved with all other settings.
  3. When you change one of the URC-E Master Settings settings that also have a matching per comment list setting, URC-E will go through all your "per comment list" settings and update the changed setting for any lists that have the given setting set to "Use URC-E Master Settings setting".
Custom variables

Allows you to create your own custom variables to use throughout your comments. Custom variables can be nested. If you are a URC-E master control comment list maintainer, your tab has already been setup to allow for this. If you have your own custom sheet, you will need to modify your "Data validation" for column C (URSTATUS) to allow "CUSTOM VAR" to be a valid option. To use:

  1. Set the title (column A) to the variable name you would like to use. WITHOUT the $'s.
Ex: CUSTOM_GREETING
  1. Set the "Comment" (column B) to be the replace text you would like to use.
Ex: Good $CURRENTDATE_TIME_CASUAL$! I am a fellow Wazer like you!
  1. Set the "URSTATUS" (column C) to be "CUSTOM VAR".
  2. Wherever you want to use this variable in your other comments, simply place the name wrapped in $'s in the comment.
Ex: $CUSTOM_GREETING$ I see you reported a $URTYPE$ issue near $SELSEGS_WITH_CITY$. Would you mind telling me more information that might help me assist with solving the issue? ...
Custom tagline

This is to allow users to have a single "tagline" that can be added to the end of each comment they want. A managed list might use this and tell you what to do. An example of a custom tagline: "If you still have issues after this report is closed. Please feel free to email me at my@email.com." Then a comment would have the variable $CUSTOMTAGLINE$ in it and would insert your tagline there. The custom tagline is a "per comment list" setting. Meaning you can have a different one for each comment list, or have them use the "master" setting.

Shortcuts in the UR Panel (and their variables to use in sheets)
  • Current date (Calendar icon (left side) or variable $CURRENTDATE_DATE$): Inserts the current date with 2-digit day, 2 digit month and 4 digit year in the current locale format.
  • Current date casual (Calendar icon (right side) or variable $CURRENTDATE_DATE_CASUAL$): Inserts the current date as full month name and 2 digit day in the current locale format.
  • Current day of week (Sun icon or variable $CURRENTDATE_DAY_OF_WEEK$): Inserts the current day of the week in the current locale language.
  • Current time (Clock icon (left side) or variable $CURRENTDATE_TIME$): Inserts the current time in 2 digit hour, 2 digit minute and abbreviated timezone, in the current locale.
  • Current time casual (Clock icon (right side) or variable $CURRENTDATE_TIME_CASUAL$): Inserts current time in casual, translated in current locale if available, according to:
    • 04:00am-11:59am: morning
    • 12:00pm-05:59pm: afternoon
    • 06:00pm-08:59pm: evening
    • 09:00pm-03:59am: night
  • Custom tagline (Tag icon or variable $CUSTOMTAGLINE$): Inserts the custom tagline for the currently loaded comment list, or replaces it with nothing if blank.
  • Drive date (Calendar icon (left side) or variable $DRIVEDATE_DATE$): Insert the drive date into the new comment box at the cursor position (2-digit month, 2-digit day, 4-digit year in locale format).
  • Drive date casual (Calendar icon (right side) or variable $DRIVEDATE_DATE_CASUAL$): Insert the drive date into the new comment box at the cursor position (full month name, 2-digit day in locale format).
  • Drive date full casual (Calendar with + icon (right side) or variable $DRIVEDATE_TIME_CASUALMODE$): Insert the drive date into the new comment box at the cursor position with the following table as a reference (in locale translation):
    • 0 days: this morning, this afternoon, this evening, tonight
    • 1 days: yesterday morning, yesterday afternoon, yesterrday evening, last night
    • 2-6 days: Day_of_Week morning/afternoon/evening/night
    • 7-13 days: last Day_of_Week morning/afternoon/evening/night
    • 14-20 days: Day_of_Week before last
    • 21-27 days: three weeks ago
    • 28-60 days: a few weeks ago
    • 61-120 days: a couple months back
    • 121+ days: a while ago
  • Drive day of week (Sun icon or variable $DRIVEDATE_DAY_OF_WEEK): Insert the drive date day of the week into the new comment box at the cursor position (full day of week name in locale language).
  • Drive time (Clock icon (left side) or variable $DRIVEDATE_TIME$): Insert the drive date time of day into the new comment box at the cursor position (2-digit hour, 2-digit minute in locale format).
  • Drive time casual (Clock icon (right side) or variable $DRIVEDATE_TIME_CASUAL$): Insert the drive date time of day into the new comment box at the cursor position (in locale language).
    • 04:00am-11:59am: morning
    • 12:00pm-05:59pm: afternoon
    • 06:00pm-08:59pm: evening
    • 09:00pm-03:59am: night
  • Place address (Pin icon or variable $PLACE_ADDRESS$): Inserts the address, with city and state (as appropriate) for the currently select place.
  • Place name (House icon or variable $PLACE_NAME$): Inserts the name of the currently selected place, or "residential place" (in the current language) if it is an RPP.
  • Selected segments (Road icon or variable $SELSEGS$): Either replaces '$SELSEGS$' (or '$SELSEGS)' with the name of the currently selected segment(s), or it will insert the name of the currently selected segment(s) into the comment box at the cursor position.
  • Selected segments with city (Road icon with + or variable $SELSEGS_WITH_CITY$): Same as $SELSEGS$, except includes the city name if 1) one selected segment and it contains a primary city 2) two selected segments and 2a) both have the same city as their primary OR 2b) one has a primary city and the other is set to "no city".
  • UR description (Paragraph icon or variable $URD$): Insert the UR description into the new comment box at the cursor position.
  • UR type: (Info icon or variable $URTYPE$): Inserts the UR type of the currently selected UR.
  • Waze username (User icon or variable $USERNAME$): Insert your Waze username into the new comment box at the cursor position.

Comments

CALLING COMMENT LIST OWNERS: All the URC comment lists have been ported to URC-E. They are now manageable through the below Google Sheet link. If you are the original owner of the list, please contact me via PM or Discord DM. If you no longer wish to maintain the list, I need to know that as well. If you would like to maintain a list, please also contact me and I can try to get in touch with the owner.

NEW LISTS: If you are interested in having your own list included, please contact me. The best scenario would be to have lists for states / regions or countries. I am working with several regions currently and they are following a model I have created in the SCR that allows for a group of editors to combine their ideas together to create a region list.

Current comment lists
  • Bahasa Indonesia: projectronic
  • CommentTeam: CommentTeam (See list below) - Initial DEFAULT list
  • Custom (for use by those that still have an addon static "custom" list)
  • Custom G Sheet (for using your own custom comment list hosted in a Google Sheet)
  • Dutch - Belgium: WimVandierendonck
  • Dutch - Netherlands: moweez
  • English - India: moweez
  • English - International: moweez
  • Estonian: matsalka
  • French: Corentin-48, asph4lt
  • German: Iridium1
  • German - Austria: fuchserl
  • Israeli Hebrew
  • Italian: m4rc072
  • Lithuanian: moweez
  • Malaysia (en-zh-ms) - Rising_Sun
  • Persian: babak_khd, BehnamNHappy, Shrm75
  • Polish: mdymek
  • Portuguese - Brazil: GibiruX_ - AUTOSWITCH for country Brazil
  • Portuguese - Portugal
  • Romanian: spookyx
  • Spanish - Bolivia: crotalo
  • Spanish - Chile: Gasparfox
  • Spanish - Colombian: mincho77
  • Spanish - Dominican: RafaCintron, mincho77
  • Spanish - Ecuador: aamazotr
  • Spanish - Mexico: arielorellana
  • Spanish - Puerto Rico: cotero2002 - AUTOSWITCH for country Puerto Rico
  • Spanish - Spain: huakayo
  • Spanish - Venezuela: moweez
  • Switzerland - DE: vince1612 (Auto-switch for states with DE language)
  • Switzerland - FR: vince1612 (Auto-switch for states with FR language)
  • Switzerland - IT: vince1612 (Auto-switch for states with IT language)
  • USA - SCR: SCR CommentTeam - AUTOSWITCH for states Arkansas, Louisiana, Mississippi, Oklahoma and Texas
  • USA - SER: itzwolf - AUTOSWITCH for states Alabama, Florida and Georgia
  • USA - NOR: NOR CommentTeam
  • USA - MAR: MAR CommentTeam
  • User: PesachZ: PezachZ


↓ URC-E is available on the following browsers:

Bring up comments or questions on this page in this forum Forum topic unread.gif.