Template:Infobox hard drive/doc: Difference between revisions
No edit summary |
Add TemplateData |
||
| Line 74: | Line 74: | ||
}} | }} | ||
</pre> | </pre> | ||
==TemplateData== | |||
<templatedata> | |||
{ | |||
"params": { | |||
"capacity": { | |||
"label": "Capacity", | |||
"description": "The total capacity of the hard drive model. Do not include units, and do not use binary capacities (such as 236 instead of 256).", | |||
"example": "500", | |||
"type": "number", | |||
"suggested": true | |||
}, | |||
"capacity_unit": { | |||
"label": "Capacity unit acronym", | |||
"description": "The two letter acronym for the capacity's unit. Case insensitive. Do not use binary units.", | |||
"example": "gb", | |||
"type": "string", | |||
"required": true | |||
}, | |||
"recording_method": { | |||
"label": "Recording method", | |||
"description": "The three, four or similar acronym for the recording. Case insensitive.", | |||
"example": "cmr", | |||
"type": "string", | |||
"suggested": true | |||
}, | |||
"manufacturer": { | |||
"label": "Manufacturer", | |||
"description": "The company who manufactures or manufactured this hard drive model.", | |||
"example": "[[Western Digital]]", | |||
"type": "wiki-page-name", | |||
"required": true | |||
}, | |||
"image1": { | |||
"label": "Image 1", | |||
"description": "File name for the first image on the infobox.", | |||
"example": "TOSHIBA HDWJ110.jpg", | |||
"type": "wiki-file-name", | |||
"suggested": true | |||
}, | |||
"caption1": { | |||
"label": "Image caption 1", | |||
"description": "An image caption to accompany image 1. Also acts as alt text if not explicity provided.", | |||
"example": "Top down view of the hard drive.", | |||
"type": "content", | |||
"suggested": true | |||
}, | |||
"image_2": { | |||
"label": "Image 2", | |||
"description": "File name for the second image on the infobox.", | |||
"example": "Toshiba HDWJ110 SMART printout.png", | |||
"type": "wiki-file-name" | |||
}, | |||
"caption2": { | |||
"label": "Image caption 2", | |||
"description": "An image caption to accompany image 2. Also acts as alt text if not explicitly provided.", | |||
"type": "content" | |||
}, | |||
"platters": { | |||
"label": "Platter count", | |||
"description": "Number of known platters in a hard drive model.", | |||
"example": "7", | |||
"type": "number", | |||
"suggested": true | |||
}, | |||
"heads": { | |||
"label": "Recording head count", | |||
"description": "Number of recording heads in a hard drive model.", | |||
"example": "14", | |||
"type": "number", | |||
"suggested": true | |||
}, | |||
"mttf": { | |||
"label": "Mean time to failure", | |||
"description": "Mean time to failure published by the manufacturer. Do not use crowd-sourced information such as ST3000DM001s all failing at low hour numbers.", | |||
"example": "600,000 hours", | |||
"type": "number", | |||
"default": "Not specified" | |||
}, | |||
"max_load_cycles": { | |||
"label": "Maximum load/unload cycles", | |||
"description": "Maximum load/unload cycle count published by the manufacture. Specify \"N/A\" if this is a contact start-stop HDD.", | |||
"example": "600,000", | |||
"type": "number", | |||
"suggested": true | |||
}, | |||
"unrecoverable_error_rate": { | |||
"label": "Unrecoverable error rate", | |||
"description": "Unrecoverable error rate specified by the manufacturer. Use math when possible.", | |||
"type": "content", | |||
"suggested": true, | |||
"example": "<math>1</math> in <math>10^14</math>", | |||
"autovalue": "<math>1</math> in <math>10^14</math>" | |||
}, | |||
"interface": { | |||
"label": "Interface", | |||
"description": "The acronym for the interface in use (pata, sata, scsi, sas). Case insensitive.", | |||
"example": "sata", | |||
"type": "string", | |||
"suggested": true | |||
}, | |||
"interface_version": { | |||
"label": "Interface version", | |||
"description": "The version of the interface in use, and its speed.", | |||
"example": "SATA 3.3 (600 MB/s)", | |||
"type": "string", | |||
"suggested": true | |||
}, | |||
"command_set": { | |||
"label": "Command set", | |||
"description": "The command set used for interfacing with the drive.", | |||
"example": "ACS-3 Revision 5", | |||
"type": "string" | |||
}, | |||
"form_factor": { | |||
"label": "Form factor", | |||
"description": "The form factor of the hard drive model, expressed in inches (as in, 3.5\").", | |||
"example": "3.5\"", | |||
"required": true | |||
}, | |||
"family": { | |||
"label": "Product family", | |||
"description": "The product family the hard drive model belongs to.", | |||
"example": "[[Toshiba P300]]", | |||
"type": "wiki-page-name", | |||
"suggested": true | |||
}, | |||
"cache": { | |||
"label": "Cache", | |||
"description": "The amount of cache RAM the hard drive contains.", | |||
"example": "64", | |||
"type": "number", | |||
"suggested": true | |||
}, | |||
"cache_unit": { | |||
"label": "Cache unit acronym", | |||
"description": "The two letter acronym for the cache capacity's unit. Case insensitive. Do not use binary units.", | |||
"example": "mb", | |||
"suggested": true | |||
}, | |||
"capacity_per_platter": { | |||
"label": "Capacity per platter", | |||
"description": "The amount of capacity stored on each platter.", | |||
"example": "1.43", | |||
"suggested": true | |||
}, | |||
"capacity_per_platter_unit": { | |||
"label": "Capacity per platter unit acronym", | |||
"description": "The two letter acronym for the capacity's unit. Case insensitive. Do not use binary units.", | |||
"example": "tb", | |||
"type": "string", | |||
"suggested": true | |||
}, | |||
"speed": { | |||
"label": "Rotation speed", | |||
"description": "The speed that the hard drive platters rotate at.", | |||
"example": " 5,400", | |||
"suggested": true | |||
}, | |||
"apm": { | |||
"label": "APM?", | |||
"description": "Whether the hard drive supports Advanced Power Management (APM).", | |||
"example": "Yes", | |||
"type": "string", | |||
"suggested": true | |||
}, | |||
"ncq": { | |||
"label": "NCQ?", | |||
"description": "Whether the hard drive supports Native Command Queing (NCQ).", | |||
"example": "Yes", | |||
"type": "string", | |||
"required": true | |||
}, | |||
"aam": { | |||
"label": "AAM?", | |||
"description": "Whether the hard drive supports Automatic Acoustic Management (AAM).", | |||
"example": "No", | |||
"suggested": true | |||
}, | |||
"trim": { | |||
"label": "TRIM?", | |||
"description": "Whether the hard drive supports the TRIM command. Only specify \"No\" if the drive is SMR; leave blank otherwise.", | |||
"example": "Yes", | |||
"type": "string" | |||
}, | |||
"scterc": { | |||
"label": "SCTERC defaults", | |||
"description": "The default settings for SCTERC.", | |||
"example": "Read: Disabled<br>Write: Disabled", | |||
"type": "string", | |||
"suggested": true | |||
}, | |||
"af": { | |||
"label": "Advanced Format status", | |||
"description": "Whether the hard drive supports Advanced Format, and if so, what type it supports (512e, or 4Kn)", | |||
"example": "No", | |||
"type": "string", | |||
"suggested": true | |||
}, | |||
"released": { | |||
"label": "Date released", | |||
"description": "The year (add more precision if desired) the hard drive model was released.", | |||
"example": "2012", | |||
"type": "number", | |||
"suggested": true | |||
}, | |||
"discontinued": { | |||
"label": "Date discontinued", | |||
"description": "The date the model was discontinued.", | |||
"example": "2017", | |||
"type": "number" | |||
}, | |||
"max_transfer": { | |||
"label": "Maximum transfer rate", | |||
"description": "The maximum specified transfer rate, in MB/s.", | |||
"example": "180", | |||
"type": "number", | |||
"suggested": true | |||
}, | |||
"platform": { | |||
"label": "Platform/Drive family", | |||
"description": "The platform name (such as a WD Marvel family).", | |||
"example": "Diablo3s", | |||
"type": "string" | |||
}, | |||
"z-height": { | |||
"label": "z-height", | |||
"description": "The total z-height of the drive in millimetres. Most useful for 2.5\"s, most 3.5\"s are 26.1.", | |||
"example": "9.5", | |||
"type": "number", | |||
"suggested": true | |||
} | |||
}, | |||
"description": "Displays information on hard drive models.", | |||
"format": "block", | |||
"paramOrder": [ | |||
"image1", | |||
"caption1", | |||
"image_2", | |||
"caption2", | |||
"manufacturer", | |||
"family", | |||
"platform", | |||
"form_factor", | |||
"z-height", | |||
"capacity", | |||
"capacity_unit", | |||
"speed", | |||
"cache", | |||
"cache_unit", | |||
"af", | |||
"max_transfer", | |||
"interface", | |||
"interface_version", | |||
"command_set", | |||
"apm", | |||
"ncq", | |||
"aam", | |||
"trim", | |||
"scterc", | |||
"platters", | |||
"heads", | |||
"capacity_per_platter", | |||
"capacity_per_platter_unit", | |||
"recording_method", | |||
"mttf", | |||
"max_load_cycles", | |||
"unrecoverable_error_rate", | |||
"released", | |||
"discontinued" | |||
] | |||
} | |||
</templatedata> | |||
<includeonly>[[Category:Infoboxes]]</includeonly> | <includeonly>[[Category:Infoboxes]]</includeonly> | ||
Revision as of 08:46, 27 March 2021
This infobox is designed for hard drive model articles.
Examples
This infobox is generated using the following code:
{{infobox hard drive
|image1 = Toshiba HDWD240 top-down view.jpg
|caption1 = Top-down view of a HDWD240.
|image2 = File:Toshiba HDWD240 CDI SMART printout.png
|caption2 = CrystalDiskInfo printout of SMART attributes.
|manufacturer = [[Toshiba]]
|family = [[Toshiba P300]]/[[Toshiba DT02]]
|form_factor = 3.5"
|z-height = 26.1 mm
|speed = 5,400
|capacity = 4
|capacity_unit = tb
|af = 512e
|max_transfer = 176.4 (from DT02ABA400)
|ncq = Yes
|apm = Yes
|aam = Yes
|trim = No
|scterc = Read: Disabled<br>Write: Disabled
|interface = SATA
|interface_version = SATA 3.3 (600 MB/s)
|command_set = ACS-3 Revision 5
|platters = 2
|heads = 4
|capacity_per_platter = 2
|capacity_per_platter_unit = tb
|recording_method = smr
|cache = 128
|cache_unit = mb
|mttf = None
|max_load_cycles = 600,000
|unrecoverable_error_rate = <math>1</math> in <math>10^{14}</math>
|released = 2019
}}
TemplateData
Displays information on hard drive models.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Image 1 | image1 | File name for the first image on the infobox.
| File | suggested |
| Image caption 1 | caption1 | An image caption to accompany image 1. Also acts as alt text if not explicity provided.
| Content | suggested |
| Image 2 | image_2 | File name for the second image on the infobox.
| File | optional |
| Image caption 2 | caption2 | An image caption to accompany image 2. Also acts as alt text if not explicitly provided. | Content | optional |
| Manufacturer | manufacturer | The company who manufactures or manufactured this hard drive model.
| Page name | required |
| Product family | family | The product family the hard drive model belongs to.
| Page name | suggested |
| Platform/Drive family | platform | The platform name (such as a WD Marvel family).
| String | optional |
| Form factor | form_factor | The form factor of the hard drive model, expressed in inches (as in, 3.5").
| Unknown | required |
| z-height | z-height | The total z-height of the drive in millimetres. Most useful for 2.5"s, most 3.5"s are 26.1.
| Number | suggested |
| Capacity | capacity | The total capacity of the hard drive model. Do not include units, and do not use binary capacities (such as 236 instead of 256).
| Number | suggested |
| Capacity unit acronym | capacity_unit | The two letter acronym for the capacity's unit. Case insensitive. Do not use binary units.
| String | required |
| Rotation speed | speed | The speed that the hard drive platters rotate at.
| Unknown | suggested |
| Cache | cache | The amount of cache RAM the hard drive contains.
| Number | suggested |
| Cache unit acronym | cache_unit | The two letter acronym for the cache capacity's unit. Case insensitive. Do not use binary units.
| Unknown | suggested |
| Advanced Format status | af | Whether the hard drive supports Advanced Format, and if so, what type it supports (512e, or 4Kn)
| String | suggested |
| Maximum transfer rate | max_transfer | The maximum specified transfer rate, in MB/s.
| Number | suggested |
| Interface | interface | The acronym for the interface in use (pata, sata, scsi, sas). Case insensitive.
| String | suggested |
| Interface version | interface_version | The version of the interface in use, and its speed.
| String | suggested |
| Command set | command_set | The command set used for interfacing with the drive.
| String | optional |
| APM? | apm | Whether the hard drive supports Advanced Power Management (APM).
| String | suggested |
| NCQ? | ncq | Whether the hard drive supports Native Command Queing (NCQ).
| String | required |
| AAM? | aam | Whether the hard drive supports Automatic Acoustic Management (AAM).
| Unknown | suggested |
| TRIM? | trim | Whether the hard drive supports the TRIM command. Only specify "No" if the drive is SMR; leave blank otherwise.
| String | optional |
| SCTERC defaults | scterc | The default settings for SCTERC.
| String | suggested |
| Platter count | platters | Number of known platters in a hard drive model.
| Number | suggested |
| Recording head count | heads | Number of recording heads in a hard drive model.
| Number | suggested |
| Capacity per platter | capacity_per_platter | The amount of capacity stored on each platter.
| Unknown | suggested |
| Capacity per platter unit acronym | capacity_per_platter_unit | The two letter acronym for the capacity's unit. Case insensitive. Do not use binary units.
| String | suggested |
| Recording method | recording_method | The three, four or similar acronym for the recording. Case insensitive.
| String | suggested |
| Mean time to failure | mttf | Mean time to failure published by the manufacturer. Do not use crowd-sourced information such as ST3000DM001s all failing at low hour numbers.
| Number | optional |
| Maximum load/unload cycles | max_load_cycles | Maximum load/unload cycle count published by the manufacture. Specify "N/A" if this is a contact start-stop HDD.
| Number | suggested |
| Unrecoverable error rate | unrecoverable_error_rate | Unrecoverable error rate specified by the manufacturer. Use math when possible.
| Content | suggested |
| Date released | released | The year (add more precision if desired) the hard drive model was released.
| Number | suggested |
| Date discontinued | discontinued | The date the model was discontinued.
| Number | optional |