Updated demo markdowns

BasicPrimitives · BasicPrimitives · commit d4c488a89cc0 · 2022-01-21T23:36:58.000-05:00
diff --git a/server/src/static/crossbranchalignment.md b/server/src/static/crossbranchalignment.md
@@ -5,4 +5,8 @@ In the Organizational Chart layout, the number of rows occupied by the immediate
 ### General
 * Diagram reset
 * PDF file generation
-* Diagram options drawer
+* Diagram options drawer
+
+### Sources
+* [UI Components](https://github.com/BasicPrimitives/react-demo/tree/master/client/src/containers/CrossBranchAlignment)
+* [Redux Store](https://github.com/BasicPrimitives/react-demo/blob/master/client/src/redux/modules/demos/crossbranchalignment.js)
diff --git a/server/src/static/crossteamgroup.md b/server/src/static/crossteamgroup.md
@@ -1,6 +1,6 @@
 ## Demoed features
-This diagram displays the same data set as the Large Hierarchy Demo. But it looks way more compact due to the absence of horizontal scrolling and dense array of labels shown for every node of the diagram.
-The application shows cross-functional team members using selection checkmarks and large custom user templates.  If selected nodes are outside the visible viewport area, the component shows them in the form of markers on the diagram's frame. When you start this demo application, you should see them at the bottom of the diagram bounding rectangle. You can click them, and the diagram would scroll them into the viewport.
+This diagram displays the same data set as the Large Hierarchy Demo. But it looks way more compact due to the absence of horizontal scrolling and dense array of labels shown for every diagram node.
+The application shows cross-functional team members using selection checkmarks and large custom user templates. If selected nodes are outside the visible viewport area, the component shows them as markers on the diagram's frame. You should see them at the bottom of the diagram bounding rectangle when you start this demo application. You can click them, and the diagram would scroll them into the viewport.
 
 ### Cross-Functional Team Visualization
 * Group titles
@@ -21,3 +21,7 @@ The application shows cross-functional team members using selection checkmarks a
 * Diagram reset
 * PDF file generation
 * Diagram options drawer
+
+### Sources
+* [UI Components](https://github.com/BasicPrimitives/react-demo/tree/master/client/src/containers/CrossTeamGroup)
+* [Redux Store](https://github.com/BasicPrimitives/react-demo/blob/master/client/src/redux/modules/demos/crossteamgroup.js)
diff --git a/server/src/static/dependencies.md b/server/src/static/dependencies.md
@@ -1,6 +1,6 @@
 ## Demoed features
 ### Large layered graph visualization
-This is example of large volume of dependencies having no context to sort and group them.
+This is an example of the large volume of dependencies having no context to sort and group. It is time to update it.
 
 ### Features
 * Hiding grand parent connections
@@ -12,3 +12,6 @@ This is example of large volume of dependencies having no context to sort and gr
 * PDF file generation
 * Diagram options drawer
 
+### Sources
+* [UI Components](https://github.com/BasicPrimitives/react-demo/tree/master/client/src/containers/Dependencies)
+* [Redux Store](https://github.com/BasicPrimitives/react-demo/blob/master/client/src/redux/modules/demos/dependencies.js)
diff --git a/server/src/static/dynamicloading.md b/server/src/static/dynamicloading.md
@@ -1,9 +1,13 @@
 ## Demoed features
 ### Browsing combined with dynamic nodes loading
-* This demo dynamically loads chart nodes as the user navigates around the diagram. The top 3 levels stay loaded permanently. All other rows are loaded as the user browses down into them, and control discards them as it navigates out to any other branch of the hierarchy.
-* Selecting and pinning nodes. If the user check marks a loaded node, it stays loaded and not discarded when the user swaps to another branch.
+* This demo dynamically loads chart nodes as the user navigates around the diagram. The top 3 levels stay loaded permanently. All other rows are loaded as the user browses down into them, and control discards them as it navigates to any other branch of the hierarchy.
+* Selecting and pinning nodes. If the user check marks a loaded node, it will stay loaded when it goes to another branch.
 
 ### General
 * Diagram reset
 * PDF file generation
-* Diagram options drawer
+* Diagram options drawer
+
+### Sources
+* [UI Components](https://github.com/BasicPrimitives/react-demo/blob/master/client/src/containers/DynamicLoading/DynamicLoading.js)
+* [Redux Store](https://github.com/BasicPrimitives/react-demo/blob/master/client/src/redux/modules/demos/dynamicloading.js)
diff --git a/server/src/static/familychartitemsordering.md b/server/src/static/familychartitemsordering.md
@@ -1,6 +1,6 @@
 ## Demoed features
 ### User-guided family chart nodes ordering
-Family Tree Component orders and aligns nodes automatically. It searches for the best order of family nodes. The automatic layout is convenient for initial rendering, but lack of ordering rules keeps the layout engine reordering nodes every time we add new nodes into the diagram. So end-users have to adapt to global layout changes every time they make changes to diagram nodes. When a user defines a position for every node, the opposite situation drives us back to diagram editors' age and manual node placement. Manual node positioning is inconvenient, so we combine the best of the two approaches: auto layout and user-guided nodes order. Our layout engine respects end-user ordering rules as long as they are applicable and ignores them when they are not relevant.
+Family Tree Component orders and aligns nodes automatically. It searches for the best order of family nodes. The automatic layout is convenient for initial rendering, but the lack of ordering rules keeps the layout engine reordering nodes every time we add new nodes into the diagram. So end-users have to adapt to global layout changes every time they make changes to diagram nodes. When a user defines a position for every node, the opposite situation drives us back to diagram editors' age and manual node placement. Manual node positioning is inconvenient, so we combine the best from the two approaches: auto layout and user-guided nodes order. Our layout engine respects end-user ordering rules as long as applicable and ignores them when they are not relevant.
 
 This demo family diagram has annotations showing relations guiding the layout engine. See horizontal red dotted lines. The arrow direction defines who gets its order position first and who is next.
 
@@ -18,3 +18,7 @@ This demo family diagram has annotations showing relations guiding the layout en
 ### Annotations
 * Offbeat Connector Annotation - use nodes context buttons to show connector annotation between any two nodes of the diagram
 * Background Annotation - select nodes to enable background annotation. Background annotation auto merges for neighboring nodes.
+
+### Sources
+* [UI Components](https://github.com/BasicPrimitives/react-demo/blob/master/client/src/containers/FamilyChartItemsOrdering/FamilyChartItemsOrdering.js)
+* [Redux Store](https://github.com/BasicPrimitives/react-demo/blob/master/client/src/redux/modules/demos/familychartitemsordering.js)
diff --git a/server/src/static/familychartwithannotations.md b/server/src/static/familychartwithannotations.md
@@ -1,5 +1,5 @@
 ## Demoed Features
-Family chart visualizes dependency trees and graphs in form of multiple inheritance diagram.
+The family chart visualizes dependency trees and graphs in the form of a layered multiple-inheritance diagram.
 
 ### Family Chart Auto Layout
 * Automatic connection lines grouping into bundles
@@ -11,4 +11,8 @@ Family chart visualizes dependency trees and graphs in form of multiple inherita
 ### General
 * Diagram reset
 * PDF file generation
-* Diagram options drawer
+* Diagram options drawer
+
+### Sources
+* [UI Components](https://github.com/BasicPrimitives/react-demo/blob/master/client/src/containers/FamilyChartWithAnnotations/FamilyChartWithAnnotations.js)
+* [Redux Store](https://github.com/BasicPrimitives/react-demo/blob/master/client/src/redux/modules/demos/familychartwithannotations.js)
diff --git a/server/src/static/financialownership.md b/server/src/static/financialownership.md
@@ -10,3 +10,6 @@
 * PDF file generation
 * Diagram options drawer
 
+### Sources
+* [Ui Components](https://github.com/BasicPrimitives/react-demo/blob/master/client/src/containers/FinancialOwnership/FinancialOwnership.js)
+* [Redux Store](https://github.com/BasicPrimitives/react-demo/blob/master/client/src/redux/modules/demos/financialownership.js)
diff --git a/server/src/static/highlightannotations.md b/server/src/static/highlightannotations.md
@@ -3,11 +3,15 @@
 * Straight connector annotations
 * Stacking connector annotations
 
-The diagram displays permanent straight connector annotations for the current cursor node and dynamic for the currently highlighted node. 
+The diagram displays permanent straight connector annotations for the current cursor node and dynamic for the highlighted node. 
 
-The component performs the minimum required volume of rendering and layout operations. The chart shows highlight and draws on-screen connector annotations when the user moves the mouse pointer over nodes. The diagram layout does not depend on annotations. It does not reserve any space for them, so the component draws connector annotations on top of diagram nodes without general layout and nodes rendering. The user gets instant visual feedback for a node under the mouse cursor. Instant annotations are convenient when we have many of them defined across nodes of the diagram, and we don't want to show all of them all the time.
+The component performs the minimum required volume of rendering and layout operations. The chart shows the highlight and draws on-screen connector annotations when the user moves the mouse pointer over nodes. The diagram layout does not depend on annotations. It does not reserve any space, so the component draws connector annotations on top of diagram nodes without general layout and nodes rendering. The user gets instant visual feedback for a node under the mouse cursor. Instant annotations are convenient when we have many of them defined across nodes of the diagram, and we don't want to show all of them all the time.
 
 ### General
 * Diagram reset
 * PDF file generation
-* Diagram options drawer
+* Diagram options drawer
+
+### Demo Sources
+* [UI Components](https://github.com/BasicPrimitives/react-demo/tree/master/client/src/containers/HighlightAnnotations)
+* [Redux store](https://github.com/BasicPrimitives/react-demo/blob/master/client/src/redux/modules/demos/highlightannotations.js)
diff --git a/server/src/static/largehierarchy.md b/server/src/static/largehierarchy.md
@@ -1,9 +1,14 @@
 ## Demoed features
 ### Browsing diagram nodes and auto-layout 
-* Fitting large diagram into available screen space. Component folds nodes into markers to make the brwosing of large hierarchies possible.
+* Fitting large diagram into available screen space. Component folds nodes into markers to make the browsing of large hierarchies possible.
 * Showing context menu and details for a node in the user focus. Component shows cursor node immediate children and parents details, so the user can click them and browse nodes one by one further around the diagram.
 * Selecting and pinning nodes. As a user browses diagram nodes, it may pin the ones it is interested in, so their details stay visible.
+
 ### General
 * Diagram reset
 * PDF file generation
-* Diagram options drawer
+* Diagram options drawer
+
+### Sources
+* [UI Components](https://github.com/BasicPrimitives/react-demo/blob/master/client/src/containers/LargeHierarchy/LargeHierarchy.js)
+* [Redux Store](https://github.com/BasicPrimitives/react-demo/blob/master/client/src/redux/modules/demos/largeorganizationalchart.js)
diff --git a/server/src/static/mutualfinancialownership.md b/server/src/static/mutualfinancialownership.md
@@ -4,11 +4,14 @@ Configuration may contain looped references between items, so control finds layo
 
 ### Layout Features
 * Dependency Loops 
-* Hiding direct grand parent relations
+* Hiding direct grandparent relations
 * Alignment by levels
 
 ### General
 * Diagram reset
 * PDF file generation
 * Diagram options drawer
 
+### Sources
+* [UI Components](https://github.com/BasicPrimitives/react-demo/blob/master/client/src/containers/MutualFinancialOwnership/MutualFinancialOwnership.js)
+* [redux Store](https://github.com/BasicPrimitives/react-demo/blob/master/client/src/redux/modules/demos/mutualfinancialownership.js)
diff --git a/server/src/static/orgeditor.md b/server/src/static/orgeditor.md
@@ -36,4 +36,8 @@ Drag & Drop is a popular feature. We developed the stand-alone ReactJS library t
 This demo application implements nodes Drag & Drop inside of the single diagram control. It implements nodes Drag & Drop between two controls; enable the dual diagram view mode to see two controls side by side. It implements drag and Drop of nodes from the search results drawer into control panels as well.
 In general, we are against UI functionality based on Drag & Drop in analytical accounting class business applications. Drag & Drop creates a lot of usability issues in applications having transactionality of operations. Applications having document-based UI, Drag & Drop is not a problem. Users can always rollback document changes. When we develop transactional processes, the usage of Drag & Drop may accidentally create unwanted operations. So in transactional applications, Drag & Drop requires confirmation dialogs or transactions queue with a subsequent confirmation dialog to be implemented, which is not convenient and meant to be when we develop Drag & Drop UI.
 ### Matrix children layout 
-Usually, organizational charts grow horizontally more than vertically. So keeping nodes in square formation saves horizontal space. It is essential to fit the matrix into the width of the screen. It is OK to scroll nodes vertically or horizontally. The necessity to scroll both ways creates usability issues, so the control has the option `maximumColumnsInMatrix` to limit the maximum number of columns in the matrix formation, so it cannot grow beyond some fixed columns number. For example, when a node has four children, they are matrixed into 2 * 2 matrix, nine children are matrixed into 3 * 3 matrix, 16 into 4 * 4, etc. Still, if we limit the number of columns to 4, 20 children would be matrixed into a 4 * 5 matrix.
+Usually, organizational charts grow horizontally more than vertically. So keeping nodes in square formation saves horizontal space. It is essential to fit the matrix into the width of the screen. It is OK to scroll nodes vertically or horizontally. The necessity to scroll both ways creates usability issues, so the control has the option `maximumColumnsInMatrix` to limit the maximum number of columns in the matrix formation, so it cannot grow beyond some fixed columns number. For example, when a node has four children, they are matrixed into 2 * 2 matrix, nine children are matrixed into 3 * 3 matrix, 16 into 4 * 4, etc. Still, if we limit the number of columns to 4, 20 children would be matrixed into a 4 * 5 matrix.
+
+### Sources
+* [UI Components](https://github.com/BasicPrimitives/react-demo/tree/master/client/src/containers/OrgEditor)
+* [Redux Store](https://github.com/BasicPrimitives/react-demo/blob/master/client/src/redux/modules/demos/orgeditor.js)
diff --git a/server/src/static/partners.md b/server/src/static/partners.md
@@ -3,7 +3,7 @@
 * General partner
 * Limited Partner
 
-Organizational chart provides simplified support for multiple parents, multiple managers or multiple co-heads in hierarchy. Child item defined as General partner added to the same level as its parent item and logically shares children. General & Limited item types cannot have their own children, but may have Advisers & Assistants. Limited partner has no connection to parent but it shares children in hierarchy.
+The organizational chart control provides simplified support for multiple parents, managers, or co-heads in the hierarchy. If a child node item type is a general partner, the component places it at the same level as its logical parent item and visually shares children. General & limited item types cannot have their children but may have advisers & assistants. The limited partner has no connection to the parent node, but it shares children.
 
 ### Various Annotations
 * Connector Annotation
@@ -14,3 +14,7 @@ Organizational chart provides simplified support for multiple parents, multiple
 * Diagram reset
 * PDF file generation
 * Diagram options drawer
+
+### Sources
+* [UI Components](https://github.com/BasicPrimitives/react-demo/blob/master/client/src/containers/Partners/Partners.js)
+* [Redux Store](https://github.com/BasicPrimitives/react-demo/blob/master/client/src/redux/modules/demos/partners.js)
diff --git a/server/src/static/patents.md b/server/src/static/patents.md
@@ -1,6 +1,6 @@
 ## Demoed features
-### Multiple inheritance diagram having grand parent relations
-Patents data has massive number of references to grandparents, basically every patent has links to every grandparent patent in database, their visualization is meaningless and creates visual clutter, so in order to resolve this problem `famDiagram` control provides option to hide direct grand parents connectors. So this demo, instead of visualizing direct connections to grandparents, shows referenced grandparents with custom template and highlights connection with highlight path annotation, so if some grandparent is outside of the current view, end user has indication that there are grandparents directly connected to the current cursor item.
+### Multiple-inheritance diagram having grandparent relations
+Patents data has many references to grandparents; basically, every patent has links to every grandparent patent in the database. Their visualization is hard to trace and creates visual clutter, so to resolve this problem, `famDiagram` control provides an option to hide them. So this demo, instead of visualizing direct connections to grandparents, shows referenced grandparents with a custom template. Plus, the demo application highlights connection with highlight path annotation, which provides a visual indication that the item has a relationship with nodes outside viewport boundaries. 
 
 ### Features
 * Hiding grand parent connections
@@ -11,3 +11,6 @@ Patents data has massive number of references to grandparents, basically every p
 * PDF file generation
 * Diagram options drawer
 
+### Sources
+* [UI Components](https://github.com/BasicPrimitives/react-demo/blob/master/client/src/containers/Patents/Patents.js)
+* [Redux Store](https://github.com/BasicPrimitives/react-demo/blob/master/client/src/redux/modules/demos/patents.js)
diff --git a/server/src/static/techtree.md b/server/src/static/techtree.md
@@ -12,4 +12,8 @@ This alignment priority can then be used to create a full sequence, branch or ch
 ### General
 * Diagram reset
 * PDF file generation
-* Diagram options drawer
+* Diagram options drawer
+
+### Sources
+* [UI Components](https://github.com/BasicPrimitives/react-demo/blob/master/client/src/containers/TechTree/TechTree.js)
+* [Redux Store](https://github.com/BasicPrimitives/react-demo/blob/master/client/src/redux/modules/demos/techtree.js)
diff --git a/server/src/static/verticallayoutorganizationalchart.md b/server/src/static/verticallayoutorganizationalchart.md
