Template:Lock Standard State View history

Revision as of 16:40, 15 January 2015

You have not specified a state abbreviation or other equivalent, so no locking scheme can be generated

Template documentation

This template is transcluded into many state pages to define their locking standards. Any errant changes to this page can affect lots of state wiki pages relying on this template. Please be sure you fully comprehend this template and how parser switch functions work before editing it. If you need help please ask someone.

Please do not make changes to any state or regions defined settings without first getting consensus in the local forum, or approval from the RC.

This template simplifies calls to the Locking Standard template. The parameter list is somewhat long, and easy to confuse should there be multiple variations of locking standards within the state. To simplify this, a second template -- this one -- can be used to can the call for each area. You put all the complex code for your states locks in here, and just add the simple one line code to call this template on your states page.

You call this template as follows:

{{Lock Standard State|XY}}
...where XY is use a USPS state abbreviation or the like. But the list of abbreviations "and the like" must be predefined in this template.

Defining a new states locks

The template is a large "switch" statement that shows all the "states" (or provinces, regions, etc.) for which it is programmed.

To program a new state, you must first know how to use the {{Locking Standard}} template -- this template doesn't eliminate that work. This template just self-documents the resulting code, makes your states wiki page code look much cleaner, and less likely to accidentally break. (However, anyone touching the code here can break a lot of state pages!)

Once you have developed the code to define your states locking table using the {{Locking Standard}} template, use the following guidance to add a new state/region/group of localities/etc to this template.

Each state abbreviation must be in all UPPER CASE, and entered on a new line starting with a pipe character (the vertical bar |).
- Multiple states or regions can be set to use a single definition using the "fall through" technique. If you want this state to use the same values as another defined state/region; do not put the equals sign (=) following the state/region name, make sure this state/region name is added above the defined state/region you want to use. When there is no (=) after the name, it will use the next defined set of values below.
- Do not add any new states below the default settings at the bottom of the template.
To define this state put a equals sign (=) after the state abbreviation and then start the {{Locking Standard}} template code.
- Now add a wiki comment describing the source of the information, your username, and the date. These comments are only visible in the code, and displayed in the wiki, they help to keep track of changes and for maintenance. To start a comment use anything after this is displayed in the wiki.
  - For example
```
XX|{{Locking Standard 
```
- On the next line start adding in the parameters to build your state table for the {{Locking Standard}} template. To make this template easy to read you can add line breaks and indents before new parameters. You can start each parameter or group of parameters with the pipe on a new line, and use regular spaces to indent before the pipe, showing context.
- Remember to end your defining template code with a closing pair of braces (}}).
Now add the {{Lock Standard State|XX}} template code to your states wiki page.
After saving any changes to this template, please check the output for your state, and all the examples listed in the /doc page, to ensure they are producing the correct output.
- If you notice that the output for your state or some of the examples listed here in the doc page are wrong, please "UNDO" your changes using the link by your edit on the history tab.

|AB = {{Locking Standard <!--comment explaining source of information, etc., the dashes, ! and LT/GT are part of the wiki code and must be present-->
   |parameterA = value value value
   |parameterB = text text text
   |Fwy = 1 | Fwy2 = 2
   |MH = 4 | mH = 3
   |MH2 = 5 | mH2 = 5}}
|FG = {{Locking Standard <!-- comment explaining source of information, etc., the dashes, ! and LT/GT are part of the wiki code and must be present-->
   |Title1 = value value value
      |Fwy = 1 | MH = 2 | mH = 3
   |Title2 = text text text
      |Fwy2 = 5 |MH2 = 5 | mH2 = 5}}
| CD = {{Locking Standard}} <!--simple case, uses no parameters, only defaults-->
| REGION9
| REGION9PROVINCE1
| REGION9PROVINCE2
| REGION9PROVINCE3 = {{Locking Standard
   |lede=This locking standard applies to the entire Region 9 (all three member provinces, Province1, Province2, Province3)
   |Fwy=5}}
| NEW SMALLVILLE
| NEW BIGVILLE = {{Locking Standard <!--New Smallville and New Bigville share the same setup, so only one of them has to actually have the code (always the last one), and the others don't have an {{=}} {{Locking Standard... the wiki understands to just pick the next one actually specified. (Just as Region 9 above) This is called "Fall through".-->
   |Fwy = 4}}

Examples

Note that due to the peculiarities of the underlying Locking Standard template, the state name is only picked up correctly when used as intended in State Pages. It otherwise picks up the rather nonsensical (in context) name of the current page for the caption/lede.

{{Lock Standard State|CA}}

In Lock Standard State 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.