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 | ||
|
ontome:index [2021/08/30 14:26] Vincent Alamercery |
ontome:index [2024/04/29 12:10] (Version actuelle) Vincent Alamercery Avertissement |
||
|---|---|---|---|
| Ligne 3: | Ligne 3: | ||
| **https://ontome.net/** | **https://ontome.net/** | ||
| - | For any feedback, bug report: https://github.com/Semantic-Data-for-Humanities/OntoME | + | For any feedback, bug report: https://github.com/orgs/geovistory/discussions |
| ======== User guide ======== | ======== User guide ======== | ||
| Work in progress! | Work in progress! | ||
| + | |||
| + | :!: We apologise for the fact that this guide is not up to date. If you need any help, please do not hesitate to contact us: | ||
| + | * GitHub discussion: https://github.com/orgs/geovistory/discussions | ||
| + | * Discord: https://discord.gg/dV74NzaN5g | ||
| + | * Email: contact at ontome.net | ||
| ======= What is OntoME? ======= | ======= What is OntoME? ======= | ||
| Ligne 84: | Ligne 89: | ||
| :!: You can only create classes, properties and relations or modify those that exist in the ongoing namespace managed by the project you have activated.\\ | :!: 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. | The current active project is displayed at the top right of the screen. | ||
| - | |||
| ==== My current namespaces tab ==== | ==== My current namespaces tab ==== | ||
| Ligne 133: | Ligne 137: | ||
| ===== Namespaces menu ===== | ===== Namespaces menu ===== | ||
| - | This menu directly displays the list of namespaces created or imported into OntoME. | + | This menu directly displays the list of root namespaces. |
| * Filter this list by using the Search box at the top right. For example, try entering "CIDOC". | * Filter this list by using the Search box at the top right. For example, try entering "CIDOC". | ||
| * 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. | ||
| Ligne 205: | Ligne 209: | ||
| This tab lists the namespace versions in which the class is defined. Different versions of the same class can only exist in different versions of a single root namespace.\\ | This tab lists the namespace versions in which the class is defined. Different versions of the same class can only exist in different versions of a single root namespace.\\ | ||
| - | The current namespace is displayed in green. Change the version of | + | The current namespace is displayed in green. |
| * 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. | ||
| + | * Change the namespace version by using the drop-down menu at the top right. | ||
| * Click on a namespace version to open the details. | * Click on a namespace version to open the details. | ||
| ==== Hierarchy tab ==== | ==== Hierarchy tab ==== | ||
| - | This tab lists the hierarchical relations of the class.\\ | + | This tab lists the hierarchical relations of a class.\\ |
| A class can be a superclass or a subclass of another. A superclass is a class that is a generalisation of one or more other classes, its subclasses. A subclass is a class that is a specialisation of an another class, its superclass. The subclass inherits the definition of all of the properties declared for its | A class can be a superclass or a subclass of another. A superclass is a class that is a generalisation of one or more other classes, its subclasses. A subclass is a class that is a specialisation of an another class, its superclass. The subclass inherits the definition of all of the properties declared for its | ||
| superclass without exceptions. | superclass without exceptions. | ||
| * Parent classes: the list of all superclasses of the class. | * Parent classes: the list of all superclasses of the class. | ||
| * Class: the parent class. | * Class: the parent class. | ||
| - | * Class namespace: the namespace of the parent class. | + | * Class namespace: the namespace version of the parent class. |
| * Relation defined in: the namespace version in which the hierarchical relation is set. | * Relation defined in: the namespace version in which the hierarchical relation is set. | ||
| * Justification: the explanation of the hierarchical relation. | * Justification: the explanation of the hierarchical relation. | ||
| * Click on the “information” icon to view the details and the comments posted for a hierarchical relation. If you have created an account, you can also post a new comment or reply to an existing one. | * Click on the “information” icon to view the details and the comments posted for a hierarchical relation. If you have created an account, you can also post a new comment or reply to an existing one. | ||
| - | * Ancestor classes: the list of all ancestor classes of the class, i.e. all superclasses of its superclasses, with the indication of the depth and the namespace of the ancestor class. | + | * Edit: if you have the right to do so, click on the icon to edit the hierarchical relation. |
| - | * Child and descendant classes: the list of all child and descendant classes, i.e. all subclasses of the classes and all subclasses of its subclasses, with the indication of the depth and the namespace of the child or descendant class. | + | * Delete: if you have the right to do so, click on the icon to delete the hierarchical relation. |
| - | * Click on a class to open the details. | + | * Ancestor classes: the list of all ancestor classes of the class, i.e. all superclasses of its superclasses. |
| + | * Class: the ancestor class. | ||
| + | * Depth: the depth level of the relation. | ||
| + | * Class namespace: the namespace version of the ancestor class. | ||
| + | * Via: the path from the class to its ancestor. | ||
| + | * Child and descendant classes: the list of all child and descendant classes, i.e. all subclasses of the classes and all subclasses of its subclasses. | ||
| + | * Class: the descendant class. | ||
| + | * Depth: the depth level of the relation. | ||
| + | * Class namespace: the namespace version of the descendant class. | ||
| + | * Via: the path from the class to its descendant. | ||
| + | * Click on a class label to open its details. | ||
| ==== Relation tab ==== | ==== Relation tab ==== | ||
| - | This tab lists the non-hierarchical relations of the class. | + | This tab lists the non-hierarchical relations of a class. |
| * Relation: the type of the relation. Two of them are currently offered: "equivalent class" and "disjoint with". | * Relation: the type of the relation. Two of them are currently offered: "equivalent class" and "disjoint with". | ||
| * Class: the class that is in relation. | * Class: the class that is in relation. | ||
| * Justification: the explanation of the relation. | * Justification: the explanation of the relation. | ||
| - | * Relation defined in: the namespace version in which the relation is set. | + | * Relation defined in: the namespace version in which the relation is defined. |
| * Click on the “information” icon to view the details and the comments posted for a relation. If you have created an account, you can also post a new comment or reply to an existing one. | * Click on the “information” icon to view the details and the comments posted for a relation. If you have created an account, you can also post a new comment or reply to an existing one. | ||
| - | * Click on a class to open the details. | + | * Edit: if you have the right to do so, click on the icon to edit the relation. |
| + | * Delete: if you have the right to do so, click on the icon to delete the elation. | ||
| + | * Click on a class label to open its details. | ||
| ==== Profiles tab ==== | ==== Profiles tab ==== | ||
| This tab lists the profiles using the class. | This tab lists the profiles using the class. | ||
| - | * Click on a profile to open the details. | + | * Click on a profile to open its details. |
| ==== Graph tab ==== | ==== Graph tab ==== | ||
| Ligne 246: | Ligne 263: | ||
| ==== Comments tab ==== | ==== Comments tab ==== | ||
| - | This tab lists the general comments posted on the class. If you have created an account, you can also post a new comment or reply to an existing one. | + | This tab lists the general comments posted on a class. If you have created an account, you can also post a new comment or reply to an existing one. |
| ===== Property ===== | ===== Property ===== | ||
| + | |||
| + | ==== What is a property? ==== | ||
| + | |||
| + | A property serves to define a relationship of a specific kind between two classes. A property | ||
| + | plays a role analogous to a grammatical verb, in that it must be defined with reference to | ||
| + | both its //domain// and //range//, which are analogous to the subject and object in grammar. | ||
| + | |||
| + | ==== Version ==== | ||
| + | |||
| + | A property is belonging to a namespace whose version is displayed on the drop-down menu at the top right.\\ Change the version by using this menu. | ||
| ==== Summary tab ==== | ==== Summary tab ==== | ||
| Ligne 259: | Ligne 286: | ||
| * Identifier: a unique and mandatory alphanumeric string identifying the property in all versions of its namespace. | * Identifier: a unique and mandatory alphanumeric string identifying the property in all versions of its namespace. | ||
| - | * Domain and range: The domain is the class for which a property is formally defined. The range is the class that comprises all potential values of a property. The quantifiers are the allowed number of instances of a certain property that can refer to a particular instance of the domain class or the range class of that property. | + | * Domain and range: The domain is the class for which a property is formally defined. The range is the class that comprises all potential values of a property. The quantifiers are the allowed number of instances of a certain property that can refer to a particular instance of the domain class or the range class of that property.\\ :!: Note that OntoME uses the **UML** notation for quantifiers which is the reverse of that traditionally used in the CIDOC CRM documentation. |
| * Labels: the list of property labels in the different languages. There can only be one standard label per language. A label indicates the general meaning of the property but does not define it. Always refer to the scope note for the intension of the property. A property must have at least one standard label in any language. | * Labels: the list of property labels in the different languages. There can only be one standard label per language. A label indicates the general meaning of the property but does not define it. Always refer to the scope note for the intension of the property. A property must have at least one standard label in any language. | ||
| * Click on the “information” icon to view the details and the comments posted for a label. If you have created an account, you can also post a new comment or reply to an existing one. | * Click on the “information” icon to view the details and the comments posted for a label. If you have created an account, you can also post a new comment or reply to an existing one. | ||
| Ligne 274: | Ligne 301: | ||
| ==== Namespaces tab ==== | ==== Namespaces tab ==== | ||
| - | This tab lists the namespace versions in which the property is defined. Different versions of the same property can only exist in different versions of a single root namespace. | + | This tab lists the namespace versions in which the property is defined. Different versions of the same property can only exist in different versions of a single root namespace.\\ |
| - | * Click on a namespace to open the details. | + | The current namespace is displayed in green. |
| * 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. | ||
| + | * Change the namespace version by using the drop-down menu at the top right. | ||
| + | * Click on a namespace version to open its details. | ||
| ==== Hierarchy tab ==== | ==== Hierarchy tab ==== | ||
| Ligne 290: | Ligne 319: | ||
| * Property namespace: the namespace of the parent class. | * Property namespace: the namespace of the parent class. | ||
| * Relation defined in: the namespace version in which the hierarchical relation is set. | * Relation defined in: the namespace version in which the hierarchical relation is set. | ||
| - | * Justification: the explanation of the hierarchical relation. | + | * Justification: the explanation of the hierarchical relation. |
| * Click on the “information” icon to view the details and the comments posted for a hierarchical relation. If you have created an account, you can also post a new comment or reply to an existing one. | * Click on the “information” icon to view the details and the comments posted for a hierarchical relation. If you have created an account, you can also post a new comment or reply to an existing one. | ||
| - | * Ancestor properties: the list of all ancestor properties of the class, i.e. all superproperties of its superproperties, with the indication of the depth and the namespace of the ancestor property. | + | * Edit: if you have the right to do so, click on the icon to edit the hierarchical relation. |
| - | * Child and descendant properties: the list of all child and descendant properties, i.e. all subproperties of the properties and all subproperties of its subproperties, with the indication of the depth and the namespace of the child or descendant property. | + | * Delete: if you have the right to do so, click on the icon to delete the hierarchical relation. |
| - | * Click on a property to open the details. | + | * Ancestor properties: the list of all ancestor properties of the property, i.e. all superproperties of its superproperties. |
| + | * Domain: the domain class of the ancestor property, with its quantifiers. | ||
| + | * Property: the ancestor property. | ||
| + | * Range: the range class of the ancestor property, with its quantifiers. | ||
| + | * Depth: the depth level of the relation. | ||
| + | * Property namespace: the namespace version of the ancestor property. | ||
| + | * Via: the path from the property to its ancestor. | ||
| + | * Child and descendant properties: the list of all child and descendant properties, i.e. all subproperties of the properties and all subproperties of its subproperties. | ||
| + | * Domain: the domain class of the descendant property, with its quantifiers. | ||
| + | * Property: the descendant property. | ||
| + | * Range: the range class of the descendant property, with its quantifiers. | ||
| + | * Depth: the depth level of the relation. | ||
| + | * Property namespace: the namespace version of the descendant property. | ||
| + | * Via: the path from the property to its descendant. | ||
| + | * Click on a property or a class label to open its details. | ||
| ==== Relations tab ==== | ==== Relations tab ==== | ||
| Ligne 303: | Ligne 346: | ||
| * Property: the property that is in relation. | * Property: the property that is in relation. | ||
| * Justification: the explanation of the relation. | * Justification: the explanation of the relation. | ||
| - | * Relation defined in: the namespace version in which the relation is set. | + | * Relation defined in: the namespace version in which the relation is defined. |
| * Click on the “information” icon to view the details and the comments posted for a relation. If you have created an account, you can also post a new comment or reply to an existing one. | * Click on the “information” icon to view the details and the comments posted for a relation. If you have created an account, you can also post a new comment or reply to an existing one. | ||
| - | * Click on a property to open the details. | + | * Click on a property label to open its details. |
| ==== Profiles tab ==== | ==== Profiles tab ==== | ||
| Ligne 311: | Ligne 354: | ||
| This tab lists the profiles using the property. | This tab lists the profiles using the property. | ||
| - | * Click on a profile to open the details. | + | * Click on a profile to open its details. |
| ==== Comments tab ==== | ==== Comments tab ==== | ||
| Ligne 321: | Ligne 364: | ||
| ==== What is a namespace? ==== | ==== What is a namespace? ==== | ||
| - | The concept of namespaces is at the core of OntoME. A namespace refers to a set of classes and properties designed to accommodate terms from the same domain. It ensures that all the identifiers within it have unique names so that they can be easily identified. | + | The concept of namespaces is at the core of OntoME. A namespace refers to a set of classes and properties designed to accommodate terms from the same domain. It ensures that all the identifiers within it have unique names so that they can be easily identified.\\ |
| + | In OntoME, a namespace includes a root namespace and versions. The root namespace does not contain any classes or properties, it serves to bring together its different versions in which classes and properties are defined, as well as relationships. | ||
| ==== Summary tab ==== | ==== Summary tab ==== | ||
| Ligne 331: | Ligne 375: | ||
| This tab gathers the information allowing the identification of the namespace:\\ | 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). | + | === Root namespace === |
| - | * 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. | + | * Identification: this part displays the namespace URI, its project of belonging and its prefix. |
| + | * Labels: the list of namespace labels in the different languages. There can only be one standard label per language. | ||
| + | |||
| + | === Versions === | ||
| + | |||
| + | * Identification: this part displays the root namespace URI, its project of belonging, its status (ongoing, published or deprecated) and its version information. | ||
| + | * 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...). 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 in the different languages. There can only be one standard label per language. | ||
| ==== Definition tab ==== | ==== Definition tab ==== | ||
| This tab gathers the information to define a namespace: | This tab gathers the information to define a namespace: | ||
| + | |||
| + | === Root namespace === | ||
| + | |||
| + | * Description: the list of texts presenting the root namespace in the different languages. A root namespace 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. | ||
| + | |||
| + | === Version === | ||
| * Description: the list of texts presenting the namespace in the different languages. A namespace must have at least one description in any language. | * 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. | + | * Contributors: 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. | * Additional notes: the list of additional notes in the different languages. These notes, which are not mandatory, are used to specify the description. | ||
| Ligne 346: | Ligne 404: | ||
| * 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 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. | + | * For a version of a namespace, this tab only displays the root namespace. |
| ==== Classes tab ==== | ==== Classes tab ==== | ||
| - | Only for an ongoing/published/deprecated namespace. | + | Only for a version of a 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). | 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). | ||
| Ligne 356: | Ligne 414: | ||
| ==== Properties tab ==== | ==== Properties tab ==== | ||
| - | Only for an ongoing/published/deprecated namespace. | + | Only for a version of a 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). | 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). | ||
| Ligne 362: | Ligne 420: | ||
| ==== Relations tab ==== | ==== Relations tab ==== | ||
| - | Only for an ongoing/published/deprecated namespace. | + | Only for a version of a namespace. |
| This tab lists the relations in the namespace. You can filter the display by relations type. | This tab lists the relations in the namespace. You can filter the display by relations type. | ||
| Ligne 368: | Ligne 426: | ||
| ==== Graph tab ==== | ==== Graph tab ==== | ||
| - | Only for an ongoing/published/deprecated namespace. | + | Only for a version of a namespace. |
| This tab displays the namespace graph dynamically. | This tab displays the namespace graph dynamically. | ||
| Ligne 415: | Ligne 473: | ||
| 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. | 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 ==== | ==== Profiles tab ==== | ||
| Ligne 474: | Ligne 523: | ||
| [...] | [...] | ||
| + | ====== 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. | ||
| + | |||
| + | ===== Adding external namespaces to which this namespace refers ===== | ||
| + | |||
| + | If you want your classes and properties to refer to classes or properties in other namespaces (in a hierarchy or equivalence sense), you can add the relevant external namespace or namespaces as follows: | ||
| + | * Activate the ongoing namespace card | ||
| + | * Activate the "Identification" tab | ||
| + | * Choose (Pick!) a reference namespace from the list of the available namespaces | ||
| + | * Choose the version you would use in your project and add it (use the "+" icon before the envisaged version) to your namespace | ||
| + | * You will see this namespace and the its dependencies (other namespaces it refers to) appear in the list of "Namespaces to which this ongoing namespace refers" | ||
| + | |||
| + | |||
| + | The classes and properties of all the activated namespaces will now appear in your project and you can use them to refer to them from your own classes and properties. | ||
| ====== Creating and aligning entities ====== | ====== Creating and aligning entities ====== | ||
ontome/index.1630326406.txt.gz · Dernière modification: 2021/08/30 14:26 par Vincent Alamercery
