[WikiEN-l] Template documentation convention

[Steve Bennett]

On 20/04/06, Tim Starling <t.starling at physics.unimelb.edu.au> wrote:
> I've been thinking about introducing a tag which specifies that the source of the template should be
> displayed when you view the template page. There are a lot of meta-templates around where conversion
> to HTML with their default parameter values substituted in doesn't really tell you much about them.
> This would replace most uses for <includeonly>. Any comments on that?

Sounds great. Have a look at {{clearleft}} which I just "documented".
Such a tag would be very useful for templates like that.

> In any case, I would recommend documenting templates using <noinclude> sections, as long as the
> formatting is such that it is clear where the template stops and the documentation begins. I think
> that would be an improvement for usability, over using the talk page. The server overhead should be
> negligible (6ms per 100KB).

Cool. (this is the template section)<noinclude>
----
This is the documentation section.</noinclude>

Work for you?

Steve