DOCSP-30629 Working with Entities Drawer (#15)

* DOCSP-30629 Working with Entities Drawer

Author: ianf-mongodb

source/diagrams/diagrams.txt

@@ -37,9 +37,9 @@ when you update your project's data model.
 Learn More
 ----------
 
-- :ref:`understand-diagrams`
+- :ref:`rm-understand-diagrams`
 
-- :ref:`navigate-diagrams-and-entities`
+- :ref:`rm-navigate-diagrams`
 
 - :ref:`rm-apply-layout`
 

source/diagrams/navigate-diagrams/navigate-diagrams.txt

@@ -1,4 +1,4 @@
-.. _navigate-diagrams-and-entities:
+.. _rm-navigate-diagrams:
 
 ==============================
 Navigate Diagrams and Entities
@@ -76,3 +76,4 @@ Learn More
    :titlesonly:
 
    /diagrams/navigate-diagrams/apply-layout
+   /diagrams/navigate-diagrams/working-with-entities/working-with-entities

source/diagrams/navigate-diagrams/working-with-entities/copy-entities.txt

@@ -1,3 +1,55 @@
+.. _rm-copy-entities:
+
 =============
 Copy Entities
-=============
+=============
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+Select one or more entities to copy to a different diagram. You 
+can copy the entities to a newly created diagram or to a different existing 
+diagram. Copying entities lets you customize diagrams to help you visualize 
+the different ways your data can be represented in MongoDB. 
+
+Steps
+-----
+
+#. From the :guilabel:`Diagram` view or :guilabel:`Schema model` pane, 
+   :ref:`select the entities <rm-select-entities>` you want to copy. 
+
+#. Right click and select :guilabel:`Copy entities to`. 
+   
+   .. note::
+
+      You can also click the ellipsis menu in the top-right pane and select :guilabel:`Copy entities to`.
+
+#. Select one of the following options to copy your entities to: 
+
+   .. list-table::
+      :header-rows: 1
+      :widths: 33 33 33
+
+      * - If you want to
+        - Then
+        - Result
+      * - Copy entities to an existing diagram.
+        - Select the existing diagram name in the :guilabel:`Target diagram` drop-down. 
+        - The copied entities are displayed with the other pre-existing entities in the diagram.
+      * - Create a new diagram and copy entities to it.
+        - Select :guilabel:`Create new diagram` in the :guilabel:`Target diagram` drop-down.
+        - Only the copied entities are displayed in the new diagram.
+
+#. Click the green :guilabel:`Copy entities` button. 
+
+Learn More
+----------
+
+- :ref:`rm-understand-diagrams`
+- :ref:`rm-navigate-diagrams`
+- :ref:`rm-move-entities`
+- :ref:`rm-toggle-visibility-entities`
+- :ref:`rm-delete-entities`

source/diagrams/navigate-diagrams/working-with-entities/delete-entities.txt

@@ -1,3 +1,63 @@
+.. _rm-delete-entities:
+
 ===============
 Delete Entities
-===============
+===============
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+Select one or more entities to delete from your Relational or MongoDB 
+model. Deleting entities allows you to:
+
+- Customize the size of your diagram.
+- Focus on entities you select.
+- Visualize your relational database's schema to help determine how to best 
+  represent your data in MongoDB. 
+
+About this Task
+---------------
+
+- You can revert any deletion. 
+
+- Deleting an entity on the :guilabel:`Relational Model` is the equivalent of removing a 
+  table from the project's model. 
+
+  - To revert this change, re-add the table to the :guilabel:`Manage Relational Model` 
+    dialog. See :ref:`manage the relational model <rm-manage-relational-model>`.
+
+- Deleting an entity on the :guilabel:`MongoDB Model` is the equivalent of removing all 
+  mappings to that collection. 
+  
+  - To revert this change, re-add a :ref:`new documents mapping rule <rm-new-documents>` from
+    the source table.
+
+Steps
+-----
+
+#. :ref:`Select the entities<rm-select-entities>`, and press 
+   delete on your keyboard. 
+
+   Relational Migrator prompts removal commands that include either removing the 
+   entity from the model or hiding the entity from the diagram.
+
+   .. note:: 
+
+      You can also right-click the entities and select :guilabel:`Remove Entity` to prompt 
+      removal commands.
+
+#. Specify where you want to delete the entity.
+   Select :guilabel:`Remove from relational model` or :guilabel:`Remove from MongoDB model`.
+
+#. Click :guilabel:`Remove x tables` or :guilabel:`Remove x collections`.
+   The button is modified to reflect what you have selected to delete.
+
+Learn More
+----------
+
+- :ref:`rm-move-entities`
+- :ref:`rm-copy-entities`
+- :ref:`rm-toggle-visibility-entities` 

source/diagrams/navigate-diagrams/working-with-entities/hide-entities.txt

@@ -1,3 +1,93 @@
+.. _rm-toggle-visibility-entities:
+
 =============================
 Toggle Visibility of Entities
-=============================
+=============================
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+You can show or hide entities in your diagrams. Showing and hiding entities only 
+affects the current diagram and does not affect the model. By toggling the visibility 
+of entities, you can focus your attention on specific entities and relationships 
+and reduce clutter in your diagram.
+
+About this Task
+---------------
+
+The visibility of an entity:
+
+- Applies *per diagram*. If you have multiple diagrams, toggling the
+  visibility of an entity in one diagram does not affect that entity in
+  other diagrams. 
+
+- Persists as part of the diagram. For example, if you hide an entity,
+  that entity remains hidden when you reload the diagram.
+
+Changing the visibility of an entity does not affect the placement of
+other entities in the diagram.
+
+Changing Visibility Can Affect the Opposite View
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Changing the visibility of an entity in one view (either the Relational
+or MongoDB view) can affect the visibility of entities in the other
+view. Specifically:
+
+- When you hide an entity, any entities from the opposite view that are
+  linked to the current entity with mapping rules are automatically
+  hidden, provided those linked entities are not also linked to other
+  visible entities in the original view.
+
+- When you revert the hiding of an entity, any entities from the opposite view 
+  that are linked to the current entity with mapping rules are automatically
+  unhidden.
+
+.. _rm-hide-schema-model:
+
+Hide Entities using the Schema Model Pane
+-----------------------------------------
+
+To hide an entity, hover over the entity in the :guilabel:`Schema Model` pane and click 
+the eye icon.
+
+- An open eye icon indicates that the entity is visible.
+- An eye icon with a line through it indicates that the entity is hidden.
+
+.. _rm-hide-diagram:
+
+Hide Entities using a Diagram
+-----------------------------
+
+#. :ref:`Select the entities <rm-select-entities>` you want to hide.
+
+#. Press the ``delete`` key on your keyboard. Relational Migrator prompts 
+   removal commands.
+
+#. Select :guilabel:`Hide from the diagram`.
+
+#. Click the red :guilabel:`Hide` button.
+
+.. note::
+
+    You can also right-click an entity and select :guilabel:`Hide entity` 
+    to hide it. 
+
+Showing Entities
+----------------
+
+You can show hidden entities in both collections and tables.
+
+To show hidden entities, in the :guilabel:`Schema Model` pane, click they eye symbol next 
+to the collection or table you want to be visible in your diagram. The open eye 
+icon indicates that the entity is visible.
+
+Learn More
+----------
+
+- :ref:`Move Entities to Different Diagram <rm-move-entities>`
+- :ref:`Copy Entities to Different Diagrams <rm-copy-entities>`
+- :ref:`Delete Entities <rm-delete-entities>`

source/diagrams/navigate-diagrams/working-with-entities/move-entities.txt

@@ -1,3 +1,54 @@
+.. _rm-move-entities:
+
 =============
 Move Entities
-=============
+=============
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+You can select one or more entities and move them to a different diagram. You 
+can move the entities to a newly created diagram or to a different existing 
+diagram. Moving entities lets you customize diagrams to help you visualize 
+the different ways your data can be represented in MongoDB. 
+
+Steps
+-----
+
+#. :ref:`Select the entities <rm-select-entities>` you want to move.
+
+#. To view commands for your entities, click the ellipsis menu in the right pane.
+
+   .. image:: /img/diagrams/entity-menu.png
+      :alt: Entity Pane
+
+   .. note::
+
+      You can also right-click the entities to view commands.
+
+#. Click :guilabel:`Move entities to`.
+
+#. Choose how to move the entities.
+
+   You can choose to move your entities to an existing diagram *or* you can 
+   choose to create a new diagram to move your entities to. 
+
+#. Move the entities to the selected diagram.
+
+   The selected entities are hidden in the original diagram and are displayed 
+   in the diagram they are moved to. 
+
+   - If you selected an existing diagram, the moved entities are displayed 
+     with the other pre-existing entities in the diagram.
+
+   - If you selected :guilabel:`Create new diagram`, only the moved entities are displayed.
+
+Learn More
+----------
+
+- :ref:`Copy Entities to Different Diagrams <rm-move-entities>`
+- :ref:`Hide Entities <rm-toggle-visibility-entities>`
+- :ref:`Delete Entities <rm-delete-entities>`

source/diagrams/navigate-diagrams/working-with-entities/select-entities.txt

@@ -1,3 +1,74 @@
+.. _rm-select-entities:
+
 ===============
 Select Entities
-===============
+===============
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+You can select one or more entities. You can select entities either in the 
+:ref:`diagram view <rm-diagram-view>` or in the :ref:`schema model <rm-schema-model-pane>` pane. 
+After you select your entities, you can move, copy, delete, or hide your selected 
+entities.
+
+.. _rm-diagram-view:
+
+Select Entities in Diagram View
+-------------------------------
+
+Select Individual Entities
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+To select entities *individually* in the diagram view, click an entity to select 
+it. 
+
+To add entities to the existing selection, hold the :guilabel:`command` (Mac) key or the 
+:guilabel:`ctrl` (Windows/Linux) key. 
+
+Select Multiple Entities
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+To select *multiple entities* at once in the diagram view, hold the :guilabel:`Shift` 
+key and draw a box around all the entities you want to select.
+
+.. _rm-schema-model-pane:
+
+Select Entities in Schema Model Pane
+------------------------------------
+
+Select Individual Entities
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+To select entities *individually* in the left pane, click an entity to select it. 
+
+To add entities to the existing selection, hold the :guilabel:`command` (Mac) key or the 
+:guilabel:`ctrl` (Windows/Linux) key.
+
+Select Multiple Entities
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+To select *multiple entities* at once in the left pane, hold the :guilabel:`Shift` key 
+and select two entities. All entities in between the two selected entities are 
+added to the selection.
+
+Clear Selected Entities
+-----------------------
+
+You can clear selected entities in the following ways:
+
+- Hold down the :guilabel:`command` (Mac) key or the :guilabel:`ctrl` (Windows/Linux) 
+  key and click an entity to remove. 
+- Press the :guilabel:`esc` key to clear all entities. 
+- Click the diagram background to clear all entities.
+
+Learn More
+----------
+
+- :ref:`rm-move-entities`
+- :ref:`rm-copy-entities`
+- :ref:`rm-toggle-visibility-entities`
+- :ref:`rm-delete-entities`