Iss 527 QGIS plugin - project history/changes viewer

REDIRECTS

@@ -30,7 +30,7 @@ https://help.cloudmergin.com/plugin-new-project	https://merginmaps.com/docs/mana
 https://help.cloudmergin.com/plugin-sync-project	https://merginmaps.com/docs/manage/plugin/
 https://help.cloudmergin.com/plugin-variables	https://merginmaps.com/docs/layer/plugin-variables/
 https://help.cloudmergin.com/project-advanced	https://merginmaps.com/docs/manage/project-advanced/
-https://help.cloudmergin.com/project-details	https://merginmaps.com/docs/manage/project-details/
+https://help.cloudmergin.com/project-details	https://merginmaps.com/docs/manage/project-history/
 https://help.cloudmergin.com/quick-start	https://merginmaps.com/docs/tutorials/capturing-first-data/
 https://help.cloudmergin.com/quick-start.html	N/A - covered by non-html version
 https://help.cloudmergin.com/registration	https://merginmaps.com/docs/setup/sign-up-to-mergin-maps/
@@ -144,7 +144,7 @@ https://merginmaps.com/docs/howto/manage/plugin/plugin-variables/	https://mergin
 https://merginmaps.com/docs/howto/manage/troubleshoot/	https://merginmaps.com/docs/misc/troubleshoot/
 https://merginmaps.com/docs/howto/manage/web/dashboard/	https://merginmaps.com/docs/manage/dashboard/
 https://merginmaps.com/docs/howto/manage/web/project-advanced/	https://merginmaps.com/docs/manage/project-advanced/
-https://merginmaps.com/docs/howto/manage/web/project-details/	https://merginmaps.com/docs/manage/project-details/
+https://merginmaps.com/docs/howto/manage/web/project-details/	https://merginmaps.com/docs/manage/project-history/
 https://merginmaps.com/docs/howto/manage/web/register/	https://merginmaps.com/docs/setup/sign-up-to-mergin-maps/
 https://merginmaps.com/docs/howto/manage/web/subscriptions/	https://merginmaps.com/docs/manage/subscriptions/
 https://merginmaps.com/docs/howto/manage/web/web-create-project/	https://merginmaps.com/docs/manage/create-project/
@@ -174,6 +174,7 @@ https://merginmaps.com/docs/layer/settingup_forms/	https://merginmaps.com/docs/l
 https://merginmaps.com/docs/layer/settingup_forms_photo/	https://merginmaps.com/docs/layer/photos/
 https://merginmaps.com/docs/layer/settingup_forms_settings/	https://merginmaps.com/docs/layer/form-configuration/
 https://merginmaps.com/docs/manage/data_sync/	https://merginmaps.com/docs/manage/plugin/
+https://merginmaps.com/docs/manage/project-details/	https://merginmaps.com/docs/manage/project-history/
 https://merginmaps.com/docs/manage/plugin-multi-server-use/	https://merginmaps.com/docs/server/plugin-mobile-app/
 https://merginmaps.com/docs/manage/plugin-sync-project/	https://merginmaps.com/docs/manage/plugin/
 https://merginmaps.com/docs/misc/privacy/	N/A -- handled by https://merginmaps.com/privacy-policy/

src/.vuepress/sidebar/en.js

@@ -45,7 +45,7 @@ module.exports = {
                 '/manage/plugin/',
                 '/manage/dashboard/',
                 '/manage/dashboard-maps/',
-                '/manage/project-details',
+                '/manage/project-history/',
                 '/manage/selective_sync/'
             ]
         }, 

src/index.md

@@ -52,7 +52,7 @@ The ecosystem consist of various components:
 - [<QGISPluginName /> Overview](./manage/plugin/)
 - [Mergin Maps Dashboard](./manage/dashboard/)
 - [Webmaps](./manage/dashboard-maps/)
-- [Project History and Versions](./manage/project-details/)
+- [Project History and Versions](./manage/project-history/)
 - [Selective Synchronisation](./manage/selective_sync/)
 
 ## Setup GIS Project

src/manage/dashboard/index.md

@@ -44,7 +44,7 @@ The **History** tab contains an overview of available project versions that can
 You can click on a specific version to see more details.
 ![Project version details in Mergin Maps dashboard](./mergin-maps-dashboard-project-history-version.jpg "Project version details in Mergin Maps dashboard")
 
-You can learn more about project history and how to revert to an older version in [Project History and Versions](../project-details/).
+You can learn more about project history and how to revert to an older version in [Project History and Versions](../project-history/).
 
 ### Collaborators
 The **Collaborators** tab provides the list of users who have access to the project as well as pending invitations. You can use the **Share** button to invite more people to contribute to your project. 

