Article templates: Difference between revisions

From TekWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(24 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:


==Oscilloscopes and similar instruments==
==Page skeletons==
* [[:Template:Company]] for key data on a company
* Components:
** [[:Template:CRT]] for [[cathode-ray tube]]s
** [[:Template:Discrete component]] for other discrete components
** [[:Template:Vacuum Tube]] for other vacuum tubes (valves)
** [[:Template:Hybrid IC]] for hybrid integrated circuits
** [[:Template:Monolithic IC]] for monolithic integrated circuits
* [[:Template:Instrument Sidebar]] for generic instruments including spectrum analyzers, generators, ...
** [[:Template:Oscilloscope Sidebar]] specifically for oscilloscopes
** [[:Template:Probe Sidebar]] specifically for probes
* [[:Template:Plugin Sidebar]] for plug-in modules that go into other equipment
** [[: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


<code><nowiki>{{Oscilloscope Sidebar |
==Document Crossreference==
  title=Name of model  |
* [[:Template:AppNote]] is used to tag an application note file page
  summary=Short description of what it is |
* [[: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.
  image=Photo of XYZ.jpg |
* [[:Template:Brochure]] is used to tag a brochure file page
  caption=What exactly is shown in the photo |
* [[:Template:Book]] is used to tag a book file page
  introduced=year the model was introduced |
* [[:Template:Manual]] is used to tag a manual file page
  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:
==Queries==
{|
* [[:Template:Designer]] lists components and products designed by a specified person
|- valign="top"
* [[:Template:Components made by]] lists components made by a specified manufacturer
|
* [[:Template:Parts]] lists generic parts such as [[vacuum tubes]] used in the referenced instrument
<code><nowiki>{{Oscilloscope Sidebar |
** [[:Template:CRTs]] lists only CRTs used in the referenced instrument
title=Tektronix 7603 |
** [[:Template:Custom ICs]] lists only Custom ICs used in the referenced instrument
summary=100 MHz non-storage mainframe |
* [[:Template:Part usage]] lists instruments where a specific part is used
image=7603-4trace.jpg |
* [[:Template:Patents]] lists patents by a specified inventor
caption=Tektronix 7603 |
* [[:Template:People]] lists people affiliated with a specified company
introduced=1973 |
* [[:Template:Plugins]] lists plugins compatible with the referenced instrument
discontinued=1990 |
* [[:Template:Products]] lists products by a specified company
manuals=
* [[Media:070-1429-00.pdf|Tektronix 7603 Manual (PDF, 35 MB)]]
}}</nowiki></code>
|
[[File:Scope Sidebar Example.png|thumb|200px]]
|}


==Missing Data==
* [[:Template:MissingSpecs]] creates a '''Specifications''' headline and "Please add" paragraph, and categorises the page as  <code><nowiki>[[Category:Specifications needed]]</nowiki></code>.
* [[: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>.
* [[:Template:MissingBio]] creates "Please add" paragraph, and categorises the page as  <code><nowiki>[[Category:Biography needed]]</nowiki></code>.


==Plug-ins==
==Specifications==
* [[:Template:Spec]] (together with [[:Template:BeginSpecs]], [[:Template:SpecGroup]], [[:Template:EndSpecs]]) for key specifications on instrument pages


<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.


[[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"