Template:Pageheaderbox

From OIAr
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.
Document icon Version: OIAr logo
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=
}}