Difference between revisions of "Template:Infobox sailing yacht/doc"

From blackwiki
Jump to navigation Jump to search
imported>Yachty4000
imported>Hashar
(Migrate to template data)
Line 75: Line 75:
 
==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:
 
;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.
 
 
;image
 
:An image to represent the yacht or logo of the team.
 
 
;caption
 
:A caption for the image. Terms in the caption can be wikilinked, if desired.
 
 
;othernames
 
:other names in the career of the yacht
 
 
;club
 
:The yacht club
 
 
;nat
 
:The nationality of registration
 
 
;class
 
:Competition class
 
 
;sailno
 
:sail number, e.g. US–74
 
 
;designer
 
:The yacht's designer
 
 
;builder
 
:The yacht's boatbuilder
 
 
;launched
 
:The date launched
 
 
;owner
 
:Team Principal or Owner
 
 
;fate
 
:The fate of the boat.
 
 
;skip
 
:Skipper/Helmsman
 
 
;notablecrew
 
:other notable crew members, like Tacticians or others with Wiki pages
 
 
;wins
 
:major trophies such as LV Cups or America Cup wins
 
 
;ac_year
 
:The editions of America's Cup the yacht participated in
 
 
;lv_year
 
:The editions of America's Cup Challenger Selections Series (Louis Vuitton Cup, Herbert Pell Cup et cetera) the yacht participated in
 
 
;cc_year
 
:The editions of America's Cup Defender Selections Series the yacht participated in
 
 
;og_year
 
:The editions of Summer Olympics the yacht participated in
 
 
;rr_year
 
:The editions of Route du Rhum the yacht participated in
 
 
;type
 
:hull/rig type: sloop, cutter, schooner, catamaran, trimaran, etc.
 
 
;displacement
 
:displacement of the boat.
 
 
;length
 
:length of the boats. Length overall (LOA), length at waterline (LWL) or both.
 
 
;beam
 
:beam of the boat.
 
 
;draft
 
:draft of the boat.
 
 
;height
 
:height of the mast
 
 
;sail
 
:Total area of all sails.
 
 
;crew
 
:crew number
 
 
;notes
 
:Any other notes about the boat.
 
 
  
 
<includeonly>
 
<includeonly>
Line 171: Line 80:
 
[[Category:Sailing infobox templates]]
 
[[Category:Sailing infobox templates]]
 
</includeonly>
 
</includeonly>
 +
<templatedata>
 +
{
 +
"params": {
 +
"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.",
 +
"type": "string"
 +
},
 +
"image": {
 +
"description": "An image to represent the yacht or logo of the team.",
 +
"type": "wiki-file-name"
 +
},
 +
"image_size": {},
 +
"alt": {},
 +
"caption": {
 +
"description": "A caption for the image. Terms in the caption can be wikilinked, if desired.",
 +
"type": "string"
 +
},
 +
"othernames": {
 +
"description": "Other names in the career of the yacht",
 +
"type": "string"
 +
},
 +
"club": {
 +
"description": "The yacht club",
 +
"type": "string"
 +
},
 +
"nat": {
 +
"description": "The nationality of registration"
 +
},
 +
"class": {
 +
"description": "Competition class"
 +
},
 +
"sailno": {
 +
"description": "Sail number",
 +
"example": "US–74",
 +
"type": "string"
 +
},
 +
"boats": {},
 +
"designer": {
 +
"description": "The yacht's designer"
 +
},
 +
"builder": {
 +
"description": "The yacht's boatbuilder",
 +
"type": "string"
 +
},
 +
"launched": {
 +
"description": "Date launched",
 +
"example": "1993",
 +
"type": "date"
 +
},
 +
"owner": {
 +
"description": "Team Principal or Owner",
 +
"type": "string"
 +
},
 +
"fate": {
 +
"description": "The fate of the boat",
 +
"type": "string"
 +
},
 +
"skip": {
 +
"description": "Skipper/Helmsman",
 +
"type": "string"
 +
},
 +
"wins": {
 +
"description": "Major trophies such as LV Cups or America Cup wins",
 +
"type": "string"
 +
},
 +
"ac_year": {
 +
"description": "The editions of America's Cup the yacht participated in"
 +
},
 +
"lc_year": {
 +
"description": "The editions of America's Cup Challenger Selections Series (Louis Vuitton Cup, Herbert Pell Cup et cetera) the yacht participated in"
 +
},
 +
"cc_year": {
 +
"description": "The editions of America's Cup Defender Selections Series the yacht participated in"
 +
},
 +
"og_year": {
 +
"description": "The editions of Summer Olympics the yacht participated in"
 +
},
 +
"notablecrew": {
 +
"description": "other notable crew members, like Tacticians or others with Wiki pages"
 +
},
 +
"rr_year": {
 +
"description": "The editions of Route du Rhum the yacht participated in"
 +
},
 +
"displacement": {
 +
"description": "Displacement of the boat."
 +
},
 +
"type": {
 +
"description": "hull/rig type: sloop, cutter, schooner, catamaran, trimaran, etc.",
 +
"example": "catamaran",
 +
"type": "string"
 +
},
 +
"height": {
 +
"description": "Height of the mast"
 +
},
 +
"length": {
 +
"description": "Length of the boats. Length overall (LOA), length at waterline (LWL) or both."
 +
},
 +
"beam": {
 +
"description": "Beam of the boat"
 +
},
 +
"draft": {
 +
"description": "Draft of the boat"
 +
},
 +
"sail": {
 +
"description": "Total area of all sails"
 +
},
 +
"crew": {
 +
"description": "Crew number"
 +
},
 +
"notes": {
 +
"description": "Any other notes about the boat",
 +
"type": "string"
 +
}
 +
},
 +
"description": "This template summarizes information about an individual racing yacht. For racing syndicates use {{tlx|Infobox Sailing team}}.",
 +
"paramOrder": [
 +
"title",
 +
"image",
 +
"image_size",
 +
"alt",
 +
"caption",
 +
"othernames",
 +
"club",
 +
"nat",
 +
"class",
 +
"sailno",
 +
"boats",
 +
"designer",
 +
"builder",
 +
"launched",
 +
"owner",
 +
"fate",
 +
"skip",
 +
"wins",
 +
"notablecrew",
 +
"ac_year",
 +
"lc_year",
 +
"cc_year",
 +
"og_year",
 +
"rr_year",
 +
"displacement",
 +
"type",
 +
"height",
 +
"length",
 +
"beam",
 +
"draft",
 +
"sail",
 +
"crew",
 +
"notes"
 +
]
 +
}
 +
</templatedata>

Revision as of 22:36, 5 December 2016

Usage

{{{title}}}
[[File:{{{image}}}|{{{image_size}}}|alt={{{alt}}}|upright=1|{{{alt}}}]]
{{{caption}}}
Other names{{{othernames}}}
Yacht club{{{club}}}
Nation{{{nat}}}
Class{{{class}}}
Sail no{{{sailno}}}{{{boats}}}
Designer(s){{{designer}}}
Builder{{{builder}}}
Launched{{{launched}}}
Owner(s){{{owner}}}
Fate{{{fate}}}
Racing career
Skippers{{{skip}}}
Crew members{{{notablecrew}}}
Notable victories{{{wins}}}
America's Cup{{{ac_year}}}
AC Challenger
Selection Series
{{{lc_year}}}
AC Defender
Selection Series
{{{cc_year}}}
Olympics{{{og_year}}}
Route du Rhum{{{rr_year}}}
Specifications
Type{{{type}}}
Displacement{{{displacement}}}
Length{{{length}}}
Beam{{{beam}}}
Draft{{{draft}}}
Mast height{{{height}}}
Sail area{{{sail}}}
Crew{{{crew}}}
Notes
{{{notes}}}

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:


This template summarizes information about an individual racing yacht. For racing syndicates use {{tlx|Infobox Sailing team}}.

Template parameters

ParameterDescriptionTypeStatus
Titletitle

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.

Stringoptional
Imageimage

An image to represent the yacht or logo of the team.

Fileoptional
Image_sizeimage_size

no description

Unknownoptional
Altalt

no description

Unknownoptional
Captioncaption

A caption for the image. Terms in the caption can be wikilinked, if desired.

Stringoptional
Othernamesothernames

Other names in the career of the yacht

Stringoptional
Clubclub

The yacht club

Stringoptional
Natnat

The nationality of registration

Unknownoptional
Classclass

Competition class

Unknownoptional
Sailnosailno

Sail number

Example
US–74
Stringoptional
Boatsboats

no description

Unknownoptional
Designerdesigner

The yacht's designer

Unknownoptional
Builderbuilder

The yacht's boatbuilder

Stringoptional
Launchedlaunched

Date launched

Example
1993
Dateoptional
Ownerowner

Team Principal or Owner

Stringoptional
Fatefate

The fate of the boat

Stringoptional
Skipskip

Skipper/Helmsman

Stringoptional
Winswins

Major trophies such as LV Cups or America Cup wins

Stringoptional
Notablecrewnotablecrew

other notable crew members, like Tacticians or others with Wiki pages

Unknownoptional
Ac_yearac_year

The editions of America's Cup the yacht participated in

Unknownoptional
Lc_yearlc_year

The editions of America's Cup Challenger Selections Series (Louis Vuitton Cup, Herbert Pell Cup et cetera) the yacht participated in

Unknownoptional
Cc_yearcc_year

The editions of America's Cup Defender Selections Series the yacht participated in

Unknownoptional
Og_yearog_year

The editions of Summer Olympics the yacht participated in

Unknownoptional
Rr_yearrr_year

The editions of Route du Rhum the yacht participated in

Unknownoptional
Displacementdisplacement

Displacement of the boat.

Unknownoptional
Typetype

hull/rig type: sloop, cutter, schooner, catamaran, trimaran, etc.

Example
catamaran
Stringoptional
Heightheight

Height of the mast

Unknownoptional
Lengthlength

Length of the boats. Length overall (LOA), length at waterline (LWL) or both.

Unknownoptional
Beambeam

Beam of the boat

Unknownoptional
Draftdraft

Draft of the boat

Unknownoptional
Sailsail

Total area of all sails

Unknownoptional
Crewcrew

Crew number

Unknownoptional
Notesnotes

Any other notes about the boat

Stringoptional