Template:Infobox book/doc: Difference between revisions

From Vigyanwiki
< Template:Infobox book
Template>SlimVirgin
m (325 revisions imported from alpha:Template:Infobox_book/doc)
 
(90 intermediate revisions by 56 users not shown)
Line 1: Line 1:
{{Documentation subpage}}
{{Documentation subpage}}
<includeonly>{{High-use| 34,000+ }}</includeonly>
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
{{High-use| 43,000 }}
{{Auto italic title}}
{{Auto italic title}}
{{Generic template demo |_template={{BASEPAGENAME}}{{\sandbox}} |_display=italics
{{Tracks Wikidata|P18|cat=No local image but image on Wikidata}}
|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 |oclc |dewey |congress |preceded_by='''preceded_by''' |followed_by='''followed_by''' |native_wikisource=Wikisource:About |wikisource=Wikisource:About |notes
{{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}}
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->


This template is used to present a consistently-formatted table for use in articles about [[book]]s.
This template is used to present a consistently-formatted table for use in articles about [[book]]s.


== Usage ==
== 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;">
<pre style="overflow:auto;">
{{Infobox book
{{Infobox book
| italic title   = <!--(see above)-->
| italic title     = <!--(see above)-->
| name           =  
| name             =  
| image         =  
| image             =  
| image_size     =  
| image_size       =
| alt           =  
| border            =  
| caption       =  
| alt               =  
| author         =  
| caption           =  
| audio_read_by =  
| author           =  
| title_orig     =  
| audio_read_by     =  
| orig_lang_code =  
| title_orig       =  
| title_working =  
| orig_lang_code   =  
| translator     =  
| title_working     =  
| illustrator   =  
| translator       =  
| cover_artist   =  
| illustrator       =  
| country       =  
| cover_artist     =  
| language       =  
| country           =  
| series         =  
| language         =  
| release_number =  
| series           =  
| subject       =  
| release_number   =  
| genre         =  
| subject           =  
| set_in         =
| genre             =  
| published      =  
| set_in           =  
| publisher     =  
| publisher         =  
| publisher2     =  
| publisher2       =  
| pub_date       =  
| pub_date         =  
| english_pub_date =  
| english_pub_date =
| media_type     =  
| published        =  
| pages         =  
| media_type       =  
| awards         =  
| pages             =  
| isbn           =  
| awards           =  
| oclc           =  
| isbn             =
| dewey         =  
| isbn_note        =  
| congress       =  
| oclc             =  
| preceded_by   =  
| dewey             =  
| followed_by   =  
| congress         =  
| preceded_by       = <!-- for books in a series -->
| followed_by       = <!-- for books in a series -->
| native_wikisource =  
| native_wikisource =  
| wikisource     =  
| wikisource       =  
| notes         =
| notes             =  
| exclude_cover =  
| exclude_cover     =  
| website       =
| website           =  
}}</pre>
}}</pre>


== Parameters ==
== Parameters ==
''Please see [[Wikipedia:WikiProject Books|WikiProject Books]] and/or [[Wikipedia:WikiProject Novels|WikiProject Novels]] for standards on presenting names and other data.''
''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.
* 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.
* [[Help:Link#Wikilinks|Wikilinks]] can be used in any of the infobox fields.


; name: Book name. If parameter is left blank, ''name'' will be inherited from page title.
; 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>
; 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: Default size is 250px. Use a number to change image size
; 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>[[Image:Example.jpg]]</nowiki></code>); in this case add the border in {{para|image}} (e.g. <code><nowiki>[[Image:Example.jpg|border=yes]]</nowiki></code>)
; 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)
; caption: Image caption (should describe the edition used)
; alt: Image alternate text
; alt: Image alternate text
Line 70: Line 74:
; author/authors: Author(s)
; author/authors: Author(s)
; audio_read_by: For [[audiobook]]s.
; audio_read_by: For [[audiobook]]s.
; title_orig: Original title, if not in English
; title_orig: Original title, if not in English; required if using {{para|native_external_url}} or {{para|native_wikisource}}
; orig_lang_code: [[Template:ISO 639 name|ISO code]] of original language, required if using {{para|title_orig}}, {{para|native_wikisource}} or {{para|native_external_url}}
; 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
; working_title: [[Working title]], when different from published title
; translator: Translator(s), if original not in English
; translator: Translator(s), if original not in English
; illustrator: Illustrator (where used throughout and a major feature)
; illustrator: Illustrator (where used throughout and a major feature)
; cover_artist: Cover artist
; cover_artist: Cover artist, if any
; country: Country of original publication
; country: Country of original publication
; language: Language of original book
; language: Language of original book. Do not link unless it is an unusual language.
; series: Series (if any)
; 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]]''
; subject/subjects: (for non-fiction) ''See [[index term]] and [[library classification]]''
; genre/genres: (for fiction) ''See [[literary genre]]''
; 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.
; 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.
; published: Using the following format: year (publisher) (language, when originally written in a foreign language); use {{tl|plainlist}} when there is more than one notable edition
; publisher: Publisher of primary publication (prefer 1st edition); also {{para|publisher2}} for additional publishers.
; publisher/publisher2/pub_date/release_date/english_pub_date/english_release_date: [[:Category:Infobox book using deprecated parameters|Deprecated]] (use published instead)
; pub_date: Date published (1st edition)
; media_type: Print / On-line (then binding types etc., if relevant)
; 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)
; pages: Pages (prefer 1st edition, specify edition as needed)
; award/awards: Awards(s) the book has won
; award/awards: Awards(s) the book has won
; isbn: (prefer ISBN of 1st edition). Format: "ISBN 1-234-56789-0" (10-digit) or "ISBN 978-1-234-56789-0" (13-digit). If the book has a [[International Standard Book Number|standard book number]] (9&nbsp;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. The last digit is a calculated check-digit which will be wrong. Same for removing "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 put "ISBN " in front of the number so that the ISBN is automatically linked to [[Special:BookSources]].
; 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&nbsp;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.
; isbn_note: May be used to add a note following the ISBN.
; oclc: [[OCLC]] number (prefer 1st edition), use when book has no ISBN
; oclc: [[OCLC]] number (prefer 1st edition), use when book has no ISBN
Line 94: Line 102:
; 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: 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)
; 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 series or sequel}}; will be italicised 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 series or 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)
; 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_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_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
Line 108: Line 116:


{{Infobox book{{\sandbox}}
{{Infobox book{{\sandbox}}
| italic title = no <!--(lest the title of this template is italicised)-->
| italic title   = no <!--(lest the title of this template is italicised)-->
| name = Anne of Green Gables
| name           = Anne of Green Gables
| image = FirstPageGreenGables.gif
| image         = FirstPageGreenGables.gif
| caption = The front (first) page of the first edition
| caption       = The front (first) page of the first edition
| alt = Cover
| alt           = Cover
| author = [[Lucy Maud Montgomery]]
| author         = [[Lucy Maud Montgomery]]
| title_orig =  
| title_orig     =  
| working_title =  
| 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 = United States
| country       = United States
| language = English
| language       = English
| series =  
| series         =
| subject =  
| release_number =  
| genre = [[Children's literature|Children's novel]]
| subject       =  
| published = 1908 by [[L. C. Page & Co.]]
| genre         = [[Children's literature|Children's novel]]
| pages = 429 ''(first edition)''
| publisher      = [[L. C. Page & Co.]]
| awards =  
| pub_date      = 1908
| isbn = <!-- N/A -->
| pages         = 429 ''(first edition)''
| oclc = 367111
| awards         =  
| congress = PR6025.O45 A53
| isbn           = <!-- N/A -->
| preceded_by =  
| oclc           = 367111
| followed_by = [[Anne of Avonlea]]
| congress       = PR6025.O45 A53
| wikisource = Anne of Green Gables
| preceded_by   =  
| followed_by   = [[Anne of Avonlea]]
| wikisource     = Anne of Green Gables
}}
}}
<pre style="margin:3.0em 0 0;padding-right:0;overflow:auto;">
<pre style="margin:3.0em 0 0;padding-right:0;overflow:auto;">
{{Infobox book
{{Infobox book
| name = Anne of Green Gables
| name           = Anne of Green Gables
| image = FirstPageGreenGables.gif
| image         = FirstPageGreenGables.gif
| caption = The front (first) page of the first edition
| caption       = The front (first) page of the first edition
| alt = Cover
| alt           = Cover
| author = [[Lucy Maud Montgomery]]
| author         = [[Lucy Maud Montgomery]]
| title_orig =  
| title_orig     =  
| working_title =  
| 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 = United States
| country       = United States
| language = English
| language       = English
| series =  
| series         =
| subject =  
| release_number =  
| genre = [[Children's literature|Children's novel]]
| subject       =  
| published = 1908 by [[L. C. Page & Co.]]
| genre         = [[Children's literature|Children's novel]]
| pages = 429 ''(first edition)''
| publisher      = [[L. C. Page & Co.]]
| awards =  
| pub_date      = 1908
| isbn = <!-- N/A -->
| pages         = 429 ''(first edition)''
| oclc = 367111
| awards         =  
| congress = PR6025.O45 A53
| isbn           = <!-- N/A -->
| preceded_by =  
| oclc           = 367111
| followed_by = [[Anne of Avonlea]]
| congress       = PR6025.O45 A53
| wikisource = Anne of Green Gables
| preceded_by   =  
| followed_by   = [[Anne of Avonlea]]
| wikisource     = Anne of Green Gables
}}
}}
</pre>
</pre>
{{clear}}


== TemplateData ==
== TemplateData ==
{{TemplateDataHeader}}
{{Collapse top|[[Wikipedia:TemplateData|TemplateData]] documentation used by [[Wikipedia:VisualEditor|VisualEditor]] and other tools}}
<templatedata>{
{{TemplateData header|noheader=1}}
<templatedata>
{
"description": "Consistently-formatted table for presenting information about books",
"description": "Consistently-formatted table for presenting information about books",
"format": "{{_\n| _________________ = _\n}}\n",
"params": {
"params": {
"name": {
"name": {
Line 172: Line 188:
"type": "string",
"type": "string",
"required": false,
"required": false,
"description": "Book name.",
"description": "Book name",
"default": "Pagename"
"default": "Pagename"
},
"image": {
"label": "Image",
"type": "wiki-file-name",
"required": false,
"description": "Image (prefer 1st edition where permitted). Use bare filename."
},
},
"author": {
"author": {
Line 185: Line 207:
"type": "string",
"type": "string",
"required": false,
"required": false,
"description": "Language of (original) book. Full language name (not a language code)."
"description": "Language of (original) book. Full language name (not a language code).",
"example": "English"
},
},
"country": {
"country": {
Line 197: Line 220:
"type": "string",
"type": "string",
"required": false,
"required": false,
"description": ""
"description": "The book's genre",
"example": "Science fiction"
},
},
"published": {
"published": {
Line 208: Line 232:
"label": "Publisher",
"label": "Publisher",
"type": "string",
"type": "string",
"deprecated": "Add the publisher to the Published field instead.",
"required": false,
"description": "Name of publisher."
"description": "Name of publisher."
},
},
Line 214: Line 238:
"label": "ISBN",
"label": "ISBN",
"type": "string",
"type": "string",
"description": "Format: \"ISBN 1-234-56789-0\" (prefer 1st edition)"
"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"
},
},
                "exclude_cover": {
"image_size": {
                        "label": "",
"label": "Image size",
                        "type": "string",
"example": "200 px",
                        "description": "\"yes\" if no image is present and adding this article to \"Category:Books with missing cover\" is not desired"
"type": "string"
              }
},
"caption": {
"label": "Image caption",
"description": "a caption for the image used",
"type": "content"
},
"media_type": {
"label": "Type of media",
"example": "[[Newspaper]]",
"type": "string"
},
"pub_date": {
"label": "Date of publication",
"description": "Date the book or work was published",
"example": "December 21, 1787",
"type": "date"
},
"preceded_by": {
"label": "Preceded by",
"description": "The previous installment in the series/from the author",
"example": "[[Federalist No. 4]]",
"type": "string"
},
"followed_by": {
"label": "Followed by",
"description": "The next installment in the series/from the author",
"example": "[[Federalist No. 6]]",
"type": "string"
},
"italic title": {},
"infoboxwidth": {},
"width": {},
"image_caption": {},
"editors": {},
"editor": {},
"authors": {},
"audio_read_by": {},
"title_orig": {},
"title_working": {},
"translators": {},
"translator": {},