Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(user-guide): update user-guide about ontology (DSP-976) #480

Merged
merged 3 commits into from Jul 16, 2021

Conversation

@gautschr
Copy link
Contributor

@gautschr gautschr commented Jul 7, 2021

resolves DSP-976-Ontology-User-guide-about-ontology-editor

@gautschr gautschr requested review from mdelez and kilchenmann Jul 7, 2021
docs/user-guide/project.md Show resolved Hide resolved
Loading
@kilchenmann kilchenmann changed the title docs(contribution): DSP-976 docs(user-guide): update user-guide about ontology (DSP-976) Jul 9, 2021
Copy link
Collaborator

@kilchenmann kilchenmann left a comment

LGTM but @mdelez should also take a look at it

Loading

Copy link
Contributor

@mdelez mdelez left a comment

Just a few small fixes :)

Loading


Diagram 1 shows the relationships of the data by resource classes from these experiences.
By clicking `New data model`, a dialogue box opens:
Copy link
Contributor

@mdelez mdelez Jul 16, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

dialogue -> dialog. Both words exist in English but dialog is for computing :)

Loading


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.
Copy link
Contributor

@mdelez mdelez Jul 16, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would split "you've" into "you have". This could just be my American English though.

Loading


![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".](../assets/images/data-model-class-select-representation.png)*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:
Copy link
Contributor

@mdelez mdelez Jul 16, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"As label" -> "For the label"

Loading


#### Create new property by selecting from list of default property types
By hovering over `Create new from type`, a new dialogue box appears:
Copy link
Contributor

@mdelez mdelez Jul 16, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

dialogue -> dialog

Loading


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:
![Property of nteger type.](../assets/images/Fig15.png)
Copy link
Contributor

@mdelez mdelez Jul 16, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nteger -> integer

Loading


### 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:
Copy link
Contributor

@mdelez mdelez Jul 16, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Loading


---
### 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:
Copy link
Contributor

@mdelez mdelez Jul 16, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

removee - > remove

yellow-rimmed -> highlighted in yellow

Loading

### 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.
![Delete a property.](../assets/images/Fig38.png)
*Be aware, you can only delete properties which are NOT used in a resouce class!*
Copy link
Contributor

@mdelez mdelez Jul 16, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

resouce - > resource

Loading



## 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.
Copy link
Contributor

@mdelez mdelez Jul 16, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

WIn -> In

Loading

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.](../assets/images/Fig24.png)*Diagram 2: Focus on the audio-interview.*

However, we can also prefer another visualization which focusses on the transcript (Diagram 3):
Copy link
Contributor

@mdelez mdelez Jul 16, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

focusses - > focuses

Loading

@gautschr
Copy link
Contributor Author

@gautschr gautschr commented Jul 16, 2021

Requested changes are done. See

0fb72ff

Loading

@mdelez mdelez self-requested a review Jul 16, 2021
mdelez
mdelez approved these changes Jul 16, 2021
@gautschr gautschr merged commit e12f196 into main Jul 16, 2021
8 checks passed
Loading
@gautschr gautschr deleted the wip/DSP-976-Ontology-User-guide-about-ontology-editor branch Jul 16, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants