Skip to content

Commit

Permalink
Add 4.10 Guide
Browse files Browse the repository at this point in the history
  • Loading branch information
krystofkomanec committed Sep 3, 2024
1 parent e76e9d9 commit 2ccf6a4
Show file tree
Hide file tree
Showing 6 changed files with 135 additions and 108 deletions.
1 change: 1 addition & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,5 @@ watch:
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@rm -rf ./_build
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
37 changes: 23 additions & 14 deletions docs/about/introduction/knowledge-model.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ The knowledge model consists of chapters at the top level. Each chapter has a **
Question
--------

Questions are used to collect the answers from users. Each question has a **title** (the actual question), a **description**, a **phase** when it becomes desirable, a list of :ref:`references<reference>` and :ref:`experts<expert>`, and a selection of :ref:`question tags<question-tag>`.
Questions are used to collect the answers from users. Each question has a **title** (the actual question), a **description**, a **phase** when it becomes desirable, a list of :ref:`resource pages<resource-page>` gathered in a :ref:`resource collection<resource-collection>` or :ref:`URL references<url-reference>` and :ref:`experts<expert>`, and a selection of :ref:`question tags<question-tag>`.

Then there are some additional settings based on the **question type**.

Expand Down Expand Up @@ -101,6 +101,13 @@ Multi-Choice Question
The multi-choice question has a list of :ref:`choices<choice>`. Users can then pick as many of those choices as they wish. There are, however, no follow-up questions available for this question type.


.. _item-select-question:

Item Select Question
^^^^^^^^^^^^^^^^^^^^

The item selection question works in conjunction with the :ref:`list of items question<list-of-items-question>`. It is used to select one of the previously created items within a series of interconnected list of items question.

.. _answer:

Answer
Expand All @@ -124,17 +131,26 @@ Choice
A choice is used with :ref:`multi-choice questions<multi-choice-question>`. It only contains a **label** which is presented to the user.


.. _reference:
.. _resource-collection:

Resource Collection
--------------------

We can provide some additional reference resources for :ref:`questions<question>` to help users better understand it or learn more details. There are two types of references.

.. _resource-page:

Resource Page Reference
^^^^^^^^^^^^^^^^^^^^^^^

Reference
---------
A resource page reference is a link to a page in the |project_name| itself. It has **title** which is the name of the page and a **content** that describes what the reference is about. Resource pages are gathered in the resource collections.

We can provide some additional references for :ref:`questions<question>` to help users better understand it or learn more details. There are more types of references.
.. _url-reference:

URL Reference
^^^^^^^^^^^^^
-------------

A URL reference is a simple link to any website. It has **URL** which is the actual link and a **label** that describes what the reference is about.
A URL reference is a simple link to any website. It has **URL** which is the actual link and a **label** that describes what the reference is about. URL reference is set up on a level of question, not on a level of knowledge model.

Book Reference
^^^^^^^^^^^^^^
Expand All @@ -143,13 +159,6 @@ Book Reference
Book references are deprecated.


Resource Page Reference
^^^^^^^^^^^^^^^^^^^^^^^

.. warning::
Resource page references are not yet implemented.


.. _expert:

Expert
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,19 +45,18 @@ There are different entities we can edit in the knowledge model, the editor show
- :ref:`Question<question>`
- :ref:`Answer<answer>`
- :ref:`Choice<choice>`
- :ref:`Reference<reference>`
- :ref:`Expert<expert>`
- :ref:`Metric<metric>`
- :ref:`Phase<phase>`
- :ref:`Question Tag<question-tag>`
- :ref:`Integration<integration>`
- :ref:`Resource Collection<resource-collection>`

.. figure:: knowledge-model/editor-form.png

Example of question editor form.



Besides their own fields, each entity has so called **Annotations**. They are arbitrary key value pairs that can be assigned to the entity and used later, when :ref:`developing a document template<document-template-development>`.


Expand Down
16 changes: 14 additions & 2 deletions docs/application/projects/list/detail/questionnaire.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,6 @@ There are three desirability states the question can be in:
If there is no phase defined on the knowledge model, the current phase selection is not visible in the questionnaire detail.



Chapters
========

Expand Down Expand Up @@ -108,6 +107,7 @@ There is a trash bin icon in the item's top right corner that we can use to **de

List of items question with a single item.


Value Question
--------------

Expand All @@ -132,7 +132,6 @@ When we pick an answer from the list, we not only have the answer but also **a l
Integration question with a response from FAIRsharing containing also a link.



Multi-Choice Question
---------------------

Expand All @@ -143,6 +142,19 @@ Multi-choice question is similar to the options question, however we can choose
Multi-choice question with many choices.


Item Select Question
--------------------

The item selection question is used together with the list of items question. When creating an item selection question, you must choose one of the existing list of items questions. The answers provided to that list of items question are then offered as possible answers in the item selection question.

.. TODO::

Add a screenshot of the item select question.

.. .. figure:: questionnaire/item-select-question.png
.. Item select question with a list of items as possible answers.
View settings
=============
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
project_name_full = 'Data Stewardship Wizard'

# The full version, including alpha/beta/rc tags
version = release = '4.9'
version = release = '4.10'

rst_prolog = f"""
Expand Down
Loading

0 comments on commit 2ccf6a4

Please sign in to comment.