Template:Infobox book/doc: Difference between revisions
Template>Yodin (→See also: adding Wikiproject example code) |
Template>Michael Bednarek (attempt to document |exclude_cover=) |
||
Line 10: | Line 10: | ||
| name = ''name'' | | name = ''name'' | ||
| image = Example-serious.jpg | | image = Example-serious.jpg | ||
| image_size = | | image_size = | ||
| border = | | border = | ||
| caption = ''caption'' | | caption = ''caption'' | ||
| alt = | | alt = | ||
| author = ''author'' | | author = ''author'' | ||
| title_orig = '''title_orig''' | | title_orig = '''title_orig''' | ||
Line 41: | Line 41: | ||
<pre style="overflow:auto;"> | <pre style="overflow:auto;"> | ||
{{Infobox book | {{Infobox book | ||
| italic title = (see above) | |||
| name | | name = | ||
| image | | image = | ||
| caption | | caption = | ||
| alt | | alt = | ||
| author | | author = | ||
| title_orig | | title_orig = | ||
| orig_lang_code | | orig_lang_code = | ||
| title_working | | title_working = | ||
| translator | | translator = | ||
| illustrator | | illustrator = | ||
| cover_artist | | cover_artist = | ||
| country | | country = | ||
| language | | language = | ||
| series | | series = | ||
| subject | | subject = | ||
| genre | | genre = | ||
| published | | published = | ||
| media_type | | media_type = | ||
| pages | | pages = | ||
| awards | | awards = | ||
| isbn | | isbn = | ||
| oclc | | oclc = | ||
| dewey | | dewey = | ||
| congress | | congress = | ||
| preceded_by | | preceded_by = | ||
| followed_by | | followed_by = | ||
| wikisource | | wikisource = | ||
| exclude_cover = | |||
}}</pre> | }}</pre> | ||
Line 115: | Line 116: | ||
; 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_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 | ; 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}}. | |||
== Example == | == Example == | ||
Line 229: | Line 231: | ||
"type": "string", | "type": "string", | ||
"description": "Format: \"ISBN 1-234-56789-0\" (prefer 1st edition)" | "description": "Format: \"ISBN 1-234-56789-0\" (prefer 1st edition)" | ||
} | }, | ||
"exclude_cover": { | |||
"label": "", | |||
"type": "string", | |||
"description": "\"yes\" if no image is present and adding this article to \"Category:Books with missing cover\" is not desired" | |||
} | |||
} | } | ||
}</templatedata> | }</templatedata> |
Revision as of 11:02, 17 April 2014
This is a documentation subpage for Template:Infobox book. It may contain usage information, categories and other content that is not part of the original template page. |
This template is used to present a consistently-formatted table for use in articles about books.
Usage
Author | author |
---|---|
Original title | title_orig |
Working title | title_working |
Translator | translator |
Illustrator | illustrator |
Cover artist | cover_artist |
Country | country |
Language | language |
Series | series |
Subject | subject |
Genre | genre |
Published | published |
Media type | media_type |
Pages | pages |
Awards | awards |
ISBN | isbn Parameter error in {{ISBN}}: invalid character |
[[OCLC (identifier)|OCLC]] | oclc |
dewey | |
[[LCC (identifier)|LC Class]] | congress |
Preceded by | preceded_by |
Followed by | followed_by |
Original text | title_orig at Interlingua Wikisource |
Translation | name at Wikisource |
{{Infobox book | italic title = (see above) | name = | image = | caption = | alt = | author = | title_orig = | orig_lang_code = | title_working = | translator = | illustrator = | cover_artist = | country = | language = | series = | subject = | genre = | published = | media_type = | pages = | awards = | isbn = | oclc = | dewey = | congress = | preceded_by = | followed_by = | wikisource = | exclude_cover = }}
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. If parameter is left blank, name will be inherited from page title.
- image
- Image (prefer 1st edition – where permitted), use bare filename:
Example.jpg
- image_size
- Default size is 200px. Use a number to change 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)
- 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)
- subject/subjects
- (for non-fiction) See index term and library classification
- genre/genres
- (for fiction) See literary genre
- published
- Using the following format: year (publisher) (language, when originally written in a foreign language); use {{plainlist}} when there is more than one notable edition
- publisher/publisher2/pub_date/english_pub_date
- Deprecated (use published instead)
- media_type
- Print / On-line (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: "ISBN 1-234-56789-0" (10-digit) or "ISBN 123-4-567-89012-3" (13-digit). If the book was published before the use of ISBN, do not include this parameter.
- oclc
- OCLC number (prefer 1st edition), use when book has no ISBN
- dewey
- Dewey Decimal System 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 series or sequel; will be italicised by template code (do not use to connect separate books chronologically)
- followed_by_quotation_marks
- Title of subsequent work in series or 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
.
Example
Author | Lucy Maud Montgomery |
---|---|
Illustrator | M. A. and W. A. J. Claus |
Country | United States |
Language | English |
Genre | Children's novel |
Published | 1908 (L. C. Page & Co.) |
Media type | Print (hardcover) |
Pages | 429 pp (first edition) |
ISBN | N/A Parameter error in {{ISBN}}: invalid character |
[[OCLC (identifier)|OCLC]] | 367111 |
[[LCC (identifier)|LC Class]] | PR6025.O45 A53 |
Followed by | Anne of Avonlea |
Text | Anne of Green Gables at Wikisource |
{{Infobox book | name = Anne of Green Gables | image = FirstPageGreenGables.gif | caption = First page of ''Anne of Green Gables''. | alt = Cover | 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 = | subject = | genre = [[Children's literature|Children's novel]] | published = 1908 ([[L. C. Page & Co.]]) | media_type = Print ([[hardcover]]) | pages = 429 pp ''(first edition)'' | awards = | isbn = N/A | oclc = 367111 | congress = PR6025.O45 A53 | preceded_by = | followed_by = [[Anne of Avonlea]] | wikisource = Anne of Green Gables }}
Template data
This is the TemplateData documentation for this template used by VisualEditor and other tools.
Infobox book
[[Category:TemplateData documentation{{#translation:}}]]
Consistently-formatted table for presenting information about books
Parameter | Description | Type | Status | |
---|---|---|---|---|
Name | name | Book name.
| String | optional |
Author | author | Author(s) of the book (should be link to their respective article if there is one). | String | optional |
Language | language | Language of (original) book. Full language name (not a language code). | String | optional |
Country | country | Country of (original) publication. | String | optional |
Genre | genre | String | optional | |
Published | published | Using the following format: year (publisher) (language, when originally written in a foreign language) | Number | optional |
Publisher | publisher | Name of publisher. | String | deprecated |
ISBN | isbn | Format: "ISBN 1-234-56789-0" (prefer 1st edition) | String | optional |
exclude_cover | "yes" if no image is present and adding this article to "Category:Books with missing cover" is not desired | String | optional |
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
Instances without images cause the article to be added to Category:Books with missing cover.
See also
- {{Infobox book series}}
- Wikipedia:WikiProject Novels/InfoboxCode
- Wikipedia:WikiProject Novels/ArticleTemplate#Pattern template