src/manage/permissions.md

@@ -17,7 +17,7 @@ You can find detailed steps on how to invite users to your workspace in [How to
 ## Workspace member roles and project permissions
 Member roles and project permissions present similar options in terms of what a user can or cannot do. The difference is whether these options are defined on a workspace or on a project level. Compare the overview of [workspace member roles](#workspace-member-roles-overview) and of [project permissions](#project-permissions-overview) for more details.
 
-- **Reader**: Users with **Read** permission are able to see projects, projects data and [history](../project-details), but can not make any changes.
+- **Reader**: Users with **Read** permission are able to see projects, projects data and [history](./project-history/), but can not make any changes.
 - **Editor** (available on <MainPlatformNameLink /> Cloud and <EnterprisePlatformNameLink />): In addition to the **Read** access, users can [add/remove/update features](../field/mobile-features/), but *cannot* make changes in the project properties, add/remove fields in GeoPackage layers or remove GeoPackage files from the project. We recommend using this role for surveyors - users who collect data in the field.
 Editors can:
 	- *add* files such as photos, shapefiles, GeoPackage files - any file except for `*.qgs`, `*.qgz`, `mergin-config.json`

src/manage/plugin/index.md

@@ -34,6 +34,9 @@ The toolbar contains following buttons:
   ![Synchronise changes button](./plugin-toolbar-sync.jpg "Synchronise changes button")
   ![Mergin Maps project status with pending changes](./plugin-project-status.jpg "Mergin Maps project status with pending changes")
 
+- **Project history** to inspect [project history and versions](../project-history/)
+  ![Project history button](./plugin-toolbar-project-history.jpg "Project history button")
+  ![Project history changes viewer](./plugin-history-viewer.jpg "Project history changes viewer")
 
 ## Mergin Maps plugin in QGIS Browser
 
@@ -113,7 +116,7 @@ Use the **Toolbox** icon in the toolbar panel to display **Processing Toolbox**
 
 2. Double click the **Create report** tool. 
 
-   Fill in the parameters in the dialog window. If you want to get the report for a specified range of [versions](../project-details/), define also the start and end version. 
+   Fill in the parameters in the dialog window. If you want to get the report for a specified range of [versions](../project-history/), define also the start and end version. 
 
    Click **Run**.
    ![Create report tool dialog](./plugin-create-report.jpg "Create report tool dialog")

src/manage/project-details.md → src/manage/project-history/index.md

@@ -3,16 +3,34 @@
 
 Each time someone synchronises the project from a mobile device or from QGIS through <QGISPluginName />, a new project version will be created. Thus, it is possible to see the details of the changes made in <MainPlatformNameLink /> project by different users or devices. 
 
-On <AppDomainNameLink />, you can view what files have been added or removed. If you use GeoPackage for your survey, you can also see the list of the features which have been added, deleted or updated.
+Using the <QGISPluginNameShort /> or the <DashboardShortLink />, you can view what files have been added or removed. If you use GeoPackage for your survey, you can also see the list of the features which have been added, deleted or updated.
 
 
-:::tip
+:::tip Project history in QGIS
 Great tools to inspect the project history and compare changes between project versions can be found in the <QGISPluginNameShort />:
-- use [Create report](./plugin/#create-report-processing-toolbox) to get an overview of changes for a range of project versions.
-- use [Create diff](./plugin/#create-diff-processing-toolbox) to extract changes made between two versions of a layer
+- use [Project history](#project-history-in-qgis) to explore changes in the **Changes Viewer**
+- use [Create report](../plugin/#create-report-processing-toolbox) to get an overview of changes for a range of project versions.
+- use [Create diff](../plugin/#create-diff-processing-toolbox) to extract changes made between two versions of a layer
 :::
 
-## Project history and advanced changelog
+## Project history in QGIS
+Project history and version can be inspected using the <QGISPluginName /> by clicking the **Project history** button of the toolbar.
+![Project history button](../plugin/plugin-toolbar-project-history.jpg "Project history button")
+
+The button opens the **Changes Viewer** window. Here, all available project versions are listed in the left panel. By selecting a version you can inspect the *changes* between this and the previous project version (not the state of the project at that version). Note that older versions of your project can be [downloaded through the <DashboardShortLink />](../dashboard/#history).
+
+On the right, you can see some information about the currently selection version: the project size, date of creation and <MainPlatformName /> component that was used to create it. You can switch between the *Changed layers* and *Changed files* tabs.
+
+![Project history changes viewer](../plugin/plugin-history-viewer.jpg) 
+
+Select a layer from the list in the *Changed layers* tab to display its changes on the map along with a colour-coded attributes table (green for insert, yellow for update, red for delete). 
+
+Changes layers can be added to the project to inspect them further or use them to restore deleted or modified data.
+
+![Project history changes viewer](./plugin-changes-viewer-add-to-project.jpg) 
+
+
+## Project history and advanced changelog on the dashboard
 To see the project history:
 1. Log in <AppDomainNameLink /> and go to your project
 2. Navigate to the **History** tab. 
@@ -45,22 +63,22 @@ To see the project history:
 ### How to revert to an older version
 You may find yourself in a situation where you want to revert to an older version of the project.
 
-Local changes made in QGIS (changes that were not synchronised yet) can be reverted by using the **Reset changes** option in [Project status](./synchronisation/#synchronising-changes-in-qgis).
+Local changes made in QGIS (changes that were not synchronised yet) can be reverted by using the **Reset changes** option in [Project status](../synchronisation/#synchronising-changes-in-qgis).
 
 To revert to an older version of a project (already synchronised to the cloud), follow these steps:
 1. Log in <AppDomainNameLink /> and go to your project
-2. Navigate to the [**project history**](#project-history-and-advanced-changelog) and find the version you want to use
+2. Navigate to the [**project history**](#project-history-and-advanced-changelog-on-the-dashboard) and find the version you want to use
 3. **Download** the project version to your computer. Open the project in QGIS to make sure it is the version you want to restore.
    :::tip
    Our blog [Downloading a previous version of your project](https://merginmaps.com/blog/support-tip-downloading-a-previous-version-of-your-project) contains detailed steps on how to download projects that are too large to be downloaded from the <DashboardShortLink />.
    :::
 
 Now you have multiple options:
-- [Package the downloaded project version](./project/#packaging-qgis-project) as a new <MainPlatformName /> project. You can keep both projects if needed or [delete](./project-advanced/#delete-a-project) the one you don't need anymore.
+- [Package the downloaded project version](../project/#packaging-qgis-project) as a new <MainPlatformName /> project. You can keep both projects if needed or [delete](../project-advanced/#delete-a-project) the one you don't need anymore.
 
 - Replace the specific files in your <MainPlatformName /> project folder:
    1. Close QGIS
-   2. Copy the QGIS project (`.qgz`), the data (`.gpkg`) or both from the downloaded older version and paste them to your current [<MainPlatformName /> project folder](./project/#mergin-maps-project-folder). 
+   2. Copy the QGIS project (`.qgz`), the data (`.gpkg`) or both from the downloaded older version and paste them to your current [<MainPlatformName /> project folder](../project/#mergin-maps-project-folder). 
 
 
       :::warning Be careful when doing this! 

src/manage/project/index.md

@@ -52,7 +52,7 @@ Layers that were **kept as is** are not stored in the project folder.
 ![Mergin Maps project folder content](./project-folder.jpg "Mergin Maps project folder content")
 
 There are also some extra folders and files:
-- **`.mergin`** folder contains the `Geodiff` files that are used to keep the [project history and versions](../project-details/) and [diagnostic log](../../misc/troubleshoot/#diagnostic-logs) in a file named `client-log.txt`
+- **`.mergin`** folder contains the `Geodiff` files that are used to keep the [project history and versions](../project-history/) and [diagnostic log](../../misc/troubleshoot/#diagnostic-logs) in a file named `client-log.txt`
 - **`proj`** folder contains, if needed, [custom projections](../../gis/proj/) files
 - [conflict files](../missing-data/#there-are-conflict-files-in-the-folder) may appear if changes could not be properly synchronised
 ![Mergin Maps project folder history log projection conflict files](./folder-tech-files.jpg "Mergin Maps project folder content")

src/tutorials/working-collaboratively/index.md

@@ -73,7 +73,7 @@ If you wish to share a project with more than a handful of users, this method ma
 This tutorial introduced basic ways of sharing your project. Whether you use <MainPlatformNameLink /> to share project with a few friends or collaborate on it with a larger group of coworkers, we recommend to get familiar with the basics about permissions, synchronisation and project management:
 - in [Permissions](../../manage/permissions/) you can learn more about the level of access you can provide to other users
 - [Behind Data Synchronisation](../../manage/synchronisation/) explains the synchronisation process and what happens when multiple users do the field survey in the same time. There is also an option to exclude some files from syncing by using [Selective Synchronisation](../../manage/selective_sync/).
-- [Project History and Versions](../../manage/project-details/) can help you see what was changed, by whom and when
+- [Project History and Versions](../../manage/project-history/) can help you see what was changed, by whom and when
 - useful guides:
    - [How to Share, Transfer or Delete Projects](../../manage/project-advanced/#how-to-share-transfer-or-delete-projects) 
    - [How to Deploy Revised Projects](../../manage/deploy-new-project/)