Difference between revisions of "Template:Device Infobox/Begin"

From Vogons Wiki
Jump to: navigation, search
(Hide 'config method' for PCI and newer buses, which have their resources configured automatically)
(Add details about 'manual' item)
Line 81: Line 81:
 
| Config = ''Value'' || {{Property:Config method}}
 
| Config = ''Value'' || {{Property:Config method}}
 
|-
 
|-
−
| Driver = ''Wikilink'' || Link to latest driver download.  Avoid multiple links - if it is important to have multiple downloads, put them in a 'downloads' section in the article.  Example: '''<nowiki>Driver = [http://example.com/example.zip example.zip]</nowiki>'''
+
| Manual = ''Wikicode'' || ''This item is placed in the <tt>Device Infobox/End</tt> block.'' Link to a PDF of the manual.  Avoid multiple links - if it is important to have multiple downloads, put them in a 'downloads' section in the article.  Example: '''<nowiki>Manual = [http://example.com/example.pdf example.com]</nowiki>'''
 
|-
 
|-
−
| IsInfoboxPage = ''Value'' || Internal use only, do not use.  This value is set to '''Y''' on infobox pages to avoid the infoboxes themselves being added to categories like 'missing images'.
+
| Driver = ''Wikicode'' || ''This item is placed in the <tt>Device Infobox/End</tt> block.'' Link to latest driver download.  Avoid multiple links - if it is important to have multiple downloads, put them in a 'downloads' section in the article.  Example: '''<nowiki>Driver = [http://example.com/example.zip example.com]</nowiki>'''
 +
|-
 +
| IsInfoboxPage = ''Value'' || Internal use only, do not use.  This value is set to '''Y''' for the demo sections of the infobox pages, to avoid the infoboxes themselves being added to categories like 'missing images'.
 
|}
 
|}
  

Revision as of 16:51, 5 March 2016

Device Infobox/Begin
There is no image of this device — upload one!
Bus type
Bus width
Bus speed Unknown
8-bit ISA compatible? Unknown
PCI 5V tolerant? Unknown
PCI 3.3V tolerant?
AGP speed Unknown
Manufacturer Unknown
Chipset Unknown
Connectors Unknown
Requires -5VDC? Unknown
Requires -12VDC? Unknown
Config method Unknown
Driver Missing download URL

This template is used to build a more specific infobox for particular types of devices. See Accton EN1640 for example use, and Category:Infoboxes for device types that can be placed inside this infobox.

Valid parameters and examples are:

Parameter Meaning
Image = Image.jpg Photo of the device. Use the default name wherever possible (i.e. do not use this option unless you have to). If there are characters that cannot be used in a filename (e.g. a forward slash), try to find a Unicode equivalent to use instead (e.g. mathematical division slash) which are allowed in filenames and look the same.
Bus type = Value The bus type is a text field containing only one of the following permitted values:
  • Expansion cards
    • ISA - original ISA bus
    • EISA - IBM's extended ISA bus (VLB cards are often mistakenly called EISA, make sure it really is EISA!)
    • VLB - VESA Local Bus
    • PCI - original PCI (not PCI Express)
    • AGP
    • PCIe - PCI Express
  • Drives
    • IDE - standard IDE drives
    • SCSI - devices connected to the SCSI bus
    • PC Floppy - standard floppy drives with Shugart 34-pin interface
      • Shugart 50-pin - older PC-compatible floppy interface for 8" drives
    • USB - devices that connect to USB
  • CPUs
    • FSB - Intel Front Side Bus

Other buses should be added to this list as needed. If a device is available with more than one bus type, a different page should be created for each version of the device, as technically those cards are slightly different models.

If a card has multiple bus connections (e.g. some POST cards support both PCI and ISA on different edges of the card) then pick the oldest one, and list the others in the article text using code similar to this: 

This card also has a [[Bus type::PCI]] connector.
Bus width = Value The bus type is a text field containing only one of the following permitted values, which vary depending on the bus type:
  • Expansion cards
    • ISA: 8-bit, 16-bit
    • VLB: 32-bit (VLB 1.0), 64-bit (VLB 2.0)
    • PCI: 32-bit, 64-bit
    • AGP: 32-bit
    • PCIe: x1, x2, x4, x8, x16 - size of connector on the card, make a note in the article if the card is electrically less than this
  • Drives
    • PC Floppy: 1-bit (only one read and one write line)
    • IDE: 16-bit (PIO), 32-bit (UDMA)
    • SCSI: 8-bit (narrow SCSI), 16-bit (wide SCSI)
  • General
    • USB: 1-bit (only one read and one write lane)
