Merge pull request #34 from openimis/resync_insuree_family_contrib

Resync insuree family contrib
openimis · Oct 11, 2021 · bd2cd6f · bd2cd6f
2 parents 1cad3f5 + 74e41d2
commit bd2cd6f
Show file tree

Hide file tree

Showing 77 changed files with 1,348 additions and 1,999 deletions.
diff --git a/.gitignore b/.gitignore
@@ -4,4 +4,4 @@ _sidebar.rst.inc
 __pycache__/
 img_old
 *.mo
-
+venv
diff --git a/README.md b/README.md
@@ -17,32 +17,42 @@ to contribute to this existing documentation.
 
 The ReadTheDocs documentation will be generated upon commit to the master branch.
 
-## build localy 
+## build locally
 
 install Sphinx
 
-| pip install -U sphinx
-| pip install -U sphinx-rtd-theme
+```
+pip install -U sphinx
+pip install -U sphinx-rtd-theme
+```
 
-PDF and HTML code can be generated localy by running those commands
+PDF and HTML code can be generated locally by running those commands
 
-* for PDF  
+* for PDF
 
 first generate the LATEX file(s)
-| sphinx-build -b latex .\ .\_build\latex\
+```
+sphinx-build -b latex .\ .\_build\latex\
+```
 
 then use your favourite latex tool to generate the PDF
 or
+```
 pdflatex.exe .\_build\latex\openIMIS.tex
+```
 
 * for HTML
 
-| sphinx-build -b html .\ .\_build\html\
+```
+sphinx-build -b html .\ .\_build\html\
+```
 
 # Translation
 
+```
 ./make gettext
+```
 
-Drag and drop the files and folders from _build/gettext to lokalise project openIMIS doc
+Drag and drop the files and folders from `_build/gettext` to lokalise project openIMIS doc
 
-Do the translations
+Do the translations
diff --git a/conf.py b/conf.py
@@ -65,8 +65,8 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-#language = 'en'
-language = 'fr'
+language = 'en'
+# language = 'fr'
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path .
@@ -184,7 +184,7 @@
 
 # Add custom CSS to resize the tables
 def setup(app):
-    app.add_stylesheet('css/theme_overrides.css')
+    app.add_css_file('css/theme_overrides.css')
 
 #interlink mapping
 # on_rtd is whether we are on readthedocs.org, this line of code grabbed from docs.readthedocs.org
@@ -208,4 +208,4 @@ def setup(app):
 ## Gen menu
 import gensidebar
 
