diff --git a/.github/workflows/sphinx.yml b/.github/workflows/sphinx.yml index 4974816c..13d82c59 100644 --- a/.github/workflows/sphinx.yml +++ b/.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 diff --git a/docs/application/administration/locales/detail/detail.png b/docs/application/administration/locales/detail/detail.png index 50b3de3a..ff2824f7 100644 Binary files a/docs/application/administration/locales/detail/detail.png and b/docs/application/administration/locales/detail/detail.png differ diff --git a/docs/application/administration/locales/import/registry.png b/docs/application/administration/locales/import/registry.png index 72bd6484..fd2d4d45 100644 Binary files a/docs/application/administration/locales/import/registry.png and b/docs/application/administration/locales/import/registry.png differ diff --git a/docs/application/administration/locales/index/list.png b/docs/application/administration/locales/index/list.png index 22034098..c6ed4e84 100644 Binary files a/docs/application/administration/locales/index/list.png and b/docs/application/administration/locales/index/list.png differ diff --git a/docs/application/administration/settings/info/usage/usage.png b/docs/application/administration/settings/info/usage/usage.png index f129e6c0..416e5827 100644 Binary files a/docs/application/administration/settings/info/usage/usage.png and b/docs/application/administration/settings/info/usage/usage.png differ diff --git a/docs/application/administration/users/detail/profile.png b/docs/application/administration/users/detail/profile.png index 711adf38..28da29b2 100644 Binary files a/docs/application/administration/users/detail/profile.png and b/docs/application/administration/users/detail/profile.png differ diff --git a/docs/application/administration/users/index/list.png b/docs/application/administration/users/index/list.png index 4316d929..ac3c7a17 100644 Binary files a/docs/application/administration/users/index/list.png and b/docs/application/administration/users/index/list.png differ diff --git a/docs/application/document-templates/editors/detail/files.rst b/docs/application/document-templates/editors/detail/files.rst index 6a0cdac4..b8bef0b5 100644 --- a/docs/application/document-templates/editors/detail/files.rst +++ b/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. diff --git a/docs/application/document-templates/editors/detail/files/files.png b/docs/application/document-templates/editors/detail/files/files.png index 94edecc2..161cf727 100644 Binary files a/docs/application/document-templates/editors/detail/files/files.png and b/docs/application/document-templates/editors/detail/files/files.png differ diff --git a/docs/application/document-templates/editors/detail/index/editor.png b/docs/application/document-templates/editors/detail/index/editor.png index db28929b..f70fab5c 100644 Binary files a/docs/application/document-templates/editors/detail/index/editor.png and b/docs/application/document-templates/editors/detail/index/editor.png differ diff --git a/docs/application/document-templates/editors/detail/preview.rst b/docs/application/document-templates/editors/detail/preview.rst index 2a28fed0..37ab7659 100644 --- a/docs/application/document-templates/editors/detail/preview.rst +++ b/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:: diff --git a/docs/application/document-templates/editors/detail/preview/preview.png b/docs/application/document-templates/editors/detail/preview/preview.png index c466485d..dd9b1101 100644 Binary files a/docs/application/document-templates/editors/detail/preview/preview.png and b/docs/application/document-templates/editors/detail/preview/preview.png differ diff --git a/docs/application/document-templates/editors/detail/template/formats.png b/docs/application/document-templates/editors/detail/template/formats.png index 9256ab8b..1a5710e5 100644 Binary files a/docs/application/document-templates/editors/detail/template/formats.png and b/docs/application/document-templates/editors/detail/template/formats.png differ diff --git a/docs/application/document-templates/editors/index/list.png b/docs/application/document-templates/editors/index/list.png index 6b32dd9e..be2c7a1e 100644 Binary files a/docs/application/document-templates/editors/index/list.png and b/docs/application/document-templates/editors/index/list.png differ diff --git a/docs/application/document-templates/list/detail/detail.png b/docs/application/document-templates/list/detail/detail.png index 8056dd31..24de3e4f 100644 Binary files a/docs/application/document-templates/list/detail/detail.png and b/docs/application/document-templates/list/detail/detail.png differ diff --git a/docs/application/document-templates/list/index/list.png b/docs/application/document-templates/list/index/list.png index 190255c8..c2870b8f 100644 Binary files a/docs/application/document-templates/list/index/list.png and b/docs/application/document-templates/list/index/list.png differ diff --git a/docs/application/documents/index/list.png b/docs/application/documents/index/list.png index 1c3e74b8..15fc6fb8 100644 Binary files a/docs/application/documents/index/list.png and b/docs/application/documents/index/list.png differ diff --git a/docs/application/knowledge-models/editors/detail/knowledge-model.rst b/docs/application/knowledge-models/editors/detail/knowledge-model.rst index 3c6d4774..147d2237 100644 --- a/docs/application/knowledge-models/editors/detail/knowledge-model.rst +++ b/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. diff --git a/docs/application/knowledge-models/editors/detail/preview.rst b/docs/application/knowledge-models/editors/detail/preview.rst index 8b7c04ec..fa291807 100644 --- a/docs/application/knowledge-models/editors/detail/preview.rst +++ b/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`. diff --git a/docs/application/knowledge-models/editors/detail/preview/preview.png b/docs/application/knowledge-models/editors/detail/preview/preview.png index e1317f84..e51411d0 100644 Binary files a/docs/application/knowledge-models/editors/detail/preview/preview.png and b/docs/application/knowledge-models/editors/detail/preview/preview.png differ diff --git a/docs/application/knowledge-models/editors/detail/settings/settings-form.png b/docs/application/knowledge-models/editors/detail/settings/settings-form.png index 85e73cd6..720e761d 100644 Binary files a/docs/application/knowledge-models/editors/detail/settings/settings-form.png and b/docs/application/knowledge-models/editors/detail/settings/settings-form.png differ diff --git a/docs/application/knowledge-models/editors/index/knowledge-model-editors-list.png b/docs/application/knowledge-models/editors/index/knowledge-model-editors-list.png index d14a33e8..0ed5d974 100644 Binary files a/docs/application/knowledge-models/editors/index/knowledge-model-editors-list.png and b/docs/application/knowledge-models/editors/index/knowledge-model-editors-list.png differ diff --git a/docs/application/knowledge-models/list/detail/detail.png b/docs/application/knowledge-models/list/detail/detail.png index d4f07258..851c67ef 100644 Binary files a/docs/application/knowledge-models/list/detail/detail.png and b/docs/application/knowledge-models/list/detail/detail.png differ diff --git a/docs/application/knowledge-models/list/index/list.png b/docs/application/knowledge-models/list/index/list.png index 7aa92063..5b55c6a7 100644 Binary files a/docs/application/knowledge-models/list/index/list.png and b/docs/application/knowledge-models/list/index/list.png differ diff --git a/docs/application/profile/about/modal.png b/docs/application/profile/about/modal.png index 3a19be9a..6feb205f 100644 Binary files a/docs/application/profile/about/modal.png and b/docs/application/profile/about/modal.png differ diff --git a/docs/application/profile/assigned-comments/list.png b/docs/application/profile/assigned-comments/list.png index 82ea4772..1265018c 100644 Binary files a/docs/application/profile/assigned-comments/list.png and b/docs/application/profile/assigned-comments/list.png differ diff --git a/docs/application/profile/edit/active-sessions/form.png b/docs/application/profile/edit/active-sessions/form.png index c9c4d4d5..0fb850c5 100644 Binary files a/docs/application/profile/edit/active-sessions/form.png and b/docs/application/profile/edit/active-sessions/form.png differ diff --git a/docs/application/profile/edit/index/form.png b/docs/application/profile/edit/index/form.png index c59f38e8..8ceac088 100644 Binary files a/docs/application/profile/edit/index/form.png and b/docs/application/profile/edit/index/form.png differ diff --git a/docs/application/profile/index/menu.png b/docs/application/profile/index/menu.png index 8ee5c046..2c25b631 100644 Binary files a/docs/application/profile/index/menu.png and b/docs/application/profile/index/menu.png differ diff --git a/docs/application/projects/list/detail/documents/list.png b/docs/application/projects/list/detail/documents/list.png index 11b3663a..7e0a5066 100644 Binary files a/docs/application/projects/list/detail/documents/list.png and b/docs/application/projects/list/detail/documents/list.png differ diff --git a/docs/application/projects/list/detail/documents/new.png b/docs/application/projects/list/detail/documents/new.png index 98394ecf..cf49cef4 100644 Binary files a/docs/application/projects/list/detail/documents/new.png and b/docs/application/projects/list/detail/documents/new.png differ diff --git a/docs/application/projects/list/detail/files/files.png b/docs/application/projects/list/detail/files/files.png index fc0dbb3b..b0e4dd21 100644 Binary files a/docs/application/projects/list/detail/files/files.png and b/docs/application/projects/list/detail/files/files.png differ diff --git a/docs/application/projects/list/detail/index/questionnaire.png b/docs/application/projects/list/detail/index/questionnaire.png index 647518ae..7b1f6108 100644 Binary files a/docs/application/projects/list/detail/index/questionnaire.png and b/docs/application/projects/list/detail/index/questionnaire.png differ diff --git a/docs/application/projects/list/detail/metrics/metrics.png b/docs/application/projects/list/detail/metrics/metrics.png index 015596b0..424157e6 100644 Binary files a/docs/application/projects/list/detail/metrics/metrics.png and b/docs/application/projects/list/detail/metrics/metrics.png differ diff --git a/docs/application/projects/list/detail/preview/document-template-not-set.png b/docs/application/projects/list/detail/preview/document-template-not-set.png index cc58822d..64b0b44a 100644 Binary files a/docs/application/projects/list/detail/preview/document-template-not-set.png and b/docs/application/projects/list/detail/preview/document-template-not-set.png differ diff --git a/docs/application/projects/list/detail/preview/download.png b/docs/application/projects/list/detail/preview/download.png index 50703a5d..d6fdaf3c 100644 Binary files a/docs/application/projects/list/detail/preview/download.png and b/docs/application/projects/list/detail/preview/download.png differ diff --git a/docs/application/projects/list/detail/preview/preview-html.png b/docs/application/projects/list/detail/preview/preview-html.png index 385becb5..aa2fb823 100644 Binary files a/docs/application/projects/list/detail/preview/preview-html.png and b/docs/application/projects/list/detail/preview/preview-html.png differ diff --git a/docs/application/projects/list/detail/questionnaire.rst b/docs/application/projects/list/detail/questionnaire.rst index 966ab35e..a097bb62 100644 --- a/docs/application/projects/list/detail/questionnaire.rst +++ b/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 diff --git a/docs/application/projects/list/detail/questionnaire/comments.png b/docs/application/projects/list/detail/questionnaire/comments.png index 321606e9..a5c09df3 100644 Binary files a/docs/application/projects/list/detail/questionnaire/comments.png and b/docs/application/projects/list/detail/questionnaire/comments.png differ diff --git a/docs/application/projects/list/detail/questionnaire/list-of-items-question.png b/docs/application/projects/list/detail/questionnaire/list-of-items-question.png index 661a2929..01eff357 100644 Binary files a/docs/application/projects/list/detail/questionnaire/list-of-items-question.png and b/docs/application/projects/list/detail/questionnaire/list-of-items-question.png differ diff --git a/docs/application/projects/list/detail/questionnaire/multi-choice-question.png b/docs/application/projects/list/detail/questionnaire/multi-choice-question.png index 65e9c983..cea303d3 100644 Binary files a/docs/application/projects/list/detail/questionnaire/multi-choice-question.png and b/docs/application/projects/list/detail/questionnaire/multi-choice-question.png differ diff --git a/docs/application/projects/list/detail/questionnaire/options-question.png b/docs/application/projects/list/detail/questionnaire/options-question.png index f5e8c590..2405beda 100644 Binary files a/docs/application/projects/list/detail/questionnaire/options-question.png and b/docs/application/projects/list/detail/questionnaire/options-question.png differ diff --git a/docs/application/projects/list/detail/questionnaire/todos.png b/docs/application/projects/list/detail/questionnaire/todos.png index 846159c7..3a1a8208 100644 Binary files a/docs/application/projects/list/detail/questionnaire/todos.png and b/docs/application/projects/list/detail/questionnaire/todos.png differ diff --git a/docs/application/projects/list/detail/questionnaire/version-history.png b/docs/application/projects/list/detail/questionnaire/version-history.png index 50af6452..af43b6d9 100644 Binary files a/docs/application/projects/list/detail/questionnaire/version-history.png and b/docs/application/projects/list/detail/questionnaire/version-history.png differ diff --git a/docs/application/projects/list/detail/questionnaire/warnings.png b/docs/application/projects/list/detail/questionnaire/warnings.png index bcdda83a..d0c11db0 100644 Binary files a/docs/application/projects/list/detail/questionnaire/warnings.png and b/docs/application/projects/list/detail/questionnaire/warnings.png differ diff --git a/docs/application/projects/list/detail/settings/settings.png b/docs/application/projects/list/detail/settings/settings.png index ad24e895..2509a500 100644 Binary files a/docs/application/projects/list/detail/settings/settings.png and b/docs/application/projects/list/detail/settings/settings.png differ diff --git a/docs/application/projects/list/detail/sharing/share-modal.png b/docs/application/projects/list/detail/sharing/share-modal.png index 0968b684..c0e6e1d4 100644 Binary files a/docs/application/projects/list/detail/sharing/share-modal.png and b/docs/application/projects/list/detail/sharing/share-modal.png differ diff --git a/docs/application/projects/list/index/project-list.png b/docs/application/projects/list/index/project-list.png index 69446e19..0dee00ef 100644 Binary files a/docs/application/projects/list/index/project-list.png and b/docs/application/projects/list/index/project-list.png differ diff --git a/docs/application/projects/list/migration/create.png b/docs/application/projects/list/migration/create.png index 84a38cde..1d47bc09 100644 Binary files a/docs/application/projects/list/migration/create.png and b/docs/application/projects/list/migration/create.png differ diff --git a/docs/application/projects/list/migration/migration.png b/docs/application/projects/list/migration/migration.png index 9bd1f371..3458eee6 100644 Binary files a/docs/application/projects/list/migration/migration.png and b/docs/application/projects/list/migration/migration.png differ diff --git a/docs/conf.py b/docs/conf.py index 44c5bda0..556d3df3 100644 --- a/docs/conf.py +++ b/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""" diff --git a/docs/more/self-hosted-dsw/upgrade-guidelines.rst b/docs/more/self-hosted-dsw/upgrade-guidelines.rst index e94ef8bd..92d566df 100644 --- a/docs/more/self-hosted-dsw/upgrade-guidelines.rst +++ b/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 ----------------