Jump to content

Template:Infobox library/doc

From Wikipedia, the free encyclopedia

Usage

[edit]

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

{{{name}}}
{{{native_name}}}
[[File:{{{logo}}}|{{{logo_size}}}|alt={{{logo_alt}}}|upright={{{logo_upright}}}]]
[[File:{{{image}}}|{{{image_size}}}|alt={{{alt}}}|upright={{{image_upright}}}]]
{{{caption}}}
Map
0°N 0°E / 0°N 0°E / 0; 0
Location{{{address}}}, {{{city}}}, {{{region}}}, {{{state}}}, {{{country}}}, {{{postcode}}}
Type{{{type}}}
Scope{{{scope}}}
Established{{{established}}}
Architect(s){{{architect}}}
Reference to legal mandate{{{ref_legal_mandate}}}
Service area{{{service_area}}}
Branch of{{{branch_of}}}
Branches{{{num_branches}}}
Collection
Items collected{{{items_collected}}}
Size{{{collection_size}}}
Criteria for collection{{{criteria}}}
Legal deposit{{{legal_deposit}}}
Access and use
Access requirements{{{req_to_access}}}
Circulation{{{annual_circulation}}}
Population served{{{pop_served}}}
Members{{{members}}}
Other information
Budget{{{budget}}}
Director{{{director}}}
Employees{{{num_employees}}}
Parent organization{{{parent_organization}}}
Affiliation{{{affiliation}}}
Public transit access{{{publictransit}}}
Website{{{website}}}
{{{module}}}
References: {{{references}}}
{{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            = 
| num_employees       = 
| parent_organization = <!-- or
| parent_organisation = -->
| affiliation         = 
| publictransit       = 
| website             = <!-- {{URL|www.example.com}} -->
| references          = 
| embed               = 
| module              = 
}}

Parameters

[edit]
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

[edit]

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

[edit]

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

[edit]

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 {{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.
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.
publictransit
Information on nearby public transit options
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

[edit]

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-stroke-width= for the border of marker (default is 6)
  • |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 location (P276) statement
    • a wikidata property (P-number), e.g. P17 for country (P17) – use the location specified in this statement on the Wikidata item
    • a Wikidata item (Q-number), e.g. Q100 for Boston (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

[edit]

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

{{Infobox ABC
| name        = 
| <!-- etc. -->
| embedded    = <!-- or module= -->
  {{Infobox library
  | embed = yes
  | <!-- etc. -->
  }}<br/>
}}

Embedding other templates

[edit]

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

{{Infobox library
| name = 
| <!-- etc. -->
| module = 
  {{Infobox ABC
  | embed = yes <!-- or child=yes or subbox=yes-->
  | <!-- etc. -->
  }}
}}

Examples

[edit]

Example 1

[edit]
The National Library of Russia
Российская национальная библиотека
The 18th-century building of the library
faces Nevsky Prospekt
Map
59°56′01″N 30°20′08″E / 59.933611°N 30.335556°E / 59.933611; 30.335556
LocationSt Petersburg, Russia
TypeNational library
Established1795 (1795)
Reference to legal mandateDecree of the Government of the Russian Federation authorizing the Statute of the Federal State Institution "The National Library of Russia" (March 23, 2001)
Collection
Items collectedBooks, journals, newspapers, magazines, official publications, sheet music, sound and music recordings, databases, maps, postage stamps, prints, drawings, manuscripts and media.
Size36.5 million items (15 million books)
Criteria for collectionLegal 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 depositYes (Legal Deposit Law)
Access and use
Access requirementsReading rooms – free. Russian residents must be 14 or older. Foreign visitors are limited by the period of their visa.
Circulation8.88 million (2007)
Population served1.15 million (2007)
Other information
Budget569,200,000  (US$23,400,000)
Employees1,850
Websitewww.nlr.ru/eng/
{{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/}}
}}

Example 2: embedded template

[edit]
Carnegie Library of Pittsburgh
Interior view of the main branch in the Oakland neighborhood
Map
40°26′34″N 79°57′03″W / 40.442728°N 79.950787°W / 40.442728; -79.950787
LocationPittsburgh, Pennsylvania
EstablishedFebruary 6, 1890 (1890-02-06)
Collection
Size5.23 million (2009)
Access and use
Circulation3.53 million (2009)
Population served2.6 million
Members294,733 (2009)
Other information
BudgetUS$26,879,454 (2009)
Websitewww.CarnegieLibrary.org
Carnegie Library of Pittsburgh Main Branch in the city's Oakland neighborhood
Location4400 Forbes Ave., Pittsburgh, Pennsylvania
Area9.5 acres (3.8 ha)
NRHP reference No.79002158
Significant dates
Added to NRHPMarch 30, 1979
Designated PHLF1970
{{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}}
| refnum                 = 79002158
| added                  = March 30, 1979
| designated_other1_date = 1970
}}
}}

