Nutrtionmaps v0.3 XML format - Protocol Overview
Jump to:
Get Started
Entity escaping
This document describes the XML schema for the Nutrtionmap protocols for packaged food items and restaurant food items.
The Nutritionmap protocol format consists of XML tags. All data values in a Nutritionmap must be entity-escaped. The file itself must be UTF-8 encoded.
The Nutritionmap must:
- Begin with an opening
<nutritionmap>tag and end with a closing</nutritionmap>tag. - Specify the name of the restaurant or packaged food (protocol standard) within the
<restaurant>or<foodbrand>tag. - Include at least one
<item>entry for the menu tag in restuarant maps and one<packageditem>entry for the packaged food maps. - Include at least one child entry for each
<nutrition>parent tag in all maps.
Most other tags are optional. However, we encourage you to provide as much nutritional information as possible to make your map as useful as it can be.
All URLs inside of a Nutritionmap must be from one domain. I.E. www.examplesite.com or menu.examplesite.com but not both.
Sample XML Nutritionmaps
Click here to see a sample Nutritionmap for a restaurant with one menu item that includes pricing, nutrition information and ingredients.
Click here to see a sample Nutritionmap for a food brand with one food item that includes pricing, nutrition information, cooking instructions, expiration date, and ingredients.
Get Started
To get started with making your Nutritionmap using the Nutritionmaps.org system view the current protocol standards for each type. Currently we only support Retaurant made food and packaged food items.
Packaged Food Items Protocol Get started with your packaged food items Nutritionmap.
Restaurant Menu Items Protocol Get started with your restaurant items Nutritionmap.
Entity escaping
It is required that your Nutritionmap file be UTF-8 encoded.
Just like any other XML file, all of your data values must use entity escape codes for the following characters: Ampersand, Quotes, Double Quotes, Greater Than, Less Than. This includes URLs
Last Updated: 12 May 2012
Nutritionmaps.org is the sole copyright and ownership of creator Joe Youngblood. To reach out about licensing the language for usage in your commercial food manufacturing, fresh food preparation, restaurant food preparation, or other food or nutrition application please CLICK HERE TO GET IN TOUCH