View source for Template:Locking Standard/doc View history

{{doc subpage}}
This template builds a preformatted table complete with explanatory text above, (and optionally below,) to list the segment locking standards for a state or region.

{{Mbox|type=critical|text={{red|Do not change any of the default lock ranks in the template}} without first getting national consensus in the forum, and notifying the Regional Coordinator of every state using the template to display the default value for that road type on their states pages.}}

===Supporting tools===

*There is a '''[http://docs.google.com/spreadsheets/d/1p0-6SinLYcGZJ0dhEjKgGNbDHBF8d-emNGVe6PezBC0/ Google Sheet] which automatically generates the call to this template.''' It lists all the approved standards for US States. It supports up to three regions within the state as stacked columns, and doesn't provide any before or after text options. You can use the sheet to start off and add parameters from the list below as necessary.

*{{tl|Lock Standard State}} is a cover template which has been designed to be used in conjuction with this template as a skin. Using the {{tl|Lock Standard State}} keeps the code on state pages using this template clean. It also limits the template being possibly broken by editors unfamiliar with the template structure. <br>To use {{tl|Lock Standard State}}, you must first understand this template, create the call to this template for the output you desire. You then place that template call code in the {{tl|Lock Standard State}} template. Once setup you only need to put a simple template call on your states page {{tlx|Lock Standard State|XX}}.


===Design===


This template table was based on the USA/Northeast locking standard table, and has been modified to be flexible enough to be used everywhere.

Many of the features are optional and displayed only if their parameters are set. The table caption is in bold text. The rows of the table have an alternating light Waze blue background highlight. The road types are displayed using their colors as represented in WME.

The table is built with default lock rank values which may change based upon general consensus. All the lock ranks are customizable except for railroads (set to 2 by Waze staff nationally).
The table can list different locks for up to three regions within a single state. If multiple regions are enabled in your table you don't need to repeat the lock ranks for each column, unless they deviate from the first column. Therefore if your second region only had a different rank for MH, you only need to specify the rank of MH in region 2, the rest of region 2 road type will use the same rank values as region one. 
The table is designed to merge adjacent cells on the same row which have the identical lock ranks. Whether they are identical because they were set the same, or because they default to be the same, if the output is going to be the same, they will be merged into one cell using a <code>colspan=n</code>.

===Samples===
A complex output displaying all possible elements:
{{Mbox|image=none|text={{User:Kartografer/Locking Standard|title2=2nd Region|title3=3rd Region|MH2=4|mH3=3|PS2=2|PS3=2|Private=3|PLR2=2|Runway=5|Ferry=2|Other=1|Construction=3|Beacon2=Waze Staff|Beacon3=6|note=This table uses all elements available.|append=Some of the elements featured in this table are using the defaults and are not customized.}}}}

A simple output displaying the fewest possible elements:
{{Mbox|image=none|text={{{{DraftLink|Locking Standard}}|lede=|caption=&nbsp;}}}}


===Parameters===

*Paramters for this template can be used in any order.
*Parameters are case-sensitive and must be entered exactly as listed here.
*We will define the parameters here in the order in which they are displayed by the template output.


