Difference between revisions of "Template:Author Image Data/Doc"
DESiegel60 (talk | contribs) m (→Purpose) |
m (→Usage: clarify) |
||
(10 intermediate revisions by 3 users not shown) | |||
Line 5: | Line 5: | ||
==Purpose== | ==Purpose== | ||
− | This template is to be placed on the image description page of a photograph of a | + | This template is to be placed on the image description page of a photograph of a person (author, editor, or the like) used under fair use. |
==Usage== | ==Usage== | ||
Line 11: | Line 11: | ||
<code> | <code> | ||
− | <nowiki>{{Author Image Data </nowiki> | + | <nowiki>{{Author Image Data</nowiki> <br /> |
− | + | |Name=<Name of author> (person shown in picture) <br /> | |
− | |Name=<Name of author> (person shown in picture) | + | |NameId=<id of author> (only required for names with characters that break [[:Template:A]]) <br /> |
− | + | |Photographer=<Person who took the picture> <br /> | |
− | |Photographer=<Person who took the picture> | + | |Source=<where did we get the image from> <br /> |
− | + | |Publication=<Where and when was this image published> <br /> | |
− | |Source=< | + | |Portion=<How much of the image was used, if not the whole> <br /> |
− | + | |Replaceable=<Why this image can not be replaced by a freely licensed image> (example: "The person is dead.") <br /> | |
− | |Publication=<Where and when was this image published> | + | |LowRes=<YesOrNo> <br /> |
− | + | <nowiki>}}</nowiki> <br /> | |
− | |Replaceable=<Why this image can not be | ||
− | |||
− | |||
− | |||
− | |LowRes=<YesOrNo> | ||
− | |||
− | <nowiki>}}</nowiki> | ||
</code> | </code> | ||
− | All parameter names have an | + | 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. |
+ | {{AngleBracketDoc}} | ||
===Parameter definitions=== | ===Parameter definitions=== | ||
{| border="1" cellspacing="1" cellpadding="2" bgcolor="#FFFFD0" | {| border="1" cellspacing="1" cellpadding="2" bgcolor="#FFFFD0" | ||
Line 38: | Line 32: | ||
|- | |- | ||
|'''Name''' ||Should specify the name of the person whose image is being displayed. ||'''Required Field''' | |'''Name''' ||Should specify the name of the person whose image is being displayed. ||'''Required Field''' | ||
+ | |- | ||
+ | |'''NameId''' ||The record number of the person. Used to link to person's summary page via the record number when person's name has characters (single quotes, non-ASCII) that cause linking by name to fail. In order for this field to work, the "Name" field also has to be filled in. || Defaults to unused. | ||
|- | |- | ||
|'''Photographer''' ||Should specify the name of the person who took the picture||If omitted, defaults to "Unknown". | |'''Photographer''' ||Should specify the name of the person who took the picture||If omitted, defaults to "Unknown". | ||
− | |||
− | |||
|- | |- | ||
|'''Source''' ||Website or publication where the image was obtained, or name or handle of user who scanned the image. ||If omitted, defaults to "Unknown". | |'''Source''' ||Website or publication where the image was obtained, or name or handle of user who scanned the image. ||If omitted, defaults to "Unknown". | ||
|- | |- | ||
− | |'''Publication''' || where and when this | + | |'''Publication''' || where and when this image was published. If multiple publications are known, specify the first.||If omitted, defaults to "Unknown". |
|- | |- | ||
|'''Portion''' || what part of the original image was used. Mention any cropping here. || Defaults to "The entire image." | |'''Portion''' || what part of the original image was used. Mention any cropping here. || Defaults to "The entire image." | ||
|- | |- | ||
− | |'''Replaceable''' || Statement of why this image could not be | + | |'''Replaceable''' || Statement of why this image could not be replaced with one used with permission or under a free license. ||Defaults to "The image could be replaced by a freely licensed image." |
− | |||
− | |||
|- | |- | ||
− | |'''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 | + | |'''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" will cause the template to malfunction.||Defaults to "No" |
|- | |- | ||
Latest revision as of 10:16, 8 April 2017
Documentation for the template: Author Image Data
Purpose
This template is to be placed on the image description page of a photograph of a person (author, editor, or the like) used under fair use.
Usage
Call this template as:
{{Author Image Data
|Name=<Name of author> (person shown in picture)
|NameId=<id of author> (only required for names with characters that break Template:A)
|Photographer=<Person who took the picture>
|Source=<where did we get the image from>
|Publication=<Where and when was this image published>
|Portion=<How much of the image was used, if not the whole>
|Replaceable=<Why this image can not be replaced by a freely licensed image> (example: "The person is dead.")
|LowRes=<YesOrNo>
}}
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).
Parameter definitions
Parameter | Description | Default |
---|---|---|
Name | Should specify the name of the person whose image is being displayed. | Required Field |
NameId | The record number of the person. Used to link to person's summary page via the record number when person's name has characters (single quotes, non-ASCII) that cause linking by name to fail. In order for this field to work, the "Name" field also has to be filled in. | Defaults to unused. |
Photographer | Should specify the name of the person who took the picture | If omitted, defaults to "Unknown". |
Source | Website or publication where the image was obtained, or name or handle of user who scanned the image. | If omitted, defaults to "Unknown". |
Publication | where and when this image was published. If multiple publications are known, specify the first. | If omitted, defaults to "Unknown". |
Portion | what part of the original image was used. Mention any cropping here. | Defaults to "The entire image." |
Replaceable | Statement of why this image could not be replaced with one used with permission or under a free license. | Defaults to "The image could be replaced by a freely licensed image." |
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" will cause the template to malfunction. | Defaults to "No" |
Example
For a usage example, see the example page.