Merge pull request #542 from ketankartoza/update-doc-step3-4

Update doc step3 4
ConservationInternational · Nov 19, 2024 · a560454 · a560454
2 parents ca65a19 + ca23040
commit a560454
Show file tree

Hide file tree

Showing 29 changed files with 102 additions and 8 deletions.
diff --git a/docs/user/guide/img/manual-priority-layer-dialog-1.png b/docs/user/guide/img/manual-priority-layer-dialog-1.png
diff --git a/docs/user/guide/img/manual-priority-layer-dialog-2.png b/docs/user/guide/img/manual-priority-layer-dialog-2.png
diff --git a/docs/user/guide/img/manual-priority-layer-dialog-3.png b/docs/user/guide/img/manual-priority-layer-dialog-3.png
diff --git a/docs/user/guide/img/manual-priority-layer-dialog-4.png b/docs/user/guide/img/manual-priority-layer-dialog-4.png
diff --git a/docs/user/guide/img/manual-priority-layer-dialog.png b/docs/user/guide/img/manual-priority-layer-dialog.png
diff --git a/docs/user/guide/img/scenario-progress-dialog.png b/docs/user/guide/img/scenario-progress-dialog.png
diff --git a/docs/user/guide/img/step4-1.png b/docs/user/guide/img/step4-1.png
diff --git a/docs/user/guide/img/step4-3.png b/docs/user/guide/img/step4-3.png
diff --git a/docs/user/guide/img/step4-5.png b/docs/user/guide/img/step4-5.png
diff --git a/docs/user/guide/img/step4-6.png b/docs/user/guide/img/step4-6.png
diff --git a/docs/user/guide/img/step4-7.png b/docs/user/guide/img/step4-7.png
diff --git a/docs/user/guide/img/step4-8.png b/docs/user/guide/img/step4-8.png
diff --git a/docs/user/guide/img/step4-layout-designer.png b/docs/user/guide/img/step4-layout-designer.png
diff --git a/docs/user/guide/img/step4-report-pdf.png b/docs/user/guide/img/step4-report-pdf.png
diff --git a/docs/user/guide/step-3.md b/docs/user/guide/step-3.md
@@ -3,7 +3,6 @@
 The final step deals with the **Weighting priorities** and **Priority groups**. These weights will be applied when the user starts running the scenario. An example is shown in **Figure 1**.
 
 - Weight values range from 0 to 5, and affect how important a PWL is compared to other layers.
-
 - A value of 0 indicates that the PWL has a lower importance.
 
 - A value of 5 means that the PWL has a higher importance
@@ -28,26 +27,45 @@ Select the target layer from the priority weighting layers list from its priorit
 - Click on ![add button](img/symbologyAdd.svg) to add a new custom priority layer, or ![edit button](img/mActionToggleEditing.svg) to edit an existing priority layer.
 
 - This will open the Priority Layer dialog (see **Figure 2**).
+
+## Methods to create layers
+
+### Method 1: Create manually
 
 - The following parameters need to be set:
     - **Priority layer**: The layer that represents the priority layer.
     - **Priority layer name**: A unique identifier for the priority layer.
     - **Priority layer description**: A detailed description of the priority layer.
-
+ 
 - Click the **Assign activities** button to select activities to be associated with the priority layer (see **Figure 3**)
 
-![Priority layer editing/adding dialog](img/manual-priority-layer-dialog.png)
+![Priority layer editing/adding dialog](img/manual-priority-layer-dialog-1.png)
 
 *Figure 2: Priority layer dialog*
 
+
 - Select the activities you want to be associated with the priority layer.
 
 - Click **OK**.
-
+  
 ![Priority layer editing/adding dialog](img/manual-pwl-selection.png)
 
 *Figure 3: Activity selection for priority layers*
 
