Template:Infobox library/doc

Usage

To use this infobox, copy the text below to the top of the page describing the library and complete the relevant fields.

{{Infobox library
| name                = 
| native_name         = <!-- Name in native language if different -->
| native_name_lang    = <!-- ISO 639-2 code, e.g. "fr" for French. -->
| logo                = <!-- file name only (no Image: or File:) -->
| logo_size           = 
| logo_alt            = 
| image               = <!-- file name only (no Image: or File:) -->
| image_size          = 
| image_upright       = 
| alt                 = 
| caption             = 
| country             = 
| type                = 
| scope               = 
| established         = <!-- {{Start date|year|month|day}} -->
| architect           = <!-- if known and notable -->
| dissolved           = <!-- {{End date|yyyy|mm|dd}} -->
| ref_legal_mandate   = 
| location            = 
| service_area        = 
| coordinates         = <!-- {{Coord|latitude|longitude|display=inline,title}} -->
| location_map        = <!-- name of the Location map template or module (e.g. UK England) -->
| branch_of           = 
| num_branches        = 
| items_collected     = 
| collection_size     = <!-- {{Format price|number}} -->
| criteria            = 
| legal_deposit       = 
| req_to_access       = 
| annual_circulation  = 
| pop_served          = 
| members             = 
| budget              = <!-- {{Currency|value|code}} -->
| director            = 
| librarian           =
| num_employees       = 
| parent_organization = <!-- or
| parent_organisation = -->
| affiliation         = 
| publictransit       = 
| website             = <!-- {{URL|www.example.com}} -->
| references          = 
| embed               = 
| module              = 
}}

Parameters

name

Designed for the original name of the library. With libraries in multilingual countries, add the other official names, preceded by '<br/>= '. With libraries having a name in a non-Latin script, use the original name in its script, followed by '<br/>' and its transliteration between parentheses.

native_name

Name of building in native language

native_name_lang

use ISO 639-2 code, e.g. "fr" for French. If there is more than one native name, in different languages, enter those names using {{lang}}, instead.

logo

File name only (no Image: or File:), use logo_upright= to change scaling (<1.0 for tall logo, >1.0 wide logo)

image

File name only (no Image: or File:), use image_upright= to change scaling (<1.0 for tall image, >1.0 wide image)

caption

Description of the image above.

country

To be omitted when the country name appears in the library name (original or in English).

type

Prefer denominations leading to an existing page describing the type of library, such as Academic library, National library, Public library, Special library etc. Should be omitted when the relevant word is already present in the library's name.

scope

To be used if a library is specialized in a particular domain but which is not reflected in its name.

established

Foundation year. Use {{Start date}} template. If the library is still open and operating the {{Start date and age}} template can also be used.

architect

Name of the architect, if known and notable.

dissolved

Date of dissolution or closure. Use {{End date}} template.

ref_legal_mandate

Designed for referencing the law or decree establishing the library and defining its mandate.

location

Normally just town and, where appropriate, province. A full address could be entered for libraries having no website of their own. Avoid redundancies, e.g. repeating the country if it is already mentioned in the 'country' field or in the library's name.

service area

The geographic region served by the library, if not already established in earlier parameters.

coordinates

Entered with a tag {{coord|'latitude'|'longitude'|display=inline,title}}. With this code, the coordinates will also appear on the top of the page (but this redundancy is not considered problematic). Remove ",title" from the "display" parameter to omit the display of the coordinates on the top right.

branch_of

Designed for libraries that are known enough to justify an entry in WP but have little or no autonomy, being a branch of another (larger) library.

num_branches

Number of branches, not counting the headquarters, followed by their location between parentheses.

Collection

The header 'Collection' will appear only if at least one of the 4 fields below contains data.

specialization

Any focus area(s) for the collection (for UK spelling, use "specialisation").

items_collected

Allows the specification of the kinds of documents acquired by the library. Prefer denominations having their own page.

