Template:Book/doc

From Wikimedia Commons, the free media repository
Jump to navigation Jump to search

This template is used to format basic information about books and should be used in place of {{Information}} for scanned book pages, whether the file contains a single page (e.g. JPG) or the entire book (e.g. a multi-page DjVu or PDF).

The template automatically sets the following categories: Book templates, if used in a template.

Usage

{{Book
 |Author           =
 |Translator       =
 |Editor           =
 |Illustrator      =
 |Title            =
 |Subtitle         =
 |Series title     =
 |Volume           =
 |Edition          =
 |Publisher        =
 |Printer          =
 |Publication date =
 |City             =
 |Language         =
 |Description      =
 |Source           =
 |Permission       =
 |Image            =
 |Image page       =
 |Pageoverview     =
 |Wikisource       =
 |Homecat          =
 |Other_versions   =
 |ISBN             =
 |LCCN             =
 |OCLC             =
 |References       =
 |Linkback         =
 |Wikidata         =
 |noimage          =
}}

Template parameters

ParameterDescriptionDefaultStatus
Author
author
The book's author or authors. If the author is anonymous, write anonymous or unbekannt. If the book has multiple authors, write various authors or verschiedene and provide the editor's name in the Editor parameter. If possible, create and use a creator template for the author, providing identifying information and links to the author's Wikipedia and Wikisource pages. Wikidata item IDs are allowed.emptyoptional
Translator
translator
The book's translator or translators. See the Author description for the preferred format. Wikidata item IDs are allowed.emptyoptional
Editor
editor
The book's editor or editors. See the Author description for the preferred format. Wikidata item IDs are allowed.emptyoptional
Illustrator
illustrator
The book's illustrator or illustrators. See the Author description for the preferred format. Wikidata item IDs are allowed.emptyoptional
Title
title
The title of the book. Some titles of very old books tend to be long and are often split into the main title plus a subtitle. In such a case, please use the Subtitle parameter.emptyoptional
Subtitle
subtitle
The subtitle of the book.emptyoptional
Series title
series title
If the book is part of a series, then provide the series title.emptyoptional
Volume
volume
If the book has multiple volumes, then provide the volume number.emptyoptional
Edition
edition
The edition number.emptyoptional
Publisher
publisher
The book's publisher.emptyoptional
Printer
printer
The book's printer. Wikidata item IDs are allowed.emptyoptional
Publication date
Date
The date of the book's publication. Use {{Other date}} or {{Complex date}} for approximate dates.emptyoptional
City
city
The place of publication, usually a city. If possible, use {{City}} or one of autotranslated city templates (see Category:Multilingual tags: Locations). You can also use links to a gallery or Wikipedia article.emptyoptional
Language
Language
The language of the book (most of the time, but not always, ISO codes). See the MediaWiki language abbreviation documentation [1] for details. Do not use the {{language}} template as it is already coded into this template. For multi-language books: marking a book this way requires familiarity with Wikidata:
  1. You must create an Item for the book there, if one does not already exist (this is separate from the "structured data" values attached to a Commons file)
  2. Give the Wikidata property language of work or name (P407) for the Item multiple values, one for each language
  3. And set the "Wikidata" parameter of this template in the Commons page for the file to the Q-id of the Item you have created.
