Template:Bug

From Touhou Wiki
Jump to navigation Jump to search
Template documentation[view] [edit] [history] [purge]

This template is used to describe a bug.

Usage[edit]

It receives the following arguments:

{{Bug
| description      =A short description of the bug.
| affected         =Version(s) known to be affected by this bug.
| fixed            =Version that fixed the bug. (optional)
| long_description =How to reproduce the bug and further information. (optional but advised)
| check            =Flag the bug for suspicion or poor quality description. (optional, flag)
}}

Use <br /> tags to include multiple lines in the long description. See examples below.

Changelog[edit]

  • v0.2.0 Line bug fix and added check parameter. Drake Irving (talk) 08:57, 4 March 2018 (UTC)
  • v0.1.0 First release. Atanok 02:07, 3 September 2011 (UTC)
  • v0.0.0 Initial version.

Examples[edit]

  • My foo goes bar! Fixed: v1.00d <toggledisplay showtext="Show details" hidetext="Hide details">
    Affected: ≤v1.00b
    This bug was fixed, so the known affected versions are hidden under the details.
    The only way to include new lines seems to be <br> tags.
    This is another line.
    And another!</toggledisplay>
  • Silly bug. Affects: v1.00a→v1.00c <toggledisplay showtext="Show details" hidetext="Hide details">
    This bug has not been fixed yet, so it shows the affected versions in the first line.</toggledisplay>
  • Self-explanatory bug without long description. Affects: v1.00a,v1.00b
  • This is a simple bug that was fixed. Versions that were affected are under details. Fixed: v1.00b <toggledisplay showtext="Show details" hidetext="Hide details">
    Affected: v1.00a
    </toggledisplay>
  • Bug that sounds like it could be fake, has no evidence, or has poor documentation. Needs confirmation. Affects: unspecified <toggledisplay showtext="Show details" hidetext="Hide details">
    This is a reported bug that either does not describe how it could be replicated, is a bug that seems to have only affected the person who claims it without evidence, or is otherwise questionable for any reason.
    check parameter added by other editor to flag suspicion.</toggledisplay>

Wrong usage[edit]

Not providing a description:

  • No description. Affects: v1.00a <toggledisplay showtext="Show details" hidetext="Hide details">
    This bug has no short description.
    That should not happen.</toggledisplay>

Not providing affected versions:

  • I heard someone say this happened to a friend... Affects: unspecified <toggledisplay showtext="Show details" hidetext="Hide details">
    Every bug should have at least one affected version associated with it.</toggledisplay>

Template bugs and TODO[edit]

  • TODO: Remove all the silly <!-- --> usage in pages now that the bug below is fixed.
  • Too much space between consecutive bug lines. Fixed: v0.2.0 <toggledisplay showtext="Show details" hidetext="Hide details">
    Affected: ≤v0.1.0
    Using the bug template in consecutive lines should look like a bullet list, but a lot of vertical space appears between each bug.
    The current workaround for this problem is putting all the bugs on the same line.
    To use this workaround without making the article source unreadable you can comment out the newline(s) between the bugs with <!-- -->
    See this bug's source for a practical example.</toggledisplay>

BEFORE EDITING THIS TEMPLATE[edit]

Remember that this template is being used on other pages. Any changes you make should not:

  • Change existing argument names.
  • Introduce any new mandatory argument.
  • Radically change the template layout.

The following changes are welcome, after properly testing:

  • Introducing new features using optional arguments.
  • Sensible formatting and layout tweaks.

Testing should be done using the Sandbox Page and the Sandbox Template.