Difference between revisions of "Template:OOPM:Templates:Documentation:Shared:StandardTemplateHeader"

Revision as of 20:23, 9 April 2009

Meta

Purpose

Standardheader for inclusion with MediaWiki templates.

Synopsis

Template Usage:
<noinclude>
{{Template:OOPM:Templates:Documentation:Shared:StandardTemplateHeader:1.0
|deprecated=true|false (optional)
|template=<WikiUrn>
|author=<AuthorName>
|created=<Date>
|purpose=<WikiMarkup>
|synopsis=<Synopsis>
|parameters=<WikiMarkup>
|preview=<WikiMarkup>
}}
</noinclude>

Parameter Reference

• deprecated (optional)

when true, the template will display a *deprecated template notice* on the template's page.

note that you will still have to include the deprecation notice template in your own template

in order to notify the user of its deprecation on the page that will use the template

• template

The urn of the template. This will be used for display in for example the deprecation notice.

E.g. Template:OOPM:Templates:Documentation:Shared:CategoryPageHeader:1.0

• author

the author's name and provably also his or her email address, e.g. Foo Bar "foobar" <foobar@test.org>

• created

the date of initial creation in YYYY-MM-DD format

• purpose

a purpose statement

• synopsis

the usage synopsis, e.g. the actual template call omitting the surrounding double curly brackets

• parameters

a parameter reference where required

• preview (optional)

an optional preview of the template

Preview

IMPORTANT NOTICE: Do not edit nor create the below dummy links.

The template uses itself as a basis for its layout.