GITBOOK-48: utility function descriptions

BlockResearchGroup · Nov 10, 2024 · 6c6b98a · 6c6b98a
1 parent 9e8bb7d
commit 6c6b98a
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 28 deletions.
diff --git a/gitbook/manual/9.-utilities.md b/gitbook/manual/9.-utilities.md
@@ -6,11 +6,7 @@
 | ---------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
 | <img src="../.gitbook/assets/RV_undo.svg" alt="" data-size="original"> | <p><strong>Rhino command name</strong></p><p><code>RV_session_undo</code></p> | <p><strong>source file</strong></p><p><a href="../../plugin/RV_session_undo.py"><code>RV_session_undo.py</code></a></p> |
 
-
-
-
-
-
+The `RV_session_undo` command reverses recent changes made to RhinoVAULT objects.
 
 ***
 
@@ -20,11 +16,13 @@
 | ---------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
 | <img src="../.gitbook/assets/RV_redo.svg" alt="" data-size="original"> | <p><strong>Rhino command name</strong></p><p><code>RV_session_redo</code></p> | <p><strong>source file</strong></p><p><a href="../../plugin/RV_session_redo.py"><code>RV_session_redo.py</code></a></p> |
 
+The `RV_session_redo` command steps back through geometry changes activated by the `RV_session_undo` command.
 
+***
 
-
-
-
+{% hint style="danger" %}
+This function is not the same as Rhino's built-in undo function; pressing Ctrl+z will not undo RhinoVAULT functions. If you want to undo a RhinoVAULT-specific action, you must press this button. &#x20;
+{% endhint %}
 
 ***
 
@@ -34,11 +32,7 @@
 | ---------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
 | <img src="../.gitbook/assets/RV_open.svg" alt="" data-size="original"> | <p><strong>Rhino command name</strong></p><p><code>RV_session_open</code></p> | <p><strong>source file</strong></p><p><a href="../../plugin/RV_session_open.py"><code>RV_session_open.py</code></a></p> |
 
-
-
-
-
-
+`RV_session_open` command opens a previously saved RhionVAULT session file.
 
 ***
 
@@ -48,11 +42,7 @@
 | -------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
 | <img src="../.gitbook/assets/RV_save (1).svg" alt="" data-size="original"> | <p><strong>Rhino command name</strong></p><p><code>RV_session_save</code></p> | <p><strong>source file</strong></p><p><a href="../../plugin/RV_session_save.py"><code>RV_session_save.py</code></a></p> |
 
-
-
-
-
-
+`RV_session_save` command saves the current RhinoVAULT session (all diagrams and settings) as an external JSON file that can be opened and resumed later.
 
 ***
 
@@ -62,11 +52,7 @@
 | ------------------------------------------------------------------------ | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
 | <img src="../.gitbook/assets/RV_redraw.svg" alt="" data-size="original"> | <p><strong>Rhino command name</strong></p><p><code>RV_scene_redraw</code></p> | <p><strong>source file</strong></p><p><a href="../../plugin/RV_scene_redraw.py"><code>RV_scene_redraw.py</code></a></p> |
 
-
-
-
-
-
+`RV_scene_redraw` redraws or "refreshes" all objects in the scene.
 
 ***
 
@@ -76,7 +62,4 @@
 | ----------------------------------------------------------------------- | ---------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
 | <img src="../.gitbook/assets/RV_clear.svg" alt="" data-size="original"> | <p><strong>Rhino command name</strong></p><p><code>RV_scene_clear</code></p> | <p><strong>source file</strong></p><p><a href="../../plugin/RV_scene_clear.py"><code>RV_scene_clear.py</code></a></p> |
 
-
-
-
-
+`RV_scene_clear` deletes all RhinoVAULT objects from the scene and resets all settings parameters. A popup window will ask for confirmation.
diff --git a/gitbook/manual/settings.md b/gitbook/manual/settings.md
@@ -1,5 +1,7 @@
 # 8. Settings
 
+## Settings
+
 |                                                                                |                                                                           |                                                                                                                 |
 | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
 | <img src="../.gitbook/assets/RV_settings (1).svg" alt="" data-size="original"> | <p><strong>Rhino command name</strong></p><p><code>RV_settings</code></p> | <p><strong>source file</strong></p><p><a href="../../plugin/RV_settings.py"><code>RV_settings.py</code></a></p> |
@@ -8,7 +10,7 @@ Under `Settings`, global parameters (`RhinoVAULT`, `ThrustNetworkAnalysis`) and
 
 ***
 
-## Settings categories
+## Categories
 
 ### RhinoVAULT