Changes

Jump to navigation Jump to search
→‎image: specifies that it's not used by the website, and that the file name must match the entry name in the target language
Line 10: Line 10:  
* example: additives_classes:en: en:colour - the additive classes associated to E100
 
* example: additives_classes:en: en:colour - the additive classes associated to E100
 
* usage: [[Additives taxonomy]]
 
* usage: [[Additives taxonomy]]
==== additives_classes ====
+
* Linked taxonomy: https://github.com/openfoodfacts/openfoodfacts-server/blob/main/taxonomies/additives_classes.txt
 +
 
 +
==== agribalyse_food_code ====
 
* example: agribalyse_food_code:en:3000
 
* example: agribalyse_food_code:en:3000
 
* usage [[Categories taxonomy]], [[Minerals taxonomy]]
 
* usage [[Categories taxonomy]], [[Minerals taxonomy]]
Line 26: Line 28:  
* example: allergens:en: en:milk
 
* example: allergens:en: en:milk
 
* usage: [[Ingredients]]
 
* usage: [[Ingredients]]
 +
* linked taxonomy: https://github.com/openfoodfacts/openfoodfacts-server/blob/main/taxonomies/allergens.txt
    
==== carbon_footprint_fr_foodges_ingredient ====
 
==== carbon_footprint_fr_foodges_ingredient ====
Line 69: Line 72:  
A short description of a term. This is usually taken from a standard, wikidata, wiktionary or wikipedia.
 
A short description of a term. This is usually taken from a standard, wikidata, wiktionary or wikipedia.
 
* example: description:en:Acids are substances which increase the acidity of a foodstuff and/or impart a sour taste to it. - which described the term Acid in the Additives Classes taxonomy.
 
* example: description:en:Acids are substances which increase the acidity of a foodstuff and/or impart a sour taste to it. - which described the term Acid in the Additives Classes taxonomy.
* usage: [[Additives Classes taxonomy]], [[Categories taxonomy]], [[Improvements taxonomy]], [[Ingredients taxonomy]], [[Minerals taxonomy]]
+
* usage: [[Additives Classes taxonomy]], [[Categories taxonomy]], [[Improvements taxonomy]], [[Ingredients taxonomy]], [[Minerals taxonomy]], [[Nucleotides taxonomy]], [[Other nutritional substances taxonomy]],
 +
 
 +
==== dv_value ====
 +
* example: dv_value:en: 40
 +
* usage: [[Nutrients taxonomy]]
 +
 
 +
==== dv_2016_value ====
 +
* example: dv_2016_value:en: 20
 +
* usage: [[Nutrients taxonomy]]
    
==== e_number ====
 
==== e_number ====
Line 112: Line 123:  
* example: efsa_evaluation_url:en: http://dx.doi.org/10.2903/j.efsa.2010.1679 - to indicate the documentation for the term E100  
 
* example: efsa_evaluation_url:en: http://dx.doi.org/10.2903/j.efsa.2010.1679 - to indicate the documentation for the term E100  
 
* usage: [[Additives taxonomy]]
 
* usage: [[Additives taxonomy]]
 +
 +
==== evaluation ====
 +
* example: evaluation:en: bad
 +
* usage [[Nutrients taxonomy]]
 +
==== expected_ingredients ====
 +
* example: expected_ingredients:en: en:olive-oil
 +
* usage [[Categories taxonomy]]
 +
* comment:should refer to an existing ingredient
 +
==== expected_nutriscore_grade ====
 +
* example: expected_nutriscore_grade:en: c
 +
* usage: [[Categories taxonomy]]
 +
* comment: to create a data quality error if the nutriscore was different
    
==== from_palm_oil ====
 
==== from_palm_oil ====
Line 117: Line 140:  
* example: from_palm_oil:en:maybe
 
* example: from_palm_oil:en:maybe
 
* usage [[Additives classes]], [[Ingredients taxonomy]]
 
* usage [[Additives classes]], [[Ingredients taxonomy]]
 +
==== gpc_category_code ====
 +
