Template:Infobox networking protocol/doc

From Freephile Wiki
Jump to navigation Jump to search

Usage[edit source]

You can copy and paste the following empty skeleton template into the article and fill it in as you see fit, in case you wish to use source editor instead of VisualEditor. |logo caption= is deliberately omitted to discourage the use of this oft-abused parameter.

{{{title}}}
Communications protocol
[[File:{{{logo}}}|{{{logo size}}}|alt={{{logo alt}}}|{{{logo alt}}}]]
{{{logo caption}}}
[[File:{{{image}}}|{{{image size}}}|alt={{{image alt}}}|{{{image alt}}}]]
{{{caption}}}
Purpose {{{purpose}}}
Developer(s) {{{developer}}}
Introduced {{{date}}}
Based on {{{based on}}}
Influenced {{{influenced}}}
OSI layer {{{osilayer}}}
Port(s) {{{ports}}}
RFC(s) {{{rfcs}}}
Hardware {{{hardware}}}
{{Infobox networking protocol
|       title = 
|        logo = 
|    logo alt = 
|       image = 
|   image alt = 
|     caption = 
|    is stack = 
|     purpose = 
|   developer = 
|        date = {{Start date and age|    |  |  }}<!--Fill in: Year (4 digits), month and day (2 digits)-->
|    based on = 
|  influenced = 
|    osilayer = 
|       ports = 
|        rfcs = 
|    hardware = 
}}

Syntax[edit source]

This is the TemplateData documentation for this template used by VisualEditor and other tools.

See the monthly error report for this template.

TemplateData for Infobox networking protocol

This infobox helps display important preliminary details about a protocol in an article.

Template parameters

ParameterDescriptionTypeStatus
Title or nametitle name

Title or name of the subject of infobox focus.

Stringrequired
Is stack?is stack

If set to "yes" specifies whether the article is about a protocol stack, instead of a communications protocol

Auto value
yes
Booleanoptional
Logologo

Name of the image pertaining the logo of the protocol or suite. A file name is enough.

Auto value
Fileoptional
Logo sizelogo size

Size of the logo. Number and a CSS unit of measurement is accepted. e.g. 250px, x64px or 250x64px.

Stringoptional
Logo's alternative textlogo alt

Alternative text in case the logo cannot be displayed by the target web browser or cannot be seen by the target user.

Stringoptional
Logo's caption textlogo caption

A text caption to be displayed under the logo. Use of this field is discouraged, unless there is something of monumental importance to be said. Deletion notification templates go here as well.

Unbalanced wikitextoptional
Imageimage

Name of an image pertaining the protocol or suite, such as a diagram. A file name is enough. Use only when absolutely necessary.

Fileoptional
Image sizeimage size

Size of the image. Number and a CSS unit of measurement is accepted. e.g. 250px, x64px or 250x64px. Defualts to 300px. Use only when absolutely necessary and try to keep it with in the vicinity of 300 pixels in width. Smaller images are hard to see and larger images resize the infobox.

Stringoptional
Image's alternative textimage alt

Alternative text in case the image cannot be displayed by the target web browser or cannot be seen by the target user.

Stringoptional
Image captioncaption

Caption text for the image. Must be present when the image is present.

Stringoptional
Purposepurpose

A short sentence explaining the purpose of the protocol or stack succintly. Use only when absolutely needed.

Stringoptional
Developer(s)developer

Names of entities who developed the protocol or worked in concert with the developers for publicizing the protocol.

Stringoptional
Introduction datedate

The date in which the protocol is introduced. Use {{start date and age}} template.

Stringoptional
Based onbased on

Names of protocols, standards or specification from which the protocol in question is derived.

Stringoptional
Influencedinfluenced

Name of protocols that derive from this protocol

Stringoptional
RFC(s)rfcs

RFC(s) describing this protocol

Stringoptional
Port(s)ports

TCP/UDP ports if used by the protocol

Stringoptional
OSI layerosilayer

OSI layer this protocol works in

Stringoptional
Associated hardwarehardware

Name of the hardware created specifically to work with this protocol.

Stringoptional

Example[edit source]

WebDAV
Communications protocol
Purpose Allows clients to perform remote Web content authoring operations
Developer(s) Jim Whitehead, Internet Engineering Task Force (IETF)
Introduced 1996; 28 years ago (1996)
Based on Hypertext Transfer Protocol (HTTP)
Influenced Delta-V, CalDAV, GroupDAV
OSI layer Application layer
Port(s) 80, 443
RFC(s) RFC 2518, RFC 4918
{{Infobox networking protocol
|title      = WebDAV
|is stack   = no
|purpose    = Allows clients to perform remote Web content authoring operations
|developer  = [[Jim Whitehead]], [[Internet Engineering Task Force]] (IETF)
|date       = {{Start date and age|1996}}
|based on   = [[Hypertext Transfer Protocol]] (HTTP)
|influenced = [[Delta-V]], [[CalDAV]], [[GroupDAV]]
|osilayer   = [[Application layer]]
|ports      = 80, 443
|rfcs       = RFC 2518, RFC 4918
}}

See also[edit source]