Template:Pagecover/doc: Difference between revisions

no edit summary
m (21 revisions imported: Import from https://sims.wikia.com)
No edit summary
Line 1:
{{Info|Limited use only|This template is ready to be used on articles, but should only be used on "significant" pages.}}
 
;==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.
<code><pre>
{{Pagecover
|image =
Line 18:
|
}}
</pre></code>
 
 
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.
 
<code><pre>
{{Pagecover
|image =
Line 33 ⟶ 32:
|backgroundcolor =
}}
</pre></code>
 
 
The following is the ''full code'' for the template, excluding <noname>. 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.
 
<code><pre>
{{Pagecover
|image =
Line 53 ⟶ 51:
|
}}
</pre></code>
 
;==Mandatory parameter==
* ''<image> - 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.
 
Line 68 ⟶ 66:
* <backgroundcolor> - 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.
* <noname> - 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 <image>, <height>, <width>, <offset>, <generation>, and <toc>.''
* <alt> - This parameter is used to add [[wikipedia:alt attribute|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.
 
Line 79 ⟶ 78:
* <align> - 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==
<code><pre>
{{Pagecover
Line 111 ⟶ 110:
|pagetype=In-game event
|TS1|BO|TS2|TS2C|TS3S}}
 
;==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:
#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.
Line 118:
#Pagecovers are not used on articles about canon Sims or families, for stylistic purposes. Pagecovers can be used within the fanon namespace freely.
 
==Changelog==
;Change log (to track major changes to this template)
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 <toc> parameter contains 'right'.
Line 124 ⟶ 125:
* 13 February 2014 - Added <offset> and <height> 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 <noname> 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; <generation>, <backgroundcolor> and <align>.
* 28 February 2019 - Template was imported to Miraheze. It did not require significant rework in order to function.
* 16 March 2019 - Added <alt> parameter for filling in [[wikipedia:alt attribute|alt text]].
 
;==Attribution and Credit==
This template is originally based off of a series of templates from the [[wikia:w:c:arresteddevelopment|''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 [[w:c:Sims|''The Sims Wiki'']]; the template's revision history and list of contributors is available [httphttps://sims.wikiamiraheze.comorg/wiki/Template:Pagecover?action=history here].
 
''The text of this template is licensed under the [httphttps://creativecommons.org/licenses/by-sa/3.0/ Creative Commons Attribution-ShareAlike 3.0 (CC-by-SA)] license. Please review the CC-by-SA license text for more information.''
<noinclude>[[Category:Template documentation]]</noinclude>