mirror of
https://github.com/EiffelSoftware/eiffel-org.git
synced 2026-03-01 12:20:46 +01:00
Created Documentation branch for 25.02
git-svn-id: https://svn.eiffel.com/eiffel-org/trunk@2485 abb3cda0-5349-4a8f-a601-0c33ac3a8c38
This commit is contained in:
eifops
@@ -0,0 +1,11 @@
|
||||
[[Property:title|Creating a new class]]
|
||||
[[Property:weight|0]]
|
||||
[[Property:uuid|a1d33a03-a691-d7ea-c081-55c2c991e77f]]
|
||||
* To create a new class pick from the '''Create a new class''' button. [[Image:16x16--new-class-icon]] Then drop on the diagram where you want to place the class bubble. A dialog now appears where you can enter a name and specify the cluster.
|
||||
|
||||
{{seealso|<br/>
|
||||
[[New class command|Creating a new class using the address bar]] }}
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,10 @@
|
||||
[[Property:title|Creating a new feature]]
|
||||
[[Property:weight|1]]
|
||||
[[Property:uuid|f9b79d1c-6ca7-d0a3-1374-e71a8b450644]]
|
||||
To create a new feature just [[Creating client-supplier links|add a new client link]] in the diagram.
|
||||
{{seealso|
|
||||
[[Adding a feature]] }}
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,17 @@
|
||||
[[Property:title|Deleting items]]
|
||||
[[Property:weight|6]]
|
||||
[[Property:uuid|fc702c4e-2e14-7eca-8a61-3acee97f4a26]]
|
||||
* Pick-and-drop the item you want to remove in the '''Delete''' hole. [[Image:16x16--general-delete-icon]] For links, the associated Eiffel code will be removed from the class text. Clusters and classes will be deleted from disk!
|
||||
|
||||
{{warning|An action that deletes one or more files or directories cannot be undone! }}
|
||||
|
||||
|
||||
{{tip|Turn on '''Automatic backups'''. EiffelStudio will make a copy of each class file every time a compilation is done. }}
|
||||
|
||||
|
||||
{{seealso|<br/>
|
||||
[[Removing items from a view|Removing items from the view only]] }}
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,5 @@
|
||||
[[Property:title|Altering the system]]
|
||||
[[Property:weight|2]]
|
||||
[[Property:uuid|89337378-9070-68c5-1e29-e6325c292118]]
|
||||
|
||||
|
||||
@@ -0,0 +1,10 @@
|
||||
[[Property:title|Refactoring]]
|
||||
[[Property:weight|2]]
|
||||
[[Property:uuid|08099f7b-aaf4-b629-17f6-b637c4efd63a]]
|
||||
Refactoring actions include renaming classes and features, and relocating features to an ancestor class. Refactoring actions start with a compilation and also end with a compilation. Refactoring has a separate undo functionality which allows you to undo a refactoring action as long as no changes have been made to the classes that have been refactored.
|
||||
|
||||
The [[Main toolbars|Refactoring toolbar]] contains holes for both the '''Rename''' ([[Image:refactor-rename-icon]]) and '''Pull up''' ([[Image:refactor-feature-up-icon]]) refactoring actions. So, if the Refactoring toolbar is visible, you can "pick" a feature, for example, and drop it onto one of the refactoring holes. If the Refactoring toolbar is not visible, you can [[Main toolbars|make it visible]] or you can access refactoring actions through the context menu associated with a class or feature name (right-click to see the context menu, or shift-right-click if you are in "pick-and-drop by default" mode).
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
[[Property:title|Pull up Feature]]
|
||||
[[Property:weight|5]]
|
||||
[[Property:uuid|445f93dc-b81a-29ea-440b-42e394038c53]]
|
||||
# Start the '''Pull up feature''' refactoring action by either:
|
||||
## Selecting '''Refactor->Pull up''' from the context menu associated with the feature you want to relocate.
|
||||
## Picking the feature and dropping its pebble in the '''Pull up''' hole ([[Image:refactor-feature-up-icon]]) on the [[Main toolbars|refactoring toolbar]].
|
||||
# After a compilation the '''Select Class''' dialog appears. You can choose the parent where to pull the feature.
|
||||
# Click '''OK'''.
|
||||
|
||||
@@ -0,0 +1,16 @@
|
||||
[[Property:title|Rename Class]]
|
||||
[[Property:weight|3]]
|
||||
[[Property:uuid|e70f2760-389a-4c54-ed10-b731dc70e952]]
|
||||
# Start the '''Rename''' refactoring action by either:
|
||||
## Selecting '''Refactor->Rename''' from the context menu associated with the class you want to rename.
|
||||
## Picking the class and dropping its pebble into the '''Rename''' hole ([[Image:refactor-rename-icon]]) on the [[Main toolbars|refactoring toolbar]].
|
||||
# After a compilation the '''Refactoring: Class Rename''' dialog appears. You can enter a new name.
|
||||
# You can choose between these options:
|
||||
#* '''Compiled Classes''': only to the refactoring in compiled classes.
|
||||
#* '''All Classes''': do the refactoring in all classes, even in uncompiled classes.
|
||||
#* '''Rename File''': rename the file of the class to correspond with the class name, if another file with this name already exists the file will not be renamed and a warning will be given.
|
||||
#* '''Replace Name in Comments''': replace usage of the class name in comments that follow the '''{CLASSNAME}''' syntax.
|
||||
#* '''Replace Name in Strings''': replace usage of the class name in strings that follow the '''{CLASSNAME}''' syntax.
|
||||
#* '''Reuse existing name''': allow two or more classes to have the same name during refactoring (note: the compiler will still report an error, if there are two or more classes conflicting with same name, but this option could be use to merge two classes).
|
||||
# Click '''OK'''.
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
[[Property:title|Rename Feature]]
|
||||
[[Property:weight|4]]
|
||||
[[Property:uuid|03a8b4de-3c7b-0f9e-ecd2-48ff2035eaf9]]
|
||||
# Start the '''Rename feature''' refactoring action by either:
|
||||
## Selecting '''Refactor->Rename''' from the context menu associated with the feature you want to rename.
|
||||
## Picking the feature and dropping its pebble into the '''Rename''' hole ([[Image:refactor-rename-icon]]) on the [[Main toolbars|refactoring toolbar]].
|
||||
# After a compilation the '''Refactoring: Feature Rename''' dialog appears. You can enter a new name.
|
||||
# You can choose between these options:
|
||||
#* '''Replace Name in Comments''': replace usage of the feature name in comments that follow the '''`featurename`''' syntax.
|
||||
#* '''Replace Name in Strings''': replace usage of the feature name in strings that follow the '''`featurename`''' syntax.
|
||||
#* '''Reuse existing name''': allow two or more features to have the same name during refactoring (note: the compiler will still report an error, if there are two or more features with same name, but this option could be use to merge two features).
|
||||
# Click '''OK'''.
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
[[Property:title|Exporting a diagram to PNG image file]]
|
||||
[[Property:weight|6]]
|
||||
[[Property:uuid|be2bc19d-29fb-8dda-7b25-b627c5eaff2d]]
|
||||
* To save the current diagram to an image file, click '''Export diagram to PNG'''. [[Image:diagram-export-to-png-icon]] <br/>
|
||||
A dialog will pop up where you can specify a location for the generated file.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,5 @@
|
||||
[[Property:title|Designing a project]]
|
||||
[[Property:weight|5]]
|
||||
[[Property:uuid|e025afd9-0fcf-8300-2ef5-b3711397f773]]
|
||||
|
||||
|
||||
@@ -0,0 +1,16 @@
|
||||
[[Property:title|Creating aggregate client-supplier links]]
|
||||
[[Property:weight|2]]
|
||||
[[Property:uuid|824aa764-3d36-022e-e2c5-8e6c61b0b91d]]
|
||||
# Select the button '''Create new aggregate client/supplier links'''. [[Image:new-aggregate-supplier-link-icon]]
|
||||
# Start pick-and-drop on the class where the feature should be added.
|
||||
# Drop on the desired supplier class.
|
||||
# The '''Create feature''' dialog appears. See [[Adding an attribute|Creating an attribute]] or [[Adding a function|Creating a function]] using the feature wizard for more information.
|
||||
|
||||
{{seealso|<br/>
|
||||
[[Creating client-supplier links|Creating client/supplier links]] <br/>
|
||||
[[Creating inheritance links|Creating Inheritance links]] <br/>
|
||||
[[New feature dialog]] }}
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,15 @@
|
||||
[[Property:title|Creating client-supplier links]]
|
||||
[[Property:weight|1]]
|
||||
[[Property:uuid|dea329a5-0b78-8423-a0a0-a8e2516c36e7]]
|
||||
# Select the button '''Create new client/supplier links'''. [[Image:new-supplier-link-icon]]
|
||||
# Start pick-and-drop on the class where the feature should be added.
|
||||
# Drop on the desired supplier class.
|
||||
# The '''Create feature''' dialog appears. See [[Adding an attribute|Creating an attribute]] or [[Adding a function|Creating a function]] using the feature wizard for more information.
|
||||
|
||||
{{seealso|<br/>
|
||||
[[Creating aggregate client-supplier links|Creating aggregate client/supplier links]] <br/>
|
||||
[[Creating inheritance links|Creating Inheritance links]] <br/>
|
||||
[[New feature dialog]] }}
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,5 @@
|
||||
[[Property:title|Creating handles]]
|
||||
[[Property:weight|4]]
|
||||
[[Property:uuid|0e393d9e-88ec-6855-1f38-9f8fbd57489a]]
|
||||
Once you have created a link to show the relationship between the classes in your system you may wish to organize them. One technique for doing this easily is to create handles in the links. A handle is simply a point anywhere along the link that causes the link to change direction. To create a handle just click the mouse at the exact point on the link you wish to put the handle and then drag it to where you want the handle to be positioned in the overall diagram. You can create as many handles as you wish and use them to organize you diagram so that it is easier to interpret and so that links do not get too jumbled and become incoherent.
|
||||
|
||||
@@ -0,0 +1,16 @@
|
||||
[[Property:title|Creating inheritance links]]
|
||||
[[Property:weight|0]]
|
||||
[[Property:uuid|eb5649b8-0f9a-2f9f-2785-84c28a2127ca]]
|
||||
# Select the button '''Create new inheritance links'''. [[Image:new-inheritance-link-icon]]
|
||||
# Start pick-and-drop on the class where the parent should be added.
|
||||
# Drop on the desired parent class.
|
||||
|
||||
{{note|This action will also add the parent in the class text. }}
|
||||
|
||||
{{seealso|<br/>
|
||||
[[Creating client-supplier links|Creating client/supplier links]] <br/>
|
||||
}}
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,5 @@
|
||||
[[Property:title|Managing links]]
|
||||
[[Property:weight|3]]
|
||||
[[Property:uuid|dddd0495-e341-c851-c364-e22d6100401b]]
|
||||
|
||||
|
||||
@@ -0,0 +1,26 @@
|
||||
[[Property:title|Using the link tool]]
|
||||
[[Property:weight|3]]
|
||||
[[Property:uuid|2ab61f4c-fb5a-901c-f2b3-3ee680f48569]]
|
||||
If you do not want straight arrows, you can insert handles on them. It is recommended that you use the link tool to do this, because it inserts the handles so that the angles in the line are exactly 90 degrees.
|
||||
* To apply straight angles to a link, drop it in the '''Put handles on a link''' hole. [[Image:diagram-force-right-angles-icon]]
|
||||
* The '''Link tool''' appears. Select the type of angle(s) you want for the link.
|
||||
|
||||
[[Image:link-tool]]
|
||||
|
||||
The combinations of handles you can apply to your link are:
|
||||
* Put handle left <br/>
|
||||
[[Image:link-tool-left]]
|
||||
* Put handle right <br/>
|
||||
[[Image:link-tool-right]]
|
||||
* Put two handles left <br/>
|
||||
[[Image:link-tool-two-left]]
|
||||
* Put two handles right <br/>
|
||||
[[Image:link-tool-two-right]]
|
||||
* Remove handles <br/>
|
||||
[[Image:link-tool-no-handles]]
|
||||
|
||||
* Click '''OK''' when you are satisfied with the result, pressing '''Cancel''' will put the link back the way it was.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
[[Property:title|Adding a view]]
|
||||
[[Property:weight|0]]
|
||||
[[Property:uuid|28444f17-3f20-72b5-dd5b-d812154a219f]]
|
||||
* To add a view of the current class or cluster, select the view you want to duplicate to the new one using the '''View''' combo box. <br/>
|
||||
[[Image:diagram-defaultview]]
|
||||
* Enter the name of the new view in the '''View''' combo box. <br/>
|
||||
[[Image:diagram-myview]]
|
||||
* Press enter. The view is now created.
|
||||
|
||||
@@ -0,0 +1,15 @@
|
||||
[[Property:title|Deleting a view]]
|
||||
[[Property:weight|1]]
|
||||
[[Property:uuid|4e53dcce-8b05-823e-6911-ac85b226a511]]
|
||||
|
||||
*To delete a view, select the view you want to remove using the '''View''' combo box. <br/>
|
||||
[[Image:diagram-defaultview]]
|
||||
*Click the '''Delete current view''' button. [[Image:16x16--general-delete-icon]] <br/>
|
||||
|
||||
*If you choose to confirm, the view has been deleted, and the "DEFAULT" view is selected.
|
||||
|
||||
|
||||
{{note|You cannot delete the view "DEFAULT". }}
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,5 @@
|
||||
[[Property:title|Managing views]]
|
||||
[[Property:weight|5]]
|
||||
[[Property:uuid|55423866-e62b-ad1f-73ef-1b05fbf3ea3f]]
|
||||
|
||||
|
||||
@@ -0,0 +1,10 @@
|
||||
[[Property:title|Adjusting Physics Settings]]
|
||||
[[Property:weight|11]]
|
||||
[[Property:uuid|b46746cc-28e9-0db6-7d26-7aa553605e00]]
|
||||
* You can adjust the behavour of the physics mode by altering various parameters in the physics settings dialog. To disaply the physics setting dialog press this button [[Image:diagram-physics-settings-icon]] .
|
||||
|
||||
{{tip|To see the effects of each parameter modify it whilst your diagram is in view and you will see the diagram adjust to the new settings dynamically. }}
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,10 @@
|
||||
[[Property:title|Anchoring]]
|
||||
[[Property:weight|10]]
|
||||
[[Property:uuid|a30d39b6-67a6-6456-f409-e26f5e870629]]
|
||||
* You may anchor a class to the diagram by right clicking the figure and dropping it onto the anchor button [[Image:diagram-anchor-icon]] .
|
||||
|
||||
{{tip|To see the effects of anchoring [[Turn on Physics Mode|turn on physics mode]] and then anchor a class as described above. Now [[Adjusting Physics Settings|open the physics settings dialog]] and adjust the sliders. In the diagram you will see all anchored classes do not move whilst those surrounding them adjust to the new settings. }}
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,10 @@
|
||||
[[Property:title|Change the Display Quality]]
|
||||
[[Property:weight|7]]
|
||||
[[Property:uuid|70e4813e-84b5-48e7-dddb-0e7f601125e3]]
|
||||
* To change the display quality of the diagram press the Toggle Quality button [[Image:diagram-toggle-quality-icon]] .
|
||||
|
||||
{{tip|Lower quality display is faster for drawing so is recommended for very large diagrams. }}
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
[[Property:title|Changing colors of classes]]
|
||||
[[Property:weight|3]]
|
||||
[[Property:uuid|0fe16da8-7d57-d32c-291a-4a05ee9a599e]]
|
||||
# Start pick-and-drop on the class bubble you want to change the color of.
|
||||
# Drop it in the '''Change color''' hole. [[Image:diagram-choose-color-icon]]
|
||||
# A color selection dialog appears. Select the color you want and click '''OK'''.
|
||||
[[Image:color-dialog-windows]]
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
[[Property:title|Changing system exploration depth]]
|
||||
[[Property:weight|1]]
|
||||
[[Property:uuid|edb48c11-23fb-65d2-28c2-75cda5659dd8]]
|
||||
* If you want to change the context of the current cluster or class in the diagram, click the '''Select depth of relations''' button. [[Image:diagram-depth-of-relations-icon]] <br/>
|
||||
* The '''Context''' dialog appears. The layout depends on whether the current context is one of a class or cluster.
|
||||
* Context is a class:
|
||||
|
||||
[[Image:context-dialog-class]]
|
||||
|
||||
* Context is a cluster:
|
||||
|
||||
[[Image:context-dialog-cluster]]
|
||||
|
||||
@@ -0,0 +1,10 @@
|
||||
[[Property:title|Iconifying and restoring a cluster]]
|
||||
[[Property:weight|6]]
|
||||
[[Property:uuid|2a40c334-b223-3dbf-8c85-abf19a72213f]]
|
||||
* If you do not want to hide the cluster, only its contents, iconify it by double clicking on the cluster label. Double clicking it again returns the cluster to its normal state.
|
||||
|
||||
{{tip|If the entire cluster is of no relevance to your diagram, [[Removing items from a view|hide it from the view]] altogether. }}
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,5 @@
|
||||
[[Property:title|Modifying the display]]
|
||||
[[Property:weight|4]]
|
||||
[[Property:uuid|a5bcb642-d18e-8d03-da28-6042cffa153a]]
|
||||
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
[[Property:title|Removing items from a view]]
|
||||
[[Property:weight|2]]
|
||||
[[Property:uuid|537ce4ac-5993-4b8f-af4a-55a2c6193da2]]
|
||||
* To remove an class, cluster, or link from the current view, use pick-and-drop to drop it in the '''Remove figure''' hole. [[Image:general-reset-icon]] . To remove a link handle you can also the same technique
|
||||
|
||||
{{note|If you want to remove the item from the system, use the [[Deleting items|Delete]] hole. }}
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,5 @@
|
||||
[[Property:title|Retrieving all classes into a cluster]]
|
||||
[[Property:weight|5]]
|
||||
[[Property:uuid|4f0cffc5-0be9-1dc6-0cd5-25688ad8acef]]
|
||||
* If you have a cluster in your view that is incomplete and you want to show all classes in it, drop the cluster into the '''Include all classes of cluster''' hole. [[Image:diagram-fill-cluster-icon]]
|
||||
|
||||
@@ -0,0 +1,7 @@
|
||||
[[Property:title|Showing or hiding links and labels]]
|
||||
[[Property:weight|0]]
|
||||
[[Property:uuid|8a59eb22-a428-0248-65cf-70a3dfda07ff]]
|
||||
* To toggle visibility of all client links, click '''Show/hide client-supplier links'''. [[Image:diagram-supplier-link-icon]]
|
||||
* To toggle visibility of all inheritance links, click '''Show/hide inheritance links'''. [[Image:diagram-inheritance-link-icon]]
|
||||
* To toggle visibility of all client link labels, click '''Show/hide labels'''. [[Image:diagram-show-labels-icon]]
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
[[Property:title|Switching between BON and UML View]]
|
||||
[[Property:weight|9]]
|
||||
[[Property:uuid|26db4526-db63-7b76-200f-dfac974de8ad]]
|
||||
* You can switch the diagran between BON and UML views by pressing the BON/UML Toggle Button [[Image:diagram-view-uml-icon]]
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,10 @@
|
||||
[[Property:title|Turn on Physics Mode]]
|
||||
[[Property:weight|8]]
|
||||
[[Property:uuid|03910ac4-6236-0a1d-667e-3a7c25b10c78]]
|
||||
* You can turn on and off physics to the diagram by pressing the physics mode button [[Image:diagram-toogle-physics-icon]]
|
||||
|
||||
{{tip|The particular configuration of the classes in your system when using the physics mode is determined by the various settings in the [[Adjusting Physics Settings|Physics Setting Dialog]] . }}
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
[[Property:title|Using the Cluster Legend]]
|
||||
[[Property:weight|12]]
|
||||
[[Property:uuid|b0d3dc3e-35e7-2668-533e-fefc3acef987]]
|
||||
* The cluster legend allows you to quickly determine which classes in the view belong to which clusters in the system by changing the colors to match those of cluster assigned ones. Pressing the legend button [[Image:diagram-show-legend-icon]] will display a list of all the clusters in the system for which at least one class is visible in the view. Next to each cluster name is a color, and pressing the top right color square will automatically set a unique color for each cluster and change the classes belonging to that cluster to match. Pressing again the legend button will hide it from view. The image below shows the legend in use and the classes colored.
|
||||
[[Image:cluster-legend]]
|
||||
|
||||
{{tip|Use the cluster legend also to quickly see sub-cluster organization within your overall cluster design.}}
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
[[Property:title|Zooming a diagram]]
|
||||
[[Property:weight|4]]
|
||||
[[Property:uuid|df6e1cb1-b955-84c1-d0ba-42c720be8cde]]
|
||||
* To enlarge the diagram, click '''Zoom in'''. [[Image:diagram-zoom-in-icon]] <br/>
|
||||
|
||||
* To shrink the diagram, click '''Zoom out'''. [[Image:diagram-zoom-out-icon]] <br/>
|
||||
|
||||
* To enlarge and shrink the diagram to a specific size use the Zoom combo box, enter the percentage size and press the Enter key.
|
||||
|
||||
@@ -0,0 +1,10 @@
|
||||
[[Property:title|Switching to the diagram tool]]
|
||||
[[Property:weight|0]]
|
||||
[[Property:uuid|87528ee4-72c4-57c3-81f0-8d5bda425276]]
|
||||
* In order to switch from coding to designing, click the '''Diagram''' tab in the '''Context''' tool. Open the context tool by checking menu item '''View | Explorer Bar |Context'''.
|
||||
|
||||
{{tip|To make sure all your changes are in the diagram, perform a compilation. }}
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,19 @@
|
||||
[[Property:title|Undoing and redoing]]
|
||||
[[Property:weight|1]]
|
||||
[[Property:uuid|35cb87d8-14c9-f3ce-5275-83c1ec61d746]]
|
||||
Almost all actions in the diagram tool are undoable. Every action that can be undone, can also be redone. For advanced undoing, open the history tool.
|
||||
|
||||
{{tip|Undo actions cannot be undone. Use redo to undo an undo action. }}
|
||||
* To undo the last action, click '''Undo last action'''. [[Image:general-undo-icon]]
|
||||
* To redo the last action, click '''Redo last action'''. [[Image:general-redo-icon]]
|
||||
* To undo all actions up until a specific action:
|
||||
*# Click the '''History tool''' button. [[Image:general-undo-history-icon]]
|
||||
*# The '''History tool''' dialog appears with a list of all undoable actions. By clicking on one of the actions, the diagram returns to the state it was in just after you performed this action.
|
||||
|
||||
[[Image:history-tool|center]]
|
||||
|
||||
|
||||
{{note|When an action is performed that cannot be undone, the history tool is emptied. }}
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user