Template:Infobox housing project/doc

Usage

{{Infobox housing project
| building name               = 
| image                       = 
| image_size                  = 
| alt                         = 
| caption                     = 
| image_map                   = 
| map_size                    = 
| map_alt                     = 
| map_caption                 = 
| pushpin_map                 = 
| pushpin_relief              = 
| pushpin_mapsize             = 
| pushpin_map_alt             = 
| pushpin_map_caption         = 
| pushpin_label               = 
| map_dot_mark                = 
| location                    = 
| coordinates                 = 
| status                      = 
| category                    = 
| demolished                  = 
| area                        = 
| population date             = 
| population                  = 
| blocknumber                 = 
| units                       = 
| density                     = 
| built                       = 
| construction period         = 
| constructed                 = 
| construction architect      = 
| construction contractors    = 
| construction style          = 
| construction date           = 
| construction authority      = 
| construction influence      = 
| refurbishment architect     = 
| refurbishment contractors   = 
| refurbishment style         = 
| refurbishment method        = 
| refurbishment image         = 
| refurbishment caption       = 
| refurbishment proposal date = 
| refurbishment units         = 
| refurbished                 = 
| refurbishment authority     = 
| listing date                = 
| listing type                = 
| succession                  = 
| governing body              = 
| famous residents            = 
}}

Parameters

All fields are optional:

• building name – the name of the building(s)
• image – an image of the housing project; provide the image name without wikimarkup (e.g. SomeFile.jpg rather than [[File:SomeFile.jpg|200px]])
• image_size – the size of the image in pixels (e.g. 200px)
• alt – alt text for visually impaired readers; see WP:ALT
• caption – an optional text regarding the image; see WP:CAPTION. If a caption is not provided, the template will use the year_highest and year_end fields to create one.
• image_map – An image of a map showing the location of the facility. Use wiki image syntax.
• map_caption – To go with the image_map
• pushpin_map – The name of a location map
• pushpin_map_caption – To go with the pushpin_map
• location – the address (and at least the city) in which the housing project is located
  • Major, international cities: Tokyo is okay, but Tokyo, Japan is preferred unless it compromises stylistic appearance
  • Major cities in well-known provinces: Toronto, Ontario, Canada is unnecessarily specific; Toronto, Ontario or Toronto, Canada preferred (although Toronto is okay)
  • Cities with relative international anonymity: Beslan is not good due to the city's relative anonymity; Beslan, Russia is preferred, Beslan, North Ossetia–Alania discouraged, Beslan, Russia, North Ossetia–Alania unnecessarily specific
  • Cities with common names: Portland is not good; Portland, US is not good either; Portland, Oregon (well-known state) or Portland, Oregon, US preferred
• coordinates – use {{coord}} with "display=inline,title"
• status – the status of the housing project (e.g., Completed, Proposed, Under construction, Demolished, Destroyed, or Never built)
• units – the number of housing units in the housing project
• constructed – the year(s) in which the housing project was constructed (e.g. 1996–1999)
• demolished – the date in which the housing project was demolished
• governing body – the housing project management agency or company
• famous residents – famous (or infamous) people who have lived in the housing project

Mapframe maps

• Basic parameters:
  • mapframe – Specify yes or no to show or hide the map, overriding the default. Default: off if |pushpin_map= is used, on otherwise
  • mapframe-caption – Caption for the map. Default: blank (or if |mapframe-geomask= is set, "Location in geomask's label")
  • mapframe-custom – Use a custom map instead of the automatic mapframe. Specify either a {{maplink}} template, or another template that generates a mapframe map, or an image name. If used, the subsequent mapframe parameters will be ignored. Default: not specified
  • mapframe-id or id or qid – Id (Q-number) of Wikidata item to use. Default: item for current page
  • mapframe-coordinates or mapframe-coord or coordinates or coord – Coordinates to use, instead of any on Wikidata. Use the {{Coord}} template, e.g. |coord={{Coord|12.34|N|56.78|E}}. Default: coordinates from Wikidata
  • mapframe-wikidata – Set to <syntaxhighlight lang="text" class="" id="" style="" inline="1">yes</syntaxhighlight> to show shape/line features from the wikidata item, if any, when |coord= is set. Default: not specified
