Difference between revisions of "Help:Pages/Pinouts"

From Amateur Radio Equipment Database
Jump to: navigation, search
(Created page with "This page explains how to create a pinout page. == Basic page setup == === page location === Pinout pages should be stored either as a subpage of a connector or piece of eq...")
 
(General layout/grammatical improvements. Fixed a few typos.)
 
Line 1: Line 1:
This page explains how to create a pinout page.
+
This page describes the formalised structure of an pinout page and how to go about creating one.  
  
== Basic page setup ==
+
== Basic Page Setup ==
  
=== page location ===
+
=== Page Location ===
  
Pinout pages should be stored either as a subpage of a connector or piece of equipment depending on if the connector is used on multiple piece of equipment e.g. [[Phone connector/Mono audio]] or [[IC-7000/Accessory_socket]].
+
Pinout pages should be stored either as a sub-page of a connector or piece of equipment, depending on if the connector is used on multiple pieces of equipment, (e.g. [[Phone connector/Mono audio]] or [[IC-7000/Accessory_socket]]).
  
=== page contents ===
+
=== Page Contents ===
  
a pinout page should have the folowing structure
+
A pinout page should have the following structure:
 
* A description of the pinout
 
* A description of the pinout
* A {{tl|pinout}} declaration wrapped in an <nowiki><onlyinclude></nowiki> section (this alows for the pinuout to be included on other pages)
+
* A {{tl|pinout}} declaration wrapped in an <nowiki><onlyinclude></nowiki> section (this allows for the pinout to be included on other pages)
* a [[:Category:Pinout]] reference
+
* A [[:Category:Pinout]] reference
  
See the example below for a complete pinout page from([[Phone connector/Mono audio]])
+
See the example below for a complete pinout page, namely ([[Phone connector/Mono audio]])
  
 
<pre><nowiki>
 
<pre><nowiki>
Line 39: Line 39:
 
</nowiki></pre>
 
</nowiki></pre>
  
== Populating the pinout diagram ==
+
== Populating the Pinout Diagram ==
  
Documentation on fillin in a {{tl|pinout}} can be found on the [[Template:Pinout]] page.
+
Documentation on filling in a {{tl|pinout}} can be found on the [[Template:Pinout]] page.

Latest revision as of 09:38, 14 April 2017

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

Basic Page Setup

Page Location

Pinout pages should be stored either as a sub-page of a connector or piece of equipment, depending on if the connector is used on multiple pieces of equipment, (e.g. Phone connector/Mono audio or IC-7000/Accessory_socket).

Page Contents

A pinout page should have the following structure:

  • A description of the pinout
  • A {{pinout}} declaration wrapped in an <onlyinclude> section (this allows for the pinout to be included on other pages)
  • A Category:Pinout reference

See the example below for a complete pinout page, namely (Phone connector/Mono audio)

A common use of the [[Phone connector]] is for mono audio signals.

==== Pinout ====

<onlyinclude>
{{Pinout

|diagram_image = [[File:3.5mm_2pole.svg|200px|3.5mm jack]]

|id1 = Tip
|name1 = Signal
|desc1 = Audio Signal

|id3 = Sleeve
|name3 = GND
|desc3 = Ground
}}
</onlyinclude>

[[Category:Pinout]]

Populating the Pinout Diagram

Documentation on filling in a {{pinout}} can be found on the Template:Pinout page.