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

From Apache OpenOffice Wiki
Jump to: navigation, search
(made this template a non versioned template)
 
(24 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
<noinclude>
 
<noinclude>
 
__NOEDITSECTION__
 
__NOEDITSECTION__
 
 
== Meta ==
 
== Meta ==
  
Line 27: Line 26:
 
Template Usage:
 
Template Usage:
 
&lt;noinclude>
 
&lt;noinclude>
{{Template:OOPM:Templates:Documentation:Shared:StandardTemplateHeader:1.0
+
{{Template:OOPM:Templates:Documentation:Shared:StandardTemplateHeader
|deprecated=true|false (optional)
+
|template=<WikiUrn>
+
 
|author=<AuthorName>
 
|author=<AuthorName>
 
|created=<Date>
 
|created=<Date>
Line 42: Line 39:
 
=== Parameter Reference ===
 
=== Parameter Reference ===
  
* deprecated (optional)
+
* author (should provide)
: 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>
 
: the author's name and provably also his or her email address, e.g. Foo Bar "foobar" <foobar@test.org>
* created
+
* created (should provide)
 
: the date of initial creation in YYYY-MM-DD format
 
: the date of initial creation in YYYY-MM-DD format
* purpose
+
* purpose (should provide)
 
: a purpose statement
 
: a purpose statement
* synopsis
+
* synopsis (should provide)
 
: the usage synopsis, e.g. the actual template call omitting the surrounding double curly brackets  
 
: the usage synopsis, e.g. the actual template call omitting the surrounding double curly brackets  
* parameters
+
* parameters (should provide)
 
: a parameter reference where required
 
: a parameter reference where required
 
* preview (optional)
 
* preview (optional)
Line 64: Line 54:
 
== Preview ==
 
== Preview ==
  
IMPORTANT NOTICE: Do not edit nor create the below dummy links.
+
See this template.
  
The template uses itself as a basis for its layout.
+
[[Category:OOPM:Templates:Documentation|Shared]]</noinclude><includeonly>
 
+
[[Category:OOPM:Templates:Documentation|Shared]]
+
 
+
</noinclude>
+
 
+
<includeonly>
+
 
__NOEDITSECTION__
 
__NOEDITSECTION__
 
{{#ifeq: {{{deprecated}}} | true |
 
{{Template:OOPM:Templates:Documentation:Shared:StandardDeprecationNotice:1.0
 
|template=Template:OOPM:Templates:Documentation:Shared:StandardTemplateHeader:1.0
 
|alternate=Template:OOPM:Templates:Documentation:Shared:StandardTemplateHeader:1.1
 
}}
 
}}
 
 
 
== Meta ==
 
== Meta ==
  
Line 104: Line 80:
 
== Synopsis ==
 
== Synopsis ==
  
  &#123;&#123;{{{synopsis|no synopsis declaration available}}}
+
  {{#ifeq: {{{synopsis|none}}} | none | no synopsis available
&#125;&#125;
+
|&#123;&#123;{{{synopsis}}}<br />&#125;&#125;
 +
}}
  
 
=== Parameter Reference ===
 
=== Parameter Reference ===
Line 122: Line 99:
 
----
 
----
  
Uses [[Template:OOPM:Templates:Documentation:Shared:StandardTemplateHeader:1.0]]
+
Uses [[Template:OOPM:Templates:Documentation:Shared:StandardTemplateHeader]]
 
</includeonly>
 
</includeonly>

Latest revision as of 17:21, 8 May 2009


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