Template:Pageheaderbox: Difference between revisions

Revision as of 21:55, 16 April 2013

			Version:
	Document type:		Owner:

Template documentation

This box should be at the top of most pages. It takes the following mandatory named parameters:

pagetype is usually the (two-letter) coding of the object for which the page is meant. Example: GF for Generic Function;
pagename takes the intended name of the object, which is then available throughout the wiki as the "Friendly name" property; if left empty it's content will be the actual page title;
summary takes a short, functional description of the artefact to which the page relates, which is then available throughout the wiki as the "Brief description" property. If left empty it's content will become "unspecified";
doctype says what sort of definition the page provides, e.g. Generic Pattern for a page describing a pattern or Architecture Requirement for a page describing an Architecture Requirement. Note: the text you put here, places the page in the respective Category; take care to use the correct name;
version holds the version number of the document itself;
owner holds the designated owner of this architecture product. Please provide the Displayname of the wiki user that is the owner (or else his/her login name without the User: prefix).

To use the template, cut and paste the following code:

{{Pageheaderbox
|pagetype=
|pagename=
|summary=
|doctype=
|version=
|owner=
}}

The above documentation is transcluded from Template:Pageheaderbox/doc. (edit \| history) Editors can experiment in this template's sandbox (create \| mirror) and testcases (create) pages. Please add categories and interwikis to the /doc subpage. Subpages of this template.

@@ Line 12: / Line 12: @@
 |Location                =[[File:Icon_LO.png|64px|This is a Location document|link=Location]]
 |#default                =[[File:Doc-grey.png|64px|Document icon]]}}
-!width="150"|[[Pagetype::{{{pagetype|}}}]]
+!width="150"|<includeonly>[[Pagetype::{{{pagetype|}}}]]</includeonly>
-!width="300"|[[Friendly name::{{{pagename|{{PAGENAME}}}}}]]
+!width="300"|<includeonly>[[Friendly name::{{{pagename|{{PAGENAME}}}}}]]{{#vardefine:friendlyname|{{{pagename|{{PAGENAME}}}}} }}</includeonly>
 |width="50"|Version:
 |[[Version::{{{version|}}}]]
@@ Line 19: / Line 19: @@
 |-
 |Document type:
-|[[:Category:{{{doctype|}}}|{{#ifexist: Category:{{{doctype|}}} | <span style="color:#{{Color OIAm Light Blue}};"><u>{{{doctype|}}}</u></span> | <span style="color:#{{Color Busy Red}};">{{{doctype}}}</span> }}]]
+|<includeonly>[[:Category:{{{doctype|}}}|{{#ifexist: Category:{{{doctype|}}} | <span style="color:#{{Color OIAm Light Blue}};"><u>{{{doctype|}}}</u></span> | <span style="color:#{{Color Busy Red}};">{{{doctype}}}</span> }}]]</includeonly>
 |Owner:
-|{{GetUser|{{{owner|Unknown}}}}}[[Owner::{{#var:displayname}}|]][[User:{{#var:userpage}}|<span style="color:#{{Color OIAm Light Blue}};"><u>{{#var:displayname}}</u></span>]]
+|<includeonly>{{GetUser|{{{owner|Unknown}}}}}[[Owner::{{#var:displayname}}|]][[User:{{#var:userpage}}|<span style="color:#{{Color OIAm Light Blue}};"><u>{{#var:displayname}}</u></span>]]</includeonly>
 |-
 |}