Difference between revisions of "Template:Infobox bug/sandbox/doc"

From blackwiki
Jump to navigation Jump to search
imported>BrandonXLF
imported>BrandonXLF
Line 137: Line 137:
 
<templatedata>
 
<templatedata>
 
{
 
{
  "description": "Used to add an infobox to article about software bugs, vulnerabilities and security bugs.",
+
"description": "Used to add an infobox to article about software bugs, vulnerabilities and security bugs.",
  "format": "block",
+
"format": "block",
  "params": {
+
"params": {
    "name": {
+
"name": {
      "label": "Name",
+
"label": "Name",
      "description": "The name of the bug",
+
"description": "The name of the bug",
      "example": "Shellshock",
+
"example": "Shellshock",
      "autovalue": "{{BASEPAGENAME}}"
+
"autovalue": "{{BASEPAGENAME}}",
    },
+
"type": "wiki-page-name"
    "logo": {
+
},
      "label": "Logo",
+
"logo": {
      "description": "The logo of the bug",
+
"label": "Logo",
      "example": "example.png"
+
"description": "The logo of the bug",
    },
+
"example": "example.png",
    "logo size": {
+
"type": "wiki-file-name",
      "label": "Logo size",
+
"autovalue": "",
      "description": "The size of the logo",
+
"suggested": true
      "example": "180px"
+
},
    },
+
"logo size": {
    "logo alt": {
+
"label": "Logo size",
      "label": "Logo alt",
+
"description": "The size of the logo",
      "description": "Alternate text for the logo"
+
"example": "180px",
    },
+
"type": "number"
    "logo caption": {
+
},
      "label": "Logo alt",
+
"logo alt": {
      "description": "Caption for the logo",
+
"label": "Logo alt",
      "example": "A simple Shellshock logo, similar to the [[Heartbleed]] bug logo"
+
"description": "Alternate text for the logo",
    },
+
"type": "string"
    "image": {
+
},
      "label": "Image",
+
"logo caption": {
      "description": "The image of the bug",
+
"label": "Logo caption",
      "example": "example.png"
+
"description": "Caption for the logo",
    },
+
"example": "A simple Shellshock logo, similar to the [[Heartbleed]] bug logo",
    "image size": {
+
"type": "string"
      "label": "Image size",
+
},
      "description": "The size of the image",
+
"image": {
      "example": "180px"
+
"label": "Image",
    },
+
"description": "The image of the bug",
    "image alt": {
+
"example": "example.png",
      "label": "Image alt",
+
"type": "wiki-file-name"
      "description": "Alternate text for the image"
+
},
    },
+
"image size": {
    "image caption": {
+
"label": "Image size",
      "label": "Image alt",
+
"description": "The size of the image",
      "description": "Caption for the image"
+
"example": "180px",
    },
+
"type": "number"
    "screenshot": {
+
},
      "label": "Screenshot",
+
"image alt": {
      "description": "The screenshot of the bug",
+
"label": "Image alt",
      "example": "example.png"
+
"description": "Alternate text for the image",
    },
+
"type": "string"
    "screenshot size": {
+
},
      "label": "Screenshot size",
+
"image caption": {
      "description": "The size of the screenshot",
+
"label": "Image caption",
      "example": "180px"
+
"description": "Caption for the image",
    },
+
"type": "string"
    "screenshot alt": {
+
},
      "label": "Screenshot alt",
+
"screenshot": {
      "description": "Alternate text for the screenshot"
+
"label": "Screenshot",
    },
+
"description": "The screenshot of the bug",
    "screenshot caption": {
+
"example": "example.png",
      "label": "Screenshot alt",
+
"type": "wiki-file-name",
      "description": "Caption for the screenshot"
+
"suggested": true
    },
+
},
    "CVE": {
+
"screenshot size": {
      "aliases": ["cve"],
+
"label": "Screenshot size",
      "label": "Common identification(s)",
+
"description": "The size of the screenshot",
      "description": "Common Vulnerabilities and Exposures (CVE) identification(s) for the bug",
+
"example": "180px",
      "example": "CVE-XXXX-YYYY"
+
"type": "number"
    },
+
},
    "discovered": {
+
"screenshot alt": {
      "label": "Discovery date",
+
"label": "Screenshot alt",
      "description": "Year and/or date of discovery",
+
"description": "Alternate text for the screenshot",
      "example": "{{Start date and age|2019|1|20}}"
+
"type": "string"
    },
+
},
    "patched": {
+
"screenshot caption": {
      "label": "patch date",
+
"label": "Screenshot caption",
      "description": "Year and/or date of patch release",
+
"description": "Caption for the screenshot",
      "example": "{{Start date and age|2019|1|21}}"
+
"type": "string"
    },
+
},
    "discovered by": {
+
"CVE": {
      "label": "Discovered by",
+
"aliases": [
      "description": "Discoverer of the bug",
+
"cve"
      "example": "[[John Smith]]"
+
],
    },
+
"label": "Common identification(s)",
    "affected hardware": {
+
"description": "Common Vulnerabilities and Exposures (CVE) identification(s) for the bug",
      "label": "Affected hardware",
+
"example": "CVE-XXXX-YYYY",
      "description": "Hardware affected by the bug",
+
"type": "string",
      "example": "[[Qualcomm Snapdragon]]"
+
"suggested": true
    },
+
},
    "affected software": {
+
"discovered": {
      "label": "Affected software",
+
"label": "Discovery date",
      "description": "Software affected by the bug" ,
+
"description": "Year and/or date of discovery",
      "example": "[[macOS]]"
+
"example": "{{Start date and age|2019|1|20}}",
    },
+
"type": "date",
    "used by": {
+
"suggested": true
      "label": "Used by",
+
},
      "description": "Know groups/people who use(d) the exploit"
+
"patched": {
    },
+
"label": "Patch date",
    "website": {
+
"description": "Year and/or date of patch release",
      "label": "Website",
+
"example": "{{Start date and age|2019|1|21}}",
      "description": "Website for the bug",
+
"type": "date",
      "example": "{{URL|http://heartbleed.com/}}"
+
"suggested": true
    }
+
},
  }
+
"discovered by": {
 +
"label": "Discovered by",
 +
"description": "Discoverer of the bug",
 +
"example": "[[John Smith]]",
 +
"type": "string"
 +
},
 +
"affected hardware": {
 +
"label": "Affected hardware",
 +
"description": "Hardware affected by the bug",
 +
"example": "[[Qualcomm Snapdragon]]",
 +
"type": "string"
 +
},
 +
"affected software": {
 +
"label": "Affected software",
 +
"description": "Software affected by the bug",
 +
"example": "[[macOS]]",
 +
"type": "string"
 +
},
 +
"used by": {
 +
"label": "Used by",
 +
"description": "Know groups/people who use(d) the exploit",
 +
"type": "string"
 +
},
 +
"website": {
 +
"label": "Website",
 +
"description": "Website for the bug",
 +
"example": "{{URL|http://heartbleed.com/}}",
 +
"type": "url",
 +
"suggested": true
 +
}
 +
}
 
}
 
}
 