emptyoptional
Description
description
A description of the book. Please use multilingual templates like {{en}}.emptyoptional
Source
source
Information about where the source of the files in the category. Usually, this is the name of the user or the institution that scanned the book, with a link to the download page, if possible. Source should always be specified and books without a source will be tagged with the {{Source missing}} template.emptyoptional
Permission
permission
A license (such as {{PD-old-100-expired}}); used for PDF and DjVu files where the entire book is a single file. When creating book templates (for a group of images that are uploaded as separate files), leave this field blank, as each file should directly include its own license template.emptyoptional
Image
image
An image representing the book, usually the front page or the cover. For multi-image PDF and DjVu files, this is simply the filename. Omit "File:".emptyoptional
Image page
image page
The page number of the title page or page representing the book in multi-page documents (PDF and DjVu), like a cover. If not provided in the wikitext, then it will be fetched from the title page number (P4714) property on Wikidata or in SDC.emptyoptional
Pageoverview
pageoverview
A field used to show the page number, the number of pages, or possibly add links to all the pages. Different derivative templates use this field differently: emptyoptional
Wikisource
wikisource
A link to related Wikisource page. Use s:en:Main Page notation without the double brackets (e.g. s:en:Three Books of Occult Philosophy).emptyoptional
Homecat
homecat
Used only when the Book template is used to create other templates, usually templates for specific books. Homecat (Home category) will categorize the book template without categorizing images using it. In order to auto-categorize images as well, use the separate {{Book/AutoCategory}} template. If Homecat is missing or points to a non-existent category, the template is added to Category:Book templates without home category. To avoid that, use "Homecat=~".emptyoptional
Other_versions
other_versions
Other versions
other versions
Other versions of this same document on Commons. This can be used for files in a different format or other editions of the same text.emptyoptional
Other_fields
other_fields
other fields
Other fields
Additional table fields. The easiest way to use it is through {{Information field|name=(field name)|value=(field value)}}. There is also other_fields_1, other_fields_2, and other_fields_3 for placing fields in other locations.emptyoptional
ISBNInternational Standard Book Numberemptyoptional
LCCNLibrary of Congress Control Number: Authority data from the Library of Congress.emptyoptional
OCLCTitle authority data from Online Computer Library Center.emptyoptional
Institution
institution
gallery
Gallery
The archive, library, or other institution owning the piece. Use this option only in case of unique or rare material, like the Gutenberg Bible, maps, or archival documents. When possible, use collapsible institution templates like Institution:Library of Congress.emptyoptional
Department
department
Department, division, collection, or other location within the institution. Use with the "Institution" parameter.emptyoptional
Accession number
accession number
id
Id
ID
The institution's accession number or some other inventory or identification number. Provide a link to the Institution database if available. Use with the "Institution" parameter.emptyoptional
References
references
Books and websites with information about the object. Please use the {{Cite book}} and {{Cite web}} templates.emptyoptional
LinkbackIn case of specialized Book templates, use this to add a link back to the template. If provided, then a blue pencil icon will be shown in the top line after the name. Clicking this icon will bring user to the proper book template page, so it can be edited.emptyoptional
Wikidata
wikidata
WikidataID of the Wikidata item about the book, if any exists.emptyoptional
noimagenoimageA boolean variable which, when set to "1", will suppress display of first page of a multi-page document as "image" when the "image_page" parameter is not provided (in wikitext, SDC or on Wikidata).falseoptional
<templatedata>JSON</templatedata> ./. {{TemplateBox}}
TemplateData

TemplateData is a way to store information about template parameters (the description of those and of the whole template) for both humans and machines. It is used by VisualEditor and possibly other tools like Upload Wizard.


Existing template documentation
At Wikimedia Commons, it is recommended to use {{TemplateBox}} with either ‎useTemplateData=1 or ‎useTemplateData=only on the ‎/doc subpage and transcluding it with {{Documentation}} into the template. ‎<nowiki>-tags can be wrapped around the arguments, if required, to avoid templates being expanded.

Newly created template documentation and imports
Another option, especially for imported templates, or for users with JSON experience, is placing raw ‎<templatedata>-tags into the Wikitext of the template, as described in various Wikipediae.


Wikipedia's help about TemplateDataCommons-specific information

This template is used to format basic information about books and should be used in place of the Information template for scanned book pages, whether the file contains a single page (e.g. JPG) or the entire book (e.g. a multi-page DjVu or PDF).

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Accession number accession number id Id ID

The institution's accession number or some other inventory or identification number. Provide a link to the Institution database if available. Use with the "Institution" parameter.

Stringoptional
Author author

The book's author or authors. If the author is anonymous, write anonymous or unbekannt. If the book has multiple authors, write various authors or verschiedene and provide the editor's name in the Editor parameter. If possible, create and use a creator template for the author, providing identifying information and links to the author's Wikipedia and Wikisource pages.

Stringoptional
City city

The place of publication, usually a city. If possible, use the City template or one of autotranslated city templates (see Category:Multilingual tags: Locations). You can also use links to a gallery or Wikipedia article.

Stringoptional
Department department

Department, division, collection, or other location within the institution. Use with the "Institution" parameter.

Stringoptional
Description description

A description of the book. Please use multilingual templates like the "en" template.

Stringoptional
Edition edition

The edition number.

Stringoptional
Editor editor

The book's editor or editors. See the Author description for the preferred format.

Stringoptional
Homecat homecat

Used only when the Book template is used to create other templates, usually templates for specific books. Homecat (Home category) will categorize the book template without categorizing images using it. In order to auto-categorize images as well, use the separate Book/AutoCategory template. If Homecat is missing or points to a non-existent category, the template is added to Category:Book templates without home category. To avoid that, use "Homecat=~".

