Template:Pageheaderbox: Difference between revisions

From OIAr
Jump to navigation Jump to search
(add friendlyname in var)
No edit summary
 
(4 intermediate revisions by the same user not shown)
Line 3: Line 3:
|Working Area            =[[File:Icon_WA.png|64px|This is a Working Area document|link=Working Area]]
|Working Area            =[[File:Icon_WA.png|64px|This is a Working Area document|link=Working Area]]
|Quality Attribute      =[[File:Icon_QA.png|64px|This is a Quality Attribute document|link=Quality Attribute Overview]]
|Quality Attribute      =[[File:Icon_QA.png|64px|This is a Quality Attribute document|link=Quality Attribute Overview]]
|Function Definition    =[[File:Icon_Function.png|64px|This is a Function Definition document|link=Function Definition]]
|Data Object Type        =[[File:Icon_Function.png|64px|This is a Function Definition document|link=Function Definition]]
|Generic Function        =[[File:Icon_GF.png|64px|This is a Generic Function document|link=Generic Function]]
|Generic Function        =[[File:Icon_GF.png|64px|This is a Generic Function document|link=Generic Function]]
|Applied Function        =[[File:Icon_AF.png|64px|This is an Applied Function document|link=Applied Function]]
|Applied Function        =[[File:Icon_AF.png|64px|This is an Applied Function document|link=Applied Function]]
|Pattern Definition      =[[File:Icon_Pattern.png|64px|This is a Pattern Definition document|link=Pattern Definition]]
|Generic Pattern        =[[File:Icon_GP.png|64px|This is a Generic Pattern document|link=Generic Pattern]]
|Generic Pattern        =[[File:Icon_GP.png|64px|This is a Generic Pattern document|link=Generic Pattern]]
|Applied Pattern        =[[File:Icon_AP.png|64px|This is an Applied Pattern document|link=Applied Pattern]]
|Applied Pattern        =[[File:Icon_AP.png|64px|This is an Applied Pattern document|link=Applied Pattern]]
|Service Definition      =[[File:Icon_GS.png|64px|This is a Service Definition document|link=Service Definition]]
|Generic Service        =[[File:Icon_GS.png|64px|This is a Generic Service document|link=Generic Service]]
|Generic Service        =[[File:Icon_GS.png|64px|This is a Generic Service document|link=Generic Service]]
|Applied Service        =[[File:Icon_AS.png|64px|This is an Applied Service document|link=Applied Service]]
|Applied Service        =[[File:Icon_AS.png|64px|This is an Applied Service document|link=Applied Service]]

Latest revision as of 15:42, 26 November 2019

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=
}}