Template:Locking Standard/doc

This is a documentation subpage for . It contains usage information, categories and other content that is not part of the original template page.

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.

Supporting tools

• There is a 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.

• {{Lock Standard State}} is a cover template which has been designed to be used in conjuction with this template as a skin. Using the {{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.
  To use {{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 {{Lock Standard State}} template. Once setup you only need to put a simple template call on your states page {{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), and Ferries (which are limited to very specialized use if used at all, and therefore are set to 5). 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.

Samples

A complex output displaying all possible elements:

In Locking Standard 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 bringing the road types of an area into compliance with the current US road type standards (FC and highway systems). Lock the roads based on type after they've been set to current US road type standards.

Locking Standard Minimum Locking Rank Standard

Segment Type	Default locks	2nd Region	3rd Region
Freeway	4
Ramp	Highest rank of connected segment
Major Highway	3	4	3
Minor Highway	2		3
Primary Street	1	2
Street	1
|-|-|-|-|-|-|-|-|-| Railroad |-|-|-|-|-|-|-|-|-|	2
• • • • Ferry • • • •	5
Private Road	3
Parking Lot Road	1	2	1

Note: This table uses all elements available.
Some of the elements featured in this table are using the defaults and are not customized.

---

A simple output displaying the fewest possible elements:

Segment Type	Default locks
Freeway	4
Ramp	Highest rank of connected segment
Major Highway	3
Minor Highway	2
Primary Street	1
Street	1
|-|-|-|-|-|-|-|-|-| Railroad |-|-|-|-|-|-|-|-|-|	2
• • • • Ferry • • • •	5

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.

|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; |lede=|
• If this parameter is not set, the following default text will be used:

In Locking Standard 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 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.

|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; |caption= 
• If parameter is not set, the following default text will be used:

<State> Minimum Locking Rank Standard

"<State>" in the default caption will use the same root page name as the default lede text.

|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.

|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.

|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 January 2015 the Railroad and Ferry road types have hard coded lock ranks values which cannot be customized. For the reasoning, and to participate in the discussion see the 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.

|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.
  

|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 |title2= parameter mentioned above.
  

|Fwy3= This functions the same as |Fwy2=, but applies to the third regional column.
|Ramp= This sets the lock rank for  ramps .

• If this parameter is not set, the default text displayed will be: "Highest rank of connected segment".
  

|Ramp2= As above sets the rank for ramps in the second regional column.
|Ramp3= As above sets the rank for ramps in the third regional column.
|MH= Sets the lock rank for  Major Highway 

• If this parameter is not set, the default text displayed will be: "3"
  

|MH2= Sets the second regional lock rank for MH.
|MH3= Sets the third regional lock rank for MH.
|mH= Sets the lock rank for  Minor Highway 

• If this parameter is not set, the default text displayed will be: "2"
  

|mH2= Sets the second regional lock rank for mH.
|MH3= Sets the third regional lock rank for mH.
|PS= Sets the lock rank for  Primary Street 

• If this parameter is not set, the default text displayed will be: "1"
  

|PS2= Sets the second regional lock rank for PS.
|PS3= Sets the third regional lock rank for PS.
|Street= Sets the lock rank for  Street 

• If this parameter is not set, the default text displayed will be: "1"
  

|Street2= Sets the second regional lock rank for Street.
|Street3= Sets the third regional lock rank for Street.
|Private= Sets the lock rank for  Private Road 

• 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"
  

|Private2= Sets the second regional lock rank for Private.
|Private3= Sets the third regional lock rank for Private.
|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"
  

|PLR2= Sets the second regional lock rank for Parking Lot Road.
|PLR3= Sets the third regional lock rank for Parking Lot Road.

---

Examples:

Simplest, using only defaults except for eliminating the lede, changing captions and changing one lock level (Freeway=5 instead of 4)

{{Locking Standard|lede=|caption=Simple Sample Locking Table|Fwy=5}}

Simple Sample Locking Table

Segment Type	Default locks
Freeway	5
Ramp	Highest rank of connected segment
Major Highway	3
Minor Highway	2
Primary Street	1
Street	1
|-|-|-|-|-|-|-|-|-| Railroad |-|-|-|-|-|-|-|-|-|	2
• • • • Ferry • • • •	5

Complex, has three 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, as is not representative of a normal configuration)

{{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}}

In Locking Standard 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 bringing the road types of an area into compliance with the current US road type standards (FC and highway systems). Lock the roads based on type after they've been set to current US road type standards.

Locking Standard Minimum Locking Rank Standard

Segment Type	Variant 1 - Urban	Variant 2 - Rural	Variant 3 - Everywhere else
Freeway	5	4	5
Ramp	Highest rank of connected segment
Major Highway	5	3	4
Minor Highway	2
Primary Street	1
Street	1
|-|-|-|-|-|-|-|-|-| Railroad |-|-|-|-|-|-|-|-|-|	2
• • • • Ferry • • • •	5

Supports up to three variations per state, with only one required. To add a second, make sure to specify the title for the second variant column e.g., |title2=Urban areas|. To add a third, make sure to add the title for the third variant column e.g., |title3=NYC Only|.

For the first variant, the defaults are 4,3,2,1,1 (Fwy,MH,mH,PS,Street), plus Ramp has the text "highest rank of connected segment," RR=2, Ferry=5. You can override individual values, no values, or all values.

For the second and third columns, if you don't specify them, they take the value of the first column. That may be a value you specified, or the default value if you didn't specify one. If you wish to specify a custom value in the first column, and a default value in a different column, you can't -- you must specify both.