Article templates: Difference between revisions

From TekWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
TekWiki offers a number of '''Wiki templates''' that generate uniform information boxes, headlines, categories and the like.   
TekWiki offers a number of '''Wiki templates''' that generate uniform information boxes, headlines, categories and the like.   


Here's how to use some of these.
__TOC__
==Oscilloscopes and similar instruments==


<code><nowiki>{{Oscilloscope Sidebar |
Click the links below for instructions on how to use these templates:
  title=Name of model  |
  summary=Short description of what it is |
  image=Photo of XYZ.jpg |
  caption=What exactly is shown in the photo |
  introduced=year the model was introduced |
  discontinued=last year the model was sold + 1 |
  manuals=
  * [http://some.external.site XYZ Service Manual] (PDF, OCR, 13 MB)
  * [[Media:0970-9876-99.pdf|XYZ Operator's Manual]] (PDF, 5 MB)
</nowiki></code>
The template adds <code><nowiki>[[Category:Introduced in (year)]]</nowiki></code> to the article.
If the introduction or discontinuation year is unknown, please use (?) in its place, e.g. <code><nowiki>introduced=(?)</nowiki></code>.
 
Example:
{|
|- valign="top"
|
<code><nowiki>{{Oscilloscope Sidebar |
title=Tektronix 7603 |
summary=100 MHz non-storage mainframe |
image=7603-4trace.jpg |
caption=Tektronix 7603 |
introduced=1973 |
discontinued=1990 |
manuals=
* [[Media:070-1429-00.pdf|Tektronix 7603 Manual (PDF, 35 MB)]]
}}</nowiki></code>
|
[[File:Scope Sidebar Example.png|thumb|200px]]
|}
==Plug-ins==
 
<code><nowiki>{{Plugin Sidebar 2 |
  title=Name of model  |
  summary=Short description of what it is |
  image=Photo of XYZ.jpg |
  caption=What exactly is shown in the photo |
  introduced=year the model was introduced |
  discontinued=last year the model was sold + 1 |
  series=link to the page describing the instrument(s) this plug-in fits |
  manuals=
  * [http://some.external.site XYZ Service Manual] (PDF, OCR, 13 MB)
  * [[Media:0970-9876-99.pdf|XYZ Operator's Manual]] (PDF, 5 MB)
</nowiki></code>
The template adds <code><nowiki>[[Category:Introduced in (year)]]</nowiki></code> to the article.
If the introduction or discontinuation year is unknown, please use (?) in its place, e.g. <code><nowiki>introduced=(?)</nowiki></code>.
 
Example:
{|
|- valign="top"
|
<code><nowiki>{{Plugin Sidebar 2|
title=Tektronix 7A22 |
summary=1 MHz differential amplifier |
image=tek-7a22-front.jpg |
caption=7A22 front view |
introduced=1969 |
discontinued=1991 |
series=[[7000-series scopes]]|
manuals=
* [http://w140.com/smb/7a22_sm.pdf  Tektronix 7A22 Manual (OCR, PDF)]
}}</nowiki></code>
|
[[File:Plugin Sidebar Example.png|thumb|200px]]
|}
 
==TM500/TM5000 plugins==
 
<code><nowiki>{{TM500 | mfg=Tektronix | type=DM502 | function=basic 3½ digit digital multimeter | class=multimeter | image=Tek dm502 e1.jpg | introduced=1975 | discontinued=1988 |
manuals=
* [http://w140.com/tek_dm502.pdf Tektronix DM502 Manual (PDF)]
}}
</nowiki></code>
 
<code><nowiki>{{TM5000 | mfg=Tektronix | type=AM5030 | function=current probe amplifier | class=amplifier | image=Tek am5030.jpg | introduced=1994 | discontinued=(?) | manuals=
* [[Media:070-8766-05.pdf|Tektronix AM503B AM5030 Manual (PDF)]]
}}
</nowiki></code>
 
The template adds <code><nowiki>[[Category:Introduced in (year)]]</nowiki></code> to the article.
If the introduction or discontinuation year is unknown, please use (?) in its place, e.g. <code><nowiki>introduced=(?)</nowiki></code>.
 
The template adds <code><nowiki>[[Category:TM500(0) (class) plugins]]</nowiki></code> to the article, e.g. <code><nowiki>[[Category:TM500 multimeter plugins]]</nowiki></code> in the first example above.
 
In addition to the sidebar, this template generates a first paragraph as "The '''(mfg) (type)''' is a (function) plug-in for the TM500(0) system.", e.g.
: The '''Tektronix AM5030''' is a current probe amplifier plug-in for the TM5000 system.
 
==Specifications==
 
<code><nowiki>{{BeginSpecs}}
{{Spec | Parameter | values }}
{{Spec | Parameter | values }}
{{SpecGroup | grouping headline, e.g. model sub-type }}
{{Spec | Parameter | values }}
{{EndSpecs}}
</nowiki></code>
 
Example:
{|
|- valign="top"
|
<code><nowiki>{{BeginSpecs}}
{{Spec | Bandwidth | DC to 10 MHz (AC coupling LF cutoff <10 Hz) }}
{{Spec | Deflection | 1 mV/Div to 10 V/Div, 1−2−5 }}
{{Spec | Input impedance | 1 MΩ // 47 pF }}
{{Spec | Time base | 1 μs/Div to 5 s/Div, 1−2−5 }}
{{Spec | Storage | Bistable storage, Writing speed >80 Div/ms, >400 Div/ms (250 cm/ms) in enhanced mode }}
{{Spec | CRT | 8×10 Div @ 6 mm/Div, P44 phosphor, 2 kV acceleration voltage }}
{{EndSpecs}}</nowiki></code>
|
{{BeginSpecs}}
{{Spec | Bandwidth | DC to 10 MHz (AC coupling LF cutoff <10 Hz) }}
{{Spec | Deflection | 1 mV/Div to 10 V/Div, 1−2−5 }}
{{Spec | Input impedance | 1 MΩ // 47 pF }}
{{Spec | Time base | 1 μs/Div to 5 s/Div, 1−2−5 }}
{{Spec | Storage | Bistable storage, Writing speed >80 Div/ms, >400 Div/ms (250 cm/ms) in enhanced mode}}
{{Spec | CRT | 8×10 Div @ 6 mm/Div, P44 phosphor, 2 kV acceleration voltage }}
{{EndSpecs}}
|}


* [[:Template:Spec]] for lists of key specification on instrument pages
* [[:Template:Oscilloscope Sidebar]] for oscilloscopes
* [[:Template:Instrument Sidebar]] for generic instruments including spectrum analyzers, generators, ...
* [[:Template:Plugin Sidebar]] for plug-in modules that go into other equipment
* [[:Template:TM500]] for TM500 series plug-ins
* [[:Template:TM5000]] for TM5000 series plug-ins
==Missing Data==
==Missing Data==
  <code><nowiki>{{MissingSpecs}}</nowiki></code>
  <code><nowiki>{{MissingSpecs}}</nowiki></code>

Revision as of 05:49, 10 August 2021

TekWiki offers a number of Wiki templates that generate uniform information boxes, headlines, categories and the like.


Click the links below for instructions on how to use these templates:

Missing Data

{{MissingSpecs}}

Creates a Specifications headline and "Please add" paragraph, and categorises the page as [[Category:Specifications needed]].

{{MissingPics}}

Creates a Pictures headline and "Please add" paragraph, and categorises the page as [[Category:Image needed]].