Difference between revisions of "Template:Fixbox/Documentation"
From PCGamingWiki, the wiki about fixing PC games
m (improved docs) |
m (various changes + added one-line fixbox) |
||
| Line 4: | Line 4: | ||
* The title need to summarize what the fix/workaround is trying to accomplish. | * The title need to summarize what the fix/workaround is trying to accomplish. | ||
| − | |||
* For sequenced instructions, use <code>#</code> to label each step. | * For sequenced instructions, use <code>#</code> to label each step. | ||
** <code>#</code> allows numbered lists to be dynamic. | ** <code>#</code> allows numbered lists to be dynamic. | ||
** Ex. If new entries are placed in the middle of a list, the old entries are automatically re-numbered. | ** Ex. If new entries are placed in the middle of a list, the old entries are automatically re-numbered. | ||
| − | ''' | + | |
| + | '''Standard fixbox''' | ||
| + | |||
| + | {{Fixbox|description=Name|ref=<ref>Reference</ref>|fix= | ||
| + | --instructions go here-- | ||
| + | }} | ||
| + | |||
<pre><nowiki> | <pre><nowiki> | ||
{{Fixbox|description=Name|ref=<ref>Reference</ref>|fix= | {{Fixbox|description=Name|ref=<ref>Reference</ref>|fix= | ||
| Line 15: | Line 20: | ||
}} | }} | ||
</nowiki></pre> | </nowiki></pre> | ||
| + | |||
| + | |||
| + | '''One-line fixbox''' | ||
| + | |||
| + | For a short one-line fixbox where instructions are not necessary, the {{Code|fix}} parameter can be excluded entirely: | ||
| + | |||
| + | {{Fixbox|description=Use windowed mode, see [[#Video|Video]].|ref=<ref>Reference</ref>}} | ||
| + | |||
| + | <pre><nowiki> | ||
| + | {{Fixbox|description=Use windowed mode, see [[#Video|Video]].|ref=<ref>Reference</ref>}} | ||
| + | </nowiki></pre> | ||
| + | |||
'''Collapsed fixbox''' | '''Collapsed fixbox''' | ||
| Line 29: | Line 46: | ||
}} | }} | ||
</nowiki></pre> | </nowiki></pre> | ||
| + | |||
{{References}} | {{References}} | ||
Revision as of 19:16, 14 August 2022
Description
The Fixbox is a specialized container used exclusively for fixes, workarounds, and step-by-step instructions. It provides a formal base for them, as well as keeping the wiki clean.
- The title need to summarize what the fix/workaround is trying to accomplish.
- For sequenced instructions, use
#to label each step.#allows numbered lists to be dynamic.- Ex. If new entries are placed in the middle of a list, the old entries are automatically re-numbered.
Standard fixbox
| Name[1] |
|---|
|
--instructions go here-- |
{{Fixbox|description=Name|ref=<ref>Reference</ref>|fix=
--instructions go here--
}}
One-line fixbox
For a short one-line fixbox where instructions are not necessary, the fix parameter can be excluded entirely:
| Use windowed mode, see Video.[2] |
|---|
{{Fixbox|description=Use windowed mode, see [[#Video|Video]].|ref=<ref>Reference</ref>}}
Collapsed fixbox
Add |collapsed=yes to the template to have the fixbox appear as collapsed and require user input to expand.
| Name[3] |
|---|
|
--instructions go here-- |
{{Fixbox|description=Name|ref=<ref>Reference</ref>|collapsed=yes|fix=
--instructions go here--
}}