Log in Discussion History Go to the site toolbox

Template talk:Doctl

From BluWiki

Purpose

{{doctl}} inserts boilerplate for consistent documentation of a template on its own Talk page. Once inserted, it must be edited to include specific information.

Usage

  • Step 1:

{{subst:doctl|template}}

The only parameter is the name of the template you are documenting.

  • Step 2:

Save the Talk page. Do not use preview. You must save in order to evaluate the subst: atom.

  • Step 3:

Re-edit the Talk page. In the section Purpose, give a clear statement of the purpose of the template you are documenting. Use it in a sentence. In the section Usage, adjust the number of parameters and explain what each one does. If your template takes no parameters, delete that word. Note that the Usage section makes use of HTML entities; be careful editing between them. Finally, in the section History, add an appropriate entry -- if this is a new template, insert the line "Created ~~~~"; if you are documenting an existing template, insert the line "Documentation added ~~~~".

History

Imported from WPSinatra*email*talk 18:03, 1 Aug 2005 (EDT)

What it makes

The template generates the text inside the following box:

Purpose

{{[[template:{{{1}}}|{{{1}}}]]}}


Usage

{{{{{1}}}|params}}


Example

{{{{{1}}}}}


History

Created


Discussion

Site Toolbox:

Personal tools
GNU Free Documentation License 1.2
This page was last modified on 1 May 2008, at 10:23.
Disclaimers - About BluWiki