Template:Infobox book/doc: Difference between revisions

From Vigyanwiki
< Template:Infobox book
Template>Zyxw
(update list of modules used, update tracking category list, add links to supporting templates)
Template>Zyxw
(→‎TemplateData: collapse this section since the parameters are already described in a different section)
Line 177: Line 177:


== TemplateData ==
== TemplateData ==
{{TemplateData header}}
{{Collapse top|[[Wikipedia:TemplateData|TemplateData]] documentation used by [[Wikipedia:VisualEditor|VisualEditor]] and other tools}}
{{TemplateData header|noheader=1}}
<templatedata>
<templatedata>
{
{
Line 242: Line 243:
}
}
</templatedata>
</templatedata>
{{Collapse bottom}}


== Translated books ==
== Translated books ==

Revision as of 08:22, 26 November 2018

Template:Auto italic title

This template is used to present a consistently-formatted table for use in articles about books. Template:ClearTOC

Usage

name
alt
caption
Authorauthor
Audio read byaudio_read_by
Original titletitle_orig
Working titletitle_working
Translatortranslator
Illustratorillustrator
Cover artistcover_artist
Countrycountry
Languagelanguage
Seriesseries
Release number
release_number
Subjectsubject
Genregenre
Set inset_in
Publishedpublished
Publisherpublisher, publisher2
Publication date
pub_date
Published in English
english_pub_date
Media typemedia_type
Pagespages
Awardsawards
ISBNisbn Parameter error in {{ISBN}}: invalid character
[[OCLC (identifier)|OCLC]]oclc
dewey
[[LCC (identifier)|LC Class]]congress
Preceded bypreceded_by 
Followed byfollowed_by 
Original text
title_orig at Interlingua Wikisource
Translationname at Wikisource
notes
{{Infobox book
| italic title      = <!--(see above)-->
| name              = 
| image             = 
| image_size        = 
| border            = 
| alt               = 
| caption           = 
| author            = 
| audio_read_by     = 
| title_orig        = 
| orig_lang_code    = 
| title_working     = 
| translator        = 
| illustrator       = 
| cover_artist      = 
| country           = 
| language          = 
| series            = 
| release_number    = 
| subject           = 
| genre             = 
| set_in            = 
| publisher         = 
| publisher2        = 
| pub_date          = 
| english_pub_date  = 
| published         = 
| media_type        = 
| pages             = 
| awards            = 
| isbn              = 
| isbn_note         = 
| oclc              = 
| dewey             = 
| congress          = 
| preceded_by       = 
| followed_by       = 
| native_wikisource = 
| wikisource        = 
| notes             = 
| exclude_cover     = 
| 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), use bare filename: Example.jpg
image_size
Uses image size set by user (default 220px). Use a number to override image size.
border
Inserting yes here will result in a 1px grey border around the image, useful for instances where the image and the background will blend together (such as a book cover with a white background). If no border is necessary, this parameter should not be used. Note: does not apply if |image= uses the full image syntax (e.g. [[Image:Example.jpg]]); in this case add the border in |image= (e.g. [[Image:Example.jpg|border=yes]])
caption
Image caption (should describe the edition used)
alt
Image alternate text
editor/editors
Editor(s) only when they are the primary contributor, e.g. dictionaries, encyclopedias, anthologies
author/authors
Author(s)
audio_read_by
For audiobooks.
title_orig
Original title, if not in English
orig_lang_code
ISO code of original language, required if using |title_orig=, |native_wikisource= or |native_external_url=
working_title
Working title, when different from published title
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
series
Series (if any)
release_number
The "release number" of a book within the "series" (also would be called a "volume") - n.b. only relevant for an article where "series" is populated
subject/subjects
(for non-fiction) See index term and library classification
genre/genres
(for fiction) See literary genre. Use {{hlist}} for sorting multiple entries.
set_in
can be both time and place as setting. No need to create long lists.
publisher
Publisher of primary publication (prefer 1st edition); also |publisher2= for additional publishers.
pub_date
Date published (1st edition)
english_pub_date
Date first published in English if 1st edition is in another language.
published
Alternate parameter, using the following composite format: year (publisher) (language, when originally written in a foreign language); use {{plainlist}} when there is more than one notable edition
Note: |published= is acceptable, but no longer preferred to |publisher= and |pub_date=, which have been restored to common usage. No consensus has yet been reached regarding the migration of infoboxes to a common format, and none should be "fixed" one way or the other en masse until such consensus is reached.
media_type
Print / Digital (then binding types etc., if relevant)
pages
Pages (prefer 1st edition, specify edition as needed)
award/awards
Awards(s) the book has won
isbn
(prefer ISBN of 1st edition). Format: "1-234-56789-0" (10-digit) or "978-1-234-56789-0" (13-digit). If the book has a standard book number (9 digits) add a "0" to the beginning of the number. Do not change a 10-digit to a 13-digit ISBN by prefixing a "978" by hand, because the last digit is a calculated check digit, which will be wrong. Similarly, do not remove "978-" from a 13-digit ISBN to make a 10-digit ISBN. If the book was published before the use of ISBN, do not include this parameter. If the 13-digit number you have does not start with "978", "979-10", or "979-11", then it is not an ISBN and should not be used in this parameter. Change spaces in the ISBN to hyphens. The rules for hyphenating an ISBN are complex (currently 29 pages). Do not add spaces or hyphens to an unformatted ISBN which are likely to be wrong if you are guessing. However the "978" prefix of a 13-digit ISBN is always separated by a hyphen and the check digit – the last character – is always separated by a hyphen. The last character of a 10-character ISBN may be an "X". In such case, use the uppercase "X" character, not any alternate character. Do not put "ISBN " in front of the number. ISBNs are checked for validity; articles with invalid ISBNs are placed in Category:Pages with ISBN errors and display a red error message.
isbn_note
May be used to add a note following the ISBN.
oclc
OCLC number (prefer 1st edition), use when book has no ISBN
dewey
Dewey Decimal Classification
congress
Library of Congress Classification (not to be confused with Library of Congress Control Number)
preceded_by
Title of prior book in series; will be italicised by template code (do not use to connect separate books chronologically)
preceded_by_quotation_marks
Title of prior work in series if a minor work; will be surrounded with quotation marks by template code (do not use to connect separate books chronologically)
followed_by
Title of subsequent book in a series or a sequel; will be italicised by template code (do not use to connect separate books chronologically)
followed_by_quotation_marks
Title of subsequent work in a series or a sequel if a minor work; will be surrounded with quotation marks by template code (do not use to connect separate books chronologically)
native_wikisource
Page name of original text at a foreign language Wikisource (if applicable); use |orig_lang_code= to specify which Wikisource. Tracked in Category:Articles that link to foreign-language Wikisources
native_external_url
URL to a site hosting the original text when in a foreign language, and in the public domain but not yet on Wikisource. Non-commercial, open and accessible sites should be used in preference, sites which rip the text from other sites should be avoided, and illegal content is never to be linked to
native_external_host
The name of the website linked to by |native_external_url=, e.g. Project Gutenberg, Internet Archive. Should be wikilinked if possible
wikisource
Title of work if in the public domain and hosted at English Wikisource:. Tracked in Category:Articles that link to Wikisource
external_url
URL to a site hosting the text in English (whether the original or a translation), when in the public domain but not yet on Wikisource. Non-commercial, open and accessible sites should be used in preference, sites which rip the text from other sites should be avoided, and illegal content is never to be linked to
external_host
The name of the website linked to by |external_url=, e.g. Project Gutenberg, Internet Archive. Should be wikilinked if possible
exclude_cover
This template will place articles with this infobox where no image has been specified into the category Books with missing cover; where this is not desired, e.g because the cover is shown elsewhere in the article, this parameter should be set to |exclude_cover=yes.
website
for the publisher's or author's website about the book.

Example

Anne of Green Gables
Cover
The front (first) page of the first edition
AuthorLucy Maud Montgomery
IllustratorM. A. and W. A. J. Claus
CountryUnited States
LanguageEnglish
GenreChildren's novel
PublisherL. C. Page & Co.
Publication date
1908
Pages429 (first edition)
[[OCLC (identifier)|OCLC]]367111
[[LCC (identifier)|LC Class]]PR6025.O45 A53
Followed byAnne of Avonlea 
TextAnne of Green Gables at Wikisource
{{Infobox book
| name           = Anne of Green Gables
| image          = FirstPageGreenGables.gif
| caption        = The front (first) page of the first edition
| alt            = Cover
| author         = [[Lucy Maud Montgomery]]
| title_orig     = 
| working_titl e = 
| translator     = 
| illustrator    = M. A. and W. A. J. Claus
| cover_artist   = 
| country        = United States
| language       = English
| series         = 
| release_number = 
| subject        = 
| genre          = [[Children's literature|Children's novel]]
| publisher      = [[L. C. Page & Co.]]
| pub_date       = 1908
| pages          = 429 ''(first edition)''
| awards         = 
| isbn           = <!-- N/A -->
| oclc           = 367111
| congress       = PR6025.O45 A53
| preceded_by    = 
| followed_by    = [[Anne of Avonlea]]
| wikisource     = Anne of Green Gables
}}

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

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

Consistently-formatted table for presenting information about books

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Namename

Book name.

Default
Pagename
Stringoptional
Imageimage

Image (prefer 1st edition where permitted). Use bare filename.

Stringoptional
Authorauthor

Author(s) of the book (should be link to their respective article if there is one).

Stringoptional
Languagelanguage

Language of (original) book. Full language name (not a language code).

Stringoptional
Countrycountry

Country of (original) publication.

Stringoptional
Genregenre

no description

Stringoptional
Publishedpublished

Using the following format: year (publisher) (language, when originally written in a foreign language)

Stringoptional
Publisherpublisher

Name of publisher.

Stringdeprecated
ISBNisbn

Format: "ISBN 1-234-56789-0" (prefer 1st edition)

Stringoptional
exclude_coverexclude_cover

"yes" if no image is present and adding this article to "Category:Books with missing cover" is not desired

Stringoptional

Translated books

About how to handle translated books, see the Translated books case study.

COinS

This template produces COinS metadata; see COinS in Wikipedia for background information.

Tracking categories

Supporting templates and modules

The following templates are used directly from this template:

See also