Changes

Jump to navigation Jump to search
3,668 bytes added ,  18:17, 11 June 2020
Building and deploying taxonomies
Line 1: Line 1:  
[[Category:Global Taxonomies]]
 
[[Category:Global Taxonomies]]
   −
== Introduction ==
+
'''Open Food Facts''' uses '''global taxonomies''' for fields such as '''categories''', '''brands''', '''labels''' and '''countries'''. This page explains how taxonomies work in Open Food Facts and how they can be updated and enhanced.
 
  −
Open Food Facts uses global taxonomies for fields such as categories, brands, labels and countries. This page explains how taxonomies work in Open Food Facts and how they can be updated and enhanced.
      
== Features ==
 
== Features ==
Line 14: Line 12:  
== Generalities ==
 
== Generalities ==
    +
=== Languages ===
 
Each language has a 2-letter prefix. e.g. "en" for English and "fr" for French.
 
Each language has a 2-letter prefix. e.g. "en" for English and "fr" for French.
    
Whenever possible, the canonical language for each field value should be English. e.g. en:soups is the canonical value for the Soups category.
 
Whenever possible, the canonical language for each field value should be English. e.g. en:soups is the canonical value for the Soups category.
A value can be defined in another language (which becomes the canonical language), e.g. fr:soupes-a-l-oignon could be the canonical value for "Onion Soups" if we don't have an English tranlsation yet. Before December 2013, the taxonomies were defined for each language, with most definitions for French, but English translations will be added progressively.
+
A value can be defined in another language (which becomes the canonical language), e.g. fr:soupes-a-l-oignon could be the canonical value for "Onion Soups" if we don't have an English translation yet.
    
New values (e.g. categories that do not exist yet) should have an English canonical value.
 
New values (e.g. categories that do not exist yet) should have an English canonical value.
Line 25: Line 24:  
When a field value needs to be translated to a target language, if the translation does not exist yet, English is shown (or the canonical language if the English translation does not exist either).
 
When a field value needs to be translated to a target language, if the translation does not exist yet, English is shown (or the canonical language if the English translation does not exist either).
    +
==== Remarks ====
 +
* Which standard is used for the codes?  It can be the [https://en.wikipedia.org/wiki/ISO_639-1 ISO-639-1] standard, eventually this can be extended the 3-letter codes.
 +
 +
=== Singular or plural? ===
 +
Generally, we use the plural for categories but some of them are in singular. We don't put the plural form when it has a different meaning. For example Beef and Beefs. We are talking of the meat and not the animal, so there is no "s". But "Rillettes" in french (and others languages) doesn't have a singular form.
 +
 +
Sometimes plural or singular depends on the language. The situation for dutch is described in [[Dutch translation issues]].
 +
 +
If the category is in plural form, the translations should be in the plural form.
 +
 +
<pre>
 +
@stephane new proposal (not yet adopted, to be discussed)
 +
In the categories taxonomy, always use the plural (en:beers, fr:bières).
 +
Then add the singular (especially if it's not a simple rule like removing the final s) in a property:
 +
singular:en:beer
 +
singular:fr:bière
 +
For the ingredients taxonomy, do the reverse:
 +
always use the singular for the main entry, and then add the plural:
 +
en:tomato
 +
plural:en:tomatoes
 +
</pre>
 +
 +
=== Synonyms ===
 
In each language, each value can have a number of synonyms.
 
In each language, each value can have a number of synonyms.
   Line 31: Line 53:  
Synonyms are recursive: if en:yoghurt is a synonym of en:yogurt, then en:banana_yoghurt will automatically be added as a synonym of en:banana_yogurt
 
Synonyms are recursive: if en:yoghurt is a synonym of en:yogurt, then en:banana_yoghurt will automatically be added as a synonym of en:banana_yogurt
    +
=== Remarks ===
 +
* What are the simple synonym rules? How does translate to other languages?
 +
* Not that recursion does not work for languages, where the adjectives changes based on gender.
 +
 +
=== Stopwords ===
 
Stopwords can be used to further extend synonyms. e.g. if "à" and "la" are stopwords for French, then "Yaourts fraise" will automatically be mapped to "Yaourts à la fraise".
 
Stopwords can be used to further extend synonyms. e.g. if "à" and "la" are stopwords for French, then "Yaourts fraise" will automatically be mapped to "Yaourts à la fraise".
    +
In the ingredients taxonomy, stopwords are also words that can be ignored. For instance ''contains'' is not an ingredient.
 +
 +
=== Taxonomy architecture ===
 
The taxonomy is not a strict hierarchy: values can have multiple parents. But cycles are not allowed.
 
The taxonomy is not a strict hierarchy: values can have multiple parents. But cycles are not allowed.
   Line 69: Line 99:  
</pre>
 
</pre>
   −
== Taxonomies ==
+
== List of taxonomies ==
   −
The definitions can be edited on this wiki, they are periodically synchronized on the Open Food Facts database and web site.
+
The definitions can be edited on [https://github.com/openfoodfacts/openfoodfacts-server/tree/master/taxonomies GitHub], they are periodically synchronized on the Open Food Facts database and web site.
    
=== Taxonomies ===
 
=== Taxonomies ===
 
+
'''(on Github, account and VCS knowledge needed)'''
* [[Test taxonomy]] showing the basic taxonomy definition features
+
* [https://github.com/openfoodfacts/openfoodfacts-server/blob/master/taxonomies/test.txt Test taxonomy] showing the basic taxonomy definition features
* [[Global categories taxonomy]]
+
* [https://github.com/openfoodfacts/openfoodfacts-server/blob/master/taxonomies/ingredients.txt Ingredients taxonomy]
 +
* [https://github.com/openfoodfacts/openfoodfacts-server/blob/master/taxonomies/categories.txt Global categories taxonomy]
 
* [[Global brands and companies taxonomy]]
 
* [[Global brands and companies taxonomy]]
* [[Global labels taxonomy]]
+
* [https://github.com/openfoodfacts/openfoodfacts-server/blob/master/taxonomies/labels.txt Global labels taxonomy]
 
* [[Global labels taxonomy logos]]
 
* [[Global labels taxonomy logos]]
* [[Global languages taxonomy]]
+
* [https://github.com/openfoodfacts/openfoodfacts-server/blob/master/taxonomies/languages.txt Global languages taxonomy]
* [[Global countries taxonomy]]
+
* [https://github.com/openfoodfacts/openfoodfacts-server/blob/master/taxonomies/countries.txt Global countries taxonomy]
 
* [[Global origins taxonomy]]
 
* [[Global origins taxonomy]]
* [[Global additives taxonomy]]
+
* [https://github.com/openfoodfacts/openfoodfacts-server/blob/master/taxonomies/additives.txt Global additives taxonomy]
* [[Global allergens taxonomy]]
+
* [https://github.com/openfoodfacts/openfoodfacts-server/blob/master/taxonomies/additives_classes.txt Global additives classes taxonomy]
* [[Global traces taxonomy]]
+
* [https://github.com/openfoodfacts/openfoodfacts-server/blob/master/taxonomies/vitamins.txt Global vitamins taxonomy]
* [[Global states taxonomy]]
+
* [https://github.com/openfoodfacts/openfoodfacts-server/blob/master/taxonomies/minerals.txt Global minerals taxonomy]
 +
* [https://github.com/openfoodfacts/openfoodfacts-server/blob/master/taxonomies/amino_acids.txt Global amino acids taxonomy]
 +
* [https://github.com/openfoodfacts/openfoodfacts-server/blob/master/taxonomies/nucleotides.txt Global nucleotides taxonomy]
 +
* [https://github.com/openfoodfacts/openfoodfacts-server/blob/master/taxonomies/other_nutritional_substances.txt Global other nutritional substances taxonomy]
 +
* [https://github.com/openfoodfacts/openfoodfacts-server/blob/master/taxonomies/allergens.txt Global allergens taxonomy]
 +
* [https://github.com/openfoodfacts/openfoodfacts-server/blob/master/taxonomies/states.txt Global states taxonomy]
 +
* [https://github.com/openfoodfacts/openfoodfacts-server/blob/master/taxonomies/nova_groups.txt Global NOVA groups taxonomy]
    
=== Draft Taxonomies ===
 
=== Draft Taxonomies ===
 
* [[Global packaging taxonomy]]
 
* [[Global packaging taxonomy]]
 +
* [[Global stores taxonomy]]
 
* [[Global Religious Certification taxonomy]]
 
* [[Global Religious Certification taxonomy]]
* [[Food Preparation taxonomy]] (related to [[Project:Microwave]])
+
* [[Global Food Preparation taxonomy]] (related to [[Project:Microwave]])
 
* [[Global IGP taxonomy]]
 
* [[Global IGP taxonomy]]
 
* [[Global EC marks taxonomy]]
 
* [[Global EC marks taxonomy]]
 +
 +
== Building and deploying taxonomies ==
 +
 +
Changes to taxonomies on GitHub are not deployed instantly, the need to be built, deployed, and products need to be re-processed with the new taxonomy.
 +
 +
* [[How to build and deploy taxonomies]]
 +
 +
== More info ==
 +
For detailed information specific for the ingredients taxonomy see [[Project:Ingredients ontology|Ingredients Ontology]].

Navigation menu