Template:Pageheaderbox: Difference between revisions
Jump to navigation
Jump to search
(underline owner name) |
(support for LOC and AR) |
||
| Line 5: | Line 5: | ||
* ''pagename'' takes a brief description of the object, which is then available throughout the wiki as the "Brief description" property; if left empty it's content will be the actual page title; | * ''pagename'' takes a brief description of the object, which is then available throughout the wiki as the "Brief description" 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 "Summary string" property. If left empty it's content will become "unspecified". Note that at currently, the content of this field is NOT shown directly on the page where ''Template:Pageheaderbox'' is placed, at least not by means of this template itself. | * ''summary'' takes a short, functional description of the artefact to which the page relates, which is then available throughout the wiki as the "Summary string" property. If left empty it's content will become "unspecified". Note that at currently, the content of this field is NOT shown directly on the page where ''Template:Pageheaderbox'' is placed, at least not by means of this template itself. | ||
* ''doctype'' says what sort of definition the page provides, e.g. ''Pattern'' for a page describing a pattern or '' | * ''doctype'' says what sort of definition the page provides, e.g. ''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 [[Special:Categories|Category]]; take care to use the correct name; | ||
* ''version'' holds the version number of the document itself; | * ''version'' holds the version number of the document itself; | ||
* ''owner'' holds the designated owner of this architecture product. Please provide the [[Property:Displayname|Displayname]] of the wiki user that is the owner (or else his/her [[Special:ListUsers|login name]] without the ''User:'' prefix). | * ''owner'' holds the designated owner of this architecture product. Please provide the [[Property:Displayname|Displayname]] of the wiki user that is the owner (or else his/her [[Special:ListUsers|login name]] without the ''User:'' prefix). | ||
| Line 21: | Line 21: | ||
</noinclude><includeonly>[[Category:{{{doctype|}}}]]__NOTOC__ __SHOWFACTBOX__ __NOEDITSECTION__{{#switch: {{{doctype|}}} | </noinclude><includeonly>[[Category:{{{doctype|}}}]]__NOTOC__ __SHOWFACTBOX__ __NOEDITSECTION__{{#switch: {{{doctype|}}} | ||
|Working Area=[[Image:Icon_WA.png|100px|This is a Working Area document|link=Working Area]] | |Working Area=[[Image:Icon_WA.png|100px|This is a Working Area document|link=Working Area]] | ||
| | |Location=[[Image:Icon_LOC.png|100px|This is a Location document|link=Location]] | ||
|Building Block Type=[[Image:Icon_BB.png|100px|This is a Building Block document|link=Building Block]] | |Building Block Type=[[Image:Icon_BB.png|100px|This is a Building Block document|link=Building Block]] | ||
|Building Block Variant=[[Image:Icon_BBV.png|100px|This is a Building Block document|link=Building Block]] | |Building Block Variant=[[Image:Icon_BBV.png|100px|This is a Building Block document|link=Building Block]] | ||
|Pattern Type=[[Image:Icon_PA.png|100px|This is a Pattern document|link=Pattern]] | |Pattern Type=[[Image:Icon_PA.png|100px|This is a Pattern document|link=Pattern]] | ||
|Pattern Variant=[[Image:Icon_PAV.png|100px|This is a Pattern document|link=Pattern]] | |Pattern Variant=[[Image:Icon_PAV.png|100px|This is a Pattern document|link=Pattern]] | ||
| | |Architecture Requirement=[[Image:Icon_AR.png|100px|This is an Architecture Requirement document|link=Architecture Requirement]] | ||
|Quality Attribute=[[Image:Icon_QA.png|100px|This is a Quality Attribute document|link=Quality Attribute Overview]] | |Quality Attribute=[[Image:Icon_QA.png|100px|This is a Quality Attribute document|link=Quality Attribute Overview]] | ||
|Design Outline=[[Image:Icon_DO|100px|This is a Design Outline document|link=Design Outline]] | |Design Outline=[[Image:Icon_DO|100px|This is a Design Outline document|link=Design Outline]] | ||
|Technical Component=[[Image:Icon_TC|100px|This is a Technical Component document|link=Technical Component]] | |Technical Component=[[Image:Icon_TC|100px|This is a Technical Component document|link=Technical Component]] | ||
|Environment=[[Image:Icon_ENV.png|100px|This is an Environment document|link=Environment]] | |||
|Element=[[Image:Icon_EL.png|100px|This is an Element document|link=Element]] | |||
| | | | ||
}}<br style="clear: both" /> | }}<br style="clear: both" /> | ||
Latest revision as of 13:06, 26 February 2013
This box should be at the top of most pages. It takes the following mandatory named parameters:
- pagetype is usually the coding of the object for which the page is meant;
- pagename takes a brief description of the object, which is then available throughout the wiki as the "Brief description" 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 "Summary string" property. If left empty it's content will become "unspecified". Note that at currently, the content of this field is NOT shown directly on the page where Template:Pageheaderbox is placed, at least not by means of this template itself.
- doctype says what sort of definition the page provides, e.g. 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=
}}