From bc575da71feec5077429a59f585160714d9f3de6 Mon Sep 17 00:00:00 2001 From: krystofkomanec Date: Wed, 24 Apr 2024 10:12:36 +0200 Subject: [PATCH] Add more information about question tags --- docs/about/introduction/knowledge-model.rst | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/about/introduction/knowledge-model.rst b/docs/about/introduction/knowledge-model.rst index 216a8570..e8888c9a 100644 --- a/docs/about/introduction/knowledge-model.rst +++ b/docs/about/introduction/knowledge-model.rst @@ -44,6 +44,7 @@ Questions are used to collect the answers from users. Each question has a **titl Then there are some additional settings based on the **question type**. + .. _options-question: Options Question @@ -51,6 +52,7 @@ Options Question The options question contains a closed list of :ref:`answers` where users can pick one. Answers can have some follow-up questions that are only presented to the user when they pick the answer. So the options question can be used for questionnaire branching. + .. _list-question: List Question @@ -58,6 +60,7 @@ List Question The list question is used when there are multiple answers and we want to ask more details about those. For example, we can ask about different datasets that will be produced -- users will have multiple datasets but we want to ask the same questions for each of those. For that, we configure the **item template**, which defines the questions for each item. + .. _value-question: Value Question @@ -77,6 +80,7 @@ The value question asks for a single value that users type in. There are many di The input field differs based on the value type (simple input for string, date picker for date, etc.). Some of these have a check whether the entered value is valid (such as valid email or URL) and displays a warning if not. + .. _integration-question: Integration Question @@ -127,7 +131,6 @@ Reference We can provide some additional references for :ref:`questions` to help users better understand it or learn more details. There are more types of references. - URL Reference ^^^^^^^^^^^^^ @@ -139,6 +142,7 @@ Book Reference .. warning:: Book references are deprecated. + Resource Page Reference ^^^^^^^^^^^^^^^^^^^^^^^ @@ -153,6 +157,7 @@ Expert We can provide a contact information to an expert for some :ref:`questions`. An expert has a **name** and an **email**. We can use this, for example, if there is an expert for a specific topics in our institution and we want to make it easy to find out in our customized knowledge model. + .. _metric: Metric @@ -189,7 +194,7 @@ Question Tag We can define question tags on the knowledge model and then assign them to different :ref:`questions`. This can be used to group together questions on the same topic or for the same purpose. -When researchers create a new project from the knowledge model, they can only choose the question groups they are interested in for their research. So we can use this to create a very rich knowledge model but researchers will be able to use only the parts relevant to them. +When researchers create a new project from the knowledge model, they can only choose the question groups they are interested in for their research. Selection of question tags is done in :ref:`custom project creation` So we can use this to create a very rich knowledge model but researchers will be able to use only the parts relevant to them. .. _integration: