Scripts/URComments: Difference between revisions View history

Script Subpage
VisualWikitext
m (PesachZ moved page Scripts/UR Comments to Scripts/URComments: renaming script as per author)
(new version)
Line 5: Line 5:
## --><!-- VERY BRIEF SCRIPT SUMMARY GOES BELOW THIS LINE  
## --><!-- VERY BRIEF SCRIPT SUMMARY GOES BELOW THIS LINE  
## --------------------------------------------------------->
## --------------------------------------------------------->
This script streamlines responding to URs. It can autofill the comment based on UR type, or you can choose from a list of responses. It can enhance the UR icons to show their status at a glance, and filter by status.
This script streamlines the process of responding to Update Requests. It enhances the UR icons to show their status at a glance, and can also filter by status. It generates comments based on UR type and days since last response, or you can manually choose from a list of comments. The comments are adjustable before sending. Several languages are available, if yours is not available, you can make your own custom list.
<!--##----------------------------------------------------
<!--##----------------------------------------------------
## VERY BRIEF SCRIPT SUMMARY GOES ABOVE THIS LINE -->|<br><!--
## VERY BRIEF SCRIPT SUMMARY GOES ABOVE THIS LINE -->|<br><!--
Line 13: Line 13:
by {{Username|Rickzabel}}
by {{Username|Rickzabel}}


