Template:Book/doc

From HandWiki
< Template:Book
Revision as of 16:23, 4 January 2024 by MainEditor (talk | contribs) (Created page with "{{Documentation subpage}} <!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE --> {{High-use| 43,000 }} {{Auto italic title}} {{Tracks Wikidata|P18|cat=No local image but image on Wikidata}} {{Uses Wikidata|P136|P577|P212|P856|P1036|P1104|P1149}} {{Lua|Module:Infobox|Module:Infobox/utilities|Module:InfoboxImage|Module:Check for unknown parameters|Module:ISBNT|Module:Lang|Module:Wikidata|noprotcat=yes}} This template is used to present a consistently-formatted table for use...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Lua error in package.lua at line 80: module 'Module:Transclusion_count/data/B' not found.

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

Usage

{{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       = <!-- for books in a series -->
| followed_by       = <!-- for books in a series -->
| 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
For a title page from a Commons PDF, specify the page and width in the syntax: [[File:Lissagaray - Histoire de la Commune de 1871, MS.djvu|page=9|220px]]
image_size
Uses image size set by user (default 220px). Use a number to override image size. However, this is discouraged per WP:THUMBSIZE.
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. [[File:Example.jpg]]); in this case add the border in |image= (e.g. [[File: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; required if using |native_external_url= or |native_wikisource=
orig_lang_code
ISO 639 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, if any
country
Country of original publication
language
Language of original book. Do not link unless it is an unusual language.
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. Use approximate dates/places if it is not clearly specified in the text.
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

Template:Infobox book/sandbox

{{Infobox book
| name           = Anne of Green Gables
| image          = Lucy Maud Montgomery, Anne of Green Gables, 1908, title page.jpg
| caption        = Title page of the first edition
| alt            = Title page
| author         = [[Lucy Maud Montgomery]]
| title_orig     = 
| working_title = 
| 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

TemplateData documentation used by VisualEditor and other tools
Click here to see a monthly parameter usage report for this template in articles based on this TemplateData.

TemplateData for Book

Consistently-formatted table for presenting information about books

Template parameters

This template has custom formatting.

ParameterDescriptionTypeStatus
Namename

Book title

Default
Pagename
Stringoptional
Imageimage

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

Filesuggested
Authorauthor

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

Stringsuggested
Languagelanguage

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

Example
English
Stringoptional
Countrycountry

Country of (original) publication.

Stringoptional
Genregenre

The book's genre

Example
Science fiction
Stringoptional
Publishedpublished

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

Stringoptional
Publisherpublisher

Name of publisher.

Stringoptional
ISBNisbn ISBN

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

Stringsuggested
exclude cover?exclude_cover

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

Example
yes
Stringoptional
Seriesseries

Series the book is part of

Example
[[The Federalist Papers]]
Stringoptional
Image sizeimage_size

no description

Example
200 px
Stringoptional
Image captioncaption

a caption for the image used

Contentoptional
Type of mediamedia_type

no description

Example
[[Newspaper]]
Stringoptional
Date of publicationpub_date

Date the book or work was published

Example
December 21, 1787
Datesuggested
Preceded bypreceded_by

The previous installment in the series/from the author

Example
[[Federalist No. 4]]
Stringoptional
Followed byfollowed_by

The next installment in the series/from the author

Example
[[Federalist No. 6]]
Stringoptional
italic titleitalic title

no description

Unknownoptional
infoboxwidthinfoboxwidth

no description

Unknownoptional
widthwidth

no description

Unknownoptional
image_captionimage_caption

no description

Unknownoptional
editorseditors

no description

Unknownoptional
editoreditor

no description

Unknownoptional
authorsauthors

no description

Unknownoptional
audio_read_byaudio_read_by

no description

Unknownoptional
title_origtitle_orig

no description

Unknownoptional
title_workingtitle_working

no description

Unknownoptional
translatorstranslators

no description

Unknownoptional
translatortranslator

no description

Unknownoptional
illustratorsillustrators

no description

Unknownoptional
illustratorillustrator

no description

Unknownoptional
cover_artistcover_artist

no description

Unknownoptional
release_numberrelease_number

no description

Unknownoptional
subjectssubjects

no description

Unknownoptional
subjectsubject

no description

Unknownoptional
genresgenres

no description

Unknownoptional
set_inset_in

no description

Unknownoptional
publisher2publisher2

no description

Unknownoptional
release_daterelease_date

no description

Unknownoptional
english_pub_dateenglish_pub_date

no description

Unknownoptional
english_release_dateenglish_release_date

no description

Unknownoptional
pagespages

no description

Unknownoptional
awardsawards

no description

Unknownoptional
awardaward

no description

Unknownoptional
isbn_noteisbn_note ISBN_note

no description

Unknownoptional
deweydewey

no description

Unknownoptional
congresscongress

no description

Unknownoptional
lastlast

no description

Unknownoptional
firstfirst

no description

Unknownoptional
locationlocation

no description

Unknownoptional
oclcoclc

no description

Unknownoptional
altalt

no description

Unknownoptional
borderborder

no description

Unknownoptional
orig_lang_codeorig_lang_code

no description

Unknownoptional
preceded_by_quotation_markspreceded_by_quotation_marks

no description

Unknownoptional
followed_by_quotation_marksfollowed_by_quotation_marks

no description

Unknownoptional
native_wikisourcenative_wikisource

no description

Unknownoptional
native_external_urlnative_external_url

no description

Unknownoptional
native_external_hostnative_external_host

no description

Unknownoptional
wikisourcewikisource

no description

Unknownoptional
external_urlexternal_url

no description

Unknownoptional
external_hostexternal_host

no description

Unknownoptional
websitewebsite

no description

Unknownoptional
homepagehomepage

no description

Unknownoptional
URLURL

no description

Unknownoptional
notesnotes

no description

Unknownoptional
notenote

no description

Unknownoptional
nocat_wdimagenocat_wdimage

no description

Unknownoptional

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

See also