collection_size

It makes reading easier to round numbers to 2-3 significant figures using {{Format price}} this allows the source to hold the most accurate number while displaying a much easier to read number formatted per MOS:Dates and numbers.

criteria

Allows to specify the kind of documents the library acquires, be it in its legal mandate or its policy.

legal_deposit

Intended for national libraries, to specify whether they can acquire material through legal deposit, copyright legislation or other kind of agreement.

Access and use

The header 'Access and use' will appear only if at least one of the 4 fields below contains data.

req_to_access

Allows to specify the conditions to be met for accessing the collections, such as residence, age, membership of a specific community etc.

annual_circulation

Number of lent or used items followed by the period concerned, preferably the most recent past year, between parentheses.

pop_served

Allows to specify the number of potential users when the library serves a specific group, be it by area of residence, age, membership etc. Can be omitted when the circle of potential users is vaguely defined, e.g. for national libraries which, as generally last resource library for national material, may serve the entire world. It makes reading easier to round numbers to 3 significant figures using {{Format price}} and format numbers per MOS:Dates and numbers.

members

Number of registered users. It makes reading easier to round numbers to 3 significant figures using {{Format price}}.

Other information

The header 'Other information' will appear only if at least one of the 5 fields below contains data.

budget

Annual budget with specification of the currency using {{currency}}, followed by the year concerned (ideally the current one) between parentheses. It makes reading easier to round numbers to 2-3 significant figures, abbreviate millions by an unspaced 'M' and provide the equivalent in US dollars between parentheses. Templates that can also be helpful here are {{Inflation}} and {{Format price}}.

director

When a name is transliterated, provide the name in its original script between parentheses. Add the year of the appointment between parentheses.

librarian

Name of the person heading the library

num_employees

Number of employees, ideally followed by the number of full-time equivalents (input: [[Full-time_equivalent|FTE]]). It makes reading easier to round numbers to 3 significant figures by using {{Format price}}.

parent_organization

Name of any parent organization. For alternative spelling, use |parent_organisation=

affiliation

Any organizational affiliations.

website

If the website has a home page in English, link directly to it using {{URL}}. Otherwise, specify the language(s) in which the website is.

references

References used specifically to populate infobox.

Maps

A mapframe map is automatically included if:

• There are coordinates specified on the page's Wikidata item (or the item specified in |id=), or in the |coordinates= parameter
• It has not been turned off by setting |mapframe=no

The following optional parameters can then be used to adjust the map

