v50 Steam/Premium information for editors
  • v50 information can now be added to pages in the main namespace. v0.47 information can still be found in the DF2014 namespace. See here for more details on the new versioning policy.
  • Use this page to report any issues related to the migration.
This notice may be cached—the current version can be found here.

Difference between revisions of "Template:Bug/doc"

From Dwarf Fortress Wiki
Jump to navigation Jump to search
m (add "workaround in comments" description)
m (rm cats)
Line 7: Line 7:
 
The first parameter is the number of the bug on the bug tracker. Leading 0's aren't necessary.
 
The first parameter is the number of the bug on the bug tracker. Leading 0's aren't necessary.
 
<pre>{{bug|296}}</pre>
 
<pre>{{bug|296}}</pre>
{{bug|296}}
+
{{bug|296|cat=nocat}}
  
 
An optional parameter is a link to the workaround. This should be used temporarily, while the bug is '''not''' fixed. If the bug is fixed, remove it from the article. ([[Dwarf fortress wiki:Community Portal#T|Rule T]])
 
An optional parameter is a link to the workaround. This should be used temporarily, while the bug is '''not''' fixed. If the bug is fixed, remove it from the article. ([[Dwarf fortress wiki:Community Portal#T|Rule T]])
Line 13: Line 13:
 
Note that this parameter is '''named'''. You need to use <code><nowiki>workaround=http://...</nowiki></code>, not just the link as the second parameter.
 
Note that this parameter is '''named'''. You need to use <code><nowiki>workaround=http://...</nowiki></code>, not just the link as the second parameter.
 
<pre>{{bug|6290|workaround=http://www.bay12forums.com/smf/index.php?topic=122782.0}}</pre>
 
<pre>{{bug|6290|workaround=http://www.bay12forums.com/smf/index.php?topic=122782.0}}</pre>
{{bug|6290|workaround=http://www.bay12forums.com/smf/index.php?topic=122782.0}}
+
{{bug|6290|workaround=http://www.bay12forums.com/smf/index.php?topic=122782.0|cat=nocat}}
  
 
If the workaround is listed in the comments of the bug report, use <pre>{{bug|number|workaround=comments}}</pre>
 
If the workaround is listed in the comments of the bug report, use <pre>{{bug|number|workaround=comments}}</pre>
  
{{bug|1|workaround=comments}}
+
{{bug|1|workaround=comments|cat=nocat}}
  
 
===Linking to an article's "bugs" section===
 
===Linking to an article's "bugs" section===
  
Some articles have a separate section for bugs. Using this template without a bug number will link to that section. For example, <pre>{{bug}}</pre> produces this: {{bug}}
+
Some articles have a separate section for bugs. Using this template without a bug number will link to that section. For example, <pre>{{bug}}</pre> produces this: {{bug|cat=nocat}}
  
If the section title containing bugs is something other than "Bugs", specify this in the <code>section</code> parameter. <pre>{{bug|section=Usage}}</pre> produces this: {{bug|section=Usage}} (this should jump to the Usage section of this documentation, which does not actually contain bugs).
+
If the section title containing bugs is something other than "Bugs", specify this in the <code>section</code> parameter. <pre>{{bug|section=Usage}}</pre> produces this: {{bug|section=Usage|cat=nocat}} (this should jump to the Usage section of this documentation, which does not actually contain bugs).
  
 
==Bugs==
 
==Bugs==
This is a sample section, which would ideally contain bugs in a real article. It is here to serve as an example for linking to the bugs section.
+
This is a sample section, which would contain bugs in a real article. It is here to serve as an example for linking to the bugs section.
 
 
Sample bugs:
 
 
 
{{bug|1}}
 
 
 
{{bug|2}}
 
 
 
{{bug|3}}
 
 
 
{{bug|4}}
 
 
 
{{bug|5}}
 
 
 
{{bug|6}}
 
 
 
{{bug|7}}
 
 
 
{{bug|8}}
 
 
 
{{bug|1}}
 
 
 
{{bug|2}}
 
 
 
{{bug|3}}
 
 
 
{{bug|4}}
 
 
 
{{bug|5}}
 
 
 
{{bug|6}}
 
 
 
{{bug|7}}
 
 
 
{{bug|8}}
 
 
 
{{bug|1}}
 
 
 
{{bug|2}}
 
 
 
{{bug|3}}
 
 
 
{{bug|4}}
 
 
 
{{bug|5}}
 
 
 
{{bug|6}}
 
 
 
{{bug|7}}
 
 
 
{{bug|8}}
 

Revision as of 23:35, 7 March 2013

Used for linking to bugs on the Bug Tracker


Usage

The first parameter is the number of the bug on the bug tracker. Leading 0's aren't necessary.

{{bug|296}}

Bug:296

An optional parameter is a link to the workaround. This should be used temporarily, while the bug is not fixed. If the bug is fixed, remove it from the article. (Rule T)

Note that this parameter is named. You need to use workaround=http://..., not just the link as the second parameter.

{{bug|6290|workaround=http://www.bay12forums.com/smf/index.php?topic=122782.0}}

Bug:6290 (Workaround)

If the workaround is listed in the comments of the bug report, use

{{bug|number|workaround=comments}}

Bug:1 (Workaround in comments)

Linking to an article's "bugs" section

Some articles have a separate section for bugs. Using this template without a bug number will link to that section. For example,

{{bug}}

produces this: Bug If the section title containing bugs is something other than "Bugs", specify this in the section parameter.

{{bug|section=Usage}}

produces this: Bug (this should jump to the Usage section of this documentation, which does not actually contain bugs).

Bugs

This is a sample section, which would contain bugs in a real article. It is here to serve as an example for linking to the bugs section.