Template:Infobox instrument/doc

From Wikihussain
< Template:Infobox instrument
Revision as of 17:27, 11 September 2018 by fa>Yamaha5Bot (→‎Usage: endash)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Code

name
Example-serious.jpg
image caption
background
Other namesnames
Classification classification
Hornbostel–Sachs classificationhombostel_sachs
(hombostel_sachs_desc)
Inventor(s)inventors
Developeddeveloped
Timbretimbre
Volumevolume
Attackattack
Decaydecay
Playing range

range [music notation]

pitch ["low"/"medium"/"high"]
Related instruments
related
Musicians
musicians
Builders
builders
More articles
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               =
| 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
musicians - related musicians
builders - related musical instrument makers
articles - other articles which may be of interest

TemplateData

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

TemplateData for Infobox instrument

<templatedata> {

 "description": "An infobox for articles about musical instruments",
 "params": {
    "name": {
     "label": "Name",
     "description": "The name of the instrument",
     "type": "string",
     "required": false
    },
    "image": {
     "label": "Image",
     "description": "The file name for an image of the instrument",
     "type": "string",
     "required": false
   },
    "caption": {
     "label": "Caption",
     "description": "An description of the image",
     "type": "string",
     "required": false
   },
    "background": {
     "label": "Background",
     "description": "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",
     "type": "string",
     "required": false
   },
    "names": {
     "label": "Names",
     "description": "Alternative names for the instrument",
     "type": "string",
     "required": false
   },
    "classification": {
     "label": "Classification",
     "description": "The general classification of the instrument - Idiophone, Membranophone, Chordophone, Aerophone, Electrophone",
     "type": "string",
     "required": false
   },
    "hornbostel_sachs ": {
     "label": "Hornbostel-Sachs",
     "description": "The Hornbostel-Sachs number of the instrument ",
     "type": "string",
     "required": false
   },
    "hornbostel_sachs_desc ": {
     "label": "Hornbostel-Sachs Description",
     "description": "The name of the Hornbostel-Sachs subcategory of the instrument ",
     "type": "string",
     "required": false
   },
    "inventors": {
     "label": "Inventors",
     "description": "The inventor(s) of the instrument, if known",
     "type": "string",
     "required": false
   },
   
    "pitch": {
     "label": "Pitch",
     "description": "the playing range of the instrument, without image: 'low', 'medium', 'high'",
     "type": "string",
     "required": false
   },
    "related": {
     "label": "Related",
     "description": "related musical instruments",
     "type": "string",
     "required": false
   },
    "musicians": {
     "label": "Musicians",
     "description": "Notable musicians",
     "type": "string",
     "required": false
   },
    "builders": {
     "label": "Builders",
     "description": "Notable music instrument makers",
     "type": "string",
     "required": false
   },
   "developed": {
     "label": "Developed",
     "description": "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.)",
     "type": "string",
     "required": false
   },
    "timbre": {
     "label": "Timbre",
     "description": "The sound quality of the instrument",
     "type": "string",
     "required": false
   },
    "volume": {
     "label": "Volume",
     "description": "How loud the instrument is - 'low', 'medium', 'high'",
     "type": "string",
     "required": false
   },
    "attack": {
     "label": "Attack",
     "description": "how quickly the instrument begins making sound when it starts being played - 'slow', 'medium', 'fast'",
     "type": "string",
     "required": false
   },
    "decay": {
     "label": "Decay",
     "description": "how long the sound fades after the instrument stops being played: 'slow', 'medium', 'fast'",
     "type": "string",
     "required": false
   },
    "range": {
     "label": "Range",
     "description": "The playing range of the instrument (an image is preferred, many are already created, see commons:Category:Instrument ranges')",
     "type": "string",
     "required": false
   },
    "articles": {
     "label": "Articles",
     "description": "Other articles which may be of interest",
     "type": "string",
     "required": false
   }
 }

}</templatedata>

See also