Template:Infobox instrument/doc: Difference between revisions
No edit summary |
m (1 revision imported) |
Latest revision as of 14:50, 2 November 2021
This is a documentation subpage for Template:Infobox instrument. It contains usage information, categories and other content that is not part of the original template page. |
This template uses Lua: |
Code
background | |
---|---|
Other names | names |
Classification | classification |
Hornbostel–Sachs classification | hombostel_sachs (hombostel_sachs_desc) |
Inventor(s) | inventors |
Developed | developed |
Timbre | timbre |
Volume | volume |
Attack | attack |
Decay | decay |
Playing range | |
range [music notation] pitch ["low"/"medium"/"high"] | |
Related instruments | |
related | |
Musicians | |
musicians | |
Composers | |
composers | |
Builders | |
builders | |
Sound sample | |
sound sample | |
More articles or information | |
articles |
{{Infobox instrument | name = {{subst:PAGENAMEBASE}} | image = Replace this image butterfly.png | image_size = | alt = | caption = | background = | names = | classification = | hornbostel_sachs = | hornbostel_sachs_desc = | inventors = | developed = | timbre = | volume = | attack = | decay = | range = | pitch = | related = {{bulleted list|x|y}} | musicians = | builders = | articles = }}
Usage
This template, meant to be used on all musical instrument pages, takes the following parameters (bold parameters are required, others are optional):
name | – full name of the instrument - using WikiProject Musical Instruments/Templates/Infobox instrument/doc will set this field to the name of the article |
image | – the filename of a photo of the instrument |
caption | - a caption for the photo of the instrument |
background | – the general classification of the instrument ('keyboard', 'woodwind', 'brass', 'string', 'percussion', 'electronic', or 'other') used to choose the color scheme of the infobox and populate a simple classification link-header below the image caption |
names | – other name/names |
classification | – the classification of the instrument (such as string, woodwind, etc.) |
hornbostel_sachs | - the Hornbostel–Sachs classification of the instrument (or 'NaN', if not specified, such as for the Hydraulophone) |
hornbostel_sachs_desc | - a textual description of the Hornbostel–Sachs classification |
inventors | - the inventor(s) of the instrument, if known |
developed | - the rough time period (and instrument from which) the instrument was developed (e.g. "Early 16th century" for the violin, "Early 18th century from the chalumeau" for the clarinet, etc.) |
timbre | - the sound quality of the instrument |
volume | - how loud the instrument is: "low", "medium", "high" |
attack | - how quickly the instrument begins making sound when it starts being played: "slow", "medium", "fast" |
decay | - how long the sound fades after the instrument stops being played: "slow", "medium", "fast" |
range | - the playing range of the instrument (an image is preferred; many are already created, see commons:Category:Instrument ranges) |
pitch | - the playing range of the instrument, without image: "low", "medium", "high" |
related | - related musical instruments. Use {{bulleted list}} to list multiple instruments. |
musicians | - related musicians. Use {{bulleted list}} to list multiple musicians. |
composers | - related composers. |
builders | - related musical instrument makers. Use {{bulleted list}} to list multiple makers. |
sound sample | - related sample. |
articles | - more information or other articles which may be of interest. Use {{bulleted list}} to list multiple articles. |
TemplateData
TemplateData for Infobox instrument
An infobox for articles about musical instruments
Parameter | Description | Type | Status | |
---|---|---|---|---|
Name | name | The name of the instrument | String | optional |
Image | image | The file name for an image of the instrument | String | optional |
Caption | caption | An description of the image | String | optional |
Background | background | The general classification of the instrument ('keyboard', 'woodwind', 'brass', 'string', 'percussion', 'electronic', or 'other') used to choose the color scheme of the infobox and populate a simple classification link-header below the image caption | String | optional |
Names | names | Alternative names for the instrument | String | optional |
Classification | classification | The general classification of the instrument - Idiophone, Membranophone, Chordophone, Aerophone, Electrophone | String | optional |
Hornbostel-Sachs | hornbostel_sachs | The Hornbostel-Sachs number of the instrument | String | optional |
Hornbostel-Sachs Description | hornbostel_sachs_desc | The name of the Hornbostel-Sachs subcategory of the instrument | String | optional |
Inventors | inventors | The inventor(s) of the instrument, if known | String | optional |
Pitch | pitch | the playing range of the instrument, without image: 'low', 'medium', 'high' | String | optional |
Related | related | related musical instruments | String | optional |
Musicians | musicians | Notable musicians | String | optional |
Composers | composers | Notable composers | String | optional |
Builders | builders | Notable music instrument makers | String | optional |
Sound sample | sound sample | Notable sample | String | optional |
Developed | developed | the rough time period (and instrument from which) the instrument was developed (e.g. 'Early 16th century' for the violin, 'Early 18th century from the chalumeau' for the clarinet, etc.) | String | optional |
Timbre | timbre | The sound quality of the instrument | String | optional |
Volume | volume | How loud the instrument is - 'low', 'medium', 'high' | String | optional |
Attack | attack | how quickly the instrument begins making sound when it starts being played - 'slow', 'medium', 'fast' | String | optional |
Decay | decay | how long the sound fades after the instrument stops being played: 'slow', 'medium', 'fast' | String | optional |
Range | range | The playing range of the instrument (an image is preferred, many are already created, see [[commons:Category:Instrument ranges]]') | String | optional |
Articles | articles | Other articles which may be of interest or more information | String | optional |
See also