Template:Locking Standard/Sandbox/doc View history

Template documentation pages Locking standards
VisualWikitext
No edit summary
 
(11 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{doc subpage}}
{{doc subpage}}
<!-- ADD DOCUMENTATION BELOW THIS LINE -->
<!-- ADD DOCUMENTATION BELOW THIS LINE -->
{{Locking Standard/Sandbox
Documentation for [[Template:Locking Standard/Sandbox]], which is the test version of [[Template:Locking Standard]]
 
== Parameters ==
 
Note: Exact capitalization of parameter names matters:
 
* '''lede''': Lead-in paragraph. There is some default text otherwise. To have no lede paragraph, make sure to set it to a blank value''': |Lede=|
* '''caption''': The title above the table (not a wiki heading). Defaults to Xyzyz Locking Standard, where Xyzyz is taking from the page title (and would be the state name if you use Kent's state template scheme)
* '''title''': The title of the first column of lock values (sometimes the only column). Default value is "Default lock"
* '''title2, title3''': Column titles for second and third variants. If you do not specify a title, the column will not appear. No default.
* '''note, append''': text to be added below the table, which can include full wiki markup. If you use note, the text is automatically started with "Note''': " in bold (the rest is not automatically bold
* '''Fwy, Fwy2, Fwy3''': The ''Freeway'' values, defaults to 4; Fwy is the first column, Fwy2 and Fwy3 are the second and third columns
* '''MH, MH2, MH3''': ''Major Highway'' values; defaults to 3 (note that the "m" is uppercase)
* '''mH, mH2, mH3''': Minor highway values, defaults to 2 (note that the "m" is lowercase)
* '''PS, Street, PS2, Street2, PS3, Street3''': ''Primary Street'' values and ''Street'' values; defaults to 1
* '''RR, RR2, RR3''': ''Railroad'' values; defaults to 2
* '''Ferry, Ferry2, Ferry3''': ''Ferry'' values; defaults to 5
* '''Private, Private2, Private3''': ''Private Road'' segment values. If you do not specify any of these three values, no row will display for Private. If you specify Private2 and/or Private3, but not Private, then Private defaults to 1
 
 
== Samples ==
{{Anchor|s00|No params at all}}{{Locking Standard/Sandbox}}
* The above first sample calls the template with no parameters at all, and displays completely default behavior.
 
{{Anchor|s01|x3 - All Default}}{{Locking Standard/Sandbox
|lede=
|caption=x3 - All Default
|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}}
 
{{Anchor|s02|x3 All 5 (manual)}}{{Locking Standard/Sandbox
|lede=
|lede=
|caption='''x3 - All Default'''
|caption=x3 All 5 (manual)
|title= First Column
|title= First Column
|title2= Second Column
|title2= Second Column
|title3= Third 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
}}
}}


{{Locking Standard/Sandbox
{{Anchor|s03|x3 A=custom, B=same custom, C=default}}{{Locking Standard/Sandbox
|lede=
|lede=
|caption='''x3 All 5 (manual)'''
|caption=x3 A=custom, B=same custom, C=default
|title= First Column
|title= First Column
|title2= Second Column
|title2= Second Column
Line 17: Line 56:
|Fwy=5
|Fwy=5
|Fwy2=5
|Fwy2=5
|Fwy3=5
}}
}}


{{Locking Standard/Sandbox
 
 
{{Anchor|s04}}{{Locking Standard/Sandbox
|lede=
|lede=
|caption='''x3 A=5, others default to same'''
|caption=x3 A=custom, B=default, C=same custom
|title= First Column
|title= First Column
|title2= Second Column
|title2= Second Column
|title3= Third Column
|title3= Third Column
|Fwy=5
|Fwy=5
|Fwy3=5
}}
}}




{{Locking Standard/Sandbox
{{Anchor|s05}}{{Locking Standard/Sandbox
|lede=
|lede=
|caption='''x3 Region 1 & 2 Match (manual)'''
|caption=x3 Region 1 & 2 Match (manual)
|title= First Column
|title= First Column
|title2= Second Column
|title2= Second Column
Line 41: Line 82:
}}
}}


{{Locking Standard/Sandbox
{{Anchor|s06}}{{Locking Standard/Sandbox
|lede=
|lede=
|caption='''x3 Region 2 & 3 Match'''
|caption=x3 Region 2 & 3 Match
|title= First Column
|title= First Column
|title2= Second Column
|title2= Second Column
Line 51: Line 92:
}}
}}


{{Locking Standard/Sandbox
{{Anchor|s07}}{{Locking Standard/Sandbox
|lede=
|lede=
|caption='''x3 All Different'''
|caption=x3 All Different
|title= First Column
|title= First Column
|title2= Second Column
|title2= Second Column
Line 61: Line 102:
}}
}}


{{Locking Standard/Sandbox
{{Anchor|s08}}{{Locking Standard/Sandbox
|lede=
|lede=
|caption='''x3 A/C match (manual)'''
|caption=x3 A/C match (manual)
|title= First Column
|title= First Column
|title2= Second Column
|title2= Second Column
Line 72: Line 113:
}}
}}


