Template:Infobox book series/doc: Difference between revisions

From Vigyanwiki
< Template:Infobox book series
temp>Izkala
(demo)
m (49 revisions imported from alpha:Template:Infobox_book_series/doc)
 
(23 intermediate revisions by 15 users not shown)
Line 1: Line 1:
{{Documentation subpage}}
{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE AND INTERWIKIS TO WIKIDATA -->
<!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE AND INTERWIKIS TO WIKIDATA -->
{{Auto italic title}}
{{Lua|Module:Infobox|Module:InfoboxImage|Module:Check for unknown parameters}}
This template is for use on a [[book series]] main page.
This template is for use on a [[book series]] main page.
{{bad documentation}}


== Usage ==
== Usage ==
{{Parameter names example|author=|books|country|cover_artist|discipline|editors|english_pub_date|followed by|followed_by|genre=|illustrator|image|image_caption|infoboxwidth|language|list_books|media_type|name|number_of_books|oclc|preceded by|preceded_by|pub_date|publisher|title_orig|translator|website}}
{{Parameter names example|author=|books|country|cover_artist|discipline|editors|english_pub_date|followed by|followed_by|genre=|illustrator|image|image_caption|infoboxwidth|language|list_books|media_type|name|number_of_books|oclc|preceded by|preceded_by|pub_date|publisher|title_orig|translator|website|italic title=no}}
<pre style="overflow: auto;">
<pre style="overflow: auto;">
{{Infobox book series
{{Infobox book series
| name            =  
| name            =  
| image            = <!-- include the file, px and alt: [[File:Example.jpg|200px|Cover]] -->
| image            = <!-- Example.jpg -->
| image_caption    =  
| image_caption    =  
| books            =  
| books            =  
| author          =
| author          =  
| editors          =
| editors          =  
| title_orig      =  
| title_orig      =  
| translator      =  
| translator      =  
Line 21: Line 22:
| country          =  
| country          =  
| language        =  
| language        =  
| genre            =
| discipline      = <!-- or |genre= -->
| discipline      =
| publisher        =  
| publisher        =  
| pub_date        =  
| pub_date        =  
Line 33: Line 33:
| followed by      =  
| followed by      =  
| website          =  
| website          =  
}}
}}</pre>
</pre>
 
== Parameters ==
''Please see [[Wikipedia:WikiProject Books|WikiProject Books]] and/or [[Wikipedia:WikiProject Novels|WikiProject Novels]] for standards on presenting names and other data.''
* Parameters can be safely left blank. Note that you may include an image with no caption, but a caption will not be shown if there is no image.
* [[Help:Link#Wikilinks|Wikilinks]] can be used in any of the infobox fields.
 
; name: Book name or [[Title (publishing)|title]]. If parameter is left blank, ''name'' will be inherited from the [[Wikipedia:Article titles|Wikipedia page]] where this infobox is invoked.
; image: Image (prefer 1st edition – where permitted)
; image_caption: Image caption (should describe the edition used)
; books: List of works included in the series, using {{tl|plainlist}}.
; author: Author(s)
; editors: Editor(s) '''only when they are the primary contributor''', e.g. dictionaries, encyclopedias, anthologies
; title_orig: Original title, if not in English
; translator: Translator(s), if original not in English
; illustrator: Illustrator (where used throughout and a major feature)
; cover_artist: Cover artist
; country: Country of original publication
; language: Language of original book
; discipline or genre: ''See [[literary genre]]''
; publisher: Name of publisher; use {{tl|plainlist}} when there is more than one notable edition
; pub_date: Date of publication; use {{tl|plainlist}} when there is more than one notable edition
; media_type: Print / Digital (then binding types etc., if relevant)
; number_of_books: Number of works in the series
; list_books: If a Wikipedia "List of" article exists for the books, put its name here. Do not use a link (i.e. do not include [[ ]]).
; preceded_by: Title of prior series.
; followed_by: Title of subsequent series.
; website: for the publisher's or author's website about the book.
 
== TemplateData ==
{{collapse top|[[Wikipedia:TemplateData|TemplateData]] documentation used by [[Wikipedia:VisualEditor|VisualEditor]] and other tools}}
{{TemplateData header|noheader=1}}
<div style="width:auto; overflow:scroll">
<templatedata>
{
"description": "A template for displaying information related to a book series.",
"params": {
"name": {
"label": "Name",
"type": "string",
"suggested": true,
"description": "Book name or title"
},
"image": {
"label": "Image",
"type": "wiki-file-name",
"required": false,
"description": "Prefer first edition where permitted"
},
"image_caption": {
"label": "Image caption",
"type": "string",
"required": false,
"description": "Should describe the edition used"
},
"alt": {
"label": "Alt text",
"type": "string",
"required": false,
"description": "Alternative text for image"
},
"books": {
"label": "Books",
"type": "string",
"required": false,
"description": "List of works included in the series, using {{plainlist}}"
},
"author": {
"label": "Author",
"type": "string",
"suggested": true,
"description": "Author(s)"
},
"editors": {
"label": "Editors",
"type": "string",
"required": false,
"description": "Editor(s) only when they are the primary contributor, e.g. dictionaries, encyclopedias, anthologies"
},
"title_orig": {
"label": "Original title",
"type": "string",
"required": false,
"description": "Original title, if not in English"
},
"translator": {
"label": "Translator",
"type": "string",
"required": false,
"description": "Translator(s), if original not in English"
},
"illustrator": {
"label": "Illustrator",
"type": "string",
"required": false,
"description": "Illustrator (where used throughout and a major feature)"
},
"cover_artist": {
"label": "Cover artist",
"type": "string",
"required": false,
"description": "Creator of the cover art"
},
"country": {
"label": "Country",
"type": "string",
"required": false,
"description": "Country of original publication"
},
"language": {
"label": "Language",
"type": "string",
"suggested": true,
"description": "Language of original book"
},
"discipline": {
"label": "Discipline",
"type": "string",
"required": false,
"description": "Literary discipline. Mutually exclusive with 'genre'"
},
"genre": {
"label": "Genre",
"type": "string",
"required": false,
"description": "Literary genre. Mutually exclusive with 'discipline'"
},
"publisher": {
"label": "Publisher",
"type": "string",
"suggested": true,
"description": "Name of publisher; use {{plainlist}} when there is more than one notable edition"
},
"pub_date": {
"label": "Publication date",
"type": "string",
"suggested": true,
"description": "Date of publication; use {{plainlist}} when there is more than one notable edition"
},
"media_type": {
"label": "Media type",
"type": "string",
"required": false,
"description": "Print / Digital (then binding types etc., if relevant)"
},
"number_of_books": {
"label": "Number of books",
"type": "number",
"suggested": true,
"description": "Number of works in the series"
},
"list_books": {
"label": "List of books",
"type": "wiki-page-name",
"required": false,
"description": "If a Wikipedia 'List of' article exists for the books, put its name here. Do not use a link (i.e. do not include [[ ]])."
},
"preceded_by": {
"label": "Preceded by",
"type": "string",
"required": false,
"description": "Title of prior series"
},
"followed_by": {
"label": "Followed by",
"type": "string",
"required": false,
"description": "Title of subsequent series"
},
"website": {
"label": "Website",
"type": "string",
"required": false,
"description": "For the publisher's or author's website about the book"
},
"oclc": {
"label": "OCLC",
"type": "number",
"required": false,
"description": "Identifying number assigned by the Online Computer Library Center"
}
},
"format": "block",
"paramOrder": [
"name",
"image",
"image_caption",
"alt",
"books",
"author",
"editors",
"title_orig",
"translator",
"illustrator",
"cover_artist",
"country",
"language",
"discipline",
"genre",
"publisher",
"pub_date",
"media_type",
"number_of_books",
"list_books",
"preceded_by",
"followed_by",
"website",
"oclc"
]
}
</templatedata>
</div>
{{collapse bottom}}
 
== Tracking category ==
* {{clc|Pages using infobox book series with unknown parameters}}


== See also ==
== See also ==
* {{tl|Book list}} - for creating formatted table of books in a series within the series article (or related list)
* {{tl|Infobox book}}
* {{tl|Book list}}—for creating formatted table of books in a series within the series article (or related list)


<includeonly>
<includeonly>{{Sandbox other||
<!-- CATEGORIES GO HERE AND INTERWIKIS GO TO WIKIDATA, THANKS -->
<!-- CATEGORIES GO HERE AND INTERWIKIS GO TO WIKIDATA, THANKS -->
[[Category:Book infobox templates|Book series]]
[[Category:Book infobox templates|Book series]]
 
[[Category:Templates that add a tracking category]]
</includeonly>
}}</includeonly>

Latest revision as of 09:47, 15 December 2022

Template:Auto italic title

This template is for use on a book series main page.

Usage

{{{name}}}
[[File:{{{image}}}|frameless|upright=1]]
{{{image_caption}}}

{{{books}}}

Edited by{{{editors}}}
Original title
{{{title_orig}}}
Translator{{{translator}}}
Illustrator{{{illustrator}}}
Cover artist{{{cover_artist}}}
Country{{{country}}}
Language{{{language}}}
Discipline{{{discipline}}}
Publisher{{{publisher}}}
Published{{{pub_date}}}
Published in English{{{english_pub_date}}}
Media type{{{media_type}}}
No. of books{{{number_of_books}}} ([[{{{list_books}}}|List of books]])
[[OCLC (identifier)|OCLC]]{{{oclc}}}
Preceded by{{{preceded_by}}}
Followed by{{{followed_by}}}
Website{{{website}}}
{{Infobox book series
| name             = 
| image            = <!-- Example.jpg -->
| image_caption    = 
| books            = 
| author           = 
| editors          = 
| title_orig       = 
| translator       = 
| illustrator      = 
| cover_artist     = 
| country          = 
| language         = 
| discipline       = <!-- or |genre= -->
| publisher        = 
| pub_date         = 
| english_pub_date = 
| media_type       = 
| number_of_books  = 
| list_books       = 
| oclc             = 
| preceded by      = 
| followed by      = 
| website          = 
}}

Parameters

Please see WikiProject Books and/or WikiProject Novels for standards on presenting names and other data.

  • Parameters can be safely left blank. Note that you may include an image with no caption, but a caption will not be shown if there is no image.
  • Wikilinks can be used in any of the infobox fields.
name
Book name or title. If parameter is left blank, name will be inherited from the Wikipedia page where this infobox is invoked.
image
Image (prefer 1st edition – where permitted)
image_caption
Image caption (should describe the edition used)
books
List of works included in the series, using {{plainlist}}.
author
Author(s)
editors
Editor(s) only when they are the primary contributor, e.g. dictionaries, encyclopedias, anthologies
title_orig
Original title, if not in English
translator
Translator(s), if original not in English
illustrator
Illustrator (where used throughout and a major feature)
cover_artist
Cover artist
country
Country of original publication
language
Language of original book
discipline or genre
See literary genre
publisher
Name of publisher; use {{plainlist}} when there is more than one notable edition
pub_date
Date of publication; use {{plainlist}} when there is more than one notable edition
media_type
Print / Digital (then binding types etc., if relevant)
number_of_books
Number of works in the series
list_books
If a Wikipedia "List of" article exists for the books, put its name here. Do not use a link (i.e. do not include [[ ]]).
preceded_by
Title of prior series.
followed_by
Title of subsequent series.
website
for the publisher's or author's website about the book.

TemplateData

style="background: #CCFFCC; font-size:87%; padding:0.2em 0.3em; text-align:center; " |
TemplateData documentation used by VisualEditor and other tools


Infobox book series

[[Category:TemplateData documentation{{#translation:}}]]

A template for displaying information related to a book series.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Namename

Book name or title

Stringsuggested
Imageimage

Prefer first edition where permitted

Fileoptional
Image captionimage_caption

Should describe the edition used

Stringoptional
Alt textalt

Alternative text for image

Stringoptional
Booksbooks

List of works included in the series, using {{plainlist}}

Stringoptional
Authorauthor

Author(s)

Stringsuggested
Editorseditors

Editor(s) only when they are the primary contributor, e.g. dictionaries, encyclopedias, anthologies

Stringoptional
Original titletitle_orig

Original title, if not in English

Stringoptional
Translatortranslator

Translator(s), if original not in English

Stringoptional
Illustratorillustrator

Illustrator (where used throughout and a major feature)

Stringoptional
Cover artistcover_artist

Creator of the cover art

Stringoptional
Countrycountry

Country of original publication

Stringoptional
Languagelanguage

Language of original book

Stringsuggested
Disciplinediscipline

Literary discipline. Mutually exclusive with 'genre'

Stringoptional
Genregenre

Literary genre. Mutually exclusive with 'discipline'

Stringoptional
Publisherpublisher

Name of publisher; use {{plainlist}} when there is more than one notable edition

Stringsuggested
Publication datepub_date

Date of publication; use {{plainlist}} when there is more than one notable edition

Stringsuggested
Media typemedia_type

Print / Digital (then binding types etc., if relevant)

Stringoptional
Number of booksnumber_of_books

Number of works in the series

Numbersuggested
List of bookslist_books

If a Wikipedia 'List of' article exists for the books, put its name here. Do not use a link (i.e. do not include [[ ]]).

Page nameoptional
Preceded bypreceded_by

Title of prior series

Stringoptional
Followed byfollowed_by

Title of subsequent series

Stringoptional
Websitewebsite

For the publisher's or author's website about the book

Stringoptional
OCLCoclc

Identifying number assigned by the Online Computer Library Center

Numberoptional

Tracking category

See also

  • {{Infobox book}}
  • {{Book list}}—for creating formatted table of books in a series within the series article (or related list)