• |mapframe-zoom= zoom level (default is 10)
• |mapframe-width= and |mapframe-height= for the map size (defaults are 270 and 200)
• |mapframe-marker= for the marker icon (default is the library icon)
• either |mapframe-marker-color= or |mapframe-marker-colour= for the marker colour (hex triplet, default is #5E74F3)
• |mapframe-caption= caption below the map
• |mapframe-coordinates= or |mapframe-coord= – alternate initial latitude and longitude for the map, instead of the building's coordinates. Specify as {{coord
• |mapframe-geomask= Show a geomask (shape outside of which the area is shaded. Set to either:
  • yes – use the location specified in the Wikidata item's (P276) statement
  • a wikidata property (P-number), e.g. P17 for (P17) – use the location specified in this statement on the Wikidata item
  • a Wikidata item (Q-number), e.g. Q100 for (Q100) – use this item as the geomask
• |map_caption= – caption for the map. If this is not set, and a geomask is used, an automatic caption of "Location in <geomask-label>" is used.

Use as a child template

The embed parameter is used when embedding this infobox into another (see the Template:Infobox documentation which explains embedding and subboxes).

<syntaxhighlight lang="html" style="overflow: auto;"> Template:Infobox ABC </syntaxhighlight>

Embedding other templates

The module parameter is used for embedding other templates into this infobox (see Wikipedia:Infobox modules).

<syntaxhighlight lang="html" style="overflow: auto;">

Collection
Other information
Map
Template:Infobox ABC

</syntaxhighlight>

Examples

Example 1

Российская национальная библиотека
File:Logo of NLR.jpg
File:Невский 37.jpg The 18th-century building of the library faces Nevsky Prospekt
Country	Russia
Type	National library
Established	1795 (1795)
Reference to legal mandate	Decree of the Government of the Russian Federation authorizing the Statute of the Federal State Institution "The National Library of Russia" (March 23, 2001)
Location	St Petersburg
Coordinates
Collection
Items collected	Books, journals, newspapers, magazines, official publications, sheet music, sound and music recordings, databases, maps, postage stamps, prints, drawings, manuscripts and media.
Size	36.5 million items (15 million books)
Criteria for collection	Legal deposit of materials published in Russia; "Rossika": materials about Russia or materials published by the people of Russia residing abroad; selected foreign scholarly publications and other materials.
Legal deposit	Yes (Legal Deposit Law)
Access and use
Access requirements	Reading rooms – free. Russian residents must be 14 or older. Foreign visitors are limited by the period of their visa.
Circulation	8.88 million (2007)
Population served	1.15 million (2007)
Other information
Budget	()
Staff	1,850
Website
Map

<syntaxhighlight lang="html" style="overflow:auto;">

Российская национальная библиотека
File:Logo of NLR.jpg
File:Невский 37.jpg The 18th-century building of the library faces Nevsky Prospekt
Country	Russia
Type	National library
Established	1795 (1795)
Reference to legal mandate	Decree of the Government of the Russian Federation authorizing the Statute of the Federal State Institution "The National Library of Russia" (March 23, 2001)
Location	St Petersburg
Coordinates
Collection
Items collected	Books, journals, newspapers, magazines, official publications, sheet music, sound and music recordings, databases, maps, postage stamps, prints, drawings, manuscripts and media.
Size	36.5 million items (15 million books)
Criteria for collection	Legal deposit of materials published in Russia; "Rossika": materials about Russia or materials published by the people of Russia residing abroad; selected foreign scholarly publications and other materials.
Legal deposit	Yes (Legal Deposit Law)
Access and use
Access requirements	Reading rooms – free. Russian residents must be 14 or older. Foreign visitors are limited by the period of their visa.
Circulation	8.88 million (2007)
Population served	1.15 million (2007)
Other information
Budget	()
Staff	1,850
Website
Map

</syntaxhighlight>

Example 2: embedded template

File:Carnegie Library of Pittsburgh - IMG 1162.JPG Interior view of the main branch in the Oakland neighborhood
Established	February 6, 1890 (1890-02-06)
Location	Pittsburgh, Pennsylvania
Coordinates
Collection
Size	5.23 million (2009)
Access and use
Circulation	3.53 million (2009)
Population served	2.6 million
Members	294,733 (2009)
Other information
Budget	(2009)
Website
Map
U.S. National Register of Historic Places
Pittsburgh Landmark – PHLF
File:CarnegieLibraryPittsburghFrontEntrance.jpg Carnegie Library of Pittsburgh Main Branch in the city's Oakland neighborhood
Location	4400 Forbes Ave., Pittsburgh, Pennsylvania
Area
NRHP reference No.	79002158
Significant dates
Added to NRHP	March 30, 1979
Designated PHLF	1970

<syntaxhighlight lang="html" style="overflow:auto;">

File:Carnegie Library of Pittsburgh - IMG 1162.JPG Interior view of the main branch in the Oakland neighborhood
Established	February 6, 1890 (1890-02-06)
Location	Pittsburgh, Pennsylvania
Coordinates
Collection
Size	5.23 million (2009)
Access and use
Circulation	3.53 million (2009)
Population served	2.6 million
Members	294,733 (2009)
Other information
Budget	(2009)
Website
Map
U.S. National Register of Historic Places
Pittsburgh Landmark – PHLF
File:CarnegieLibraryPittsburghFrontEntrance.jpg Carnegie Library of Pittsburgh Main Branch in the city's Oakland neighborhood
Location	4400 Forbes Ave., Pittsburgh, Pennsylvania
Area
NRHP reference No.	79002158
Significant dates
Added to NRHP	March 30, 1979
Designated PHLF	1970

</syntaxhighlight>

Microformat

The HTML markup produced by this template includes an hCard microformat, which makes the place-name and location parsable by computers, either acting automatically to catalogue articles across Wikipedia, or via a browser tool operated by a person, to (for example) add the subject to an address book. Within the hCard is a Geo microformat, which additionally makes the coordinates (latitude & longitude) parsable, so that they can be, say, looked up on a map, or downloaded to a GPS unit. For more information about the use of microformats on Wikipedia, please see the microformat project.

Sub-templates

If the place or venue has "established", "founded", "opened" or similar dates, use {{start date}} for the earliest of those dates unless the date is before 1583 CE.

If it has a URL, use {{URL}}.

Please do not remove instances of these sub-templates.

Classes

hCard uses HTML classes including:

• adr
• agent
• category
• county-name
• extended-address
• fn
• label
• locality
• nickname
• note
• org
• region
• street-address
• uid
• url
• vcard

Geo is produced by calling {{coord}}, and uses HTML classes:

• geo
• latitude
• longitude

Please do not rename or remove these classes nor collapse nested elements which use them.

Precision

When giving coordinates, please use an appropriate level of precision. Do not use {{coord}}'s |name= parameter.

TemplateData

TemplateData documentation used by VisualEditor and other tools

Click here to see a monthly parameter usage report for this template based on this TemplateData. TemplateData for Infobox library No description. Template parameters This template prefers block formatting of parameters. Parameter Description Type Status embed embed no description Unknown optional name name no description Unknown optional library_name library_name no description Unknown optional name_en name_en no description Unknown optional library_logo library_logo no description Unknown optional logo logo no description Unknown optional logo_size logo_size no description Unknown optional logo_upright logo_upright no description Unknown optional logo_alt logo_alt no description Unknown optional image image no description Unknown optional image_size image_size no description Unknown optional image_upright image_upright no description Unknown optional alt alt no description Unknown optional caption caption no description Unknown optional country country no description Unknown optional type type no description Unknown optional scope scope no description Unknown optional established established no description Unknown optional dissolved dissolved no description Unknown optional ref_legal_mandate ref_legal_mandate no description Unknown optional location location no description Unknown optional coordinates coordinates no description Unknown optional branch_of branch_of no description Unknown optional num_branches num_branches no description Unknown optional items_collected items_collected no description Unknown optional collection_size collection_size no description Unknown optional criteria_for_collection criteria_for_collection no description Unknown optional legal_deposit legal_deposit no description Unknown optional criteria criteria no description Unknown optional req_to_access req_to_access no description Unknown optional annual_circulation annual_circulation no description Unknown optional pop_served pop_served no description Unknown optional members members no description Unknown optional budget budget no description Unknown optional director director no description Unknown optional dir_since dir_since no description Unknown optional num_employees num_employees no description Unknown optional website website no description Unknown optional module module no description Unknown optional references references no description Unknown optional

Tracking category

• Category:Pages using infobox library with unknown parameters (0)

See also

Template braces

The pages listed in this category are meant to be infobox templates.

This page is part of Wikipedia's administration and not part of the encyclopedia.

Further template category notes

This category contains pages in the template namespace. It should not be used to categorize articles or pages in other namespaces.

To add a template to this category:

• If the template has a separate documentation page (usually called "Template:template name/doc"), add
•  [[Template:Infobox library/doc]]
• to the <includeonly> section at the bottom of that page. Otherwise, add
•  <noinclude>[[Template:Infobox library/doc]]</noinclude>
• to the end of the template code, making sure it starts on the same line as the code's last character.