Template:Infobox trail/doc

This template is in articles about specific hiking trails or cycleways. The example on the right shows a good example of how a trail template is properly used.

Blank template

{{{name}}}
[[File:{{{photo}}}|{{{photo_size}}}|alt={{{photo_alt}}}]] {{{caption}}}
{{{title}}}
Length	{{{length}}}
Location	{{{location}}}
Established	{{{established}}}
Began construction	{{{began}}}
Completed	{{{completed}}}
Closed	{{{closed_date}}}
Designation	{{{designation}}}
Trailheads	{{{trailheads}}}
Use	{{{use}}}
Elevation gain/loss	{{{elev_gain_and_loss}}}
Elevation change	{{{elev_change}}}
Highest point	{{{highest_name}}}, , {{{highest}}}
Lowest point	{{{lowest_name}}}, , {{{lowest}}}
Grade	{{{grade}}}
Difficulty	{{{difficulty}}}
Season	{{{season}}}
Months	{{{months}}}
Waymark	{{{waymark}}}
Sights	{{{sights}}}
Hazards	{{{hazards}}}
Surface	{{{surface}}}
Right of way	{{{ROW}}}
Maintained by	{{{maintainer}}}
Website	{{{website}}}
{{{map_name}}}
[[File:{{{map}}}|{{{map_size}}}|alt={{{map_alt}}}]] {{{map_caption}}}

{{Infobox trail
| name        = 
| embed       = 
| cellstyle   = 
| photo       = 
| photo_size  = 
| photo_alt   = 
| caption     = 
| title       = 
| established = 
| began       = 
| completed   = 
| closed_date = 
| length      = 
| location    = 
| designation = 
| trailheads  = 
| use         = 
| 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         = 
| maintainer  = 
| certification =
| website     = 
| map         = 
| map_name    = 
| map_caption = 
| map_size    = 
| map_alt     = 
| route       = 
| route_state = 
}}

Parameter descriptions

Parameter	Description
name	Name of the trail
length_km	Length of the trail in kilometers, as a single number. Will convert to miles automatically
length_mi	Length of the trail in miles, as a single number. Will convert to kilometers automatically. For information on use of units see Manual of Style Units.
length	Length of trail, no auto-conversion. Use if you want to add more words or citation to length.
location	Location of the trail including park, state, county or region where appropriate and country.
trailheads	where trail begins and ends
use	always include at least hiking or cycling or ...
photo	Photo of the area around the trail. 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 trail has received e.g. UK National Trail or U.S. National Scenic Trail.
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 trail. Auto-converts units if _ft or _m suffix is used.
elev_change_ft
elev_change_m
highest_m	Elevation of highest point on trail, in either meters or feet (will autoconvert). For information on the use of units see Manual of Style Units.
highest_ft
highest_name	Name of highest point in trail (for use with highest_ft or highest_m)
highest	Free field for highest point in trail, use when citations is needed
lowest_m	Similar to highest_ etc., except describing the lowest point of the trail
lowest_ft
lowest_name
lowest
grade	The grade in percent, typical with former railroad right-of-ways
difficulty	The difficulty of the trail for a typical healthy person based on a reliable source
season	The season(s) that the trail may be hiked, or is easily accessible
months	The months that the trail may be hiked, or is easily accessible
sights	Significant sights along the way
hazards	Major hazards that a hiker may encounter, as documented by a reliable source
surface	The trail surface: natural, gravel, ballast, asphalt, etc.
ROW	The current or former Right of way, e.g. railroads or railways
maintainer	The organisation responsible for maintaining the route
website	Website of the organization that maintains the trail
waymark	The waymark (sign or symbol) used to mark or signpost the route
map	Map of the trail, if an image
map_name	Map name. Default is "Trail 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 trail, if a route diagram template
route_state	Collapsed state of route map

Embed inside another infobox

The trail infobox can be embedded inside another infobox for seamless display of info. For example, a trail that is also a protected area, such as the Kal-Haven Trail. See the testcases for more examples.

Inserting the trail infobox inside the parent infobox

The trail 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 trail
  | 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 hiking trail 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 trail name

Example

Wonderland Trail
Mt Rainier from the Cowlitz Divide along the Wonderland Trail
Length	93 miles (150 km)
Location	Mount Rainier National Park, Washington, United States
Trailheads	Longmire Lodge Mowich Lake Ipsut Creek Camp Ground Sunrise parking area White River Camp Ground Fryingpan Creek Trailhead Box Canyon Reflection Lakes Cougar Rock
Use	Hiking
Elevation gain/loss	22,000 feet (6,700 m) gain approximately
Highest point	Panhandle Gap 6,750 feet (2,060 m)
Lowest point	Ipsut Creek Campground 2,320 feet (710 m)
Season	Summer to early fall
Months	Mid-July through late September
Website	nps.gov/mora/planyourvisit/the-wonderland-trail.htm