Stringoptional
ISBN

International Standard Book Number

Stringoptional
Illustrator illustrator

The book's illustrator or illustrators. See the Author description for the preferred format.

Stringoptional
Image image

An image representing the book, usually the front page or the cover. For multi-image PDF and DjVu files, this is simply the filename. Omit "File:".

Fileoptional
Image page image page

The page number of the title page or page representing the book in multi-page documents (PDF and DjVu), like a cover. If not provided in the wikitext, then it will be fetched from the title page number (P4714) property on Wikidata or in SDC.

Lineoptional
Institution institution gallery Gallery

The archive, library, or other institution owning the piece. Use this option only in case of unique or rare material, like the Gutenberg Bible, maps, or archival documents. When possible, use collapsible institution templates like Institution:Library of Congress.

Stringoptional
LCCN

Library of Congress Control Number: Authority data from the Library of Congress.

Stringoptional
Language Language

The language of the book (most of the time, but not always, ISO codes). See the MediaWiki language abbreviation documentation for details. Do not use the Language template as it is already coded into this template. For multi-language books: marking a book this way requires familiarity with Wikidata—you must create an Item for the book there, if one does not already exist (this is separate from the "structured data" values attached to a Commons file), give the Wikidata property "language of work or name (P407)" for the Item multiple values, one for each language, and set the "Wikidata" parameter of this template in the Commons page for the file to the Q-id of the Item you have created.

Stringoptional
Linkback

In case of specialized Book templates, use this to add a link back to the template. If provided, then an icon will be shown in the top line after the name. Clicking this icon will bring user to the proper book template page, so it can be edited.

Stringoptional
OCLC

Title authority data from Online Computer Library Center.

Stringoptional
Other_fields other_fields other fields Other fields

Additional table fields. The easiest way to use it is through the Information field template. There is also other_fields_1, other_fields_2, and other_fields_3 for placing fields in other locations.

Stringoptional
Other_versions other_versions Other versions other versions

Other versions of this same document on Commons. This can be used for files in a different format or other editions of the same text.

Stringoptional
Pageoverview pageoverview

A field used to show the page number, the number of pages, or possibly add links to all the pages. Different derivative templates use this field differently.

Stringoptional
Permission permission

A license (such as PD-old-100-expired); used for PDF and DjVu files where the entire book is a single file. When creating book templates (for a group of images that are uploaded as separate files), leave this field blank, as each file should directly include its own license template.

Stringoptional
Printer printer

The book's printer. Wikidata item IDs are allowed.

Stringoptional
Publication date Date

The date of the book's publication. Use the Other date or Complex date templates for approximate dates.

Stringoptional
Publisher publisher

The book's publisher.

Stringoptional
References references

Books and websites with information about the object. Please use the Cite book and Cite web templates.

Stringoptional
Series title series title

If the book is part of a series, then provide the series title.

Stringoptional
Source source

Information about where the source of the files in the category. Usually, this is the name of the user or the institution that scanned the book, with a link to the download page, if possible. Source should always be specified and books without a source will be tagged with the Source missing template.

Stringoptional
Subtitle subtitle

The subtitle of the book.

Stringoptional
Title title

The title of the book. Some titles of very old books tend to be long and are often split into the main title plus a subtitle. In such a case, please use the Subtitle parameter.

Stringoptional
Translator translator

The book's translator or translators. See the Author description for the preferred format.

Stringoptional
Volume volume

If the book has multiple volumes, then provide the volume number.

Stringoptional
WikidataWikidata wikidata

ID of the Wikidata item about the book, if any exists.

Stringoptional
Wikisource wikisource

A link to related Wikisource page. Use [[s:en:Main Page]] notation without the double brackets (e.g. s:en:Three Books of Occult Philosophy).

Stringoptional
noimagenoimage

A boolean variable which, when set to "1", will suppress display of first page of a multi-page document as "image" when the "image_page" parameter is not provided (in wikitext, SDC or on Wikidata).

Default
false
Stringoptional

Additional information

The template is intended to be used in the following namespaces: all namespaces

The template is intended to be used by the following user groups: all users

Relies on:
{{Language}}, {{City}}, {{ISOdate}}, {{Anonymous}}, {{Author}}

Examples

See also

Localization

This template is localized by utilizing MediaWiki namespace messages. These can be translated at translatewiki.net (current translations).