Specification - v1.0

OpenMenu Format files should be of the extension .omf

The current OpenMenu Format is under the Specification Section.

Sample XML structure

<omf>
  <omf_version>
    <version>1.0</version>
    <editor>OpenMenu Format Creator</editor>
    <general_info></general_info>
    <date_created></date_created>
  </omf_version>

  <restaurant_info>
    <restaurant_name></restaurant_name>
    <brief_description></brief_description>
    <full_description></full_description>
    <location_id></location_id>
    <logo_url></logo_url>
    <address_1></address_1>
    <address_2></address_2>
    <city_town></city_town>
    <state_province></state_province>
    <postal_code></postal_code>
    <country></country>
    <phone></phone>
    <fax></fax>
    <longitude></longitude>
    <latitude></latitude>
    <website_url></website_url>
    <cuisine_type></cuisine_type>
    <seating_qty></seating_qty>
    <smoking_allowed></smoking_allowed>
    <seating_location></seating_location>
    <dress_code></dress_code>
    <currency_symbol></currency_symbol>
    <contact_info>
      <creator_first_name></creator_first_name>
      <creator_last_name></creator_last_name>
      <creator_email></creator_email>
      <contact_first_name></contact_first_name>
      <contact_last_name></contact_last_name>
      <contact_email></contact_email>
    </contact_info>
    <parent_company>
      <parent_company_name></parent_company_name>
      <parent_company_website></parent_company_website>
      <address_1></address_1>
      <address_2></address_2>
      <city_town></city_town>
      <state_province></state_province>
      <postal_code></postal_code>
      <country></country>
      <phone></phone>
      <fax></fax>
    </parent_company>
  </restaurant_info>

  <menus>
    <menu>
      <menu_duration></menu_duration>
      <menu_groups>
        <menu_group>
          <menu_group_name></menu_group_name>
          <menu_items>
            <menu_item>
              <menu_item_name></menu_item_name>
              <menu_item_description></menu_item_description>
              <menu_item_image_url></menu_item_image_url>
              <menu_item_price></menu_item_price>
              <menu_item_vegetarian></menu_item_vegetarian>
              <menu_item_calories></menu_item_calories>
              <menu_item_allergy_information></menu_item_allergy_information>
              <menu_item_sizes>
                <menu_item_size>
                  <menu_item_size_name></menu_item_size_name>
                  <menu_item_size_description></menu_item_size_description>
                  <menu_item_size_price></menu_item_size_price>
                  <menu_item_size_calories></menu_item_size_calories>
                </menu_item_size>
              </menu_item_sizes>
            </menu_item>
          </menu_items>
        </menu_group>
      </menu_groups>
    </menu>
  </menus>
</omf>

Details of the specification

omf_version

version
the version of the OMF spec that the menu adheres to format: decimal with a . (period) seperator
editor
name of the editor used to create the OMF file format: 0 - 100 characters
general_info
additional information about the spec/version format: 0 - 255 characters
date_created
date the OMF file was created format: yyyymmdd

restaurant_info

