Changes
Jump to navigation
Jump to search
Template:Infobox networking protocol/doc (view source)
Revision as of 15:16, 12 January 2016
, 15:16, 12 January 2016fix code
{{documentation subpage}}
== Usage ==
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]]. {{para|logo caption}} is deliberately omitted to discourage the use of this oft-abused parameter.
{{Parameter names example|_template=|title|name|is stack|logo|logo size|logo alt|logo caption|image|image size|image alt|caption|purpose|developer|date|based on|influenced|osilayer|ports|rfcs|hardware}}
<pre style="overflow:auto;">
{{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 =
}}
</pre>
==Syntax==
{{TemplateDataHeader}}
<templatedata>
{
"description": "This infobox helps display important preliminary details about a protocol in an article.",
"params": {
"title": {
"aliases": [
"name"
],
"label": "Title or name",
"description": "Title or name of the subject of infobox focus.",
"type": "string",
"required": true
},
"is stack": {
"label": "Is stack?",
"description": "If set to \"yes\" specifies whether the article is about a protocol stack, instead of a communications protocol",
"type": "boolean",
"autovalue": "yes"
},
"logo": {
"label": "Logo",
"description": "Name of the image pertaining the logo of the protocol or suite. A file name is enough.",
"type": "wiki-file-name",
"autovalue": ""
},
"logo size": {
"label": "Logo size",
"description": "Size of the logo. Number and a CSS unit of measurement is accepted. e.g. 250px, x64px or 250x64px.",
"type": "string"
},
"logo alt": {
"label": "Logo's alternative text",
"description": "Alternative text in case the logo cannot be displayed by the target web browser or cannot be seen by the target user.",
"type": "string"
},
"logo caption": {
"label": "Logo's caption text",
"description": "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.",
"type": "unbalanced-wikitext"
},
"image": {
"label": "Image",
"description": "Name of an image pertaining the protocol or suite, such as a diagram. A file name is enough. Use only when absolutely necessary.",
"type": "wiki-file-name"
},
"image size": {
"label": "Image size",
"description": "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.",
"type": "string"
},
"image alt": {
"label": "Image's alternative text",
"description": "Alternative text in case the image cannot be displayed by the target web browser or cannot be seen by the target user.",
"type": "string"
},
"caption": {
"label": "Image caption",
"description": "Caption text for the image. Must be present when the image is present.",
"type": "string"
},
"purpose": {
"label": "Purpose",
"description": "A short sentence explaining the purpose of the protocol or stack succintly. Use only when absolutely needed.",
"type": "string"
},
"developer": {
"label": "Developer(s)",
"description": "Names of entities who developed the protocol or worked in concert with the developers for publicizing the protocol.",
"type": "string"
},
"date": {
"label": "Introduction date",
"description": "The date in which the protocol is introduced. Use {{start date and age}} template.",
"type": "string"
},
"based on": {
"label": "Based on",
"description": "Names of protocols, standards or specification from which the protocol in question is derived.",
"type": "string"
},
"influenced": {
"label": "Influenced",
"description": "Name of protocols that derive from this protocol",
"type": "string"
},
"rfcs": {
"label": "RFC(s)",
"type": "string",
"deprecated": false,
"description": "RFC(s) describing this protocol"
},
"ports": {
"label": "Port(s)",
"type": "string",
"deprecated": false,
"description": "TCP/UDP ports if used by the protocol"
},
"osilayer": {
"label": "OSI layer",
"type": "string",
"deprecated": false,
"description": "OSI layer this protocol works in"
},
"hardware": {
"label": "Associated hardware",
"description": "Name of the hardware created specifically to work with this protocol.",
"type": "string"
}
}
}
</templatedata>
== Example ==
{{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
}}
<pre style="overflow:auto;">
{{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
}}</pre>
{{reflist}}
{{Clear}}
== See also ==
* {{Lts|Infobox software}} for [[software]]
* {{Lts|Infobox web browser}} for [[web browser]]s
* {{Lts|Infobox OS}} for [[operating systems]]
* {{Lts|Infobox VG}} for [[video games|games]]
* {{Lts|Infobox website}} for [[website]]s and [[web application]]s
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Software infobox templates|Networking Protocol]]
[[Category:Computer networking templates]]
}}</includeonly>
== Usage ==
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]]. {{para|logo caption}} is deliberately omitted to discourage the use of this oft-abused parameter.
{{Parameter names example|_template=|title|name|is stack|logo|logo size|logo alt|logo caption|image|image size|image alt|caption|purpose|developer|date|based on|influenced|osilayer|ports|rfcs|hardware}}
<pre style="overflow:auto;">
{{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 =
}}
</pre>
==Syntax==
{{TemplateDataHeader}}
<templatedata>
{
"description": "This infobox helps display important preliminary details about a protocol in an article.",
"params": {
"title": {
"aliases": [
"name"
],
"label": "Title or name",
"description": "Title or name of the subject of infobox focus.",
"type": "string",
"required": true
},
"is stack": {
"label": "Is stack?",
"description": "If set to \"yes\" specifies whether the article is about a protocol stack, instead of a communications protocol",
"type": "boolean",
"autovalue": "yes"
},
"logo": {
"label": "Logo",
"description": "Name of the image pertaining the logo of the protocol or suite. A file name is enough.",
"type": "wiki-file-name",
"autovalue": ""
},
"logo size": {
"label": "Logo size",
"description": "Size of the logo. Number and a CSS unit of measurement is accepted. e.g. 250px, x64px or 250x64px.",
"type": "string"
},
"logo alt": {
"label": "Logo's alternative text",
"description": "Alternative text in case the logo cannot be displayed by the target web browser or cannot be seen by the target user.",
"type": "string"
},
"logo caption": {
"label": "Logo's caption text",
"description": "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.",
"type": "unbalanced-wikitext"
},
"image": {
"label": "Image",
"description": "Name of an image pertaining the protocol or suite, such as a diagram. A file name is enough. Use only when absolutely necessary.",
"type": "wiki-file-name"
},
"image size": {
"label": "Image size",
"description": "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.",
"type": "string"
},
"image alt": {
"label": "Image's alternative text",
"description": "Alternative text in case the image cannot be displayed by the target web browser or cannot be seen by the target user.",
"type": "string"
},
"caption": {
"label": "Image caption",
"description": "Caption text for the image. Must be present when the image is present.",
"type": "string"
},
"purpose": {
"label": "Purpose",
"description": "A short sentence explaining the purpose of the protocol or stack succintly. Use only when absolutely needed.",
"type": "string"
},
"developer": {
"label": "Developer(s)",
"description": "Names of entities who developed the protocol or worked in concert with the developers for publicizing the protocol.",
"type": "string"
},
"date": {
"label": "Introduction date",
"description": "The date in which the protocol is introduced. Use {{start date and age}} template.",
"type": "string"
},
"based on": {
"label": "Based on",
"description": "Names of protocols, standards or specification from which the protocol in question is derived.",
"type": "string"
},
"influenced": {
"label": "Influenced",
"description": "Name of protocols that derive from this protocol",
"type": "string"
},
"rfcs": {
"label": "RFC(s)",
"type": "string",
"deprecated": false,
"description": "RFC(s) describing this protocol"
},
"ports": {
"label": "Port(s)",
"type": "string",
"deprecated": false,
"description": "TCP/UDP ports if used by the protocol"
},
"osilayer": {
"label": "OSI layer",
"type": "string",
"deprecated": false,
"description": "OSI layer this protocol works in"
},
"hardware": {
"label": "Associated hardware",
"description": "Name of the hardware created specifically to work with this protocol.",
"type": "string"
}
}
}
</templatedata>
== Example ==
{{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
}}
<pre style="overflow:auto;">
{{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
}}</pre>
{{reflist}}
{{Clear}}
== See also ==
* {{Lts|Infobox software}} for [[software]]
* {{Lts|Infobox web browser}} for [[web browser]]s
* {{Lts|Infobox OS}} for [[operating systems]]
* {{Lts|Infobox VG}} for [[video games|games]]
* {{Lts|Infobox website}} for [[website]]s and [[web application]]s
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Software infobox templates|Networking Protocol]]
[[Category:Computer networking templates]]
}}</includeonly>
