Template:OOPM:Templates:Documentation:Shared:StandardTemplateHeader

From Apache OpenOffice Wiki
Jump to: navigation, search


Meta

Template Name Template:OOPM:Templates:Documentation:Shared:StandardTemplateHeader
Author Carsten Klein "rts" <carsten.klein@abstraxion.de>
Created 2009-04-08
Edited 2009-005-08

Purpose

Standardheader for inclusion with MediaWiki templates.

Synopsis

Template Usage:
<noinclude>
{{Template:OOPM:Templates:Documentation:Shared:StandardTemplateHeader
|author=<AuthorName>
|created=<Date>
|purpose=<WikiMarkup>
|synopsis=<Synopsis>
|parameters=<WikiMarkup>
|preview=<WikiMarkup>
}}
</noinclude>

Parameter Reference

  • author (should provide)
the author's name and provably also his or her email address, e.g. Foo Bar "foobar" <foobar@test.org>
  • created (should provide)
the date of initial creation in YYYY-MM-DD format
  • purpose (should provide)
a purpose statement
  • synopsis (should provide)
the usage synopsis, e.g. the actual template call omitting the surrounding double curly brackets
  • parameters (should provide)
a parameter reference where required
  • preview (optional)
an optional preview of the template

Preview

See this template.

Personal tools