mirror of
https://github.com/EiffelSoftware/eiffel-org.git
synced 2026-03-11 12:21:13 +01:00
Author:admin
Date:2008-09-19T07:55:09.000000Z git-svn-id: https://svn.eiffel.com/eiffel-org/trunk@27 abb3cda0-5349-4a8f-a601-0c33ac3a8c38
This commit is contained in:
jfiat
@@ -1,6 +1,7 @@
|
||||
[[Property:title|MANUAL IDENTIFICATION AND COPYRIGHT]]
|
||||
[[Property:link_title|Manual identification and copyright]]
|
||||
[[Property:weight|7]]
|
||||
[[Property:uuid|c581a81b-fc9b-99bd-e73a-f290f6051a45]]
|
||||
Title: ''EiffelStudio: A Guided Tour'', Eiffel Software Technical Report TR-EI-68/GT. (Replaces TR-EI-38/EB.)
|
||||
|
||||
===Publication history===
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Browsing]]
|
||||
[[Property:weight|1]]
|
||||
[[Property:uuid|62242eb2-a02d-32f0-e357-6ed0e3966066]]
|
||||
* [[Searching|Searching]]
|
||||
* [[Viewing information about a component|Viewing information about a component]]
|
||||
* [[Opening new windows|Opening a new window]]
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Opening new windows]]
|
||||
[[Property:weight|2]]
|
||||
[[Property:uuid|1d3066d2-f1ad-9287-ecd2-5341d3c24b61]]
|
||||
There are several ways to open a new window. First, you can use the pick and drop shortcut. Then, you can use new window menu items and the corresponding icons. There are three such commands:
|
||||
* Clicking on '''New window''' in the '''File''' menu or on [[Image:new-window-icon]] make an new window appear. In this window, the editor and the context tool will be visible.
|
||||
* Clicking on '''New editor window''' in the '''File''' menu or on [[Image:new-editor-icon]] does the same as the previous command but the context tool is minimized in the new window.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Searching]]
|
||||
[[Property:weight|0]]
|
||||
[[Property:uuid|655fd717-159f-43f0-00ec-9a804790283f]]
|
||||
* [[Looking for a cluster|Looking for a cluster]]
|
||||
* [[Looking for a class|Looking for a class]]
|
||||
* [[Looking for a feature|Looking for a feature]]
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Looking for a class]]
|
||||
[[Property:weight|1]]
|
||||
[[Property:uuid|d3f517bc-46a8-2181-e9fb-ce0430e04261]]
|
||||
There are two simple ways to find a class if you know its name or a part of it :
|
||||
* You may use the [[Cluster tool: Introduction|cluster tool]] . This tool presents the entire universe of your project. By developing the [[System tree representation|cluster tree]] , you will be able to find what you are looking for. This method is quick if you already have an idea of where the class is in the universe.
|
||||
* Using [[Address bars: Introduction|address bars]] will be quicker if you do not have this information or if the size of your project is important. If you type the name of the searched class (you can use wildcards, i.e."*" and "?") in the [[Main address bar|main address bar]] - and then select the right class in the displayed list if there are several possibilities - the editor will be centered on the class you are looking for. The information about the class location will be displayed in the title bar of the window. If you need more complete information about the class location, you can [[Pick-and-drop mechanism|pick]] the name of the class in the editor and drop it on the [[Locate command|view icon ]] [[Image:general-search-icon]] of the [[Cluster tool: Introduction|cluster tool]] . This tool will then show where the class is in the universe.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Looking for a cluster]]
|
||||
[[Property:weight|0]]
|
||||
[[Property:uuid|95175328-cc1b-0b0f-974d-5be7fde40e92]]
|
||||
If you know the name of a cluster but not where it is located in the system, there are two ways to find this out:
|
||||
* You can try to find it in the [[Cluster tool: Introduction|cluster tool]] by expanding the cluster tree.
|
||||
* In a window where the context tool is independent from the editor, you can type the name of the cluster in [[Context tool address bar|context tool address bar]] . You may use wildcards ("*" or "?") if you know only a part of the name. You can then locate the cluster in the system by [[Pick-and-drop mechanism|picking]] the cluster stone in the [[Context tool address bar|address bar]] and dropping it on the [[Locate command|view icon ]] [[Image:general-search-icon]] of the [[Cluster tool: Introduction|cluster tool]] .
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
[[Property:title|Looking for an expression in a text]]
|
||||
[[Property:link_title|Looking for an expression in text]]
|
||||
[[Property:weight|3]]
|
||||
[[Property:uuid|d71e4302-3f44-5cd8-7a26-365af4a6ecf6]]
|
||||
To find a word or an expression in a text, you can use the [[Search tool|search tool]] . If it is not displayed, you can make it appear by clicking on its icon [[Image:tool-search-icon]] in the tool bar. This tool will allow you to search a word or a regular expression and to replace it if you want to. It can be case sensitive and look for isolated words.
|
||||
'''Note''': The [[Search tool|search tool]] will look for the wanted word in the editor or in the context tool, depending on which one has the focus.
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Looking for a feature]]
|
||||
[[Property:weight|2]]
|
||||
[[Property:uuid|5ea97cae-9001-7d9d-2dbb-2b632b05fb75]]
|
||||
There are many ways to find a feature in a class. In particular :
|
||||
* You can use the [[Feature tool: Introduction|feature tool]] and search the tree by expanding feature clauses. This tool, however, displays only the features that are defined or redefined in the current class text. If you do not know if the feature is inherited or not, you may therefore not find what you are looking for with this method.
|
||||
* You can also use the [[Class formatters: Introduction|class tab]] in the context tool. It will allow you to see all the [[Attributes| attributes]] or [[Routines|routines]] , or all the [[Exported features|public features]] for instance. If you do not know if the feature you seek is an attributes or a function and if it is public, this may not be the right method either.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Centering tools on a component]]
|
||||
[[Property:weight|0]]
|
||||
[[Property:uuid|513b0d4a-78b6-30c3-fdde-b00c3072d8d3]]
|
||||
There are three kind of tools directly available in a default development tool : [[Browsing tools: Introduction|browsing tools]] on the left, the [[EiffelStudio Editor Introduction|editor]] on the upper right and context tools on the lower right. No browsing tool, except the feature tool, displays information about a particular component. On the contrary, the editor and context tools display information about a given cluster, class or feature : they are centered on this component. There are several ways to center the editor on an element:
|
||||
* use the [[Main address bar|address bar]] on the top of the editor. It allows you to set which class (and even which feature in the class) you want the editor to display. You may use wildcards ("?" or "*") as you type the names of these components.
|
||||
* use [[Pick-and-drop mechanism|pick and drop]] . Pick a cluster, class or feature stone anywhere in EiffelStudio and drop it in the editor. It will center it on the component automatically.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Viewing information about a component]]
|
||||
[[Property:weight|1]]
|
||||
[[Property:uuid|58f7ce9a-b5c3-77ab-d7a7-d834bb6d3b58]]
|
||||
* [[Centering tools on a component|Centering tools on a component]]
|
||||
* [[Viewing information about a cluster|Viewing information about a cluster]]
|
||||
* [[Viewing information about a class|Viewing information about a class]]
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Viewing information about a class]]
|
||||
[[Property:weight|2]]
|
||||
[[Property:uuid|6ec8ca83-fbe0-e02c-2570-68b5f3931083]]
|
||||
Once you [[Centering tools on a component|centered the editor]] on a class, you have access to its [[Class formatters: Basic text view|basic text]] . If the class is compiled, the [[Feature tool: Introduction|feature tool]] shows the list of the features that are defined or redefined in this text. You can also view [[Clickable view|clickable]] , [[Class formatters: Flat view|flat]] , [[Flat Contract view|flat contract]] and [[Contract view|contract]] views of the class in the editor. The class tab in the context tool can display more information. If the [[Centering tools on a component|context tool is independent]] , [[Centering tools on a component|center it]] on the wanted class and select this tab. You can then see information about the features ( [[Routines|routines]] , [[Attributes|attributes]] , [[Exported features|exported features, ]] [[Class views|etc.]] ..) of the class, its [[Ancestors|ancestors]] and [[Descendants|descendants]] or its [[Clients|clients]] and [[Suppliers|suppliers]] . <br/>
|
||||
The [[Metric tool: Introduction|metric tool]] provides another kind of data. It allows you to compute a complete set of [[How to analyze a project: Introduction|measures ]] on your class.
|
||||
{{seealso| '''See Also''' <br/>
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Viewing information about a cluster]]
|
||||
[[Property:weight|1]]
|
||||
[[Property:uuid|daff6cb5-89bd-4281-4c1e-cf031391a34b]]
|
||||
To view information about a cluster, you have to center the context tool on this component. Then the [[Metric tool: Introduction|metric tool]] will provide a complete set of measures that you will able to compute.
|
||||
{{seealso| '''See Also''' <br/>
|
||||
[[Looking for a cluster|Looking for a cluster]] <br/>
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Viewing information about a feature]]
|
||||
[[Property:weight|3]]
|
||||
[[Property:uuid|0151eab9-ee25-210a-bed9-b2709e9fa5f0]]
|
||||
Once you [[Centering tools on a component|centered the editor]] on a feature, you have access to its text. The feature tab in the context tool can display more information. To have access to it, you have first to center the context tool on the wanted class and select the feature tab. You can then consult the different views of the text of the feature ( [[Feature formatters: Basic text view|basic text]] or [[Feature formatters: Flat view|flat]] ) and other information such as its [[Callers|callers]] or its [[Descendant versions|descendant]] versions. <br/>
|
||||
The [[Metric tool: Introduction|metric tool]] provides another kind of data. It enables you to compute some [[How to analyze a project: Introduction|measures]] on your feature.
|
||||
{{seealso| '''See Also''' <br/>
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Enabling the profiler]]
|
||||
[[Property:weight|4]]
|
||||
[[Property:uuid|62732b12-c41f-c87e-f798-8839664dc118]]
|
||||
To profile an executable, the profiler must first be enabled. To enable the profiler:
|
||||
* Open the [[General Target Options|Project Settings]] dialog.
|
||||
* In the '''Target''' section, enable '''Profile'''.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Generating executables]]
|
||||
[[Property:weight|0]]
|
||||
[[Property:uuid|d089f44a-9d01-41cf-9ba5-a58570ca5365]]
|
||||
There are several ways to compile an executable with EiffelStudio.
|
||||
|
||||
Compilation modes include the following: melting, freezing and finalizing. To learn more about the compilation semantics in EiffelStudio, see the [[Compiler: introduction|compiler reference]] .
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Generating libraries]]
|
||||
[[Property:weight|1]]
|
||||
[[Property:uuid|a2862dd7-1702-50b6-2505-74f9e1ac4b70]]
|
||||
There are two main types of libraries in Eiffel: precompiled Eiffel libraries and C libraries. Both kinds of libraries can be created via EiffelStudio. The former can only be used in Eiffel projects, C libraries can be used either in Eiffel programs, or in standard C programs.
|
||||
|
||||
To generate an Eiffel precompiled library:
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Compiling]]
|
||||
[[Property:weight|3]]
|
||||
[[Property:uuid|30b06b72-4988-48a0-2dae-fcf7c2e5c838]]
|
||||
* [[Generating executables|Generating executables]]
|
||||
* [[Generating libraries|Generating libraries]]
|
||||
* [[Setting the assertion level|Changing the assertion level]]
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Setting the assertion level]]
|
||||
[[Property:weight|2]]
|
||||
[[Property:uuid|af3a030c-2970-2e07-7bd4-9e9333a8a8c3]]
|
||||
To modify the assertion level in a generated binary (executable or library),
|
||||
* Open the [[Assertion Options|Project Settings]] dialog.
|
||||
* In the '''Target, Assertions'''section, select the assertions you want to check (among require, ensure, check, loop and class invariant).
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Tuning a program]]
|
||||
[[Property:weight|6]]
|
||||
[[Property:uuid|74d7c168-c9c1-2d43-fb76-4854cf4b69c7]]
|
||||
The best way to speed up a program is of course to improve the algorithms and data structures you are using. Spotting the functions that slow down the execution and improving can change a lot in a program. [[Profiling|Profiling]] can be used for this.
|
||||
|
||||
Try to keep the number of classes and objects in your system as low as possible to ensure maximum efficiency. This should never hinder the design of the system, though.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Using libraries]]
|
||||
[[Property:weight|5]]
|
||||
[[Property:uuid|443320fa-8e5c-fd13-ed20-66e49094f3d5]]
|
||||
There are two kinds of libraries in Eiffel: precompiled Eiffel libraries and C libraries.
|
||||
|
||||
To use an Eiffel precompiled library:
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Using threads]]
|
||||
[[Property:weight|7]]
|
||||
[[Property:uuid|9f53d641-093a-38cb-50bb-568aaadfeb34]]
|
||||
Eiffel supports multithreaded programs. The [[EiffelThread Library|thread library]] provides ways to handle threads safely inside an Eiffel program. Make sure you [[Adding a library|add]] it to your project if you want to use threads.
|
||||
|
||||
To create a multithreaded program or library:
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Changing the default history size]]
|
||||
[[Property:weight|4]]
|
||||
[[Property:uuid|d83e13f7-bdc7-a938-e979-da67e0e521d4]]
|
||||
By default, there may not be more than 10 items in the history of a development window. It means that combo boxes in the [[Main address bar|address bar]] will let you choose between at most 10 possibilities. You can change this number.
|
||||
To do so, use the [[Preference window overview|preference window]] : select '''Preferences''' in the '''Tools''' menu. Then in the preferences tree, select the "Browsing tools "sub-category in the "Tools" category. On the right part of the window, a list of preferences will appear, including "number of items displayed in the history combo boxes". Click on this item and enter the new value.
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Changing texts display]]
|
||||
[[Property:weight|1]]
|
||||
[[Property:uuid|b7c1cbac-975b-c6e6-050b-e48b61732a57]]
|
||||
By modifying EiffelStudio [[EiffelStudio preferences: Introduction|preferences]] , you can change the font and the colors used to display texts in the editor. For more information, refer to EiffelStudio [[Interface|graphical preferences reference]] .
|
||||
{{seealso| '''See Also''' <br/>
|
||||
[[Customizing class text views|Customizing formatted output]] }}
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Choosing classes to be ignored in BON diagrams]]
|
||||
[[Property:weight|5]]
|
||||
[[Property:uuid|18dcc14f-2ad0-3f3b-4b2e-fc9251035b6f]]
|
||||
Every class in your system inherits from <eiffel>ANY</eiffel>. <eiffel>INTEGER</eiffel>, like other classes that represent basic types, is very often a supplier of the classes the user wrote. It may therefore not be interesting to display classes such as <eiffel>ANY</eiffel> or <eiffel>INTEGER</eiffel> in [[Diagram tool: Introduction|BON diagrams]] .
|
||||
EiffelStudio allows you to customize a list of classes that it has to ignore when it creates diagrams. This list is stored in the [[EiffelStudio preferences: Introduction|preferences]] . To modify it, first open the [[Preference window overview|preferences window]] by choosing '''Preferences...''' in the '''Tools''' menu. Select then the "context tool" sub-category of the "Tools" category in the preferences tree. On the right, you will then see a table of preferences, which includes "Show ALL classes in the diagram" and "Names of classes that should not appear in generated diagrams". If "Show ALL classes in the diagram" is not False, click on it and set it to False. Then click on "Names of classes that should not appear in generated diagrams" and edit the list. Class names must be separated by semicolons.
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Configuring an external editor]]
|
||||
[[Property:weight|7]]
|
||||
[[Property:uuid|15ecd536-139b-e880-d199-9c54aa88c892]]
|
||||
By clicking on, or by [[Pick-and-drop mechanism|dropping a pebble]] on the external editor toolbar button( [[Image:command-send-to-external-editor-icon]] ), you can launch an external editor. By default, this editor is VI on Unix and Notepad on Windows. You can tell EiffelStudio to launch another editor by editing the preferences.
|
||||
To do so, first open the [[Preferences Reference|preferences window]] by choosing '''Preferences...''' in the '''Tools''' menu. Select then the "Global preferences" category in the preferences tree. Click on "Command used to launch an external editor" and modify the command line so that it calls your favorite editor. You can use keywords that represent the filename ($target)and the line number ($line) as is explained in the [[Preferences Reference|preferences reference]] .
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Customizing class text views]]
|
||||
[[Property:weight|6]]
|
||||
[[Property:uuid|386c40f1-3427-cf1c-1043-46aeac1bc3c5]]
|
||||
It is possible in EiffelStudio to customize some properties of [[Formatters: Introduction|class text views]] (other than basic texts) displayed in the editor or class and feature tabs of the context tool. Besides [[Changing texts display|graphical appearance]] , you may modify:
|
||||
* the order of feature clauses.
|
||||
* the type of callers and suppliers displayed in the corresponding views.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Customizing toolbars]]
|
||||
[[Property:weight|2]]
|
||||
[[Property:uuid|583811a0-abcc-e26f-60e9-0cd6d4f9a8a8]]
|
||||
There may be up to 26 buttons in the [[Main toolbars|standard toolbar]] and up to 17 in the [[Main toolbars|project toolbar]] . All those buttons are not shown by default though. Only 16 icons are displayed in the default standard toolbar for instance.
|
||||
It is possible to choose which button are shown and in which order they appear in the toolbars. To do so, use [[Toolbar customization|toolbar customization]] windows. they appear when you choose '''Customize standard toolbar...''' or '''Customize project toolbar...''' in the toolbars sub-menu of the View menu or in the contextual menu of the toolbars (which is displayed when you right-click in the empty space on the right of the toolbars).
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Customizing EiffelStudio]]
|
||||
[[Property:weight|8]]
|
||||
[[Property:uuid|6f4b9558-38bc-1350-ce61-5f58d7032646]]
|
||||
* [[Setting the editor behavior|Setting the editor behavior]]
|
||||
* [[Changing texts display|Changing texts display]]
|
||||
* [[Customizing toolbars|Customizing toolbars]]
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Making the context tool independent from the editor]]
|
||||
[[Property:weight|3]]
|
||||
[[Property:uuid|895ca03f-b14c-e0c5-f3e7-6757b47f5bc3]]
|
||||
By default, [[EiffelStudio Editor Introduction|the editor]] and the [[EiffelStudio window overview|context tool]] are [[Centering tools on a component|centered]] on the same cluster, class or feature. It is possible to make the context tool independent from the editor. It has then its own address bar and can display information on a totally different component than the one on which the editor is centered.
|
||||
To do so, click on or select '''Isolate context tool''' in the '''View''' menu. To go back to the previous configuration, click on the same icon again or select '''Merge context tool''' in the '''View''' menu.
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Setting the editor behavior]]
|
||||
[[Property:weight|0]]
|
||||
[[Property:uuid|ff77b886-4a47-2ba4-eac7-ae051934a3f5]]
|
||||
Some of [[EiffelStudio Editor Introduction|the editor]] properties are customizable. [[Automatic completion: Introduction|Automatic completion]] , for instance, can be partially or totally disabled, and inserted strings can be defined by the user. Some accelerators are customizable too. For more information, please refer to the [[Editor Preferences|editor preferences reference]] .
|
||||
{{seealso| '''See Also''' <br/>
|
||||
[[Changing texts display|Text colors and font customization.]] }}
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[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|'''See Also'''<br/>
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[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| '''See Also''' <br/>
|
||||
[[Adding a feature: Introduction|Creating a new feature]] }}
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[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| '''Caution''': An action that deletes one or more files or directories cannot be undone! }}
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Altering the system]]
|
||||
[[Property:weight|2]]
|
||||
[[Property:uuid|89337378-9070-68c5-1e29-e6325c292118]]
|
||||
* [[Creating a new class|Creating a new class]]
|
||||
* [[Creating a new feature|Creating a new feature]]
|
||||
* [[Refactoring|Refactoring]]
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Refactoring]]
|
||||
[[Property:weight|2]]
|
||||
[[Property:uuid|08099f7b-aaf4-b629-17f6-b637c4efd63a]]
|
||||
There are several different refactorings available. Refactorings start with a compilation and also end with a compilation. Refactoring have a separate undo functionality which allows to undo a refactoring as long as no changes have been done to the classes that have been refactored.
|
||||
|
||||
* [[Rename class|Class Rename]]
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Pull up Feature]]
|
||||
[[Property:weight|5]]
|
||||
[[Property:uuid|445f93dc-b81a-29ea-440b-42e394038c53]]
|
||||
# Start pick-and-drop on the feature bubble which you want to pull up.
|
||||
# Drop it in the '''Pull up Feature''' hole. [[Image:refactor-feature-up-icon]]
|
||||
# After a compilation the '''Select Class''' dialog appears. You can choose the parent where to pull the feature.
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
[[Property:title|Rename class]]
|
||||
[[Property:link_title|Rename Class]]
|
||||
[[Property:weight|3]]
|
||||
[[Property:uuid|e70f2760-389a-4c54-ed10-b731dc70e952]]
|
||||
# Start pick-and-drop on the class bubble of which you want to change the name.
|
||||
# Drop it in the '''Rename Feature/Class''' hole. [[Image:refactor-rename-icon]]
|
||||
# After a compilation the '''Refactoring: Class Rename''' dialog appears. You can enter a new name.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Rename Feature]]
|
||||
[[Property:weight|4]]
|
||||
[[Property:uuid|03a8b4de-3c7b-0f9e-ecd2-48ff2035eaf9]]
|
||||
# Start pick-and-drop on the feature bubble of which you want to change the name.
|
||||
# Drop it in the '''Rename Feature/Class''' hole. [[Image:refactor-rename-icon]]
|
||||
# After a compilation the '''Refactoring: Feature Rename''' dialog appears. You can enter a new name.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[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.
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Designing a project]]
|
||||
[[Property:weight|5]]
|
||||
[[Property:uuid|e025afd9-0fcf-8300-2ef5-b3711397f773]]
|
||||
* [[Switching to the diagram tool|Switching to the diagram tool]]
|
||||
* [[Undoing and redoing|Undoing and redoing]]
|
||||
* [[Altering the system|Altering the system]]
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[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.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[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.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[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.
|
||||
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[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.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Managing links]]
|
||||
[[Property:weight|3]]
|
||||
[[Property:uuid|dddd0495-e341-c851-c364-e22d6100401b]]
|
||||
* [[Creating inheritance links|Creating inheritance links]]
|
||||
* [[Creating client/supplier links|Creating client/supplier links]]
|
||||
* [[Creating aggregate client/supplier links|Creating aggregate client/supplier links]]
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[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.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[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/>
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[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/>
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Managing views]]
|
||||
[[Property:weight|5]]
|
||||
[[Property:uuid|55423866-e62b-ad1f-73ef-1b05fbf3ea3f]]
|
||||
* [[Adding a view|Adding a view]]
|
||||
* [[Deleting a view|Deleting a view]]
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[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| '''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. }}
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[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| '''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. }}
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[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| '''Tip''': Lower quality display is faster for drawing so is recommended for very large diagrams. }}
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[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'''.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[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:
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[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| '''Tip''': If the entire cluster is of no relevance to your diagram, [[Removing items from a view|hide it from the view]] altogether. }}
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Modifying the display]]
|
||||
[[Property:weight|4]]
|
||||
[[Property:uuid|a5bcb642-d18e-8d03-da28-6042cffa153a]]
|
||||
* [[Showing or hiding links and labels|Showing or hiding links and labels]]
|
||||
* [[Changing system exploration depth|Changing system exploration depth]]
|
||||
* [[Removing items from a view|Removing items from a view]]
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[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| '''Note''': If you want to remove the item from the system, use the [[Deleting items|Delete]] hole. }}
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[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]]
|
||||
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[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]]
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[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]]
|
||||
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[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| '''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]] . }}
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[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]]
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[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/>
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[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| '''Tip''': To make sure all your changes are in the diagram, perform a compilation. }}
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[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| '''Tip''': Undo actions cannot be undone. Use redo to undo an undo action. }}
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Adding a class]]
|
||||
[[Property:weight|2]]
|
||||
[[Property:uuid|592f9c3a-4533-d849-a0d7-5c00864e5c26]]
|
||||
A dialog window is dedicated to the creation of new classes.
|
||||
[[Image:new-class-dialog]]
|
||||
A list of all the clusters of the system lets you to choose in which one the new class will be inserted. The name of the new class and the name of the corresponding file can be set thank to two text fields above the list. It is also possible to define whether the class should be deferred or expanded, what its creation feature is (if any), what its parents are and whether the default feature clauses should be generated.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Adding a cluster]]
|
||||
[[Property:weight|0]]
|
||||
[[Property:uuid|76a118a9-270e-fbc4-567d-e2ce031585d4]]
|
||||
It is possible to create new clusters from EiffelStudio. A dialog window has been designed to help you do so.
|
||||
[[Image:new-cluster-dialog]]
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Adding an attribute]]
|
||||
[[Property:weight|4]]
|
||||
[[Property:uuid|091387a6-2dda-aff4-7741-b44ade4857cb]]
|
||||
Once [[Opening the new feature dialog|the new feature dialog]] is displayed and '''attribute''' selected in '''feature type''', follow the following steps:
|
||||
# [[Feature clauses|Choose a feature clause]]
|
||||
# [[Name field|Type a name]]
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Adding a function]]
|
||||
[[Property:weight|3]]
|
||||
[[Property:uuid|1175bdb8-b8a0-e4c4-c083-3d624ae1e501]]
|
||||
Once [[Opening the new feature dialog|the new feature dialog]] is displayed and '''function''' selected in '''feature type''', follow the following steps:
|
||||
# [[Feature clauses|Choose a feature clause]]
|
||||
# [[Name field|Type a name]]
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Adding a procedure]]
|
||||
[[Property:weight|2]]
|
||||
[[Property:uuid|220515f7-5c16-2648-fcad-74d3fb1583da]]
|
||||
Once [[Opening the new feature dialog|the new feature dialog]] is displayed and '''procedure''' selected in '''feature type''', follow the following steps:
|
||||
# [[Feature clauses|Choose a feature clause]]
|
||||
# [[Name field|Type a name]]
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Adding a feature]]
|
||||
[[Property:weight|3]]
|
||||
[[Property:uuid|c65b3fd0-05fb-9b16-79b9-d4207bf42769]]
|
||||
* [[Adding a feature: Introduction|Introduction]]
|
||||
* [[Opening the new feature dialog|Opening the new feature dialog]]
|
||||
* [[Adding a procedure|Creating a procedure]]
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Opening the new feature dialog]]
|
||||
[[Property:weight|1]]
|
||||
[[Property:uuid|98d1f7e1-3fca-5884-83fc-f44475a3f364]]
|
||||
To make the [[New feature dialog overview|new feature window]] appear, you can:
|
||||
* Click [[Image:16x16--new-feature-icon]] in the [[Main toolbars|standard toolbar]] .
|
||||
* Select '''New feature''' in the '''Tools''' menu.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Adding a library]]
|
||||
[[Property:weight|1]]
|
||||
[[Property:uuid|6d711ed5-7cd4-481f-1ea3-7bc0eb4e1730]]
|
||||
A dialog window has been designed to help you to add a library to your project.
|
||||
[[Image:new-library-dialog]]
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Changing project parameters]]
|
||||
[[Property:weight|8]]
|
||||
[[Property:uuid|54b1b86c-ce04-e634-ca1d-3546e14736f9]]
|
||||
A tool has been designed to help you to modify the settings of your project. To make the Project configuration tool appear, there are two possibilities:
|
||||
* Click [[Image:tool-config-icon]] in the [[Main toolbars|standard toolbar]] .
|
||||
* Select '''Project settings...''' in the '''Project''' menu.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Editing a project]]
|
||||
[[Property:weight|2]]
|
||||
[[Property:uuid|d04c152e-1749-9e9f-0503-ec505478471e]]
|
||||
* [[Adding a cluster|Adding a cluster]]
|
||||
* [[Adding a library|Adding a library]]
|
||||
* [[Adding a class|Adding a class]]
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Moving a class]]
|
||||
[[Property:weight|7]]
|
||||
[[Property:uuid|10947266-61c8-ddd5-445e-9eb0de61cd05]]
|
||||
To move a class from a cluster to another one, you have to use the [[Diagram tool: Introduction|Diagram tool]] . First, [[Centering tools on a component|center the tool]] on the cluster that contains the class you want to move. Then, if the destination cluster is not shown on the diagram, [[Pick-and-drop mechanism|pick]] it in the [[Cluster tool: Introduction|cluster tool]] and drop it in the [[Diagram tool: Introduction|diagram]] . Once both clusters are displayed, you just have to drag the class to its destination.
|
||||
{{seealso| '''See Also''' <br/>
|
||||
[[Looking for a class|Find where a class is]] <br/>
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Removing a class]]
|
||||
[[Property:weight|5]]
|
||||
[[Property:uuid|f975b6e2-7f81-874b-82f2-e76db588ff5e]]
|
||||
To remove a class, you can:
|
||||
* [[Centering tools on a component|Center the editor on the component]] , and click [[Image:16x16--general-delete-icon]] in the [[Main toolbars|standard toolbar]] or select '''Remove current item''' in the '''Tools''' menu.
|
||||
* [[Pick-and-drop mechanism|Drop a pebble]] of this component on [[Image:16x16--general-delete-icon]] in the [[Main toolbars|standard toolbar]] or in the [[Diagram tool: Introduction|Diagram tool]] [[Diagram toolbar|toolbar]] .
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Removing a cluster]]
|
||||
[[Property:weight|4]]
|
||||
[[Property:uuid|aebcf24c-758b-7c03-4130-533cf34650f5]]
|
||||
To remove clusters, you can:
|
||||
* [[Centering tools on a component|Center the editor on the component]] , and click [[Image:16x16--general-delete-icon]] in the [[Main toolbars|standard toolbar]] or select '''Remove current item''' in the '''Tools''' menu.
|
||||
* [[Pick-and-drop mechanism|Drop a pebble]] of this component on [[Image:16x16--general-delete-icon]] in the [[Main toolbars|standard toolbar]] or in the [[Diagram tool: Introduction|Diagram tool]] [[Diagram toolbar|toolbar]] .
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Removing a feature]]
|
||||
[[Property:weight|6]]
|
||||
[[Property:uuid|8779bb5f-44d4-48fa-7320-d3c02c3dc176]]
|
||||
To remove a feature, you may of course delete the corresponding lines in the class text. You can also use the Diagram tool if it is an attribute or a function. To do so, make sure that supplier links are shown in the diagram (if [[Image:diagram-supplier-link-icon]] is not pressed, click it). Pick the link that correspond to the feature you want to remove and drop the pebble on [[Image:16x16--general-delete-icon]] .
|
||||
{{seealso| '''See Also''' <br/>
|
||||
[[Adding a feature: Introduction|Adding a feature]] }}
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|EiffelStudio: Creating a new project]]
|
||||
[[Property:weight|0]]
|
||||
[[Property:uuid|e73ed6ac-47ba-7e08-a352-0b1cca4ddc62]]
|
||||
The first thing to do to start Eiffeling is to create a project. Most commands are disabled when no project is created.
|
||||
|
||||
When opening EiffelStudio, by default a dialog is popped up that proposes to create or open a project:
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|EiffelStudio: Starting a project]]
|
||||
[[Property:weight|0]]
|
||||
[[Property:uuid|d3d6bae9-7a93-2c02-1fab-4759341419d6]]
|
||||
* [[EiffelStudio: Creating a new project|Creating a new project]]
|
||||
* [[Retrieving a project from a configuration file|Retrieving a project from a configuration file]]
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Retrieving a project from a configuration file]]
|
||||
[[Property:weight|1]]
|
||||
[[Property:uuid|eef8cf02-0ed0-3e3e-3204-56541df18d37]]
|
||||
If you have already designed a project and want to retrieve it, or if you want to open a project created by someone else (such as the examples of the libraries which are shipped with EiffelStudio), you can either directly select it from the list of last opened projects or use the '''Add Project''' button to open the configuration file.
|
||||
|
||||
This dialog also allows you to select which target to compile and you can also specify your own location where the project will be compiled. The '''action''' describes what should be done and the optional '''clean''' removes the compiled files of a previous compilation before doing the action.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Generating multi-format documentation]]
|
||||
[[Property:weight|0]]
|
||||
[[Property:uuid|37a81bfb-004f-a1f9-7cc8-140639e96e9f]]
|
||||
EiffelStudio can generate documentation for a system using many different formats.
|
||||
|
||||
The '''Documentation Wizard''', which helps you to get the documentation you want, is available in the '''Project''' menu, under the entry '''Generate Documentation'''.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Generating XMI documentation]]
|
||||
[[Property:weight|1]]
|
||||
[[Property:uuid|a6aa8b26-6ce4-90d5-7204-014c5fee0267]]
|
||||
EiffelStudio can generate an '''XMI''' description of a system; '''XMI''' (XML Metadata Interchange) format is the new industry standard way to describe and exchange object-oriented systems, further information can be found [http://www.omg.org/technology/xml/ here] .
|
||||
|
||||
The '''XMI Export wizard''' is available in the '''Project''' menu, under the entry '''Export XMI'''.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Generating documentation]]
|
||||
[[Property:weight|7]]
|
||||
[[Property:uuid|18c19156-899a-33fd-92f0-3065267f30f0]]
|
||||
* [[Generating multi-format documentation|Generating multi-format documentation]]
|
||||
* [[Generating XMI documentation|Generating XMI]]
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Evaluating a measure]]
|
||||
[[Property:weight|1]]
|
||||
[[Property:uuid|533ec807-ad3d-5338-3955-aa2f8601976e]]
|
||||
To evaluate a metric over a scope:
|
||||
# Select the '''Metric Evaluation''' tab from the Metric tool.
|
||||
# Define the scope by adding either groups, classes or features to the input domain list.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Computing a measure]]
|
||||
[[Property:weight|1]]
|
||||
[[Property:uuid|cff91cf0-1280-f79d-440a-69801b213dac]]
|
||||
* [[Computing a measure: Introduction|Introduction]]
|
||||
* [[Evaluating a measure|Evaluating a measure]]
|
||||
* [[Saving a measure|Saving a measure]]
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Saving a measure]]
|
||||
[[Property:weight|2]]
|
||||
[[Property:uuid|d967fde4-5dea-a855-50ec-b0d8f1473cf2]]
|
||||
To save the result of evaluation of a metric:
|
||||
# Select the '''Metric Archive''' tab of the Metric tool.
|
||||
# Select the input domain as described in [[Evaluating a measure|Evaluating a measure]] and the metrics you want to compute and save over the selected scope
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Viewing measure details]]
|
||||
[[Property:weight|3]]
|
||||
[[Property:uuid|570feb7a-4650-0a7d-ae45-1336c5429cfb]]
|
||||
It is possible to have some details when evaluating a metric.
|
||||
# Select the '''Metric Evaluation''' tab of the metric tool.
|
||||
# [[Evaluating a measure|Evaluate a metric]] .
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Comparing to an archive]]
|
||||
[[Property:weight|2]]
|
||||
[[Property:uuid|eb13a2c4-623d-8a35-6175-40a43486beb8]]
|
||||
The main goal of archives is comparing archives one to another. In order to compare your project to an archived file, you must select the '''Metric archive''' tab of the metric tool.
|
||||
|
||||
The goal is to load the archive of a (preferably different) project, to compare the archived measures to the system's. You can select your current archive or any other archive, against a reference archive file.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Creating an archive]]
|
||||
[[Property:weight|1]]
|
||||
[[Property:uuid|d8bd6d77-a5dc-df38-a796-6fa8a07ddf29]]
|
||||
Users may want to archive the result of the system they are working on. To create an archive is basically the same as [[Saving a measure|saving a measure]] .
|
||||
|
||||
{{seealso| '''See Also''' <br/>
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Handling archives]]
|
||||
[[Property:weight|3]]
|
||||
[[Property:uuid|1a2bc120-2f9d-0cc3-4883-a98c5999b12d]]
|
||||
* [[Handling archives: introduction|Introduction]]
|
||||
* [[Creating an archive|Creating an archive]]
|
||||
* [[Comparing to an archive|Comparing to an archive]]
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Defining derived metrics]]
|
||||
[[Property:weight|1]]
|
||||
[[Property:uuid|d9c9037a-7b87-3810-c5c8-d34523cdad7b]]
|
||||
To define a derived metric, you must select the''' Metric Definition''' tab and click the '''New metric''' button. A menu appears asking you the kind of metric you want to define. Select '''Basic metric''' and then the type of the results you are looking for (i.e. Class, Feature, Line, ...). Once done, you can perform the following steps:
|
||||
# Enter a name for the metric in the "Name" field. Next to the field you will see the type of metric as well as the unit for this metric.
|
||||
# Enter a description for the metric. The description is shown as a tooltip when you navigate the list of available metrics.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Defining linear metrics]]
|
||||
[[Property:weight|2]]
|
||||
[[Property:uuid|bfcfffff-08ec-8e18-fed4-3f39ac3772da]]
|
||||
To define a linear metric, you must select the '''Metric Definition''' tab and click the '''New metric''' button. A menu appears asking you the kind of metric you want to define. Select '''Linear metric''' and then the type of the results you are looking for (i.e. Class, Feature, Line, ...). Once done, you can perform the following steps:
|
||||
# Enter a name for the metric in the "Name" field. Next to the field you will see the type of metric as well as the unit for this metric.
|
||||
# Enter a description for the metric. The description is shown as a tooltip when you navigate the list of available metrics.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Defining ratio metrics]]
|
||||
[[Property:weight|3]]
|
||||
[[Property:uuid|40394359-600c-5392-8609-6f994920a3b1]]
|
||||
To define a ratio metric, you must select the '''Metric Definition''' tab and click the '''New metric''' button. A menu appears asking you the kind of metric you want to define. Select '''Ratio metric'''. Once done, you can perform the following steps:
|
||||
# Enter a name for the metric in the "Name" field. Next to the field you will see the type of metric as well as the unit for this metric.
|
||||
# Enter a description for the metric. The description is shown as a tooltip when you navigate the list of available metrics.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Defining new metrics]]
|
||||
[[Property:weight|1]]
|
||||
[[Property:uuid|7f36c01c-40f4-be23-dfcd-d92bf2bbd535]]
|
||||
* [[Defining new metrics: introduction|Introduction]]
|
||||
* [[Defining derived metrics|Derived metrics]]
|
||||
* [[Defining linear metrics|Linear metrics]]
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Handling new metrics]]
|
||||
[[Property:weight|2]]
|
||||
[[Property:uuid|1ca7a8cf-f446-6cbc-59e1-0455e633ce44]]
|
||||
* [[Handling new metrics: Introduction|Introduction]]
|
||||
* [[Defining new metrics|Defining new metrics]]
|
||||
* [[Managing new metrics|Managing metrics]]
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|Managing new metrics]]
|
||||
[[Property:weight|2]]
|
||||
[[Property:uuid|540cbcc4-27cb-7fc4-5c98-0c622bfb0841]]
|
||||
* [[Managing new metrics: Introduction|Introduction]]
|
||||
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|How to analyze a project]]
|
||||
[[Property:weight|6]]
|
||||
[[Property:uuid|85d47406-926e-8754-0c15-a2af5b151658]]
|
||||
* [[How to analyze a project: Introduction|Introduction]]
|
||||
* [[Computing a measure|Computing a measure]]
|
||||
* [[Handling new metrics|Handling new metrics]]
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[Property:title|EiffelStudio How To's]]
|
||||
[[Property:weight|-1]]
|
||||
[[Property:uuid|10d806ce-5b43-26a5-6f0e-23b3b2faa2ed]]
|
||||
* [[EiffelStudio: Starting a project|Starting a project]]
|
||||
* [[Browsing|Browsing]]
|
||||
* [[Editing a project|Editing a project]]
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user