{{Locking Standard/Sandbox
{{Anchor|s09}}{{Locking Standard/Sandbox
|lede=
|lede=
|caption='''x3 A/C match (default C)'''
|caption=x3 A/C match (default C)
|title= First Column
|title= First Column
|title2= Second Column
|title2= Second Column
Line 83: Line 124:




{{Locking Standard/Sandbox
{{Anchor|s10}}{{Locking Standard/Sandbox
|lede=
|lede=
|caption='''x3 A/C default'''
|caption=x3 A/C default
|title= First Column
|title= First Column
|title2= Second Column
|title2= Second Column
Line 94: Line 135:




{{Locking Standard/Sandbox
{{Anchor|s11}}{{Locking Standard/Sandbox
|lede=
|lede=
|caption='''x2 All Different'''
|caption=x2 All Different
|title= First Column
|title= First Column
|title2= Second Column
|title2= Second Column
Line 102: Line 143:
}}
}}


{{Locking Standard/Sandbox
{{Anchor|s12}}{{Locking Standard/Sandbox
|lede=
|lede=
|caption='''x2 All Default'''
|caption=x2 All Default
|title= First Column
|title= First Column
|title2= Second Column
|title2= Second Column
}}
}}


{{Locking Standard/Sandbox
{{Anchor|s13}}{{Locking Standard/Sandbox
|lede=
|lede=
|caption='''x2 Manual Match'''
|caption=x2 Manual Match
|title= First Column
|title= First Column
|title2= Second Column
|title2= Second Column
Line 118: Line 159:
}}
}}


{{Locking Standard/Sandbox
{{Anchor|s14}}{{Locking Standard/Sandbox
|lede=
|lede=
|caption='''x1 Default - no table params'''
|caption=x1 Default - no table params
}}
}}


{{Locking Standard/Sandbox
{{Anchor|s15}}{{Locking Standard/Sandbox
|lede=
|lede=
|caption='''x1 Custom lock'''
|caption=x1 Custom lock
|Fwy=5
|Fwy=5
}}
}}


{{Locking Standard/Sandbox
{{Anchor|s16}}{{Locking Standard/Sandbox
|lede=
|lede=
|caption='''x1 custom title and lock'''
|caption=x1 custom title and lock
|title= custom
|title= custom
|Fwy=5
|Fwy=5
}}
}}
{{Anchor|s17}}{{Locking Standard/Sandbox|lede=|caption=private|Private=3}}
{{Anchor|s18}}{{Locking Standard/Sandbox|lede=|caption=private and plr|Private=2|PLR=1}}
{{Anchor|s19}}{{Locking Standard/Sandbox|lede=
|caption=private and plr (default 1, custom 2)
|Private=2
|title2=custom plr|PLR2=2}}
{{Anchor|s20}}{{Locking Standard/Sandbox|lede=|caption=plr|PLR=3}}


<includeonly>
<includeonly>

Latest revision as of 00:07, 27 February 2015

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

Documentation for Template:Locking Standard/Sandbox, which is the test version of Template:Locking Standard

Parameters

Note: Exact capitalization of parameter names matters:

  • lede: Lead-in paragraph. There is some default text otherwise. To have no lede paragraph, make sure to set it to a blank value: |Lede=|
  • caption: The title above the table (not a wiki heading). Defaults to Xyzyz Locking Standard, where Xyzyz is taking from the page title (and would be the state name if you use Kent's state template scheme)
  • title: The title of the first column of lock values (sometimes the only column). Default value is "Default lock"
  • title2, title3: Column titles for second and third variants. If you do not specify a title, the column will not appear. No default.
  • note, append: text to be added below the table, which can include full wiki markup. If you use note, the text is automatically started with "Note: " in bold (the rest is not automatically bold
  • Fwy, Fwy2, Fwy3: The Freeway values, defaults to 4; Fwy is the first column, Fwy2 and Fwy3 are the second and third columns
  • MH, MH2, MH3: Major Highway values; defaults to 3 (note that the "m" is uppercase)
  • mH, mH2, mH3: Minor highway values, defaults to 2 (note that the "m" is lowercase)
  • PS, Street, PS2, Street2, PS3, Street3: Primary Street values and Street values; defaults to 1
  • RR, RR2, RR3: Railroad values; defaults to 2
  • Ferry, Ferry2, Ferry3: Ferry values; defaults to 5
  • Private, Private2, Private3: Private Road segment values. If you do not specify any of these three values, no row will display for Private. If you specify Private2 and/or Private3, but not Private, then Private defaults to 1


Samples

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
 Freeway  4
 Ramp  Highest rank of connected segment
 Major Highway  3
 Minor Highway  2
 Primary Street  1
 Street  1
 :|:|:|:|:Railroad:|:|:|:|:  2
 Ferry  5
  • The above first sample calls the template with no parameters at all, and displays completely default behavior.

x3 - All Default
Segment Type First Column  Second Column  Third Column
 Freeway  4
 Ramp  Highest rank of connected segment
 Major Highway  3
 Minor Highway  2
 Primary Street  1
 Street  1
 :|:|:|:|:Railroad:|:|:|:|:  2
 Ferry  5

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

x3 All 5 (manual)
Segment Type First Column  Second Column  Third Column
 Freeway  5
 Ramp  Highest rank of connected segment
 Major Highway  3
 Minor Highway  2
 Primary Street  1
 Street  1
 :|:|:|:|:Railroad:|:|:|:|:  2
 Ferry  5

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

x3 A=custom, B=same custom, C=default
Segment Type First Column  Second Column  Third Column
 Freeway  5
 Ramp  Highest rank of connected segment
 Major Highway  3
 Minor Highway  2
 Primary Street  1
 Street  1
 :|:|:|:|:Railroad:|:|:|:|:  2
 Ferry  5


x3 A=custom, B=default, C=same custom
Segment Type First Column  Second Column  Third Column
 Freeway  5
 Ramp  Highest rank of connected segment
 Major Highway  3
 Minor Highway  2
 Primary Street  1
 Street  1
 :|:|:|:|:Railroad:|:|:|:|:  2
 Ferry  5


x3 Region 1 & 2 Match (manual)
Segment Type First Column  Second Column  Third Column
 Freeway  5 3
 Ramp  Highest rank of connected segment
 Major Highway  3
 Minor Highway  2
 Primary Street  1
 Street  1
 :|:|:|:|:Railroad:|:|:|:|:  2
 Ferry  5

x3 Region 2 & 3 Match
Segment Type First Column  Second Column  Third Column
 Freeway  4 5
 Ramp  Highest rank of connected segment
 Major Highway  3
 Minor Highway  2
 Primary Street  1
 Street  1
 :|:|:|:|:Railroad:|:|:|:|:  2
 Ferry  5

x3 All Different
Segment Type First Column  Second Column  Third Column
 Freeway  4 5 3
 Ramp  Highest rank of connected segment
 Major Highway  3
 Minor Highway  2
 Primary Street  1
 Street  1
 :|:|:|:|:Railroad:|:|:|:|:  2
 Ferry  5

x3 A/C match (manual)
Segment Type First Column  Second Column  Third Column
 Freeway  99 5 99
 Ramp  Highest rank of connected segment
 Major Highway  3
 Minor Highway  2
 Primary Street  1
 Street  1
 :|:|:|:|:Railroad:|:|:|:|:  2
 Ferry  5

x3 A/C match (default C)
Segment Type First Column  Second Column  Third Column
 Freeway  313 5 313
 Ramp  Highest rank of connected segment
 Major Highway  3
 Minor Highway  2
 Primary Street  1
 Street  1
 :|:|:|:|:Railroad:|:|:|:|:  2
 Ferry  5


x3 A/C default
Segment Type First Column  Second Column  Third Column
 Freeway  4 144 4
 Ramp  Highest rank of connected segment
 Major Highway  3
 Minor Highway  2
 Primary Street  1
 Street  1
 :|:|:|:|:Railroad:|:|:|:|:  2
 Ferry  5


x2 All Different
Segment Type First Column  Second Column
 Freeway  4 5
 Ramp  Highest rank of connected segment
 Major Highway  3
 Minor Highway  2
 Primary Street  1
 Street  1
 :|:|:|:|:Railroad:|:|:|:|:  2
 Ferry  5

x2 All Default
Segment Type First Column  Second Column
 Freeway  4
 Ramp  Highest rank of connected segment
 Major Highway  3
 Minor Highway  2
 Primary Street  1
 Street  1
 :|:|:|:|:Railroad:|:|:|:|:  2
 Ferry  5

x2 Manual Match
Segment Type First Column  Second Column
 Freeway  5
 Ramp  Highest rank of connected segment
 Major Highway  3
 Minor Highway  2
 Primary Street  1
 Street  1
 :|:|:|:|:Railroad:|:|:|:|:  2
 Ferry  5

x1 Default - no table params
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

x1 Custom lock
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

x1 custom title and lock
Segment Type custom
 Freeway  5
 Ramp  Highest rank of connected segment
 Major Highway  3
 Minor Highway  2
 Primary Street  1
 Street  1
 :|:|:|:|:Railroad:|:|:|:|:  2
 Ferry  5

private
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
 Private Road  3

private and plr
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
 Private Road  2
 Parking Lot Road  1

private and plr (default 1, custom 2)
Segment Type Default locks  custom plr
 Freeway  4
 Ramp  Highest rank of connected segment
 Major Highway  3
 Minor Highway  2
 Primary Street  1
 Street  1
 :|:|:|:|:Railroad:|:|:|:|:  2
 Ferry  5
 Private Road  2
 Parking Lot Road  1 2

plr
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
 Parking Lot Road  3


Retrieved from "https://beta.waze.com/wiki/USA/index.php?title=Template:Locking_Standard/Sandbox/doc&oldid=97039"