{{Infobox trail
 | name = Wonderland Trail
 | photo = CowlitzDivide.JPG
 | caption = Mt Rainier from the Cowlitz Divide along the Wonderland Trail
 | location = [[Mount Rainier National Park]], [[Washington (state)|Washington]], [[United States]]
 | length = {{convert|93|mi|km|0}}<ref name="Filley">
     {{cite book
     | author = Filley, Bette
     | year = 2002
     | title = Discovering the Wonders of the Wonderland Trail: Encircling Mount Rainier
     | publisher = Dunamis House
     | isbn = 1-880405-09-1
     | edition = 5th
     }}</ref>
 | trailheads = [[Longmire, Washington|Longmire Lodge]] <br/> [[Mowich Lake]] <br/> Ipsut Creek Camp Ground <br/> [[Sunrise (Mount Rainier)|Sunrise parking area]] <br/> White River Camp Ground <br/> Fryingpan Creek Trailhead <br/> Box Canyon <br/> Reflection Lakes <br/> Cougar Rock
 | use = [[Hiking]]
 | elev_gain_and_loss = {{convert|22000|ft|m|-2}} gain approximately<ref name="Filley"/>
 | highest = Panhandle Gap {{convert|6750|ft|m|-1}}<ref name="SpringManningMRNP">
     {{cite book
     | author = Spring, Ira
     | author-link = Ira Spring
     | author-link2 = Harvey Manning
     | author2=Manning, Harvey
     | year = 1999
     | title = 50 Hikes in Mount Rainier National Park
     | publisher = The Mountaineers
     | isbn = 0-89886-572-7
     }}</ref>
 | lowest = Ipsut Creek Campground {{convert|2320|ft|m|-1}}<ref name="Filley"/>
 | season = Summer to early [[Autumn|fall]]
 | months = Mid-July through late September
 | website = [http://www.nps.gov/mora/planyourvisit/the-wonderland-trail.htm nps.gov/mora/planyourvisit/the-wonderland-trail.htm]
}}

Tracking category

• Category:Pages using infobox trail with unknown parameters (0)

TemplateData

No description.

Template parameters

This template prefers block formatting of parameters.

Parameter		Description	Type	Status
Name	name	Name of the trail; defaults to page name	String	suggested
Length in kilometers	length_km	Will convert to miles automatically	Number	optional
Length in miles	length_mi	Will convert to kilometers automatically	Number	optional
Length	length	No auto-conversion	String	optional
Location	location	including park, state, county or region where appropriate and country	Unknown	optional
Trailheads	trailheads	no description	Unknown	optional
Use	use	no description Example hiking, cycling	String	optional
Photo	photo	no description	File	optional
Photo size	photo_size	Width of displayed photo, in pixels. Defaults to 250.	Number	optional
Photo alternate text	photo_alt	no description	Unknown	optional
Designation	designation	no description Example UK National Trail, US National Scenic Trail	Unknown	optional
Established	established	no description	Unknown	optional
Elevation gain/loss	elev_gain_and_loss	Gain/loss with no units; use {{convert}}	String	optional
Elevation change	elev_change	The sum of the altitude climbed or descended through the trail; use {{convert}}	Unknown	optional
Elevation change (ft)	elev_change_ft	The sum of the altitude climbed or descended through the trail; will be auto-converted	Number	optional
Elevation change (m)	elev_change_m	The sum of the altitude climbed or descended through the trail; will be auto-converted	Number	optional
Highest point (ft)	highest_ft	Highest point in feet; will be auto-converted	Number	optional
Highest point (m)	highest_m	Highest point in meters; will be auto-converted	Number	optional
Highest point	highest_name	Name of highest point in trail (for use with highest_ft or highest_m)	String	optional
Lowest point (m)	lowest_m	no description	Number	optional
Lowest point (ft)	lowest_ft	no description	Number	optional
Lowest point	lowest	no description	Unknown	optional
Name of lowest point	lowest_name	Name of lowest point in trail (for use with lowest_ft or lowest_m)	String	optional
Grade	grade	Grade in percent	Unknown	optional
Difficulty	difficulty	The difficulty of the trail for a typical healthy person, based on a reliable source	String	optional
Season	season	The season(s) that the trail may be hiked, or is easily accessible	String	optional
Months	months	The months that the trail may be hiked, or is easily accessible	Unknown	optional
Sights	sights	no description	Unknown	optional
Hazards	hazards	no description	Unknown	optional
Surface	surface	Material used as the surface of the trail Example natural, gravel, ballast, asphalt	String	optional
Right-of-way	ROW	The current or former Right of way, e.g. railroads or railways	String	optional
Maintainer	maintainer	Organization responsible for maintaining the route	String	optional
Website	website	Use {{URL}} or {{official URL}}	Unknown	optional
Waymark	waymark	Description of the waymark (sign or symbol) used to mark or signpost the route	String	optional
Map image	map	Map of the trail, if an image	File	optional
Map image name	map_name	Map name. Default is "Trail map" Default Trail map	Unknown	optional
Map image size	map_size	Size of map (either in px or %)	Unknown	optional
Map image alt text	map_alt	no description	String	optional
Map image caption	map_caption	no description	String	optional
Route diagram	route	Map of the trail, from a template in [[Category:Trail routemap templates]]	Template	optional
Route diagram collapsed state	route_state	Collapsed state of route map Suggested values collapsed uncollapsed Default uncollapsed	String	optional
Embed	embed	Set to "yes" if this template is embedded inside another template Suggested values yes Default yes	String	optional
cellstyle	cellstyle	Set to a class/style that matches the outer Infoboxes cell class/style so that the columns line up properly; see template documentation for more details	String	optional
title	title	A first colored header before the main infobox, used when embedded, to show the trail name	String	optional

References

These references will appear in the article, but this list appears only on this page.