Difference between revisions of "Template:Cover Image Data3/Doc"

From ISFDB
Jump to navigation Jump to search
(New page: ----- <!-- * * * --> Documentation for the template: '''Cover Image Data2''' (transcluded from Template:Cover Image Data2/Doc. ==Purpose== This tem...)
 
(add ArtistId)
 
(13 intermediate revisions by one other user not shown)
Line 3: Line 3:
  
  
Documentation for the template: '''[[:Template:Cover Image Data3|Cover Image Data2]]''' (transcluded from [[:Template:Cover Image Data2/Doc]].
+
Documentation for the template: '''[[:Template:Cover Image Data3|Cover Image Data3]]''' (transcluded from [[:Template:Cover Image Data3/Doc]].
  
 
==Purpose==
 
==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. This template provides less information than does [[:Template:Cover Image Data]], but requires less user input.
+
This template is to be placed on the image description page of a book, magazine, or other publication cover image used under fair use.  
 +
 
 +
This template provides less information than does [[:Template:Cover Image Data]], but requires less user input. However, it does document the cover artist, and put the image page into an artist category, as [[:Template:Cover Image Data2]] does not. It is therefore a sort of middle ground between [[:Template:Cover Image Data]] and [[:Template:Cover Image Data2]]
  
 
==Usage==
 
==Usage==
 
Call this template as:
 
Call this template as:
 +
 +
<code>
 +
<nowiki>{{</nowiki>Cover Image Data3  <br>
 +
|Pub=<TAG> <br />
 +
|Artist=<Canonical or credited name of artist> <br />
 +
|Title=<Book Title> <br />
 +
<nowiki>}}</nowiki></code>
 +
 +
or as:
  
 
<code>
 
<code>
Line 21: Line 32:
  
 
<code>
 
<code>
<nowiki>{{Cover Image Data2 </nowiki> <br />
+
<nowiki>{{Cover Image Data3 </nowiki> <br />
|Id=<TAG> <br />
+
|Pub=<TAG> <br />
 
|Artist=<name> <br />
 
|Artist=<name> <br />
 
<nowiki>}}</nowiki></code>
 
<nowiki>}}</nowiki></code>
Line 34: Line 45:
  
 
<code>
 
<code>
<nowiki>{{</nowiki>Cover Image Data2|<TAG>|<Artist's name>|<nowiki>}}</nowiki></code>
+
<nowiki>{{</nowiki>Cover Image Data3|<TAG>|<Artist's name>|<nowiki>}}</nowiki></code>
 +
 
 +
{{AngleBracketDoc}}
 +
 
 +
{{UnnamedParmDoc}}
  
 
==Parameters==
 
==Parameters==
*'''Id''' must specify a publication record tag or record number, an acceptable argument to [[:Template:P]] (which see). If the "Id=" parameter is not present, the first unnamed parameter is used. One or the other must be present and valid for the template to work correctly
+
*'''Pub''' must specify a publication record tag or record number, an acceptable argument to [[:Template:P]] (which see). '''Id''' may be used instead. If neither the "Pub=" nor the "Id=" parameter is present, the first unnamed parameter is used. One of these must be present and valid for the template to work correctly.
  
*'''Artist''' should specify the name of the artist who created the cover image. The artist may be specified either as credited for this particular work, or by his or her ISFDB '''canonical name'''. If the "Artist=" parameter is not present, the 2nd unnamed parameter is used. Note that it therefore does not fork to specify the Id parameter with a name, but the Artist parameter without one. Either both should be supplied as named parameters, or both as positional (unnamed) parameters. While the template will work without the artist being specified (it defaults to "Unknown") the main point of using this template, as opposed to {{tl|Cover Image Data2}}, is the ability to specify the artist, and put the image into an artist category automatically. So this parameter is "almost required".
+
*'''Artist''' should specify the name of the artist who created the cover image. The artist may be specified either as credited for this particular work, or by his or her ISFDB '''canonical name'''. If the "Artist=" parameter is not present, the 2nd unnamed parameter is used. Note that it therefore does not work to specify the Id parameter with a name, but the Artist parameter without one. Either both should be supplied as named parameters, or both as positional (unnamed) parameters. While the template will work without the artist being specified (it defaults to "Unknown") the main point of using this template, as opposed to {{tl|Cover Image Data2}}, is the ability to specify the artist, and put the image into an artist category automatically. So this parameter is "almost required". If the image is one that has only lettering against a plain background, or otherwise has no real "art", and has no credited creator, specify the artist as '''None'''.
  
*'''Title''' may specify the title of the book. This will be used in formatting the link to the publication record, as the optional name parameter to [[:Template:P]]. If "Title=" is not present, the 2nd unnamed parameter is used instead. If neither is present, the tag is used in place of the title.
+
*'''ArtistId''' is optionally used to specify the record number of the 1st cover artist, if known. It is 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.
 +
 
 +
*'''Title''' may specify the title of the book. This will be used in formatting the link to the publication record, as the optional name parameter to [[:Template:P]]. If "Title=" is not present, the 3rd unnamed parameter is used instead. If neither is present, the tag is used in place of the title. (Note that therefore an unnam,es parameter should not be used for title unless both ID and Artist use unnamed parameters also. All or none should be unnamed.)
  
 
==Alias==
 
==Alias==
Line 48: Line 65:
 
<code>
 
<code>
 
<nowiki>{{</nowiki>CID3<br>
 
<nowiki>{{</nowiki>CID3<br>
|Id=<TAG> <br />
+
|Pub=<TAG> <br />
 
|Artist=<name> <br />
 
|Artist=<name> <br />
 
|Title=<Book Title> <br />
 
|Title=<Book Title> <br />
Line 64: Line 81:
  
 
<code>
 
<code>
<nowiki>{{</nowiki>CID3|<TAG>|<Artist's name>|<Book Title><nowiki>}}</nowiki></code>  
+
<nowiki>{{</nowiki>CID3|<TAG>|<Artist's name>|<Book Title><nowiki>}}</nowiki></code>
  
 +
{{AngleBracketDoc}}
  
 
== Categories ==
 
== Categories ==
Line 75: Line 93:
  
 
It also puts each such page into a category based on the artist's name, as recorded in the Artist parameter.
 
It also puts each such page into a category based on the artist's name, as recorded in the Artist parameter.
 +
 +
-------

Latest revision as of 11:21, 8 April 2017



Documentation for the template: Cover Image Data3 (transcluded from Template:Cover Image Data3/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.

This template provides less information than does Template:Cover Image Data, but requires less user input. However, it does document the cover artist, and put the image page into an artist category, as Template:Cover Image Data2 does not. It is therefore a sort of middle ground between Template:Cover Image Data and Template:Cover Image Data2

Usage

Call this template as:

{{Cover Image Data3
|Pub=<TAG>
|Artist=<Canonical or credited name of artist>
|Title=<Book Title>
}}

or as:

{{Cover Image Data3
|Id=<TAG>
|Artist=<Canonical or credited name of artist>
|Title=<Book Title>
}}

or as:

{{Cover Image Data3
|Pub=<TAG>
|Artist=<name>
}}

or as:

{{Cover Image Data3|<TAG>|<Artist's name>|<Book Title>}}

or as:

{{Cover Image Data3|<TAG>|<Artist's name>|}}

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.

Parameters

  • Pub must specify a publication record tag or record number, an acceptable argument to Template:P (which see). Id may be used instead. If neither the "Pub=" nor the "Id=" parameter is present, the first unnamed parameter is used. One of these must be present and valid for the template to work correctly.
  • Artist should specify the name of the artist who created the cover image. The artist may be specified either as credited for this particular work, or by his or her ISFDB canonical name. If the "Artist=" parameter is not present, the 2nd unnamed parameter is used. Note that it therefore does not work to specify the Id parameter with a name, but the Artist parameter without one. Either both should be supplied as named parameters, or both as positional (unnamed) parameters. While the template will work without the artist being specified (it defaults to "Unknown") the main point of using this template, as opposed to {{Cover Image Data2}}, is the ability to specify the artist, and put the image into an artist category automatically. So this parameter is "almost required". If the image is one that has only lettering against a plain background, or otherwise has no real "art", and has no credited creator, specify the artist as None.
  • ArtistId is optionally used to specify the record number of the 1st cover artist, if known. It is 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.
  • Title may specify the title of the book. This will be used in formatting the link to the publication record, as the optional name parameter to Template:P. If "Title=" is not present, the 3rd unnamed parameter is used instead. If neither is present, the tag is used in place of the title. (Note that therefore an unnam,es parameter should not be used for title unless both ID and Artist use unnamed parameters also. All or none should be unnamed.)

Alias

To reduce typing, the alias {{CID3}} has been created for this template. So this template can also be called as

{{CID3
|Pub=<TAG>
|Artist=<name>
|Title=<Book Title>
}}

or as:

{{CID3
|Id=<TAG>
|Artist=<name>
}}

or as:

{{CID3|<TAG>|<Artist's name>|<Book Title>}}

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).

Categories

This template puts all pages that transclude (call) it into the following categories:

It also puts each such page into a category based on the artist's name, as recorded in the Artist parameter.