Template:Pageheaderbox/doc: Difference between revisions
Jump to navigation
Jump to search
(doc added) |
(doc fix) |
||
| Line 2: | Line 2: | ||
This box should be at the top of most pages. It takes the following mandatory named parameters: | 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; | * ''pagetype'' is usually the (two-letter) coding of the object for which the page is meant. Example: GF for Generic Function; | ||
* ''pagename'' takes | * ''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" | * ''summary'' takes a short, functional description of the artefact to which the page relates, which is then available throughout the wiki as the "[[Property:Brief description|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 [[Special:Categories|Category]]; take care to use the correct name; | * ''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 [[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; | ||
Latest revision as of 20:40, 29 March 2013
 |
This is a documentation subpage for Template:Pageheaderbox (see that page for the template itself). It contains usage information, categories and other content that is not part of the original template page. |
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=
}}