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

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.

40x40px 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:

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for Infobox sailing yacht

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

Template parameters
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 Example US–74	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 Example 1993	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. Example catamaran	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

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

Latest revision as of 21:10, 25 April 2020

Usage

Parameters

Navigation menu

Personal tools

Namespaces

Variants

Views

More

Search

Navigation

Tools

@@ Line 1: / Line 1: @@
 {{Documentation subpage}}
 {{Auto italic title}}
 ==Usage==
-{{Infobox sailing yacht
+{{Parameter names example
 | italic title = no
-| title = {{{title}}}
+| title
-| image = {{{image}}}
+| image
-| image_size = {{{image_size}}}
+| image_size
-| alt = {{{alt}}}
+| alt
-| caption = {{{caption}}}
+| caption
-| othernames = {{{othernames}}}
+| othernames
-| club = {{{club}}}
+| club
-| nat = {{{nat}}}
+| nat
-| class = {{{class}}}
+| class
-| sailno = {{{sailno}}}
+| sailno
-| boats = {{{boats}}}
+| boats
-| designer = {{{designer}}}
+| designer
-| builder = {{{builder}}}
+| builder
-| launched = {{{launched}}}
+| launched
-| owner = {{{owner}}}
+| owner
-| fate = {{{fate}}}
+| fate
-| skip = {{{skip}}}
+| skip
-| wins = {{{wins}}}
+| wins
-| ac_year = {{{ac_year}}}
+| ac_year
-| lc_year = {{{lc_year}}}
+| lc_year
-| cc_year = {{{cc_year}}}
+| cc_year
-| og_year = {{{og_year}}}
+| og_year
-| notablecrew = {{{notablecrew}}}
+| notablecrew
-| rr_year = {{{rr_year}}}
+| rr_year
-| displacement = {{{displacement}}}
+| displacement
-| type = {{{type}}}
+| type
-| height = {{{height}}}
+| height
-| length = {{{length}}}
+| length
-| beam = {{{beam}}}
+| beam
-| draft = {{{draft}}}
+| draft
-| sail = {{{sail}}}
+| sail
-| crew = {{{crew}}}
+| crew
-| notes = {{{notes}}}
+| notes
 }}
 This template summarizes information about an individual racing yacht. For racing syndicates use {{tlx|Infobox Sailing team}}.
 <pre style="overflow:auto">
@@ Line 72: / Line 74: @@
 }}
 </pre>
+{{clear}}
 ==Parameters==
 This infobox takes a number of parameters, which are optional unless indicated otherwise:
+{{TemplateData header}}
+<templatedata>
+{
+	"description": "This template summarizes information about an individual racing yacht. For racing syndicates use {{tlx|Infobox Sailing team}}.",
+	"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",
+			"label": "Title"
+		},
+		"image": {
+			"description": "An image to represent the yacht or logo of the team.",
+			"type": "wiki-file-name",
+			"label": "Image"
+		},
+		"image_size": {
+			"label": "Image size"
+		},
+		"alt": {
+			"label": "Alternate text"
+		},
+		"caption": {
+			"description": "A caption for the image. Terms in the caption can be wikilinked, if desired.",
+			"type": "string",
+			"label": "Caption"
+		},
+		"othernames": {
+			"description": "Other names in the career of the yacht",
+			"type": "string",
+			"label": "Other names"
+		},
+		"club": {
+			"type": "string",
+			"label": "Yacht club"
+		},
+		"nat": {
+			"description": "The nationality of registration",
+			"label": "Nationality"
+		},
+		"class": {
+			"label": "Competition class"
+		},
+		"sailno": {
+			"example": "US–74",
+			"type": "string",
+			"label": "Sail number"
+		},
+		"boats": {
+			"label": "Boats"
+		},
+		"designer": {
+			"description": "The yacht's designer",
+			"label": "Designer"
+		},
+		"builder": {
+			"description": "The yacht's boatbuilder",
+			"type": "string",
+			"label": "Builder"
+		},
+		"launched": {
+			"example": "1993",
+			"type": "date",
+			"label": "Date launched"
+		},
+		"owner": {
+			"description": "Team Principal or Owner",
+			"type": "string",
+			"label": "Owner"
+		},
+		"fate": {
+			"description": "The fate of the boat",
+			"type": "string",
+			"label": "Fate"
+		},
+		"skip": {
+			"type": "string",
+			"label": "Skipper/Helmsman"
+		},
+		"wins": {
+			"description": "Major trophies such as LV Cups or America Cup wins",
+			"type": "string",
+			"label": "Wins"
+		},
+		"ac_year": {
+			"description": "The editions of America's Cup the yacht participated in",
+			"label": "America's Cup years"
+		},
+		"lc_year": {
+			"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": {
+			"description": "The editions of America's Cup Defender Selections Series the yacht participated in",
+			"label": "America's Cup Defender Selections years"
+		},
+		"og_year": {
+			"description": "The editions of Summer Olympics the yacht participated in",
+			"label": "Olympics years"
+		},
+		"notablecrew": {
+			"description": "Other notable crew members, like Tacticians or others with Wiki pages",
+			"label": "Notable crew"
+		},
+		"rr_year": {
+			"description": "The editions of Route du Rhum the yacht participated in",
+			"label": "Route du Rhum years"
+		},
+		"displacement": {
+			"description": "Displacement of the boat.",
+			"label": "Displacement"
+		},
+		"type": {
+			"description": "hull/rig type: sloop, cutter, schooner, catamaran, trimaran, etc.",
+			"example": "catamaran",
+			"type": "string",
+			"label": "Type"
+		},
+		"height": {
+			"description": "Height of the mast",
+			"label": "Height"
+		},
+		"length": {
+			"description": "Length of the boats. Length overall (LOA), length at waterline (LWL) or both.",
+			"label": "Length"
+		},
+		"beam": {
+			"description": "Beam of the boat",
+			"label": "Beam"
+		},
+		"draft": {
+			"description": "Draft of the boat",
+			"label": "Draft"
+		},
+		"sail": {
+			"description": "Total area of all sails",
+			"label": "Sail area"
+		},
+		"crew": {
+			"label": "Crew number"
+		},
+		"notes": {
+			"description": "Any other notes about the boat",
+			"type": "string",
+			"label": "Notes"
+		}
+	},
+	"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>
-;title
+<includeonly>{{Sandbox other||
-: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>
 <!-- Categories go here, and interwikis go in Wikidata -->
 [[Category:Sailing infobox templates]]
-</includeonly>
+}}</includeonly>