• Customise which features are displayed:
  • mapframe-shape – Turn off display of shape feature by setting to <syntaxhighlight lang="text" class="" id="" style="" inline="1">none</syntaxhighlight>. Use an inverse shape (geomask) instead of a regular shape by setting to <syntaxhighlight lang="text" class="" id="" style="" inline="1">inverse</syntaxhighlight>. Default: not specified
  • mapframe-point – Turn off display of point feature by setting to <syntaxhighlight lang="text" class="" id="" style="" inline="1">none</syntaxhighlight>. Force point marker to be displayed by setting to <syntaxhighlight lang="text" class="" id="" style="" inline="1">on</syntaxhighlight>. Default: not specified
  • mapframe-line – Turn off display of line feature by setting to <syntaxhighlight lang="text" class="" id="" style="" inline="1">none</syntaxhighlight>. Default: not specified
  • mapframe-geomask – Wikidata item to use as a geomask (everything outside the boundary is shaded darker). Can either be a specific Wikidata item (Q-number), or a property that specifies the item to use (e.g. P17 for (P17), P131 for (P131)). Default: not specified
  • mapframe-switcher – set to <syntaxhighlight lang="text" class="" id="" style="" inline="1">auto</syntaxhighlight> or <syntaxhighlight lang="text" class="" id="" style="" inline="1">geomasks</syntaxhighlight> or <syntaxhighlight lang="text" class="" id="" style="" inline="1">zooms</syntaxhighlight> to enable Template:Switcher-style switching between multiple mapframes. Default: not specified
    • <syntaxhighlight lang="text" class="" id="" style="" inline="1">auto</syntaxhighlight> – switch geomasks found in (P276) and (P131) statements on the page's Wikidata item, searching recursively. E.g. an item's city, that city's state, and that state's country.
    • <syntaxhighlight lang="text" class="" id="" style="" inline="1">geomasks</syntaxhighlight> – switch between the geomasks specified as a comma-separated list of Wikidata items (Q-numbers) in the mapframe-geomask parameter
    • <syntaxhighlight lang="text" class="" id="" style="" inline="1">zooms</syntaxhighlight> – switch between "zoomed in"/"zoomed midway"/"zoomed out", where "zoomed in" is the default zoom (with a minimum of <syntaxhighlight lang="text" class="" id="" style="" inline="1">3</syntaxhighlight>), "zoomed out" is <syntaxhighlight lang="text" class="" id="" style="" inline="1">1</syntaxhighlight>, and "zoomed midway" is the average
• Other optional parameters:
  • mapframe-frame-width or mapframe-width – Frame width. Default: 270
  • mapframe-frame-height or mapframe-height – Frame height. Default: 200
  • mapframe-shape-fill – Color used to fill shape features. Default: #606060
  • mapframe-shape-fill-opacity – Opacity level of shape fill, a number between 0 and 1. Default: 0.5
  • mapframe-stroke-color or mapframe-stroke-colour – Color of line features, and outlines of shape features. Default: #ff0000
  • mapframe-stroke-width – Width of line features, and outlines of shape features; default is "5". Default: 5
  • mapframe-marker – Marker symbol to use for coordinates; see mw:Help:Extension:Kartographer/Icons for options. Default: not specified (i.e. blank)
    • Can also be set to <syntaxhighlight lang="text" class="" id="" style="" inline="1">blank</syntaxhighlight> to override any default marker symbol
  • mapframe-marker-color or mapframe-marker-colour – Background color for the marker. Default: #5E74F3
  • mapframe-geomask-stroke-color or mapframe-geomask-stroke-colour – Color of outline of geomask shape. Default: #555555
  • mapframe-geomask-stroke-width – Width of outline of geomask shape. Default: 2
  • mapframe-geomask-fill – Color used to fill outside geomask features. Default: #606060
  • mapframe-geomask-fill-opacity – Opacity level of fill outside geomask features, a number between 0 and 1. Default: 0.5
  • mapframe-zoom – Set the zoom level, from "1" (map of earth) to "18" (maximum zoom in), to be used if the zoom level cannot be determined automatically from object length or area. Default: 10
  • mapframe-length_km or mapframe-length_mi or mapframe-area_km2 or mapframe-area_mi2 – Determine zoom level by passing in object's length (in kilometres or miles) or area (in square kilometres or square miles). Default: not specified
  • mapframe-frame-coordinates or mapframe-frame-coord – Alternate latitude and longitude coordinates for initial placement of map, using {{coord}}. Default: derived from item coordinates

Tracking category

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

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 housing project/doc]]
• to the <includeonly> section at the bottom of that page. Otherwise, add
•  <noinclude>[[Template:Infobox housing project/doc]]</noinclude>
• to the end of the template code, making sure it starts on the same line as the code's last character.