Template:KnownIssue: Difference between revisions
Appearance
No edit summary |
No edit summary |
||
| (One intermediate revision by the same user not shown) | |||
| Line 9: | Line 9: | ||
included — renders exactly as it would anywhere else. | included — renders exactly as it would anywhere else. | ||
To link to known issues, reference it like so: | To link to known issues, reference it like so: [[Known_issues#KnownIssue33|issue 33: custom description]] or simply [[Known_issues#KnownIssue33|issue 33]]. | ||
=== Parameters === | === Parameters === | ||
Latest revision as of 11:06, 26 June 2026
Template:KnownIssue
One row of the Known Issues table. Place the calls between a hand-written table
header and footer (see Usage); each call emits one |- row.
The description (text) is rendered as raw wikitext, so any template
— TAG, FILE, multi-argument ones
included — renders exactly as it would anywhere else.
To link to known issues, reference it like so: issue 33: custom description or simply issue 33.
Parameters
| Parameter | Required | Description |
|---|---|---|
ID |
Recommended | Unique positive integer. Emits the row anchor #KnownIssueN for page links. If omitted the ID cell shows None on red; if non-integer it is flagged. Duplicate IDs are not caught here — add Template:KnownIssueDupCheck once on the page to detect them.
|
resolved_in_version |
No | VASP version where the issue was fixed, e.g. 6.4.0 — shown on a cyan background. Use - or omit for unresolved issues, shown as Open on red.
|
obsolete |
No | Set to yes to mark the issue obsolete: Version fixed shows Obsolete on grey (overrides resolved_in_version), and Version first noticed is grey too.
|
resolved_in_commit |
No | Commit hash of the fix, or -. Never rendered — for internal reference only.
|
reported_in_version |
Yes | VASP version where the issue was first noticed, e.g. 6.0.0 — shown on red (that version still has the issue), or grey if obsolete.
|
date_added |
No | Date the entry was added, e.g. 2025-06-11.
|
hide |
No | Set to yes (or 1/true) to hide the row from the table (rendered with display:none). It is still present in the page source, so Template:KnownIssueDupCheck still counts its ID.
|
anchor |
No | Defaults to true. Set to no to render the row without the #KnownIssueN anchor.
|
text |
Yes | The issue description, rendered as a raw table cell. Links, multi-argument templates (TAG) and markup all work, and may span multiple lines/paragraphs. For a literal pipe use | (a bare {{!}} would be read as a cell separator); avoid lines that begin with | or !.
|
Usage
You supply the table frame and header; add Template:KnownIssueDupCheck above it so duplicate IDs are reported.
{{KnownIssueDupCheck}}
{| class="sortable wikitable"
|-
! style="width:4em; text-align:center;" | ID
!! style="width:5em" | Version fixed
!! style="text-align:center;" | Version first noticed
!! Date
!! Description
{{KnownIssue
| ID = 73
| resolved_in_version = -
| resolved_in_commit = -
| reported_in_version = 6.0.0
| date_added = 2025-06-11
| text = '''Reading charge density from {{FILE|vaspwave.h5}} not implemented.''' Hence, it is not possible to restart a fixed density calculation ({{TAG|ICHARG|11}}) from a calculation that used {{TAG|LH5|.True.}}.
}}
|}
A live example lives on Template:KnownIssue/testcases (kept off this page so the template is not transcluded into itself).