Microformat

[edit]

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

[edit]

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

[edit]

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

[edit]

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

TemplateData

[edit]
TemplateData documentation used by VisualEditor and other tools
See a monthly parameter usage report for Template:Infobox library in articles based on its TemplateData.

TemplateData for Infobox library

An infobox for a library

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Namename library_name

The name of the library (defaults to article name if left blank)

Stringsuggested
Native namenative_name

The native name of the library.

Stringoptional
Native language namenative_name_lang

The language code for the native name

Example
zh
Stringoptional
Logologo library_logo

The logo of the library

Filesuggested
Logo sizelogo_size

The width of the image, in pixels

Example
220px
Unknownoptional
Logo uprightlogo_upright

The upright value for the image

Example
1.2
Numberoptional
Logo altlogo_alt

The alt text of the logo

Stringoptional
Imageimage

A photo of the library

Filesuggested
Image sizeimage_size

The width of the image, in pixels

Example
220px
Unknownoptional
Image uprightimage_upright

The upright value for the image

Example
1.2
Numberoptional
Altalt

Alt text for the image

Stringoptional
Captioncaption

A caption for the image

Stringoptional
Mapmap

no description

Unknownoptional
Map imagemap_image

no description

Unknownoptional
Coordinatescoordinates

The coordinates of the library, using {{Coord}}

Unknownsuggested
Locationlocation Location

no description

Unknownoptional
Addressaddress Address

no description

Unknownoptional
Citycity City

The city the library is located in

Stringoptional
Regionregion Region

The region the library is located in

Stringoptional
Statestate State

The state the library is located in

Unknownoptional
Countrycountry Country

The country the library is located in

Unknownoptional
Zip codezipcode Zipcode postcode Postcode

The zip code that the library is in

Numberoptional
Typetype

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.

Stringoptional
Scopescope

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

Stringoptional
Establishedestablished

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

Dateoptional
Dissolveddissolved

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

Unknownoptional
ref_legal_mandateref_legal_mandate

no description

Unknownoptional
Branch of: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.

Unknownoptional
Number of Branchesnum_branches

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

Unknownoptional
items_collecteditems_collected

no description

Unknownoptional
collection_sizecollection_size

no description

Unknownoptional
criteria_for_collectioncriteria_for_collection

no description

Unknownoptional
legal_depositlegal_deposit

no description

Unknownoptional
criteriacriteria

no description

Unknownoptional
req_to_accessreq_to_access

no description

Unknownoptional
annual_circulationannual_circulation

no description

Unknownoptional
pop_servedpop_served

no description

Unknownoptional
membersmembers

no description

Unknownoptional
budgetbudget

no description

Unknownoptional
directordirector

no description

Unknownoptional
Director Sincedir_since

no description

Unknownoptional
num_employeesnum_employees

no description

Unknownoptional
websitewebsite

no description

Example
{{URL|www.example.com/}} }}
Unknownoptional
modulemodule

no description

Unknownoptional
referencesreferences

no description

Unknownoptional
postcodepostcode

no description

Unknownoptional
closedclosed

no description

Unknownoptional
architectarchitect

no description

Unknownoptional
service_areaservice_area

no description

Unknownoptional
specialisationspecialisation

no description

Unknownoptional
specializationspecialization

no description

Unknownoptional
affiliationaffiliation

no description

Unknownoptional
fundingfunding

no description

Unknownoptional
publictransitpublictransit

no description

Unknownoptional
parent_organizationparent_organization

no description

Unknownoptional
parent_organisationparent_organisation

no description

Unknownoptional
mapframemapframe

no description

Unknownoptional
map_captionmap_caption

no description

Unknownoptional
mapframe-geomaskmapframe-geomask

no description

Unknownoptional
idid

no description

Unknownoptional
embedembed

no description

Unknownoptional

Tracking category

[edit]

See also

[edit]