Merge pull request #182 from ds-wizard/release/4.14.0

Release 4.14.0 (develop)

.github/workflows/sphinx.yml

@@ -37,6 +37,10 @@ jobs:
           python -m pip install --upgrade pip
           pip install -r docs/requirements.txt
 
+      - name: Install ImageMagick
+        run: |
+          sudo apt install imagemagick
+
       - name: Run Sphinx
         run: |
           cd docs

docs/application/document-templates/editors/detail/files.rst

@@ -5,7 +5,7 @@ The :guilabel:`Files` tab in :doc:`./index` allows us to manage the files and di
 
 If we select a text file in the file tree, it is opened in the built-in text editor. We can also open multiple files (the editor supports tabs). Moreover, if we have more files opened, we can see a *split view* icon on the top of the file tree. When we click it, it will split the view and move the opened file to the other group. If there are already two groups, it switches the file between the two groups. We can close the file by clicking cross icon in its tab.
 
-We can easily delete files; when it is selected in the file tree, we can simply click the red trash icon above the file tree. The deletion must be confirmed in the prompt so we will not delete something by accident as it is not reversible operation. To delete folder, we must first delete all files and folders in it. Then it disappears from the file tree.
+We can easily delete a file or a folder; when it is selected in the file tree, we can simply click the red trash icon above the file tree. The deletion must be confirmed in the prompt so we will not delete something by accident as it is not reversible operation. If a folder becomes empty, it will be deleted automatically.
 
 With files and folders we can also use move and rename functionalities, both by clicking their respective icons above the file tree. The move functionality is useful when we want to move a file to another folder. The rename functionality is useful when we want to change the name of a file or folder.
 

docs/application/document-templates/editors/detail/preview.rst

@@ -1,12 +1,11 @@
 Preview
 *******
 
-The :guilabel:`Preview` tab of :doc:`./index` allows us to quickly check how our document template works and how the resulting document looks like for a selected project and document format. We can select any **Project** that we are allowed to view. Then, we select the desired **Format** (one of those specified on the :doc:`./settings` tab of the editor). Any change in the template configuration and its files will trigger re-generation of the preview (we can simply click the :guilabel:`Preview` tab again).
-
+The :guilabel:`Preview` tab of :doc:`./index` allows us to quickly check how our document template works and how the resulting document looks like for a selected project and document format. We can select any **project** or **knowledge model editor** that we are allowed to view. Then, we select the desired **Format** (one of those specified on the :doc:`./settings` tab of the editor). Any change in the template configuration and its files will trigger re-generation of the preview (we can simply click the :guilabel:`Preview` tab again). We can also open corresponding project or knowledge model editor in a new tab by clicking the button next to the selected project or knowledge model editor.
 
 .. figure:: preview/preview.png
 
-    Preview in a document template editor (without selected **Project** and **Format**).
+    Preview in a document template editor using project.
 
 
 .. note::

docs/application/knowledge-models/editors/detail/knowledge-model.rst

@@ -70,3 +70,9 @@ The editor checks for some possible problems, such as empty title for a chapter
     :width: 317
 
     Warnings in the knowledge model editor.
+
+
+Development with Document Template Editor
+=========================================
+
+It is possible to develop the knowledge model together with the document template. Any changes to the knowledge model are immediately reflected in the document template editor. In the Preview tab we can also save the current preview answer values to the knowledge model and make them visible in the document template editor.

docs/application/knowledge-models/editors/detail/preview.rst

@@ -8,3 +8,6 @@ We can use :guilabel:`Preview` tab to quickly see how the resulting questionnair
 .. figure:: preview/preview.png
 
     Preview of the resulting questionnaire in the knowledge model editor.
+
+
+If we want to develop the knowledge model together with the document template, we can use the :guilabel:`Save preview values` button. This will save the current preview answer values to the knowledge model and make them visible in the :ref:`document template editor<document-template-editors>`.

docs/application/projects/list/detail/questionnaire.rst

@@ -99,13 +99,13 @@ List of Items Question
 
 List of Items question doesn't have a simple answer but a list of items. Each of the items has the same set of subquestions. For example, a list of items question asking about the project contributors where each item represent one contributor with questions about their name, role, etc.
 
-We can simply click on :guilabel:`Add` button under the question to add a new item. Then, we can answer the questions for the item. If the item has a lot of questions, we can use the arrow icon in the item's top left corner to **fold/unfold** the item. We can also use :guilabel:`Expand all` and :guilabel:`Collapse all` buttons in the question menu to **fold/unfold** all items at once.
+We can simply click on :guilabel:`Add` button under the question to add a new item. Then, we can answer the questions for the item. If the item has a lot of questions, we can use the arrow icon in the item's top left corner to **fold/unfold** the item. We can also use :guilabel:`Expand all` and :guilabel:`Collapse all` buttons in the question menu to **fold/unfold** all items at once. The :guilabel:`Expand all` and :guilabel:`Collapse all` buttons are visible before the listed items if there are at least two items and also below the listed items, if there are more than two items. 
 
 There is a trash bin icon in the item's top right corner that we can use to **delete** the item. If there are more than one item, there are also arrow icons that we can use to **change the order** of the items.
 
 .. figure:: questionnaire/list-of-items-question.png
 
-    List of items question with a single item.
+    List of items question with a multiple items.
 
 
 Value Question
@@ -203,7 +203,7 @@ All of value question types (except for color) can have validations set on them.
 Comments
 ========
 
-We sometimes want to leave comments to discuss things with our team or just reminders for ourselves. We can write comments to each question in the questionnaire.
+We sometimes want to leave comments to discuss things with our team or just reminders for ourselves. We can write comments to each question in the questionnaire. The comments can be browsed using the navigation buttons.
 
 .. figure:: questionnaire/comments.png
     :width: 603

docs/conf.py

@@ -18,14 +18,14 @@
 # -- Project information -----------------------------------------------------
 
 project = 'Data Stewardship Wizard'
-copyright = '2024, DSW Team'
+copyright = '2018 - 2025, DSW Team'
 author = 'DSW Team'
 
 project_name = 'DSW'
 project_name_full = 'Data Stewardship Wizard'
 
 # The full version, including alpha/beta/rc tags
-version = release = '4.13'
+version = release = '4.14'
 
 rst_prolog = f"""
 

docs/more/self-hosted-dsw/upgrade-guidelines.rst

@@ -43,6 +43,11 @@ Usually, nothing special is required for the upgrade. Internal structure changes
 
    Make sure to stop ``document-worker`` and ``mailer`` before upgrading to the next version. Run ``wizard-server`` first, then run the workers. Otherwise the database migrations might not work correctly.
 
+4.13.X to 4.14.X
+----------------
+
+*(nothing)*
+
 4.12.X to 4.13.X
 ----------------