Changes

Jump to navigation Jump to search
5,880 bytes added ,  14:21, 23 August 2021
More information on countries.
Line 29: Line 29:  
* <code>Petit déjeuner Nesquick</code> => you don't have to explain, just put the name from the packaging
 
* <code>Petit déjeuner Nesquick</code> => you don't have to explain, just put the name from the packaging
 
* <code>Nutella by Ferrero</code> => you shouldn't fill the brand here, there's a field for that :)
 
* <code>Nutella by Ferrero</code> => you shouldn't fill the brand here, there's a field for that :)
 +
* <code>Nesquick®</code> => Don't use symbols ®, ™, © or similar in product name data field or even in other fields.
    
In the database, the technical name for this field is <code>product_name</code>.
 
In the database, the technical name for this field is <code>product_name</code>.
      
==== Common name ====
 
==== Common name ====
The common name defines the product. It is the name used when you don't want or can't use the product name. This is the place where you say "Cocoa and hazelnuts spreads" instead of "Nutella". This name is very useful for our AI (artificial intelligence): it helps to guess the category of the product.
+
The common name defines the product. It is the name used when you don't want or can't use the product name. This is the place where you say <code>Cocoa and hazelnuts spreads</code> instead of <code>Nutella</code>. This name is very useful for our AI (artificial intelligence): it helps to guess the category of the product.
    
The common name might be equivalent to product category but sometimes not [examples].
 
The common name might be equivalent to product category but sometimes not [examples].
Line 47: Line 47:  
* <code>230 g</code>
 
* <code>230 g</code>
 
* <code>6</code> (for 6 eggs)
 
* <code>6</code> (for 6 eggs)
 +
* <code>3 x 150g</code> (for a product with 3 boxes, each of 150g)
    
A complete wiki page is dedicated to [[products quantities]].
 
