Difference between revisions of "Template:Infobox modem/doc"
(create documentation for infobox modem template) |
m (grammar) |
||
Line 68: | Line 68: | ||
| | | | ||
| valign="top" | <code>baud_rates</code> | | valign="top" | <code>baud_rates</code> | ||
− | | The baud rates supported by the modem. | + | | The baud rates supported by the modem. If only a range of baud rates is known, use the form ''smallest''-''largest'', e.g. 100-19200. If all the discrete baud rates supported by the terminal are known, list them in order from smallest to largest, e.g. 100, 150, 300. |
|- | |- | ||
| valign="top" | '''Firmware''' | | valign="top" | '''Firmware''' |
Latest revision as of 22:29, 2 June 2020
This is a documentation subpage for Template:Infobox modem. It contains usage information, categories and other content that is not part of the original template page. |
This template is used to create an infobox for a particular external modem.
The parameters are all named. Two of the parameters, manufacturer
and model
, are required and must match the PAGENAME
of the article. All other parameters can be omitted and will result in no associated displayed information.
Section | Parameter | Meaning |
---|---|---|
Basic Information | manufacturer (required)
|
The name of the manufacturer, as categorized on the wiki. The name will be linked to the category page for the manufacturer. Detailed information about the manufacturer is given on it's category page, including links to any pages on Wikipedia for the company if they exist. |
model (required)
|
The model name of the modem. In some cases the model name is reported inconsistently in different references, including different text from the manufacturer. Use a model name taxonomy that is consistent across all models from the same manufacturer. For instance, some documentation from DEC refers to the DEC VT100 as VT100 and some refers to it as VT-100. | |
image
|
The filename of a canonical image uploaded for this terminal. It will be formatted as a thumbnail that links to the media page for the uploaded file. The uploaded file should be categorized to the manufacturer with the model name used as the sort key, e.g. [[Category:Hayes|Smartmodem]]. | |
Lifetime | intro_prior
|
If non-empty, will result in the phrase prior to being prepended to the introduction date |
intro_month
|
The name of the month when the modem was introduced, if known. This may be prior to the date when the modem was actually available for shipment, as an announcement of the modem may be made prior to it first being shipped as a product. Use January, February, etc. | |
intro_year
|
The year in which the modem was introduced. | |
intro_price
|
The price of the modem when it was first introduced. | |
discontinued_month
|
The month in which the modem was discontinued. | |
discontinued_year
|
The year in which the modem was discontinued. | |
Communication | interface
|
The primary communications interface offered by the modem, e.g. RS-232C |
interface2
|
A second interface offered by the modem, e.g. 20 mA current loop | |
interface3
|
A third interface offered by the modem, e.g. TTL | |
interface4
|
A fourth interface offered by the modem | |
interface5
|
A fifth interface offered by the modem | |
baud_rates
|
The baud rates supported by the modem. If only a range of baud rates is known, use the form smallest-largest, e.g. 100-19200. If all the discrete baud rates supported by the terminal are known, list them in order from smallest to largest, e.g. 100, 150, 300. | |
Firmware | cpu
|
The name of the microprocessor, if any, for this modem. Include the clock rate if it is known and always include the manufacturer of the architecture, e.g. 1 MHz Mostek 6502 |
rom
|
The amount of firmware read-only memory for this modem, if any, e.g. 32K | |
ram
|
The amount of firmware random access memory for this modem, if any, e.g. 2K. |
Example
{{infobox modem | manufacturer = | model = | image = | intro_year = | intro_month = | intro_prior = | intro_price = | discontinued_year = | discontinued_month = | interface = | interface2 = | interface3 = | interface4 = | interface5 = | baud_rates = | cpu = | rom = | ram = }}