Template:Infobox cycling path/doc
| This is a documentation subpage for Template:Infobox cycling path. It contains usage information, categories and other content that is not part of the original template page. |
| Please note this documentation is also included in Wikipedia:WikiProject Cycling. |
| This template uses Lua: |
This template is in articles about specific cycling paths. The example on the right shows a good example of how a path template is properly used.
Contents
Blank template
Template:Parameter names example
{{Infobox cycling path
| name =
| embed =
| cellstyle =
| photo =
| photo_size =
| photo_alt =
| caption =
| title =
| established =
| length =
| location =
| designation =
| trailheads =
| use = <!-- May be mixed use, e.g. cycling, pedestrians, horse trail, etc. List all approved uses. -->
| elev_gain_and_loss =
| elev_change = <!-- Use elev_gain_and_loss if the gain and/or loss is known.
Use this field when only the change is known. -->
| highest =
| lowest =
| grade =
| difficulty =
| season =
| months =
| waymark =
| sights =
| hazards =
| surface =
| ROW =
| certification =
| website =
| map =
| map_name =
| map_caption =
| map_size =
| map_alt =
| route =
| route_state =
}}
Parameter descriptions
| Parameter | Description |
|---|---|
| name | Name of the path |
| length_km | Length of the path in kilometers, as a single number. Will convert to miles automatically |
| length_mi | Length of the path in miles, as a single number. Will convert to kilometers automatically. Please only use for paths in the United States or the United Kingdom |
| length | Length of path, no auto-conversion. Use if you want to add more words or citation to length. |
| location | Location of the path including park, state, county or region where appropriate and country. |
| trailheads | where path begins and ends |
| use | always include at least cycling |
| photo | Photo of the area around the path. Specify as filename.jpg, no need for "File:". Please use a high-resolution original (at least 300 pixels wide). |
| photo_size | Width of displayed photo, in pixels. Defaults to 250. |
| photo_alt | Alternate text for the displayed photo |
| designation | Any designation which the path has received e.g. UK National Cycle Network or Dutch LF-Route. |
| established | Establishment date |
| elev_gain_and_loss | The elevation gain and/or loss e.g. "{{convert|300|m|ft|-1}} gain" or "{{convert|300|m|ft|-1}} gain in; {{convert|100|m|ft|-1}} gain out". Please express the gain or loss in meters or feet, not kilometers or miles. |
| elev_change | The sum of the altitude climbed or descended through the path. Auto-converts units if _ft or _m suffix is used. |
| elev_change_ft | |
| elev_change_m | |
| highest_m | Elevation of highest point on path, in either meters or feet (will autoconvert). Please use _ft only for paths in the United States and the United Kingdom |
| highest_ft | |
| highest_name | Name of highest point in path (for use with highest_ft or highest_m) |
| highest | Free field for highest point in path, use when citations is needed |
| lowest_m | Similar to highest_ etc., except describing the lowest point of the path |
| lowest_ft | |
| lowest_name | |
| lowest | |
| grade | The grade in percent, typical with former railroad right-of-ways |
| difficulty | The difficulty of the path for a typical healthy person based on a reliable source |
| season | The season(s) that the path may be cycled, or is easily accessible |
| months | The months that the path may be hiked, or is easily accessible |
| sights | Significant sights along the way |
| hazards | Major hazards that a cyclist may encounter, as documented by a reliable source |
| surface | The path surface(s): natural, gravel, ballast, asphalt, etc. |
| ROW | The current or former Right of way, e.g. railroads or railways |
| certification | Certification by official cycling organisations e.g. ADFC 4 star route |
| website | Website of the organization that maintains the path |
| waymark | The waymark (sign or symbol) used to mark or signpost the route |
| map | Map of the path, if an image |
| map_name | Map name. Default is "Path map". |
| map_size | Size of map (either in px or %) |
| map_alt | Alt text for map |
| map_caption | Caption for map |
| route | Map of the path, if a route diagram template |
| route_state | Collapsed state of route map |
Embed inside another Infobox
The cycling path Infobox can be embedded inside another Infobox for seamless display of info. For example, a cycling path that is also a protected area, such as the Kal-Haven Trail. See the testcases for more examples.
Inserting the cycling path Infobox inside the parent Infobox
The cycling path Infobox can only be inserted after certain field values of the parent template. Specifically, only after fields whose values are not passed to another template by the parent templates source code. In other words, the parent templates source code for the field has to output the fields' value without passing it to a template. This may require examining the parent templates source code. It is ok to insert after field values that contain internal [[]] and external links [].
Example:
{| style="float:right; clear:right; border:0; margin:-0.5em 0 0 0;"
|-
|{{Infobox Protected area
| name = Kal-Haven Trail
...
| governing_body = <div>[[Michigan Department of Natural Resources]]</div>
{{Infobox cycling path
| embed = yes
| cellstyle = padding:0.1em 0.3em;
| name = Kal-Haven Trail
| length = {{convert|34.5|mi|km|1}}
...
}}
}}
|}
Note the <div> tag surrounding the governing_body wiki link. It is needed to reduce the vertical spacing between the governing_body field and the first cycling path field, in this case, length.
Parent Infobox encapsulation
The parent Infobox needs to be encapsulated in a table as in the above example.
{| style="float:right; clear:right; border:0; margin:-0.5em 0 0 0;"
|-
|(parent Infobox)
|}
Parameters
| Field name | Description |
|---|---|
embed |
Set to embed = yes when embedding inside another Infobox.
|
cellstyle |
Set to a class/style that matches the outer Infoboxes cell class/style so that the columns line up properly. Example for using with {{Infobox protected area}}:cellstyle = padding:0.1em 0.3em;
|
title |
A first colored header before the main infobox, used when embedded, to show the path name |
Example
| National Cycle Route 1 | |
|---|---|
| Length | 1,695 miles (2,728 km)[1] |
| Location | United Kingdom and Scotland |
| Designation | UK National Cycle Network |
| Trailheads | Dover (south) to Shetland (north) |
| Use | Cycling |
| Cycling details | |
| Surface | Varies from on-road to traffic-free tarmac to compacted surface |
| Website | Template:URL |
{{Infobox cycling path
| name = National Cycle Route 1
| embed =
| cellstyle =
| photo = NCN Route 1 Milepost at Conyer.jpg
| photo_size =
| photo_alt =
| caption = A milepost on National Cycle Route 1 at [[Conyer]], [[Kent]].
| title =
| established =
| length = {{convert|1695|mi}}<ref>{{cite web |url=http://www.sustrans.org.uk/ncn/map/route/route-1 |title=Route 1 |work=National Cycle Network |publisher=C |date=2016 |access-date=4 December 2016 }}</ref>
| location = [[United Kingdom]] and [[Scotland]]
| designation = [[National Cycle Network|UK National Cycle Network]]
| trailheads = [[Dover]] {{small|(south)}} to [[Shetland]] {{small|(north)}}
| use = [[Cycling]]<!-- May be mixed use, e.g. cycling, pedestrians, horse trail, etc. List all approved uses. -->
| elev_gain_and_loss =
| elev_change = <!-- Use elev_gain_and_loss if the gain and/or loss is known.
Use this field when only the change is known. -->
| highest =
| lowest =
| grade =
| difficulty =
| season =
| months =
| waymark =
| sights =
| hazards =
| surface = Varies from on-road to traffic-free tarmac to compacted surface
| ROW =
| certification =
| website = {{URL|http://www.sustrans.org.uk/ncn/map/route/route-1|sustrans.org.uk}}
| map_name =
| map_caption =
| map_size =
| map_alt =
| route =
| route_state =
}}
Tracking category