Difference between revisions of "Template:OOPM:Templates:Documentation:Shared:StandardTemplateHeader"
From Apache OpenOffice Wiki
| Line 29: | Line 29: | ||
{{Template:OOPM:Templates:Documentation:Shared:StandardTemplateHeader:1.0 | {{Template:OOPM:Templates:Documentation:Shared:StandardTemplateHeader:1.0 | ||
|deprecated=true|false (optional) | |deprecated=true|false (optional) | ||
| + | |template=<WikiUrn> | ||
|author=<AuthorName> | |author=<AuthorName> | ||
|created=<Date> | |created=<Date> | ||
| Line 41: | Line 42: | ||
=== Parameter Reference === | === Parameter Reference === | ||
| − | * deprecated | + | * deprecated (optional) |
| − | : when true, the template will display a *deprecated template notice* on the page that | + | : 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 | * 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> | ||
| Line 53: | Line 59: | ||
* parameters | * parameters | ||
: a parameter reference where required | : a parameter reference where required | ||
| − | * preview | + | * preview (optional) |
: an optional preview of the template | : an optional preview of the template | ||
| Line 70: | Line 76: | ||
{{#ifeq: {{{deprecated}}} | true | | {{#ifeq: {{{deprecated}}} | true | | ||
| − | + | {{Template:OOPM:Templates:Documentation:Shared:StandardDeprecationNotice:1.0 | |
| − | + | |template=Template:OOPM:Templates:Documentation:Shared:StandardTemplateHeader:1.0 | |
| − | + | |alternate=none available at the time being | |
| − | + | }} | |
| − | + | }} | |
== Meta == | == Meta == | ||
| Line 104: | Line 110: | ||
{{{parameters|no parameter reference available}}} | {{{parameters|no parameter reference available}}} | ||
| + | |||
| + | {{#ifeq: {{{preview|none}}} | none | | | ||
== Preview == | == Preview == | ||
| Line 109: | Line 117: | ||
IMPORTANT NOTICE: Do not edit a/o create the below dummy links. | IMPORTANT NOTICE: Do not edit a/o create the below dummy links. | ||
| − | {{{preview | + | {{{preview}}} |
| + | }} | ||
---- | ---- | ||
Revision as of 20:08, 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
|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.