Bus speed = Value Rated maximum bus speed of the device. The values depend on the bus type:
  • AGP: 66 MHz
  • IDE: N/A (set automatically from Bus version)
  • ISA: 8 MHz
  • PCI: 33 MHz, 66 MHz, 133 MHz
  • PCIe: N/A (PCIe version goes into Bus version parameter)
  • VLB: 40 MHz (VLB 1.0), 50 MHz (VLB 2.0)
8-bit ISA compatible = Value 16-bit ISA only: This boolean property is Yes if a 16-bit ISA card is known to work in an 8-bit ISA slot. It is No if the card is known not to work in an 8-bit slot. If the value is not set, then the card has not yet been tested in an 8-bit slot. If the card is an 8-bit card then this value is automatically set to Yes so it can be omitted. It is likewise automatically set to No for non-ISA buses so it can be omitted there as well.

This is useful for those working with XT and older computers, which only have 8-bit slots. Knowing a particular 16-bit card will work in a machine with only 8-bit slots saves the hassle of trying to find an 8-bit card to use.

If a card does not natively work in an 8-bit slot but can be made to do so with different drivers, then this value should be set to Yes, but an explanation should be given on the device's page.

PCI 5V = Value PCI only: Boolean value indicating whether the card will work in a 5 VDC PCI slot. Yes, No or Unknown.
PCI 3.3V = Value PCI only: Boolean value indicating whether the card will work in a 3.3 VDC PCI slot. Yes, No or Unknown.
AGP speed = Value AGP only: Property:Has AGP speed
Manufacturer = Value Page for the manufacturer's company name. Be consistent so all cards with the same manufacturer are grouped together.
Chipset = Value Text value containing the name of the primary chipset. Be consistent so all cards with the same chipset are grouped together. If there is more than one large chip, try to pick the biggest or the one most related to the card's primary function.
Compatible with = Value Generic interfaces that can be used to control this card. Valid values depend on the device type, see the device-specific infobox pages for examples. Each interface has a page of its own.
Connectors = Value Which externally accessible connectors are on the card? Comma separated list of Has connector page elements. Valid values depend on the device type, see Has connector for a list. An example is [[Has connector::VGA]], [[Has connector::RS232/DB25]]

Internal connectors are typically specified elsewhere in the infobox.

Extra fields = Value Additional infobox fields for more specific infoboxes to use. Zero or more whitespace-separated instances of Template:Device Infobox/Item.
Requires -5VDC = Value Boolean value indicating whether the device requires -5VDC present to function correctly. Yes, No or Unknown. This can be important since most modern power supplies no longer deliver -5VDC.
Requires -12VDC = Value Boolean value indicating whether the device requires -12VDC present to function correctly. Yes, No or Unknown.
Config = Value Configuration method used to set card resources (addresses, IRQ, etc.). Comma separated list, one or more of:
  • [[Config method::Jumpers]] (some or all resources are set via physical jumpers on the card)
  • [[Config method::DIP switches]] (similar to jumpers but via small switches instead)
  • [[Config method::Software]] (some or all resources are set with a manufacturer-provided configuration program)
  • [[Config method::PnP]] (some or all resources are set via the ISA/PCI plug-n-play specification, requiring a PnP BIOS or configuration manager program to be used)
  • [[Config method::None]] (none of the resources can be changed at all)
Manual = Wikicode This item is placed in the Device Infobox/End block. Link to a PDF of the manual. Avoid multiple links - if it is important to have multiple downloads, put them in a 'downloads' section in the article. Example: Manual = [http://example.com/example.pdf example.com]
Driver = Wikicode This item is placed in the Device Infobox/End block. Link to latest driver download. Avoid multiple links - if it is important to have multiple downloads, put them in a 'downloads' section in the article. Example: Driver = [http://example.com/example.zip example.com]
IsInfoboxPage = Value Internal use only, do not use. This value is set to Y for the demo sections of the infobox pages, to avoid the infoboxes themselves being added to categories like 'missing images'.

Default values are shown if the parameter is omitted, so do not use any parameters unless the value is known (most of the defaults say "unknown")

Retrieved from "https://www.vogonswiki.com/index.php?title=Template:Device_Infobox/Begin&oldid=2423"