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

From ISFDB
Jump to navigation Jump to search
(→‎Usage: Pub)
(add ArtistIds)
 
(One intermediate revision by one other user not shown)
Line 57: Line 57:
  
 
==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.
  
 
*'''Artist1''' should specify the name of the 1st artist who joined in creating 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 "Artist1=" 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 Artist1 parameter without one. Either both should be supplied as named parameters, or both as positional (unnamed) parameters. While the template will work without the artists being specified (the parameter defaults to "Unknown") the main point of using this template, as opposed to {{tl|Cover Image Data2}}, is the ability to specify the artists, and put the image into artist categories automatically. So this parameter is "almost required".
 
*'''Artist1''' should specify the name of the 1st artist who joined in creating 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 "Artist1=" 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 Artist1 parameter without one. Either both should be supplied as named parameters, or both as positional (unnamed) parameters. While the template will work without the artists being specified (the parameter defaults to "Unknown") the main point of using this template, as opposed to {{tl|Cover Image Data2}}, is the ability to specify the artists, and put the image into artist categories automatically. So this parameter is "almost required".
 +
 +
*'''Artist1Id''' 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 "Artist1" field also has to be filled in.
  
 
*'''Artist2''' should specify the name of the 2nd artist who joined in creating 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 "Artist2=" parameter is not present, the 3rd unnamed parameter is used. Note that it therefore does not work to specify the Id or Artist1 parameter with a name, but the Artist2 parameter without one. Either all three should be supplied as named parameters, or all three as positional (unnamed) parameters. While the template will work without the artists being specified (the parameter defaults to "Unknown") the main point of using this template, as opposed to {{tl|Cover Image Data2}}, is the ability to specify the artists, and put the image into artist categories automatically. So this parameter is "almost required".
 
*'''Artist2''' should specify the name of the 2nd artist who joined in creating 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 "Artist2=" parameter is not present, the 3rd unnamed parameter is used. Note that it therefore does not work to specify the Id or Artist1 parameter with a name, but the Artist2 parameter without one. Either all three should be supplied as named parameters, or all three as positional (unnamed) parameters. While the template will work without the artists being specified (the parameter defaults to "Unknown") the main point of using this template, as opposed to {{tl|Cover Image Data2}}, is the ability to specify the artists, and put the image into artist categories automatically. So this parameter is "almost required".
 +
 +
*'''Artist2Id''' 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 "Artist2" 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 4th unnamed parameter is used instead. If neither is present, the tag is used in place of the title. (Note that therefore an unnamed parameter should not be used for Title unless ID, Artist1 and Artist2 use unnamed parameters also. All or none should be unnamed.)
 
*'''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 4th unnamed parameter is used instead. If neither is present, the tag is used in place of the title. (Note that therefore an unnamed parameter should not be used for Title unless ID, Artist1 and Artist2 use unnamed parameters also. All or none should be unnamed.)

Latest revision as of 11:17, 8 April 2017



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

This variant of Template:Cover Image Data3 is intended exclusively for the case where there are two joint cover image artists to be credited.

Usage

Call this template as:

{{Cover Image Data3-2
|Pub=<TAG>
|Artist1=<Canonical or credited name of artist>
|Artist2=<Canonical or credited name of artist>
|Title=<Book Title>
}}

or as:

{{Cover Image Data3-2
|Id=<TAG>
|Artist1=<Canonical or credited name of artist>
|Artist2=<Canonical or credited name of artist>
|Title=<Book Title>
}}

or as:

{{Cover Image Data3-2
|Pub=<TAG>
|Artist1=<name>
|Artist2=<name>
}}

or as:

{{Cover Image Data3-2|<TAG>|<1st Artist's name>|<2nd Artist's name>|<Book Title>}}

or as:

{{Cover Image Data3-2|<TAG>|<1st Artist's name>|<2nd 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.
  • Artist1 should specify the name of the 1st artist who joined in creating 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 "Artist1=" 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 Artist1 parameter without one. Either both should be supplied as named parameters, or both as positional (unnamed) parameters. While the template will work without the artists being specified (the parameter defaults to "Unknown") the main point of using this template, as opposed to {{Cover Image Data2}}, is the ability to specify the artists, and put the image into artist categories automatically. So this parameter is "almost required".
  • Artist1Id 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 "Artist1" field also has to be filled in.
  • Artist2 should specify the name of the 2nd artist who joined in creating 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 "Artist2=" parameter is not present, the 3rd unnamed parameter is used. Note that it therefore does not work to specify the Id or Artist1 parameter with a name, but the Artist2 parameter without one. Either all three should be supplied as named parameters, or all three as positional (unnamed) parameters. While the template will work without the artists being specified (the parameter defaults to "Unknown") the main point of using this template, as opposed to {{Cover Image Data2}}, is the ability to specify the artists, and put the image into artist categories automatically. So this parameter is "almost required".
  • Artist2Id 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 "Artist2" 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 4th unnamed parameter is used instead. If neither is present, the tag is used in place of the title. (Note that therefore an unnamed parameter should not be used for Title unless ID, Artist1 and Artist2 use unnamed parameters also. All or none should be unnamed.)

Alias

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

{{CID3-2
|Id=<TAG>
|Artist1=<name>
|Artist2=<name>
|Title=<Book Title>
}}

or as:

{{CID3-2
|Id=<TAG>
|Artist1=<name>
|Artist2=<name>
}}

or as:

{{CID3|<TAG>|<1st Artist's name>|<2nd Artist's name>|<Book Title>}}

Categories

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

It also puts each such page into three categories based on the artists' names, as recorded in the Artist parameters -- one for each artist, and a joint works category.