Difference between revisions of "Help:Pages/Connectors"

From Amateur Radio Equipment Database
Jump to: navigation, search
(Created page with "This page covers the components and sections of a connector page and how to go about creating one == Basic Page information and categorisation == === Page Location === Page...")
 
(General layout/grammatical improvements.)
Line 1: Line 1:
This page covers the components and sections of a connector page and how to go about creating one
+
This page describes the formalised structure of an connector page and how to go about creating one.
  
== Basic Page information and categorisation ==
+
== Basic Page Information and Categorisation ==
  
 
=== Page Location ===
 
=== Page Location ===
  
Pages for connectors should be located under the name of the connector. e.g. [[Phone connector]] or [[VL connector]]
+
Pages for connectors should be located under the name of the connector, (e.g. [[Phone connector]] or [[VL connector]]).
  
 
=== Infobox ===
 
=== Infobox ===
  
Connector pages use the {{tl|Infobox connector}} template to provide the basic information about the equipment. Documentation on the fields available in the info-box are available at the [[Template:Infobox connector]] page.
+
Connector pages use the {{tl|Infobox connector}} template to provide the basic information about the connector. Documentation on the fields available in this infobox are available at the [[Template:Infobox connector]] page.
  
=== Basic description ===
+
=== Basic Description ===
  
 
Before the first section there should be a basic description of the connector.
 
Before the first section there should be a basic description of the connector.
Line 19: Line 19:
 
Connectors are stored under the [[:Category:Connector]] category.
 
Connectors are stored under the [[:Category:Connector]] category.
  
== Adding detailed information to a connector page ==
+
== Adding Detailed Information to a Connector Page ==
  
Connector pages can be improved beyond the basic components listed above.
+
Connector pages maybe improved beyond the basic structure listed above.
  
=== Some common sections to add to an equipment page ===
+
=== Additional Common Sections ===
  
 
* Characteristics
 
* Characteristics
Line 30: Line 30:
 
* Common uses with links to pinout pages
 
* Common uses with links to pinout pages
  
=== Things not to add to an equipment page ===
+
=== Things to Avoid ===
  
 
* Links to distributors or online stores
 
* Links to distributors or online stores
 
* Personal reviews of the connectors
 
* Personal reviews of the connectors
 
* connector pinouts (These should end up in a [[Help:Pages/Pinouts|pinout]] page)
 
* connector pinouts (These should end up in a [[Help:Pages/Pinouts|pinout]] page)

Revision as of 09:34, 14 April 2017

This page describes the formalised structure of an connector page and how to go about creating one.

Basic Page Information and Categorisation

Page Location

Pages for connectors should be located under the name of the connector, (e.g. Phone connector or VL connector).

Infobox

Connector pages use the {{Infobox connector}} template to provide the basic information about the connector. Documentation on the fields available in this infobox are available at the Template:Infobox connector page.

Basic Description

Before the first section there should be a basic description of the connector.

Categorisation

Connectors are stored under the Category:Connector category.

Adding Detailed Information to a Connector Page

Connector pages maybe improved beyond the basic structure listed above.

Additional Common Sections

  • Characteristics
    • Mechanical
    • Electrical
  • Common uses with links to pinout pages

Things to Avoid

  • Links to distributors or online stores
  • Personal reviews of the connectors
  • connector pinouts (These should end up in a pinout page)