Template:Pagecover/doc

Use
This template adds a large header to a page, incorporating the image and text provided by the editor. The cover can be used in place of an infobox, provided the infobox presents only a limited amount of information.

This template may be adapted to more specific uses over time.

Code
The following is the basic code of the template, including its most common uses. Simply copy-and-paste this code onto the page and fill in the parameters to use it.

The following is the "noname" version of the template, with the title box removed so that the template only displays an image. This code can be used to add a pagecover without a title, and only relevant parameters have been included here.

The following is the full code for the template, excluding. The full code may be useful in limited circumstances but most of the time all the parameters aren't needed at the same time. Simply copy-and-paste this code to use it on a page.

Mandatory parameter

 * - The image selected should be close to, if not as large as, 690px (width) by 300px (height). Images smaller than 690 x 300px are stretched to fit, and images larger than 690 x 300px are cropped. The maximum height of the image may need to be adjusted if large amounts of text are included in the Subtitle parameter.

Useful parameters
These parameters aren't necessary for the template to be useable, but they increase its usefulness. These parameters are frequently used when the template is added to a page.


 * - This text appears right-aligned on the top level of the cover, to the left of any game icons (see below). This field can be filled in to describe the type of article the cover is being used on. If left blank, nothing will appear for this parameter.
 * - This text appears directly below the title line. The text is a larger font size than the text used for.
 * - The vertical width of the template (in pixels) can be set with this parameter. Note that changing this setting will not change the size of the image used in the template, so if the height is set too large there may be empty space at the bottom of the template. Height is set to 300px by default.
 * - The image used within the template can be moved "up" by filling this parameter (in pixels). Use the preview button to check the offset before publishing, as setting the offset too high might show an empty space below the image. There is no offset by default.
 * - This parameter colors the template background based on the generation specified. Currently, Gens 1 - 4 (The Sims through The Sims 4) are included; "TS#" or "The Sims #" (e.g. TS2, The Sims 3) will complete this parameter. If not specified, the template will default to a gray color.
 * - If the article in question is not part of an easily-defined game generation, a custom color can be added to the text box instead. note: the background color will override the generation color, if one is chosen.
 * - If this parameter is filled with any non-empty characters, the gray text box and all text included in it will not be displayed. You can use this parameter to display a large image box without the text on top of it. Note that filling this parameter makes all other parameters redundant except, , , , , and .
 * - This parameter is used to add alt text to the image, which will be displayed when the image cannot be loaded for whatever reason. It is also used by screen readers to describe images.

Additionally, if the template is being used on a page for game features that span multiple titles, game icons can be included, by appending the appropriate vgcode (as found in Template:Era) to the template. This parameter does not have a name. Presently the template can accommodate up to eight icons.

Additional parameters
The template can be further customized on a case-by-case basis by using the following parameters. These parameters may not be needed under every circumstance.


 * - The name shown on the title line of the cover can be changed by filling in this parameter. If the parameter is left empty, the name used defaults to the name of the page the template is used on.
 * - The horizontal width of the template (in pixels) can be set with this parameter. Setting this parameter also changes the size of the image used in the template. By default, the normal width is 690px.
 * - This parameter can be used to create a right-aligned table of contents on the page. By default, the table of contents is left-aligned (note that this has changed from earlier versions of the template - see the change log for details).
 * - This parameter determines how the "text box" on the template will be aligned. The box is right-aligned by default; acceptable parameters are 'right', 'left', 'center' or 'centre'.

Samples
...will produce:

...produces:

Guidelines
This template is versatile and can be customized on a case-by-case basis. However, it is not useful in all circumstances. When considering whether or not to add this template to a page, consider the following:
 * 1) This template requires a large, high-quality image. Small images will be stretched and distorted and will not look good, and low-quality images will be displayed prominently, which is not ideal. Even if other pages of the same "type" have a pagecover, it may not be practical to add a pagecover to an article if an adequate image doesn't exist.
 * 2) The height of the image shown in the cover is directly proportional to the width set in the parameters. This is a fundamental trait for the template to display correctly, so editors planning to add a pagecover will need to work around this. To do this, the parameters and can be used to change the vertical size of the cover itself (while not changing the image size), and to adjust whether the image is moved up or down within the cover.
 * 3) Articles should almost never have more than one pagecover. The page cover should almost always be at the very top of the article, above all templated messages, infobox and content. Articles with pagecover should not use Era icons. Era icons can be displayed on the pagecover by including the appropriate game abbreviations to a blank parameter at the end of the template.
 * 4) Pagecovers are not used on articles about canon Sims or families, for stylistic purposes. Pagecovers can be used within the fanon namespace freely.

Changelog
Major changes to this template are tracked here.
 * 4 April 2013 - Template created
 * 25 July 2013 - Template can now have a variable (left/right) width. Template also no longer applies right-aligned table of contents, but can be made to display a right-aligned toc if the parameter contains 'right'.
 * 22 August 2013 - Fixed a bug where the cover image would re-size incorrectly if a non-default width is used. Images should now "scale" properly in these cases, but it may affect previous uses of the template with non-default widths.
 * 13 February 2014 - Added and parameters. Offset will move an image "up" within the template itself, while height adjusts the vertical size of the template. Note that adjusting the height will not adjust the size of the image.
 * 20 December 2014 - Added parameter. When filled with a non-empty character, parameter will remove the gray text box from in front of the image, allowing a display of the image and bounding box alone.
 * 10 April 2015 - Template updated to match the new wiki-wide theme. Three new parameters were added;, and.
 * 28 February 2019 - Template was imported to Miraheze. It did not require significant rework in order to function.
 * 16 March 2019 - Added parameter for filling in alt text.

Attribution and Credit
This template is originally based off of a series of templates from the Arrested Development Wiki, including: wikia:w:c:arresteddevelopment:Template:Appearances, wikia:w:c:arresteddevelopment:Template:NewCharacter, and others of a similar design. Revision histories for each of those templates is available on the Arrested Development wiki. The original source template has been modified and adapted to The Sims Wiki; the template's revision history and list of contributors is available here.

''The text of this template is licensed under the Creative Commons Attribution-ShareAlike 3.0 (CC-by-SA) license. Please review the CC-by-SA license text for more information.''