Template:Cover Image Data/Doc

From ISFDB
< Template:Cover Image Data
Revision as of 21:12, 30 August 2010 by DESiegel60 (talk | contribs) (→‎Usage: {{UnnamedParmDoc}})
Jump to navigation Jump to search


Documentation for the template: Cover Image Data (transcluded from Template:Cover Image Data/Doc

Purpose

This template is to be placed on the image description page of a book, magazine, or other publication cover image used under fair use. If you have more than one artist then see Template:Cover Image Data1-2 and Template:Cover Image Data1-3.

Usage

A minimal call (omitting parameters that can safely be left to their defaults) to the template would be:

{{Cover Image Data
|Title=<publication title>
|Edition=<date and/or publisher>
|Pub=<the publication record number or tag>
|Publisher=<Name of publisher>
|Artist=<name of cover artist>
|Source=<origin of image>
}}

A maximal call, including all parameters, would be:

{{Cover Image Data
|Title=<publication title>
|Edition=<date and/or publisher>
|Pub=<the publication record number or tag>
|Publisher=<Name of publisher>
|Artist=<name of cover artist>
|CpyrtHolder=<name of the actual copyright holder>
|Source=<origin of image>
|Side=<back or front or spine>
|AddRat=<Additional fair use rationale>
|LowRes=<Yes or No>
}}

All parameter names have an initial capital letter. Case is significant in a parameter name. The order of the parameters is not significant, but the order above is suggested, as it is the order of use within the template.

Note: In all the above examples, when a parameter is shown in angle brackets, like:

<Parameter>

then the parameter, and the angle brackets, should be replaced by the value of the parameter. For example: Title=<TITLE> should become Title=The Name of the Book (or whatever the name might be).

When using an unnamed (positional) parameter, it should NOT be the last thing on the line. It should be followed by either a pipe symbol (|) if there is another parameter to follow, or by the template call close (}}) if there is not. Otherwise the parameter value will be passed as including the carriage return at the end of the line, which will probably cause the template to function incorrectly.

Parameter definitions

Parameter Description Default
Title Should specify the actual title of the book or other publication whose image is being displayed. Required Field
Edition Ideally should specify the year and publisher, as "Ace 1983", or some other text string which will distinguish the pictured edition from other publications of the same title. Required Field
Pub The publication record number or tag. Must be a valid argument to {{P}}. (Id may be used instead. Strongly encouraged. No default.
Publisher Should specify the name of the publisher of the publication displayed, for proper attribution. Required Field
CpyrtHolder The name of the copyright holder of the image, if known with reasonable assurance, particularly if this is not the publisher. For example if a movie tie-in edition has a cover that is a still or poster for the movie, this would be the production company (such as "Paramount Pictures"). Defaults to "the publisher or the cover artist". Omit if not known.
Artist The name of the cover artist. If omitted, defaults to "Unknown". Links to the artist's DB page unless the artist is "Unknown". If the cover is plain except for lettering, or otherwise has no real "Art" and no credited creator, specify "Artist=None"
Source Website where the image was obtained, or name or handle of user who scanned the image. May also include scanner resolution in dpi. If omitted, defaults to "Unknown".
Side should be "back" if this is a (rare) back-cover image, or "spine" for an image of the cover spine. Use "both" if both sides of a Dos-a-Dos book are included. If omitted, defaults to "front". Can safely be omitted for front covers.
AddRat Additional rationale. Any text spelling out additional reasons why this image qualifies for fair use. Defaults to blank. Should be omitted unless there is an additional rationale to specify.
LowRes Should normally be "Yes", to indicate that this is a relatively low-res image. If the value is "Yes" a statement to this effect is displayed. If the value is "No", or if the parameter is omitted, a warning text will be displayed instead. Values other than "Yes" or "No" may cause the template to malfunction. Defaults to "Yes", can be omitted for images under 600 pixels.

Alias

{{CID1}} is an alias for this template. it may be used with exactly the same parameters, and will have exactly the same effect.

Example

For a usage example, see the example page.

Categories

This template places all pages it is used on into Category:Fair use images and Category:Cover images. It will also place each page into an Artist and a Publisher category, the names being derived from the appropriate parameters. If the Pub parameter is not supplied, the image is also placed in Category:Cover images without publication links.