devdocs/specs/core-display-format-template-system.txt

@@ -1,8 +1,14 @@
 DISPLAY FORMAT TEMPLATE SYSTEM SPECS
 
 OVERVIEW 
-Narrow grids on small screens as well as picklists need to show a single field of information as required by that shop for selection, recognition etc so templated to format multiple return fields into one
+RAVEN uses a user customizable template to determine what fields in which order get sent to the client when they display a list or select from a drop down
+    - Users with BIZ rights can set the template
+    - There is one template per list (not user based but global in nature)
+    - Template affects both "MINI" single column display of list for small devices and large format wide mode with multiple columns for larger devices
+    - In MINI list format displays they choose which columns go into the one single column for display that is returned
+    - In regular list format display they choose which columns are returned and which order separately from MINI format display
 
+Narrow grids on small screens as well as picklists need to show a single field of information as required by that shop for selection, recognition etc so templated to format multiple return fields into one
 Grids need a way to ensure you can see what you need on small devices as well they need to show the columns desired on larger devices
 PickLists need a way to format what is returned for picking (with template)
 
@@ -21,6 +27,11 @@ none relevant
 REQUIREMENTS
 
 Client
+    - Template editor:
+        - One area is for what goes into a single column in "MINI" mode for that list
+        - Another separate area on the same form is for selecting which columns are returned in a wide list and in what order
+        - Everyone gets the same template selections, i.e. there is only one template per list type
+            - This differs from v7 in which each user could select the columns to display and the order but then they needed to for filtering and sort order and stuff
     - Main grid lists < 600px show only a single column based on template
     - Selection drop down boxes in forms for selecting other objects
     - Template editor under global settings for all main list objects
@@ -46,7 +57,7 @@ Server
 
 Back AND front end
     - Need to handle changes in fields gracefully i.e. a new field added in an update, a field removed in an update cleans out the template when detected etc
-    - Should send the customized templated display name field to the reports as well as all the regular including name fields   
+    - REPORTS (FUTURE) Should send the customized templated display name field to the reports as well as all the regular including name fields   
         - This is because users will likely want that for many reports
         - Kind of a calculated field        
     - Default templates come with Raven, user can customize further

devdocs/specs/core-main-grids.txt

@@ -3,7 +3,7 @@ MAIN GRID SPECS
 OVERVIEW
 Main grids show all the stuff people have entered in Raven and are used for selection to edit/ view, filter and sort for reporting and mass operations.
 Proposed system is a hybrid grid system that has two modes to take into account the width of the display device:
-    - Xtra Small (XS ) < 600 pixels wide (my phone is 393px)
+    - MINI mode (XS ) < 600 pixels wide (my Pixel 3a phone is 393px)
         - In this mode only one column shows and it's formatted according to the Display Format Template
         - DisplayFormatTemplate is specd in the core-display-format-template-system.txt doc
         - So the user chooses which columns to show in a small factor themselves, default is name only or equivalent
@@ -17,19 +17,18 @@ REQUIREMENTS
 
 Client
     - Client needs to tell the server which form of list is required, i.e. it's client window size when fetching a list    
-		- HYBRID BIMODAL: XS or LARGE (for now but consider maybe a medium down the road in planning)
-			- in XS mode
-				- the client sends "viewport=xs" to the client with the grid data request
+		- HYBRID BIMODAL: MINI or default which is large (for now but consider maybe a medium down the road in planning)
+			- in MINI mode
+				- the client sends "mini=true" to the client with the grid data request
 				- Client receives two field list back (id and display field), displays the single field
 			- in large mode
-				- the client sends no viewport= parameter as it's optional and understood to be full size
+				- the client sends no mini= parameter as it's optional and understood to be full size
 				- the list comes back as an object with not only the actual columns but also a separate property listing the set of columns in order to be displayed 
                     - Also their data type 
                     - Also need what type of object if openable with an url
-					- Client expects an arbitrary set of columns in an arbitrary order defined by server so doesn't have a pre-ordained set of things.
-						- HMMM... Maybe I only need a single list object that adapts to the data being sent back!!!!!
-                - The client needs to be able to handle more columns than fit horizontally
-                - The client needs to not wrap any column vertically but ellipse.. it instead
+					- Client expects an arbitrary set of columns in an arbitrary order defined by server so doesn't have a pre-ordained set of things.						
+              - The client needs to be able to handle more columns than fit horizontally
+              - The client needs to not wrap any column vertically but ellipse.. it instead
         - Client accepts a list of fields and types etc and generates the grid and populates the data dynamically
             - This means that I can make a general purpose Vue grid component, plunk it down on a form and then wrap it with what is unique about that form