Changes

Jump to navigation Jump to search
486 bytes added ,  10:06, 19 April 2022
Refactor "how" section
Line 1: Line 1:  
[[Category:Folksonomy Engine]]
 
[[Category:Folksonomy Engine]]
 
[[Category:Roadmap]]
 
[[Category:Roadmap]]
The goal of '''Folksonomy engine''' is to unleash an ocean of new usages regarding food knowledge. Folksonomy engine allows all kind of people — citizens, researchers, journalists, professionals, artists, communities, innovators... — to enrich and use Open Food Facts, thanks to '''free tags and properties''' for your own use or to enrich the shared knowledge. Open Food Facts, as the biggest open-food database in the world, already feeds hundreds of data reuses. It will allow thousands of new apps and new usages.
+
 
 +
{{Project|title=Folksonomy Engine|description=The goal of '''Folksonomy engine''' is to unleash an ocean of new usages regarding food knowledge. Folksonomy engine allows all kind of people — citizens, researchers, journalists, professionals, artists, communities, innovators... — to enrich and use Open Food Facts, thanks to '''free properties''' for your own use or to enrich the shared knowledge. Open Food Facts, as the biggest open-food database in the world, already feeds hundreds of data reuses. It will allow thousands of new apps and new usages.|what=<br>
 +
# An [https://api.folksonomy.openfoodfacts.org/docs API] to allow save/retry/modify property/value pairs for each product.<br>
 +
# A user interface to for the end user, integrated to Open Food Facts.|why=unleash new usages with free properties for each product|status=<br>
 +
# [https://api.folksonomy.openfoodfacts.org/docs Folksonomy Engine API] is up and running.<br>
 +
# Folksonomy Engine user interface is currently tested by Open Food Facts administrators. There also a [https://github.com/openfoodfacts/folksonomy_frontend simpler interface] that can be installed as a user script.|needs=<br>
 +
# more use cases to better understand how it will improve Open Food Facts
 +
# dev contributors to improve UI|timeline=<br>
 +
* 2021: project launched
 +
* 2021-10: Folksonomy Engine API works
 +
* 2021-11: Folksonomy Engine UI|people=<br>
 +
* Project owner: Charles Nepote; Lucas Huber at the beginning of the project
 +
* API dev: Christian Quest
 +
* Product Opener integration: Charles Nepote
 +
* With the help of: Stephane, Pierre, Alex, Tacite, ...}}
    
== Documentation and communication ==
 
== Documentation and communication ==
* [https://docs.google.com/document/d/1ADMs4ngCaz0qaw1HGdLCywyuAfB8cxhCfK9yQqI7dao/ Short presentation] (4 pages)
+
* [https://docs.google.com/document/d/1ADMs4ngCaz0qaw1HGdLCywyuAfB8cxhCfK9yQqI7dao/ Short presentation] (4 pages) [old documentation, to be modified]
* https://docs.google.com/document/d/1vYOAXGCatRx_wThW-JvOiM7P6VIIlweXr4uCOAhvEgU/ Folksonomy Whitepaper
   
* Project document Wiki page. (This current document)
 
* Project document Wiki page. (This current document)
   Line 14: Line 27:  
* [https://github.com/openfoodfacts/folksonomy_engine Folksonomy Engine repo]: this repository centralise issues and discussions dedicated to the whole project
 
* [https://github.com/openfoodfacts/folksonomy_engine Folksonomy Engine repo]: this repository centralise issues and discussions dedicated to the whole project
   −
* [https://github.com/openfoodfacts/folksonomy_api Folksonomy Engine API]
+
* [https://github.com/openfoodfacts/folksonomy_api Folksonomy Engine API repo]
* [https://github.com/openfoodfacts/folksonomy_frontend Folksonomy Engine frontend]
+
* [https://github.com/openfoodfacts/folksonomy_frontend Folksonomy Engine frontend repo]
    
Slack channel: [https://app.slack.com/client/T02KVRT1Q/C01M1T2E8L8/thread/C0116U37JCE-1611738330.008000 #folksonomy_engine]
 
Slack channel: [https://app.slack.com/client/T02KVRT1Q/C01M1T2E8L8/thread/C0116U37JCE-1611738330.008000 #folksonomy_engine]
  −
== Who ==
  −
Skills needed (in short)
  −
* Project management
  −
* Dev
  −
  −
Project team:
  −
* Project manager: Lucas
  −
* Project owner: Charles
  −
* End-user tester: ?
  −
* Dev: Stéphane
  −
* Others?
      
== Use cases ==  
 
== Use cases ==  
Line 41: Line 42:     
See, [[Folksonomy Engine/Uses cases|some use cases]] we are starting to investigate.
 
See, [[Folksonomy Engine/Uses cases|some use cases]] we are starting to investigate.
 +
 +
We also have investigated separately [[Folksonomy Engine/Mobile use cases|mobile use cases]], as they allow very different kind of things.
    
== How ==
 
== How ==
    
As of today, Open Food Facts is made of a set of predefined properties (about 20 types of properties such as the product name, the product weight, the ingredients, the nutrients, etc.).
 
As of today, Open Food Facts is made of a set of predefined properties (about 20 types of properties such as the product name, the product weight, the ingredients, the nutrients, etc.).
Folksonomy engine will add several kinds of new individual data properties to Open Food Facts or Open Products Facts. In fact the scope of such new data properties is nearly endless, so we intend to get feedback from the community to define which one we should implement and how the user interface should look like.
+
Folksonomy engine is adding several kinds of new individual data properties to Open Food Facts or Open Products Facts. In fact, the scope of such new data properties is nearly endless, so we intend to get feedback from the community to define which one we should implement and how the user interface should look like.
 
  −
=== Social tagging ===
  −
 
  −
Social tagging can be introduced in different ways. Simpler forms as Hashtags or Text Tags or more complex ones as individual attributes in units.
  −
 
  −
==== Text Tags ====
  −
 
  −
There are many ways to implement social tagging inside of text, as simple plain keywords or more sophisticated forms with colors or different types of tags. The list of tags can be completely free for the user, predefined by admins or curated by admins.
  −
 
  −
==== Individual properties and attributes ====
     −
Properties, or material facts, allowing to specify a value or multiple values for the corresponding product. Eg. it allows adding free properties with values.
+
Properties, or material facts, allows to specify a value or multiple values for the corresponding product.
    
Example: This product height is 35 cm, which ends up in a tag like [height = 35cm].
 
Example: This product height is 35 cm, which ends up in a tag like [height = 35cm].
Line 66: Line 59:  
[Recall: if produced from 2020-03-31 - 2020-04-02]
 
[Recall: if produced from 2020-03-31 - 2020-04-02]
    +
== Wishful deliverables ==
 +
Here we put wishful deliverables if any.
 +
* Tool to monitor tag usages.
 +
* Workshop for contributors.
 +
 +
== Questions/ideas ==
 +
* What about a deliverable dedicated to communication?
 +
* Use case in collaboration with scientists?
 +
 +
== Archives ==
 +
Old timeline.
 
{| class="wikitable"  
 
{| class="wikitable"  
 
|- style="background-color:#c0c0c0;"
 
|- style="background-color:#c0c0c0;"
Line 117: Line 121:  
|  
 
|  
 
|}
 
|}
 
+
[[Category:Project]]
== Wishful deliverables ==
  −
Here we put wishful deliverables if any.
  −
* Tool to monitor tag usages.
  −
* Workshop for contributors.
  −
 
  −
== Questions/ideas ==
  −
* What about a deliverable dedicated to communication?
  −
* Use case in collaboration with scientists?
 

Navigation menu