Template talk:Helpbox
From BluWiki
Contents |
Purpose
{{helpbox}} is a toolmaker's tool. Templates, like any other code, should be documented (as this template is on this page). For standard templates generated with {{box}}, {{helpbox}} provides a compact, standard link to docs.
Compare {{tl}}, which generates copyable markup which doubles as a clickable link. As useful as this is, the actual page of some templates is all but incomprehensible, as the markup source is rendered without required parameters.
Usage
{{helpbox|talkpage}}
Insert this template within <div> tags of a template for which you wish to provide documentation. The only parameter (required) is the name of the talk page on which the docs are to be found.
As this template floats right, you may wish to clear the float at some point; however, this has not yet been found necessary.
- Note that it is completely inappropriate to attach this helpbox to templates that do not generate a
<div>of some kind, with border and/or background. If thrown onto a page "loose", it will float all the way to the right of the main content area and appear unconnected to anything in particular.
- Note that to achieve standard position within the documented template, {{helpbox}} must appear as the first line of template content. See Example.
Example
This is how not to use it! →
History
Imported from WP. — "Bear" 09:17, 17 Nov 2005 (EST)
