docs(user-guide): update user-guide about ontology (DSP-976) #480
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kilchenmann
reviewed
Jul 9, 2021
kilchenmann
changed the title
kilchenmann
approved these changes
Jul 16, 2021
mdelez
requested changes
Jul 16, 2021
docs/user-guide/project.md
Outdated
|
|
||
| Diagram 1 shows the relationships of the data by resource classes from these experiences. | ||
| By clicking `New data model`, a dialogue box opens: |
There was a problem hiding this comment.
dialogue -> dialog. Both words exist in English but dialog is for computing :)
docs/user-guide/project.md
Outdated
|
|
||
| Go to your project, select the tab `Data model` and click on button `New data model` or `Create your first data model` (in case of a brand new project). This will open a form in a dialog box where you have to set a unique name and a label. Optional you can also add a short description of form of a comment. | ||
| Now you've to set a unique name (*please consider the NOTE*) and you can add a comment. Push the button `Create` to create your data model. |
There was a problem hiding this comment.
I would split "you've" into "you have". This could just be my American English though.
docs/user-guide/project.md
Outdated
|
|
||
| *Data model editor | Step 2: Create all your main resource classes by selecting a predefined representation type; e.g. for a taped interview, select the representation type "Audio / Sound / Interview".* | ||
| As label you could write *Book*, and you should add a preferably meaningful comment in at least one of the predefined languages English (en), German (de), French (fr) or Italian (it). Then click the `Submit` button: |
There was a problem hiding this comment.
"As label" -> "For the label"
docs/user-guide/project.md
Outdated
|
|
||
| #### Create new property by selecting from list of default property types | ||
| By hovering over `Create new from type`, a new dialogue box appears: |
docs/user-guide/project.md
Outdated
|
|
||
| If you have already created some properties in another resource classes or in the property section <!-- TODO: add link to property section as soon this section exists --> you can select one of them to add it to the resource class. This way you have to define — for example — a "Title" property only once. | ||
| Page numbers have no decimal places, thus you will selecet `Integer` as type for your property. The following window pops up: | ||
|  |
docs/user-guide/project.md
Outdated
|
|
||
| ### Connect SOURCE TYPES in the data model (optional) | ||
| #### How to define items in a list | ||
| In our example we have created a list named *Category*. Now it is time to define the list items. We will as first hierarchy in our list some main literature genres. Enter the name of the list node and click the `+` as shown below: |
There was a problem hiding this comment.
We will as first hierarchy in our list some main literature genres. - > We will list some main literature genres as the first hierarchy in our list.
docs/user-guide/project.md
Outdated
|
|
||
| --- | ||
| ### Remove PROPERTIES from a resource class | ||
| To remove a property, hover over the property which you want to remove. By doing so you see a white x with a black background (removee button) appearing, it is yellow-rimmed in the image below: |
There was a problem hiding this comment.
removee - > remove
yellow-rimmed -> highlighted in yellow
docs/user-guide/project.md
Outdated
| ### Delete a property | ||
| In order to really delete a property you have to go to the `Properties` section as shown below. Click on `Properties`, and afterwards click on the waste basket sign of the property which you intend to delete. | ||
|  | ||
| *Be aware, you can only delete properties which are NOT used in a resouce class!* |
docs/user-guide/project.md
Outdated
|
|
||
|
|
||
| ## An example | ||
| WIn the following example we focus on how we can reflect about our data before building our model and how a data model can relate classes to each other. |
docs/user-guide/project.md
Outdated
| How the practical arrangement finally looks like depends on your purposes and preferences. For example we could choose to arrange the data with regards to their audio source as seen in Diagram 2: | ||
| *Diagram 2: Focus on the audio-interview.* | ||
|
|
||
| However, we can also prefer another visualization which focusses on the transcript (Diagram 3): |
|
Requested changes are done. See |
mdelez
approved these changes
Jul 16, 2021
gautschr
deleted the
wip/DSP-976-Ontology-User-guide-about-ontology-editor
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
resolves DSP-976-Ontology-User-guide-about-ontology-editor