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

From Apache OpenOffice Wiki
Jump to: navigation, search
Line 28: Line 28:
 
<noinclude>
 
<noinclude>
 
{{Template:OOPM:Templates:Documentation:Shared:StandardTemplateHeader:1.0
 
{{Template:OOPM:Templates:Documentation:Shared:StandardTemplateHeader:1.0
|deprecated=true|false (optional)
 
|template=<WikiUrn>
 
|alternate=<WikiUrn>
 
 
|author=<AuthorName>
 
|author=<AuthorName>
 
|created=<Date>
 
|created=<Date>
Line 43: Line 40:
 
=== Parameter Reference ===
 
=== 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 (currently optional)
 
: 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
 
* alternate (optional)
 
: The urn of the alternative template to be used instead. This will be used for display in
 
: the deprecation notice.
 
: E.g. Template:OOPM:Templates:Documentation:Shared:CategoryPageHeader:1.1
 
 
* author (should provide)
 
* author (should provide)
 
: the author's name and provably also his or her email address, e.g. Foo Bar "foobar" <foobar@test.org>
 
: the author's name and provably also his or her email address, e.g. Foo Bar "foobar" <foobar@test.org>
Line 79: Line 65:
 
<includeonly>
 
<includeonly>
 
__NOEDITSECTION__
 
__NOEDITSECTION__
 
{{#ifeq: {{{deprecated}}} | true | {{Template:OOPM:Templates:Documentation:Shared:StandardDeprecationNotice:1.0 | template= {{{template}}} | alternate= {{{alternate}}} }}}}
 
  
 
== Meta ==
 
== Meta ==

Revision as of 20:35, 9 April 2009


Meta

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

Purpose

Standardheader for inclusion with MediaWiki templates.

Synopsis

Template Usage:
<noinclude>
{{Template:OOPM:Templates:Documentation:Shared:StandardTemplateHeader:1.0
|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

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

The template uses itself as a basis for its layout.

Personal tools