Reviewed changelog

changelog/60_UNRELEASED_2020-xx-xx.md

@@ -1,18 +1,21 @@
 > !!! The major version bump is due to breaking API changes, please see below if you use the API
 
-### New feature: Link product of different sizes
-- Imagine you buy for example eggs in different pack sizes
-- The "Factor purchase to stock quantity unit" can now be set during purchase (if the products purchase and stock QU are different)
-- Additionally, each product barcode can be assigned a different "Factor purchase to stock quantity unit" (on the product edit page), which is then automatically prefilled on the purchase page
-- (Thanks @kriddles)
+### New feature: Use any product related quantity unit anywhere
+- Finally it's possible to use any product related quantity unit on any page
+- Products still have one quantity unit stock and one (default) quantity unit purchase, but any QU, which has a direct or indirect conversion for that product, can be used to pick an amount
 
-## New feature: Permissions
+### New feature: Prefill purchase data by barcodes
+- Imagine you buy for example eggs in different pack sizes and they have different barcodes
+- Each product barcode can be assigned a amount, quantity unit and store (on the product edit page), which is then automatically prefilled on the purchase page
+- (Thanks @kriddles for the initial work on this)
+
+### New feature: Permissions
 - Users can now have permissions, can be configured per user on the "Manage users" page (lock icon)
 - Default permissions for new users can be set via a new `config.php` setting `DEFAULT_PERMISSIONS` (defaults to `ADMIN`, so no changed behavior when not configured)
 - All currently existing users will get all permissions (`ADMIN`) during the update/migration
 - Creating API keys on the "Manage API keys"-page (top right corner settings menu) now requires the `ADMIN` permission
   - Other users only see their API keys on that page
-- (Thanks @fipwmaqzufheoxq92ebc)
+- (Thanks @fipwmaqzufheoxq92ebc for the initial work on this)
 
 ### New feature: External authentication support
 - New `config.php` setting `AUTH_CLASS` to change the used authentication provider
@@ -25,13 +28,11 @@
   - (Thanks @fipwmaqzufheoxq92ebc for the initial work on this)
 
 ### Stock improvements/fixes
-- On the purchase/consume/transfer/inventory/shopping list item page (so everywhere) any product related quantity unit can now be used
 - When creating a quantity unit conversion it's now possible to automatically create the inverse conversion (thanks @kriddles)
 - Optimized/clarified what the total/unit price is on the purchase page (thanks @kriddles)
 - On the purchase page the amount field is now displayed above/before the best before date for better `TAB` handling (thanks @kriddles)
 - Changed that when `FEATURE_FLAG_STOCK_BEST_BEFORE_DATE_TRACKING` is disabled, products now get internally a best before of "never expires" (aka `2999-12-31`) instead of today (thanks @kriddles)
 - Products can now be hidden instead of deleted to prevent problems / missing information on existing references (new checkbox on the product edit page) (thanks @kriddles)
-- Improved/fixed that changing the products "Factor purchase to stock quantity unit" not longer messes up historical prices (which results for example in wrong recipe costs) (thanks @kriddles)
 - On the stock journal page, it's now visible if a consume-booking was spoiled
 - It's now tracked who made a stock change (currently logged in user, visible on the stock journal page) (thanks @fipwmaqzufheoxq92ebc)
 - Product edit page improvements ("Save & continue" button, deleting and adding a product picuture is now possible in one go) (thanks @Ma27)
@@ -41,15 +42,15 @@
 - The decimal places for all amount and price inputs can now be configured (stock settings / top right corner settings menu, both default to `4`)
 - When clicking the product name on the shopping list, the product card will now be displayed (like on the stock overview page) (thanks @kriddles)
 - On the product card there is now also a button to jump directly to the stock entries of the corresponding product (thanks @kriddles)
-- The product picker workflows can now also be started by `ENTER` (instead of only `TAB`)
-- Fixed that it was not possible to leave the "Barcode(s)" on the product edit page by `TAB`
+- The product picker workflows can now also be started by `ENTER` (additionally to `TAB`)
+- Fixed that changing the products "Factor purchase to stock quantity unit" not longer messes up historical prices (which results for example in wrong recipe costs) (thanks @kriddles)
 - Fixed that when adding products through a product picker workflow and when the created products contains special characters, the product was not preselected on the previous page (thanks @Forceu)
 - Fixed that when editing a product the default store was not visible / always empty regardless if the product had one set (thanks @kriddles)
 - Fixed that `FEATURE_SETTING_STOCK_COUNT_OPENED_PRODUCTS_AGAINST_MINIMUM_STOCK_AMOUNT` (option to configure if opened products should be considered for minimum stock amounts) was not handled correctly (thanks @teddybeermaniac)
-- Fixed that the "Expiring soon" sum (yellow header-button) on the stock overview page didn't include products which expire today (thanks @fipwmaqzufheoxq92ebc)
+- Fixed that the "Expiring soon" sum (yellow filter button) on the stock overview page didn't include products which expire today (thanks @fipwmaqzufheoxq92ebc)
 - Fixed that the shopping cart icon on the stock overview page was also shown if the product was on an already deleted shopping list (if enabled) (thanks @fipwmaqzufheoxq92ebc)
 - Fixed that when editing a stock entry without a price, the price field was prefilled with `1`