+### Method 2: Create Online
+
+![Priority layer editing/adding dialog](img/manual-priority-layer-dialog-2.png)
+
+- After clicking on this option a drop down menu will appear with the available online defaults. 
+
+![Priority layer editing/adding dialog](img/manual-priority-layer-dialog-3.png)
+
+- Select the desired online default.
+
+![Priority layer editing/adding dialog](img/manual-priority-layer-dialog-4.png)
+
+- Then click on the 1️⃣ `OK` button, to add the priority layer to PWL.
+
 - ![remove button](img/symbologyRemove.svg): Remove the selected PWL.
 
 ## Create a new financial priority layer Net Present Value (NPV)

diff --git a/docs/user/guide/step-4.md b/docs/user/guide/step-4.md
@@ -18,10 +18,42 @@ Click on the 1️⃣ `Step 4` option, to go to Step 4.
 
 ![Processing Options](./img/step4-3.png)
 
-## Run Scenario
+If `Online defaults` is choosen previously then this option will be automatically selected.
 
-**Run Scenario:** Click on the `Run Scenario` button to execute the scenario and generate the report.
+## Run Scenario
 
+**Run Scenario:** Click on the `Run Scenario` button to execute the scenario and generate the report.A  progress bar will appear, showing the status of the processing.
 ![Run Scenario](./img/step4-4.png)
 
+
+**Scenario Progress Dialog:** This dialog box shows the progress of the scenario execution. 
+
+![Scenario-progress-dialog](img/scenario-progress-dialog.png)
+- **Hide** - Hide the dialog box.
+
+After hiding the  dialog box, the `View Online Task Status` button will be enabled to check the status of the task.
+
+![Processing Option](img/step4-5.png)
+
+Click on the  `View Online Task Status` button to check the status of the task.
+
+![Processing Option](img/step4-6.png)
+
+## View Report 
+Once the scenario is processed, you can view the report by clicking on the `View Report` button.
+
+![View Report](img/step4-7.png)
+
+Click on the `View Report` button, it will display a dropdown menu to view the report.
+
+![View Report Dialog](img/step4-8.png)
+
+1. **Layout designer**: Opens the report in the QGIS layout designer.
+
+![Layout Designer](img/step4-layout-designer.png)
+
+2. **Open PDF**: Opens the created PDF.
+
+![Report Pdf](img/step4-report-pdf.png)
+
 Click [here](logs.md) to explore the log section.
diff --git a/docs/user/manual/img/2024-09-20_15-07.png b/docs/user/manual/img/2024-09-20_15-07.png
diff --git a/docs/user/manual/img/manual-priority-layer-dialog.png b/docs/user/manual/img/manual-priority-layer-dialog.png
diff --git a/docs/user/manual/img/manual-processing-dialog.png b/docs/user/manual/img/manual-processing-dialog.png
diff --git a/docs/user/manual/img/step-4-2.png b/docs/user/manual/img/step-4-2.png
diff --git a/docs/user/manual/img/step-4-3.png b/docs/user/manual/img/step-4-3.png
diff --git a/docs/user/manual/img/step-4-4.png b/docs/user/manual/img/step-4-4.png
diff --git a/docs/user/manual/img/step-4-5.png b/docs/user/manual/img/step-4-5.png
diff --git a/docs/user/manual/img/step-4.png b/docs/user/manual/img/step-4.png
diff --git a/docs/user/manual/img/step3-multiple-item-selection.png b/docs/user/manual/img/step3-multiple-item-selection.png
diff --git a/docs/user/manual/img/step3-priority-layer-dialog-1.png b/docs/user/manual/img/step3-priority-layer-dialog-1.png
diff --git a/docs/user/manual/img/step3-priority-layer-dialog-2.png b/docs/user/manual/img/step3-priority-layer-dialog-2.png
diff --git a/docs/user/manual/step-3.md b/docs/user/manual/step-3.md
@@ -20,6 +20,35 @@
 
 - ![edit button](img/mActionToggleEditing.svg): Edit the selected PWL.
 