Streamline the process of responding to Update Requests. It can autofill the comment box based on UR type, or you can manually choose from the list of responses, depending on your preference.
On this page, you will find a brief overview of the features of the WME URComments 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. For an extensive description, please view the [[{{DraftLink|URComments_new}}#Illustrated_slideshow|illustrated slideshow]].


If you have UR Overview installed (URO+), UR Comments can integrate with it to provide quick presets that will change UR Overview's settings to show different UR types. UR Overview plus is not required to run UR comments.
=== Updates ===
This script has an auto-update feature which automatically download and install the up-to-date version upon release.
 
=== Assistance ===
Should you require any assistance on this script, or want to propose new features, please post a message in the following forum thread: [http://www.waze.com/forum/viewtopic.php?f=819&t=122776 UrComments] (in English).
 
=== Features ===
[[File:WME URComments UR pill.PNG|right]]
WME URComments displays the URs in your screen with a brief indication of its status; amount of comments, amount of days since last comment, and who the commenter is. White and blue pills indicate URs that you currently handle. You can find an elaborate description of the pills in the [[{{DraftLink|URComments_new}}#Illustrated_slideshow|illustrated slideshow]].<br />
 
This script adds another tab to the left side panel in WME. There are four main elements, the header and three sub tabs. We will explain each of the elements below.
 
===== Header =====
[[File:WME URComments tab1.PNG|right]]
# '''UR Comments Version Number''': Tampermonkey and Greasemonkey are not always reliable at fetching updates, so once-in-a-while it is a good idea to check your version number against the version listed on greasyfork.
# '''Zoom Out 0 & Close UR''': Zooms all the way out and closes the UR window.
# '''Zoom Out 2 & Close UR''': Zooms out to level 2
# '''Zoom Out 3 & Close UR''': Zooms out to level 3. This is where you can find most of the toolbox highlighting works.
# '''55''' or any other number: amount of active URs (maybe hidden by filters) in your display
# [[File:WME URComments reloadbutton.PNG]] Map reload button: Reloads the map without having to go into Waze's layers menu
 
==== Comments ====
WME URComments generates comments based on UR report type. You can have them auto-inserted in the text window of the UR, or choose from a list of other comments. You can adjust the comments before sending, depending on the presets. To make your own custom list, view the [[{{DraftLink|URComments_new}}#Tutorial_to_Customize_URComments|tutorial]].
<br />
 
[[File:WME URComments Comments small.PNG |right]]<br />
 
The comments in the list are color coded, black, orange, green, and red. They all generate a standard text that auto-inserts in the comment window. If you enable the setting "Auto click open, solved, not identified", the script will also set the status of the UR:
*'''Black''' comments set the UR Status to "Open"
*<span style="color:#E68A00">Orange</span> comments set the UR Status to "Not Identified"
*<span style="color:#008F00">Green</span> comments set the UR Status to "Solved"
*<span style="color:#CC0000">Red</span> comments have errors in the script; they will still generate the comment text and then set the UR Status to "Open"
 
Before actually sending your commment, make sure you understand the report and adjust the text accordingly!
 
==== Filters ====
[[File:WME URComments filters3.PNG|left]]
<br /><br />
 
You can set several kinds of filters for URs to display. Hover your mouse over the items will show tool tips describing their function.
<br /><br />
The Filters and Auto Reminders work in conjunction with the Reminder days and Close Days setting.
<br /><br /><br /><br /><br />
 
Also, you can set the amount of days after you wish to send a reminder message, and the amount of days after you would like to close a message. <br />
 
 
===== Integration with URO+ =====
<!--URO+ shortcuts are deleted from the script -->
From version 1.1.0 on, you can easily use URComments without [[Scripts#UR_Overview_Plus_.28URO.2B.29|URO+]] installed, since URComments has it's own filter settings. For those using URO+, URComments works smoothly together. However, if you use URO+ filters, the filters of URComments will be disabled. To enable them, simply check ''Enable URComments UR filtering''. You may need to disable URO+ filters first.<br /><br />
<!--Previous text: From version 1.1.0 on, you can easily use URComments without URO+ installed, since URComments has it's own filter settings. However, if you use URO+ filters, the filters of URComments will be disabled. To enable them, simply click URO+ Clear UR Filters, and subsequently check Enable URComments UR filtering (from the first list). -->
 
==== Settings ====
[[File:WME_URComments_settings.PNG|right]]
In the settings, you define how URComments works for you. To make yourself acquintainted, it is recommended to check all settings from the first list, except the 8th and the last two. Holding the mouse over any of the items will show tool tips describing the function.
 
From the Comment List Drop down menu, choose which list you want to use. The available files are listed under [[{{DraftLink|URComments_new}}#Installation|Installation]]. To make your own list, use the Custom List and view the tutorial. If you need support, you can find [[{{DraftLink|URComments_new}}#Assistance|assistance]] in the forum.
 
Some advanced settings are at the bottom of this tab. Make yourself acquainted with this script before you change the settings and use them with care, especially the ''Auto send reminders'' option.
 
=== Illustrated slideshow ===
 
==== Presentation of WME URComments ====
 
{{#widget:Iframe
|url=https://docs.google.com/presentation/d/1zwdKAejRbnkUll5YBfFNrlI2I3Owmb5XDIbRAf47TVU/embed?start=false&loop=false&delayms=30000
|border=0
|width=700
|height=423
}}<br />
 
You can view this presentation [http://docs.google.com/presentation/d/1zwdKAejRbnkUll5YBfFNrlI2I3Owmb5XDIbRAf47TVU/present#slide=id.p full screen], or open the [http://goo.gl/kLg7e2 slide show] in google drive.
 
==== Tutorial to Customize URComments ====
Especially for the use of URComments in other languages, there is a Custom List that you can use to make a list of comments in your own language. In this tutorial you will find an elaborate explanation on how to do that. If you like support making your custom list, contact {{Username|moweez}}.
<br />
 
{{#widget:Iframe
|url=https://docs.google.com/presentation/d/1f_oFpJwa6FyUEhQOCFhMcG8SY9_xoPSAc9gwyDIXf08/embed?start=false&loop=false&delayms=30000
|border=0
|width=700
|height=423
}}<br />
 
You can view this presentation [http://docs.google.com/presentation/d/1f_oFpJwa6FyUEhQOCFhMcG8SY9_xoPSAc9gwyDIXf08/present#slide=id.p full screen], or open the [http://docs.google.com/presentation/d/1f_oFpJwa6FyUEhQOCFhMcG8SY9_xoPSAc9gwyDIXf08/edit?usp=sharing slide show] in google drive.


<!-- PLACE ALL SCRIPT DESCRIPTIONS ABOVE THIS LINE. DOWNLOAD LINKS GO BELOW -->
<!-- PLACE ALL SCRIPT DESCRIPTIONS ABOVE THIS LINE. DOWNLOAD LINKS GO BELOW -->


↓ {{U|'''DOWNLOAD'''}} ↓
↓ {{U|'''DOWNLOAD'''}} ↓
* See [[User:Rickzabel/UrComments/|The author's page]] for more information.
WME URComment is available on the following browsers:
* Chrome: [http://greasyfork.org/en/scripts/5592-wme-urcomments-stable WME URComments] via [http://tampermonkey.net/ ''TamperMonkey'']
<!--[[{{DraftLink}}#Greasemonkey_or_Tampermonkey_add-on_for_script_management|''TamperMonkey'']]-->
* Firefox: [http://greasyfork.org/en/scripts/5592-wme-urcomments-stable WME URComments] via [http://addons.mozilla.org/en-US/firefox/addon/greasemonkey/ ''Greasemonkey'']
<!-- [[{{DraftLink}}#Greasemonkey_or_Tampermonkey_add-on_for_script_management|''Greasemonkey'']]-->
To use other languages or make your own custom list, you need to install one of the following scripts in addition:<br />
* [http://greasyfork.org/en/scripts/6236-wme-ur-comments-custom-list/ Custom List] Install and edit this file if you wish to customize comments. There is a [[{{DraftLink|URComments_new}}#Tutorial_to_Customize_URComments|tutorial]] at the bottom of this page to guide you.
* [http://greasyfork.org/en/scripts/13272-wme-urcomments-international-list International List]: a shorter and slightly simpler version of the Comment Team list. This list has some extra comments, handy for base map editing and starting communities.<br />


Languages:
* [http://greasyfork.org/en/scripts/7292-wme-urcomments-brazilianportuguese-list Brazilian (Portuguese) Comments], maintained by {{Username|Murilo-Carvalho}}
* [http://greasyfork.org/en/scripts/13840-wme-urcomments-colombian-spanish-list Colombian (Spanish) Comments], maintained by {{Username|Mincho77}}
* [http://greasyfork.org/en/scripts/7276-wme-urcomments-dutch-list Dutch Comments], maintained by {{Username|moweez}}
* [http://greasyfork.org/en/scripts/8682-wme-urcomments-hebrew-list Israeli (Hebrew) Comments ] maintained by {{Username|crayzee}}
* [http://greasyfork.org/en/scripts/13197-wme-urcomments-bahasa-indonesia Indonesian (Bahasa) Comments], maintained by {{Username|projectronic}}
* [http://greasyfork.org/en/scripts/14100-wme-urcomments-spanish-list Spanish Comments], maintained by {{Username|cotero2002}}
<!-- do personal user's scripts need to be published on the wiki page?
'''User's Lists'''
[http://greasyfork.org/en/scripts/7272-wme-ur-comments-pesachz-list PesachZ's Comments ''on GreasyFork.org'']  maintained by PesachZ.''
-->
{{Clear}}
{{Clear}}
<!-- {{ForumLink
<br />
|forum=http://www.waze.com/forum/viewtopic.php?YOUR_THREAD}}-->
 
{{ForumLink
|forum=http://www.waze.com/forum/viewtopic.php?f=819&t=122776}}


<!-- PLACE CATEGORIES BELOW THIS LINE -->
<!-- PLACE CATEGORIES BELOW THIS LINE -->
<noinclude>[[Category:Script Subpage]]</noinclude>}}
<noinclude>[[Category:Script Subpage]]</noinclude>}}

Revision as of 17:44, 24 November 2015

 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 Rickzabel (PM [Help])  

On this page, you will find a brief overview of the features of the WME URComments 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. For an extensive description, please view the illustrated slideshow.

Updates

This script has an auto-update feature which automatically download and install the up-to-date version upon release.

Assistance

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

Features

WME URComments displays the URs in your screen with a brief indication of its status; amount of comments, amount of days since last comment, and who the commenter is. White and blue pills indicate URs that you currently handle. You can find an elaborate description of the pills in the illustrated slideshow.

This script adds another tab to the left side panel in WME. There are four main elements, the header and three sub tabs. We will explain each of the elements below.

Header
  1. UR Comments Version Number: Tampermonkey and Greasemonkey are not always reliable at fetching updates, so once-in-a-while it is a good idea to check your version number against the version listed on greasyfork.
  2. Zoom Out 0 & Close UR: Zooms all the way out and closes the UR window.
  3. Zoom Out 2 & Close UR: Zooms out to level 2
  4. Zoom Out 3 & Close UR: Zooms out to level 3. This is where you can find most of the toolbox highlighting works.
  5. 55 or any other number: amount of active URs (maybe hidden by filters) in your display
  6. Map reload button: Reloads the map without having to go into Waze's layers menu

Comments

WME URComments generates comments based on UR report type. You can have them auto-inserted in the text window of the UR, or choose from a list of other comments. You can adjust the comments before sending, depending on the presets. To make your own custom list, view the tutorial.


The comments in the list are color coded, black, orange, green, and red. They all generate a standard text that auto-inserts in the comment window. If you enable the setting "Auto click open, solved, not identified", the script will also set the status of the UR:

  • Black comments set the UR Status to "Open"
  • Orange comments set the UR Status to "Not Identified"
  • Green comments set the UR Status to "Solved"
  • Red comments have errors in the script; they will still generate the comment text and then set the UR Status to "Open"

Before actually sending your commment, make sure you understand the report and adjust the text accordingly!

Filters



You can set several kinds of filters for URs to display. Hover your mouse over the items will show tool tips describing their function.

The Filters and Auto Reminders work in conjunction with the Reminder days and Close Days setting.




Also, you can set the amount of days after you wish to send a reminder message, and the amount of days after you would like to close a message.


Integration with URO+

From version 1.1.0 on, you can easily use URComments without URO+ installed, since URComments has it's own filter settings. For those using URO+, URComments works smoothly together. However, if you use URO+ filters, the filters of URComments will be disabled. To enable them, simply check Enable URComments UR filtering. You may need to disable URO+ filters first.

Settings

In the settings, you define how URComments works for you. To make yourself acquintainted, it is recommended to check all settings from the first list, except the 8th and the last two. Holding the mouse over any of the items will show tool tips describing the function.

From the Comment List Drop down menu, choose which list you want to use. The available files are listed under Installation. To make your own list, use the Custom List and view the tutorial. If you need support, you can find assistance in the forum.

Some advanced settings are at the bottom of this tab. Make yourself acquainted with this script before you change the settings and use them with care, especially the Auto send reminders option.

Illustrated slideshow

Presentation of WME URComments


You can view this presentation full screen, or open the slide show in google drive.

Tutorial to Customize URComments

Especially for the use of URComments in other languages, there is a Custom List that you can use to make a list of comments in your own language. In this tutorial you will find an elaborate explanation on how to do that. If you like support making your custom list, contact moweez (PM [Help])  .


You can view this presentation full screen, or open the slide show in google drive.


↓ DOWNLOAD ↓ WME URComment is available on the following browsers:

To use other languages or make your own custom list, you need to install one of the following scripts in addition:

  • Custom List Install and edit this file if you wish to customize comments. There is a tutorial at the bottom of this page to guide you.
  • International List: a shorter and slightly simpler version of the Comment Team list. This list has some extra comments, handy for base map editing and starting communities.

Languages:


Bring up comments or questions on this page in this forum .
Retrieved from "https://beta.waze.com/wiki/Mauritius/index.php?title=Scripts/URComments&oldid=127902"