Template:Infobox book/doc: Difference between revisions
From Vigyanwiki
Template>Nsaa (iw) |
m (325 revisions imported from alpha:Template:Infobox_book/doc) |
||
| (307 intermediate revisions by more than 100 users not shown) | |||
| Line 1: | Line 1: | ||
< | {{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 in articles about [[book]]s. | |||
== Usage == | |||
{{Generic template demo |_template={{BASEPAGENAME}}{{\sandbox}} |_display=italics |italic title=no | |||
|name |image=Example-serious.jpg |alt |caption |author |audio_read_by |title_orig='''title_orig''' |orig_lang_code=ia |title_working='''title_working''' |translator |illustrator |cover_artist |country |language |series |release_number |subject |genre |set_in |published |publisher |publisher2 |pub_date |english_pub_date |media_type |pages |awards |isbn=123456789X |oclc |dewey |congress |preceded_by='''preceded_by''' |followed_by='''followed_by''' |native_wikisource=Wikisource:About |wikisource=Wikisource:About |notes | |||
}} | |||
<pre style="overflow:auto;"> | |||
{{Infobox book | |||
| italic title = <!--(see above)--> | |||
! | | name = | ||
| | | image = | ||
| | | image_size = | ||
| border = | |||
| | | alt = | ||
| | | caption = | ||
| | | author = | ||
| | | audio_read_by = | ||
| | | title_orig = | ||
| | | orig_lang_code = | ||
| illustrator | | title_working = | ||
| cover_artist | | translator = | ||
| country | | illustrator = | ||
| language | | cover_artist = | ||
| series | | country = | ||
| subject | | language = | ||
| genre = | | series = | ||
| | | release_number = | ||
| pub_date | | subject = | ||
| english_pub_date = | | genre = | ||
| media_type | | set_in = | ||
| pages | | publisher = | ||
| isbn | | publisher2 = | ||
| oclc = | | pub_date = | ||
| preceded_by | | english_pub_date = | ||
| followed_by | | 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 = | |||
}}</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), use bare filename: <code><nowiki>Example.jpg</nowiki></code><br>For a title page from a [[:Commons:|Commons]] PDF, specify the page and width in [[WP:EIS|the syntax]]: <code><nowiki>[[File:Lissagaray - Histoire de la Commune de 1871, MS.djvu|page=9|220px]]</nowiki></code> | |||
; 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 <code>yes</code> 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 {{para|image}} uses the full image syntax (e.g. <code><nowiki>[[File:Example.jpg]]</nowiki></code>); in this case add the border in {{para|image}} (e.g. <code><nowiki>[[File:Example.jpg|border=yes]]</nowiki></code>) | |||
; 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 [[audiobook]]s. | |||
; title_orig: Original title, if not in English; required if using {{para|native_external_url}} or {{para|native_wikisource}} | |||
; orig_lang_code: [[ISO 639|ISO 639 code]] of original language, required if using {{para|title_orig}}, {{para|native_wikisource}} or {{para|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 {{tl|hlist}} for sorting multiple entries. | |||
; set_in: can be both time and place as [[Setting (narrative)|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 {{para|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 {{tl|plainlist}} when there is more than one notable edition | |||
:Note: {{para|published}} is acceptable, but no longer preferred to {{para|publisher}} and {{para|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 [[International Standard Book Number|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{{spnd}}the last character{{spnd}}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 {{em|in series}}; will be italicised by template code (do not use to connect separate books chronologically) | |||
; preceded_by_quotation_marks: Title of prior work {{em|in series}} if a [[Wikipedia:Manual of Style/Text formatting#When not to use italics|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 {{em|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 {{em|in a series or a sequel}} if a [[Wikipedia:Manual of Style/Text formatting#When not to use italics|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 {{para|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 {{para|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 {{para|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 [[:Category:Books with missing cover|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 {{para|exclude_cover|yes}}. | |||
; website: for the publisher's or author's website about the book. | |||
== Example == | == Example == | ||
{ | |||
! | {{Infobox book{{\sandbox}} | ||
| italic title = no <!--(lest the title of this template is italicised)--> | |||
| name = Anne of Green Gables | |||
| image = FirstPageGreenGables.gif | |||
| name = Anne of Green Gables | | caption = The front (first) page of the first edition | ||
| alt = Cover | |||
| author = [[Lucy Maud Montgomery]] | |||
| title_orig = | | title_orig = | ||
| working_title = | |||
| translator = | | translator = | ||
| illustrator = M. A. and W. A. J. Claus | | illustrator = M. A. and W. A. J. Claus | ||
| cover_artist = | | cover_artist = | ||
| country = | | country = United States | ||
| language = | | language = English | ||
| series = | | series = | ||
| release_number = | |||
| subject = | | subject = | ||
| genre = [[Children's literature|Children's novel]] | | genre = [[Children's literature|Children's novel]] | ||
| publisher = [[L. C. Page & Co.]] | | publisher = [[L. C. Page & Co.]] | ||
| pub_date = | | pub_date = 1908 | ||
| pages = 429 ''(first edition)'' | |||
| pages = 429 | | awards = | ||
| isbn = | | isbn = <!-- N/A --> | ||
| oclc = 367111 | | oclc = 367111 | ||
| congress = PR6025.O45 A53 | |||
| preceded_by = | | preceded_by = | ||
| followed_by = [[Anne of Avonlea]] | | followed_by = [[Anne of Avonlea]] | ||
| wikisource = Anne of Green Gables | |||
}} | }} | ||
<pre style="margin:3.0em 0 0;padding-right:0;overflow:auto;"> | |||
< | {{Infobox book | ||
| name = Anne of Green Gables | |||
| 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 = | | title_orig = | ||
| working_title = | |||
| translator = | | translator = | ||
| illustrator = M. A. and W. A. J. Claus | | illustrator = M. A. and W. A. J. Claus | ||
| cover_artist = | | cover_artist = | ||
| country = | | country = United States | ||
| language = | | language = English | ||
| series = | | series = | ||
| release_number = | |||
| subject = | | subject = | ||
| genre = [[Children's literature|Children's novel]] | | genre = [[Children's literature|Children's novel]] | ||
| publisher = [[L. C. Page & Co.]] | | publisher = [[L. C. Page & Co.]] | ||
| pub_date = | | pub_date = 1908 | ||
| pages = 429 ''(first edition)'' | |||
| pages = 429 | | awards = | ||
| isbn = | | isbn = <!-- N/A --> | ||
| oclc = 367111 | | oclc = 367111 | ||
| congress = PR6025.O45 A53 | |||
| preceded_by = | | preceded_by = | ||
| followed_by = [[Anne of Avonlea]] | | followed_by = [[Anne of Avonlea]] | ||
| wikisource = Anne of Green Gables | |||
}} | }} | ||
|} | </pre> | ||
< | {{clear}} | ||
== TemplateData == | |||
{{Collapse top|[[Wikipedia:TemplateData|TemplateData]] documentation used by [[Wikipedia:VisualEditor|VisualEditor]] and other tools}} | |||
{{TemplateData header|noheader=1}} | |||
<templatedata> | |||
{ | |||
"description": "Consistently-formatted table for presenting information about books", | |||
"format": "{{_\n| _________________ = _\n}}\n", | |||
"params": { | |||
"name": { | |||
"label": "Name", | |||
"type": "string", | |||
"required": false, | |||
"description": "Book name", | |||
"default": "Pagename" | |||
}, | |||
"image": { | |||
"label": "Image", | |||
"type": "wiki-file-name", | |||
"required": false, | |||
"description": "Image (prefer 1st edition where permitted). Use bare filename." | |||
}, | |||
"author": { | |||
"label": "Author", | |||
"type": "string", | |||
"required": false, | |||
"description": "Author(s) of the book (should be link to their respective article if there is one)." | |||
}, | |||
"language": { | |||
"label": "Language", | |||
"type": "string", | |||
"required": false, | |||
"description": "Language of (original) book. Full language name (not a language code).", | |||
"example": "English" | |||
}, | |||
"country": { | |||
"label": "Country", | |||
"type": "string", | |||
"required": false, | |||
"description": "Country of (original) publication." | |||
}, | |||
"genre": { | |||
"label": "Genre", | |||
"type": "string", | |||
"required": false, | |||
"description": "The book's genre", | |||
"example": "Science fiction" | |||
}, | |||
"published": { | |||
"label": "Published", | |||
"type": "string", | |||
"required": false, | |||
"description": "Using the following format: year (publisher) (language, when originally written in a foreign language)" | |||
}, | |||
"publisher": { | |||
"label": "Publisher", | |||
"type": "string", | |||
"required": false, | |||
"description": "Name of publisher." | |||
}, | |||
"isbn": { | |||
"label": "ISBN", | |||
"type": "string", | |||
"description": "Format: \"ISBN 1-234-56789-0\" (prefer 1st edition)", | |||
"aliases": [ | |||
"ISBN" | |||
] | |||
}, | |||
"exclude_cover": { | |||
"type": "string", | |||
"description": "\"yes\" if no image is present and adding this article to \"Category:Books with missing cover\" is not desired", | |||
"label": "exclude cover?", | |||
"example": "yes" | |||
}, | |||
"series": { | |||
"label": "Series", | |||
"description": "Series the book is part of", | |||
"example": "[[The Federalist Papers]]", | |||
"type": "string" | |||
}, | |||
"image_size": { | |||
"label": "Image size", | |||
"example": "200 px", | |||
"type": "string" | |||
}, | |||
"caption": { | |||
| < | |||