Template:Graphic novel list/sublist/doc

From blackwiki
< Template:Graphic novel list‎ | sublist
Revision as of 21:07, 23 June 2009 by imported>Goodraise (replace " list/footer" with " list/sublist/footer" (had to fork the footer after the newest rev. caused a problem))
Jump to navigation Jump to search

Usage

This template is part of a family of templates, and should be used in conjunction with {{Graphic novel list/sublist/header}} and {{Graphic novel list/sublist/footer}}, like so:

{{Graphic novel list/sublist/header|List of Foo Bar volumes
 | parameter = value
}}
{{Graphic novel list/sublist|List of Foo Bar volumes
 | parameter = value
}}
{{Graphic novel list/sublist/footer}}

It is supposed to yield the same results as {{Graphic novel list}} of which it makes use. However, it allows to yield different results when the page it is used in is transcluded onto another page, given as the first parameter (here: List of Foo Bar volumes).

Parameters

Parameter Use
{{Graphic novel list/sublist/header}}
All of this template's parameters are optional.
OneLanguage Values: "yes" (case-sensitive)
When this parameter is set to "yes", this template will produce a three-column view, ideal for displaying information when only the original language has a release. Setting this to anything else or omitting it entirely will produce a five-column view, ideal for displaying information about original-language and licensed-language releases. This parameter must also be added to transclusions of the body template if set; otherwise, the body will attempt to create five columns instead of three, resulting in mangled output.
Language Values: any
This is the language of origin. In three-column views, this defaults to nothing; in five-column views, this defaults to "Original".
SecondLanguage Values: any
This is the licensed language. This displays only in five-column views, where it defaults to "English".
Width Values: an integer number greater than zero or a percentage from 0% to 100%
Determines the width of the table. Defaults to "98%".
LineColor Values: a hex color value of the form "RGB" or "RRGGBB"
To separate the header from the main body of the table, a three-pixel colored border is added to the bottom; this determines the color of the border. Defaults to "CCF".
WithTitle Values: "yes" and "no" (both case-sensitive)
Determines whether volume titles should be displayed in the transclusion. With OneLanguage=yes, this defaults to "no". With OneLanguage=no, it is always "yes" (not showing titles has not yet been implemented).
{{Graphic novel list/sublist}}
VolumeNumber Values: any valid HTML ID (A-Z, a-z, 0-9, _, -, :, .), usually numeric
A volume number. This parameter also creates an HTML anchor which can be linked to from other pages, prefixed with "vol"; for example, [[List of chapters#vol01]].
Series
(Optional)
Values: any valid HTML ID
A non-printing parameter which is prefixed to the HTML anchor ID defined by VolumeNumber; for example, if defined as "alt" with a VolumeNumber of "02", the anchor becomes "#altvol02".
OneLanguage Values: "yes" (case-sensitive)
This controls how many columns the template produces, and should match however it was defined in the header.
RelDate
OriginalRelDate
Values: any, usually a date
The release date of the original-language work. Both parameters define the same thing. If more than one release date is necessary, separate each with <br />.
LicensedRelDate Values: any, usually a date
The release date of the licensed-language work. If more than one release date is necessary, separate each with <br />. This parameter only displays in the five-column view.
ISBN
OriginalISBN
Values: a valid ISBN-10 or ISBN-13 number
The ISBN of the original-language work. This should be only the number; the template prefixes ISBN automatically, to link it with Special:Booksources. If more than one ISBN is necessary, separate each with <br /> and add "ISBN" to all but the first.
LicensedISBN Values: a valid ISBN-10 or ISBN-13 number
The ISBN of the licensed-language work. As with ISBN/OriginalISBN, this should only be the number, unless more than one ISBN is present. This parameter only displays in the five-column view.
ChapterList
(Optional)
Values: a formatted list of chapters
A list of chapters from the volume, with specific chapter names in quotation marks.
If VolumeExtras is defined, this will occupy just over half its row; otherwise, it will occupy an entire row.
VolumeExtras
(Optional)
Values: any
Any extra information about a volume, such as the title or a list of cover characters.
If ChapterList is defined, this will occupy just under half its row; otherwise, it will occupy an entire row.
Summary
(Optional)
Values: any
A summary of the volume.
Occupies an entire row.
LineColor
(Optional)
Values: a hex color value of the form "RGB" or "RRGGBB"
In a table containing more than just release information, three-pixel colored borders are added to the bottoms of individual volume releases to separate them; this determines the color of the border. Defaults to "CCF".
Title
(Optional)
Values: The original volume title
Is unaffected by the TitleFormat parameter.
OriginalTitle
(Optional)
Values: The original volume title
LicensedTitle
(Optional)
Values: The volume title in the licensed language
TranslitTitle
(Optional)
Values: The original volume title, transliterated
TitleFormat
(Optional)
Values: The name of the template used to display the volume title
Defaults to nihongo.
{{Graphic novel list/sublist/footer}}
This template has no parameters.

Examples

One language without titles view

Basic use
{{Graphic novel list/sublist/header|List of Foo Bar volumes
 | OneLanguage = yes
}}
{{Graphic novel list/sublist|List of Foo Bar volumes
 | OneLanguage     = yes
 | VolumeNumber    = 00
 | RelDate         = December 31, 1969
 | ISBN            = 9784000000000
}}
{{Graphic novel list/sublist/footer}}

On the page it is used, it would look like this:

No. Release date ISBN
00 December 31, 19699784000000000

On List of Foo Bar volumes, it would look like this:

# Release date ISBN
00 December 31, 19699784000000000
All parameters filled in
{{Graphic novel list/sublist/header|List of Foo Bar volumes
 | OneLanguage     = yes
 | Width           = 80%
 | LineColor       = FCC
}}
{{Graphic novel list/sublist|List of Foo Bar volumes
 | OneLanguage     = yes
 | VolumeNumber    = 00
 | RelDate         = December 12, 2012
 | ISBN            = 9781000000009
 | ChapterList     = 
* 001. "Former Part"
* 002. "Latter Part"
 | VolumeExtras    = 
;Cover character(s)
* Character 1
* Character 2
 | Summary         = The story was moved forward and characters were developed.
 | LineColor       = FCC
}}
{{Graphic novel list/sublist/footer}}

On the page it is used, it would look like this:

No. Release date ISBN
00 December 12, 20129781000000009
  • 001. "Former Part"
  • 002. "Latter Part"
The story was moved forward and characters were developed.

On List of Foo Bar volumes, it would look like this:

# Release date ISBN
00 December 12, 20129781000000009
  • 001. "Former Part"
  • 002. "Latter Part"
The story was moved forward and characters were developed.

One language with titles view

Basic use
{{Graphic novel list/sublist/header|List of Foo Bar volumes
 | OneLanguage = yes
 | WithTitle   = yes
}}
{{Graphic novel list/sublist|List of Foo Bar volumes
 | OneLanguage     = yes
 | VolumeNumber    = 00
 | RelDate         = December 31, 1969
 | ISBN            = 9784000000000
 | Title           = Title
}}
{{Graphic novel list/sublist/footer}}

On the page it is used, it would look like this:

No. Release date ISBN
00TitleDecember 31, 19699784000000000

On List of Foo Bar volumes, it would look like this:

# Title Release date ISBN
00TitleDecember 31, 19699784000000000
All parameters filled in
{{Graphic novel list/sublist/header|List of Foo Bar volumes
 | OneLanguage     = yes
 | WithTitle       = yes
 | Width           = 80%
 | LineColor       = FCC
}}
{{Graphic novel list/sublist|List of Foo Bar volumes
 | OneLanguage     = yes
 | VolumeNumber    = 00
 | RelDate         = December 12, 2012
 | ISBN            = 9781000000009
 | ChapterList     = 
* 001. "Former Part"
* 002. "Latter Part"
 | Title           = Title
 | VolumeExtras    = 
;Cover character(s)
* Character 1
* Character 2
 | Summary         = The story was moved forward and characters were developed.
 | LineColor       = FCC
}}
{{Graphic novel list/sublist/footer}}

On the page it is used, it would look like this:

No. Release date ISBN
00TitleDecember 12, 20129781000000009
  • 001. "Former Part"
  • 002. "Latter Part"
The story was moved forward and characters were developed.

On List of Foo Bar volumes, it would look like this:

# Title Release date ISBN
00TitleDecember 12, 20129781000000009
  • 001. "Former Part"
  • 002. "Latter Part"
The story was moved forward and characters were developed.

Two languages without titles view

Not yet implemented.

Two languages with titles view

Basic use
{{Graphic novel list/sublist/header|List of Foo Bar volumes
| Language    = Language
| Region      = Region
| SecondRegion= Second Region
}}
{{Graphic novel list/sublist|List of Foo Bar volumes
 | VolumeNumber    = 00
 | OriginalRelDate = December 31, 1969
 | OriginalISBN    = 9784000000000
 | LicensedRelDate = December 12, 2012
 | LicensedISBN    = 9781000000009
 | LicensedTitle   = Licensed Title
 | OriginalTitle   = Original Title
 | TranslitTitle   = Transliterated Title
}}
{{Graphic novel list/sublist/footer}}

On the page it is used, it would look like this:

No. Original release date Original ISBN English release date English ISBN
00Licensed Title
Transliterated Title (Original Title)
December 31, 1969
9784000000000
December 12, 2012
9781000000009

On List of Foo Bar volumes, it would look like this:

Title Volume Release date
English Language Region Second Region
00Licensed Title
Transliterated Title (Original Title)
December 31, 1969
9784000000000
December 12, 2012
9781000000009
All parameters filled in
{{Graphic novel list/sublist/header|List of Foo Bar volumes
 | Language       = Original
 | Region         = Region
 | Width          = 80%
 | LineColor      = FCC
 | SecondRegion   = Second Region
}}
{{Graphic novel list/sublist|List of Foo Bar volumes
 | VolumeNumber    = 00
 | OriginalRelDate = December 31, 1969
 | OriginalISBN    = 9784000000000
 | LicensedRelDate = December 12, 2012
 | LicensedISBN    = 9781000000009
 | ChapterList     = 
* 001. {{nihongo|"Former Part"|前編|"Zenpen"}}
* 002. {{nihongo|"Latter Part"|後編|"Kōhen"}}
 | LicensedTitle   = Licensed Title
 | OriginalTitle   = Original Title
 | TranslitTitle   = Transliterated Title
 | VolumeExtras    = 
;Cover character(s)
* Character 1
* Character 2
 | Summary         = The story was moved forward and characters were developed.
 | LineColor       = FCC
}}
{{Graphic novel list/sublist/footer}}

On the page it is used, it would look like this:

No. Original release date Original ISBN English release date English ISBN
00Licensed Title
Transliterated Title (Original Title)
December 31, 1969
9784000000000
December 12, 2012
9781000000009
The story was moved forward and characters were developed.

On List of Foo Bar volumes, it would look like this:

Title Volume Release date
English Original Region Second Region
00Licensed Title
Transliterated Title (Original Title)
December 31, 1969
9784000000000
December 12, 2012
9781000000009
The story was moved forward and characters were developed.

Notes

ISBNs may be given in either unhyphenated format (for example, 9781000000009) or hyphenated format (978-1-00-000000-9). If converting an unhyphenated ISBN to a hyphenated one, you can use the reference list of group and publisher numbers, provided by the International ISBN Agency, or one of several online converters.

If you're having trouble making a one-language list, the |OneLanguage=yes parameter needs to be not only in the header, but also in every volume's code. (e.g. List of Psyren chapters )