-gensidebar.generate_sidebar(globals(), "openIMIS")
+gensidebar.generate_sidebar(globals(), "openIMIS")
diff --git a/img/user_manual/100_insuree_edit.png b/img/user_manual/100_insuree_edit.png
diff --git a/img/user_manual/102_policies_view.png b/img/user_manual/102_policies_view.png
diff --git a/img/user_manual/24_insuree_delete_confirmation.png b/img/user_manual/24_insuree_delete_confirmation.png
diff --git a/img/user_manual/6_date_picker.png b/img/user_manual/6_date_picker.png
diff --git a/img/user_manual/76_insuree_search.png b/img/user_manual/76_insuree_search.png
diff --git a/img/user_manual/77_insuree_historical.png b/img/user_manual/77_insuree_historical.png
diff --git a/img/user_manual/78_insuree_search_results.png b/img/user_manual/78_insuree_search_results.png
diff --git a/img/user_manual/79_pagination.png b/img/user_manual/79_pagination.png
diff --git a/img/user_manual/80_policies_find.png b/img/user_manual/80_policies_find.png
diff --git a/img/user_manual/81_policies_historical.png b/img/user_manual/81_policies_historical.png
diff --git a/img/user_manual/82_policies_actions.png b/img/user_manual/82_policies_actions.png
diff --git a/img/user_manual/8_date_picker_year.png b/img/user_manual/8_date_picker_year.png
diff --git a/img/user_manual/cont_dialog_delete.png b/img/user_manual/cont_dialog_delete.png
diff --git a/img/user_manual/cont_dialog_enforce.png b/img/user_manual/cont_dialog_enforce.png
diff --git a/img/user_manual/cont_dialog_higher.png b/img/user_manual/cont_dialog_higher.png
diff --git a/img/user_manual/cont_dialog_lower.png b/img/user_manual/cont_dialog_lower.png
diff --git a/img/user_manual/cont_dialog_matches.png b/img/user_manual/cont_dialog_matches.png
diff --git a/img/user_manual/cont_family_add.png b/img/user_manual/cont_family_add.png
diff --git a/img/user_manual/cont_form.png b/img/user_manual/cont_form.png
diff --git a/img/user_manual/cont_menu.png b/img/user_manual/cont_menu.png
diff --git a/img/user_manual/cont_search.png b/img/user_manual/cont_search.png
diff --git a/img/user_manual/cont_search_hist.png b/img/user_manual/cont_search_hist.png
diff --git a/img/user_manual/delete_insuree_button.png b/img/user_manual/delete_insuree_button.png
diff --git a/img/user_manual/family_overview_page.png b/img/user_manual/family_overview_page.png
diff --git a/img/user_manual/family_policies.png b/img/user_manual/family_policies.png
diff --git a/img/user_manual/image100.png b/img/user_manual/image100.png
diff --git a/img/user_manual/image102.png b/img/user_manual/image102.png
diff --git a/img/user_manual/image11.png b/img/user_manual/image11.png
diff --git a/img/user_manual/image124.png b/img/user_manual/image124.png
diff --git a/img/user_manual/image125.png b/img/user_manual/image125.png
diff --git a/img/user_manual/image126.png b/img/user_manual/image126.png
diff --git a/img/user_manual/image127.png b/img/user_manual/image127.png
diff --git a/img/user_manual/image128.png b/img/user_manual/image128.png
diff --git a/img/user_manual/image71.png b/img/user_manual/image71.png
diff --git a/img/user_manual/image72.png b/img/user_manual/image72.png
diff --git a/img/user_manual/image73.png b/img/user_manual/image73.png
diff --git a/img/user_manual/image74.png b/img/user_manual/image74.png
diff --git a/img/user_manual/image76.png b/img/user_manual/image76.png
diff --git a/img/user_manual/image77.png b/img/user_manual/image77.png
diff --git a/img/user_manual/image78.png b/img/user_manual/image78.png
diff --git a/img/user_manual/image80.png b/img/user_manual/image80.png
diff --git a/img/user_manual/image81.png b/img/user_manual/image81.png
diff --git a/img/user_manual/image82.png b/img/user_manual/image82.png
diff --git a/img/user_manual/image90.png b/img/user_manual/image90.png
diff --git a/img/user_manual/image97.png b/img/user_manual/image97.png
diff --git a/img/user_manual/insuree_enquiry.png b/img/user_manual/insuree_enquiry.png
diff --git a/img/user_manual/med_item_delete.png b/img/user_manual/med_item_delete.png
diff --git a/img/user_manual/med_item_history.png b/img/user_manual/med_item_history.png
diff --git a/img/user_manual/med_item_list.png b/img/user_manual/med_item_list.png
diff --git a/img/user_manual/med_item_menu.png b/img/user_manual/med_item_menu.png
diff --git a/img/user_manual/med_item_new.png b/img/user_manual/med_item_new.png
diff --git a/img/user_manual/med_service_delete.png b/img/user_manual/med_service_delete.png
diff --git a/img/user_manual/med_service_history.png b/img/user_manual/med_service_history.png
diff --git a/img/user_manual/med_service_list.png b/img/user_manual/med_service_list.png
diff --git a/img/user_manual/med_service_menu.png b/img/user_manual/med_service_menu.png
diff --git a/img/user_manual/med_service_new.png b/img/user_manual/med_service_new.png
diff --git a/img/user_manual/policies_delete_confirmation.png b/img/user_manual/policies_delete_confirmation.png
diff --git a/img/user_manual/policies_suspend_confirmation.png b/img/user_manual/policies_suspend_confirmation.png
diff --git a/img/user_manual/save_button.png b/img/user_manual/save_button.png
diff --git a/img/user_manual/search_button.png b/img/user_manual/search_button.png
diff --git a/img/user_manual/search_reset_button.png b/img/user_manual/search_reset_button.png
diff --git a/locale/en/LC_MESSAGES/user_manual/insuree_policies/family.po b/locale/en/LC_MESSAGES/user_manual/insuree_policies/family.po
diff --git a/locale/en/LC_MESSAGES/user_manual/insuree_policies/insuree.po b/locale/en/LC_MESSAGES/user_manual/insuree_policies/insuree.po
diff --git a/locale/fr/LC_MESSAGES/user_manual/insuree_policies/family.po b/locale/fr/LC_MESSAGES/user_manual/insuree_policies/family.po
diff --git a/locale/fr/LC_MESSAGES/user_manual/insuree_policies/insuree.po b/locale/fr/LC_MESSAGES/user_manual/insuree_policies/insuree.po
diff --git a/user_manual/claims/hf_claims.rst b/user_manual/claims/hf_claims.rst
@@ -92,45 +92,22 @@ Claims Control Page
 
     * ``Visit Date From``
 
