951
edits
Global taxonomies: Difference between revisions
Refactoring + added undocumented properties (to be continued)
(Building and deploying taxonomies) |
(Refactoring + added undocumented properties (to be continued)) |
||
| Line 12: | Line 12: | ||
== Generalities == | == Generalities == | ||
=== Languages === | === Taxonomy term === | ||
A taxonomy term is the main object of a taxonomy. Its simple form is the term itself with its language as a prefix. Example: <code>en:Authentic Trappist Product</code> is a term in the labels' taxonomy. | |||
==== 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 translation yet. | A value can be defined in another language (which becomes the canonical language), e.g. <code>fr:soupes-a-l-oignon</code> 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 24: | Line 27: | ||
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 ==== | ===== 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. | * 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? === | ===== 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. | 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. | ||
| Line 51: | Line 54: | ||
Simple synonyms (simple singular) are done automatically when possible. | Simple synonyms (simple singular) are done automatically when possible. | ||
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 <code>en:yoghurt</code> is a synonym of <code>en:yogurt</code>, then <code>en:banana_yoghurt</code> will automatically be added as a synonym of <code>en:banana_yogurt</code>. | ||
=== Remarks === | ==== Remarks ==== | ||
* What are the simple synonym rules? How does translate to other languages? | * What are the simple synonym rules? How does translate to other languages? | ||
* Not that recursion does not work for languages, where the adjectives | * Not that recursion does not work for languages, where the adjectives change based on gender. | ||
=== Stopwords === | === Stopwords === | ||
| Line 61: | Line 64: | ||
In the ingredients taxonomy, stopwords are also words that can be ignored. For instance ''contains'' is not an ingredient. | In the ingredients taxonomy, stopwords are also words that can be ignored. For instance ''contains'' is not an ingredient. | ||
=== Description === | |||
The <code>description:</code> prefix allows to describe the term. Example: | |||
en:Fair trade | |||
description:en:Fair trade is an arrangement designed to help producers in developing countries achieve sustainable and equitable trade relationships. Members of the fair trade movement add the payment of higher prices to exporters, as well as improved social and environmental standards. | |||
The description is reused on Open Food Facts website. Example: https://world.openfoodfacts.org/label/fair-trade | |||
=== Image (logo) === | |||
The <code>image:</code> prefix allows to add an image/logo related to the term. | |||
<en:Organic | |||
en:Bio Austria | |||
de:Bio Austria | |||
country:en:Austria | |||
image:en:bio-austria.67x90.svg | |||
The description is reused on Open Food Facts website. Example: https://world.openfoodfacts.org/label/bio-austria | |||
=== Wikidata === | |||
The <code>wikidata:</code> prefix allows to link the term with its equivalent on Wikidata database. Example: | |||
fr:Label Rouge | |||
xx:Label Rouge | |||
wikidata:en:Q3214309 | |||
The description is reused on Open Food Facts website. Example: https://world.openfoodfacts.org/label/label-rouge | |||
=== Opposite === | |||
"we use "opposite" for imports (e.g. when there is a column "Organic" with values like "No") | |||
en:Non-fair trade, Not fair trade | |||
fr:Non issu du commerce équitable | |||
opposite:en: en:fair-trade" | |||
=== Wikipedia === | |||
The <code>wikipedia:</code> prefix allows to link the term with its equivalent on Wikipedia. Example: | |||
<en:Fair trade | |||
en:Fairtrade USA | |||
xx:Fairtrade USA | |||
wikipedia:en:<nowiki>https://en.wikipedia.org/wiki/Fair_Trade_USA</nowiki> | |||
The wikipedia: property is not reused on Open Food Facts website. | |||
=== Unused properties === | |||
Some people have added more properties in the different taxonomies. They are not used for the moment, but they can lead to interesting usages: | |||
* give more information for the contributor who is editing the taxonomy | |||
* prepare new usages or features | |||
Here is a list of properties already used in the taxonomies: | |||
* wikipedia: | |||
* country: | |||
* label_categories: | |||
* eu_groups: | |||
* auth_name: | |||
* auth_address: | |||
* auth_url: | |||
* exceptions: | |||
=== Taxonomy architecture === | === Taxonomy architecture === | ||