mirrors/eiffel-org
1
0
Fork 0
mirror of https://github.com/EiffelSoftware/eiffel-org.git synced 2025-12-07 15:22:31 +01:00
Code Issues Packages Projects Releases Wiki Activity

Created 18.01 branch of the documentation.

Browse Source 
git-svn-id: https://svn.eiffel.com/eiffel-org/trunk@1942 abb3cda0-5349-4a8f-a601-0c33ac3a8c38
This commit is contained in:
eiffel-org
2018-02-08 15:00:31 +00:00
parent 265a446dab
commit b5d5c80911
2923 changed files with 61520 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
documentation/18.01/eiffelstudio/eiffelstudio-how-tos/editing-project/adding-class.wiki Normal file
View File

@@ -0,0 +1,30 @@
[[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.
{{tip|You can change the class text that is generated by default by editing the following files: <br/><br/>
$ISE_EIFFEL\studio\help\defaults\$ISE_PLATFORM\full.cls (with default feature clauses) and <br/><br/>
$ISE_EIFFEL\studio\help\defaults\$ISE_PLATFORM\empty.cls (without default feature clauses). }}
To make the window appear, you can:
* Click [[Image:16x16--new-class-icon]] in the [[Main toolbars|standard toolbar]] .
* Select '''New class''' in the '''Tools''' menu.
* Type the name of the new class in the class field of the [[Main address bar|main address bar]] or the [[Context tool address bar|context tool address bar]] . The current cluster will then be preselected.
* Use the [[Diagram tool]] : Pick the icon [[Image:16x16--new-class-icon]] and drop it on the diagram in the right cluster. This will make the dialog window appear with the chosen cluster selected.
{{seealso|<br/>
[[Removing a class|Removing a class]] }}

27
documentation/18.01/eiffelstudio/eiffelstudio-how-tos/editing-project/adding-cluster.wiki Normal file
View File

@@ -0,0 +1,27 @@
[[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]]
There are three ways to make this window appear. You can:
* Click [[Image:16x16--new-cluster-icon]] in the [[Main toolbars|standard toolbar]] .
* Click [[Image:new-cluster-icon]] in the [[Groups tool|groups tool]] .
* Select '''New cluster''' in the '''Tools''' menu.
Using this dialog, you can either create a subcluster of an existing cluster or a top-level cluster.
If you decide to create a top-level cluster, you should give it a name and a path (if the selected path does not exist, it will be created). You can also choose if it should be recursive or not..
If you want to create a subcluster, give it a name and select its parent in the list of available clusters. Giving it a path is not required. If you do not set a path for a new subcluster, it will be located by default in a subdirectory of its parent cluster, named after the subcluster name. This is the recommended way of creating a subcluster (since its path in the configuration file will be automatically relative to the parent), but it is not compulsory.
To import an existing cluster, you can also go to the '''Groups''' section in the [[Group Options|Project Settings dialog]] and click '''Add cluster'''. Although this solution may be slightly more tedious, it gives access to more options.
{{seealso|<br/>
[[Removing a cluster|Removing a cluster]] }}

11
documentation/18.01/eiffelstudio/eiffelstudio-how-tos/editing-project/adding-feature/adding-attribute.wiki Normal file
View File

@@ -0,0 +1,11 @@
[[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]]
# [[Type selection|Select the type]]
# [[Header comment|Type a header comment]]
# [[Invariant field|Select a class invariant]]
# [[Set-procedure|Select to create a set-procedure]]

11
documentation/18.01/eiffelstudio/eiffelstudio-how-tos/editing-project/adding-feature/adding-function.wiki Normal file
View File

@@ -0,0 +1,11 @@
[[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]]
# [[Argument list|Select formal parameters]]
# [[Type selection|Select the type]]
# [[Header comment|Type a header comment]]
# Enter [[Precondition|precondition]] , [[Local variable|local variable]] , [[Feature body|body]] and [[Postcondition|postcondition]]

10
documentation/18.01/eiffelstudio/eiffelstudio-how-tos/editing-project/adding-feature/adding-procedure.wiki Normal file
View File

@@ -0,0 +1,10 @@
[[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]]
# [[Argument list|Select formal parameters]]
# [[Header comment|Type a header comment]]
# Enter [[Precondition|precondition]] , [[Local variable|local variable]] , [[Feature body|body]] and [[Postcondition|postcondition]]

5
documentation/18.01/eiffelstudio/eiffelstudio-how-tos/editing-project/adding-feature/index.wiki Normal file
View File

@@ -0,0 +1,5 @@
[[Property:title|Adding a feature]]
[[Property:weight|3]]
[[Property:uuid|c65b3fd0-05fb-9b16-79b9-d4207bf42769]]
To add a feature to a class, you can directly edit its text of course. EiffelStudio offers you other ways to do so. A dialog window has been designed to help you to add features. Once you make it appear, the [[Opening the new feature dialog|new feature dialog]] allows you to choose what kind of feature you want to create and to set most of its characteristics. The process of creating the new feature is different if it is a [[Adding a procedure|procedure]] , a [[Adding a function|function]] or an [[Adding an attribute|attribute]] .

10
documentation/18.01/eiffelstudio/eiffelstudio-how-tos/editing-project/adding-feature/opening-new-feature-dialog.wiki Normal file
View File

@@ -0,0 +1,10 @@
[[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.
* Use the [[Diagram tool]]: First, select '''create new client-supplier links''' by clicking on [[Image:new-supplier-link-icon]] .Then, pick the class to which you want to add the new feature. Lastly, drop the pebble on the class that corresponds to the type returned by the new feature.<br/>
This last method does not allow you to create procedures.
The first thing to do when the dialog is displayed is to choose the kind of feature you want to create. The rest of the process depends on what you selected : [[Adding a procedure|procedure]] , [[Adding a function|function]] or [[Adding an attribute|attribute]] .

15
documentation/18.01/eiffelstudio/eiffelstudio-how-tos/editing-project/adding-library.wiki Normal file
View File

@@ -0,0 +1,15 @@
[[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]]
There are two ways to make this window appear. You can:
* Click [[Image:new-library-icon]] in the [[Groups tool|groups tool]] .
* Select '''Add library''' in the '''Tools''' menu.
Using this dialog, you can either choose a library from a list or select your own library.

12
documentation/18.01/eiffelstudio/eiffelstudio-how-tos/editing-project/changing-project-parameters.wiki Normal file
View File

@@ -0,0 +1,12 @@
[[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.
This tool will allow you, for instance, to add or remove clusters, set the assertion level or activate debug clauses.
For more complete information, please refer to the [[EiffelStudio: Project settings window|Project configuration tool help]] .

5
documentation/18.01/eiffelstudio/eiffelstudio-how-tos/editing-project/index.wiki Normal file
View File

@@ -0,0 +1,5 @@
[[Property:title|Editing a project]]
[[Property:weight|2]]
[[Property:uuid|d04c152e-1749-9e9f-0503-ec505478471e]]

11
documentation/18.01/eiffelstudio/eiffelstudio-how-tos/editing-project/moving-class.wiki Normal file
View File

@@ -0,0 +1,11 @@
[[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]]. 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 [[Groups tool|groups tool]] and drop it in the [[Diagram tool|diagram]]. Once both clusters are displayed, you just have to drag the class to its destination.
{{seealso|<br/>
[[Looking for a class|Find where a class is]] <br/>
[[Looking for a cluster|Find where a cluster is]] }}

17
documentation/18.01/eiffelstudio/eiffelstudio-how-tos/editing-project/removing-class.wiki Normal file
View File

@@ -0,0 +1,17 @@
[[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]] [[Diagram toolbar|toolbar]].
{{warning|Removing a class from the system implies the deletion of the corresponding file on disk. }}
{{warning|Picking a feature and dropping it on the delete icon, or calling '''Remove current item''' as the editor is centered on a feature, will not remove the feature but the class to which it belongs. }}
{{seealso|<br/>
[[Adding a class|Adding a class]] }}

14
documentation/18.01/eiffelstudio/eiffelstudio-how-tos/editing-project/removing-cluster.wiki Normal file
View File

@@ -0,0 +1,14 @@
[[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]] [[Diagram toolbar|toolbar]].
* Use the cluster tab in the project configuration window.
{{seealso|<br/>
[[Adding a cluster|Adding a cluster]] }}

10
documentation/18.01/eiffelstudio/eiffelstudio-how-tos/editing-project/removing-feature.wiki Normal file
View File

@@ -0,0 +1,10 @@
[[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|<br/>
[[Adding a feature]] }}