-      Type in a date; or use the Date Selector (:numref:`cal_picker`), to search for claims with a ``Visit Date From`` date which is on or is greater than the date typed/selected. *Note. To clear the date entry box; use the ``Clear`` button on the date picker popup*. ``Visit Date From`` should be the day of admission for in-patient care or the visit date in case of out-patient care.
+      Type in a date; or use the Date Selector (:ref:`cal_picker`), to search for claims with a ``Visit Date From`` date which is on or is greater than the date typed/selected. *Note. To clear the date entry box; use the ``Clear`` button on the date picker popup*. ``Visit Date From`` should be the day of admission for in-patient care or the visit date in case of out-patient care.
 
     * ``Visit Date To``
 
-      Type in a date; or use the Date Selector (:numref:`cal_picker`), to search for claims with a ``Visit Date From`` date which is on or is less than the date typed/selected. *Note. To clear the date entry box; use the ``Clear`` button on the date picker popup*. ``Visit Date To`` should be the day of discharge for in-patient care or the visit date in case of out-patient care.
+      Type in a date; or use the Date Selector (:ref:`cal_picker`), to search for claims with a ``Visit Date From`` date which is on or is less than the date typed/selected. *Note. To clear the date entry box; use the ``Clear`` button on the date picker popup*. ``Visit Date To`` should be the day of discharge for in-patient care or the visit date in case of out-patient care.
 
     * ``Claim Date From``
 
-      Type in a date; or use the Date Selector (:numref:`cal_picker`), to search for claims with a ``Claim Date`` date which is on or is greater than the date typed/selected. *Note. To clear the date entry box; use the ``Clear`` button on the date picker popup**
+      Type in a date; or use the Date Selector (:ref:`cal_picker`), to search for claims with a ``Claim Date`` date which is on or is greater than the date typed/selected. *Note. To clear the date entry box; use the ``Clear`` button on the date picker popup**
 
     * ``Claim Date To``
 
