Difference between revisions of "Template:MACaddr/doc"

From blackwiki
Jump to navigation Jump to search
imported>Dandorid
imported>WOSlinker
m (add {{documentation subpage}})
 
(2 intermediate revisions by one other user not shown)
Line 1: Line 1:
 +
{{documentation subpage}}
 
==Introduction==
 
==Introduction==
 
Template <code><nowiki>{{MACaddr}}</nowiki></code> is used to make a [[MAC address]] stand out in the text, to improve readability.
 
Template <code><nowiki>{{MACaddr}}</nowiki></code> is used to make a [[MAC address]] stand out in the text, to improve readability.
The address is displayed in uppercase italics.
+
The address is displayed in uppercase italics to more easily differentiate visually between a MAC address and an IPv6 address.
  
 
==Arguments==
 
==Arguments==
 
The first parameter is the MAC address to be displayed.
 
The first parameter is the MAC address to be displayed.
Its octets should preferably be delimited with hyphens to more easily differentiate visually between a MAC address and an IPv6 address.
 
  
 
==Examples==
 
==Examples==
Line 13: Line 13:
  
 
<code><nowiki>{{MACaddr|3c0e.23e2.10b4}}</nowiki></code> yields: {{MACaddr|3c0e.23e2.10b4}} (periods: [[Cisco]] style).
 
<code><nowiki>{{MACaddr|3c0e.23e2.10b4}}</nowiki></code> yields: {{MACaddr|3c0e.23e2.10b4}} (periods: [[Cisco]] style).
 +
 +
==Template data==
 +
<templatedata>
 +
{
 +
    "description": "Template {{MACaddr}} is used to make a MAC address stand out in the text, to improve readability.",
 +
    "params": {
 +
        "1": {
 +
            "description": "The MAC address to display. A MAC address is displayed in italics, using upper case letters to distinguish them better from IPv6 addresses.",
 +
            "example": "10:dd:b1:b9:1b:f1 or 00-0c-29-05-89-d0",
 +
            "type": "string",
 +
            "required": true
 +
        }
 +
    }
 +
}
 +
</templatedata>
 +
==See also==
 +
 +
* [[Template:IPaddr|Template <nowiki>{{IPaddr}}</nowiki> for displaying IP addresses]].

Latest revision as of 19:00, 29 October 2018

Introduction

Template {{MACaddr}} is used to make a MAC address stand out in the text, to improve readability. The address is displayed in uppercase italics to more easily differentiate visually between a MAC address and an IPv6 address.

Arguments

The first parameter is the MAC address to be displayed.

Examples

{{MACaddr|00-0c-29-05-89-d0}} yields: 00-0C-29-05-89-D0 (dashes: IEEE style).

{{MACaddr|10:dd:b1:b9:1b:f1}} yields: 10:DD:B1:B9:1B:F1 (colons: Linux, MacOS style).

{{MACaddr|3c0e.23e2.10b4}} yields: 3C0E.23E2.10B4 (periods: Cisco style).

Template data

Template {{MACaddr}} is used to make a MAC address stand out in the text, to improve readability.

Template parameters

ParameterDescriptionTypeStatus
11

The MAC address to display. A MAC address is displayed in italics, using upper case letters to distinguish them better from IPv6 addresses.

Example
10:dd:b1:b9:1b:f1 or 00-0c-29-05-89-d0
Stringrequired

See also