Template:Resbox/doc
This is a documentation subpage for Template:Resbox. It contains usage information, categories, and other content that is not part of the original template page. |
Purpose
editThis is a wrapper template, to convert any of the large family of inline, comment-level templates, used for annotating process or discussion resolutions, into a bordered, discussion hatnote template of the {{Resolved}} style. The inline templates are most often used at the beginning of a reply, while the hatnotes are used immediately below the discussion heading. This wrapper permits the many more specific messages available at the inline level to be used at the thread level, where only a few such templates have been heretofore been available. The wrapper obviates the need to permanently duplicate any more of the inline ones as essentially redundant hatnote variants.
Usage
edit- Basic:
The first parameter is a (usually) a template:
{{Resbox|{{Fixed}}}}
produces:
- Fixed
You can even leave off the {{...}}
around the inline template, as long as you don't need to feed the inline template any parameters:
{{Resbox|Fixed}}
produces:
- Fixed
This parameter is also named |text=
for backward compatibility with the parameter that changes the wording of {{Resolved}}, e.g. {{Resolved|text=Fixed}}
:
{{Resbox|text=Fixed}}
produces:
- Fixed
- Arbitrary
If the text supplied doesn't match a template name, then it's simply turned into a comment in the box, with no icon:
{{Resbox|I have no idea what to, and have given up}}
produces:
- I have no idea what to, and have given up
- With inline template's parameters:
{{Resbox|{{Deferred|''after RfC concludes''.}}}}
produces:
Use |1=
if it fails because of an embedded =
character:
{{Resbox|{{Deferred|1=''after RfC concludes'' (= 17 June).}}}}
produces:
- With its own outside-the-box comment text:
{{Resbox|Fixed|I corrected that yesterday.}}
produces:
- Fixed
and:
{{Resbox|{{Deferred|after RfC concludes}}|Closure expected by January 20.}}
produces:
Parameter may be explicitly named as |2=
or |reason=
if it breaks due to an =
in the text:
{{Resbox|Wontfix|reason=A feature someone doesn't like != a bug.}}
produces:
- Wontfix
- Technically it can be used with other inline templates:
{{Resbox|talkfact}}
produces:
- talkfact
and
{{Resbox|Executed|You're killin' me!}}
produces:
- Executed