-      Type in a date; or use the Date Selector (:numref:`cal_picker`), to search for claims with a ``Claim Date`` date which is on or is less than the date typed/selected. *Note. To clear the date entry box; use the mouse to highlight the full date and then press the space key*.
+      Type in a date; or use the Date Selector (:ref:`cal_picker`), to search for claims with a ``Claim Date`` date which is on or is less than the date typed/selected. *Note. To clear the date entry box; use the mouse to highlight the full date and then press the space key*.
 
 
-
-      .. _cal_picker:
-      .. list-table:: Date Picker
-        :widths: 1 1 1
-
-        * - .. figure:: /img/user_manual/date_picker.day.png
-              :align: center
-
-              `Day picker`
-          - .. figure:: /img/user_manual/date_picker.month.png
-              :align: center
-
-              `Month picker`
-          - .. figure:: /img/user_manual/date_picker.year.png
-              :align: center
-
-              `Year picker`
-        * - At anytime during the use of the pop-up, the user can see the date of **today**.
-            Clicking on a day will close the pop-up and display the date 
-
-          - Clicking on the arrow to the left displays the previous month.
-            Clicking on the arrow on the right will displays the following month.
-
-          - Clicking on the year will display a year selector.
+      .. include:: ../date_picker.rst
 
 
     * ``Search Button``

diff --git a/user_manual/date_picker.rst b/user_manual/date_picker.rst
@@ -0,0 +1,23 @@
+      .. _cal_picker:
+      .. list-table:: Date Picker
+        :widths: 1 1 1
+
+        * - .. figure:: /img/user_manual/date_picker.day.png
+              :align: center
+
+              `Day picker`
+          - .. figure:: /img/user_manual/date_picker.month.png
+              :align: center
+
+              `Month picker`
+          - .. figure:: /img/user_manual/date_picker.year.png
+              :align: center
+
+              `Year picker`
+        * - At anytime during the use of the pop-up, the user can see the date of **today**.
+            Clicking on a day will close the pop-up and display the date
+
+          - Clicking on the arrow to the left displays the previous month.
+            Clicking on the arrow on the right will displays the following month.
+
+          - Clicking on the year will display a year selector.
diff --git a/user_manual/insuree_policies/contribution.rst b/user_manual/insuree_policies/contribution.rst
@@ -17,7 +17,7 @@ Navigation
   Find Contribution can be found under the main menu ``Insurees and Policies``, sub menu ``Contributions``
 
   .. _image107:
-  .. figure:: /img/user_manual/image83.png
+  .. figure:: /img/user_manual/cont_menu.png
     :align: center
 
     `Navigation Contributions`
@@ -27,7 +27,7 @@ Navigation
 Find Contribution Page
 
   .. _image108:
-  .. figure:: /img/user_manual/image84.png
+  .. figure:: /img/user_manual/cont_search.png
     :align: center
 
     `Image - 108 Find Contribution Page`
@@ -54,35 +54,6 @@ Find Contribution Page
 
       Type in a date; or use the Date Selector Button, to enter the ``Payment Date To`` to search for contributions with a ``Payment Date`` equal or earlier than the specified date. *Note. To clear the date entry box; use the mouse to highlight the full date and then press the space key.*
 
-    * ``Date Selector Button``
-
-      Clicking on the ``Date Selector Button`` will pop-up an easy to use, calendar selector (:numref:`image109`); by default the calendar will show the current month, or the month of the currently selected date, with the current day highlighted.
-
-        - At anytime during the use of the pop-up, the user can see the date of **today**.
-        - Clicking on *today* will close the pop-up and display the today’s date in the corresponding date entry box.
-        - Clicking on any day of the month will close the pop-up and display the date selected in the corresponding date entry box.
-        - Clicking on the arrow to the left displays the previous month.
-        - Clicking on the arrow on the right will displays the following month.
-        - Clicking on the month will display all the months for the year.
-        - Clicking on the year will display a year selector.
-
-      .. _image109:
-      .. |logo33| image:: /img/user_manual/image6.png
-        :scale: 100%
-        :align: middle
-      .. |logo34| image:: /img/user_manual/image7.png
-        :scale: 100%
-        :align: middle
-      .. |logo35| image:: /img/user_manual/image8.png
-        :scale: 100%
-        :align: middle
-
-      +----------++----------++----------+
-      | |logo33| || |logo34| || |logo35| |
-      +----------++----------++----------+
-
-        `Calendar Selector - Search Panel`
-
     * ``Contribution Category``
 
       Select the ``Contribution Category`` that match with the type of contribution paid, by default there is *Contribution and Others* and *photo fee*. this enable to add fees that won't be counted as contribution payment
