View source for Template:Infobox library/doc

{{Documentation subpage}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{Lua|Module:Infobox|Module:InfoboxImage|Module:WikidataIB|Module:Location map|Module:Check for unknown parameters}}

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

{{Generic template demo
| name
| native_name
| logo
| logo_size
| logo_upright
| logo_alt
| image
| image_size
| image_upright
| alt
| caption
| country
| type
| scope
| established
| architect
| ref_legal_mandate
| location
| service_area
| coordinates = {{coord|0|0}}
| location_map = World
| branch_of
| num_branches
| items_collected
| collection_size
| criteria
| legal_deposit
| req_to_access
| annual_circulation
| pop_served
| members
| budget
| director
| num_employees
| affiliation
| parent_organization
| publictransit
| website
| references
| module
}}

<pre style="overflow:auto;">
{{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          = 
| 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            = 
| num_employees       = 
| parent_organization = <!-- or
| parent_organisation = -->
| affiliation         = 
| publictransit       = 
| website             = <!-- {{URL|www.example.com}} -->
| references          = 
| embed               = 
| module              = 
}}
</pre>
{{clear}}

== Parameters ==
; name: Designed for the original name of the library. With libraries in multilingual countries, add the other official names, preceded by '&#60;br/&#62;= '. With libraries having a name in a non-Latin script, use the original name in its script, followed by '&#60;br/&#62;' and its transliteration between parentheses.
; native_name: Name of building in native language
; native_name_lang: use [[List of ISO 639-2 codes|ISO 639-2 code]], e.g. "fr" for French. If there is more than one native name, in different languages, enter those names using {{tl|lang}}, instead. 
; logo:  File name only (no Image: or File:), use <code>logo_upright=</code> to change scaling (<1.0 for tall logo, >1.0 wide logo)
; image: File name only (no Image: or File:), use <code>image_upright=</code> 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 {{tlx|Start date}} template. If the library is still open and operating the {{tlx|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 {{tlx|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 <nowiki>{{coord|'latitude'|'longitude'|display=inline,title}}</nowiki>. 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 {{tlx|Format price}} this allows the source to hold the most accurate number while displaying a much easier to read number formatted per [[Wikipedia:Manual of Style/Dates and numbers#Numbers as figures or words|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 {{tlx|Format price}} and format numbers per [[Wikipedia:Manual of Style/Dates and numbers#Numbers as figures or words|MOS:Dates and numbers]].
; members: Number of registered users. It makes reading easier to round numbers to 3 significant figures using {{tlx|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 {{tlx|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 {{tlx|Inflation}} and {{tlx|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.
; num_employees: Number of employees, ideally followed by the number of [[full-time equivalent]]s (input: <nowiki>[[Full-time_equivalent|FTE]]</nowiki>). It makes reading easier to round numbers to 3 significant figures by using {{tlx|Format price}}.
; parent_organization: Name of any parent organization.  For alternative spelling, use {{para|parent_organisation}}
; affiliation: Any organizational affiliations.
; website: If the website has a home page in English, link directly to it using {{tlx|URL}}. Otherwise, specify the language(s) in which the website is.
; references: References used specifically to populate infobox.

=== Maps ===
A [[Template:Mapframe|mapframe]] map is automatically included if:
* There are coordinates specified on the page's Wikidata item (or the item specified in {{para|id}}), or in the {{para|coordinates}} parameter
* It has not been turned off by setting {{para|mapframe|no}}
The following optional parameters can then be used to adjust the map
* {{para|mapframe-zoom}} zoom level (default is {{kbd|10}})
* {{para|mapframe-width}} and {{para|mapframe-height}} for the map size (defaults are {{kbd|270}} and {{kbd|200}})
* {{para|mapframe-marker}} for the [[mw:Help:Extension:Kartographer/Icons|marker icon]] (default is the library icon)
* either {{para|mapframe-marker-color}} or {{para|mapframe-marker-colour}} for the marker colour ([[hex triplet]], default is <code>#5E74F3</code>)
* {{para|mapframe-caption}} caption below the map
* {{para|mapframe-coordinates}} or {{para|mapframe-coord}} – alternate initial latitude and longitude for the map, instead of the building's coordinates. Specify as {{kbd|<nowiki>{{</nowiki>coord| ''latitude'' | ''longitude'' <nowiki>}}</nowiki>}}
* {{para|mapframe-geomask}} Show a geomask (shape outside of which the area is shaded. Set to either:
** {{kbd|yes}} – use the location specified in the Wikidata item's {{Q|P276}} statement
** a wikidata property (P-number), e.g. {{kbd|P17}} for {{Q|P17}} – use the location specified in this statement on the Wikidata item
** a Wikidata item (Q-number), e.g. {{kbd|Q100}} for {{Q|100}} – use this item as the geomask
* {{para|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 [[Template:Infobox/doc#Embedding|embedding]] and [[Template:Infobox/doc#Subboxes|subboxes]]).

<pre style="overflow: auto;">
{{Infobox ABC
| name        = 
| <!-- etc. -->
| embedded    = <!-- or module= -->
  {{Infobox library
  | embed = yes
  | <!-- etc. -->
  }}<br/>
}}
</pre>

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

<pre style="overflow: auto;">
{{Infobox library
| name = 
| <!-- etc. -->
| module = 
  {{Infobox ABC
  | embed = yes <!-- or child=yes or subbox=yes-->
  | <!-- etc. -->
  }}
}}
</pre>

== Examples ==

=== Example 1 ===
{{Infobox library
| name               = The National Library of Russia
| native_name        = Российская национальная библиотека
| native_name_lang   = ru
| logo               = Logo of NLR.jpg
| logo_size          = 180
| logo_alt           = 
| image              = Невский 37.jpg
| image_size         = 
| alt                = 
| caption            = The 18th-century building of the library <br />faces [[Nevsky Prospekt]]
| country            = [[Russia]]
| type               = [[National library]]
| scope              = 
| established        = {{start date|1795}}
| ref_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        = {{coord|59.933611|30.335556|region:RU_type:landmark|display=inline<!--,title-->}}
| branch_of          = 
| num_branches       = 
| items_collected    = Books, [[Academic journal|journals]], newspapers, magazines, [[Official publications of Russia|official publications]], sheet music, sound and music recordings, databases, maps, postage stamps, [[Printmaking|prints]], drawings, manuscripts and media.
| collection_size    = {{Format price|36475000}} items ({{Format price|15000000}} books)
| criteria           = 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)
| req_to_access      = Reading rooms&nbsp;– free. Russian residents must be 14 or older. Foreign visitors are limited by the period of their visa.
| annual_circulation = {{Format price|8880000}} (2007)
| pop_served         = {{Format price|1150000}} (2007)
| members            = 
| budget             = {{Currency|569200000|RUB}} ({{Currency|23400000|USD}})
| director           = 
| num_employees      = 1,850
| website            = {{URL|www.nlr.ru/eng/}}
}}

<pre style="overflow:auto;">
{{Infobox library
| name               = The National Library of Russia
| native_name        = Российская национальная библиотека
| native_name_lang   = ru
| logo               = Logo of NLR.jpg
| logo_size          = 180
| logo_alt           = 
| image              = Невский 37.jpg
| image_size         = 
| alt                = 
| caption            = The 18th-century building of the library <br />faces [[Nevsky Prospekt]]
| country            = [[Russia]]
| type               = [[National library]]
| scope              = 
| established        = {{start date|1795}}
| ref_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        = {{coord|59.933611|30.335556|region:RU_type:landmark|display=inline<!--,title-->}}
| branch_of          = 
| num_branches       = 
| items_collected    = Books, [[Academic journal|journals]], newspapers, magazines, [[Official publications of Russia|official publications]], sheet music, sound and music recordings, databases, maps, postage stamps, [[Printmaking|prints]], drawings, manuscripts and media.
| collection_size    = {{Format price|36475000}} items ({{Format price|15000000}} books)
| criteria           = 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)
| req_to_access      = Reading rooms&nbsp;– free. Russian residents must be 14 or older. Foreign visitors are limited by the period of their visa.
| annual_circulation = {{Format price|8880000}} (2007)
| pop_served         = {{Format price|1150000}} (2007)
| members            = 
| budget             = {{Currency|569200000|RUB}} ({{Currency|23400000|USD}})
| director           = 
| num_employees      = 1,850
| website            = {{URL|www.nlr.ru/eng/}}
}}
</pre>
{{clear}}

=== Example 2: embedded template ===
{{Infobox library
| name               = Carnegie Library of Pittsburgh
| logo               = 
| logo_size          = 100
| logo_alt           = 
| image              = Carnegie Library of Pittsburgh - IMG 1162.JPG
| image_size         = 250
| alt                = 
| caption            = Interior view of the main branch in the Oakland neighborhood
| country            = 
| type               = 
| scope              = 
| established        = {{Start date|1890|02|06}}
| ref_legal_mandate  = 
| location           = [[Pittsburgh, Pennsylvania]]
| coordinates        = {{coord|40.442728|-79.950787|region:US-PA_type:landmark|format=dms|display=inline<!--,title-->}}
| branch_of          = 
| num_branches       = 
| items_collected    = 
| collection_size    = {{Format price|5230200}} (2009)
| criteria           = 
| legal_deposit      = 
| req_to_access      = 
| annual_circulation = {{Format price|3529379}} (2009)
| pop_served         = {{Format price|2600000}}
| members            = {{Format price|294733}} (2009)
| budget             = {{Currency|26879454|USD}} (2009)
| director           = 
| num_employees      = 
| website            = {{URL|www.carnegielibrary.org|www.CarnegieLibrary.org}}
| module             = 
  {{Infobox NRHP
  | embed = yes
  | name = 
  | nrhp_type = 
  | designated_other1 = PHLF
  | image = CarnegieLibraryPittsburghFrontEntrance.jpg
  | caption = Carnegie Library of Pittsburgh Main Branch in the city's Oakland neighborhood
  | location = 4400 Forbes Ave., [[Pittsburgh, Pennsylvania]]
  | locmapin = Pennsylvania
  | area = {{convert|9.5|acre|1}}
  | governing_body = Carnegie Library of Pittsburgh
  | refnum = 79002158
  | added = March 30, 1979
  | designated_other1_date = 1970
  }}
}}

<pre style="overflow:auto;">
{{Infobox library
| name               = Carnegie Library of Pittsburgh
| logo               = 
| logo_size          = 100
| logo_alt           = 
| image              = Carnegie Library of Pittsburgh - IMG 1162.JPG
| image_size         = 250
| alt                = 
| caption            = Interior view of the main branch in the Oakland neighborhood
| country            = 
| type               = 
| scope              = 
| established        = {{Start date|1890|02|06}}
| ref_legal_mandate  = 
| location           = [[Pittsburgh, Pennsylvania]]
| coordinates        = {{coord|40.442728|-79.950787|region:US-PA_type:landmark|format=dms|display=inline<!--,title-->}}
| branch_of          = 
| num_branches       = 
| items_collected    = 
| collection_size    = {{Format price|5230200}} (2009)
| criteria           = 
| legal_deposit      = 
| req_to_access      = 
| annual_circulation = {{Format price|3529379}} (2009)
| pop_served         = {{Format price|2600000}}
| members            = {{Format price|294733}} (2009)
| budget             = {{Currency|26879454|USD}} (2009)
| director           = 
| num_employees      = 
| website            = {{URL|www.carnegielibrary.org|www.CarnegieLibrary.org}}
| module             = 
  {{Infobox NRHP
  | embed = yes
  | name = 
  | nrhp_type = 
  | designated_other1 = PHLF
  | image = CarnegieLibraryPittsburghFrontEntrance.jpg
  | caption = Carnegie Library of Pittsburgh Main Branch in the city's Oakland neighborhood
  | location = 4400 Forbes Ave., [[Pittsburgh, Pennsylvania]]
  | locmapin = Pennsylvania
  | area = {{convert|9.5|acre|1}}
  | governing_body = Carnegie Library of Pittsburgh
  | refnum = 79002158
  | added = March 30, 1979
  | designated_other1_date = 1970
  }}
}}
</pre>
{{clear}}

==Microformat==
{{UF-hcard-geo}}

== TemplateData ==
{{Collapse top|title=[[Wikipedia:TemplateData|TemplateData]] documentation used by [[Wikipedia:VisualEditor|VisualEditor]] and other tools}}
{{TemplateData header|noheader=1}}
<templatedata>
{
	"format": "block",
	"params": {
		"embed": {},
		"name": {},
		"library_name": {},
		"name_en": {},
		"library_logo": {},
		"logo": {},
		"logo_size": {},
		"logo_upright": {},
		"logo_alt": {},
		"image": {},
		"image_size": {},
		"image_upright": {},
		"alt": {},
		"caption": {},
		"country": {},
		"type": {},
		"scope": {},
		"established": {},
		"dissolved": {},
		"ref_legal_mandate": {},
		"location": {},
		"coordinates": {},
		"branch_of": {},
		"num_branches": {},
		"items_collected": {},
		"collection_size": {},
		"criteria_for_collection": {},
		"legal_deposit": {},
		"criteria": {},
		"req_to_access": {},
		"annual_circulation": {},
		"pop_served": {},
		"members": {},
		"budget": {},
		"director": {},
		"dir_since": {},
		"num_employees": {},
		"website": {},
		"module": {},
		"references": {}
	}
}
</templatedata>
{{Collapse bottom}}

==Tracking category==
* {{clc|Pages using infobox library with unknown parameters}}

==See also==
{{Buildings and structures infobox templates}}

<includeonly>{{Sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Buildings and structures infobox templates|Library]]
[[Category:Organization infobox templates|Library]]
[[Category:Infobox templates with module parameter|Library]]
[[Category:Embeddable templates]]
[[Category:Templates that add a tracking category]]
[[Category:WikiProject Libraries infoboxes|Library]]
}}</includeonly>