Article templates: Difference between revisions

From TekWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(23 intermediate revisions by the same user not shown)
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.
Please see the individual templates for instructions on their use:
__TOC__
==Oscilloscopes and similar instruments==


<code><nowiki>{{Oscilloscope Sidebar |
==Page skeletons==
  title=Name of model  |
* [[:Template:Company]] for key data on a company
  summary=Short description of what it is |
* Components:
  image=Photo of XYZ.jpg |
** [[:Template:CRT]] for [[cathode-ray tube]]s
  caption=What exactly is shown in the photo |
** [[:Template:Discrete component]] for other discrete components
  introduced=year the model was introduced |
** [[:Template:Vacuum Tube]] for other vacuum tubes (valves)
  discontinued=last year the model was sold + 1 |
** [[:Template:Hybrid IC]] for hybrid integrated circuits
  manuals=
** [[:Template:Monolithic IC]] for monolithic integrated circuits
  * [http://some.external.site XYZ Service Manual] (PDF, OCR, 13 MB)
* [[:Template:Instrument Sidebar]] for generic instruments including spectrum analyzers, generators, ...
  * [[Media:0970-9876-99.pdf|XYZ Operator's Manual]] (PDF, 5 MB)
** [[:Template:Oscilloscope Sidebar]] specifically for oscilloscopes
</nowiki></code>
** [[:Template:Probe Sidebar]] specifically for probes
The template adds <code><nowiki>[[Category:Introduced in (year)]]</nowiki></code> to the article.
* [[:Template:Plugin Sidebar]] for plug-in modules that go into other equipment
If the introduction or discontinuation year is unknown, please use (?) in its place, e.g. <code><nowiki>introduced=(?)</nowiki></code>.
** [[:Template:TM500]] specifically for [[:Category:TM500 series plugins|TM500 series plugins]]
** [[:Template:TM5000]] specifically for [[:Category:TM5000 series plugins|TM5000 series plugins]]
* [[:Template:Patent]] for patents related to Tek or Tek equipment
* [[:Template:Person]] for key biographical data on a person


Example:
==Document Crossreference==
{|
* [[:Template:AppNote]] is used to tag an application note file page
|- valign="top"
* [[:Template:Article]] is used to tag articles in a file, e.g. a TekScope issue. The template can be used multiple times on the same file page.
|
* [[:Template:Brochure]] is used to tag a brochure file page
<code><nowiki>{{Oscilloscope Sidebar |
* [[:Template:Book]] is used to tag a book file page
title=Tektronix 7603 |
* [[:Template:Manual]] is used to tag a manual file page
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 |
==Queries==
  title=Name of model  |
* [[:Template:Designer]] lists components and products designed by a specified person
  summary=Short description of what it is |
* [[:Template:Components made by]] lists components made by a specified manufacturer
  image=Photo of XYZ.jpg |
* [[:Template:Parts]] lists generic parts such as [[vacuum tubes]] used in the referenced instrument
  caption=What exactly is shown in the photo |
** [[:Template:CRTs]] lists only CRTs used in the referenced instrument
  introduced=year the model was introduced |
** [[:Template:Custom ICs]] lists only Custom ICs used in the referenced instrument
  discontinued=last year the model was sold + 1 |
* [[:Template:Part usage]] lists instruments where a specific part is used
  series=link to the page describing the instrument(s) this plug-in fits |
* [[:Template:Patents]] lists patents by a specified inventor
  manuals=
* [[:Template:People]] lists people affiliated with a specified company
  * [http://some.external.site XYZ Service Manual] (PDF, OCR, 13 MB)
* [[:Template:Plugins]] lists plugins compatible with the referenced instrument
  * [[Media:0970-9876-99.pdf|XYZ Operator's Manual]] (PDF, 5 MB)
* [[:Template:Products]] lists products by a specified company
</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:
==Missing Data==
{|
* [[:Template:MissingSpecs]] creates a '''Specifications''' headline and "Please add" paragraph, and categorises the page as <code><nowiki>[[Category:Specifications needed]]</nowiki></code>.
|- valign="top"
* [[:Template:MissingPics]] creates a '''Pictures''' headline and "Please add" paragraph, and categorises the page as <code><nowiki>[[Category:Image needed]]</nowiki></code>.
|
* [[:Template:BetterPics]] creates a notice that better pictures are needed, and categorises the page as <code><nowiki>[[Category:Better image needed]]</nowiki></code>.
  <code><nowiki>{{Plugin Sidebar 2|
* [[:Template:MissingBio]] creates "Please add" paragraph, and categorises the page as  <code><nowiki>[[Category:Biography needed]]</nowiki></code>.
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==
==Specifications==
* [[:Template:Spec]] (together with [[:Template:BeginSpecs]], [[:Template:SpecGroup]], [[:Template:EndSpecs]]) for key specifications on instrument pages


<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}}
|}
==Missing Data==
<code><nowiki>{{MissingSpecs}}</nowiki></code>
Creates a '''Specifications''' headline and "Please add" paragraph, and categorises the page as  <code><nowiki>[[Category:Specifications needed]]</nowiki></code>.
<code><nowiki>{{MissingPics}}</nowiki></code>
Creates a '''Pictures''' headline and "Please add" paragraph, and categorises the page as  <code><nowiki>[[Category:Image needed]]</nowiki></code>.






[[Category:TekWiki]]
[[Category:TekWiki]]

Latest revision as of 06:07, 21 June 2024

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

Please see the individual templates for instructions on their use:

Page skeletons

Document Crossreference

Queries

Missing Data

  • Template:MissingSpecs creates a Specifications headline and "Please add" paragraph, and categorises the page as [[Category:Specifications needed]].
  • Template:MissingPics creates a Pictures headline and "Please add" paragraph, and categorises the page as [[Category:Image needed]].
  • Template:BetterPics creates a notice that better pictures are needed, and categorises the page as [[Category:Better image needed]].
  • Template:MissingBio creates "Please add" paragraph, and categorises the page as [[Category:Biography needed]].

Specifications

Retrieved from "https://w140.com/tekwiki/index.php?title=Article_templates&oldid=94612"