View source for Template:Infobox restaurant/doc

{{Documentation subpage}}
<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->
{{Lua|Module:Infobox|Module:InfoboxImage|Module:Infobox mapframe|Module:Location map|Module:Check for unknown parameters}}

== Usage ==
{{Parameter names example | name | logo | logo_width | logo_alt | image | image_width | image_alt | image_caption |mapframe=yes |mapframe-caption | pushpin_map= | map_size | map_alt | map_caption | slogan | established | closed | current-owner | previous-owner | head-chef | chef | pastry-chef | food-type | dress-code | rating | street-address | city  | county | state | zip | country | coordinates={{coord|0.0001|-79.3950}} | seating-capacity | reservations | other-locations | other-label= | other-information | website
}}

<pre style="overflow:auto">
{{Infobox restaurant
| embed               = 
| name                = <!-- Leave blank if embed set to yes -->
| title               = <!-- If embedding use this for secondary small font title -->
| logo                = 
| logo_width          = 
| logo_alt            = 
| image               = 
| image_width         = 
| image_alt           = 
| image_caption       = 
| mapframe            = <!-- Set to yes to show a mapframe map -->
| pushpin_map         = <!-- Requires {{para|coordinates}} -->
| map_alt             = 
| map_caption         = 
| map_size            = 
| slogan              = 
| established         = <!-- {{Start date|YYYY|MM|DD}} -->
| closed              = <!-- {{End date|YYYY|MM|DD}} -->
| current-owner       = 
| previous-owner      = 
| head-chef           = 
| chef                = 
| pastry-chef         = 
| food-type           = 
| dress-code          = 
| rating              = 
| street-address      = 
| city                = 
| county              = 
| state               = 
| postcode            = <!-- or |zip= -->
| country             = 
| coordinates         = <!-- {{coord}} -->
| seating-capacity    = 
| reservations        = 
| other-locations     = 
| other-information   = <!-- or |other-label= -->
| website             = <!-- {{URL|example.com}} -->
}}
</pre>
{{clear}}