+## Methods to create layers
+
+### Method 1: Create manually 
+
+- The following parameters need to be set:
+    - **Priority layer**: The layer that represents the priority layer.
+    - **Priority layer name**: A unique identifier for the priority layer.
+    - **Priority layer description**: A detailed description of the priority layer.
+
+- Click the `Assign activities` button to select activities to be associated with the priority layer.
+
+![Priority Layer Dialog](img/step3-priority-layer-dialog-1.png)
+
+
+- Select the activities you want to be associated with the priority layer.
+
+- Click **OK**.
+
+![Multiple Item Selection](img/step3-multiple-item-selection.png)
+
+
+### Method 2: Create Online
+
+Click on the `Online defaults` to select the default priority layer from the available options.
+
+![Priority Layer Dialog](img/step3-priority-layer-dialog-2.png)
+
+- Then click **OK** to add the priority layer to PWL.
+
 ## Financial Priority Weighted Layer Editor dialog
 
 The Net Present Value (NPV) Tool is designed to assist users in making informed financial decisions by evaluating and prioritising activities based on their projected cash flows and the time value of money. This manual provides comprehensive instructions on how to utilise the NPV tool effectively.
@@ -83,6 +112,8 @@ The primary purpose of the NPV Tool is to help users prioritise activities by pr
 
 - **Priority layer**: Select the priority layer.
 
+- **Online Defaults**: Select priority layers from online defaults.
+
 - **Priority layer name**: A unique name for the priority layer.
 
 - **Priority layer description**: A detailed description for the priority layer.
@@ -111,6 +142,8 @@ The primary purpose of the NPV Tool is to help users prioritise activities by pr
 
 - **View Report**: This button will remain disabled until the processing is done.
 
+- **Hide**: This button will hide the  progress dialog.
+
 - **Cancel**: Clicking this button will stop the processing.
 
 - **Close**: Only visible once the processing stops. Will close the progress dialog.

diff --git a/docs/user/manual/step-4.md b/docs/user/manual/step-4.md
@@ -33,6 +33,8 @@ This step is crucial for tailoring the outputs to include only the necessary inf
     ![Processing option](./img/step-4-2.png)
 
     1. **Process the scenario online:** By default, this option is unchecked. When the user selects this option, the scenario is processed online using the API. This means that the system sends the scenario data to a remote server or service via the Internet. The remote server performs the necessary computations or analysis based on the provided scenario data. Processing online allows for real-time analysis and can leverage the computing power and resources available on the remote server. This option might be preferred when the user requires quicker results or when the scenario data is too large or complex to be processed efficiently on the user's local device. However, processing online may require a stable internet connection.
+
+    *If the user has previously selected `Online defaults`, this option will be selected automatically.*
 
 4. **Run Scenario:** 
 
@@ -51,9 +53,18 @@ This step is crucial for tailoring the outputs to include only the necessary inf
         - **Open PDF:** Opens the created PDF.
 
         - **Help:** Takes the user to the User's documentation site.
+
+    3. **Hide:** This  option hides the Progress Dialog Box.
 
-    3. **Cancel:** Click on the `Cancel` button to terminate the report generation process. Upon clicking this button, it will transform into the `Close` button. Click on the `Close` button to dismiss the pop-up window.
+    4. **Cancel:** Click on the `Cancel` button to terminate the report generation process. Upon clicking this button, it will transform into the `Close` button. Click on the `Close` button to dismiss the pop-up window.
 
-    ![Close action](./img/step-4-4.png)
+    ### View Task Status Online
+    After clicking on the `Hide` button this button will be enabled to view the task status.
+
+    ![View Task Online Button](img/step-4-4.png)
+
+    Click on the `View Task Online button` to view the task status.
+
+    ![Processing Dialog](img/step-4-5.png) 
 
 Click [here](logs.md) to explore the log section.