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.

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 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   to change scaling (<1.0 for tall logo, >1.0 wide logo)
 * image: File name only (no Image: or File:), use  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 template. If the library is still open and operating the  template can also be used.
 * architect: Name of the architect, if known and notable.
 * dissolved: Date of dissolution or closure. Use 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 °N, °W . 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 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 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.

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


 * budget: Annual budget with specification of the currency using, 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 and.
 * 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 equivalents (input: FTE ). It makes reading easier to round numbers to 3 significant figures by using.
 * parent_organization: Name of any parent organization. For alternative spelling, use parent_organisation
 * affiliation: Any organizational affiliations.
 * publictransit: Information on nearby public transit options
 * website: If the website has a home page in English, link directly to it using . 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: The following optional parameters can then be used to adjust the map
 * 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 no
 * 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 )
 * 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 °N, °W
 * 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 statement
 * a wikidata property (P-number), e.g. P17 for – use the location specified in this statement on the Wikidata item
 * a Wikidata item (Q-number), e.g. Q100 for – 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 " 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).

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

TemplateData
{	"format": "block", "params": { "embed": {}, "name": { "aliases": [ "library_name" ],			"label": "Name", "description": "The name of the library (defaults to article name if left blank)", "type": "string", "suggested": true },		"logo": { "aliases": [ "library_logo" ],			"label": "Logo", "description": "The logo of the library", "type": "wiki-file-name", "suggested": true },		"logo_size": { "label": "Logo size", "description": "The width of the image, in pixels", "example": "220px" },		"logo_upright": { "label": "Logo upright", "description": "The upright value for the image", "example": "1.2", "type": "number" },		"logo_alt": { "label": "Logo alt", "description": "The alt text of the logo", "type": "string" },		"image": { "label": "Image", "description": "A photo of the library", "type": "wiki-file-name", "suggested": true },		"image_size": { "label": "Image size", "description": "The width of the image, in pixels", "example": "220px" },		"image_upright": { "label": "Image upright", "description": "The upright value for the image", "example": "1.2", "type": "number" },		"alt": { "label": "Alt", "description": "Alt text for the image", "type": "string" },		"caption": { "label": "Caption", "description": "A caption for the image", "type": "string" },		"country": { "label": "Country", "description": "The country the library is located in", "aliases": [ "Country" ]		},		"type": { "label": "Type", "description": "The type of this library. 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.", "type": "string" },		"scope": { "label": "Scope", "description": "To be used if a library is specialized in a particular domain but which is not reflected in its name.", "type": "string" },		"established": { "label": "Established", "description": "Foundation year. Use template. If the library is still open and operating the  template can also be used.", "type": "date" },		"dissolved": {}, "ref_legal_mandate": {}, "location": { "aliases": [ "Location" ],			"label": "Location" },		"coordinates": { "label": "Coordinates", "description": "The coordinates of the library, using °N, °W", "suggested": true },		"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": {}, "native_name": { "label": "Native name", "description": "The native name of the library.", "type": "string" },		"native_name_lang": { "label": "Native language name", "description": "The language code for the native name", "example": "zh", "type": "string" },		"map": { "label": "Map" },		"map_image": { "label": "Map image" },		"address": { "aliases": [ "Address" ],			"label": "Address" },		"city": { "aliases": [ "City" ],			"label": "City", "description": "The city the library is located in", "type": "string" },		"region": { "aliases": [ "Region" ],			"label": "Region", "description": "The region the library is located in", "type": "string" },		"state": { "aliases": [ "State" ],			"label": "State", "description": "The state the library is located in" },		"postcode": {}, "zipcode": { "aliases": [ "Zipcode", "postcode", "Postcode" ],			"label": "Zip code", "description": "The zip code that the library is in", "type": "number" },		"closed": {}, "architect": {}, "service_area": {}, "specialisation": {}, "specialization": {}, "affiliation": {}, "funding": {}, "publictransit": {}, "parent_organization": {}, "parent_organisation": {}, "mapframe": {}, "map_caption": {}, "mapframe-geomask": {}, "id": {} },	"description": "An infobox for a library", "paramOrder": [ "name", "native_name", "native_name_lang", "logo", "logo_size", "logo_upright", "logo_alt", "image", "image_size", "image_upright", "alt", "caption", "map", "map_image", "coordinates", "location", "address", "city", "region", "state", "country", "zipcode", "type", "scope", "established", "dissolved", "ref_legal_mandate", "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", "postcode", "closed", "architect", "service_area", "specialisation", "specialization", "affiliation", "funding", "publictransit", "parent_organization", "parent_organisation", "mapframe", "map_caption", "mapframe-geomask", "id", "embed" ] }