==Description==
{| class="wikitable"
|- 
! style="background-color:orange" | Field
! style="background-color:orange" | Description
|-
| <code>name</code>
| Name of restaurant (required)
|-
| <code>logo</code>
| Restaurant's logo
|-
| <code>logo_width</code>
| Size of ''logo''
|-
| <code>logo_alt</code>
| [[WP:ALT|Alt text]] for ''logo''
|-
| <code>image</code>
| Restaurant image
|-
| <code>image_width</code>
| Size of ''image''
|-
| <code>image_alt</code>
| [[WP:ALT|Alt text]] for ''image''
|-
| <code>image_caption</code>
| Caption
|-
| <code>pushpin_map</code>
| Name of a [[Template:location map|location map]] (see [[#Map and coordinates]]). Requires {{para|coordinates}} to display a map.
|-
| <code>map_alt</code>
| [[WP:ALT|Alt text]] for the ''pushpin_map''
|-
| <code>map_caption</code>
| Caption for ''pushpin_map''
|-
| <code>map_size</code>
| Size of the ''pushpin_map''
|-
| <code>slogan</code>
| Restaurant's slogan
|-
| <code>established</code>
| When was the restaurant first opened? Use {{Tl|Start date}}
|-
| <code>closed</code>
| When was the restaurant closed? Use {{Tl|End date}}
|-
| <code>current-owner</code>
| Who is the current owner(s)?
|-
| <code>previous-owner</code>
| Who were the previous owner(s)?
|-
| <code>head-chef</code>
| Who is the head chef?
|-
| <code>chef</code>
| (Alternative for head chef) Who is the establishment's chef?
|-
| <code>pastry-chef</code>
| Who is the pastry chef?
|-
| <code>food-type</code>
| Food type of restaurant (French, Italian, etc.)
|-
| <code>dress-code</code>
| Dress code of the restaurant (casual, semi-formal, formal)
|-
| <code>rating</code>
| Rating of the restaurant (Michelin Guide and {{tl|Michelin stars}}, Zagat's Survey, etc.)
|-
| <code>street-address</code>
| Address on which the restaurant is located
|-
| <code>city</code>
| City in which the restaurant is located
|-
| <code>county</code>
| County in which the restaurant is located
|-
| <code>state</code>
| State in which the restaurant is located
|-
| <code>postcode</code>
| Or {{para|zip}} for postal code
|-
| <code>country</code>
| Country the restaurant is located in
|-
| <code>coordinates</code>
| The Geographic coordinates using {{tl|coord}} (see [[#Map and coordinates]])
|-
| <code>seating-capacity</code>
| The [[seating capacity]] of the restaurant
|-
| <code>reservations</code>
| Are reservations required?
|-
| <code>other-locations</code>
| Are there other locations? Is the restaurant franchised?
|-
| <code>other-information</code>
| Or {{para|other-label}} for closings, renovations, etc.  Do not include phone numbers per [[WP:NOTYELLOW]].
|-
| <code>website</code>
| Restaurant's website; use {{Tl|URL}}
|}

== Map and coordinates ==
=== Coordinates ===
Use the {{Para|coordinates}} parameter, with {{Tl|Coord}}, to display the coordinates. It will also allows the display of either an interactive {{tl|Mapframe}} map, or {{tl|Location map}} showing a pushpin for the location of the restaurant.

=== Mapframe maps ===
{{Infobox mapframe/doc/parameters|mapframe-marker=restaurant}}

=== Location maps ===
The <code>pushpin_map=</code> parameter can be used to specify a particular {{tl|location map}}.  Requires {{para|coordinates}}.

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

==TemplateData==
{{cot|TemplateData}}
{{TemplateData header}}
<templatedata>

{
	"params": {
		"embed": {},
		"title": {},
		"name": {},
		"logo": {},
		"logo_width": {},
		"logo_alt": {},
		"image": {},
		"image_width": {},
		"image_alt": {},
		"image_caption": {},
		"pushpin_map": {},
		"coordinates": {},
		"map_alt": {},
		"map_caption": {},
		"map_size": {},
		"slogan": {},
		"established": {},
		"closed": {},
		"current-owner": {},
		"previous-owner": {},
		"head-chef": {},
		"chef": {},
		"pastry-chef": {},
		"food-type": {},
		"dress-code": {},
		"rating": {},
		"street-address": {},
		"city": {},
		"state": {},
		"county": {},
		"postcode": {},
		"zip": {
			"aliases": [
				"postcode",
				"postalcode"
			]
		},
		"country": {},
		"seating-capacity": {},
		"reservations": {},
		"other-locations": {},
		"other-information": {},
		"website": {},
		"other-label": {},
		"mapframe": {
			"label": "Show mapframe map",
			"description": "Specify yes or no to show or hide the map, overriding the default",
			"example": "yes",
			"type": "string",
			"default": "no",
			"suggested": true
		},
		"mapframe-caption": {
			"label": "Mapframe caption",
			"description": "Caption for the map. If mapframe-geomask is set, then the default is \"Location in <<geomask's label>>\"",
			"type": "string"
		},
		"mapframe-custom": {
			"label": "Custom mapframe",
			"description": "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, other mapframe parameters will be ignored.",
			"type": "wiki-template-name"
		},
		"mapframe-id": {
			"aliases": [
				"id",
				"qid"
			],
			"label": "Mapframe Wikidata item",
			"description": "Id (Q-number) of Wikidata item to use.",
			"type": "string",
			"default": "(item for current page)"
		},
		"mapframe-wikidata": {
			"label": "Mapframe shapes from Wikidata",
			"description": "et to yes to show shape/line features from the wikidata item, if any, when coordinates are specified by parameter",
			"example": "yes",
			"type": "string"
		},
		"mapframe-point": {
			"label": "Mapframe point feature",
			"description": "Override display of mapframe point feature. Turn off display of point feature by setting to \"none\". Force point marker to be displayed by setting to \"on\"",
			"type": "string"
		},
		"mapframe-shape": {
			"label": "Mapframe shape feature",
			"description": "Override display of mapframe shape feature. Turn off by setting to \"none\". Use an inverse shape (geomask) instead of a regular shape by setting to \"inverse\"",
			"type": "string"
		},
		"mapframe-frame-width": {
			"aliases": [
				"mapframe-width"
			],
			"label": "Mapframe width",
			"description": "Frame width in pixels",
			"type": "number",
			"default": "270"
		},
		"mapframe-frame-height": {
			"aliases": [
				"mapframe-height"
			],
			"label": "Mapframe height",
			"description": "Frame height in pixels",
			"type": "number",
			"default": "200"
		},
		"mapframe-shape-fill": {
			"label": "Mapframe shape fill",
			"description": "Color used to fill shape features",
			"type": "string",
			"default": "#606060"
		},
		"mapframe-shape-fill-opacity": {
			"label": "Mapframe shape fill opacity",
			"description": "Opacity level of shape fill, a number between 0 and 1",
			"type": "number",
			"default": "0.5"
		},
		"mapframe-stroke-color": {
			"aliases": [
				"mapframe-stroke-colour"
			],
			"label": "Mapframe stroke color",
			"description": "Color of line features, and outlines of shape features",
			"type": "string",
			"default": "#ff0000"
		},
		"mapframe-stroke-width": {
			"label": "Mapframe stroke width",
			"description": "Width of line features, and outlines of shape features",
			"type": "number",
			"default": "5"
		},
		"mapframe-marker": {
			"label": "Mapframe marker",
			"description": "Marker symbol to use for coordinates; see [[mw:Help:Extension:Kartographer/Icons]] for options",
			"example": "museum",
			"type": "string",
			"default": "restaurant"
		},
		"mapframe-marker-color": {
			"aliases": [
				"mapframe-marker-colour"
			],
			"label": "Mapframe marker color",
			"description": "Background color for the marker",
			"type": "string",
			"default": "#5E74F3"
		},
		"mapframe-geomask": {
			"label": "Mapframe geomask",
			"description": "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 country, or P131 for located in the administrative territorial entity)",
			"example": "Q100",
			"type": "wiki-page-name"
		},
		"mapframe-geomask-stroke-color": {
			"aliases": [
				"mapframe-geomask-stroke-colour"
			],
			"label": "Mapframe geomask stroke color",
			"description": "Color of outline of geomask shape",
			"type": "string",
			"default": "#555555"
		},
		"mapframe-geomask-stroke-width": {
			"label": "Mapframe geomask stroke width",
			"description": "Width of outline of geomask shape",
			"type": "number",
			"default": "2"
		},
		"mapframe-geomask-fill": {
			"label": "Mapframe geomask fill",
			"description": "Color used to fill outside geomask features",
			"type": "string",
			"default": "#606060"
		},
		"mapframe-geomask-fill-opacity": {
			"label": "Mapframe geomask fill opacity",
			"description": "Opacity level of fill outside geomask features, a number between 0 and 1",
			"type": "number",
			"default": "0.5"
		},
		"mapframe-zoom": {
			"label": "Mapframe zoom",
			"description": "Set the zoom level, from \"1\" to \"18\", to used if the zoom level cannot be determined automatically from object length or area",
			"example": "12",
			"type": "number",
			"default": "10"
		},
		"mapframe-length_km": {
			"label": "Mapframe length (km)",
			"description": "Object length in kilometres, for automatically determining zoom level. ONLY use ONE of the available parameters for length or area",
			"type": "number"
		},
		"mapframe-length_mi": {
			"label": "Mapframe length (mi)",
			"description": "Object length in miles, for automatically determining zoom level. ONLY use ONE of the available parameters for length or area",
			"type": "number"
		},
		"mapframe-area_km2": {
			"label": "Mapframe area (km^2)",
			"description": "Object arean square kilometres, for automatically determining zoom level. ONLY use ONE of the available parameters for length or area",
			"type": "number"
		},
		"mapframe-area_mi2": {
			"label": "Mapframe area (mi^2)",
			"description": "Object area in square miles, for automatically determining zoom level. ONLY use ONE of the available parameters for length or area",
			"type": "number"
		},
		"mapframe-frame-coordinates": {
			"aliases": [
				"mapframe-frame-coord"
			],
			"label": "Mapframe frame coordinates",
			"description": "Alternate latitude and longitude coordinates for initial placement of map, using {{coord}}",
			"example": "{{Coord|12.35|N|56.71|E}}",
			"type": "wiki-template-name"
		},
		"mapframe-switcher": {
			"label": "Mapframe switcher",
			"description": "Set to \"auto\" or \"geomasks\" or \"zooms\" to enable Template:Switcher-style switching between multiple mapframes. IF SET TO auto – switch geomasks found in location (P276) and located in the administrative territorial entity (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. IF SET TO geomasks – switch between the geomasks specified as a comma-separated list of Wikidata items (Q-numbers) in the mapframe-geomask parameter. IF SET TO zooms – switch between \"zoomed in\"/\"zoomed midway\"/\"zoomed out\", where \"zoomed in\" is the default zoom (with a minimum of 3), \"zoomed out\" is 1, and \"zoomed midway\" is the average.",
			"type": "string"
		},
		"mapframe-coordinates": {
			"aliases": [
				"mapframe-coord",
				"coordinates. coord"
			],
			"label": "Mapframe coordinates ",
			"description": "Coordinates to use, instead of any on Wikidata. Use the {{Coord}} template.",
			"example": "{{Coord|12.34|N|56.78|E}}",
			"type": "wiki-template-name",
			"default": "(coordinates from Wikidata)"
		},
		"postcode-type": {}
	}
}</templatedata>
{{cob}}

== Tracking category ==
* {{clc|Pages using infobox restaurant with unsupported parameters}}

==See also==
* {{tl|Infobox chef}}
{{Buildings and structures infobox templates}}
{{Organization infoboxes}}<includeonly>
{{sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Foodservice infobox templates|Restaurant]]
[[Category:Buildings and structures infobox templates|Restaurant]]
[[Category:Embeddable templates]]
[[Category:Templates that add a tracking category]]
}}</includeonly>