Template:Infobox bug/doc: Difference between revisions

Content deleted Content added
note Lua modules used, add template categories, misc formatting
added cat
 
(15 intermediate revisions by 9 users not shown)
Line 1:
{{Documentation subpage}}
{{For2|an infobox for bugs (as in viruses and bacteria)|[[Template:Virusbox]], [[Template:Taxobox]] and [[Template:Automatic taxobox]]|an infobox for bugs (as in small insects)|[[Template:Taxobox]] and [[Template:Automatic taxobox]]}}
{{For-text|an infobox for bugs (as in viruses and bacteria)|[[Template:Virusbox]], [[Template:Taxobox]] and [[Template:Automatic taxobox]]|an infobox for bugs (as in small insects)|[[Template:Taxobox]] and [[Template:Automatic taxobox]]}}
{{Lua|Module:Infobox|Module:InfoboxImage|Module:Check for unknown parameters}}
 
This infobox is used to add an infobox to article about [[software bug]]s, [[vulnerability (computing)|vulnerabilities]] and [[security bug]]s.
 
== ParametersUsage ==
 
{{Parameter names example | name | image | image_size | alt | caption | screenshot | screenshot_size | screenshot_alt | screenshot_caption | CVE | CVSS| discovered | disclosed | patched | discoverer | affected hardware | affected software | used by | website }}
<syntaxhighlight lang="wikitext" style="overflow: auto;">
 
