76
edits
Data fields: Difference between revisions
nutrition facts information + reformat titles to be similar to product edition
(Manufacturing or processing places section) |
(nutrition facts information + reformat titles to be similar to product edition) |
||
| Line 6: | Line 6: | ||
# fields that are sometimes computed based on other fields, such as the Nutri-Score, the Nova score, etc. | # fields that are sometimes computed based on other fields, such as the Nutri-Score, the Nova score, etc. | ||
This page deals only with "Fields completed by users". All these fields can entered or modified by hand by the users. | This page deals only with "Fields completed by users". All these fields can be entered or modified by hand by the users. | ||
== Product name == | == Product characteristics == | ||
=== Product name === | |||
The product name is the main name printed on the packaging. It can be a registered trademark such as Nutella. This data is important and useful as it's one of the most used data. | The product name is the main name printed on the packaging. It can be a registered trademark such as Nutella. This data is important and useful as it's one of the most used data. | ||
| Line 22: | Line 23: | ||
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>. | ||
=== Good examples === | ==== Good examples ==== | ||
* <code>Nesquick</code> ([https://world.openfoodfacts.org/product/3033710065967/nesquik-poudre-cacaotee-boite-nestle link]) | * <code>Nesquick</code> ([https://world.openfoodfacts.org/product/3033710065967/nesquik-poudre-cacaotee-boite-nestle link]) | ||
=== Bad examples === | ==== Bad examples ==== | ||
* <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. | * <code>Nesquick®</code> => Don't use symbols ®, ™, © or similar in product name data field or even in other fields. | ||
== Common name == | === Common name === | ||
[[File:Coca-Cola cherry example.jpg|thumb|Example in Coca-Cola Cherry: '''"Sparkling Cherry Flavour Soft Drink with Vegetables Extracts"'''. This info should be in "Common name" filed.]] | [[File:Coca-Cola cherry example.jpg|thumb|Example in Coca-Cola Cherry: '''"Sparkling Cherry Flavour Soft Drink with Vegetables Extracts"'''. This info should be in "Common name" filed.]] | ||
| Line 39: | Line 40: | ||
In the database, the technical name for this field is <code>generic_name</code>. | In the database, the technical name for this field is <code>generic_name</code>. | ||
== Quantity == | === Quantity === | ||
This is the quantity of the product, with the corresponding number of portions or unit. The best way to fill it is to enter the value as indicated on the product. Don't forget the units! If we can deduce the quantity in grams it can be used to calculate some things such as the carbon impact. | This is the quantity of the product, with the corresponding number of portions or unit. The best way to fill it is to enter the value as indicated on the product. Don't forget the units! If we can deduce the quantity in grams it can be used to calculate some things such as the carbon impact. | ||
| Line 56: | Line 57: | ||
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 == | === 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: | 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 substance of the packaging: glass, metal, plastic, etc. | ||
| Line 73: | Line 74: | ||
See [https://github.com/openfoodfacts/openfoodfacts-server/issues?q=is%3Aissue+is%3Aopen+packaging+label%3Apackaging issues related to <code>packaging</code>]. | See [https://github.com/openfoodfacts/openfoodfacts-server/issues?q=is%3Aissue+is%3Aopen+packaging+label%3Apackaging issues related to <code>packaging</code>]. | ||
== Brands == | === 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: | 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 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 | ||
| Line 86: | Line 87: | ||
See: [https://github.com/openfoodfacts/openfoodfacts-server/issues?q=is%3Aissue+is%3Aopen+ingredients+label%3Abrands issues related to <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 == | === Categories === | ||
[to be completed] | [to be completed] | ||
| Line 99: | Line 100: | ||
* [https://github.com/openfoodfacts/openfoodfacts-server/issues?q=is%3Aissue+is%3Aopen+category+label%3Acategories issues related to <code>categories</code>]. | * [https://github.com/openfoodfacts/openfoodfacts-server/issues?q=is%3Aissue+is%3Aopen+category+label%3Acategories issues related to <code>categories</code>]. | ||
== Labels == | === Labels === | ||
[to be completed] | [to be completed] | ||
| Line 112: | Line 113: | ||
* [https://github.com/openfoodfacts/openfoodfacts-server/issues?q=is%3Aissue+is%3Aopen+category+label%3Alabels issues related to <code>labels</code>]. | * [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 == | === Manufacturing or processing places === | ||
[to be completed] | [to be completed] | ||
| Line 129: | Line 130: | ||
In the database, this field is called <code>manufacturing_places</code>; it has a normalized version (small caps, spaces removed) under the name <code>manufacturing_places_tags</code>. | In the database, this field is called <code>manufacturing_places</code>; it has a normalized version (small caps, spaces removed) under the name <code>manufacturing_places_tags</code>. | ||
== EMB code == | === EMB code === | ||
[to be completed] | [to be completed] | ||
| Line 141: | Line 142: | ||
We use it to produce the world map of products: https://cestemballepresdechezvous.fr/ (fr) and https://madenear.me/ (en) [down on 2021-08-19]. | 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 == | === 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. | |||
Be aware that, for the moment, this field is NOT normalized, so it probably contains dates in various formats that can be ambiguous (31/12/2019, 12/31/2019, 13 mai 2018, etc.). Also, the meaning of "best before", "expiry date", "use-by" notions might be different from different countries. You can help us to gather information about it in your own country, participating to the page [[Dates on the products]]. | |||
It is possible to see: | |||
*[https://world.openfoodfacts.org/state/expiration-date-completed how many products do have an expiration date] (a bit more than 10% at the beginning of 2020) | |||
* and [https://world.openfoodfacts.org/state/expiration-date-to-be-completed how many don't] | |||
In the database and in Product Opener software, the technical name for this field is <code>expiration_date</code>. | |||
=== Countries where sold === | |||
This field contains all the countries where the product is widely available (not including stores specialising in foreign products). If the field contains France, the product will be listed on the https://fr.openfoodfacts.org/ website. | This field contains all the countries where the product is widely available (not including stores specialising in foreign products). If the field contains France, the product will be listed on the https://fr.openfoodfacts.org/ website. | ||
| Line 174: | Line 186: | ||
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 185: | Line 197: | ||
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. | ||
| Line 199: | Line 211: | ||
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>]. | ||
== | == Nutrition facts == | ||
== Nutrition facts not specified == | === Nutrition facts not specified === | ||
Sometimes nutrition facts are not specified on the packaging or on a document given with the product. In this case, and only in this case, you have to fill the checkbox called <code>Nutrition facts are not specified on the product</code>. | Sometimes nutrition facts are not specified on the packaging or on a document given with the product. In this case, and only in this case, you have to fill the checkbox called <code>Nutrition facts are not specified on the product</code>. | ||
| Line 217: | Line 220: | ||
In the database, the technical name for this field is <code>no_nutrition_data</code>. | In the database, the technical name for this field is <code>no_nutrition_data</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 228: | Line 231: | ||
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>]. | ||
=== Good examples === | ==== Good examples ==== | ||
* <code>60 g</code> (preferred, for readability reasons) | * <code>60 g</code> (preferred, for readability reasons) | ||
* <code>30g</code> | * <code>30g</code> | ||
| Line 235: | Line 238: | ||
* <code>1L</code> | * <code>1L</code> | ||
=== Possible examples (while not recommended) === | ==== Possible examples (while not recommended) ==== | ||
* <code>cookie 25g</code> | * <code>cookie 25g</code> | ||
* <code>One Slice (50g)</code> | * <code>One Slice (50g)</code> | ||
* <code>97 g (0.5 cup)</code> | * <code>97 g (0.5 cup)</code> | ||
=== Bad examples === | ==== Bad examples ==== | ||
* <code>30 gr</code> => <code>gr</code> is not a correct unit | * <code>30 gr</code> => <code>gr</code> is not a correct unit | ||
* <code>9 candies and 2 biscuits</code> => it's not possible to calculate a ratio because we don't know the weight of this portion | * <code>9 candies and 2 biscuits</code> => it's not possible to calculate a ratio because we don't know the weight of this portion | ||
* <code>30</code> => there is no unit | * <code>30</code> => there is no unit | ||
=== Entering values === | |||
'''Question:''' is there any difference between comma "," and dot "."? (example "2,5" vs "2.5") | |||
'''Answer:''' no | |||
'''Question:''' if the number on the product ends with ".0" ("8.0", for example). Does it make any difference, if we enter "8.0" or "8"? | |||
'''Answer:''' yes | |||
'''Question:''' if the number on the products starts with "<". ("<0.5", for example). Does it make any difference, if we enter "<0.5" or "0.5"? | |||
'''Answer:''' yes | |||