Update docs for node snap and add Keyboard Shortcut Guide

2021-10-22 10:09:57 -05:00
1 parent a3081bcf4c
commit 83bb2edec4
@@ -0,0 +1,136 @@
+{
+    "topic": "Quick Guides",
+    "pageNumber": 1,
+    "type": "Keyboard Shortcut Quick Guide",
+    "definition": {
+        "text": "Superalgos offers a number of keyboard shortcuts to make working with the platform more efficent and user friendly.",
+        "updated": 1634909540261
+    },
+    "paragraphs": [
+        {
+            "style": "Text",
+            "text": "Here is the current list of all implemented shortcuts and options for customazation:",
+            "updated": 1634909619221
+        },
+        {
+            "style": "Subtitle",
+            "text": "General Shortcuts"
+        },
+        {
+            "style": "List",
+            "text": "Save the current workspace: Ctrl + Shift + Alt + Key-S ",
+            "updated": 1634908447626
+        },
+        {
+            "style": "List",
+            "text": "Display Reference Connections: Ctrl + Shift + Alt + Key-R",
+            "updated": 1634908480733
+        },
+        {
+            "style": "List",
+            "text": "Display Parent Connections: Ctrl + Shift + Alt + Key-C",
+            "updated": 1634908495968
+        },
+        {
+            "style": "List",
+            "text": "Adjust Chart Aspect Ratio: Ctrl + Shift + Alt + Key-A"
+        },
+        {
+            "style": "List",
+            "text": "Toggle Map Mode: Ctrl + Shift + Key-M"
+        },
+        {
+            "style": "Success",
+            "text": "You can change the shortcut key for these general shortcuts by adjusting the config of your Space Settings node found under the Design Space node. See the Space Settings node page for more details.",
+            "updated": 1634909647891
+        },
+        {
+            "style": "Subtitle",
+            "text": "Node Manipulation Shortcuts",
+            "updated": 1634909665231
+        },
+        {
+            "style": "List",
+            "text": "While hovering over a node: Select a Node to move Ctrl + Shift + Key-Z",
+            "updated": 1634910777397
+        },
+        {
+            "style": "List",
+            "text": "While hovering over nothing: Clears the selected node Ctrl + Shift + Key-Z",
+            "updated": 1634910711538
+        },
+        {
+            "style": "List",
+            "text": "Move Selected node to current position of Mouse Pointer: Ctrl + Shift + Key-X",
+            "updated": 1634910953347
+        },
+        {
+            "style": "Note",
+            "text": "Node must be pinned in order to move.",
+            "updated": 1634911098847
+        },
+        {
+            "style": "List",
+            "text": "Retrieve a lost/out of bounds node: Ctrl + Shift + Key-K"
+        },
+        {
+            "style": "Subtitle",
+            "text": "Productivity Shortcuts"
+        },
+        {
+            "style": "List",
+            "text": "Capture a static PNG image: Ctrl + F8 ",
+            "updated": 1634908593022
+        },
+        {
+            "style": "List",
+            "text": "Start capturing a GIF video: Ctrl + F9 hit the same key combination again to end the capture. ",
+            "updated": 1634908656330
+        },
+        {
+            "style": "Note",
+            "text": "Once the capture ends, it takes some time to process the capture and generate the final file."
+        },
+        {
+            "style": "List",
+            "text": "Start capturing a WEBM video: Ctrl + F10 hit the same key combination again to end the capture. ",
+            "updated": 1634908707702
+        },
+        {
+            "style": "Note",
+            "text": "WEBM videos are processed instantly."
+        },
+        {
+            "style": "List",
+            "text": "Display animation preformance: Ctrl + Shift + Alt + F11",
+            "updated": 1634910183292
+        },
+        {
+            "style": "List",
+            "text": "Print Node Object of current Node to browser console: Ctrl + Shift + Alt + F12",
+            "updated": 1634910470824
+        },
+        {
+            "style": "Subtitle",
+            "text": "Custom Shortcuts"
+        },
+        {
+            "style": "List",
+            "text": "It is also possible to set a custom shortcut to any node you would like. Simply hover over a node and hit Ctrl + Alt + your preferred key to assign the shortcut.",
+            "updated": 1634909920250
+        },
+        {
+            "style": "Note",
+            "text": "A more detailed walk through can be found here: Keyboard Shortcuts to Nodes"
+        },
+        {
+            "style": "Subtitle",
+            "text": "General Navigation"
+        },
+        {
+            "style": "Text",
+            "text": "You can find additional descriptions of how to use your mouse and keybord to navigate the Charting Space and Design Space at the Basic Navigation page.",
+            "updated": 1634912820206
+        }
+    ]
+}
@@ -42,8 +42,8 @@
        },
        {
            "style": "List",
-            "text": "<kbd>Ctrl</kbd> or <kbd>⌘</kbd> + <kbd>Shift</kbd> + <kbd>↑</kbd> to close the charting space and open the design space.",
-            "updated": 1610040275547
+            "text": "Ctrl or <kbd>⌘</kbd> + Shift + ↑ to close the charting space and open the design space.",
+            "updated": 1634912063838
        },
        {
            "style": "List",
@@ -96,8 +96,49 @@
        },
        {
            "style": "List",
-            "text": "<kbd>Ctrl</kbd> or <kbd>⌘</kbd> + <kbd>↓</kbd> to pan downwards.",
-            "updated": 1610040740709
+            "text": "Ctrl or <kbd>⌘</kbd> + ↓ to pan downwards.",
+            "updated": 1634912309430
+        },
+        {
+            "style": "Title",
+            "text": "Moving Nodes"
+        },
+        {
+            "style": "Text",
+            "text": "There are two main ways to move a node:"
+        },
+        {
+            "style": "Success",
+            "text": "No matter what method you use, make sure the node is Pinned. Otherwise it will snap back to its original position.",
+            "updated": 1634914254508
+        },
+        {
+            "style": "List",
+            "text": "Click on a node while holding Ctrl. Then use the arrow keys ← → ↑ ↓ to drag the node to your desired location."
+        },
+        {
+            "style": "List",
+            "text": "The second method copies the node you wish to move and then snaps it to the new position. In order to do this, first find the Save Node to Move menu option on the node you wish to move and click it. Then move to a different node near where you would like the current node and click the Snap Saved Node to Position button.",
+            "updated": 1634914182709
+        },
+        {
+            "style": "Gif",
+            "text": "GIFs/Foundations/Docs/design-space/how-to-snap-node.gif",
+            "updated": 1634915106388
+        },
+        {
+            "style": "Text",
+            "text": "There are also keyboard shortcuts to acomplish node snapping. See Keyboard Shortcut Quick Guide page for more details.",
+            "updated": 1634915239339
+        },
+        {
+            "style": "Title",
+            "text": "Keyboard Shortcuts"
+        },
+        {
+            "style": "Text",
+            "text": "Superalgos also offers a range of keyboard shortcuts to help make working with the platfom easier. You can find a list of all current shortcuts at the Keyboard Shortcut Quick Guide page.",
+            "updated": 1634915308602
        },
        {
            "style": "Text",
@@ -18,7 +18,8 @@
        },
        {
            "style": "List",
-            "text": "Click Ctrl or ⌘ + Alt + your preferred key to assign the shortcut."
+            "text": "Click Ctrl or Cmd + Alt + your preferred key to assign the shortcut.",
+            "updated": 1634909858587
        },
        {
            "style": "List",