A complete wiki page is dedicated to [[products quantities]].
Line 55: Line 56:     
See [https://github.com/openfoodfacts/openfoodfacts-server/issues?q=is%3Aissue+is%3Aopen+quantity+label%3Aquantity issues related to <code>quantity</code>].
 
See [https://github.com/openfoodfacts/openfoodfacts-server/issues?q=is%3Aissue+is%3Aopen+quantity+label%3Aquantity issues related to <code>quantity</code>].
 +
 +
==== Packaging ====
 +
This is the packaging of the product. Multiple values are allowed. There is no taxonomy for this field, so you can enter anything you find relevant including:
 +
* the substance of the packaging: glass, metal, plastic, etc.
 +
* the shape: bottle, can, etc.
 +
 +
You can write it in your own language. Don't hesitate to add as much data as you find relevant.
 +
 +
Two draft taxonomies has been proposed, don't hesitate to comment or help:
 +
* a [[Global_packaging_taxonomy|global taxonomy]]
 +
* and a [[Global_packaging_taxonomy_logos|packaging logos taxonomy]]
 +
 +
In the database, there's two fields related to packaging:
 +
* <code>packaging</code>: the list of values entered in the packaging field; e.g.: <code>Bottle,Glass</code>
 +
* <code>packaging_tags</code>: an array of different packaging tags
 +
 +
See [https://github.com/openfoodfacts/openfoodfacts-server/issues?q=is%3Aissue+is%3Aopen+packaging+label%3Apackaging issues related to <code>packaging</code>].
 +
 +
==== Brands ====
 +
This is the brands of the product. The main brand, generally clearly displayed on the front pack, should be entered first. A product can have other brands:
 +
* when a product is a brand sold by a big company: <code>Actimel</code> is sold by <code>Danone</code>, see https://world.openfoodfacts.org/product/4009700036810/actimel-granatapfel
 +
* when a product is sold with its brand translated in two languages: <code>Nature Valley</code> is sometimes written <code>Val Nature</code>; see  https://world.openfoodfacts.org/product/0065633280267/barre-granola-erable-et-cassonade-nature-valley
 +
 +
There's no taxonomy for brands for the moment, so just do your best and don't waste too much time to enter brands.
 +
 +
A complete wiki page is dedicated to [[brands]].
 +
 +
In the database, this field is called <code>brands</code>.
 +
 +
See: [https://github.com/openfoodfacts/openfoodfacts-server/issues?q=is%3Aissue+is%3Aopen+ingredients+label%3Abrands issues related to <code>brands</code>].
 +
 +
==== Categories ====
 +
[to be completed]
 +
 +
This field list the specific [[Global_categories_taxonomy|category]] of a product and its related parents. '''This field is very important''': it needs to be completed for Nutri-Score computation, as this computation makes differences between types of products (beverages, ...).
 +
 +
→ Indicate only the most specific category. "Parents" categories will be automatically added.
 +
 +
Examples: <code>Sardines in olive oil</code>, <code>Orange juice from concentrate</code>
 +
 +
See also:
 +
* [https://github.com/openfoodfacts/openfoodfacts-server/blob/master/taxonomies/categories.txt our categories taxonomy on our repository].
 +
* [https://github.com/openfoodfacts/openfoodfacts-server/issues?q=is%3Aissue+is%3Aopen+category+label%3Acategories issues related to <code>categories</code>].
 +
 +
==== Labels ====
 +
[to be completed]
 +
 +
"[[Labels]], certifications, awards" on the website.
 +
 +
Example: Organic.
 +
 +
See the [[Labels]] page for more informations.
 +
 +
See also:
 +
* [https://github.com/openfoodfacts/openfoodfacts-server/blob/master/taxonomies/labels.txt our labels taxonomy on our repository].
 +
* [https://github.com/openfoodfacts/openfoodfacts-server/issues?q=is%3Aissue+is%3Aopen+category+label%3Alabels issues related to <code>labels</code>].
 +
 +
==== Manufacturing or processing places ====
 +
[to be completed]
 +
 +
This field lists the places where the product has been manufactured or processed.
 +
 +
==== EMB code ====
 +
[to be completed]
 +
 +
This field is dedicated for various codes related to packaging marks, identification marks or health marks:
 +
 +
* [https://en.wikipedia.org/wiki/EC_identification_and_health_marks EC identification and health marks] in use in the European Community to identify food producers or food packagers. Example: <code>FR 72.264.002 CE</code>.
 +
* [https://fr.wikipedia.org/wiki/EMB_(code) EMB codes] (fr): packaging codes in use in France. Example: <code>EMB 72264</code>.
 +
 +
Open Food Facts gathered [https://world.openfoodfacts.org/packager-codes 25,000+ codes] as of 2021-08-18. These codes allow to localize the places on a map: https://world.openfoodfacts.org/packager-code/fr-72-264-002-ce
 +
 +
We use it to produce the world map of products: https://cestemballepresdechezvous.fr/ (fr) and https://madenear.me/ (en) [down on 2021-08-19].
 +
 +
==== '''Countries where sold''' ====
 +
This field contains all the countries where the product is sold. If the field contains France, the product will be listed on the https://fr.openfoodfacts.org/ website.
 +
 +
The list of all existing countries can be found here: https://world.openfoodfacts.org/countries
 +
 +
In 2021, the [https://en.wikipedia.org/wiki/List_of_sovereign_states United Nation recognize 193 countries] but Open Food Facts also recognize other territories, such as overseas regions/territories such as French Guiana, Guadeloupe, French Polynesia, etc. This field is taxonomized ([https://github.com/openfoodfacts/openfoodfacts-server/blob/main/taxonomies/countries.txt source code]). Though, Open Food Facts accepts all values and some people or some bogus tools enter other values, which leads to have bad values.
 +
 +
In the database, this field is called <code>countries</code>. This field allows to compute the <code>countries_tags</code> field, the normalized version of countries, which allows to show the name of a country in the desired language, thanks to countries taxonomy. Eg: when <code>Italy</code> is entered from a page in english (say,  world.openfoodfacts.org), <code>countries_tags</code> becomes <code>en:italy</code>.
    
==== Ingredients ====
 
==== Ingredients ====
Line 70: Line 153:     
See [https://github.com/openfoodfacts/openfoodfacts-server/issues?q=is%3Aissue+is%3Aopen+ingredients+label%3Aingredients issues related to <code>ingredients</code>].
 
See [https://github.com/openfoodfacts/openfoodfacts-server/issues?q=is%3Aissue+is%3Aopen+ingredients+label%3Aingredients issues related to <code>ingredients</code>].
  −
   
==== Substances or products causing allergies or intolerances ====
 
==== Substances or products causing allergies or intolerances ====
 
The substances are ingredients that are actually in the product, which could cause common allergies. This field can be filled by hand, but is also completed by automatic ingredients analysis.
 
The substances are ingredients that are actually in the product, which could cause common allergies. This field can be filled by hand, but is also completed by automatic ingredients analysis.
Line 83: Line 164:     
See [https://github.com/openfoodfacts/openfoodfacts-server/issues?q=is%3Aissue+is%3Aopen+traces+label%3Aallergens issues related to <code>allergens_tags</code>].
 
See [https://github.com/openfoodfacts/openfoodfacts-server/issues?q=is%3Aissue+is%3Aopen+traces+label%3Aallergens issues related to <code>allergens_tags</code>].
  −
   
==== Traces ====
 
==== Traces ====
 
The traces are ingredients which are not used for the product itself but lay in the factory or the production process: the product might contains traces of these ingredients. Traces are really important if you are allergic.
 
The traces are ingredients which are not used for the product itself but lay in the factory or the production process: the product might contains traces of these ingredients. Traces are really important if you are allergic.
 +
 
This field can be filled by hand, but is also completed by automatic ingredients analysis.
 
This field can be filled by hand, but is also completed by automatic ingredients analysis.
   Line 97: Line 177:     
See [https://github.com/openfoodfacts/openfoodfacts-server/issues?q=is%3Aissue+is%3Aopen+traces+label%3Atraces issues related to <code>traces</code>].
 
See [https://github.com/openfoodfacts/openfoodfacts-server/issues?q=is%3Aissue+is%3Aopen+traces+label%3Atraces issues related to <code>traces</code>].
  −
   
==== Best before date (expiration date) ====
 
==== Best before date (expiration date) ====
 
The expiration date is a way to track product changes over time and to identify the most recent version. It's a data for manual usages. At this moment (2020-03), Open Food Facts apps and website don't make any usage of this field. An issue is open to [https://github.com/openfoodfacts/openfoodfacts-server/issues/76 throw off very old products in averages], it could be useful for it.
 
The expiration date is a way to track product changes over time and to identify the most recent version. It's a data for manual usages. At this moment (2020-03), Open Food Facts apps and website don't make any usage of this field. An issue is open to [https://github.com/openfoodfacts/openfoodfacts-server/issues/76 throw off very old products in averages], it could be useful for it.
Line 109: Line 187:     
In the database and in Product Opener software, the technical name for this field is <code>expiration_date</code>.
 
In the database and in Product Opener software, the technical name for this field is <code>expiration_date</code>.
  −
   
==== Serving size ====
 
==== Serving size ====
 
Serving size has a specific goal: to let Open Food Facts app make a proportional calculation of each nutrient per serving size. If a candy's weight is 5 g, it can be chosen as the serving size: if these candies has 66 g of sugar per 100 g, it has about 3 g per candy. [https://github.com/openfoodfacts/openfoodfacts-server/blob/f25308b7d47255be83210f699f897cba87c9517f/lib/ProductOpener/Food.pm#L3835 Allowed units] are: <code>kg, g, mg, µg, oz, l, dl, cl, ml, fl.oz, fl oz, г, мг, кг, л, дл, кл, мл, 毫克, 公斤, 毫升, 公升, 吨</code>.
 
Serving size has a specific goal: to let Open Food Facts app make a proportional calculation of each nutrient per serving size. If a candy's weight is 5 g, it can be chosen as the serving size: if these candies has 66 g of sugar per 100 g, it has about 3 g per candy. [https://github.com/openfoodfacts/openfoodfacts-server/blob/f25308b7d47255be83210f699f897cba87c9517f/lib/ProductOpener/Food.pm#L3835 Allowed units] are: <code>kg, g, mg, µg, oz, l, dl, cl, ml, fl.oz, fl oz, г, мг, кг, л, дл, кл, мл, 毫克, 公斤, 毫升, 公升, 吨</code>.
Line 135: Line 211:  
* <code>30</code> => there is no unit
 
* <code>30</code> => there is no unit
   −
In the database and in Product Opener software, the technical name for this field is <code>serving_size</code>.
+
In the database and in Product Opener software, the technical name for this field is <code>serving_size</code>. Based on <code>serving_size</code>, Open Food Facts computes a <code>serving_quantity</code> float number for 100g or 100ml. The <code>serving_quantity</code> can be found in the API or the data exports.
    
See [https://github.com/openfoodfacts/openfoodfacts-server/issues?q=is%3Aissue+is%3Aopen+serving+label%3Aportions issues related to <code>serving_size</code>].
 
See [https://github.com/openfoodfacts/openfoodfacts-server/issues?q=is%3Aissue+is%3Aopen+serving+label%3Aportions issues related to <code>serving_size</code>].

Navigation menu