Difference between revisions of "Template:Infobox computer hardware/doc"

From blackwiki
Jump to navigation Jump to search
(Fix parameters name example typo: logo-caption -> logo caption)
imported>Funandtrvl
(fix code)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE -->
+
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[</nowiki>[[Wikipedia:Wikidata]]<nowiki>]]) -->
  
 
This is for generic pieces of computer hardware that don't have more specific infoboxes, such as hard drives, motherboards, CD-ROMs etc. It should not be used for hardware such as CPUs that have their own specific infoboxes. External hardware should not use this box either.
 
This is for generic pieces of computer hardware that don't have more specific infoboxes, such as hard drives, motherboards, CD-ROMs etc. It should not be used for hardware such as CPUs that have their own specific infoboxes. External hardware should not use this box either.
  
 +
==Usage==
 
{{Parameter names example|name|logo|logo caption|logo-size|image|image-size|caption|invent-date|invent-name|conn1|via1_1|via1_2|via1_3|via1_4|via1_5|via1_6|via1_7|via1_8|via1_9|conn2|via2_1|via2_2|via2_3|via2_4|via2_5|via2_6|via2_7|via2_8|via2_9|conn3|via3_1|via3_2|via3_3|via3_4|via3_5|via3_6|via3_7|via3_8|via3_9|conn4|via4_1|via4_2|via4_3|via4_4|via4_5|via4_6|via4_7|via4_8|via4_9|class1|class-name|class2|class3|class4|class5|class6|manuf1|manuf2|manuf3|manuf4|manuf5|manuf6|manuf7|designfirm|manufacturer|introduced|discontinued|cost|type|processor|frequency|memory|coprocessor|connection|ports|power|weight|dimensions|rom|slots|color|dpi|speed|language}}
 
{{Parameter names example|name|logo|logo caption|logo-size|image|image-size|caption|invent-date|invent-name|conn1|via1_1|via1_2|via1_3|via1_4|via1_5|via1_6|via1_7|via1_8|via1_9|conn2|via2_1|via2_2|via2_3|via2_4|via2_5|via2_6|via2_7|via2_8|via2_9|conn3|via3_1|via3_2|via3_3|via3_4|via3_5|via3_6|via3_7|via3_8|via3_9|conn4|via4_1|via4_2|via4_3|via4_4|via4_5|via4_6|via4_7|via4_8|via4_9|class1|class-name|class2|class3|class4|class5|class6|manuf1|manuf2|manuf3|manuf4|manuf5|manuf6|manuf7|designfirm|manufacturer|introduced|discontinued|cost|type|processor|frequency|memory|coprocessor|connection|ports|power|weight|dimensions|rom|slots|color|dpi|speed|language}}
 
<pre style="overflow: auto;">
 
<pre style="overflow: auto;">
Line 43: Line 44:
 
</pre>
 
</pre>
  
== Usage ==
+
== Parameters ==
The following is an explanation of each parameter
+
The following is an explanation of each parameter:
  
 
;name: Device name
 
;name: Device name
Line 66: Line 67:
 
;processor: Type of processor/pic/chip
 
;processor: Type of processor/pic/chip
 
;frequency: Speed of the processor
 
;frequency: Speed of the processor
;memory: Amount of built in memory, if any, expressed in [[byte]]s or one of the derivative units such as [[kilobyte|kB]], [[Megabye|MB]] or [[Gigabytes|GB]]
+
;memory: Amount of built in memory, if any, expressed in [[byte]]s or one of the derivative units such as [[kilobyte|kB]], [[Megabyte|MB]] or [[Gigabytes|GB]]
 
;coprocessor: Type of coprocessor
 
;coprocessor: Type of coprocessor
 
;connection: Connection (PCI/PCI-E/USB....)
 
;connection: Connection (PCI/PCI-E/USB....)
Line 79: Line 80:
  
 
== Examples ==
 
== Examples ==
 
 
{{Infobox computer hardware
 
{{Infobox computer hardware
 
| name = Central Processing Unit
 
| name = Central Processing Unit
Line 89: Line 89:
 
| manuf1 = Intel
 
| manuf1 = Intel
 
}}
 
}}
 
+
<pre style="overflow: auto;">
 +
{{Infobox computer hardware
 +
| name = Central Processing Unit
 +
| invent-date = ages ago
 +
| conn1 = Motherboard
 +
| via1_1 = cpu socket
 +
| classname = Architectures
 +
| class1 = x86
 +
| manuf1 = Intel
 +
}}
 +
</pre>
 +
{{clear}}
 +
{{Infobox computer hardware
 +
| name = Video Card
 +
| invent-name = someone
 +
| conn1 = Motherboard
 +
| via1_1 = PciExpress
 +
| via1_2 = Agp Port
 +
| via1_3 = Pci Port
 +
| conn2 = Display
 +
| via2_1 = Cord
 +
| manuf1 = ATI
 +
| manuf2 = nVidia
 +
}}
 +
<pre style="overflow: auto;">
 
{{Infobox computer hardware
 
{{Infobox computer hardware
 
| name = Video Card
 
| name = Video Card
Line 102: Line 126:
 
| manuf2 = nVidia
 
| manuf2 = nVidia
 
}}
 
}}
 
+
</pre>
 +
{{clear}}
 +
{{Infobox computer hardware
 +
| name = Hard Drive
 +
| conn1 = Motherboard
 +
| via1_1 = IDE
 +
| via1_2 = ATA
 +
| via1_3 = SATA
 +
| via1_4 = SCSI
 +
| conn2 = User
 +
| via2_1 = Interactions
 +
| conn3 = Blah
 +
| via3_1 = Meh
 +
| via3_2 = Yeah
 +
| classname = Interfaces
 +
| class1 = IDE
 +
| class2 = ATA
 +
| class3 = S-ATA
 +
| class4 = SCSI
 +
}}
 +
<pre style="overflow: auto;">
 
{{Infobox computer hardware
 
{{Infobox computer hardware
 
| name = Hard Drive
 
| name = Hard Drive
Line 121: Line 165:
 
| class4 = SCSI
 
| class4 = SCSI
 
}}
 
}}
 
+
</pre>
 +
{{clear}}
 
== See also ==
 
== See also ==
 
* {{tl|Infobox CPU}} for [[central processing unit]]s
 
* {{tl|Infobox CPU}} for [[central processing unit]]s
  
<includeonly>
+
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
<!-- CATEGORIES HERE, THANKS -->
+
<!-- Categories below this line, please; interwikis at Wikidata -->
 
[[Category:Computer hardware infobox templates| ]]
 
[[Category:Computer hardware infobox templates| ]]
 
+
}}</includeonly>
</includeonly>
 

Revision as of 19:42, 12 January 2016

This is for generic pieces of computer hardware that don't have more specific infoboxes, such as hard drives, motherboards, CD-ROMs etc. It should not be used for hardware such as CPUs that have their own specific infoboxes. External hardware should not use this box either.

Usage

Template:Parameter names example

{{Infobox computer hardware
| name         = 
| logo         = 
| logo caption = 
| image        = 
| caption      = 
| invent-date  = 
| invent-name  = 
| conn1        = 
| via1_1       = 
| class-name   = 
| class1       = 
| manuf1       = 
| designfirm   = 
| manufacturer = 
| introduced   = 
| discontinued = 
| cost         = 
| type         = 
| processor    = 
| frequency    = 
| memory       = 
| slots        =
| rom          =
| coprocessor  = 
| connection   = 
| ports        = 
| color        =
| dpi          =
| speed        =
| language     =
| power        = 
| weight       = 
| dimensions   = 
}}

Parameters

The following is an explanation of each parameter:

name
Device name
logo
Logo for the top of the infobox
logo caption
Caption of the logo that appears below it. Should not be used to provide trivial captions, such as "This is the logo of X", which is automatically assumed. Reserved for special cases when a description beyond telling the obvious is needed, or for inserting {{ffdc}} or {{deletable image-caption}}.
image
Image to show in the infobox
caption
Caption for the image
invent-date
Date of invention expressed in {{Start date and age|YYYY|MM|DD|df=yes/no}}. (See Template:Start date and age/doc for details.)
invent-name
Name of inventor
conn1: What the device connects to (range 1-3)
via1_1
Possible interface for connection (range 1-9)
class-name
Name of the subclassing method
class1
First value in subclassing (range 1-5)
manuf1
Common manufacturers of the device (range 1-5)
designfirm
Often, but not always, the same as manufacturer
manufacturer
Common manufacturers of the device
introduced
Date of introduction expressed in {{Start date and age|YYYY|MM|DD|df=yes/no}}.
discontinued
Date of discontinuation expressed in {{Start date and age|YYYY|MM|DD|df=yes/no}}.
cost
Introductory price
type
Type of hardware (extension card/sound card/graphics card...)
processor
Type of processor/pic/chip
frequency
Speed of the processor
memory
Amount of built in memory, if any, expressed in bytes or one of the derivative units such as kB, MB or GB
coprocessor
Type of coprocessor
connection
Connection (PCI/PCI-E/USB....)
ports
Connections on the device, such as PATA, SCSI, SATA...
power
Power consumption, expressed W/kWh
weight
Device weight, expressed in kg
dimensions
Width, depth and height of the device, normally expressed in cm

All fields, except 'name', are optional

The numbered attributes mean that there is allowance for multiples. The via attributes range from via1_1 to via3_9 where the first number corresponds to the appropriate connection number and the second number is the position in that connections 'via' list. For each connection (via_1, via_2, or via_3), there can be up to 9 connectors, via#_1 through via#_9.

Examples

Central Processing Unit
Date inventedages ago
Connects toMotherboard via:
  • cpu socket
Product classesx86
Common manufacturersIntel
{{Infobox computer hardware
| name = Central Processing Unit
| invent-date = ages ago
| conn1 = Motherboard
| via1_1 = cpu socket
| classname = Architectures
| class1 = x86
| manuf1 = Intel
}}
Video Card
Invented bysomeone
Connects toMotherboard via one of:
  • PciExpress
  • Agp Port
  • Pci Port

Display via:

  • Cord
Common manufacturersATI
nVidia
{{Infobox computer hardware
| name = Video Card
| invent-name = someone
| conn1 = Motherboard
| via1_1 = PciExpress
| via1_2 = Agp Port
| via1_3 = Pci Port
| conn2 = Display
| via2_1 = Cord
| manuf1 = ATI
| manuf2 = nVidia
}}
Hard Drive
Connects toMotherboard via one of:
  • IDE
  • ATA
  • SATA
  • SCSI

User via:

  • Interactions

Blah via one of:

  • Meh
  • Yeah
Product classesIDE
ATA
S-ATA
SCSI
{{Infobox computer hardware
| name = Hard Drive
| conn1 = Motherboard
| via1_1 = IDE
| via1_2 = ATA
| via1_3 = SATA
| via1_4 = SCSI
| conn2 = User
| via2_1 = Interactions
| conn3 = Blah
| via3_1 = Meh
| via3_2 = Yeah
| classname = Interfaces
| class1 = IDE
| class2 = ATA
| class3 = S-ATA
| class4 = SCSI
}}

See also