LIMSWiki:Product page

From LIMSWiki
Jump to: navigation, search

Like Wikipedia, product pages are going to be allowed on LIMSwiki.org. Also like Wikipedia, certain standards are expected of a product page:

  • A product page shouldn't be created unless it meets notability guidelines. As Wikipedia defines it, "notability is an attempt to assess whether the topic has 'enduring notability,' as evidenced by significant coverage in reliable secondary sources that are independent of the topic."
  • As mentioned above, a product page should be predominately based on reliable independent sources. While a product page can certainly contain self-supported, non-independent sources to back up company claims, these should not make up the majority of the sources.

Product page format

A product page can have many different formats, based upon available information (or lack thereof) about the product. However, there are a few defining elements of a product page that need to be included:

1. Either a hardware or software info box: The two predominate infobox types that are used are Template:Infobox laboratory equipment and Template:Infobox software (with the potential of more being added as necessary), and they are used to insert a software-based info box into a product page.

Infobox laboratory equipment

The code for a laboratory equipment infobox (with all the available attributes) looks like this:

{{Infobox laboratory equipment
|name         = 
|image        = 
|alt          = <!-- Alternative text for images -->
|caption      = 
|acronym      = 
|other_names  = 
|uses         = 
|notable_experiments =
|inventor     = 
|manufacturer = 
|model        = 
|related      = 
|website      = [http://example.org example.org]
}}

Obviously not all of these attributes will be needed for a piece of laboratory equipment. Those attributes not used can either be removed from the inserted code or left intact for future use. (See below for an example.)

Infobox software

The code for a software infobox (with all the available attributes) looks like this:

{{Infobox software
| name                   = 
| title                  = 
| logo                   = <!-- [[File: ]] -->
| screenshot             = <!-- [[File: ]] -->
| caption                = 
| collapsible            = 
| author                 = 
| developer              = 
| released               = <!-- {{Start date|YYYY|MM|DD|df=yes/no}} -->
| discontinued           = 
| latest release version = 
| latest release date    = <!-- {{Start date and age|YYYY|MM|DD|df=yes/no}} -->
| latest preview version = 
| latest preview date    = <!-- {{Start date and age|YYYY|MM|DD|df=yes/no}} -->
| frequently updated     = <!-- DO NOT include this parameter unless you know what it does -->
| programming language   = 
| operating system       = 
| platform               = 
| size                   = 
| language               = 
| status                 = 
| genre                  = 
| license                = 
| website                = [http://example.org example.org]
}}

Obviously not all of these attributes will be needed for a software product. Those attributes not used can either be removed from the inserted code or left intact for future use. (See below for an example.)

2. An introductory paragraph or two that introduces the software and what it does

3. A history of the software product

4. A description of the software product's most important features

5. Any applicable hardware and software requirements for the specific product to function as intended (usually only for software products)

Example code

Laboratory equipment example

Here's example code that a laboratory equipment article stub may start out with:

{{Infobox laboratory equipment
|name         = ZYX Tabletop Microscope
|image        = 
|alt          = <!-- Alternative text for images -->
|caption      = 
|acronym      = 
|other_names  = ZYX
|uses         = [[Digital microscopy]]
|notable_experiments =
|inventor     = 
|manufacturer = [[ZYX Industries, Inc.]]
|model        = ZYX-ABC123
|related      = [[ABC Tabletop Microscope]]
|website      = [http://zyxindustries.com ZYXIndustries.com]
}}

This is an intro paragraph about the product.

==Product history==

This is the history of the product.

==Features==

This is a brief description of the key features.

==Hardware/software requirements==

If applicable, add any additional interfacing requirements or additional equipment needed to use the product.

==References==
<references />

<!---Place all category tags here-->
[[Category:Digital microscope]]

Obviously pages can be much more dynamic and contain much more content, as long that content is able to be supported with a fair mix of independent and non-independent sources.

Software example

Here's example code that a software article stub may start out with:

{{Infobox software
| name                   = ABCXYZ LIMS
| title                  = '''ABCXYZ LIMS'''
| logo                   = <!-- [[File: ]] -->
| screenshot             = <!-- [[File: ]] -->
| caption                = 
| collapsible            = 
| author                 = 
| developer              = [[ABCXYZ, Inc.]]
| released               = <!-- {{Start date|2007}} -->
| discontinued           = 
| latest release version = 1.2.0
| latest release date    = <!-- {{Start date and age|2009|08|19|}} -->
| latest preview version = 
| latest preview date    = <!-- {{Start date and age|YYYY|MM|DD|df=yes/no}} -->
| programming language   = Java
| operating system       = 
| platform               = Java 1.6 or higher
| size                   = 
| language               = 
| status                 = Active
| genre                  = [[LIMS]]
| license                = Proprietary commercial software
| website                = [http://www.abcxyz.com ABCXYZ.com]
}}

This is an intro paragraph about the software product.

==Product history==

This is the history of the product.

==Features==

This is a brief description of the key features.

==Hardware/software requirements==

This is a description of the hardware and software requirements for running the product.

'''Additional requirements to use the software:'''

==References==
<references />

<!---Place all category tags here-->
[[Category:Laboratory information management systems]]

Obviously pages can be much more dynamic and contain much more content, as long that content is able to be supported with a fair mix of independent and non-independent sources.

Example pages

Example of a laboratory equipment article stub: Branson Ultrasonic Corporation's Sonifier S-450A

Example of an open-source software article stub: OpenELIS