Merge pull request #213 from codevence/develop

Release 4.24 (preview)

Author: krystofkomanec

docs/about/introduction/knowledge-model.rst

@@ -153,7 +153,7 @@ Validation is used to define some rules for the answers in Value question type.
 Reference
 ---------
 
-References are used to provide additional information for :ref:`questions<question>`. There are two types of references. :ref:`Resource page reference<resource-page>` and :ref:`URL reference<url-reference>`. resource page references are gathered in the resource collections.
+References are used to provide additional information for :ref:`questions<question>`. There are three types of references. :ref:`Resource page reference<resource-page>`, :ref:`URL reference<url-reference>`, and :ref:`Cross reference<cross-reference>`. resource page references are gathered in the resource collections.
 
 .. _resource-collection:
 
@@ -176,6 +176,13 @@ 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. URL reference is set up on a level of question, not on a level of knowledge model.
 
+.. _cross-reference:
+
+Cross Reference
+^^^^^^^^^^^^^^^
+
+A cross reference is a link to another question within the same knowledge model. It has **question** which is the referenced question selected from dropdown list and a **description** that describes what the reference is about.
+
 .. _expert:
 
 Expert

docs/applications/admin-center/settings/system/locales/create.rst

@@ -5,7 +5,7 @@ We can create a new locale directly in |project_name| by pressing :guilabel:`Cre
 
 Finally, a POT files can be downloaded here. From them, we can create PO files in a standard (`gettext <https://www.gnu.org/software/gettext/>`__-based) way. There is a POT file for each app of FAIR Wizard and also for the emails.
 
-We can :download:`download localization files here<./create/fw-4-23-0-locales.zip>`.
+We can :download:`download localization files here<./create/fw-4-24-0-locales.zip>`.
 
 .. figure:: create/form.png
 

docs/applications/admin-center/settings/system/locales/create/fw-4-23-0-locales.zip

@@ -11,7 +11,7 @@ Questionnaire is the first tab of the project detail. This is the most important
 Current Phase
 =============
 
-If the :ref:`knowledge model<knowledge-model>` we use for the :ref:`project<project>` has :ref:`phases<phase>` defined, we can see a phase selection in the questionnaire detail. Different questions become desirable based on the selected phase. For example, some should be answered before submitting the proposal, while others can be filled later.
+If the :ref:`knowledge model<knowledge-model>` we use for the :ref:`project<project>` has :ref:`phases<phase>` defined, we can see a phase selection in the questionnaire detail. Different questions become desirable based on the selected phase. For example, some should be answered before submitting the proposal, while others can be filled later. The phase progress is also visible.
 
 .. figure:: questionnaire/phase-selection.png
     :width: 299
@@ -207,6 +207,20 @@ All of value question types (except for color) can have validations set on them.
 
     Warnings referring to questions with invalid values.
 
+.. _todos:
+
+TODOs
+=====
+
+When we are filling in the questionnaire, we can stumble upon a question that we don't know how to answer yet, but we don't want to forget to come back to that question. We can click on :guilabel:`+ Add TODO` to add a TODO to the question.
+
+We can then open the :guilabel:`TODOs` tab from the questionnaire menu to see the list of all questions with assigned TODO in the questionnaire. By clicking on a question there, we can quickly jump back to that question and fill it.
+
+.. figure:: questionnaire/todos.png
+    :width: 334
+    
+    List of TODOs.
+
 
 Comments
 ========
@@ -267,21 +281,6 @@ Editor Notes
 Besides comments there are also editor notes which work the same way as comments but they are visible only to project editors and owners. We can use editor notes to internal communication with our team while working on the DMP and then comments to gather the feedback from supervisor or reviewer.
 
 
-.. _todos:
-
-TODOs
-=====
-
-When we are filling in the questionnaire, we can stumble upon a question that we don't know how to answer yet, but we don't want to forget to come back to that question. We can click on :guilabel:`+ Add TODO` to add a TODO to the question.
-
-We can then open the :guilabel:`TODOs` tab from the questionnaire menu to see the list of all questions with assigned TODO in the questionnaire. By clicking on a question there, we can quickly jump back to that question and fill it.
-
-.. figure:: questionnaire/todos.png
-    :width: 334
-    
-    List of TODOs.
-
-
 Version History
 ===============
 
@@ -325,3 +324,17 @@ We can also revert a questionnaire to an older version. We can simply find the d
 .. WARNING::
 
     Reverting to an older version cannot be undone. It is therefore recommended to create a copy of the project before reverting.
+
+
+Search
+======
+
+Search is accessible from the questionnaire menu bar by clicking on the :guilabel:`🔍` button. A search side panel opens where we can type in our search query. The search works in real-time, so while we are typing, the results are displayed below. We can fulltext search in questions and answers. In questions not only the question name but also description and references. The search is case insensitive.
+
+We can click on any of the search results to quickly navigate to that question in the questionnaire.
+
+.. TODO::
+
+    Add screenshot of the search panel.
+
+    

docs/applications/admin-center/settings/system/locales/create/fw-4-24-0-locales.zip

@@ -26,7 +26,7 @@
 registry_name = 'FAIR Wizard Registry'
 
 # The full version, including alpha/beta/rc tags
-version = release = '4.23'
+version = release = '4.24'
 
 rst_prolog = f"""
 

docs/applications/data-management-planner/projects/list/detail/questionnaire.rst

@@ -426,8 +426,9 @@ get a more specific one and never just a ``Question``.
 
 Aliases:
 
--  ``url_references`` (``list[``\ :ref:`odc-url-reference`\ ``]``)
+-  ``cross_references`` (``list[``\ :ref:`odc-cross-reference`\ ``]``)
 -  ``resource_page_references`` (``list[``\ :ref:`odc-resource-page-reference`\ ``]``)
+-  ``url_references`` (``list[``\ :ref:`odc-url-reference`\ ``]``)
 
 Notes:
 
@@ -561,13 +562,13 @@ As for the :ref:`odc-question` class, ``Reference`` is also a superclass and you
 -  ``type`` (``str``)
 -  ``annotations`` (``dict[str,str]``)
 
-.. _odc-url-reference:
+.. _odc-cross-reference:
 
-URLReference
-''''''''''''
+CrossReference
+''''''''''''''
 
--  ``label`` (``str``)
--  ``url`` (``str``)
+-  ``target_uuid`` (``str``)
+-  ``description`` (``str``)
 
 .. _odc-resource-page-reference:
 
@@ -576,6 +577,14 @@ ResourcePageReference
 
 -  ``resource_page`` (``Optional[``\ :ref:`odc-resource-page`\ ``]``)
 
+.. _odc-url-reference:
+
+URLReference
+''''''''''''
+
+-  ``label`` (``str``)
+-  ``url`` (``str``)
+
 
 .. _odc-resource-collection: