diff --git a/docs/application/administration/locales/detail/detail.png b/docs/application/administration/locales/detail/detail.png index f9dde3f..d748391 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 8c09f1f..2e9adda 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 24f9998..f882312 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 589b110..21b50cd 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/settings/system/features/tours.png b/docs/application/administration/settings/system/features/tours.png index edd4198..649a16f 100644 Binary files a/docs/application/administration/settings/system/features/tours.png and b/docs/application/administration/settings/system/features/tours.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 585c81c..174b41d 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/preview.png b/docs/application/document-templates/editors/detail/preview/preview.png index b60cd55..b427330 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 ceda9ce..bceaeb0 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 3fcef50..5688d8f 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 34ab917..37f1910 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/import/registry.png b/docs/application/document-templates/list/import/registry.png index 9f58e79..625ff67 100644 Binary files a/docs/application/document-templates/list/import/registry.png and b/docs/application/document-templates/list/import/registry.png differ diff --git a/docs/application/document-templates/list/index/list.png b/docs/application/document-templates/list/index/list.png index 7bbc344..61eca40 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/knowledge-models/editors/create/create-km.png b/docs/application/knowledge-models/editors/create/create-km.png index e40096b..803807b 100644 Binary files a/docs/application/knowledge-models/editors/create/create-km.png and b/docs/application/knowledge-models/editors/create/create-km.png differ diff --git a/docs/application/knowledge-models/editors/detail/preview/preview.png b/docs/application/knowledge-models/editors/detail/preview/preview.png index f834f28..c7a1acf 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 9c5e3f4..b7763b2 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/migration/migration.png b/docs/application/knowledge-models/editors/migration/migration.png index 4a13e8a..8409a45 100644 Binary files a/docs/application/knowledge-models/editors/migration/migration.png and b/docs/application/knowledge-models/editors/migration/migration.png differ diff --git a/docs/application/knowledge-models/list/detail/detail.png b/docs/application/knowledge-models/list/detail/detail.png index b0f388b..2cc816f 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/import/registry.png b/docs/application/knowledge-models/list/import/registry.png index a31fae0..2da17f4 100644 Binary files a/docs/application/knowledge-models/list/import/registry.png and b/docs/application/knowledge-models/list/import/registry.png differ diff --git a/docs/application/knowledge-models/list/index.rst b/docs/application/knowledge-models/list/index.rst index 7d9f586..a83cf4f 100644 --- a/docs/application/knowledge-models/list/index.rst +++ b/docs/application/knowledge-models/list/index.rst @@ -13,7 +13,14 @@ For each knowledge model (KM), we can see the latest version in the list. If we - :guilabel:`Fork KM` is again a shortcut for :doc:`../editors/create` for to create a fork (some more specific KM based on this one). - :guilabel:`Create project` is a shortcut to :doc:`../../projects/list/create` with this KM. - :guilabel:`Set deprecated` or :guilabel:`Restore` for setting a KM deprecated when we no longer want the **researchers** to use it. -- :guilabel:`Delete` for all versions of the KM (possible only if is not used in any projects or linked in other KMs and editors). +- :guilabel:`Delete` for all versions of the KM. (Single version can be deleted from the KM's :doc:`./detail` page). + +.. WARNING:: + + It is possible to force delete a KM. Doing so will delete all KM versions, all KM editors based on this KM and all projects based on this KM, as well as all documents and files related to these projects. + + This action is irreversible, so be careful when using it. + If a newer version of the knowledge model is available in the `DSW Registry `__, a yellow :guilabel:`update available` badge, which we can use for quick update of the template to the latest version, will appear. diff --git a/docs/application/knowledge-models/list/index/list.png b/docs/application/knowledge-models/list/index/list.png index 92b8639..b16ff4b 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/knowledge-models/secrets/secrets.png b/docs/application/knowledge-models/secrets/secrets.png index 7ad8172..5f9c609 100644 Binary files a/docs/application/knowledge-models/secrets/secrets.png and b/docs/application/knowledge-models/secrets/secrets.png differ diff --git a/docs/application/profile/about/modal.png b/docs/application/profile/about/modal.png index d826741..54b9457 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/index/menu.png b/docs/application/profile/index/menu.png index c2959f0..7a3445b 100644 Binary files a/docs/application/profile/index/menu.png and b/docs/application/profile/index/menu.png differ diff --git a/docs/application/profile/language/list.png b/docs/application/profile/language/list.png index 1f95984..b7878eb 100644 Binary files a/docs/application/profile/language/list.png and b/docs/application/profile/language/list.png differ diff --git a/docs/application/profile/settings/active-sessions/form.png b/docs/application/profile/settings/active-sessions/form.png index 9c6b9af..1fbabe9 100644 Binary files a/docs/application/profile/settings/active-sessions/form.png and b/docs/application/profile/settings/active-sessions/form.png differ diff --git a/docs/application/projects/importers.rst b/docs/application/projects/importers.rst deleted file mode 100644 index 89e1da0..0000000 --- a/docs/application/projects/importers.rst +++ /dev/null @@ -1,27 +0,0 @@ -.. _importers: - -Importers -********* - -.. WARNING:: - - Project importers are discontinued and will be removed in future releases. Importers are now implemented as plugins, more information on configuration can be found here: :ref:`plugins configuration`. - - We can also develop new plugins, more information on development can be found here: :ref:`plugins development`. - - -We can use project importers to import data from different |project_name| instances or even different applications to |project_name|. Each has a set of supported knowledge models defined. This is because each knowledge model has a different structure and the importer needs to understand it so it can import the answers to the correct questions. - -.. NOTE:: - - Only data stewards or admins can access project importers. - - -If we navigate to :guilabel:`Projects → Importers`, we can see the list of all available importers. We can enable or disable them by clicking on the triple dots icon and choosing the appropriate action. - -.. figure:: importers/importers.png - - List of project importers where we can enable or disable them. - - -More information about how to develop project importers is available on the :ref:`project importers development` page. diff --git a/docs/application/projects/importers/importers.png b/docs/application/projects/importers/importers.png deleted file mode 100644 index aa1f142..0000000 Binary files a/docs/application/projects/importers/importers.png and /dev/null differ diff --git a/docs/application/projects/index.rst b/docs/application/projects/index.rst index 67985f9..92b7fe0 100644 --- a/docs/application/projects/index.rst +++ b/docs/application/projects/index.rst @@ -24,4 +24,3 @@ Projects are mainly used by the researchers. We have the introduction video abou List Files Documents - Importers diff --git a/docs/conf.py b/docs/conf.py index e77a084..92a7826 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -18,14 +18,14 @@ # -- Project information ----------------------------------------------------- project = 'Data Stewardship Wizard' -copyright = '2018 - 2025, DSW Team' +copyright = '2018 - 2026, 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.27' +version = release = '4.28' rst_prolog = f""" diff --git a/docs/more/development/document-templates/dev-notes.rst b/docs/more/development/document-templates/dev-notes.rst index cdadc3b..62fcd3f 100644 --- a/docs/more/development/document-templates/dev-notes.rst +++ b/docs/more/development/document-templates/dev-notes.rst @@ -50,7 +50,21 @@ Styling MS Word Documents **Issue**: CSS and HTML styling is not appearing correctly in MS Word documents (transformed from HTML via the Pandoc step). -**Recommendations**: CSS styles do not affect resulting MS Word documents as that is not possible with Pandoc. The Word document will use the matching styles based on certain HTML tags (e.g. ````, ``<h1>``, ``<p>``, or ``<table>``). You can adjust how those look by creating ``reference.docx`` document with desired styles incl. headers/footers. Ideal way is to download MS Word document generated, adjust styles as needed, and store it as the ``reference.docx`` document. Then, it can be simply added to the document template and used for the :ref:`Pandoc step <document-template-step-pandoc>` via ``args``. Please check directly the `relevant part of the Pandoc documentation <https://pandoc.org/MANUAL.html#option--reference-doc>`_. +**Recommendations**: + +- CSS styles do not affect resulting MS Word documents as that is not possible with Pandoc. The Word document will use the matching styles based on certain HTML tags (e.g. ``<title>``, ``<h1>``, ``<p>``, or ``<table>``). You can adjust how those look by creating ``reference.docx`` document with desired styles incl. headers/footers. Ideal way is to download MS Word document generated, adjust styles as needed, and store it as the ``reference.docx`` document. Then, it can be simply added to the document template and used for the :ref:`Pandoc step <document-template-step-pandoc>` via ``args``. Please check directly the `relevant part of the Pandoc documentation <https://pandoc.org/MANUAL.html#option--reference-doc>`_. +- HTML only supports heading levels up to ``<h6>``, while MS Word supports more levels (up to 9). To set style for >6 level, you can set the style in ``reference.docx`` and use following code: + +.. code:: html + + <div data-custom-style="Heading 7"> + <p>YOUR TITLE</p> + </div> + + +.. note:: + + In the ``reference.docx`` document, you need to go to ``Styles Pane`` and edit the styles there, other methods do not work. See the Pandoc documentation for more details. Compressing Images in MS Word Documents diff --git a/docs/more/development/importers.rst b/docs/more/development/importers.rst deleted file mode 100644 index 98f40cb..0000000 --- a/docs/more/development/importers.rst +++ /dev/null @@ -1,25 +0,0 @@ -.. _development-importers: - -Project Importers Development -***************************** - -.. WARNING:: - - Project importers are discontinued and will be removed in future releases. Importers are now implemented as plugins, more information on configuration can be found here: :ref:`plugins configuration<configuration-plugins>`. - - We can also develop new plugins, more information on development can be found here: :ref:`plugins development<development-plugins>`. - - -Project importers are can be used to import the data from an external resource to |project_name| questionnaire. The importer creates the replies based on the data, therefore it needs to know the structure of the knowledge model it is compatible with. - -We can implement a project importer using `DSW Integration SDK <https://github.com/ds-wizard/dsw-integration-sdk>`_. It is a JavaScript library we can import and use its API for the communication with |project_name|. The installation and usage is described in the SDK readme. - -Example Importers -================= - -There are some importers already implemented. They are a good resource to see how to use the SDK: - - -- `DSW Replies Importer <https://github.com/ds-wizard/dsw-replies-importer>`_ -- `DSW maDMP Importer <https://github.com/ds-wizard/dsw-madmp-importer>`_ - diff --git a/docs/more/development/index.rst b/docs/more/development/index.rst index b84e572..ddc281a 100644 --- a/docs/more/development/index.rst +++ b/docs/more/development/index.rst @@ -19,7 +19,6 @@ This section provides information on how to develop custom content for |project_ metamodel-schemas Document Templates<document-templates/index> integration-questions/index - Project Importers<importers> submission-service Integration via API<api> plugins diff --git a/docs/more/self-hosted-dsw/upgrade-guidelines.rst b/docs/more/self-hosted-dsw/upgrade-guidelines.rst index e7c7e71..cf7f9fe 100644 --- a/docs/more/self-hosted-dsw/upgrade-guidelines.rst +++ b/docs/more/self-hosted-dsw/upgrade-guidelines.rst @@ -46,23 +46,30 @@ 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.27.X to 4.28.X +---------------- + +- **Project Importers** were removed. They can be replaced by :ref:`configuration-plugins`. +- API endpoints in sections related to **Document Templates** and **Knowledge Models** were updated. The primary identifier was changed from ``ID`` to ``UUID``. Please check the API documentation for the new endpoints. +- Due to Document Template changes, it is necessary to migrate Document Templates in S3. You can use this script: https://github.com/ds-wizard/dsw-templates-migration-script + 4.26.X to 4.27.X ---------------- -- API endpoints in the sections related to Locales were updated. The primary identifier was changed from ID to UUID. Please check the API documentation for the new endpoints. -- Due to the locale changes, it is necessary to migrate the locales in S3. You can use this script: https://github.com/ds-wizard/dsw-locale-migration-script +- API endpoints in the sections related to **Locales** were updated. The primary identifier was changed from ``ID`` to ``UUID``. Please check the API documentation for the new endpoints. +- Due to Locale changes, it is necessary to migrate Locales in S3. You can use this script: https://github.com/ds-wizard/dsw-locale-migration-script 4.25.X to 4.26.X ---------------- -- API Endpoints in the sections related to the Questionnaire were renamed to Project to match the DSW UI. Please check the API documentation for the new endpoints. -- Due to changes in the API, it is necessary to rename `questionnaire-files` in S3 to `project-files`. -- Document template metamodel version is raised (from 17.0 to 17.1) due to new type of API Integration in KM and way of versioning document template metamodel, for details check :ref:`document-template-metamodel-versions`. +- API Endpoints in the sections related to **Questionnaire** were renamed to **Project** to match the DSW UI. Please check the API documentation for the new endpoints. +- Due to changes in the API, it is necessary to rename ``questionnaire-files`` in S3 to ``project-files``. +- Document Template metamodel version is raised (from 17.0 to 17.1) due to new type of API Integration in KM and way of versioning document template metamodel, for details check :ref:`document-template-metamodel-versions`. 4.24.X to 4.25.X ---------------- -- API Endpoints in the sections related to the Knowledge Model and the Knowledge Model Editor have been updated. Please check the API documentation for the new endpoints. +- API Endpoints in the sections related to **Knowledge Model** and **Knowledge Model Editor** have been updated. Please check the API documentation for the new endpoints. - All Document Submissions with no Submission service defined will be deleted during migration. This can happen if the Submission service used by the Document Submission was deleted or renamed. - It is necessary to finish all Knowledge Model migrations, either by completing or deleting them, before upgrading. The upgrade will delete any ongoing migrations. @@ -477,122 +484,3 @@ Before updating check following, otherwise the migration will fail: --------------- - Custom DMP templates needs to be upgraded to a new structure (see the default *root* template). - - -Compatibility -============= - -.. Important:: - - |project_name| components (server, client, document worker, mailer, registry) should always use the matching version (compatibility is assured)! - - -The |project_name| is compatible with all recent versions of web browsers Chrome, Opera, Firefox, and Edge. We do not recommend the use of Internet Explorer. - -The following table shows the compatibility of the |project_name| with the metamodel versions of Knowledge models, Document Templates, Project Importers, and the Registry. - -+------------------+--------------+-----------------------------+----------------------------+-----------+ -| Wizard | KM Metamodel | Document Template Metamodel | Project Importer Metamodel | Registry | -+==================+==============+=============================+============================+===========+ -| 3.24.0 | 13 | 11 | 1 | 3.24.0 | -+------------------+--------------+-----------------------------+----------------------------+-----------+ -| 3.23.0 | 13 | 11 | 1 | 3.23.0 | -+------------------+--------------+-----------------------------+----------------------------+-----------+ -| 3.22.0 | 13 | 11 | 1 | 3.22.0 | -+------------------+--------------+-----------------------------+----------------------------+-----------+ -| 3.21.0 | 13 | 11 | 1 | 3.21.0 | -+------------------+--------------+-----------------------------+----------------------------+-----------+ -| 3.20.0 | 13 | 11 | 1 | 3.20.0 | -+------------------+--------------+-----------------------------+----------------------------+-----------+ -| 3.19.0 | 13 | 10 | 1 | 3.19.0 | -+------------------+--------------+-----------------------------+----------------------------+-----------+ -| 3.18.0 | 13 | 10 | 1 | 3.18.0 | -+------------------+--------------+-----------------------------+----------------------------+-----------+ -| 3.17.0 | 13 | 10 | 1 | 3.17.0 | -+------------------+--------------+-----------------------------+----------------------------+-----------+ -| 3.16.0 | 13 | 10 | 1 | 3.16.0 | -+------------------+--------------+-----------------------------+----------------------------+-----------+ -| 3.15.0 | 13 | 10 | 1 | 3.15.0 | -+------------------+--------------+-----------------------------+----------------------------+-----------+ -| 3.14.0 | 13 | 10 | -- | 3.14.0 | -+------------------+--------------+-----------------------------+----------------------------+-----------+ -| 3.13.0 | 13 | 10 | -- | 3.13.0 | -+------------------+--------------+-----------------------------+----------------------------+-----------+ -| 3.12.0 | 13 | 10 | -- | 3.12.0 | -+------------------+--------------+-----------------------------+----------------------------+-----------+ -| 3.11.0 | 12 | 9 | -- | 3.11.0 | -+------------------+--------------+-----------------------------+----------------------------+-----------+ -| 3.10.0 | 12 | 9 | -- | 3.10.0 | -+------------------+--------------+-----------------------------+----------------------------+-----------+ -| 3.9.0 | 11 | 8 | -- | 3.9.0 | -+------------------+--------------+-----------------------------+----------------------------+-----------+ -| 3.8.0 | 11 | 8 | -- | 3.8.0 | -+------------------+--------------+-----------------------------+----------------------------+-----------+ -| 3.7.0 | 10 | 7 | -- | 3.7.0 | -+------------------+--------------+-----------------------------+----------------------------+-----------+ -| 3.6.0 | 10 | 6 | -- | 3.6.0 | -+------------------+--------------+-----------------------------+----------------------------+-----------+ -| 3.5.0 | 9 | 5 | -- | 3.5.0 | -+------------------+--------------+-----------------------------+----------------------------+-----------+ -| 3.4.0 | 8 | 4 | -- | 3.4.0 | -+------------------+--------------+-----------------------------+----------------------------+-----------+ -| 3.3.0 | 8 | 4 | -- | 3.3.0 | -+------------------+--------------+-----------------------------+----------------------------+-----------+ -| 3.2.0 | 8 | 4 | -- | 3.2.0 | -+------------------+--------------+-----------------------------+----------------------------+-----------+ -| 3.1.0 | 7 | 3 | -- | 3.1.0 | -+------------------+--------------+-----------------------------+----------------------------+-----------+ -| 3.0.0 | 7 | 3 | -- | 3.0.0 | -+------------------+--------------+-----------------------------+----------------------------+-----------+ -| 2.14.0 | 7 | 3 | -- | 2.14.0 | -+------------------+--------------+-----------------------------+----------------------------+-----------+ -| 2.13.0 | 7 | 3 | -- | 2.13.0 | -+------------------+--------------+-----------------------------+----------------------------+-----------+ -| 2.12.0 | 6 | 3 | -- | 2.12.0 | -+------------------+--------------+-----------------------------+----------------------------+-----------+ -| 2.11.0 | 5 | 2 | -- | 2.11.0 | -+------------------+--------------+-----------------------------+----------------------------+-----------+ -| 2.10.0 | 5 | 2 | -- | 2.10.0 | -+------------------+--------------+-----------------------------+----------------------------+-----------+ -| 2.9.0 | 5 | 2 | -- | 2.9.0 | -+------------------+--------------+-----------------------------+----------------------------+-----------+ -| 2.8.0 | 5 | 2 | -- | 2.8.0 | -+------------------+--------------+-----------------------------+----------------------------+-----------+ -| 2.7.0 | 5 | 2 | -- | 2.7.0 | -+------------------+--------------+-----------------------------+----------------------------+-----------+ -| 2.6.0 | 5 | 2 | -- | 2.6.0 | -+------------------+--------------+-----------------------------+----------------------------+-----------+ -| 2.5.0 | 5 | 1 | -- | 2.5.0 | -+------------------+--------------+-----------------------------+----------------------------+-----------+ -| 2.4.0 | 5 | -- | -- | 2.4.0 | -+------------------+--------------+-----------------------------+----------------------------+-----------+ -| 2.3.0 | 5 | -- | -- | 2.3.0 | -+------------------+--------------+-----------------------------+----------------------------+-----------+ -| 2.2.0 | 5 | -- | -- | 2.2.0 | -+------------------+--------------+-----------------------------+----------------------------+-----------+ -| 2.1.0 | 5 | -- | -- | 2.1.0 | -+------------------+--------------+-----------------------------+----------------------------+-----------+ -| 2.0.0 | 5 | -- | -- | 2.0.0 | -+------------------+--------------+-----------------------------+----------------------------+-----------+ -| 1.10.0 | 4 | -- | -- | 1.2.0 | -+------------------+--------------+-----------------------------+----------------------------+-----------+ -| 1.9.0 | 3 | -- | -- | 1.1.0 | -+------------------+--------------+-----------------------------+----------------------------+-----------+ -| 1.8.0 | 3 | -- | -- | 1.0.0 | -+------------------+--------------+-----------------------------+----------------------------+-----------+ -| 1.7.0 | 2 | -- | -- | -- | -+------------------+--------------+-----------------------------+----------------------------+-----------+ -| 1.6.0 | 1 | -- | -- | -- | -+------------------+--------------+-----------------------------+----------------------------+-----------+ -| 1.5.0 | -- | -- | -- | -- | -+------------------+--------------+-----------------------------+----------------------------+-----------+ -| 1.4.0 | -- | -- | -- | -- | -+------------------+--------------+-----------------------------+----------------------------+-----------+ -| 1.3.0 | -- | -- | -- | -- | -+------------------+--------------+-----------------------------+----------------------------+-----------+ -| 1.2.0 | -- | -- | -- | -- | -+------------------+--------------+-----------------------------+----------------------------+-----------+ -| 1.1.0 | -- | -- | -- | -- | -+------------------+--------------+-----------------------------+----------------------------+-----------+ -| 1.0.0 | -- | -- | -- | -- | -+------------------+--------------+-----------------------------+----------------------------+-----------+ \ No newline at end of file