Template:Graphic novel list/doc
This is a documentation subpage for Template:Graphic novel list. It contains usage information, categories and other content that is not part of the original template page. |
This template uses Lua: |
Usage
This template is part of a family of templates, and should be used in conjunction with {{Graphic novel list/header}} and {{Graphic novel list/footer}}, like so:
{{Graphic novel list/header|episodes= {{Graphic novel list | parameter = value }} {{Graphic novel list | parameter = value }} }}
Alternative usage:
{{Graphic novel list/header |{{Graphic novel list | parameter = value }} {{Graphic novel list | parameter = value }} }}
Parameters
Parameter | Use |
---|---|
{{Graphic novel list/header}} All of this template's parameters are optional. | |
episodes | Only use one of these parameters! - These parameters both do the same thing and are used to place the list of {{Graphic novel list}} templates within it. See the useage at the top of the documentation. |
1 | |
OneLanguage | Values: "yes" (case-sensitive) When this parameter is set to "yes", this template will produce a three- or four-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 four- or five-column view, ideal for displaying information about original-language and licensed-language releases. |
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" (case-sensitive) When this parameter is set to "yes", this template will produce a four-column view, ideal for displaying information when the individual volumes have names. Setting this to anything else or omitting it entirely will produce a three- or five-column view, ideal for displaying information about volumes without names. |
Clear | Values: "no" When this parameter is set, this template will not automatically clear floating tables and divs (this effect can also be achieved by setting a custom width). |
{{Graphic novel list}} | |
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". |
RelDate OriginalRelDate (Optional) |
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 (Optional) |
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 /> .If both LicensedRelDate and LicensedISBN are empty, the template will yield output appropriate for one-language view. Manually insert an em-dash (—) in LicensedRelDate (but leave LicensedISBN empty) to overcome this, if a two-language view is desired. |
ISBN OriginalISBN (Optional) |
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. |
LicensedISBN (Optional) |
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. If both LicensedRelDate and LicensedISBN are empty, the template will yield output appropriate for one-language view. Manually insert an em-dash (—) in LicensedRelDate (but leave LicensedISBN empty) to overcome this, if a two-language view is desired. |
ChapterList ChapterListCol1 (Optional) |
Values: a formatted list of chapters A list of chapters from the volume, with specific chapter names in quotation marks. If ChapterListCol2 is defined, this will occupy just over half its row; otherwise, it will occupy an entire row. |
ChapterListCol2 (Optional) |
Values: a formatted list of chapters A second list of chapters from the volume, with specific chapter names in quotation marks. If ChapterList or ChapterListCol1 is defined, this will occupy just under half its row; otherwise, it will not be displayed. |
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 a chapter list and/or a summary, 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". |
OriginalTitle (Optional) |
Values: any The original language title of the volume. Use only if transliteration is required. If all title parameters are empty, the template will yield output appropriate for three- or four-column view. |
TranslitTitle (Optional) |
Values: any The original language title of the volume, transliterated if necessary. If all title parameters are empty, the template will yield output appropriate for three- or four-column view. |
Title LicensedTitle (Optional) |
Values: any The title of the volume in its licensed release. If all title parameters are empty, the template will yield output appropriate for three- or four-column view. |
SublistOf (Optional) |
Values: any If this matches the name of the page the table is displayed on, for example through transclusion, chapter lists and summaries are hidden. |
{{Graphic novel list/footer}} This template has no parameters. |
Examples
One language without titles
- Basic use
{{Graphic novel list/header | OneLanguage = yes }} {{Graphic novel list | VolumeNumber = 00 | RelDate = December 31, 1969 | ISBN = 9784000000000 }} {{Graphic novel list/footer}}
No. | Release date | ISBN |
---|---|---|
00 | December 31, 1969 | 9784000000000 |
- All parameters filled in
{{Graphic novel list/header | OneLanguage = yes | Language = English | Width = 80% | LineColor = FCC }} {{Graphic novel list | VolumeNumber = 00 | RelDate = December 12, 2012 | ISBN = 9781000000009 | ChapterListCol1 = * 001. "Former Part" | ChapterListCol2 = * 002. "Latter Part" | Summary = The story was moved forward and characters were developed. | LineColor = FCC }} {{Graphic novel list/footer}}
No. | English release date | English ISBN | ||
---|---|---|---|---|
00 | December 12, 2012 | 9781000000009 | ||
| ||||
The story was moved forward and characters were developed. |
Two languages without titles
- Basic use
{{Graphic novel list/header}} {{Graphic novel list | VolumeNumber = 00 | OriginalRelDate = December 31, 1969 | OriginalISBN = 9784000000000 | LicensedRelDate = December 12, 2012 | LicensedISBN = 9781000000009 }} {{Graphic novel list/footer}}
No. | Original release date | Original ISBN | English release date | English ISBN |
---|---|---|---|---|
00 | December 31, 1969 | 9784000000000 | December 12, 2012 | 9781000000009 |
- All parameters filled in
{{Graphic novel list/header | Language = Japanese | SecondLanguage = North American | Width = 80% | LineColor = FCC }} {{Graphic novel list | VolumeNumber = 00 | OriginalRelDate = December 31, 1969 | OriginalISBN = 9784000000000 | LicensedRelDate = December 12, 2012 | LicensedISBN = 9781000000009 | ChapterListCol1 = * 001. {{nihongo|"Former Part"|前編|"Zenpen"}} | ChapterListCol2 = * 002. {{nihongo|"Latter Part"|後編|"Kōhen"}} | Summary = The story was moved forward and characters were developed. | LineColor = FCC }} {{Graphic novel list/footer}}
No. | Original release date | Original ISBN | North American release date | North American ISBN | ||
---|---|---|---|---|---|---|
00 | December 31, 1969 | 9784000000000 | December 12, 2012 | 9781000000009 | ||
| ||||||
The story was moved forward and characters were developed. |
One language with titles
- Basic use
{{Graphic novel list/header | OneLanguage = yes | WithTitle = yes }} {{Graphic novel list | VolumeNumber = 00 | RelDate = December 31, 1969 | ISBN = 9784000000000 | Title = Title }} {{Graphic novel list/footer}}
No. | Title | Release date | ISBN |
---|---|---|---|
00 | Title | December 31, 1969 | 9784000000000 |
- All parameters filled in
{{Graphic novel list/header | OneLanguage = yes | WithTitle = yes | Language = Japanese | SecondLanguage = North American | Width = 80% | LineColor = FCC }} {{Graphic novel list | VolumeNumber = 00 | RelDate = December 12, 2012 | ISBN = 9781000000009 | ChapterListCol1 = * 001. "Former Part" | ChapterListCol2 = * 002. "Latter Part" | Summary = The story was moved forward and characters were developed. | LineColor = FCC | Title = Title }} {{Graphic novel list/footer}}
No. | Title | Japanese release date | Japanese ISBN | ||
---|---|---|---|---|---|
00 | Title | December 12, 2012 | 9781000000009 | ||
| |||||
The story was moved forward and characters were developed. |
Two languages with titles
- Basic use
{{Graphic novel list/header | WithTitle = yes }} {{Graphic novel list | VolumeNumber = 00 | OriginalRelDate = December 31, 1969 | OriginalISBN = 9784000000000 | LicensedRelDate = December 31, 1970 | LicensedISBN = 9784000000001 | OriginalTitle = Original Title | LicensedTitle = Licensed Title | TranslitTitle = Transliterated Title }} {{Graphic novel list/footer}}
No. | Title | Original release date | English release date |
---|---|---|---|
00 | Licensed Title Transliterated Title (Original Title) | December 31, 1969 9784000000000 | December 31, 1970 9784000000001 Parameter error in {{ISBN}}: Invalid ISBN. |
- All parameters filled in
{{Graphic novel list/header | WithTitle = yes | Language = Japanese | SecondLanguage = North American | Width = 80% | LineColor = FCC }} {{Graphic novel list | VolumeNumber = 00 | OriginalRelDate = December 31, 1969 | OriginalISBN = 9784000000000 | LicensedRelDate = December 31, 1970 | LicensedISBN = 9784000000001 | ChapterListCol1 = * 001. {{nihongo|"Former Part"|前編|"Zenpen"}} | ChapterListCol2 = * 002. {{nihongo|"Latter Part"|後編|"Kōhen"}} | Summary = The story was moved forward and characters were developed. | LineColor = FCC | OriginalTitle = Original Title | LicensedTitle = Licensed Title | TranslitTitle = Transliterated Title }} {{Graphic novel list/footer}}
No. | Title | Original release date | North American release date | ||
---|---|---|---|---|---|
00 | Licensed Title Transliterated Title (Original Title) | December 31, 1969 9784000000000 | December 31, 1970 9784000000001 Parameter error in {{ISBN}}: Invalid ISBN. | ||
| |||||
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.
- Apostrophes in the
|SublistOf=
parameter need to be replaced by'
due to a bug in the underlying software.
TemplateData
TemplateData for Graphic novel list
One of three templates for formatting of lists of graphic novels
Parameter | Description | Type | Status | |
---|---|---|---|---|
Volume number | VolumeNumber | A volume number. This parameter also creates an HTML anchor which can be linked to from other pages, prefixed with 'vol'. | String | required |
Graphic novel series | Series | 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'. | String | optional |
Original release date | OriginalRelDate RelDate | 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 />. | String | optional |
Licensed-language work release date | LicensedRelDate | The release date of the licensed-language work. If more than one release date is necessary, separate each with <br />. If both LicensedRelDate and LicensedISBN are empty, the template will yield output appropriate for one-language view. Manually insert an em-dash (—) in LicensedRelDate (but leave LicensedISBN empty) to overcome this, if a two-language view is desired. | String | optional |
ISBN of original-language work | OriginalISBN ISBN | The ISBN of the original-language work. This should be only the number; the template prefixes ISBN automatically, to link it with Special:Booksources. | String | optional |
ISBN of licensed-language work | LicensedISBN | The ISBN of the licensed-language work. As with ISBN/OriginalISBN, this should only be the number. If both LicensedRelDate and LicensedISBN are empty, the template will yield output appropriate for one-language view. Manually insert an em-dash (—) in LicensedRelDate (but leave LicensedISBN empty) to overcome this, if a two-language view is desired. | String | optional |
List of chapters | ChapterList ChapterListCol1 | A list of chapters from the volume, with specific chapter names in quotation marks. If ChapterListCol2 is defined, this will occupy just over half its row; otherwise, it will occupy an entire row. | String | optional |
Second list of chapters | ChapterListCol2 | A second list of chapters from the volume, with specific chapter names in quotation marks. If ChapterList or ChapterListCol1 is defined, this will occupy just under half its row; otherwise, it will not be displayed. | String | optional |
Summary | A summary of the volume. Occupies an entire row. | String | optional | |
Volume separator color | LineColor | In a table containing a chapter list and/or a summary, three-pixel colored borders are added to the bottoms of individual volume releases to separate them; this determines the color of the border. Values: a hex color value of the form 'RGB' or 'RRGGBB'. Defaults to 'CCF'. | String | optional |
Original title before transliteration | OriginalTitle | The original language title of the volume. Use only if transliteration is required. If all title parameters are empty, the template will yield output appropriate for three- or four-column view. | String | optional |
Original title after transliteration | TranslitTitle | The original language title of the volume, transliterated if necessary. If all title parameters are empty, the template will yield output appropriate for three- or four-column view. | String | optional |
Title of the volume | Title LicensedTitle | The title of the volume in its licensed release. If all title parameters are empty, the template will yield output appropriate for three- or four-column view. | String | optional |
Containing list | SublistOf | If this matches the name of the page the table is displayed on, for example through transclusion, chapter lists and summaries are hidden. | String | optional |
See also
- {{Book list}}
- {{Episode list}}
Sub-template sandboxes