-- Fixed that location & product groups filter on the stock overview page did a contains search instead an exact search
+- Fixed that the location & product groups filter on the stock overview page used a contains search instead of an exact search
 - Fixed that the amount on the success popup was wrong when consuming a product with "Tare weight handling" enabled
 - Fixed that the aggregated amount of parent products was wrong on the stock overview page when the child products had not the same stock quantity units
 - Fixed that edited stock entries were not considered for the price history chart on the product card
@@ -59,20 +60,17 @@
 
 ### Shopping list improvements
 - Decimal amounts are now allowed (for any product, rounded by two decimal places)
-- "Add products that are below defined min. stock amount" always rounded up the missing amount to an integral number, this now allows decimal numbers
 - Added a button to add all currently in-stock but expired products to the shopping list (thanks @m-byte)
 - Improved that when `FEATURE_FLAG_STOCK` is disabled, all product/stock related inputs and buttons are now hidden on the shopping list page (thanks @fipwmaqzufheoxq92ebc)
-- When adding/editing shopping list items a dialog is now used instead of jumping between pages (thanks @kriddles)
+- Fixed that "Add products that are below defined min. stock amount" always rounded up the missing amount to an integral number, this now allows decimal numbers
 
 ### Recipe improvements/fixes
 - It's now possible to print recipes (button next to the recipe title) (thanks @zsarnett)
-- Improved recipe card presentation (thanks @zsarnett)
-- Improved the recipe adding workflow (a recipe called "New recipe" is now not automatically created when starting to add a recipe) (thanks @zsarnett)
-- Fixed that images on the recipe gallery view were not scaled correctly on largers screens (thanks @zsarnett)
-- Fixed that decimal ingredient amounts maybe resulted in wrong conversions truncated decimal places if your locale does not use a dot as the decimal separator (thanks @m-byte)
+- Improved the recipe add workflow (a recipe called "New recipe" is now not automatically created when starting to add a recipe) (thanks @zsarnett)
+- Fixed that images on the recipe gallery view were not scaled correctly on larger screens (thanks @zsarnett)
+- Fixed that decimal ingredient amounts maybe resulted in wrong conversions or truncated decimal places if your locale does not use a dot as the decimal separator (thanks @m-byte)
 - Fixed that a recipe cannot be included in itself (because this will cause an infinite loop) (thanks @fipwmaqzufheoxq92ebc)
 - Fixed that when editing a recipe ingredient the checkbox "Disable stock fulfillment checking for this ingredient" was not initaliased with the saved value
-- Fixed that when using the "+"-symbol (which appears on small screens only to expand columns which don't fit the screen) the page reloaded
 - Fixed that the status filter ("Enough in stock", etc.) on the recipes page did not filter recipes on the gallery tab (thanks @fipwmaqzufheoxq92ebc)
 - Fixed that consuming a recipe ingredient with tare weight handling enabled consumed a wrong amount (thanks @fipwmaqzufheoxq92ebc)
 
@@ -85,7 +83,7 @@
 - Fixed that the assignment type "In alphabetic order" did not work correctly (the last person in the list was always assigned next once reached) (thanks @fipwmaqzufheoxq92ebc)
 
 ### Equipment improvements
-- The equipment page now will be never automatically reloaded, even when `Auto reload on external changes` is on and a change was detected (because you most probably have that page open longer to read the manual) (thanks @fipwmaqzufheoxq92ebc)
+- The equipment page now will never automatically reload, even when `Auto reload on external changes` is on and a change was detected (because you most probably have that page open longer to read the manual) (thanks @fipwmaqzufheoxq92ebc)
 
 ### Calendar improvements/fixes
 - Events are now links to the corresponding page (thanks @zsarnett)
@@ -98,7 +96,7 @@
 
 ### API improvements/fixes
 - Breaking changes:
-  - All prices are now related to the products **stock** quantity unit (instead the purchase QU)
+  - All prices are now related to the products **stock** quantity unit (instead of the purchase QU)
   - The product object no longer has a field `barcodes` with a comma separated barcode list, instead barcodes are now stored in a separate table/entity `product_barcodes` (use the existing "Generic entity interactions" endpoints to access them)
 - For better integration (apps), it's now possible to show a QR-Code for API keys (thanks @fipwmaqzufheoxq92ebc)
   - New QR-Code button on the "Manage API keys"-page (top right corner settings menu), the QR-Codes contains `<API-Url>|<API-Key>`
@@ -112,7 +110,7 @@
   - `/tasks`
   - `/chores`
   - `/batteries`
-  - There are 4 new (optional) query parameters to use that
+  - There are 4 new (optional) query parameters to utilize that
     - `order` The field to order by
     - `limit` The maximum number of objects to return
     - `offset` The number of objects to skip
@@ -141,6 +139,7 @@
 - Improved mobile views (thanks @4lloyd for the idea and initial work on this)
   - The buttons on the top of each page and the filter row is now collapsed (use the ellipsis/filter button to show them, this also superseded the shopping list compact view)
   - Tables are horizontally scrollable (instead of collapsing columns which don't fit)
+- Dialogs are now used everywhere where appropriate instead of jumping between pages (for exampel when adding/editing shopping list items)
 - Added a "Clear filter"-button on all pages (with filters) to quickly reset applied filters
 - The data path (previously fixed to the `data` folder) is now configurable, making it possible to run multiple grocy instances from the same directory (with different `config.php` files / different database, etc.) (thanks @fgrsnau)
   - Via an environment variable `GROCY_DATAPATH` (higher priority)