Merge pull request #4785 from cielf/user_docs_cont_IX

User docs cont ix

Author: awwaiid

docs/user_guide/bank/asking_for_changes.md

@@ -1,3 +1,4 @@
+READY FOR REVIEW
 # Asking for changes
 
 We welcome ideas for how Human Essentials can support your work better.

docs/user_guide/bank/essentials_distributions.md

@@ -1,5 +1,6 @@
 
-DRAFT USER GUIDE
+READY FOR REVIEW
+
 # Distributions
 Distributions are where you record what you allocate to your partner agencies.
 
@@ -40,49 +41,72 @@ Here, you will enter some information about the whole Distribution,  then add th
 The fields include:
 - Partner (mandatory)
 - Distribution date and time -- this is defaulted to midnight of the current day.  If you want to change it (if, for example, you have a specific time you are scheduling the pickup for), we recommend you use the little calendar gizmo at the right of the field.
-  [TODO: question:  does send email reminder the day before appear based on an organization flag?]
 
 - Send email reminder the day before  --> causes an email to be sent the day before
-  - [TODO:  SOOO.  It looks like this is ineffective.  Do we remove it, or do we make it work.  Let's see whether people are clicking it....
-
-- Agency representative - for information only  [TODO:  is this defaulted from the chosen partner?  It could be.. but do we?]
+  
+- Agency representative - for information only.  This is defaulted to the email of the person who sent the request.
 - Delivery method -- we default this to pickup because it's the most common across banks.
 - From storage location:  The storage location the distribution is coming from.  Mandatory.
 - Comment
 - All the items:
   - For each item:
       - If you have set up Barcodes for Items, you can just 'boo'p' the item in.  Otherwise,  select the Item from the list, and enter the quantity
-      - [TODO:  Totally rewrite this bit for packs -- actually it's already out of date]
-## Exporting Distributions
-To export your Distributions, click "Export Distributions" on the distributions view.  This will include all the top-level information, and a column [or more, if you use custom units] for each Item in the distribution,  in alphabetic order.   It will include all the Distributions within the filter you have already applied.
-[TODO:  add navigational screenshot and sample csv]
+  ## Exporting Distributions
+To export your Distributions, click "Export Distributions" on the distributions view.  
+
+![navigation to export Distributions](images/essentials/distributions/essentials_distributions_export_navigation.png)
+
+This will include all the top-level information, and a column [or more, if you use custom units] for each Item in the distribution,  in alphabetic order.   It will include all the Distributions within the filter you have already applied.
+
+![sample Distributions csv snapshot](images/essentials/distributions/essentials_distributions_export_sample.png)
 ## Viewing a Distribution
 To view a Distribution,  click "view" beside it in the distributions view.   
+![Navigation for distribution view](images/essentials/distributions/essentials_distributions_view_navigation.png)
+
 This includes the following fields:
 - distribution id (for our reference for support) ,
 - Source location  (the storage location the inventory came from),
 - Agency representative ,
 - Delivery method (pickup delivery or shipped),
 - Shipping cost (if shipped),
 - Comments, and
-- the current status.
-  [TODO: add screenhot of view]
+- the current status, as well as 
+- a breakdown of the items in the view including 
+  - Item name
+  - Value per Item
+  - Total value
+  - Quantity
+  - Package count (only if you have defined a package size for the Item)
+   
+![Navigation for Distribution view](images/essentials/distributions/essentials_distributions_view.png)
+
+You can mark the Distribution "complete",  or make a correction (which brings up the edit page, below) from this page.
+
 ## Editing a Distribution
 To edit a Distribution,  click on "Edit" beside the Distribution in the list,  or on "Make a Correction" in the view.
+![Edit Distribution navigation](images/essentials/distributions/essentials_distributions_edit_navigation.png)
+
+[!NOTE] When you edit a Distribution -- if is was in the past,  you will see a warning to that effect -- because we assumed that you wouldn't normally need to change the Distribution once it had been put together! Some banks will add things when the Partners come to pick up the distributions, based on additional needs and/or supply opportunities.
+However,  We will give you a stern warning if there has been an Audit since the Distribution was entered, and you may be prevented from changing some Distribution information (such as the storage location), because we just don't know how to handle some of those cases.
 
-If the Distribution is in the past,  you will see a warning to that effect -- because we assumed that you wouldn't normally need to change the Distribution once it had gone out the door!
-We will give you a stern warning if there has been an Audit since the Distribution was entered, and you may be prevented from changing some Distribution information (such as the storage location), because we just don't know how to handle some of those cases.
-[TODO:  screenshot]
+![Distributions edit](images/essentials/distributions/essentials_distributions_edit.png)
 ## Printing a Distribution
-Printing a Distribution produces an invoice-like page that can be used as a packing slip.  This is the same as the pdf that is emailed to the Partner when a new Distribution is saved.
+Printing a Distribution produces an invoice-like page that can be used as a packing slip. 
+
+![Distribution print navigation](images/essentials/distributions/essentials_distributions_print_navigation.png)
+![Distribution printout](images/essentials/distributions/essentials_distributions_printout.png)
 
-It is somewhat configurable -- there are options on your [Organization](getting_started_customization.md#customizing-the-distribution-printout) page to allow you to: a) add a place for a signature, or b) hide certain columns in the printout.
+This is the same pdf that is emailed to the Partner when a new Distribution is saved.  
+[!NOTE] The partner does not get a new email when you edit a Distribution,  so you may want to print the Distribution to send them in that case.
+
+The printout is somewhat configurable -- there are options on your [Organization](getting_started_customization.md#customizing-the-distribution-printout) page to allow you to: a) add a place for a signature, or b) hide certain columns in the printout.
 
 Please note that your logo (also configurable on the [Organization](getting_started_customization.md#logo) ) is included on this printout -- we strongly advice keeping it fairly small, as a large logo will just be resized anyway, and will potentially break this function.
 
 ## Reclaiming a Distribution
 What do you do if, for some reason, the Distribution that was entered was not picked up?   You can reclaim it,  adding the items back into your inventory.
-To do this,  click "Reclaim" beside the Distribution in question.
-NOTE:  You can not reverse a reclaim.  If you reclaim by accident, you will have to re-enter the Distribution.
+To do this,  click "Reclaim" beside the Distribution in question, and cliock "Ok" in the confirmation screen that appears.
+
+[!WARN]  You can not reverse a reclaim.  If you reclaim by accident, you will have to re-enter the Distribution.  If that happens,  you should be able to grab the Item quantities from the [History Report](reports_history.md), but we don't retain the rest of the information.
 
 [Prior: Requests](essentials_requests.md)[Next: Pick Ups and Deliveries](essentials_pick_ups.md)

docs/user_guide/bank/essentials_pick_ups.md

@@ -7,7 +7,7 @@ Click on "Pick Ups & Deliveries" in the left-hand menu to view the calendar.
 
 ![PickUps & Delivery Calendar](images/essentials/pick_ups/pickup&delivery.jpg)
 
-Click on any scheduled Eistribution to view details on all the Eistributions for that day.
+Click on any scheduled Distribution to view details on all the Distributions for that day.
 The Distribution Schedule page shows details including the Partner,the time of Distribution, Storage Location, the total number of items, and the status of the Distribution.
 
 ![Specific Day Distribution](images/essentials/pick_ups/specific_day_distribution_schedule.jpg)

docs/user_guide/bank/exports.md

@@ -59,7 +59,7 @@ For more information on these, please see the [Annual Survey Report](reports_ann
 - Money spent purchasing diapers, 
 - Purchased from, 
 - Vendors diapers Purchased through, 
-- Total storage locations, 
+- Total Storage Locations, 
 - Total square footage, 
 - Largest storage site type, 
 - Adult incontinence supplies distributed, 
@@ -264,7 +264,7 @@ You can filter the Purchases by:
 - Vendor
 - Purchase date
 
-The default is all storage locations and vendors, and the default period of 60 days prior, 30 days forward from today's date.
+The default is all Storage Locations and vendors, and the default period of 60 days prior, 30 days forward from today's date.
 
 Make your selection and click "Filter"  before clicking "Export Purchases"
 ### Content of Purchases Export
@@ -304,18 +304,17 @@ For each filtered Request,
   - Note: If you have packs enabled (upcoming feature), there will be a column for each unit that you have enabled for each Item.  Otherwise, one column per Item.
 
 ## Storage Locations
-### Navigating to export storage locations
+### Navigating to export Storage Locations
 Click "Inventory", then "Storage Locations" in the left-hand menu. Then click "Export Storage Locations"
 ### Filtering exported Storage Locations
-You can filter the exported list by Item.  This will give all storage locations that have ever had that Item, *not* those with current inventory.
-(Note:  including inactive is currently broken)
-[TODO: Write up including inactive]
-[TODO:  Check that by Item filter works for export storage location]
-The default is all active storage locations.
-[TODO:  IT looks like the export doesn't include the inactive when selected.]
+You can filter the exported list by Item.  This will give all Storage Locations that have ever had that Item, *not* just those with current inventory.
+(Note:  including inactive Storage Locations is not working at time of writing)
+
+The default is all active Storage Locations.
+
 Make your selections, then click "Filter" before clicking "Export Storage Locations"
-### Contents of storage location exports
-For each storage location in the filtered list:
+### Contents of Storage Location exports
+For each Storage Location in the filtered list:
 - Name,
 - Address,
 - Square Footage,
@@ -324,21 +323,21 @@ For each storage location in the filtered list:
 - Quantity for each of the organization's Items.
 
 ## Transfers
-### Navigating to export transfers
+### Navigating to export Transfers
 Click "Inventory", then "Transfers" in the left-hand menu. Then click "Export Storage Locations"
-### Filtering exported transfers
-You can filter the transfers by:
+### Filtering exported Transfers
+You can filter the Transfers by:
 - From location
 - To location
 - date range.  
-  - Note that this is the date the transfer was entered in the system, which may or may not be when it happened.
+  - Note that this is the date the Transfer was entered in the system, which may or may not be when it happened.
 
-The default is all the transfers for the period of 60 days prior, 30 days forward from today.
+The default is all the Transfers for the period of 60 days prior, 30 days forward from today.
 
 Make you selection and click 'Filter' before clicking "Export Transfers".
 
-### Contents of transfers exports
-For each selected transfer:
+### Contents of Transfers export
+For each selected Transfer:
 - From,
 - To,
 - Comment,