kartoza · ketankartoza · Jan 10, 2025
diff --git a/docs/mkdocs-base.yml b/docs/mkdocs-base.yml
@@ -81,6 +81,8 @@ nav:
                   - Log Out: user/manual/logout.md
                   - Password Reset: user/manual/password-reset.md
                   - About: user/manual/about.md
+                  - Map: user/manual/map.md
+                  - Add Biodiversity Data: user/manual/add-biodiversity-data.md
                   - Contact: user/manual/contact.md
                   - Help: user/manual/help.md
                   - Citation: user/manual/citation.md

diff --git a/docs/src/user/manual/add-biodiversity-data.md b/docs/src/user/manual/add-biodiversity-data.md
@@ -0,0 +1,142 @@
+---
+title: BIMS Documentation
+summary: Central documentation site for BIMS projects
+    - Tim Sutton
+    - Jeremy Prior
+    - Ketan Bamniya
+date: 26-09-2023
+some_url: https://github.com/kartoza/bims-website
+copyright: Copyright 2023, Kartoza
+contact: 
+license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.
+#context_id: 1234
+---
+
+# Add Biodiversity Data
+
+[![Add Data 1](./img/add-biodiversity-data-img-1.png)](./img/add-biodiversity-data-img-1.png)
+
+1. **Site Code:** This is the site code of the corresponding site to which the user is going to add data.
+
+2. **X:** Users can click on this button to close the form.
+
+3. **➕ and ➖:** Users can use these button to zoom in and zoom out on the map.
+
+4. **Location Indicator:** This is showing the location of the site on the map.
+
+5. **Longitude and Latitude:** These are the coordinates of the location of the site on the map.
+
+6. **Update Coordinate:** Users can update the site's coordinates by inputting the new longitude and latitude values into the respective fields and clicking on this button to save the changes.
+
+7. **Data:** This is the date when the data was added.
+
+8. **Owner:** Owner of the data.
+
+9. **End Embargo Period:** This is the date when the data will be available for public access.
+
+10. **Broad Biotope / Habitat:** Select the type of overarching biotope or habitat characterising the site from the drop-down menu.
+
+11. **Specific Biotope:** Select the specific biotope from the drop-down menu.
+
+12. **Substratum:** Select the type of substratum from the drop-down menu.
+
+13. **Sampling Method:** Select the sampling method from the drop-down menu.
+
+[![Add Data 1](./img/add-biodiversity-data-img-2.png)](./img/add-biodiversity-data-img-2.png)
+
+1. **Sampling Effort:** Users can input the sampling effort in the respective field.
+
+2. **Record type:** Select the type of record from the drop-down menu.
+
+3. **Site Image:** Users can upload an image of the site by clicking on this field. This action will open the file explorer, where users can navigate to the desired file, select it, and then click the `Select` button to upload the image.
+
+4. **Selected Source Reference:** This contains the selected source reference.
+
+5. **Choose Source Reference:** This section contains the source reference options.
+
+    [![Source Reference](./img/add-biodiversity-data-img-3.png)](./img/add-biodiversity-data-img-3.png)
+
+    1 **Search:** Users can search for a source reference by inputting the name in the search bar.
+
+    2 **Dropdown menu:** Users can filter the sources by selecting the type of source from the dropdown menu.
+
+    3 **Authors:** Users can filter the by entering the authors' names in the search bar.
+
+    4 **Add Source Reference:** Users can add a new source reference by clicking on this button. For more information, please refer to the [Add Source Reference](./source-reference-page.md#add-source-reference) page.
+
+    5 **Select:** Users can select the source reference by clicking on the `Select` button.
+
+    6 **Pagination:** Users can navigate through the list of source references by clicking on the pagination buttons.
+
+[![Taxon 1](./img/add-biodiversity-data-img-4.png)](./img/add-biodiversity-data-img-4.png)
+
+1. **Add Taxon:** Users can add taxon by clicking on this button.
+
+2. **Add New Taxon:** Users can add a new taxon by clicking on this button.
+
+    [![Add New Taxon](./img/add-biodiversity-data-img-10.png)](./img/add-biodiversity-data-img-10.png)
+
+    1 **Search:** Users can search for a taxon by inputting the name in the search bar.
+
+    2 **Find:** After entering the name in search bar, users can click on the `Find` button to search for the taxon.
+
+    3 **Add:** Users can add the taxon by clicking on the `Add` button.
+
+    4 **Close:** Users can close the taxon search window by clicking on the `Close` button.
+
+3. **Taxa:** This is the column heading, indicating that this column contains the list of taxa.
+
+4. **Observed:** Users can check the box to indicate that the taxon was observed.
+
+5. **Abundance:** Users can input the abundance of the taxon in the respective field and select the unit from the drop-down menu.
+
+[![Taxon 2](./img/add-biodiversity-data-img-5.png)](./img/add-biodiversity-data-img-5.png)
+
+1. **Checkbox:** Check this checkbox to accept the agreement.
+
+2. **Next:** Click on this button to proceed to the next step.
+
+* After clicking the `Next` button, the user will receive an alert asking them to confirm whether they want to proceed with the data entry.
+
+[![Alert](./img/add-biodiversity-data-img-6.png)](./img/add-biodiversity-data-img-6.png)
+
+* **Cancel:** Users can cancel the process by clicking on this button.
+
+* **Submit:** Users can confirm the data entry by clicking on this button.
+
+    [![Error](./img/add-biodiversity-data-img-7.png)](./img/add-biodiversity-data-img-7.png)
+
+    * **Error:** If users forgot to fill in any of the required fields, they will receive an error message.
+
+    * After successfully submitting the form users will be redirected to the next from.
+
+        [![Add New Data](./img/add-biodiversity-data-img-8.png)](./img/add-biodiversity-data-img-8.png)
+
+        - Users are required to fill in the necessary fields again, scroll to the bottom, and check the box to accept the agreement. Then, click the `Next` button to proceed to the next step.
+
+After completing the process, the data will be added to the database.
+
+[![New Data](./img/add-biodiversity-data-img-9.png)](./img/add-biodiversity-data-img-9.png)
+
+1. **[![Eye Icon](./img/add-biodiversity-data-img-11.png)](./img/add-biodiversity-data-img-11.png):** Users can view the newly added data by clicking on this button.
+
+    [![View Data](./img/add-biodiversity-data-img-13.png)](./img/add-biodiversity-data-img-13.png)
+
+    1 **Edit:** Allows users to edit the data.
+
+    2 **Delete:** This option allows users to delete the data. Upon clicking the `Delete` button, users will be prompted to confirm their decision to proceed with the deletion or cancel the process.
+
+    [![Alert](./img/add-biodiversity-data-img-14.png)](./img/add-biodiversity-data-img-14.png)
+
+    * **Cancel:** Users can cancel the deletion process by clicking on this button.
+
+    * **Delete:** Users can confirm the deletion by clicking on this button.
+
+2. **[![Remove Icon](./img/add-biodiversity-data-img-12.png)](./img/add-biodiversity-data-img-12.png):** Users can delete the newly added data by clicking on this button.
+
+    [![Alert](./img/add-biodiversity-data-img-14.png)](./img/add-biodiversity-data-img-14.png)
+
+    * **Cancel:** Users can cancel the deletion process by clicking on this button.
+
+    * **Delete:** Users can confirm the deletion by clicking on this button.
+
diff --git a/docs/src/user/manual/img/add-biodiversity-data-img-1.png b/docs/src/user/manual/img/add-biodiversity-data-img-1.png
diff --git a/docs/src/user/manual/img/add-biodiversity-data-img-10.png b/docs/src/user/manual/img/add-biodiversity-data-img-10.png
diff --git a/docs/src/user/manual/img/add-biodiversity-data-img-11.png b/docs/src/user/manual/img/add-biodiversity-data-img-11.png
diff --git a/docs/src/user/manual/img/add-biodiversity-data-img-12.png b/docs/src/user/manual/img/add-biodiversity-data-img-12.png
diff --git a/docs/src/user/manual/img/add-biodiversity-data-img-13.png b/docs/src/user/manual/img/add-biodiversity-data-img-13.png
diff --git a/docs/src/user/manual/img/add-biodiversity-data-img-14.png b/docs/src/user/manual/img/add-biodiversity-data-img-14.png
diff --git a/docs/src/user/manual/img/add-biodiversity-data-img-2.png b/docs/src/user/manual/img/add-biodiversity-data-img-2.png
diff --git a/docs/src/user/manual/img/add-biodiversity-data-img-3.png b/docs/src/user/manual/img/add-biodiversity-data-img-3.png
diff --git a/docs/src/user/manual/img/add-biodiversity-data-img-4.png b/docs/src/user/manual/img/add-biodiversity-data-img-4.png
diff --git a/docs/src/user/manual/img/add-biodiversity-data-img-5.png b/docs/src/user/manual/img/add-biodiversity-data-img-5.png
diff --git a/docs/src/user/manual/img/add-biodiversity-data-img-6.png b/docs/src/user/manual/img/add-biodiversity-data-img-6.png
diff --git a/docs/src/user/manual/img/add-biodiversity-data-img-7.png b/docs/src/user/manual/img/add-biodiversity-data-img-7.png
diff --git a/docs/src/user/manual/img/add-biodiversity-data-img-8.png b/docs/src/user/manual/img/add-biodiversity-data-img-8.png
diff --git a/docs/src/user/manual/img/add-biodiversity-data-img-9.png b/docs/src/user/manual/img/add-biodiversity-data-img-9.png
diff --git a/docs/src/user/manual/img/map-img-1.png b/docs/src/user/manual/img/map-img-1.png
diff --git a/docs/src/user/manual/img/map-img-10.png b/docs/src/user/manual/img/map-img-10.png
diff --git a/docs/src/user/manual/img/map-img-11.png b/docs/src/user/manual/img/map-img-11.png
diff --git a/docs/src/user/manual/img/map-img-12.png b/docs/src/user/manual/img/map-img-12.png
diff --git a/docs/src/user/manual/img/map-img-13.png b/docs/src/user/manual/img/map-img-13.png
diff --git a/docs/src/user/manual/img/map-img-14.png b/docs/src/user/manual/img/map-img-14.png
diff --git a/docs/src/user/manual/img/map-img-15.png b/docs/src/user/manual/img/map-img-15.png
diff --git a/docs/src/user/manual/img/map-img-16.png b/docs/src/user/manual/img/map-img-16.png
diff --git a/docs/src/user/manual/img/map-img-17.png b/docs/src/user/manual/img/map-img-17.png
diff --git a/docs/src/user/manual/img/map-img-18.png b/docs/src/user/manual/img/map-img-18.png
diff --git a/docs/src/user/manual/img/map-img-19.png b/docs/src/user/manual/img/map-img-19.png
diff --git a/docs/src/user/manual/img/map-img-2.png b/docs/src/user/manual/img/map-img-2.png
diff --git a/docs/src/user/manual/img/map-img-20.png b/docs/src/user/manual/img/map-img-20.png
diff --git a/docs/src/user/manual/img/map-img-21.png b/docs/src/user/manual/img/map-img-21.png
diff --git a/docs/src/user/manual/img/map-img-22.png b/docs/src/user/manual/img/map-img-22.png
diff --git a/docs/src/user/manual/img/map-img-23.png b/docs/src/user/manual/img/map-img-23.png
diff --git a/docs/src/user/manual/img/map-img-24.png b/docs/src/user/manual/img/map-img-24.png
diff --git a/docs/src/user/manual/img/map-img-25.png b/docs/src/user/manual/img/map-img-25.png
diff --git a/docs/src/user/manual/img/map-img-26.png b/docs/src/user/manual/img/map-img-26.png
diff --git a/docs/src/user/manual/img/map-img-27.png b/docs/src/user/manual/img/map-img-27.png
diff --git a/docs/src/user/manual/img/map-img-28.png b/docs/src/user/manual/img/map-img-28.png
diff --git a/docs/src/user/manual/img/map-img-29.png b/docs/src/user/manual/img/map-img-29.png
diff --git a/docs/src/user/manual/img/map-img-3.png b/docs/src/user/manual/img/map-img-3.png
diff --git a/docs/src/user/manual/img/map-img-30.png b/docs/src/user/manual/img/map-img-30.png
diff --git a/docs/src/user/manual/img/map-img-31.png b/docs/src/user/manual/img/map-img-31.png
diff --git a/docs/src/user/manual/img/map-img-32.png b/docs/src/user/manual/img/map-img-32.png
diff --git a/docs/src/user/manual/img/map-img-33.png b/docs/src/user/manual/img/map-img-33.png
diff --git a/docs/src/user/manual/img/map-img-34.png b/docs/src/user/manual/img/map-img-34.png
diff --git a/docs/src/user/manual/img/map-img-35.png b/docs/src/user/manual/img/map-img-35.png
diff --git a/docs/src/user/manual/img/map-img-36.png b/docs/src/user/manual/img/map-img-36.png
diff --git a/docs/src/user/manual/img/map-img-37.png b/docs/src/user/manual/img/map-img-37.png
diff --git a/docs/src/user/manual/img/map-img-38.png b/docs/src/user/manual/img/map-img-38.png
diff --git a/docs/src/user/manual/img/map-img-39.png b/docs/src/user/manual/img/map-img-39.png
diff --git a/docs/src/user/manual/img/map-img-4.png b/docs/src/user/manual/img/map-img-4.png
diff --git a/docs/src/user/manual/img/map-img-40.png b/docs/src/user/manual/img/map-img-40.png
diff --git a/docs/src/user/manual/img/map-img-41.png b/docs/src/user/manual/img/map-img-41.png
diff --git a/docs/src/user/manual/img/map-img-42.png b/docs/src/user/manual/img/map-img-42.png
diff --git a/docs/src/user/manual/img/map-img-43.png b/docs/src/user/manual/img/map-img-43.png
diff --git a/docs/src/user/manual/img/map-img-44.png b/docs/src/user/manual/img/map-img-44.png
diff --git a/docs/src/user/manual/img/map-img-45.png b/docs/src/user/manual/img/map-img-45.png
diff --git a/docs/src/user/manual/img/map-img-46.png b/docs/src/user/manual/img/map-img-46.png
diff --git a/docs/src/user/manual/img/map-img-47.png b/docs/src/user/manual/img/map-img-47.png
diff --git a/docs/src/user/manual/img/map-img-5.png b/docs/src/user/manual/img/map-img-5.png
diff --git a/docs/src/user/manual/img/map-img-6.png b/docs/src/user/manual/img/map-img-6.png
diff --git a/docs/src/user/manual/img/map-img-7.png b/docs/src/user/manual/img/map-img-7.png
diff --git a/docs/src/user/manual/img/map-img-8.png b/docs/src/user/manual/img/map-img-8.png
diff --git a/docs/src/user/manual/img/map-img-9.png b/docs/src/user/manual/img/map-img-9.png
diff --git a/docs/src/user/manual/index.md b/docs/src/user/manual/index.md
@@ -30,6 +30,8 @@ you may prefer to work through our [user guide](../guide/index.md).
 
 **[About](./about.md):** This provides a walkthrough of the about page.
 
+**[Map](./map.md):** This provides a walkthrough of the map page.
+
 **[Contact](./contact.md):** This provides a walkthrough of the contact page.
 
 **[Help](./help.md):** This provides a walkthrough of the help page.