Difference between revisions of "Template:AUSintcore/doc"
blackwiki>Numbermaniac m |
blackwiki>Evad37 (add more to TemplateData) |
||
| Line 219: | Line 219: | ||
"description": "A template for making intersection tables.", | "description": "A template for making intersection tables.", | ||
"params": { | "params": { | ||
| − | "1": {}, | + | "1": { |
| − | "sspan": {}, | + | "label": "Exit number columns", |
| + | "description": "For an exit number column, set to \"exit\". For exit number and old exit number columns, set to \"old\"" | ||
| + | }, | ||
| + | "sspan": { | ||
| + | "label": "State-cell span", | ||
| + | "description": "Number of rows that the state cell spans, for interstate routes. For routes within a single state/territory, do not use this parameter" | ||
| + | }, | ||
"LGAspan": { | "LGAspan": { | ||
| − | "description": " | + | "description": "Number of rows the LGA cell spans. If value=1, omit this parameter. If set, LGA (or LGAC etc) paramters should be omitted from the other rows it spans.", |
"type": "number", | "type": "number", | ||
| − | "default": " | + | "default": "", |
| + | "label": "LGA-cell span" | ||
}, | }, | ||
"LGA": { | "LGA": { | ||
| − | "description": "The name of the local government area in which the intersection is located. Full wiki markup is required, for example: | + | "description": "The name of the local government area in which the intersection is located. Full wiki markup is required, for example: [[City of Mitcham|Mitcham]]", |
"type": "string", | "type": "string", | ||
"required": true, | "required": true, | ||
| − | "suggested": true | + | "suggested": true, |
| + | "label": "Local government area" | ||
| + | }, | ||
| + | "LGAC": { | ||
| + | "label": "Local government area - City of ____", | ||
| + | "description": "Name of the local government area, when the name is of the form \"City of NAME\"" | ||
| + | }, | ||
| + | "LGA-C": { | ||
| + | "label": "Local government area - ____ City", | ||
| + | "description": "Name of the local government area, when the name is of the form \"NAME City\"" | ||
| + | }, | ||
| + | "LGARC": { | ||
| + | "label": "Local government area - Rural City of ____", | ||
| + | "description": "Name of the local government area, when the name is of the form \"Rural City of NAME\"" | ||
| + | }, | ||
| + | "LGA-Co": { | ||
| + | "label": "Local government area - ____ Council", | ||
| + | "description": "Name of the local government area, when the name is of the form \"NAME Council\"" | ||
| + | }, | ||
| + | "LGADC": { | ||
| + | "label": "Local government area - District Council of ____", | ||
| + | "description": "Name of the local government area, when the name is of the form \"District Council of NAME\"" | ||
| + | }, | ||
| + | "LGA-DC": { | ||
| + | "label": "Local government area - ____ District Council", | ||
| + | "description": "Name of the local government area, when the name is of the form \"NAME District Council\"" | ||
| + | }, | ||
| + | "LGAM": { | ||
| + | "label": "Local government area - Municipality of ____", | ||
| + | "description": "Name of the local government area, when the name is of the form \"Municipality of NAME\"" | ||
| + | }, | ||
| + | "LGA-M": { | ||
| + | "label": "Local government area - ____ Municipality", | ||
| + | "description": "Name of the local government area, when the name is of the form \"NAME Municipality\"" | ||
| + | }, | ||
| + | "LGA-R": { | ||
| + | "label": "Local government area - ____ Region", | ||
| + | "description": "Name of the local government area, when the name is of the form \"NAME Region\"" | ||
| + | }, | ||
| + | "LGAS": { | ||
| + | "label": "Local government area - Shire of ____", | ||
| + | "description": "Name of the local government area, when the name is of the form \"Shire of NAME\"" | ||
| + | }, | ||
| + | "LGA-S": { | ||
| + | "label": "Local government area - ____ Shire", | ||
| + | "description": "Name of the local government area, when the name is of the form \"NAME Shire\"" | ||
| + | }, | ||
| + | "LGAAS": { | ||
| + | "label": "Local government area - Aboriginal Shire of ____", | ||
| + | "description": "Name of the local government area, when the name is of the form \"Aboriginal Shire of NAME\"" | ||
| + | }, | ||
| + | "LGAT": { | ||
| + | "label": "Local government area - Town of ____", | ||
| + | "description": "Name of the local government area, when the name is of the form \"Town of NAME\"" | ||
| + | }, | ||
| + | "LGA_note": { | ||
| + | "description": "A note that appears in small text below the LGA" | ||
}, | }, | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
"location": { | "location": { | ||
| − | "description": "the suburb the intersection is in. The text entered here will be wikilinked to <text entered>, | + | "description": "the suburb the intersection is in. The text entered here will be wikilinked to <text entered>, <state>, so if the intersection is in multiple suburbs, you must use the \"location_special\" parameter", |
"type": "string", | "type": "string", | ||
"suggested": true | "suggested": true | ||
}, | }, | ||
| − | "location_special": {}, | + | "location_special": { |
| + | "description": "(replaces \"location\" parameter) the location where the junction is located - use for custom entries only, such as when an intersection is in multiple suburbs. Requires full wiki markup." | ||
| + | }, | ||
"lspan": { | "lspan": { | ||
| − | "description": "number of rows the location spans—if value=1, omit this parameter. If set, location (or location_special) should be omitted from the other rows it spans", | + | "description": "number of rows the location cell spans—if value=1, omit this parameter. If set, location (or location_special) should be omitted from the other rows it spans", |
"type": "string" | "type": "string" | ||
}, | }, | ||
| − | "lcspan": {}, | + | "lcspan": { |
| − | "lcalign": {}, | + | "description": "number of columns the location cell spans—if value=1, omit this parameter. If set, LGA and/or state cells should be omitted from this rows" |
| − | "type": {}, | + | }, |
| + | "lcalign": { | ||
| + | "description": "Alignment of the location cell, if \"lcspan\" parameter is used. Can be set to \"left\", \"right\", or \"center\"" | ||
| + | }, | ||
| + | "type": { | ||
| + | "description": "use to specify a shading for the intersection's row. The permitted types are: \"closed\" for highway intersections or interchanges that are now closed to traffic; \"concur\" for a route concurrency terminus; \"trans\" for a route transition – from one route number to either another route number, or a section without a route number, along a named road; \"unbuilt\" for unbuilt roadway intersections/interchanges; \"incomplete\" for incomplete intersections/interchanges where all movements are not supported (Northbound exit and southbound entrance, etc); \"hov\" for interchanges that are only for High occupancy vehicle lanes; \"toll\" or \"etc\" for an interchange where tolls or electronic tolls are collected" | ||
| + | }, | ||
"unit": {}, | "unit": {}, | ||
"km": { | "km": { | ||
"description": "km: the distance, in kilometres, of the intersection from the start of the road. Only enter numerical values, as these will be used to automatically generate a Miles column. Use km2 if the location is in a range of kilometres", | "description": "km: the distance, in kilometres, of the intersection from the start of the road. Only enter numerical values, as these will be used to automatically generate a Miles column. Use km2 if the location is in a range of kilometres", | ||
| − | "type": "number" | + | "type": "number", |
| + | "suggested": true | ||
}, | }, | ||
"km2": { | "km2": { | ||
| Line 268: | Line 326: | ||
"type": "number" | "type": "number" | ||
}, | }, | ||
| − | "uspan": {}, | + | "uspan": { |
| − | "old": {}, | + | "label": "units-cells span", |
| − | "ospan": {}, | + | "description": "number of rows the units cells spans—if value=1, omit this parameter. If set, km and km2 should be omitted from the other rows it spans." |
| − | "exit": {}, | + | }, |
| − | "espan": {}, | + | "old": { |
| + | "description": "Old exit number" | ||
| + | }, | ||
| + | "ospan": { | ||
| + | "description": "number of rows the old exit number spans—if value=1, omit this parameter. If set, \"old\" parameter should be omitted from the other rows it spans" | ||
| + | }, | ||
| + | "exit": { | ||
| + | "description": "Exit number" | ||
| + | }, | ||
| + | "espan": { | ||
| + | "description": "number of rows the exit number spans—if value=1, omit this parameter. If set, \"exit\" parameter should be omitted from the other rows it spans" | ||
| + | }, | ||
"road": { | "road": { | ||
| − | "description": "road that the article route intersects at this junction. This should be formatted as follows:<route shield/s> <wikilinked Road Name> <ndash> <wikilinked destinations> | + | "description": "road that the article route intersects at this junction. This should be formatted as follows:<route shield/s> <wikilinked Road Name> <ndash> <wikilinked destinations> ; Generate route shields using {{AUshield}; If there are multiple roads (ie intersecting road changes name at this intersection), use a slash (/) to separate roads; Generate an ndash (–) and wikilinked destinations using {{ACTcity}}, {{NSWcity}}, {{VICcity}} etc; If destinations are to be entered manually, an ndash can be generated by the HTML character code –", |
"type": "string", | "type": "string", | ||
| − | "required": true | + | "required": true, |
| + | "suggested": true | ||
| + | }, | ||
| + | "rspan": { | ||
| + | "description": "number of rows the road cell spans—if value=1, omit this parameter" | ||
| + | }, | ||
| + | "rcspan": { | ||
| + | "description": "number of columns the road cell spans—if value=1, omit this parameter. if using this parameter, set the \"notes\" parameter to \"none\" to avoid the notes cell spilling over the edge of the table." | ||
| + | }, | ||
| + | "notes": { | ||
| + | "description": "any notes regarding that junction. This must include an explanation for any usage of the type-generated shading.", | ||
| + | "suggested": true | ||
| + | }, | ||
| + | "nspan": { | ||
| + | "description": "number of rows the notes spans—if value=1, omit this parameter. If set, the \"notes\" parameter should be omitted from the other rows it spans." | ||
| + | }, | ||
| + | "place": { | ||
| + | "aliases": [ | ||
| + | "bridge", | ||
| + | "tunnel" | ||
| + | ], | ||
| + | "description": "a feature, such as a bridge or tunnel. This will appear in a multicolumn cell (centre aligned) that spans the destinations and notes columns. Full wiki markup is required for links, otherwise the result will be plain text." | ||
| + | }, | ||
| + | "pspan": { | ||
| + | "aliases": [ | ||
| + | "bspan", | ||
| + | "tspan" | ||
| + | ], | ||
| + | "description": "number of rows the place/bridge/tunnel multicolumn cell spans—if value=1, omit this parameter." | ||
}, | }, | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
} | } | ||
} | } | ||
Revision as of 00:45, 16 January 2015
| This is a documentation subpage for Template:AUSintcore. It contains usage information, categories and other content that is not part of the original template page. |
This is a template for generating an intersection or exit for a State not specified correctly - Must be the uppercase 2-to-3 letter abbreviation ie "WA" or "NSW" road article. It is a member of the {{Jctint}} suite of templates.
General usage
This is the basic syntax you need to get a complete intersection table. Just copy and paste the code below:
{{AUSinttop}}
State not specified correctly
|LGA=
|LGAspan=
|location=
|lspan=
|type=
|km=
|road=
|notes=
}}
{{Jctbtm}}
...and fill in the variables! For more entries, use this:
State not specified correctly |LGA= |LGAspan= |location= |lspan= |type= |km= |road= |notes= }}
Within a single LGA
If a road is entirely within a single local government area, you may omit the LGA column by using the following code:
{{AUSinttop|noLGA=yes}}
State not specified correctly
|location=
|lspan=
|type=
|km=
|road=
|notes=
}}
{{Jctbtm}}
Just copy and paste the above code, and fill in the variables! Also note that the table should be preceded by line explaining the omitted column, such as:
The entire freeway is in the [[City of Mitcham]].
For more entries, use this:
State not specified correctly |location= |lspan= |type= |km= |road= |notes= }}
Parameters
For the above parameters, here's what you should fill in:
- LGA: The name of the local government area in which the intersection is located. Full wiki markup is required, for example
|LGA=[[City of Mitcham|Mitcham]]. Parameters such as LGAC can be used intsead to avoid using full wiki markup (see below) - LGAspan: number of rows the LGA spans. If value=1, omit this parameter. If set, LGA (or LGAC etc) should be omitted from the other rows it spans.
- location: the suburb the intersection is in. The text entered here will be wikilinked to <text entered>, State not specified correctly, so if the intersection is in multiple suburbs, you must use location_special (see below).
- lspan: number of rows the location spans—if value=1, omit this parameter. If set, location (or location_special) should be omitted from the other rows it spans
- type: use to specify a shading for that intersection's row. The permitted types are:
- closed: for highway intersections or interchanges that are now closed to traffic
- mplex or concur: for a route multiplexing terminus or concurrencies.
- trans: for a route transition – from one route number to either another route number, or a section without a route number, along a named road
- unbuilt: for unbuilt roadway intersections/interchanges.
- incomplete: for incomplete intersections/interchanges where all movements are not supported (Northbound exit and southbound entrance, etc)
- hov for interchanges that are only for High occupancy vehicle lanes
- toll or etc for an interchange where tolls or electronic tolls are collected
- Note: If the type parameter is used, the table must include a colour key at the bottom of the table. Use the
|keys=parameter in {{jctbtm}} to generate a compliant legend.
- km: the distance, in kilometres, of the intersection from the start of the road. Only enter numerical values, as these will be used to automatically generate a Miles column. Use km2 if the location is in a range of kilometres (see below)
- road: road that the article route intersects at this junction. This should be formatted as follows:<route shield/s> <wikilinked Road Name> <ndash> <wikilinked destinations>
- Generate route shields using {{AUshield}}
- If there are multiple roads (ie intersecting road changes name at this intersection), use a slash (/) to separate roads
- Generate an ndash (–) and wikilinked destinations using State not specified correctly
- If destinations are to be entered manually, an ndash can be generated by the HTML character code
–
- notes: any notes regarding that junction. This must include an explanation for any usage of the type-generated shading.
Additional Parameters
In addition to those in the basic syntax, the following parameters may be used:
- LGA_note: a note that appears in small text below the LGA
- location_special: (replaces location) the location where the junction is located - use for custom entries only, such as when an intersection is in multiple suburbs. Requires full wiki markup.
- km2: use as the second measurement (km being the first) if an there are intersections with a road spread out between two points along the article route.
- uspan: number of rows the units spans—if value=1, omit this parameter. If set, km and km2) should be omitted from the other rows it spans.
- rcspan: number of columns the road cell spans-if value=1, omit this parameter. Set
|rcspan=2 to generate a left aligned cell that spans both the destination and notes column. Do not use for features such as a rivers and bridges - see place below. Important: if using this parameter, set|notes=none to avoid the notes cell spilling over the edge of the table. - nspan: number of rows the notes spans—if value=1, omit this parameter. If set, notes should be omitted from the other rows it spans.
- place or bridge or tunnel: a feature, such as a bridge or tunnel. This will appear in a multicolumn cell (centre aligned) that spans the destinations and notes columns. Full wiki markup is required for links, otherwise the result will be plain text.
- pspan or bspan or tspan: number of rows the above multicolumn cell spans-if value=1, omit this parameter.
- Parameters that replace LGA: The parameters in the table below allow you to enter the LGA name as plain text, and the template will generate the necessary piped link. For example,
|LGAC=Mitchamwill generate Mitcham , which links to the Wikipedia article City of Mitcham
| Parameter | Type of LGA (name of article on Wikipedia) |
|---|---|
| LGAC | "City of <name>" |
| LGA-C | "<name> City" |
| LGARC | "Rural City of <name>" |
| LGA-Co | "<name> Council" |
| LGADC | "District Council of <name>" |
| LGA-DC | "<name> District Council" |
| LGAM | "Municipality of <name>" |
| LGA-M | "<name> Municipality" |
| LGA-R | "<name> Region" |
| LGAS | "Shire of <name>" |
| LGA-S | "<name> Shire" |
| LGAAS | "Aboriginal Shire of <name>" |
| LGAT | "Town of <name>" |
Any parameter which is empty can be omitted.
TemplateData
|
|---|
|
Syntax error in JSON. |
See also
- {{jctname}}, {{AUshield}} and {{WAcity}}, are templates used to generate route shields and wikilinked destinations
- {{AUSinttop}}, a template that generates a MOS:RJL-compliant header for the junction list
- {{jctbtm}}, a template that closes the junction list table
- {{jcttop}}, {{CTint}}, {{ILint}}, {{INint}}, {{MIint}}, {{MNint}}, {{NHint}}, {{NYint}}, {{OHint}}, {{PAint}}, {{VTint}}, {{WIint}} are other templates in the {{Jctint}} suite, used in American road junction lists
- {{jctbridge}}, a template that generates rows for bridge crossings
- {{jctco}}, a template that generates rows for counties without junctions
- {{jctgap}}, a template for generating a row for a gap in the route
- {{jcttunnel}}, a template that generates rows for tunnel crossings
- {{jctrestarea}}, a template that generates rows for rest areas, service areas and the like