{{Para|lede}} This is the '''lede paragraph''', the paragraph of text displayed above the table.
*If you do not want to have a lede paragraph, make sure to set this parameter to a blank value like this; {{para|lede|{{!}}}}
*If this parameter is not set, the following '''default text''' will be used:
{{Mbox|image=none|text=In {{RootPage2}} we have a set minimum standard for locking roads based on segment type. Any road of a certain segment type must be locked '''at least''' to the rank (level) in the chart below. Roads may be locked higher for protection and special situations (areas with construction, tricky design, frequent mistakes, imaging inaccuracies, and the like), but should not be locked lower.

A great time to implement these locks is while performing the FC Upgrade of an area. Lock the roads based on type after they've been set to FC standards.}}
:''NOTICE how it starts off "In {{u|Locking Standard}} we have set...", this uses the name of the root page the template will ultimately be displayed on. If you are using it in one of the USA state wiki pages this will show the states name, even if it is on a subpage of that state.''

{{Para|caption}} This sets the '''caption''' displayed in bold text above the table.
*If you do not want to have a caption, make sure to set this parameter to a blank value like this; {{para|caption|{{&}}nbsp;}}
*If parameter is not set, the following '''default text''' will be used:
{{Mbox|image=none|text='''<center><State> Minimum Locking Rank Standard</center>'''}}
:''"<State>" in the default caption will use the same root page name as the default lede text.

{{para|title}} The title of the '''first column''' of lock values (sometimes the only column).
*If the parameter is not set (if it is omitted), the '''default title''' "Default locks" is used.

{{Para|title2}} This is the column title for the '''second regional column'''.
*This parameter must be set in order for the second regional column to be displayed.
*If you do not specify a title, the entire column will not appear. There is '''no default''' display.

{{Para|title3}} This is the column title for the '''third regional column'''.
*This parameter must be set in order for the third regional column to be displayed.
*If you do not specify a title, the entire column will not appear. There is '''no default''' display.

'''Custom Lock Ranks'''
*Every road type has a default lock rank which will be used by this template unless it is overridden by a custom value.
*There are built-in defaults, these will be used in the first column (region) if you do not set the lock rank for a specific road type.
*If you specify a custom rank for the first regional column, that rank will be used as the default for the remaining two columns. If an column is listed but a custom rank is not specified for the same road type, it will display the same rank as the first column.
*Each road type which allows custom lock ranks has three parameters available, one for each column. The first parameter name is the abbreviation for that road type, the next 2 are the abbreviation followed by a "2" or "3".
*''{{As of|2018|Dec}} the Railroad type has a hard-coded lock ranks value which cannot be customized. For the reasoning, and to participate in the discussion see the [http://www.waze.com/forum/viewtopic.php?t=122610 forum thread].''
*The following parameters for road ranks accept any text value. It is recommended to just enter a single digit for simplicity. In some cases (Ramps for example it may be necessary to use text instead.
*Being that the default lock ranks displayed by this template may change over time, it is recommended to define the lock ranks for your region and not rely on the default values. If you set the first column thiugh, that becomes the default for the remaining columns in the table, and its OK not to list identical ranks for the same road type in different regions. 

{{Para|Fwy}} This sets the displayed lock rank for {{Freeway}} in the first column.
*If the second (and third) column are displayed but they do not have a custom rank set for freeways, they will also use this rank.
*If this parameter is not set to a custom rank, it will show rank '''"4"'''.

{{Para|Fwy2}} This sets the lock rank for Freeway in the second displayed region.
*If this parameter is not set, it will show the same rank as the first column.
*This rank will only be displayed in the table if the second regional column is activated. (The second column is activated by setting a header for it using the {{para|title2}} parameter mentioned above.

{{para|Fwy3}} This functions the same as {{para|Fwy2}}, but applies to the third regional column.

{{Para|Ramp}} This sets the lock rank for {{ramp|ramps}}.
*If this parameter is not set, the default text displayed will be: '''"Highest rank of connected segment"'''.

{{Para|Ramp2}} As above sets the rank for ramps in the second regional column.

{{Para|Ramp3}} As above sets the rank for ramps in the third regional column.

{{Para|MH}} Sets the lock rank for {{Major Highway}}
*If this parameter is not set, the default text displayed will be: '''"3"'''

{{Para|MH2}} Sets the second regional lock rank for MH.

{{Para|MH3}} Sets the third regional lock rank for MH.

{{Para|mH}} Sets the lock rank for {{Minor Highway}}
*If this parameter is not set, the default text displayed will be: '''"2"'''

{{Para|mH2}} Sets the second regional lock rank for mH.

{{Para|MH3}} Sets the third regional lock rank for mH.

{{Para|PS}} Sets the lock rank for {{Primary Street}}
*If this parameter is not set, the default text displayed will be: '''"1"'''

{{Para|PS2}} Sets the second regional lock rank for PS.

{{Para|PS3}} Sets the third regional lock rank for PS.

{{Para|Street}} Sets the lock rank for {{Street}}
*If this parameter is not set, the default text displayed will be: '''"1"'''

{{Para|Street2}} Sets the second regional lock rank for Street.

{{Para|Street3}} Sets the third regional lock rank for Street.

{{Para|Ferry}} Sets the lock rank for {{Ferry}}
*If this parameter is not set, the default text displayed will be: '''"5"'''

{{Para|Ferry2}} Sets the second regional lock rank for Ferry.

{{Para|Ferry3}} Sets the third regional lock rank for Ferry.

{{Para|Private}} Sets the lock rank for {{Private}}
*This row will only be displayed if at least one of the displayed columns has a custom rank set for Private Roads. It doesn't matter what rank it's set to, even "1", as long as it has an assigned rank.
*If this parameter is not set, the default text displayed will be: '''"1"'''

{{Para|Private2}} Sets the second regional lock rank for Private.

{{Para|Private3}} Sets the third regional lock rank for Private.

{{Para|PLR}} Sets the lock rank for {{Parking Lot Road}}
*This row will only be displayed if at least one of the displayed columns has a custom rank set for Parking Lot Roads. It doesn't matter what rank it's set to, even "1", as long as it has an assigned rank.
*If this parameter is not set, the default text displayed will be: '''"1"'''

{{Para|PLR2}} Sets the second regional lock rank for Parking Lot Road.

{{Para|PLR3}} Sets the third regional lock rank for Parking Lot Road.

{{Para|Runway}} Sets the lock rank for {{Runway}}
*This row will only be displayed if at least one of the displayed columns has a custom rank set for Runways. It doesn't matter what rank it's set to, even "1", as long as it has an assigned rank.
*If this parameter is not set, the default text displayed will be: '''"1"'''

{{Para|Runway2}} Sets the second regional lock rank for Runway.

{{Para|Runway3}} Sets the third regional lock rank for Runway.

{{Para|Other}} Sets the lock rank for any other road types.
*This row will only be displayed if at least one of the displayed columns has a custom rank set for other named types. It doesn't matter what rank it's set to, even "1", as long as it has an assigned rank.
*If this parameter is not set, the default text displayed will be: '''"1"'''

{{Para|Other2}} Sets the second regional lock rank for other road types.

{{Para|Other3}} Sets the third regional lock rank for other road types.

{{Para|Construction}} Sets the lock rank for segment in construction areas with oudated aerial imagery.
*This row will only be displayed if at least one of the displayed columns has a custom rank set for construction areas. It doesn't matter what rank it's set to, even "1", as long as it has an assigned rank.
*If this parameter is not set, the default text displayed will be: '''"1"'''

{{Para|Construction2}} Sets the second regional lock rank for construction areas.

{{Para|Construction3}} Sets the third regional lock rank for construction areas.

{{Para|Beacon}} Sets the lock rank for segments associated with installed Waze Beacons.
*This row will only be displayed if at least one of the displayed columns has a custom rank set for segments with beacons. It doesn't matter what rank it's set to, even "1", as long as it has an assigned rank.
*If this parameter is not set, the default text displayed will be: '''"6"'''

{{Para|Beacon2}} Sets the second regional lock rank for segments with beacons.

{{Para|Beacon3}} Sets the third regional lock rank for segments with beacons.

{{Para|note}} This adds note text below the table, when it is used the text is preceded by the word "'''NOTE:'''"
*If this parameter is not used there is '''no default''' text displayed below the table.

{{Para|append}} This adds text below the table as well, but without the word "'''NOTE:'''" preceding it.
*This can be used in conjunction with the {{para|note}} parameter to display two separate texts below the table.
*When this is used with {{para|note}}, this text will appear on a new line below the note text.
*If this parameter is not used there is '''no default''' text displayed below the table.

===Example usage===

Here is a simple display using only defaults except for eliminating the lede paragraph, changing the caption, and changing one lock level (Freeway is set to rank 5 instead of 4).

To display this table you would use the following code on your page:
{{Tlx|Locking Standard|lede{{=}}|caption{{=}}Simple Sample Locking Table|Fwy{{=}}5}}

{{Mbox|image=none|text={{{{DraftLink|Locking Standard}}|lede=|caption=Simple Sample Locking Table|Fwy=5}}}}


----

This complex example has three regional columns, changes many defaults, including interactions of defaults for the same type across the three columns, but does use default lede and caption; ''(Note that the caption "state name" is pulled from the template/documentation page, and is not representative of a normal configuration. When displayed on a state page it will say <State Name> minimum...)''

<code><nowiki>{{</nowiki>Locking Standard

|title =Variant 1 - Urban

|title2=Variant 2 - Rural

|title3=Variant 3 - Everywhere else

|Fwy =5   |MH=5

|Fwy2=4   |MH2=3

|MH3 =4   |mH3=2

|Ramp2=2 |Ramp3=Second highest connected segment lock

|Private=2<nowiki>}}</nowiki></code>

{{Mbox|image=none|text={{{{DraftLink|Locking Standard}}|title=Variant 1 - Urban|title2=Variant 2 - Rural|title3=Variant 3 - Everywhere else|Fwy=5|MH=5|Fwy2=4|MH2=3|MH3=4|mH3=2|Ramp2=2|Ramp3=Second highest connected segment lock|Private=2}}}}


----

<code><nowiki>{{</nowiki>Locking Standard

|lede=

|caption=x3 - All Default Fwy 5

|title= First Column

|title2= Second Column

|title3= Third Column

|note=This sample uses all defaults for segment lock values, but maxes out all the columns, 
removes the lead-in text (lede) and adds a "note" at the end<nowiki>}}</nowiki></code>

{{mbox|image=none|text={{{{DraftLink|Locking Standard}}
|lede=
|caption=x3 - All Default Fwy 5
|title= First Column
|title2= Second Column
|title3= Third Column
|Fwy=5
|Fwy2=5
|Fwy3=5
|append=This sample is the same as the previous. However:
* Freeway is set to 5 instead of to 4
* All Freeway values are set to be the same manually, though the additional columns would have inherited the same value (5) anyway from the first column, i.e., the default for columns 2 and 3 is to be the same as column 1, whether column 1 inherits the ''unspecified'' default or is set to a different value. The purpose of that is to allow the caller to specify the minimal number of changes from column to column.
* The "note" is changed to the "append" parameter, which functions similarly except without the bolded "Note: " prefix
}}}}


----

<code><nowiki>{{</nowiki>Locking Standard

|lede=

|caption=x3 A=custom, B=same custom, C=default

|title= First Column

|title2= Second Column

|title3= Third Column

|Fwy=5

|Fwy2=5<nowiki>}}</nowiki></code>

{{mbox|image=none|text={{{{DraftLink|Locking Standard}}
|lede=
|caption=x3 A=custom, B=same custom, C=default
|title= First Column
|title2= Second Column
|title3= Third Column
|Fwy2=5
|Fwy3=5}}}}


----

<code><nowiki>{{</nowiki>Locking Standard

|lede=

|caption=x3 Region 2 & 3 Match

|title= First Column

|title2= Second Column

|title3= Third Column

|Fwy=5

|Fwy2=5

|Fwy3=3<nowiki>}}</nowiki></code>

{{mbox|image=none|text={{{{DraftLink|Locking Standard}}
|lede=
|caption=x3 Region 2 & 3 Match
|title= First Column
|title2= Second Column
|title3= Third Column
|Fwy2=5
|Fwy3=5
}}}}


----

<code><nowiki>{{</nowiki>Locking Standard

|lede=

|caption=x3 All Different

|title= First Column

|title2= Second Column

|title3= Third Column

|Fwy2=5

|Fwy3=3<nowiki>}}</nowiki></code>

{{mbox|image=none|text={{{{DraftLink|Locking Standard}}
|lede=
|caption=x3 All Different
|title= First Column
|title2= Second Column
|title3= Third Column
|Fwy2=5
|Fwy3=3
}}}}


----

<code><nowiki>{{</nowiki>Locking Standard

|lede=

|caption=x3 A/C match (default C)

|title= First Column

|title2= Second Column

|title3= Third Column

|Fwy=3

|Fwy2=5<nowiki>}}</nowiki></code>

{{mbox|image=none|text={{{{DraftLink|Locking Standard}}
|lede=
|caption=x3 A/C default
|title= First Column
|title2= Second Column
|title3= Third Column
|Fwy=3
}}}}


----

<code><nowiki>{{</nowiki>Locking Standard

|lede=

|caption=x2 All Different

|title= First Column

|title2= Second Column

|Fwy2=5<nowiki>}}</nowiki></code>

{{mbox|image=none|text={{{{DraftLink|Locking Standard}}
|lede=
|caption=x2 All Default
|title= First Column
|title2= Second Column
|Fwy2=5}}}}


----

<code><nowiki>{{</nowiki>Locking Standard

|lede=

|caption=x2 Manual Match

|title= First Column

|title2= Second Column

|Fwy=5

|Fwy2=5<nowiki>}}</nowiki></code>

{{mbox|image=none|text={{{{DraftLink|Locking Standard}}
|lede=
|caption=x2 Manual Match
|title= First Column
|title2= Second Column
|Fwy=5
|Fwy2=5}}}}


----

<code><nowiki>{{</nowiki>Locking Standard

|lede=

|caption=x1 Default - no table params<nowiki>}}</nowiki></code>

{{mbox|image=none|text={{{{DraftLink|Locking Standard}}
|lede=
|caption=x1 Default - no table params}}}}


----

<code><nowiki>{{</nowiki>Locking Standard

|lede=

|caption=x1 Custom lock

|Fwy=5<nowiki>}}</nowiki></code>

{{mbox|image=none|text={{{{DraftLink|Locking Standard}}
|lede=
|caption=x1 Custom lock
|Fwy=5}}}}


----

<code><nowiki>{{</nowiki>Locking Standard

|lede=

|caption=x1 custom title and lock

|title= custom

|Fwy=5<nowiki>}}</nowiki></code>

{{mbox|image=none|text={{{{DraftLink|Locking Standard}}
|lede=
|caption=x1 custom title and lock
|title= custom
|Fwy=5}}}}


----

<code><nowiki>{{</nowiki>Locking Standard

|lede=

|caption=private custom 3

|Private=3<nowiki>}}</nowiki></code>

{{mbox|image=none|text={{{{DraftLink|Locking Standard}}
|lede=
|caption=private custom 3
|Private=3}}}}


----

<code><nowiki>{{</nowiki>Locking Standard

|lede=

|caption=private and plr

|Private=2

|PLR=1<nowiki>}}</nowiki></code>

{{mbox|image=none|text={{{{DraftLink|Locking Standard}}
|lede=
|caption=private and plr
|Private=2
|PLR=1}}}}


----

<code><nowiki>{{</nowiki>Locking Standard

|lede=

|caption=private, plr (default 1, custom 2), runway and beacon

|Private=2

|title2=custom plr

|PLR2=2

|Runway=4

|Beacon=6<nowiki>}}</nowiki></code>

{{mbox|image=none|text={{{{DraftLink|Locking Standard}}
|lede=
|caption=private, plr (default 1, custom 2), runway and beacon
|Private=2
|title2=custom plr
|PLR2=2
|Runway=4
|Beacon=6}}}}


----

<code><nowiki>{{</nowiki>Locking Standard

|lede=

|caption=custom ferry, runway, other types & construction

|Ferry=2

|PLR=3

|Runway=1

|Other=1

|Construction=3<nowiki>}}</nowiki></code>

{{mbox|image=none|text={{{{DraftLink|Locking Standard}}
|lede=
|caption=custom ferry, runway, other types & construction
|Ferry=2
|PLR=3
|Runway=1
|Other=1
|Construction=3}}}}
<includeonly>
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
[[Category:Transcludable pages]]
[[Category:Guideline properties]]

<!-- ADD INTERWIKIS BELOW THIS LINE -->

</includeonly>