Wiki - New Device Copy & Paste Template

From LinuxTVWiki
Revision as of 02:45, 14 August 2012 by CityK (Talk | contribs)

Jump to: navigation, search
Note: In essence, this page is a "copy and paste" template which users should use when establishing a new device article within the wiki. Its intended purpose is to serve as the basis for the format/layout of device articles; thereby striving to establish a general consistency throughout the wiki.

Usage:

  • Once you have logged in, simply click the edit tab at the top of this page
  • Then from within the editing box at the bottom of the editing page, copy the entire contents of this article
  • From within the editing box at the bottom of the new device page you are creating, paste the copied content from the "new device copy and paste template"
  • Proceed to fill in the information relevant for the device and delete the italic directional comment sections provided by the template (as well as this notice)

First, if possible, we would like a good overall image of what the device looks like (Note: do NOT use proprietary images unless you have obtained permission to do so). Next, provide a brief summary of what the device is and by whom it is provided (include wiki links to the card type and the vendor -- and, ideally, after you have finished editing this page, you should add links from those pages back to this one). The last introductory piece of information is the all important indication of whether or not the device is supported under Linux. Here's an example:

Example Image: Add a good overall image of what the device looks like here and perhaps a very brief description

An ATSC ATSC PCI cards from KWORLD.

The ATSC 115 is supported under Linux since kernel 2.6.24.

Note: The page contents menu will automagically build itself, so you need not worry about it

Overview/Features

Discuss the features and facets of the device here. For example:

  • USB2 interface
  • Inputs: Antenna

Components Used

List the hardware ICs and modules used by the device here. For example:

Other Images

Use the included code to insert other images if necessary. Add as many high resolution pictures as you can i.e the card, the original box, the remote and, when uploading the files to the wiki, give them detailed specific names. Note: only use images taken by yourself or those 3rd party images for which you have received express written consent (such as from a vendor) that permits their usage. For example:

Identification

Provide here, for PCI/PCIe devices, the relevant output of lspci -vnn or, in the case of USB devices, lsusb -v . We're particularly interested in the subsystem ID's. To make a code block simply make the first character of each line a space. For example:


External Links

Provide a link to the vendor's product page here along with any other external link to information that is generally helpful in relation to the device. For example:

Finally, add anything else that you think might be relevant under an appropriate heading.

Very last thing is add a catergory. (Remove the nowiki tags). For example
[[Category:DVB-T PCI Devices]]