Difference between revisions of "Template:OOPM:Templates:Documentation:Shared:StandardTemplateHeader"
From Apache OpenOffice Wiki
| Line 30: | Line 30: | ||
|deprecated=true|false (optional) | |deprecated=true|false (optional) | ||
|template=<WikiUrn> | |template=<WikiUrn> | ||
| + | |alternate=<WikiUrn> | ||
|author=<AuthorName> | |author=<AuthorName> | ||
|created=<Date> | |created=<Date> | ||
| Line 46: | Line 47: | ||
: note that you will still have to include the deprecation notice template in your own template | : 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 | : in order to notify the user of its deprecation on the page that will use the template | ||
| − | * template | + | * template (currently optional) |
: The urn of the template. This will be used for display in for example the deprecation notice. | : 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 | : E.g. Template:OOPM:Templates:Documentation:Shared:CategoryPageHeader:1.0 | ||
| − | * author | + | * 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) | ||
: 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 77: | Line 82: | ||
{{#ifeq: {{{deprecated}}} | true | | {{#ifeq: {{{deprecated}}} | true | | ||
{{Template:OOPM:Templates:Documentation:Shared:StandardDeprecationNotice:1.0 | {{Template:OOPM:Templates:Documentation:Shared:StandardDeprecationNotice:1.0 | ||
| − | |template= | + | |template={{{template}}} |
| − | |alternate= | + | |alternate={{{alternate}}} |
}} | }} | ||
}} | }} | ||
Revision as of 20:26, 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>
|alternate=<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 (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)
- 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.
