Différences

Ci-dessous, les différences entre deux révisions de la page.

--- ontome:index [2020/10/21 19:03]
Vincent Alamercery
+++ ontome:index [2023/07/28 17:21] (Version actuelle)
Francesco Beretta [Adding external namespaces to which this namespace refers]
@@ Ligne 1: / Ligne 1: @@
 ========= OntoME wiki =========
-**https://ontome.dataforhistory.org/**
+**https://ontome.net/**
+For any feedback, bug report: https://github.com/Semantic-Data-for-Humanities/OntoME
 ======== User guide ========
@@ Ligne 25: / Ligne 27: @@
 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 ======
@@ Ligne 32: / Ligne 43: @@
   * Click on the LOGIN button in the top right corner.
   * 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.
@@ Ligne 45: / Ligne 56: @@
 If you forgot your password :
   * Click on "Request new password" on the LOGIN page.
-  * Enter your e-mail and check your mailbox (and your spam folder too) for a message from "ontome@dataforhistory.org".
+  * Enter your e-mail and check your mailbox (and your spam folder too) for a message from "contact@ontome.net".
   * Click on the link and enter a new password.
   * Login to OntoME with your new password.
@@ Ligne 59: / Ligne 70: @@
 ==== 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.
-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 ====
@@ Ligne 90: / Ligne 110: @@
 ==== Classes list ====
-This list displays all classes belonging to the namespaces selected in the "my current namespaces" tab of your dashboard.
+By default, this list displays all classes belonging to the namespaces selected in the "my current namespaces" tab of your dashboard.\\
-  * Click on a label to open the class details.
+Display all the classes contained in OntoME by clicking on "Show all classes" on the top right. Clicking on "Hide all classes" will return to the default display.
-  * Filter this list by using the Search box at the top right. The search is performed on labels and namespaces. For example, try entering "CIDOC".
+  * Sort the list by clicking on the column names.
+  * Filter the list by using the Search box at the top right. The search is performed on all columns. For example, try entering "CIDOC".
   * Adjust the number of lines displayed by using the drop-down menu at the top left.
+  * Click on a label to open the class details.
 ==== Classes tree ====
@@ Ligne 101: / Ligne 123: @@
 ===== Properties menu =====
-This menu directly displays the list of all properties created or imported into OntoME with their domain and range classes, quantifiers and namespaces to which they belong.
+This menu directly displays the list of properties. By default, this list displays all properties belonging to the namespaces selected in the "my current namespaces" tab of your dashboard.\\
-  * Click on a label to open the details.
+Display all the properties contained in OntoME by clicking on "Show all classes" on the top right. Clicking on "Hide all classes" will return to the default display.
-  * Filter this list by using the Search box at the top right. The search is performed on properties labels, domain and range classes labels and namespaces. For example, try entering "CIDOC".
+  * Sort the list by clicking on the column names.
+  * Filter the list by using the Search box at the top right. The search is performed on all columns. For example, try entering "CIDOC".
   * Adjust the number of lines displayed by using the drop-down menu at the top left.
+  * Click on a label to open the property details.
 ===== Namespaces menu =====
-This menu directly displays the list of namespaces created or imported into OntoME.
+This menu directly displays the list of root namespaces.
-  * Click on a label to open the namespace details.
   * 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.
+  * Click on a label to open the namespace details.
 ===== Projects menu =====
 This menu directly displays the list of projects.
-  * Click on a label to open the project details.
   * 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.
+  * Click on a label to open the project details.
 ===== Profiles menu =====
 This menu directly displays the list of profiles with their project to which they belong.
-  * Click on a label to open the details.
   * 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.
+  * Click on a label to open the details.
 ===== User guide menu =====
@@ Ligne 138: / Ligne 162: @@
 A class is a category of items that share one or more common traits serving as criteria to identify the items belonging to the class.\\
+==== Version ====
+A class 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 ====
@@ Ligne 168: / Ligne 196: @@
   * Incoming properties (inherited from ancestors): the list of properties for which the range is a parent class.
-  * Click on a label of a property or a class to open the entity details.
   * Filter these lists by using the Search box at the top right. The search is performed on labels and namespaces.
   * Adjust the number of lines displayed by using the drop-down menu at the top left.
-  * The namespace column displays the namespace version in which the property is set.
+  * The namespace column displays the namespace version in which the property is defined.
+  * Click on a label of a property or a class to open the entity details.
 ==== Namespaces tab ====
-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.\\
-  * 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.
   * 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.
 ==== 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
 superclass without exceptions.
   * Parent classes: the list of all superclasses of the 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.
     * 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.
-  * 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 ====
-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".
   * Class: the class that is in 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 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 ====
 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 ====
@@ Ligne 216: / Ligne 258: @@
 ==== 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 =====
+==== 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 ====
@@ Ligne 229: / Ligne 281: @@
   * 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.
   * 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 244: / Ligne 296: @@
 ==== 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.
   * 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 ====
@@ Ligne 259: / Ligne 314: @@
     * Property namespace: the namespace of the parent class.
     * Relation defined in: the namespace version in which the hierarchical relation is set.
     * 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.
-  * 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 ====
@@ Ligne 272: / Ligne 341: @@
   * Property: the property that is in 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 a property to open the details.
+  * Click on a property label to open its details.
 ==== Profiles tab ====
@@ Ligne 280: / Ligne 349: @@
 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 ====
@@ Ligne 287: / Ligne 356: @@
 ===== 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.\\
+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 ====
+This tab presents all the information about the namespace in a compact display.
+==== Identification tab ====
+This tab gathers the information allowing the identification of the namespace:\\
+=== Root namespace ===
+  * 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 ====
+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.
+  * 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.
+==== 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 a version of a namespace, this tab only displays the root namespace.
+==== Classes tab ====
+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).
+==== Properties tab ====
+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).
+==== Relations tab ====
+Only for a version of a namespace.
+This tab lists the relations in the namespace. You can filter the display by relations type.
+==== Graph tab ====
+Only for a version of a 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 =====
+==== 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.
+==== Profiles tab ====
 [...]
+==== Members tab ====
+This tab list the members of the project with their institution and role.\\
+To add a member and define their role, switch to edit mode by clicking the large green button on the upper right.
+===== 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:\\
 [...]
@@ Ligne 300: / Ligne 498: @@
 [...]
-==== Hierarchy tab ====
+==== Namespaces tab ====
 [...]
@@ Ligne 312: / Ligne 510: @@
 [...]
-==== Graph tab ====
+==== Projects tab ====
 [...]
-===== Project =====
+==== Graph tab ====
 [...]
-===== Profile =====
+====== 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 ======
 ===== Classes =====
-==== Adding a new class ====
+==== Add a new class ====
 After login, select the ongoing namespace to which you want to add a class.
@@ Ligne 342: / Ligne 557: @@
 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.
@@ Ligne 360: / Ligne 575: @@
 ===== 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.
@@ Ligne 379: / Ligne 594: @@
 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.
@@ Ligne 397: / Ligne 612: @@
 ===== 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.

Wiki de l'ARHNAxe de recherche en histoire numériqueLARHRA UMR5190

Outils pour utilisateurs

Outils du site

Différences

Outils de la page

Wiki de l'ARHN

Axe de recherche en histoire numérique
LARHRA UMR5190