Difference between revisions of "Template:Infobox sailing yacht/doc"
imported>Hashar (Migrate to template data) |
imported>Vanisaac m (→Parameters: clean up per WP:CAT#T and WP:AWBREQ add template:Sandbox other) |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
{{Auto italic title}} | {{Auto italic title}} | ||
| + | |||
==Usage== | ==Usage== | ||
| − | {{ | + | {{Parameter names example |
| italic title = no | | italic title = no | ||
| − | | title | + | | title |
| − | | image | + | | image |
| − | | image_size | + | | image_size |
| − | | alt | + | | alt |
| − | | caption | + | | caption |
| − | | othernames | + | | othernames |
| − | | club | + | | club |
| − | | nat | + | | nat |
| − | | class | + | | class |
| − | | sailno | + | | sailno |
| − | | boats | + | | boats |
| − | | designer | + | | designer |
| − | | builder | + | | builder |
| − | | launched | + | | launched |
| − | | owner | + | | owner |
| − | | fate | + | | fate |
| − | | skip | + | | skip |
| − | | wins | + | | wins |
| − | | ac_year | + | | ac_year |
| − | | lc_year | + | | lc_year |
| − | | cc_year | + | | cc_year |
| − | | og_year | + | | og_year |
| − | | notablecrew | + | | notablecrew |
| − | | rr_year | + | | rr_year |
| − | | displacement | + | | displacement |
| − | | type | + | | type |
| − | | height | + | | height |
| − | | length | + | | length |
| − | | beam | + | | beam |
| − | | draft | + | | draft |
| − | | sail | + | | sail |
| − | | crew | + | | crew |
| − | | notes | + | | notes |
}} | }} | ||
| + | |||
This template summarizes information about an individual racing yacht. For racing syndicates use {{tlx|Infobox Sailing team}}. | This template summarizes information about an individual racing yacht. For racing syndicates use {{tlx|Infobox Sailing team}}. | ||
<pre style="overflow:auto"> | <pre style="overflow:auto"> | ||
| Line 72: | Line 74: | ||
}} | }} | ||
</pre> | </pre> | ||
| + | {{clear}} | ||
==Parameters== | ==Parameters== | ||
This infobox takes a number of parameters, which are optional unless indicated otherwise: | This infobox takes a number of parameters, which are optional unless indicated otherwise: | ||
| − | + | {{TemplateData header}} | |
| − | |||
| − | |||
| − | |||
| − | |||
<templatedata> | <templatedata> | ||
{ | { | ||
| + | "description": "This template summarizes information about an individual racing yacht. For racing syndicates use {{tlx|Infobox Sailing team}}.", | ||
"params": { | "params": { | ||
"title": { | "title": { | ||
"description": "The common name of the yacht which should preferably be the same as the article title. If the parameter is omitted, the article name is used.", | "description": "The common name of the yacht which should preferably be the same as the article title. If the parameter is omitted, the article name is used.", | ||
| − | "type": "string" | + | "type": "string", |
| + | "label": "Title" | ||
}, | }, | ||
"image": { | "image": { | ||
"description": "An image to represent the yacht or logo of the team.", | "description": "An image to represent the yacht or logo of the team.", | ||
| − | "type": "wiki-file-name" | + | "type": "wiki-file-name", |
| + | "label": "Image" | ||
| + | }, | ||
| + | "image_size": { | ||
| + | "label": "Image size" | ||
| + | }, | ||
| + | "alt": { | ||
| + | "label": "Alternate text" | ||
}, | }, | ||
| − | |||
| − | |||
"caption": { | "caption": { | ||
"description": "A caption for the image. Terms in the caption can be wikilinked, if desired.", | "description": "A caption for the image. Terms in the caption can be wikilinked, if desired.", | ||
| − | "type": "string" | + | "type": "string", |
| + | "label": "Caption" | ||
}, | }, | ||
"othernames": { | "othernames": { | ||
"description": "Other names in the career of the yacht", | "description": "Other names in the career of the yacht", | ||
| − | "type": "string" | + | "type": "string", |
| + | "label": "Other names" | ||
}, | }, | ||
"club": { | "club": { | ||
| − | " | + | "type": "string", |
| − | " | + | "label": "Yacht club" |
}, | }, | ||
"nat": { | "nat": { | ||
| − | "description": "The nationality of registration" | + | "description": "The nationality of registration", |
| + | "label": "Nationality" | ||
}, | }, | ||
"class": { | "class": { | ||
| − | " | + | "label": "Competition class" |
}, | }, | ||
"sailno": { | "sailno": { | ||
| − | |||
"example": "US–74", | "example": "US–74", | ||
| − | "type": "string" | + | "type": "string", |
| + | "label": "Sail number" | ||
| + | }, | ||
| + | "boats": { | ||
| + | "label": "Boats" | ||
}, | }, | ||
| − | |||
"designer": { | "designer": { | ||
| − | "description": "The yacht's designer" | + | "description": "The yacht's designer", |
| + | "label": "Designer" | ||
}, | }, | ||
"builder": { | "builder": { | ||
"description": "The yacht's boatbuilder", | "description": "The yacht's boatbuilder", | ||
| − | "type": "string" | + | "type": "string", |
| + | "label": "Builder" | ||
}, | }, | ||
"launched": { | "launched": { | ||
| − | |||
"example": "1993", | "example": "1993", | ||
| − | "type": "date" | + | "type": "date", |
| + | "label": "Date launched" | ||
}, | }, | ||
"owner": { | "owner": { | ||
"description": "Team Principal or Owner", | "description": "Team Principal or Owner", | ||
| − | "type": "string" | + | "type": "string", |
| + | "label": "Owner" | ||
}, | }, | ||
"fate": { | "fate": { | ||
"description": "The fate of the boat", | "description": "The fate of the boat", | ||
| − | "type": "string" | + | "type": "string", |
| + | "label": "Fate" | ||
}, | }, | ||
"skip": { | "skip": { | ||
| − | " | + | "type": "string", |
| − | " | + | "label": "Skipper/Helmsman" |
}, | }, | ||
"wins": { | "wins": { | ||
"description": "Major trophies such as LV Cups or America Cup wins", | "description": "Major trophies such as LV Cups or America Cup wins", | ||
| − | "type": "string" | + | "type": "string", |
| + | "label": "Wins" | ||
}, | }, | ||
"ac_year": { | "ac_year": { | ||
| − | "description": "The editions of America's Cup the yacht participated in" | + | "description": "The editions of America's Cup the yacht participated in", |
| + | "label": "America's Cup years" | ||
}, | }, | ||
"lc_year": { | "lc_year": { | ||
| − | "description": "The editions of America's Cup Challenger Selections Series (Louis Vuitton Cup, Herbert Pell Cup et cetera) the yacht participated in" | + | "description": "The editions of America's Cup Challenger Selections Series (Louis Vuitton Cup, Herbert Pell Cup et cetera) the yacht participated in", |
| + | "label": "America's Cup Challenger Selections years" | ||
}, | }, | ||
"cc_year": { | "cc_year": { | ||
| − | "description": "The editions of America's Cup Defender Selections Series the yacht participated in" | + | "description": "The editions of America's Cup Defender Selections Series the yacht participated in", |
| + | "label": "America's Cup Defender Selections years" | ||
}, | }, | ||
"og_year": { | "og_year": { | ||
| − | "description": "The editions of Summer Olympics the yacht participated in" | + | "description": "The editions of Summer Olympics the yacht participated in", |
| + | "label": "Olympics years" | ||
}, | }, | ||
"notablecrew": { | "notablecrew": { | ||
| − | "description": " | + | "description": "Other notable crew members, like Tacticians or others with Wiki pages", |
| + | "label": "Notable crew" | ||
}, | }, | ||
"rr_year": { | "rr_year": { | ||
| − | "description": "The editions of Route du Rhum the yacht participated in" | + | "description": "The editions of Route du Rhum the yacht participated in", |
| + | "label": "Route du Rhum years" | ||
}, | }, | ||
"displacement": { | "displacement": { | ||
| − | "description": "Displacement of the boat." | + | "description": "Displacement of the boat.", |
| + | "label": "Displacement" | ||
}, | }, | ||
"type": { | "type": { | ||
"description": "hull/rig type: sloop, cutter, schooner, catamaran, trimaran, etc.", | "description": "hull/rig type: sloop, cutter, schooner, catamaran, trimaran, etc.", | ||
"example": "catamaran", | "example": "catamaran", | ||
| − | "type": "string" | + | "type": "string", |
| + | "label": "Type" | ||
}, | }, | ||
"height": { | "height": { | ||
| − | "description": "Height of the mast" | + | "description": "Height of the mast", |
| + | "label": "Height" | ||
}, | }, | ||
"length": { | "length": { | ||
| − | "description": "Length of the boats. Length overall (LOA), length at waterline (LWL) or both." | + | "description": "Length of the boats. Length overall (LOA), length at waterline (LWL) or both.", |
| + | "label": "Length" | ||
}, | }, | ||
"beam": { | "beam": { | ||
| − | "description": "Beam of the boat" | + | "description": "Beam of the boat", |
| + | "label": "Beam" | ||
}, | }, | ||
"draft": { | "draft": { | ||
| − | "description": "Draft of the boat" | + | "description": "Draft of the boat", |
| + | "label": "Draft" | ||
}, | }, | ||
"sail": { | "sail": { | ||
| − | "description": "Total area of all sails" | + | "description": "Total area of all sails", |
| + | "label": "Sail area" | ||
}, | }, | ||
"crew": { | "crew": { | ||
| − | " | + | "label": "Crew number" |
}, | }, | ||
"notes": { | "notes": { | ||
"description": "Any other notes about the boat", | "description": "Any other notes about the boat", | ||
| − | "type": "string" | + | "type": "string", |
| + | "label": "Notes" | ||
} | } | ||
}, | }, | ||
| − | |||
"paramOrder": [ | "paramOrder": [ | ||
"title", | "title", | ||
| Line 232: | Line 261: | ||
} | } | ||
</templatedata> | </templatedata> | ||
| + | |||
| + | <includeonly>{{Sandbox other|| | ||
| + | <!-- Categories go here, and interwikis go in Wikidata --> | ||
| + | [[Category:Sailing infobox templates]] | ||
| + | }}</includeonly> | ||
Latest revision as of 21:10, 25 April 2020
| This is a documentation subpage for Template:Infobox sailing yacht. It contains usage information, categories and other content that is not part of the original template page. |
This infobox should italicize the article title automatically. If this is not required, add |italic title=no to the list of parameters. If this is required but the title is not being italicized, try |italic title=force. |
Usage
Template:Parameter names example
This template summarizes information about an individual racing yacht. For racing syndicates use {{Infobox Sailing team}}.
{{Infobox sailing yacht
| title =
| image =
| caption =
| othernames =
| club =
| nat =
| class =
| sailno =
| designer =
| builder =
| launched =
| owner =
| fate =
| skip =
| wins =
| ac_year =
| lv_year =
| cc_year =
| og_year =
| rr_year =
| type =
| displacement =
| length =
| beam =
| draft =
| height =
| sail =
| crew =
| notes =
}}
Parameters
This infobox takes a number of parameters, which are optional unless indicated otherwise:
TemplateData for Infobox sailing yacht
This template summarizes information about an individual racing yacht. For racing syndicates use {{tlx|Infobox Sailing team}}.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Title | title | The common name of the yacht which should preferably be the same as the article title. If the parameter is omitted, the article name is used. | String | optional |
| Image | image | An image to represent the yacht or logo of the team. | File | optional |
| Image size | image_size | no description | Unknown | optional |
| Alternate text | alt | no description | Unknown | optional |
| Caption | caption | A caption for the image. Terms in the caption can be wikilinked, if desired. | String | optional |
| Other names | othernames | Other names in the career of the yacht | String | optional |
| Yacht club | club | no description | String | optional |
| Nationality | nat | The nationality of registration | Unknown | optional |
| Competition class | class | no description | Unknown | optional |
| Sail number | sailno | no description
| String | optional |
| Boats | boats | no description | Unknown | optional |
| Designer | designer | The yacht's designer | Unknown | optional |
| Builder | builder | The yacht's boatbuilder | String | optional |
| Date launched | launched | no description
| Date | optional |
| Owner | owner | Team Principal or Owner | String | optional |
| Fate | fate | The fate of the boat | String | optional |
| Skipper/Helmsman | skip | no description | String | optional |
| Wins | wins | Major trophies such as LV Cups or America Cup wins | String | optional |
| Notable crew | notablecrew | Other notable crew members, like Tacticians or others with Wiki pages | Unknown | optional |
| America's Cup years | ac_year | The editions of America's Cup the yacht participated in | Unknown | optional |
| America's Cup Challenger Selections years | lc_year | The editions of America's Cup Challenger Selections Series (Louis Vuitton Cup, Herbert Pell Cup et cetera) the yacht participated in | Unknown | optional |
| America's Cup Defender Selections years | cc_year | The editions of America's Cup Defender Selections Series the yacht participated in | Unknown | optional |
| Olympics years | og_year | The editions of Summer Olympics the yacht participated in | Unknown | optional |
| Route du Rhum years | rr_year | The editions of Route du Rhum the yacht participated in | Unknown | optional |
| Displacement | displacement | Displacement of the boat. | Unknown | optional |
| Type | type | hull/rig type: sloop, cutter, schooner, catamaran, trimaran, etc.
| String | optional |
| Height | height | Height of the mast | Unknown | optional |
| Length | length | Length of the boats. Length overall (LOA), length at waterline (LWL) or both. | Unknown | optional |
| Beam | beam | Beam of the boat | Unknown | optional |
| Draft | draft | Draft of the boat | Unknown | optional |
| Sail area | sail | Total area of all sails | Unknown | optional |
| Crew number | crew | no description | Unknown | optional |
| Notes | notes | Any other notes about the boat | String | optional |