Template:Pattern Graphic/doc

From OIAr
Jump to navigation Jump to search

This template is used on both Generic Pattern and Applied Pattern pages; it displays the "functional and integration view" of the Pattern, if that image is uploaded to the wiki, complete with a matching legend. Furthermore, if the source file from which the image is created is also uploaded to the wiki, then this file can be indicated as well, and a download link to that file will be provided to the reader right next to the legend.

The template takes the following parameters:

  • graphic: an uploaded image file that depicts the functional & integration view of the pattern. If this is left blank, the No graphic yet image is used instead.
  • source: an uploaded file (likely a .vsd Visio file), which is the source of the uploaded image. This parameter is optional.
  • size: a wikitext parameter for the "Image" command, such as "400px" (width only) or "200x400px" (width by height). If left empty, the wiki will attempt to show the graphic in its original size.
  • title: the "alternative" text, i.e. the text that is shown when the cursor hovers over the picture. If left empty, a name is generated: "Generic Pattern" (or "Applied Pattern") plus the Pattern's "friendly name". This usually suffices, so you only use title if you need to override this generated alternative text.
  • kind: specify whether the graphic is a Generic Pattern or an Applied Pattern by using either Generic or Applied. If misspelled or left empty, Generic is assumed.

To use the template, cut and paste the following code:

{{Pattern Graphic
|graphic=
|source=
|size=
|title=
|kind=
}}