@@ -104,7 +75,7 @@ Find Contribution Page
       Click on ``Historical`` to see historical records matching the selected criteria. Historical records are displayed in the result with a line through the middle of the text (strikethrough) to clearly define them from current records (:numref:`image110`).
 
       .. _image110:
-      .. figure:: /img/user_manual/image85.png
+      .. figure:: /img/user_manual/cont_search_hist.png
         :align: center
 
         `Historical records - Result Panel`
@@ -113,39 +84,14 @@ Find Contribution Page
 
       Once the criteria have been entered, use the ``Search`` button to filter the records, the results will appear in the Result Panel.
 
- #. **Result Panel**
-
-    The result panel displays a list of all contributions found, matching the selected criteria in the search panel. The currently selected record is highlighted with light blue, while hovering over records changes the highlight to yellow (:numref:`image111`) The leftmost record contains a hyperlink which if clicked, re-directs the user to the actual record for detailed viewing if it is a historical record or editing if it is the current record.
-
-    .. _image111:
-    .. figure:: /img/user_manual/image86.png
-      :align: center
-
-      `Image 111 Selected record (blue), hovered records (yellow) - Result Pane`
-
-    A maximum of 15 records are displayed at one time, further records can be viewed by navigating through the pages using the page selector at the bottom of the result Panel (:numref:`image112`).
-
-    .. _image112:
-    .. figure:: /img/user_manual/image11.png
-      :align: center
-
-      `Page selector- Result Panel`
-
- #. **Button Panel**
-
-    The ``Cancel`` button re-directs to the :ref:`Home Page <home_page>`.
-
- #. **Information Panel**
-
-    The Information Panel is used to display messages back to the user. Messages will occur once a contribution has been added, updated or deleted or if there was an error at any time during the process of these actions.
 
 Contribution Page
 """""""""""""""""
 
  #. **Data Entry**
 
     .. _image130:
-    .. figure:: /img/user_manual/image104.png
+    .. figure:: /img/user_manual/cont_form.png
       :align: center
 
       `Contribution Page`
@@ -177,23 +123,23 @@ Contribution Page
       a) If the Contribution paid matches the price of the policy:
 
       .. _image131:
-      .. figure:: /img/user_manual/image105.png
+      .. figure:: /img/user_manual/cont_dialog_matches.png
         :align: center
 
         `Image 131`
 
       b) If the contribution paid is lower than the price of the policy:
 
       .. _image132:
-      .. figure:: /img/user_manual/image106.png
+      .. figure:: /img/user_manual/cont_dialog_lower.png
         :align: center
 
         `Image 132`
 
       Followed by:
 
       .. _image133:
-      .. figure:: /img/user_manual/image107.png
+      .. figure:: /img/user_manual/cont_dialog_enforce.png
         :align: center
 
         `Image 133`
@@ -203,7 +149,7 @@ Contribution Page
       c) If the contribution is higher than the price of the policy:
 
       .. _image134:
-      .. figure:: /img/user_manual/image108.png
+      .. figure:: /img/user_manual/cont_dialog_higher.png
         :align: center
 
         `Image 134`
@@ -238,7 +184,7 @@ Deleting a Contribution
   Before deleting a confirmation popup (:numref:`image135`) is displayed, which requires the user to confirm if the action should really be carried out?
 
   .. _image135:
-  .. figure:: /img/user_manual/image109.png
+  .. figure:: /img/user_manual/cont_dialog_delete.png
     :align: center
 
     `Delete confirmation- Button Panel`