9
edits
Taxonomy editor: Difference between revisions
Add some images of the editor
(Add some images of the editor) |
|||
| Line 48: | Line 48: | ||
* create a new project for taxonomy editing : Start with a currently used taxonomy of your choice and begin editing. | * create a new project for taxonomy editing : Start with a currently used taxonomy of your choice and begin editing. | ||
* open an existing project for taxonomy editing : Continue you editions on a project, or collaborate with others on editing a taxonomy together. | * open an existing project for taxonomy editing : Continue you editions on a project, or collaborate with others on editing a taxonomy together. | ||
[[File:ImageHomePage.png|thumb|alt=|400x400px]] | |||
[[File:ImageHomePage.png|thumb]] | |||
=== Create a new project === | === Create a new project === | ||
| Line 59: | Line 58: | ||
After you project is created, you can edit nodes. But beware, if something wrong happen while importing the taxonomy, you will be notified. You should not attempt to edit a taxonomy with error, but inspect errors instead, and eventually talk with the Open Food Facts team. | After you project is created, you can edit nodes. But beware, if something wrong happen while importing the taxonomy, you will be notified. You should not attempt to edit a taxonomy with error, but inspect errors instead, and eventually talk with the Open Food Facts team. | ||
[[File:Existing projects.png|left|thumb|400x400px|Existing projects page ]] | |||
=== Collaborate with others (or continue editing you project) === | === Collaborate with others (or continue editing you project) === | ||
| Line 69: | Line 70: | ||
* '''''OPEN''''': The project has been created, but no changes have been exported to GitHub yet | * '''''OPEN''''': The project has been created, but no changes have been exported to GitHub yet | ||
* '''''EXPORTED''''': Changes have been exported to GitHub. Normally at this point, the changes are under review by others, and contributions should only concern fixing issues. | * '''''EXPORTED''''': Changes have been exported to GitHub. Normally at this point, the changes are under review by others, and contributions should only concern fixing issues. | ||
* '''''CLOSED''''': The project has been accepted (merged), and further contributions is not possible | * '''''CLOSED''''': The project has been accepted (merged), and further contributions is not possible<br /> | ||
[[File:Nodes page.png|thumb|300x300px|Nodes page : list of root nodes]] | |||
While additional information such as the GitHub branch name and error count encountered by the parser are provided in the table, they are not essential for contributing. | While additional information such as the GitHub branch name and error count encountered by the parser are provided in the table, they are not essential for contributing. | ||
To contribute to a project, simply click on the pencil icon! | To contribute to a project, simply click on the pencil icon! | ||
=== Edit the taxonomy === | === Edit the taxonomy === | ||
First you arrive on a page listing all the root nodes, which are nodes without parents. Most probably you would want to use the search page to search for specific nodes using a simple search query. | First you arrive on a page listing all the root nodes, which are nodes without parents. Most probably you would want to use the search page to search for specific nodes using a simple search query. | ||
As you have a list of nodes, you can choose one of them by clicking on the pencil button. | As you have a list of nodes, you can choose one of them by clicking on the pencil button. | ||
=== Edit a node === | |||
[[File:Edit a node page.png|left|thumb|400x400px|Edit a node]] | |||
=== Edit a node === | |||
Once you've selected the node you wish to edit, you'll be directed to the edit page. | Once you've selected the node you wish to edit, you'll be directed to the edit page. | ||
| Line 92: | Line 94: | ||
Finally, you'll find a list of properties associated with the node. Here, you can edit existing properties, add new ones, or remove unnecessary ones. Property names must be unique and adhere to the format "name:of:the:property:lc" (where "lc" represents the language code). These names should contain only letters and numbers, excluding special characters. | Finally, you'll find a list of properties associated with the node. Here, you can edit existing properties, add new ones, or remove unnecessary ones. Property names must be unique and adhere to the format "name:of:the:property:lc" (where "lc" represents the language code). These names should contain only letters and numbers, excluding special characters. | ||
[[File:Add a node.png|thumb|Add a node to the taxonomy]] | |||
Once you've completed editing the node, remember to save your changes by clicking the blue button; otherwise you would lose your modifications. | Once you've completed editing the node, remember to save your changes by clicking the blue button; otherwise you would lose your modifications. | ||
=== Add a node === | === Add a node === | ||
You can either: | You can either: | ||
| Line 103: | Line 105: | ||
At creation time, you will have to choose a main language code (two letter code) and a name for the node. | At creation time, you will have to choose a main language code (two letter code) and a name for the node. | ||
=== Adding relations === | |||
[[File:Add a children node.png|left|thumb|400x400px|Add children to a node]] | |||
=== Adding relations === | |||
If you want to put a node under a new parent, navigate to the parent node and use the "+" icon next to children, then enter main language code of the entry and it's name. The existing node will be retrieved and put under the parent node. | If you want to put a node under a new parent, navigate to the parent node and use the "+" icon next to children, then enter main language code of the entry and it's name. The existing node will be retrieved and put under the parent node. | ||
=== Publish your contributions === | |||
[[File:Export.png|thumb|400x400px|Export your changes to Github]] | |||
=== Publish your contributions === | |||
Navigate to the export tab in the header bar to export your edited taxonomy. | Navigate to the export tab in the header bar to export your edited taxonomy. | ||