Template:Locking Standard/Sandbox/doc View history

(Update Parameters)
(T)
Line 43: Line 43:
* Freeway is set to 5 instead of to 4
* 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.
* 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 "attend" parameter, which functions similarly except without the bolded "Note: " prefix
* The "note" is changed to the "append" parameter, which functions similarly except without the bolded "Note: " prefix
}}
}}



Revision as of 20:31, 18 January 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

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