Jump to content

Data fields: Difference between revisions

2,211 bytes added ,  16 March 2020
Substances and traces
(common_name)
(Substances and traces)
Line 9: Line 9:


=== Fields completed by users ===
=== Fields completed by users ===
All these fields can entered or modified by hand by the users.
[to be completed]
[to be completed]


==== Product name ====
==== 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.
If it's not a part of the name, it shouldn't contain the number of portions or a quantity: bad examples are "1 Onglet", "10 Burgers", "1L Sirop cerise"; "100% Cacao", "1848 Lait noisette" (name of a product); it shouldn't contain registered trademark symbols ®, HTML code such as <code>&amp;quot;</code>; it shouldn't be in capital letters except if they are used on the product; it shouldn't contain brands except if it's included in the name ("Kinder Bueno" is good while "Kronembourg 1664", "Stella" or "Vodka Smirnoff" are not); it shouldn't contain price.


At the beginning of 2020, more than 95% of Open Food Facts products have a product name:
At the beginning of 2020, more than 95% of Open Food Facts products have a product name:
Line 26: 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 :)
In the database, the technical name for this field is <code>product_name</code>.




Line 32: Line 37:


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].
In the database, the technical name for this field is <code>generic_name</code>.
==== Quantity ====
This is the quantity of the product, with the corresponding number of portions or unit; example: "230g", "6" (for 6 eggs), etc.
In the database, the technical name for this field is <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>].
==== Substances or products causing allergies or intolerances ====
The substances are ingredients that are actually in the product, which could cause common allergies.
Examples:
* <code>Milk</code>
* <code>Gluten</code>
* <code>Nuts</code>
In the database, this field is an array of tags called <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 ====
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.
Examples:
* <code>Milk</code>
* <code>Gluten</code>
* <code>Nuts</code>
In the database, the technical name for this field is <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>].