From 99849abc1ab479048272e62ae28625a4c415bede Mon Sep 17 00:00:00 2001
From: vermeul <swen@ethz.ch>
Date: Mon, 28 May 2018 14:58:58 +0200
Subject: [PATCH] added more description controlled vocabulary

---
 src/python/PyBis/README.md  | 13 +++++++++++--
 src/python/PyBis/README.rst | 23 ++++++++++++++++++-----
 2 files changed, 29 insertions(+), 7 deletions(-)

diff --git a/src/python/PyBis/README.md b/src/python/PyBis/README.md
index b4db8bb03b8..5e96b729ccf 100644
--- a/src/python/PyBis/README.md
+++ b/src/python/PyBis/README.md
@@ -290,7 +290,16 @@ tag.delete()
 
 ## Vocabualry and VocabularyTerms
 
-Vocabulary consists of many VocabularyTerms. They are used to control the Terms in a Property field. So for example, you want to add a property called **Animal** to a Sample and you want to control which terms are used in this Property. For this you need to do a couple of steps:
+An entity such as Sample (Object), Experiment (Collection), Material or DataSet can be of a specific type:
+
+* Sample Type
+* Experiment Type
+* DataSet Type
+* Material Type
+
+Every type defines which Properties may be defined. Properties are like Attributes, but they are Type specific. Properties can contain all sorts of information, such as free text, XML, Hyperlink, Boolean and also *Controlled Vocabulary*. Such a Controlled Vocabulary consists of many VocabularyTerms. They are used to check the terms entered in a Property field.
+
+So for example, you want to add a property called **Animal** to a Sample and you want to control which terms are entered in this Property field. For this you need to do a couple of steps:
 
 1. create a new vocabulary *AnimalVocabulary*
 2. add terms to that vocabulary: *Cat, Dog, Mouse*
@@ -357,4 +366,4 @@ This project is devided in several parts:
 - src/core-plugins/**jupyter-api**, an ingestion plug-in for openBIS, allowing people to upload new datasets
 - src/vagrant/**jupyter-bis/Vagrantfile** to set up JupyterHub on a virtual machine (CentOS 7), which uses the JupyterBis authenticator module
 - src/vagrant/**obis/Vagrantfile** to set up a complete OpenBIS instance on a virtual machine (CentOS 7)
-- 
\ No newline at end of file
+- 
diff --git a/src/python/PyBis/README.rst b/src/python/PyBis/README.rst
index 370e47122e4..5b1d275ca03 100644
--- a/src/python/PyBis/README.rst
+++ b/src/python/PyBis/README.rst
@@ -313,11 +313,24 @@ Tags
 Vocabualry and VocabularyTerms
 ------------------------------
 
-Vocabulary consists of many VocabularyTerms. They are used to control
-the Terms in a Property field. So for example, you want to add a
-property called **Animal** to a Sample and you want to control which
-terms are used in this Property. For this you need to do a couple of
-steps:
+An entity such as Sample (Object), Experiment (Collection), Material or
+DataSet can be of a specific type:
+
+-  Sample Type
+-  Experiment Type
+-  DataSet Type
+-  Material Type
+
+Every type defines which Properties may be defined. Properties are like
+Attributes, but they are Type specific. Properties can contain all sorts
+of information, such as free text, XML, Hyperlink, Boolean and also
+*Controlled Vocabulary*. Such a Controlled Vocabulary consists of many
+VocabularyTerms. They are used to check the terms entered in a Property
+field.
+
+So for example, you want to add a property called **Animal** to a Sample
+and you want to control which terms are entered in this Property field.
+For this you need to do a couple of steps:
 
 1. create a new vocabulary *AnimalVocabulary*
 2. add terms to that vocabulary: *Cat, Dog, Mouse*
-- 
GitLab