Scripts: Difference between revisions View history

imported>GizmoGuy411
imported>Forumtestuser
m (1 revision imported)
 
(156 intermediate revisions by 17 users not shown)
Line 1: Line 1:
The Waze community has created the following plugins/extensions/addons for use in the Waze web-based environments. (Client-side possible?)
#REDIRECT [[USA:Scripts]]
==LiveMap==
===LiveMap Navigation List===
by Timbones
 
This plugin/extension works with the Waze LiveMap only. After installing, create a route in the LiveMap by clicking on the origin and destination. Once the LiveMap requests the route, the left side area will switch from the current events scrolling list, to a navigation list of the route. Multiple routes are displayed. Each turn is clickable and the map will zoom to that location.
 
<u>'''DOWNLOAD LiveMap Navigation List'''</u>
 
[http://userscripts.org/scripts/show/118389 Download the LiveMap Navigation List] from userscripts.org
*Firefox requires the [https://addons.mozilla.org/en-US/firefox/addon/greasemonkey/ Greasemonkey Addon].
*Chrome users can leverage the [https://chrome.google.com/webstore/detail/tampermonkey/dhdgffkkebhmkfjojejmpbldmpobfkfo?hl=en Tampermonkey Extension] to install and manage the script from directly within the browser. Otherwise Chrome users will need drag the file downloaded to their PC into the Chrome Extensions tab.
 
<u>'''More Information'''</u>
 
[http://www.waze.com/forum/viewtopic.php?t=13511 LiveMap Navigation List forum thread]
 
 
===LiveMap UR Overlay (LMUR)===
by Twister-UK
 
LMUR allows update requests and map problems to be displayed on the Livemap, with various filtering options to show/hide requests/problems by type, age, keyword etc.  Requires Livemap to be viewed via the secure (https) URL - LMUR will prompt you if a non-secure URL is used.
 
<u>'''DOWNLOAD LiveMap UR Overlay (LMUR)'''</u>
 
[http://userscripts.org/scripts/show/150276 Download the LiveMap UR Overlay script] from userscripts.org
*Firefox requires the [https://addons.mozilla.org/en-US/firefox/addon/greasemonkey/ Greasemonkey Addon].
*Chrome users can leverage the [https://chrome.google.com/webstore/detail/tampermonkey/dhdgffkkebhmkfjojejmpbldmpobfkfo?hl=en Tampermonkey Extension] to install and manage the script from directly within the browser. Otherwise Chrome users will need to [http://crx.chizzum.com/ download the crx package] instead.
 
<u>'''More Information'''</u>
 
[http://www.waze.com/forum/viewtopic.php?t=29381 LiveMap UR Overlay forum thread]
 
 
==Editing==
===WME Colour Highlights for Landmarks and Segments===
by Timbones
 
This script adds color highlighting to segments and landmarks according to their status and type. The highlighting of segments is likely to be most useful, for it shows locked and un-named roads.
 
[[Image:Wme-highlights.png]]
 
<u>'''DOWNLOAD WME Colour Highlights for Landmarks and Segments'''</u>
 
[http://userscripts.org/scripts/show/141050 Download WME Colour Highlights for Firefox] from userscripts.org
*Chrome users: download the linked .crx file included on the userscript.org page
*Firefox requires the [https://addons.mozilla.org/en-US/firefox/addon/greasemonkey/ Greasemonkey Addon].
 
<u>'''More Information'''</u>
 
[http://www.waze.com/forum/viewtopic.php?t=40705 WME Color Highlights forum thread]
 
===WME Junction Angle Info===
Shows the angle between two selected (and connected) segments. Version 1.5 as of March 20, 2013.
 
<u>'''DOWNLOAD Junction Angle Info'''</u>
 
Download Junction Angle Info [http://userscripts.org/scripts/show/160864 for Firefox] or [https://chrome.google.com/webstore/detail/wme-junctionangle/cfcpfikgmfoghjfpfepmklballeagadf for Chrome]
 
<u>'''More Information'''</u>
 
(The link for discussion of this script in the Waze forums needs to be added.)
 
 
===Junction Node Fixer (JNF)===
by bgodette
 
Junction Node Fixer has several features. The primary focus of JNF is that it overloads the 'q' (disallowAllTurns) keyboard shortcut to preserve existing turn restrictions. 'Overloading' means that it takes over all functionality of the 'q' hotkey only. The 'q' keyboard shortcut performs the following actions
* Fixes any self and reverse connectivity issues
* Fixes closed loop roads (by splitting into two segments with a joining junction)
* Terminates dead-ends with a junction
* Makes dead-ends two-way (only if both ends of the segment are visible)
* Sets the Type of a roundabouts using lowest of two highest rule and sets country/state if needed
* For UK sets Type of roundabouts using highest type excluding Freeway rule.
* Does a traditional 'qw' (clears reverse connectivity, and locks turns)
* Causes the turn arrows to refresh (the side effect of 's' but without the shifting).
 
Since you end up with the same turns restricted, that means you need to press 'w' if you really want all turns allowed. This is why it overloads 'q' instead of 'w'. Ultimately this will be a separate hotkey that's editable through WME's '?' interface.
 
JNF also:
* Saves the state of WME's ShowAllTurns, ShowTurns and Full-screen mode across F5/Permalink.
* Forces data model reload after successful save.
 
This has only be tested in Chrome, it's been reported to work in FF+GM.
 
<u>'''DOWNLOAD Junction Node Fixer'''</u>
 
[http://userscripts.org/scripts/show/144939 Download Junction Node Fixer script] from userscripts.org
 
<u>'''More Information'''</u>
 
[http://www.waze.com/forum/viewtopic.php?t=35237 WME Junction Node Fixer forum thread]
 
 
===WME Toolbox===
by OyyoDams
 
This script adds many features like small junctions highlight, redo roundabout, convert roundabout to standard road, clear road geometry, many permalinks to external sites, and more.
 
It's live updated and doesn't need to be manually updated each time a new version is released.
 
It requires WME Color Highlight and WME Junction Node Fixer to work.
 
<u>'''DOWNLOAD WME Toolbox'''</u>
 
Download WME Toolbox for [http://userscripts.org/scripts/show/166405 Firefox] or
[http://www.wazeteam.com/chrome/WME_Toolbox_laucher.crx Chrome]
 
<u>'''More Information'''</u>
 
[http://www.waze.com/forum/viewtopic.php?t=48123 English forum thread] -
[http://www.waze.com/forum/viewtopic.php?t=47964 French forum thread]
 
===Update Request Overview (URO)===
by Twister-UK
 
URO provides various filtering options to show/hide update request, map problem and camera markers according to type, age, comment keyword etc.  For any markers that remain visible, hovering the mouse pointer over the marker then generates a pop-up which contains a summary of the marker information and some marker-type specific actions (e.g. opening an update request in a new tab, deleting a camera).  For any UR markers where a conversation is taking place (currently WME beta only), the marker is modified to show a small quote icon in place of the Waze icon.
 
<u>'''DOWNLOAD Update Request Overview'''</u>
 
Download Update Request Overview v1.34 for [http://userscripts.org/scripts/show/145186 Firefox+Greasemonkey] or [http://crx.chizzum.com/UROverview.1.34.crx Chrome packaged version]
 
<u>'''More Information'''</u>
 
[http://www.waze.com/forum/viewtopic.php?t=29054 Update Request Overview forum thread]
 
 
===Waze Aerial Shifter===
This script helps you adjust the position of underlying Bing maps to work on road alignment inside WME.
 
<u>'''DOWNLOAD Waze Aerial Shifter'''</u>
 
[https://docs.google.com/file/d/0B9yvR3S7YHqoLVEwR1BUOWoxdDA/edit?usp=sharing Chrome packaged Version 1.2.14] (June 24, 2013)
 
For WME beta, download [https://docs.google.com/file/d/0B9yvR3S7YHqoMFA0eDJicy12TEU/edit?usp=sharing Chrome packaged Version 1.2.15] (July 16, 2013)
 
<u>'''More Information'''</u>
 
[http://world.waze.com/forum/viewtopic.php?t=53022 Waze Aerial Shifter forum thread]
 
 
===Street to River===
[[image:street-created-selected-and-named.png|thumb|Street created, selected and named]]
[[image:created-river-after-helper-street-deleted.png|thumb|River created and helper street deleted]]
 
The script is designed as a helper for creating river/railroad landmarks for the free waze navigation system. The script transforms the geometry of a new unsaved street to a river or railroad landmark. You can predefine the width and the name for the new landmark in the form of a special street name.
 
Mini howto:
* install this script as greasemonkey script or chrome extension
* draw a new street but do not save the street
* add and apply a street name to define the rivers name and width. This step is optional.
: Example: ''20m Spree'' creates a 20 meters wide river named ''Spree''
* Select the helper street
* Click the '''Street to river''' or '''Street to railroad''' button
* Delete the helper street
* Edit the new landmark as you like. You can even set the landmark to another type. [http://world.waze.com/livemap/?zoom=9&lat=52.45873&lon=6.17407 Here it is used] to mark a railroad, using landmark type 'other'.
 
Examples of rivers created by the script:
* Spree: https://world.waze.com/edtior/?zoom=2&lat=52.29672&lon=14.25296
* Nottekanal: https://world.waze.com/edtior/?zoom=1&lat=52.22414&lon=13.48316&
{{clear|right}}
<u>'''DOWNLOAD Street to River'''</u>
 
Download the Street to River script for [http://userscripts.org/scripts/show/122049 userscripts.org Firefox+Greasemonkey] from userscripts.org
*Firefox requires the [https://addons.mozilla.org/en-US/firefox/addon/greasemonkey/ Greasemonkey Addon].
*Chrome users can leverage the [https://chrome.google.com/webstore/detail/tampermonkey/dhdgffkkebhmkfjojejmpbldmpobfkfo?hl=en Tampermonkey Extension] to install and manage the script from directly within the browser. Otherwise, Chrome users will need to downloaded  manually, and then drag the script file into the Extensions tab.
 
<u>'''More Information'''</u>
 
[http://www.waze.com/forum/viewtopic.php?t=14550 Street to River forum thread]
 
 
===WazeBar===
by edsonajj
 
WazeBar is an alternative menu bar for WME that also integrates other scripts, making them available on Safari.
 
The currently integrated scripts are:
* WME Color Highlights by timbones.
*UR Overview by Twister_UK.
*GeoWipe by bgodette.
* Junction Node Fixer bybgodette.
 
Other features include:
* Autosave at a certain number of edits.
 
More features and additional script integrations are being worked on. The original development of WazeBar was made by Mike Bronner, it is currently mantained by Edson Jiménez.
 
<u>'''DOWNLOAD WazeBar'''</u>
 
[https://dl.dropboxusercontent.com/u/86545493/Waze/Extensions/Safari/WazeBar.safariextz Download WazeBar for Safari] from dropbox.
 
<u>'''More Information'''</u>
 
[http://www.waze.com/forum/viewtopic.php?t=47794 WazeBar for Safari forum thread]
 
 
===Roundabout Angles and Landmark===
by davipt
 
Roundabout Angles and Landmark is a script with two features:
* selecting a roundabout node, on the left side there is a button to automatically create a "junction" landmark around the landmark. Roundabout segments shall not have street name set, but the roundabout name should be added to this landmark in the middle, so the label appears horizontally.
* selecting a roundabout node, on the left side there is a button to create a temporary landmark in the form of a leaf, which will denote the approximate 90º, 180º and 270º range that Waze uses to switch from the "take the nth exit" to the "straight ahead/turn left/turn right" on roundabouts with two to four connections.
 
If the created landmark is not round, it means the roundabout has something screwed up, usually a reversed A->B segment, so it also helps ensuring proper roundabouts.
 
<u>'''DOWNLOAD Roundabout Angles and Landmark'''</u>
 
[http://userscripts.org/scripts/show/152981 Download Roundabout Angles and Landmark] from userscripts.org
 
<u>'''More Information'''</u>
 
[http://www.waze.com/forum/viewtopic.php?t=32633 Roundabout Angles and Landmark forum thread]
 
 
===WME Add-Ons===
'''CAUTION!'''
Please do not use this tool unless you are a very experienced Waze editor and fully understand the ramifications of using this tool. Even experienced editors should learn how to use it only on very smaller areas at a time. Read the forum linked below to better learn how to use it and to understand the ramifications of its use!
 
This is a plugin/extension which displays a table of all the current view's country, state, city and street names. You can select all segments of a street using a custom button. This extension makes it very easy to find and fix incorrect cities and states (in the U.S.) and bad street names. The tool has many other capabilities as well.
 
Since this tool is updated often, please see the forum linked below for a full list of features, download links, installation instructions, and discussion for the latest version.
 
[http://www.waze.com/forum/viewtopic.php?p=334169 "(Script) WME Add-Ons"]
 
''There is a previous version of this tool called "WME Extended Tools". Due to changes to the Waze Map Editor, its functionality was broken, and the decision was made to re-write the tool from scratch. '''WME Extended Tools is no longer supported, should be uninstalled, and should no longer be used.'''
 
 
===WME Level Highlighter===
WME Script allowing Segment highlighting based on segment levels. Please note that this does Conflict with Tim's WME Color Highlights and that both should NOT be active at the same time.
 
[http://userscripts.org/scripts/show/158183 "(Script) WME Level Highlighter"]
 
 
===Select Roundabout Segments (SRS)===
by Twister-UK
 
This script adds a "Select roundabout" button to the segment edit panel if you select a single segment from a roundabout. Clicking the button then automatically selects the entire roundabout. Note that if the entire roundabout doesn't get selected, it probably means the roundabout itself is broken.
 
<u>'''DOWNLOAD Select Roundabout Segments'''</u>
 
[http://userscripts.org/scripts/show/151341 Firefox+Greasemonkey version 0.5] - [http://crx.chizzum.com/SRS.0.5.crx Chrome packaged version 0.5] (July 16, 2013)
 
<u>'''More Information'''</u>
 
[http://www.waze.com/forum/viewtopic.php?t=30529 Forum discussion thread]
 
==Device==
===Geocaching===
[[http://world.waze.com/forum/viewtopic.php?f=3&t=36866 Geocaching-Waze bookmarklet]] is a iOS Safari bookmarklet from davipt that allows driving to a given Geocaching coordinate. Currently it assumes a fixed flow within iOS and the official Geocaching client, but it can be adapted to other situations.
 
Open the iOS Geocaching app, pick up a cache, click on "Open on external map", which will open Google Maps on the browser. From this page, click on the bookmarklet, which will display the lat+lon, and then open Waze on that point, ready to drive there.
 
==Developing==
===JavaScript Development Best Practices for Waze Extensions and Scripts===
====Best Practices====
All of the normal best practice guidelines apply, some references:
* [http://www.javascripttoolbox.com/bestpractices/ JavaScript Toolbox]
* [http://sarfraznawaz.wordpress.com/2012/02/19/842/ Sarfraz Ahmed's Blog]
To help with this, run your code through some useful analyzers to head off potential problems, like:
* [http://www.jshint.com JSHint]
* [http://www.jslint.com JSLint]
* [https://developers.google.com/closure/ JavaScript Closure Tools]
====jQuery====
WME is built on jQuery. This makes it easy to manipulate, access properties, and directly reference the built-in Waze objects underlying WME. Using jQuery enables tighter integration into WME, reduces code, and builds on what is already there. As of now, WME is running jQuery 1.7 vanilla, which does not include any optional modules like jQuery UI.
====Variable & Function Prefix====
To ensure that your code is safe from collision with other scripts and extensions, please prefix all variables and functions with a prefix of your choosing (this includes local variables and global variables, since your entire script is made public when it is loaded in WME). An example would be instead of naming a variable "version", name it "coolscript_version" instead, if your script is named "Cool Script".
====Code Encapsulation====
While not technically code encapsulation in the object oriented sense, please encapsulate all code with a function, except requisite bootstrap code and initializer calls.
====UserScript Bootstraping====
When creating user scripts for Greasemonkey, Chrome, or TamperMonkey, use the following bootstrap at the start of your script. timbones did extensive research on this to make sure it is completely cross-browser compatible. Not only will it work in GreaseMonkey, Chrome, and TamperMonkey, but can also be dropped into a Safari Extension without any recoding.
----
<pre>
function coolscript_bootstrap()
{
var bGreasemonkeyServiceDefined    = false;
 
try
{
if (typeof Components.interfaces.gmIGreasemonkeyService === "object")
{
bGreasemonkeyServiceDefined = true;
}
}
catch (err)
{
//Ignore.
}
if ( typeof unsafeWindow === "undefined"  ||  ! bGreasemonkeyServiceDefined)
{
unsafeWindow    = ( function ()
{
var dummyElem  = document.createElement('p');
dummyElem.setAttribute ('onclick', 'return window;');
return dummyElem.onclick ();
} ) ();
}
/* begin running the code! */
coolscript_init();
}
 
function coolscript_init()
{
//run your code here
}
 
// [...]
// then at the end of your script, call the bootstrap to get things started
coolscript_bootstrap();
</pre>
----

Latest revision as of 18:18, 8 January 2022

Redirect to: