Template:Infobox book/doc: Difference between revisions

From Vigyanwiki
< Template:Infobox book
Template>Mnvrsr74
No edit summary
m (325 revisions imported from alpha:Template:Infobox_book/doc)
 
(47 intermediate revisions by 31 users not shown)
Line 1: Line 1:
{{Documentation subpage}}
{{Documentation subpage}}
<includeonly>{{High-use| 41,000+ }}</includeonly>
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
{{High-use| 43,000 }}
{{Auto italic title}}
{{Auto italic title}}
{{Lua|Module:Infobox|Module:InfoboxImage|Module:Wikidata|Module:ISBNT|Module:Check for unknown parameters}}
{{Tracks Wikidata|P18|cat=No local image but image on Wikidata}}
{{Tracks Wikidata|P18|cat=No local image but image on Wikidata}}
{{Generic template demo |_template={{BASEPAGENAME}}{{\sandbox}} |_display=italics
|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}}
{{Uses Wikidata|P136|P577|P212|P856|P1036|P1104|P1149}}
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
{{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.
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
Line 29: Line 30:
| translator        =  
| translator        =  
| illustrator      =  
| illustrator      =  
| cover_artist     =
| cover_artist      =  
| Photographer     =  
| country          =  
| country          =  
| language          =  
| language          =  
Line 51: Line 51:
| dewey            =  
| dewey            =  
| congress          =  
| congress          =  
| preceded_by      =  
| preceded_by      = <!-- for books in a series -->
| followed_by      =  
| followed_by      = <!-- for books in a series -->
| native_wikisource =  
| native_wikisource =  
| wikisource        =  
| wikisource        =  
Line 66: Line 66:


; 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.
; 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: Uses image size set by user (default 220px). Use a number to override 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 74: 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]]''. Use {{tl|hlist}} for sorting multiple entries.
; 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.
; publisher: Publisher of primary publication (prefer 1st edition); also {{para|publisher2}} for additional publishers.
; publisher: Publisher of primary publication (prefer 1st edition); also {{para|publisher2}} for additional publishers.
; pub_date: Date published (1st edition)
; pub_date: Date published (1st edition)
Line 94: Line 95:
; 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: "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: (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 115: 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       =  
| publisher     = [[L. C. Page & Co.]]
| genre         = [[Children's literature|Children's novel]]
| pub_date     = 1908
| publisher     = [[L. C. Page & Co.]]
| pages         = 429 ''(first edition)''
| pub_date       = 1908
| awards       =  
| pages         = 429 ''(first edition)''
| isbn         = <!-- N/A -->
| awards         =  
| oclc         = 367111
| isbn           = <!-- N/A -->
| congress     = PR6025.O45 A53
| oclc           = 367111
| preceded_by   =  
| congress       = PR6025.O45 A53
| followed_by   = [[Anne of Avonlea]]
| preceded_by   =  
| wikisource   = Anne of Green Gables
| 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       =  
| publisher     = [[L. C. Page & Co.]]
| genre         = [[Children's literature|Children's novel]]
| pub_date     = 1908
| publisher     = [[L. C. Page & Co.]]
| pages         = 429 ''(first edition)''
| pub_date       = 1908
| awards       =  
| pages         = 429 ''(first edition)''
| isbn         = <!-- N/A -->
| awards         =  
| oclc         = 367111
| isbn           = <!-- N/A -->
| congress     = PR6025.O45 A53
| oclc           = 367111
| preceded_by   =  
| congress       = PR6025.O45 A53
| followed_by   = [[Anne of Avonlea]]
| preceded_by   =  
| wikisource   = Anne of Green Gables
| followed_by   = [[Anne of Avonlea]]
| wikisource     = Anne of Green Gables
}}
}}
</pre>
</pre>
{{clear}}


== TemplateData ==
== TemplateData ==
{{TemplateData header}}
{{Collapse top|[[Wikipedia:TemplateData|TemplateData]] documentation used by [[Wikipedia:VisualEditor|VisualEditor]] and other tools}}
{{TemplateData header|noheader=1}}
<templatedata>
<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 182: Line 188:
"type": "string",
"type": "string",
"required": false,
"required": false,
"description": "Book name.",
"description": "Book name",
"default": "Pagename"
"default": "Pagename"
}, "image": {
},
"image": {
"label": "Image",
"label": "Image",
"type": "string",
"type": "wiki-file-name",
"required": false,
"required": false,
"description": "Image (prefer 1st edition where permitted). Use bare filename."
"description": "Image (prefer 1st edition where permitted). Use bare filename."
Line 200: 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 211: Line 219:
"label": "Genre",
"label": "Genre",
"type": "string",
"type": "string",
"required": false
"required": false,
"description": "The book's genre",
"example": "Science fiction"
},
},
"published": {
"published": {
Line 222: 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 228: 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": {
"exclude_cover": {
"type": "string",
"type": "string",
"description": "\"yes\" if no image is present and adding this article to \"Category:Books with missing cover\" is not desired"
"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"
"format": "block"
},
"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": {
"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": {},
"illustrators": {},
"illustrator": {},
"cover_artist": {},
"release_number": {},
"subjects": {},
"subject": {},
"genres": {},
"set_in": {},
"publisher2": {},
"release_date": {},
"english_pub_date": {},
"english_release_date": {},
"pages": {},
"awards": {},
"award": {},
"isbn_note": {
"aliases": ["ISBN_note"]
},
"dewey": {},
"congress": {},
"last": {},
"first": {},
"location": {},
"oclc": {},
"alt": {},
"border": {},
"orig_lang_code": {},
"preceded_by_quotation_marks": {},
"followed_by_quotation_marks": {},
"native_wikisource": {},
"native_external_url": {},
"native_external_host": {},
"wikisource": {},
"external_url": {},
"external_host": {},
"website": {},
"homepage": {},
"URL": {},
"notes": {},
"note": {},
"nocat_wdimage": {}
}
}
}
</templatedata>
</templatedata>
{{Collapse bottom}}


== Translated books ==
== Translated books ==
Line 251: Line 358:
* {{clc|Pages using deprecated image syntax}}
* {{clc|Pages using deprecated image syntax}}
* {{clc|Pages using infobox book with unknown parameters}}
* {{clc|Pages using infobox book with unknown parameters}}
* {{clc|Pages using deprecated image syntax}} – Used by [[Module:InfoboxImage]] to track articles where an infobox uses image syntax in the format <kbd><nowiki>|image=[[File:Example.jpg]]</nowiki></kbd>. To exclude articles from this category, change it to {{samp|<nowiki>|image=Example.jpg</nowiki>}}.
* {{clc|No local image but image on Wikidata}} – Used by [[Template:Wikidata image]] to track articles where an infobox has no image but [[Wikidata]] has an image name. To exclude articles from this category, add an image or {{para|nocat_wdimage|yes}} to the infobox.


== See also ==
== See also ==
* {{tl|Infobox book series}}
* {{tl|Infobox book series}}
* {{tl|Infobox novella}}
* {{tl|Infobox short story}}
* [[Wikipedia:WikiProject Novels/InfoboxCode]]
* [[Wikipedia:WikiProject Novels/InfoboxCode]]
* [[Wikipedia:WikiProject Novels/ArticleTemplate#Pattern template]]
* [[Wikipedia:WikiProject Novels/ArticleTemplate#Pattern template]]


<includeonly>{{basepage subpage|
<includeonly>{{basepage subpage|
[[Category:Book infobox templates| ]]
 
[[Category:WikiProject Books| {{PAGENAME}}]]
 
[[Category:WikiProject Novels| {{PAGENAME}}]]
 
[[Category:Infobox templates using Wikidata]]
 
[[Category:Templates that add a tracking category]]
 
}}</includeonly>
}}</includeonly>
[[Category:Infobox templates|book]]
[[Category:Pages with script errors|Infobox book/doc]]
[[Category:Template documentation pages|Documentation/doc]]
[[Category:Templates tracking Wikidata|Infobox book/doc]]
[[Category:Templates using TemplateData|Infobox book/doc]]
[[Category:Templates using data from Wikidata|Infobox book/doc]]

Latest revision as of 09:46, 15 December 2022