</templatedata>
 
</templatedata>

Revision as of 01:05, 22 February 2019

This infobox is used to add an infobox to article about software bugs, vulnerabilities and security bugs.

Parameters

Template:Parameter names example

Template:Pre2 Template:Pre2

Examples

Heartbleed
CVE identifier(s)CVE-2014-0160
Date discoveredTemplate:Start date and age
Date patchedTemplate:Start date and age
Affected softwareOpenSSL (1.0.1)
WebsiteTemplate:URL
Template:Pre2
Shellshock
CVE identifier(s)CVE-2014-6271

CVE-2014-6277 CVE-2014-6278 CVE-2014-7169 CVE-2014-7186

CVE-2014-7187
Date discoveredTemplate:Start date and age
Date patchedTemplate:Start date and age
Affected softwareGNU Bash (1.0.3–2.05b)
Template:Pre2

Template data

Used to add an infobox to article about software bugs, vulnerabilities and security bugs.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Namename

The name of the bug

Example
Shellshock
Auto value
{{BASEPAGENAME}}
Pageoptional
Logologo

The logo of the bug

Example
example.png
Auto value
Filesuggested
Logo sizelogo size

The size of the logo

Example
180px
Numberoptional
Logo altlogo alt

Alternate text for the logo

Stringoptional
Logo captionlogo caption

Caption for the logo

Example
A simple Shellshock logo, similar to the [[Heartbleed]] bug logo
Stringoptional
Imageimage

The image of the bug

Example
example.png
Fileoptional
Image sizeimage size

The size of the image

Example
180px
Numberoptional
Image altimage alt

Alternate text for the image

Stringoptional
Image captionimage caption

Caption for the image

Stringoptional
Screenshotscreenshot

The screenshot of the bug

Example
example.png
Filesuggested
Screenshot sizescreenshot size

The size of the screenshot

Example
180px
Numberoptional
Screenshot altscreenshot alt

Alternate text for the screenshot

Stringoptional
Screenshot captionscreenshot caption

Caption for the screenshot

Stringoptional
Common identification(s)CVE cve

Common Vulnerabilities and Exposures (CVE) identification(s) for the bug

Example
CVE-XXXX-YYYY
Stringsuggested
Discovery datediscovered

Year and/or date of discovery

Example
{{Start date and age|2019|1|20}}
Datesuggested
Patch datepatched

Year and/or date of patch release

Example
{{Start date and age|2019|1|21}}
Datesuggested
Discovered bydiscovered by

Discoverer of the bug

Example
[[John Smith]]
Stringoptional
Affected hardwareaffected hardware

Hardware affected by the bug

Example
[[Qualcomm Snapdragon]]
Stringoptional
Affected softwareaffected software

Software affected by the bug

Example
[[macOS]]
Stringoptional
Used byused by

Know groups/people who use(d) the exploit

Stringoptional
Websitewebsite

Website for the bug

Example
{{URL|http://heartbleed.com/}}
URLsuggested

Tracking category

See also