From 3d63357534e02da201158ab403ee22cbcf20ba7e Mon Sep 17 00:00:00 2001
From: stefan <stefan.strobel@shimatta.net>
Date: Sun, 17 Nov 2024 21:44:30 +0100
Subject: [PATCH] made the readme and example for the CSV import accessible
 from the form directly

---
 .../static/example/import_csv/import_csv.csv     |  0
 .../static/example}/import_csv/readme.md         |  0
 shimatta_kenkyusho/templates/base.html           |  5 +++++
 .../parts/modals/import-component-modal.html     | 16 ++++++++++++++++
 4 files changed, 21 insertions(+)
 rename examples/import_csv/add_comps.csv => shimatta_kenkyusho/static/example/import_csv/import_csv.csv (100%)
 rename {examples => shimatta_kenkyusho/static/example}/import_csv/readme.md (100%)

diff --git a/examples/import_csv/add_comps.csv b/shimatta_kenkyusho/static/example/import_csv/import_csv.csv
similarity index 100%
rename from examples/import_csv/add_comps.csv
rename to shimatta_kenkyusho/static/example/import_csv/import_csv.csv
diff --git a/examples/import_csv/readme.md b/shimatta_kenkyusho/static/example/import_csv/readme.md
similarity index 100%
rename from examples/import_csv/readme.md
rename to shimatta_kenkyusho/static/example/import_csv/readme.md
diff --git a/shimatta_kenkyusho/templates/base.html b/shimatta_kenkyusho/templates/base.html
index 298c945..f7daf6b 100644
--- a/shimatta_kenkyusho/templates/base.html
+++ b/shimatta_kenkyusho/templates/base.html
@@ -78,6 +78,11 @@
         <script type="text/javascript" src="{% static 'js/kenyusho-api-v1.js' %}"></script>
         <script type="text/javascript" src="{% static 'js/autocomplete.js' %}"></script>
         <script type="text/javascript" src="{% static 'js/autocomplete-foreign-key-field.js' %}"></script>
+        <!-- Initialize bootstrap popovers -->
+        <script type="text/javascript">
+            const popoverTriggerList = document.querySelectorAll('[data-bs-toggle="popover"]')
+            const popoverList = [...popoverTriggerList].map(popoverTriggerEl => new bootstrap.Popover(popoverTriggerEl))
+        </script>
         {% block custom_scripts %}
         {% endblock custom_scripts %}
 
diff --git a/shimatta_kenkyusho/templates/parts/modals/import-component-modal.html b/shimatta_kenkyusho/templates/parts/modals/import-component-modal.html
index 9ab72fb..62acb6d 100644
--- a/shimatta_kenkyusho/templates/parts/modals/import-component-modal.html
+++ b/shimatta_kenkyusho/templates/parts/modals/import-component-modal.html
@@ -6,6 +6,22 @@
         <div class="modal-content">
             <div class="modal-header">
                 <h2>Import Component CSV</h2>
+                <button type="button"
+                        class="btn"
+                        data-bs-toggle="popover"
+                        data-bs-title="Import Component CSV"
+                        data-bs-html="true"
+                        data-bs-content="The shimatta kenkyusho can import components from a CSV file uploaded to the website.<br>
+                                         All parameters are passed as names (e.g. package, manufacturer etc.).<br><br>
+                                         Component parameters can be set using a prefix <code>param:</code> followed by the
+                                         parameter name. The value is then parsed bysed on the parameter type.<br><br>
+                                         Distributor part numbers can be set similarly by prepending <code>distri:</code>.<br><br>
+                                         It is also possible to create initial stocks to one storage by passing the
+                                         storage uuid and/or the path to the storage (as printed in the breadcrumbs) or
+                                         a combination of a storage uuid and the path from this storage.<br><br>
+                                         See <a href='{% static 'example/import_csv/import_csv.csv' %}'>example</a> for details.">
+                    <i class="bi bi-info-circle"></i>
+                </button>
                 <button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
             </div>
             <form method="post" enctype="multipart/form-data">