restaurant_name
name of the restaurant format: 2 - 255 characters
brief_description
Brief description of the restaurant format: 0 - 255 characters (no HTML allowed)
full_description
Full description of the restaurant format: 0 - 2000 characters (no HTML allowed)
location_id
ID of the restaurant if its a chain or has a parent company (can be blank) format: 0 - 25 characters
logo_url
URL to a 200px x 200px logo file (can be blank) format: URL starting with http:// in GIF|JPG|PNG format
address_1
Primary address of the restaurant format: 2 - 120 characters
address_2
Secondary address of the restaurant (can be blank) format: 0 - 120 characters
city_town
City or town of the restaurant format: 2 - 50 characters
state_province
State or Province of the restaurant (can be blank) format: 2 characters (two-digit code)
postal_code
Postal code of the restaurant (can be blank) format: 0 - 30 characters
country
Country of the restaurant format: 2 characters (iso3166 country code)
phone
Phone of the restaurant (can be blank) format: Numeric with punctuations (allowed: #*()-/_) 7-40 characters
fax
Fax of the restaurant (can be blank) format: Numeric with punctuations (allowed: #*()-/_) 7-40 characters
longitude
Longitude of the restaurant (can be blank). Used for easily locating the restaurant on GPS or other mapping services. format: 0 - 9 characters: (-)nnn.nnnn
latitude
Latitude of the restaurant (can be blank). Used for easily locating the restaurant on GPS or other mapping services. format: 0 - 7 characters: (-)nn.nnnn
website_url
URL to the restaurants website (can be blank) format: 0 - 120 characters starting with http://
cuisine_type
Select from the approved list as to the type of restaurant format: select from American | Afghan | African | Argentinean | Asian/Oriental | Bakery | Barbeque | Brazilian | Brew/Pubs/Microbrewery | Cajun/Creole | California | Caribbean | Chinese | Coffee House | Continental | Cuban | Desserts | Diner | Ethiopian | Family/Homestyle | French/French Bistro | Fusion | German | Greek | Hamburger | Hawaiian | Hot Dog | Indian | International | Irish | Italian | Japanese | Latin | Kosher | Malaysian | Mediterranean | Mexican | Moroccan | Pacific Rim | Pizza | Portuguese | Russian | Sandwiches | Seafood | Soup | Southwest | Southern Cuisine | Spanish | Steakhouse | Sunday Brunch | Sushi | Tapas | Thai | Vegetarian | Vietnamese
seating_qty
How many people can be seated at the restaurant (can be blank) format: numeric
smoking_allowed
Is smoking allowed at the restaurant format: select from 1|0 (1 = true)
seating_location
Can people be seated outside, inside or both format: select from indoor|outdoor|both
dress_code
What is the dress code for the restaurant format: select from none|casual|business-casual|business
currency_symbol
Defines the currency symbol for menu item prices (defaults to $) format: 0 - 2 characters

contact_info

creator_first_name
First name of the person who created the menu specification format: 2 - 25 characters
creator_last_name
Last name of the person who created the menu specification (can be blank) format: 0 - 25 characters
creator_email
Email of the person who created the menu specification (can be blank) format: 0 - 120 characters
contact_first_name
First name of the person who should be contacted about the menu specification format: 2 - 25 characters
contact_last_name
Last name of the person who should be contacted about the menu specification (can be blank) format: 0 - 25 characters
contact_email
Last name of the person who should be contacted about the menu specification format: 6 - 120 characters

parent_company

parent_company_name
description format: 0 - 255 characters
parent_company_website
description format: 0 - 120 characters starting with http://
address_1
Primary address of the parent company format: 2 - 120 characters
address_2
Secondary address of the parent company (can be blank) format: 0 - 120 characters
city_town
City or town of the parent company format: 2 - 50 characters
state_province
State or Province of the parent company (can be blank) format: 2 characters (two-digit code)
postal_code
Postal code of the parent company (can be blank) format: 0 - 30 characters
country
Country of the parent company format: 2 characters (iso3166 country code)
phone
Phone of the parent company (can be blank) format: Numeric with punctuations (allowed: #*()-/_) 7-40 characters
fax
Fax of the parent company (can be blank) format: Numeric with punctuations (allowed: #*()-/_) 7-40 characters

menus (can contain multiple menus)

menu_duration
What time of day is this menu valid for format: select from breakfast | lunch | breakfast-lunch | dinner | lunch-dinner | late-night | all

menu_groups

menu_group_name
Name of the group/section that for these menu items (ex. Appetizers, Soups & Salads, Entrees, Desserts) format: 2 - 50 characters

menu_items

menu_item_name
Name of the menu item format: 2 - 75 characters (no HTML allowed)
menu_item_description
Description for the menu item (can be blank) format: 0 - 450 characters (no HTML allowed)
menu_item_image_url
URL to a 200px x 200px logo file (can be blank) format: URL starting with http:// in GIF|JPG|PNG format
menu_item_price
Price for the menu item (no currency symbol) format: 1 - 7 characters: nnnn.nn (numeric only, period separator for decimals)
menu_item_vegetarian
Sets whether this item is a vegetarian item (default to 0) format: select from 1|0 (1 = true)
menu_item_calories
How many calories for this item format: numeric
menu_item_allergy_information
Any information about allergy warnings for this item format: 0 - 450 characters (no HTML allowed)

menu_item_sizes (optional)

menu_item_size_name
Name for an alternate size for a menu item (small, medium, large, cup, bowl) format: 0 - 25 characters
menu_item_size_description
Description of the alternate size format: 0 - 120 characters
menu_item_size_price
Price for the menu item (no currency symbol) format: 1 - 7 characters: nnnn.nn (numeric only, period separator for decimals)
menu_item_size_calories
How many calories for this item format: numeric

Get a blank OMF file