Refers to a category in the gpc (https://gpc-browser.gs1.org)
 +
* example: gpc_category_code:en:18015
 +
* usage [[Categories taxonomy]]
 +
==== gpc_category_name ====
 +
Refers to the english category name in the gpc (https://gpc-browser.gs1.org)
 +
* example: gpc_category_name:en:Tea - Liquid/Ready to Drink
 +
* usage [[Categories taxonomy]]
 +
==== gpc_category_description ====
 +
To indicate whether the term is made from palm oil. Possible values are: no, maybe, yes.
 +
* example: gpc_category_description:en:Definition: Includes any products that can be described/observed as a ready to drink beverage made from the dried leaves of the tea plant, Camellia Sinensis. Includes self-heating products and teas from single tea types such as Assam and Ceylon, and those, which are blends of various teas. Products may also have added flavourings such as lemon and milk or sweeteners. Definition Excludes: Excludes products such as Tea Bags or Loose Tea, Liquid Not Ready to Drink Teas, Teas in Capsules or Pods and Herbal Infusions/Tisanes.
 +
* usage [[Categories taxonomy]]
   −
==== Image ====
+
==== image ====
* ''Image (logo)'' - this allows to add an image/logo related to the term;
+
The website displays images for some taxonomy entries (e.g. labels).
 +
 
 +
The website currently uses the image filenames to make the match between an entry in one language and its associated logo, so the image filename in html/images/lang/[language code]/[tagtype]/ must match the name of the taxonomy entry in that language. e.g. the logo for the "fr: Union Végétarienne Européenne Végétarien" must be named html/images/lang/fr/labels/union-vegetarienne-europeenne-vegetarien.77x90.png (or .svg) (if the width is 77 pixels when the height is 90 px)
 +
 
 +
The image property may be used by other apps to make the match and discover the URL of the associated image.
 +
 
 +
* examples:
 +
** en: too good to go  xx: too good to go  image:en: too-good-to-go.108x90.png
 +
** en: European Vegetarian Union Vegetarian, European Vegetarian Union - Vegetarian, EVU Vegetarian  [..]  fr: Union Végétarienne Européenne Végétarien, Union Végétarienne Européenne - Végétarien, EVU Vegetarian  [..]  image:en: european-vegetarian-union-vegetarian.77x90.png  image:fr: union-vegetarienne-europeenne-vegetarien.77x90.png
 +
* usage Labels taxonomy
 +
 
 +
 
 +
This allows to add an image/logo related to the term.
 +
 
 +
==== iu_value ====
 +
example: iu_value:en: 0.025
 +
usage: [[Nutrients taxonomy]]
    
==== language_code_2 ====
 
==== language_code_2 ====
Line 139: Line 190:  
* example: mandatory_additive_class:en: en:colour
 
* example: mandatory_additive_class:en: en:colour
 
* usage: [[Additives taxonomy]]
 
* usage: [[Additives taxonomy]]
 +
* Linked taxonomy: https://github.com/openfoodfacts/openfoodfacts-server/blob/main/taxonomies/additives_classes.txt
 +
 +
==== non_recyclable_and_non_biodegradable ====
 +
Values: no, maybe, yes
 +
example: non_recyclable_and_non_biodegradable:en:maybe
 +
usage: [[Packaging materials taxonomy]]
    
==== nova ====
 
==== nova ====
Line 144: Line 201:  
* example: nova:en:3
 
* example: nova:en:3
 
* usage: [[Additive classes taxonomy]], [[Categories taxonomy]]
 
* usage: [[Additive classes taxonomy]], [[Categories taxonomy]]
 +
* Linked Taxonomy: https://github.com/openfoodfacts/openfoodfacts-server/blob/main/taxonomies/nova_groups.txt
    
==== opposite ====
 
==== opposite ====
Line 154: Line 212:  
* example: origins:en: en:Finland
 
* example: origins:en: en:Finland
 
* usage: [[Categories taxonomy]]
 
* usage: [[Categories taxonomy]]
 +
* Linked Taxonomy: https://github.com/openfoodfacts/openfoodfacts-server/blob/main/taxonomies/origins.txt
    
==== pnns_group_2 ====
 
==== pnns_group_2 ====
Line 167: Line 226:  
* example: protected_name_type:en: tsg
 
* example: protected_name_type:en: tsg
 
* usage: [[Categories taxonomy]]
 
* usage: [[Categories taxonomy]]
 +
==== recycling_code ====
 +
Values: 1
 +
* example: recycling_code:en:1
 +
* usage: [[Packaging materials taxonomy]]
 +
 +
==== sales_format ====
 +
Values: package, weight, volume, item
 +
* example: sales_format:en: package, weight
 +
* usage: [[Categories taxonomy]]
 +
* default: sales_format:en: package (when the entry is not present)
    
==== show_ingredients ====
 
==== show_ingredients ====
Line 177: Line 246:  
* example: show_on_producers_platform:en:yes
 
* example: show_on_producers_platform:en:yes
 
* usage: [[Data quality taxonomy]]
 
* usage: [[Data quality taxonomy]]
 +
 +
==== unit ====
 +
Default unit to be used. Possible values: g, mg, µg, kj, kcal, %DV.
 +
* example: unit:en: kj
 +
* usage: [[Nutrients taxonomy]]
 +
 +
==== unit_ca ====
 +
Default units to be used in Canada. Possible values: g, mg, µg, kj, kcal, %DV.
 +
* example: unit_ca:en: kcal
 +
* usage: [[Nutrients taxonomy]]
 +
 +
==== unit_us ====
 +
Default units to be used in the USA, Possible values: g, mg, µg, kj, kcal, %DV.
 +
* example: unit_us:en: kcal
 +
* usage: [[Nutrients taxonomy]]
    
==== vegan ====
 
==== vegan ====
 
Indicates whether the associated term is usable for a vegan diet. Values are: no, maybe, yes.
 
Indicates whether the associated term is usable for a vegan diet. Values are: no, maybe, yes.
 
* example: vegan:en:yes
 
* example: vegan:en:yes
* usage: [[Additives taxonomy]], [[Ingredients taxonomy]], [[Minerals taxonomy]]
+
* usage: [[Additives taxonomy]], [[Ingredients taxonomy]], [[Minerals taxonomy]], [[Nucleotides taxonomy]], [[Other nutritional substances taxonomy]],
    
==== vegetarian ====
 
==== vegetarian ====
 
Indicates whether the associated term is usable for a vegetarian diet. Values are: no, maybe, yes.
 
Indicates whether the associated term is usable for a vegetarian diet. Values are: no, maybe, yes.
 
* example: vegetarian:en:maybe
 
* example: vegetarian:en:maybe
* usage: [[Additives taxonomy]], [[Ingredients taxonomy]], [[Minerals taxonomy]]
+
* usage: [[Additives taxonomy]], [[Ingredients taxonomy]], [[Minerals taxonomy]], [[Nucleotides taxonomy]], [[Other nutritional substances taxonomy]]
 +
==== who_id ====
 +
Maps to a world health organisation id?
 +
* example: who_id:en:7
 +
* usage: [[Categories taxonomy]]
    
==== wikidata ====
 
==== wikidata ====
 
A reference to the corresponding entry on [https://www.wikidata.org/ Wikidata].
 
A reference to the corresponding entry on [https://www.wikidata.org/ Wikidata].
 
* Example: wikidata:en:Q5111
 
* Example: wikidata:en:Q5111
* Usage: [[Additives taxonomy]]. [[Allergens taxonomy]], [[Amino acids taxonomy]], [[Categories taxonomy]], [[Ingredients taxonomy]], [[Languages taxonomy]], [[Nucleotides taxonomy]]
+
* Usage: [[Additives taxonomy]]. [[Allergens taxonomy]], [[Amino acids taxonomy]], [[Categories taxonomy]], [[Ingredients taxonomy]], [[Languages taxonomy]], [[Nucleotides taxonomy]], [[Nutrients taxonomy]], [[Origins taxonomy]], [[Other nutritional substances taxonomy]], [[Packaging materials taxonomy]], [[Packaging shapes taxonomy]], [[Vitamins taxonomy]]
    
==== wikipedia ====
 
==== wikipedia ====
 
A link the term with its equivalent on Wikipedia.
 
A link the term with its equivalent on Wikipedia.
 
* example: wikipedia:en:https://en.wikipedia.org/wiki/Glutamine
 
* example: wikipedia:en:https://en.wikipedia.org/wiki/Glutamine
* usage: [[Amino acids taxonomy]], [[Categories taxonomy]], [[Ingredients taxonomy]]
+
* usage: [[Amino acids taxonomy]], [[Categories taxonomy]], [[Ingredients taxonomy]], [[Nucleotides taxonomy]], [[Nutrients taxonomy]], [[Other nutritional substances taxonomy]], [[Vitamins taxonomy]]
    
== Properties suggested ==
 
== Properties suggested ==

Navigation menu