{{Infobox bug
{|
|- style="vertical-align:top;"
| {{Pre2|scroll|2=
<nowiki>{{Infobox bug
| name =
| image =
Line 21 ⟶ 19:
| screenshot_alt =
| screenshot_caption =
| CVE =
| CVSS =
| discovered =
| disclosed =
| patched =
| discoverer =
Line 29:
| used by =
| website =
}}</nowiki>
}}
| {{Pre2|scroll|2=
&nbsp;
The name of the bug
The logo of the bug or any image
The size of the image
Alternate text for the image
Caption for the image
Screenshot of the bug
The size of the screenshot
Alternate text for the screenshot
Caption for the screenshot
CVE ([[Common Vulnerabilities and Exposures]]) identification (example: [https://cve.mitre.org/cgi-bin/cvename.cgi?name=cve-2014-0160 CVE-2014-0160])
Date of discovery (use {{tl|Start date and age}})
Date of patch release (use {{tl|Start date and age}})
Discoverer
Affected hardware
Affected software
&nbsp;
Website for the bug (use {{tl|URL}})
&nbsp;
}}
</syntaxhighlight>
 
== Parameters ==
{| class="wikitable"
|+ Infobox bug parameters and basic guidelines
! scope="col" | Parameter
! scope="col" | Explanation
|-
! scope="row" | name
| The name of the bug
|-
! scope="row" | image
| The logo of the bug or any image
|-
! scope="row" | image_size
| The size of the image
|-
! scope="row" | alt
| Alternate text for the image
|-
! scope="row" | caption
| Caption for the image
|-
! scope="row" | screenshot
| Screenshot of the bug
|-
! scope="row" | screenshot_size
| The size of the screenshot
|-
! scope="row" | screenshot_alt
| Alternate text for the screenshot
|-
! scope="row" | screenshot_caption
| Caption for the screenshot
|-
! scope="row" | CVE
| CVE ([[Common Vulnerabilities and Exposures]]) identification (example: [https://cve.mitre.org/cgi-bin/cvename.cgi?name=cve-2014-0160 CVE-2014-0160])
|-
! scope="row" | CVSS
| CVE ([[Common Vulnerability Scoring System]]) (example: CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N)
|-
! scope="row" | discovered
| Date of discovery (use {{tl|Start date and age}})
|-
! scope="row" | disclosed
| Date of public disclosure (use {{tl|Start date and age}})
|-
! scope="row" | patched
| Date of patch release (use {{tl|Start date and age}})
|-
! scope="row" | discoverer
| Discoverer
|-
! scope="row" | affected hardware
| Affected hardware
|-
! scope="row" | affected software
| Affected software
|-
! scope="row" | used by
|
|-
! scope="row" | website
| Website for the bug (use {{tl|URL}})
|}
 
Line 62 ⟶ 104:
| caption = Logo representing Heartbleed. Security company [[Codenomicon]] gave Heartbleed both a name and a logo, contrbuting to public awareness of the issue.
| CVE = [https://cve.mitre.org/cgi-bin/cvename.cgi?name=cve-2014-0160 CVE-2014-0160]
| CVSS = CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N
| discovered = {{Start date and age|2014|4|1}}
| discovered = {{Start date and age|2014|4|3}}
| disclosed = {{Start date and age|2014|4|7}}
| patched = {{Start date and age|2014|4|7}}
| discoverer = Neel Mehta
Line 71 ⟶ 115:
{|
|-
|{{Pre2Pre|scroll|21=
<nowiki>{{Infobox bug
| name = Heartbleed
Line 78 ⟶ 122:
| caption = Logo representing Heartbleed. Security company [[Codenomicon]] gave Heartbleed both a name and a logo, contrbuting to public awareness of the issue.
| CVE = [https://cve.mitre.org/cgi-bin/cvename.cgi?name=cve-2014-0160 CVE-2014-0160]
| CVSS = CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N
| discovered = {{Start date and age|2014|4|1}}
| discovered = {{Start date and age|2014|4|3}}
| disclosed = {{Start date and age|2014|4|7}}
| patched = {{Start date and age|2014|4|7}}
| discoverer = Neel Mehta
Line 88 ⟶ 134:
 
== Tracking category ==
* {{clcCategory link with count|Category:Pages using Template:Infoboxinfobox bug with unknown parameters}}
 
== TemplateData ==
{{TemplateData header}}
<templatedata>
{
"params": {
"name": {
"label": "Name",
"description": "The name of the bug",
"type": "string",
"required": true
},
"image": {
"label": "Image",
"description": "The logo of the bug, or any relevant image.",
"type": "wiki-file-name",
"suggested": true
},
"image_size": {
"label": "Image size",
"description": "Size of the image, in pixels.",
"example": "180px",
"type": "string",
"suggested": true
},
"alt": {
"label": "Alt text",
"description": "Alternate text for the image (see [[Wikipedia:Manual of Style/Accessibility/Alternative text for images]]).",
"type": "content"
},
"caption": {
"label": "Caption",
"description": "Caption of the image.",
"type": "content",
"suggested": true
},
"screenshot": {
"label": "Screenshot",
"description": "A screenshot of the bug.",
"type": "wiki-file-name"
},
"screenshot_size": {
"label": "Screenshot size",
"description": "The size of the screenshot, in pixels.",
"type": "string"
},
"screenshot_alt": {
"label": "Screenshot alt text",
"description": "Alternate text for the screenshot.",
"type": "content"
},
"screenshot_caption": {
"label": "Screenshot caption",
"description": "Caption for the screenshot.",
"type": "content"
},
"CVE": {
"description": "CVE (Common Vulnerabilities and Exposures) identification.",
"example": "[https://cve.mitre.org/cgi-bin/cvename.cgi?name=cve-2014-0160 CVE-2014-0160]",
"type": "content",
"suggested": true
},
"released": {
"label": "Released"
},
"discovered": {
"label": "Date of discovery",
"description": "The date when the bug was discovered. Use {{Start date and age}}.",
"type": "string"
},
"disclosed": {
"label": "Date of public disclosure",
"description": "The date when the bug was publicly disclosed. Use {{Start date and age}}.",
"type": "string"
},
"patched": {
"label": "Patch release",
"description": "Date of patch release. Use {{Start date and age}}.",
"type": "string"
},
"discoverer": {
"label": "Discoverer",
"description": "Discoverer of the bug.",
"type": "string"
},
"affected hardware": {
"label": "Affected hardware",
"description": "The hardware that the bug affects.",
"type": "content"
},
"affected software": {
"label": "Affected software",
"description": "The software the bug affects.",
"type": "content"
},
"used by": {
"label": "Used by"
},
"website": {
"label": "Website",
"description": "Website for the bug (use {{URL}})",
"type": "string"
}
},
"format": "block",
"description": "This infobox is used to add an infobox to article about software bugs, vulnerabilities and security bugs."
}
</templatedata>
 
== See also ==
Line 98 ⟶ 252:
[[Category:Computing infobox templates]]
[[Category:Templates that add a tracking category]]
[[Category:Software infobox templates]]
}}</includeonly>