Jan Schoonderbeek: doc fix

2013-03-29T19:40:30Z

doc fix

← Older revision		Revision as of 19:40, 29 March 2013
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 ~~a brief description~~ 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;		* ''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;

Jan Schoonderbeek: doc added

2013-03-29T19:15:04Z

doc added

New page

<noinclude>{{Documentation subpage}}</noinclude>
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 a brief description 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 [[Special:Categories|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 [[Property:Displayname|Displayname]] of the wiki user that is the owner (or else his/her [[Special:ListUsers|login name]] without the ''User:'' prefix).

To use the template, cut and paste the following code:
<pre><nowiki>{{Pageheaderbox
|pagetype=
|pagename=
|summary=
|doctype=
|version=
|owner=
}}</nowiki></pre>
<includeonly>

[[Category:Templates]]
</includeonly>

Template:Pageheaderbox/doc - Revision history

Jan Schoonderbeek: doc fix

Jan Schoonderbeek: doc added