Difference between revisions of "Template:Cover Image Data-PD Renew/Doc"
DESiegel60 (talk | contribs) m (categories and prototype format) |
(add ArtistId) |
||
(6 intermediate revisions by one other user not shown) | |||
Line 2: | Line 2: | ||
− | Documentation for the template: '''[[:Template:Cover Image Data-PD Renew|Cover Image Data-PD Renew]]''' | + | Documentation for the template: '''[[:Template:Cover Image Data-PD Renew|Cover Image Data-PD Renew]]''' (transcluded from [[:Template:Cover Image Data-PD Renew/Doc]] |
==Purpose== | ==Purpose== | ||
Line 14: | Line 14: | ||
|Title=<publication title> <br /> | |Title=<publication title> <br /> | ||
|Edition=<date and/or publisher> <br /> | |Edition=<date and/or publisher> <br /> | ||
+ | |Pub=<the publication record number or tag> <br /> | ||
|Publisher=<Name of publisher> <br /> | |Publisher=<Name of publisher> <br /> | ||
|Artist=<name of cover artist> <br /> | |Artist=<name of cover artist> <br /> | ||
+ | |ArtistId=<id of cover artist> (optional) <br /> | ||
|Year=<Year of publication> <br /> | |Year=<Year of publication> <br /> | ||
|Source=<origin of image> <br /> | |Source=<origin of image> <br /> | ||
− | |Side=< | + | |Side=<back or front or spine> <br /> |
<nowiki>}}</nowiki> | <nowiki>}}</nowiki> | ||
</code> | </code> | ||
Line 24: | Line 26: | ||
All parameter names have an inital capitol 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. | All parameter names have an inital capitol 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. | ||
+ | |||
+ | {{AngleBracketDoc}} | ||
===Parameter definitions=== | ===Parameter definitions=== | ||
{| border="1" cellspacing="1" cellpadding="2" bgcolor="#FFFFD0" | {| border="1" cellspacing="1" cellpadding="2" bgcolor="#FFFFD0" | ||
Line 32: | Line 36: | ||
|- | |- | ||
|'''Edition''' ||Ideally should specify the year and publisher, as "Ace 1953", or some other text string which will distinguish the pictured edition from other publications of the same title. ||'''Required Field''' | |'''Edition''' ||Ideally should specify the year and publisher, as "Ace 1953", 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 {{tl|P}}. ('''Id''' may be used as an alias for Pub, with the same effect.)||'''Strongly encouraged.''' No default. | ||
|- | |- | ||
|'''Publisher''' ||Should specify the name of the publisher of the publication displayed, for proper attribution. ||Defaults to "Unknown". | |'''Publisher''' ||Should specify the name of the publisher of the publication displayed, for proper attribution. ||Defaults to "Unknown". | ||
|- | |- | ||
− | |'''Artist''' ||The name of the cover artist. ||If omitted, defaults to "Unknown". | + | |'''Artist''' ||The name of the cover artist. ||If omitted, defaults to "Unknown". Links to the artist's DB page unless the artist is "Unknown". |
+ | |- | ||
+ | |'''ArtistId''' ||The record number of the cover artist, if known. Used to link to artist summary page via the record number when artist's name has characters (single quotes, non-ASCII) that cause linking by name to fail. In order for this field to work, the "Artist" field also has to be filled in. || Defaults to unused. | ||
|- | |- | ||
|'''Year''' ||Year of publication. Must be prior to 1964 to support public domain status.||'''Required Field''' | |'''Year''' ||Year of publication. Must be prior to 1964 to support public domain status.||'''Required Field''' | ||
Line 44: | Line 52: | ||
|- | |- | ||
|} | |} | ||
− | |||
==Example== | ==Example== | ||
Line 53: | Line 60: | ||
* [[:Category:Public Domain images]] | * [[:Category:Public Domain images]] | ||
* [[:Category:Free images]] | * [[:Category:Free images]] | ||
+ | * [[:Category:Cover images]] | ||
* an Artist: category based on the artist name supplied | * an Artist: category based on the artist name supplied | ||
* a Publisher: category based on the publisher name supplied | * a Publisher: category based on the publisher name supplied | ||
+ | * If the '''Pub''' parameter is not supplied, the image is also placed in [[:Category:Cover images without publication links]]. |
Latest revision as of 10:25, 8 April 2017
Documentation for the template: Cover Image Data-PD Renew (transcluded from Template:Cover Image Data-PD Renew/Doc
Purpose
This template is to be placed on the image description page of a book, magazine, or other publication cover image that is in the public domain because it was published before 1964 and the copyright was not renewed.
Usage
Call this template as:
{{Cover Image Data-PD Renew
|Title=<publication title>
|Edition=<date and/or publisher>
|Pub=<the publication record number or tag>
|Publisher=<Name of publisher>
|Artist=<name of cover artist>
|ArtistId=<id of cover artist> (optional)
|Year=<Year of publication>
|Source=<origin of image>
|Side=<back or front or spine>
}}
All parameter names have an inital capitol 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).
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 1953", 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 as an alias for Pub, with the same effect.) |
Strongly encouraged. No default. |
Publisher | Should specify the name of the publisher of the publication displayed, for proper attribution. | Defaults to "Unknown". |
Artist | The name of the cover artist. | If omitted, defaults to "Unknown". Links to the artist's DB page unless the artist is "Unknown". |
ArtistId | The record number of the cover artist, if known. Used to link to artist summary page via the record number when artist's name has characters (single quotes, non-ASCII) that cause linking by name to fail. In order for this field to work, the "Artist" field also has to be filled in. | Defaults to unused. |
Year | Year of publication. Must be prior to 1964 to support public domain status. | Required Field |
Source | Website where the image was obtained, or name or handle of user who scanned the image. | If omitted, defaults to "Unknown". |
Side | should be "back" if this is a (rare) back-cover image. | If omitted, defaults to "front". |
Example
For a usage example, see the example page.
Categories
This template adds any pages on which it is used to:
- Category:Public Domain images
- Category:Free images
- Category:Cover images
- an Artist: category based on the artist name supplied
- a Publisher: category based on the publisher name supplied
- If the Pub parameter is not supplied, the image is also placed in Category:Cover images without publication links.