Outils pour utilisateurs
ontome:index
Différences
Ci-dessous, les différences entre deux révisions de la page.
| Les deux révisions précédentes Révision précédente Prochaine révision | Révision précédente Prochaine révision Les deux révisions suivantes | ||
|
ontome:index [2020/10/21 19:03] Vincent Alamercery |
ontome:index [2021/04/19 14:49] Vincent Alamercery |
||
|---|---|---|---|
| Ligne 1: | Ligne 1: | ||
| ========= OntoME wiki ========= | ========= OntoME wiki ========= | ||
| - | **https://ontome.dataforhistory.org/** | + | **https://ontome.net/** |
| ======== User guide ======== | ======== User guide ======== | ||
| Ligne 25: | Ligne 25: | ||
| You can access other classes and properties from the namespaces menu but if you want to display them in your lists or create you own classes and properties you need to create an account. | You can access other classes and properties from the namespaces menu but if you want to display them in your lists or create you own classes and properties you need to create an account. | ||
| + | |||
| + | ===== How to? ===== | ||
| + | |||
| + | * [[ontome:index#create_an_account|Create an account]] | ||
| + | * [[ontome:index#create_a_new_project|Create a project]] | ||
| + | * Create a profile | ||
| + | * [[ontome:index#create_a_new_namespace|Create a namespace]] | ||
| + | * [[ontome:index#add_a_new_class|Add a class]] | ||
| + | * [[ontome:index#add_a_new_property|Add a property]] | ||
| ====== Manage your account ====== | ====== Manage your account ====== | ||
| Ligne 32: | Ligne 41: | ||
| * Click on the LOGIN button in the top right corner. | * Click on the LOGIN button in the top right corner. | ||
| * On the LOGIN page, click on "Register". | * On the LOGIN page, click on "Register". | ||
| - | * Fill the form and accept the terms and conditions of use. | + | * Fill the form and accept [[http://ontome.net/terms-of-service|the terms and conditions of use]]. |
| You are automatically logged in after creating your account. | You are automatically logged in after creating your account. | ||
| Ligne 59: | Ligne 68: | ||
| ==== My projects tab ==== | ==== My projects tab ==== | ||
| - | This tab lists the projects you have created or of which you are a member.\\ | + | This tab lists the [[ontome:index#what_is_a_project|projects]] you have created or of which you are a member.\\ |
| By default you're a member of the Public Project which displays the classes and properties of the CIDOC CRM and its extensions. | By default you're a member of the Public Project which displays the classes and properties of the CIDOC CRM and its extensions. | ||
| - | Here you can activate the project you want to work on. The current active project is displayed at the top right of the screen.\\ | + | === Create a new project === |
| - | Activating a project allows you to automatically select namespaces associated with that project. You can only create classes, properties and relations or modify those that exist in the ongoing namespace managed by the project you have activated. | + | |
| + | Click on "Create" to create a new project.\\ | ||
| + | Once a project is created, it is automatically activated. As no namespace is associated with this new project, the list of classes and properties and the class tree will appear empty.\\ | ||
| + | Manage the namespaces you wish to display in relation to your project in the [[ontome:index#my_current_namespaces_tab|My current namespaces]] tab. | ||
| + | |||
| + | === Activate a project === | ||
| + | |||
| + | Activating a project allows you to automatically select namespaces associated with that project. You can only create classes, properties and relations or modify those that exist in the ongoing namespace managed by the project you have activated.\\ | ||
| + | The current active project is displayed at the top right of the screen. | ||
| ==== My current namespaces tab ==== | ==== My current namespaces tab ==== | ||
| Ligne 248: | Ligne 266: | ||
| * Filter this list by using the Search box at the top right. | * Filter this list by using the Search box at the top right. | ||
| * Adjust the number of lines displayed by using the drop-down menu at the top left. | * Adjust the number of lines displayed by using the drop-down menu at the top left. | ||
| + | |||
| ==== Hierarchy tab ==== | ==== Hierarchy tab ==== | ||
| Ligne 288: | Ligne 307: | ||
| ===== Namespace ===== | ===== Namespace ===== | ||
| - | ==== Summary tab ==== | + | ==== What is a namespace? ==== |
| [...] | [...] | ||
| + | |||
| + | ==== Summary tab ==== | ||
| + | |||
| + | This tab presents all the information about the namespace in a compact display. | ||
| ==== Identification tab ==== | ==== Identification tab ==== | ||
| - | [...] | + | This tab gathers the information allowing the identification of the namespace:\\ |
| + | |||
| + | * Identification: this part displays the root namespace URI, its project of belonging and its status (ongoing, published or deprecated). | ||
| + | * Namespaces to which this ongoing namespace refers: the list of reference namespaces of the namespace. A reference namespace is a namespace referenced by another namespace, for instance in the case of a relationship (property, hierarchical relation, other type of relation...). So, if you want to create a relationship between classes and properties in your namespace A to classes and properties in another namespace B, you must first indicate here that the namespace B is a reference namespace to your space A. | ||
| + | * Labels: the list of namespace labels. | ||
| ==== Definition tab ==== | ==== Definition tab ==== | ||
| - | [...] | + | This tab gathers the information to define a namespace: |
| - | ==== Hierarchy tab ==== | + | * Description: the list of texts presenting the namespace in the different languages. A namespace must have at least one description in any language. |
| + | * Contributors [only for ongoing/published namespaces]: contributors to the namespace. This is a free-text field. | ||
| + | * Additional notes: the list of additional notes in the different languages. These notes, which are not mandatory, are used to specify the description. | ||
| - | [...] | + | ==== Versions tab ==== |
| + | |||
| + | * For a root namespace, this tab lists the versions of the namespace. The ongoing namespace row appears in green if you have edit rights. The column "Current namespace" indicates wether the namespace is selected in the tab "[[ontome:index#my_current_namespaces_tab|My current namespace]]" in your dashboard.\\ | ||
| + | * For an ongoing/published/deprecated namespace, this tab only displays the root namespace. | ||
| ==== Classes tab ==== | ==== Classes tab ==== | ||
| - | [...] | + | Only for an ongoing/published/deprecated namespace. |
| + | |||
| + | This tab lists the classes in the namespace. For an ongoing namespace, the column "Validation status" indicates the class status (candidate/validation request/validated/denied). | ||
| ==== Properties tab ==== | ==== Properties tab ==== | ||
| - | [...] | + | Only for an ongoing/published/deprecated namespace. |
| + | |||
| + | This tab lists the properties in the namespace. For an ongoing namespace, the column "Validation status" indicates the class status (candidate/validation request/validated/denied). | ||
| + | |||
| + | ==== Relations tab ==== | ||
| + | |||
| + | Only for an ongoing/published/deprecated namespace. | ||
| + | |||
| + | This tab lists the relations in the namespace. You can filter the display by relations type. | ||
| ==== Graph tab ==== | ==== Graph tab ==== | ||
| - | [...] | + | Only for an ongoing/published/deprecated namespace. |
| + | |||
| + | This tab displays the namespace graph dynamically. | ||
| + | |||
| + | ==== Comments tab ==== | ||
| + | |||
| + | This tab lists the general comments posted on the namespace. If you created an account, you can also post a new comment or reply to an existing one. | ||
| ===== Project ===== | ===== Project ===== | ||
| + | |||
| + | ==== What is a project? ==== | ||
| + | |||
| + | A "project" is a set that will allow you to create a namespace, one or more profiles and associate users (members) with different rights.\\ | ||
| + | A project also allows you to configure the view and namespaces you wish to display in the application.\\ | ||
| + | You can be a member of several projects, but you can only activate one project at a time to delimit the namespaces you wish to work on in each case. | ||
| + | |||
| + | ==== Summary tab ==== | ||
| + | |||
| + | This tab presents all the information about the project in a compact display. | ||
| + | |||
| + | ==== Identification tab ==== | ||
| + | |||
| + | This tab gathers the information allowing the identification of the project:\\ | ||
| + | |||
| + | * Labels: the list of project labels in the different languages. There can only be one standard label per language. A project must have at least one standard label in any language. | ||
| + | |||
| + | ==== Definition tab ==== | ||
| + | |||
| + | This tab gathers the information to define a class:\\ | ||
| + | |||
| + | * Description: the list of texts presenting the project in the different languages. A project must have at least one description in any language | ||
| + | * Additional notes: the list of additional notes in the different languages. These notes, which are not mandatory, are used to specify the description. | ||
| + | |||
| + | ==== Hierarchy tab ==== | ||
| + | |||
| + | This tab lists the hierarchical relations of the project.\\ | ||
| + | A master project may have one or more subprojects linked to it. A subproject cannot have a subproject in turn. | ||
| + | |||
| + | ==== Namespaces tab ==== | ||
| + | |||
| + | This tab lists the versions of the root namespace - if it exists - managed by the project. A project can only manage one root namespace.\\ | ||
| + | |||
| + | * Root namespace: link to the root namespace managed by the project. | ||
| + | * Versions of this namespace: the list of the different versions of the root namespace. At least the ongoing version. | ||
| + | |||
| + | If the project does not manage any namespaces, "//There is currently no namespace managed by this project//" is displayed and you can create a new one. | ||
| + | |||
| + | === Create a new namespace === | ||
| + | |||
| + | Creating a namespace means creating a root namespace, which will host all versions of your namespace, and an ongoing namespace where you can create new classes and properties. | ||
| + | |||
| + | Click on the "Create" button to open the creation form:\\ | ||
| + | * Enter a label and select a language. English is the default language. You can only add one label when creating the namespace. You can add more labels once the namespace is created. Please note this is the label of your root namespace. Your ongoing namespace will be labelled as follows: "Root namespace label //ongoing//". | ||
| + | * External namespace: only tick this checkbox if your namespace already has its URI outside OntoME. Otherwise leave it unchecked. If you don't know what this means, leave this box unchecked. | ||
| + | * OntoME URI generator: fill this field to generate automatically the namespace URI. Eg. "my namespace" generates "https://ontome.net/ns/my-namespace". The URI is constructed by default from the label entered above. | ||
| + | * Description: type or copy/paste the namespace description in this field. Use only plain text format if you copy/paste a note to clean up all unnecessary tags. You can edit your text using the included rich text editor functions. Your description must be at least 40 characters long. Select the required language in the list below. English is the default language. You can only add one description when creating the namespace. You can add more description in other languages once the namespace is created. | ||
| + | * If you want to add a different description for the ongoing namespace, click on “Add a description for your ongoing namespace” below the form. You can do it later if needed. | ||
| + | |||
| + | ==== Profiles tab ==== | ||
| [...] | [...] | ||
| + | |||
| + | ==== Members tab ==== | ||
| + | |||
| + | This tab list the members of the project with their institution and role.\\ | ||
| + | To add a member and define her/his role, switch to edit mode by clicking the large green button on the upper right. | ||
| ===== Profile ===== | ===== Profile ===== | ||
| + | |||
| + | ==== What is a profile? ==== | ||
| [...] | [...] | ||
| + | ==== Summary tab ==== | ||
| + | |||
| + | This tab presents all the information about the profile in a compact display. | ||
| + | |||
| + | ==== Identification tab ==== | ||
| + | |||
| + | This tab gathers the information allowing the identification of the project:\\ | ||
| + | [...] | ||
| + | |||
| + | ==== Definition tab ==== | ||
| + | |||
| + | [...] | ||
| + | |||
| + | ==== Namespaces tab ==== | ||
| + | |||
| + | [...] | ||
| + | |||
| + | ==== Classes tab ==== | ||
| + | |||
| + | [...] | ||
| + | |||
| + | ==== Properties tab ==== | ||
| + | |||
| + | [...] | ||
| + | |||
| + | ==== Projects tab ==== | ||
| + | |||
| + | [...] | ||
| + | |||
| + | ==== Graph tab ==== | ||
| + | |||
| + | [...] | ||
| ====== Creating and aligning entities ====== | ====== Creating and aligning entities ====== | ||
| Ligne 329: | Ligne 466: | ||
| ===== Classes ===== | ===== Classes ===== | ||
| - | ==== Adding a new class ==== | + | ==== Add a new class ==== |
| After login, select the ongoing namespace to which you want to add a class. | After login, select the ongoing namespace to which you want to add a class. | ||
| Ligne 342: | Ligne 479: | ||
| Click on the "Save" button, your class is created! | Click on the "Save" button, your class is created! | ||
| - | ==== Editing an existing class ==== | + | ==== Edit an existing class ==== |
| Select a class and switch to edit mode by clicking the large green button on the upper right. | Select a class and switch to edit mode by clicking the large green button on the upper right. | ||
| Ligne 360: | Ligne 497: | ||
| ===== Properties ===== | ===== Properties ===== | ||
| - | ==== Adding a new property ==== | + | ==== Add a new property ==== |
| Check first the property you want to create does not already exist by searching the property list. | Check first the property you want to create does not already exist by searching the property list. | ||
| Ligne 379: | Ligne 516: | ||
| Click on the "Save" button, your property is created! | Click on the "Save" button, your property is created! | ||
| - | ==== Editing an existing property ==== | + | ==== Edit an existing property ==== |
| Select a property and switch to edit mode by clicking the large green button on the upper right. | Select a property and switch to edit mode by clicking the large green button on the upper right. | ||
| Ligne 397: | Ligne 534: | ||
| ===== Hierarchy ===== | ===== Hierarchy ===== | ||
| - | ==== Adding a new parent entity ==== | + | ==== Add a new parent entity ==== |
| Select the class/property to which you want to add an existing parent class/property. Note: you can only add a hierarchical association to a parent class/property that is part of a namespace managed by a project you're belonging to. | Select the class/property to which you want to add an existing parent class/property. Note: you can only add a hierarchical association to a parent class/property that is part of a namespace managed by a project you're belonging to. | ||
ontome/index.txt · Dernière modification: 2024/04/29 12:10 par Vincent Alamercery
