Author:halw

Date:2008-09-25T21:53:24.000000Z


git-svn-id: https://svn.eiffel.com/eiffel-org/trunk@45 abb3cda0-5349-4a8f-a601-0c33ac3a8c38
This commit is contained in:
halw
2008-09-25 21:53:24 +00:00
parent 2780526eae
commit 4f7b1b97bb
78 changed files with 164 additions and 284 deletions

View File

@@ -1,14 +1,12 @@
[[Property:title|Change data share mode]]
[[Property:weight|3]]
[[Property:uuid|52206181-e002-0914-d98d-c817d32ec02e]]
Located in the '''View''' menu, named either '''Link context tool''' or '''Unlink context tool''', this command allows you to switch between the two possible [[Address bars: Introduction|addressing modes]] . It is also accessible through the main toolbar ( [[Image:context-link-icon]] ).
Located in the '''View''' menu, named either '''Link context tool''' or '''Unlink context tool''', this command allows you to switch between the two possible [[Address bars|addressing modes]]. It is also accessible through the main toolbar ( [[Image:context-link-icon]] ).
{{note|This command only applies to the development window where it is invoked, and this setting is not automatically saved when exiting EiffelStudio. }}
{{seealso|<br/>
[[Development Window Preferences|Change the default data sharing]] <br/>
}}
[[Development Window Preferences|Change the default data sharing]]}}

View File

@@ -11,6 +11,7 @@ It also contains history arrows, and by clicking on the cluster, class or featur
{{tip|Labels in this address bar are pickable, to send the address to other tools easily. }}
{{note|The context tool only has an address bar if it is unlinked from the editor. }}
{{seealso|<br/>

View File

@@ -1,10 +1,16 @@
[[Property:title|Address bars]]
[[Property:weight|1]]
[[Property:uuid|e145c4d3-afd3-653d-cf7c-14fd80f4d566]]
* [[Address bars: Introduction|Introduction]]
* [[Main address bar|Main address bar]]
* [[Context tool address bar|Context tool address bar]]
* [[Change data share mode|Switch between address sharing modes]]
All development windows are composed of two major components, each of which can be centered on a given "address" (either a cluster, a class or a feature). One is the editor, with which go all the peripheral tools (including the [[Cluster tool|cluster tool]] and the [[Feature tool|feature tool]] ). The other is the context tool, which contains for example the [[Formatters: Introduction|class and feature tabs]] , the [[Diagram tool|diagram tool]] and the [[Metric tool: Introduction|metric tool]] .
It is possible to either link both components so that they share the same address (allowing to immediately have extended information on the class that is being edited), or to unlink them (allowing to have extended information on any class while editing a class).
When both are linked, only the [[Main address bar|main address bar]] appears, whereas when they are unlinked, the [[Context tool address bar|context tool address bar]] is also displayed, since it might point to a different location than the main address bar.
The [[Change data share mode|toggle data mode command]] allows you to switch between both modes.
{{seealso|<br/>
[[Development Window Preferences|Change the default data sharing]] }}

View File

@@ -14,6 +14,7 @@ It is possible to type a class or feature name to center the editor on it. Typin
{{tip|Wildcards (* and ?) are available in these fields. }}
{{tip|The history is also accessible in the '''View/Go to''' menu. }}

View File

@@ -6,7 +6,7 @@ The '''favorites''' menu is composed of two parts.
First, there are three commands:
* The '''Add to Favorites''' command, that adds the currently edited class to the root of the favorites tree.
* The '''Show/Hide Favorites''' command, that shows or hides the [[Favorites tree|favorites tree]] .
* The '''Organize Favorites''' command, that displays the [[Organize favorites dialog: Introduction|Organize Favorites dialog]] .
* The '''Organize Favorites''' command, that displays the [[Organize favorites dialog|Organize Favorites dialog]] .
After the separator, the favorites are displayed in a menu representation. Clicking on any of these menu items will send the selected favorite class to the editor.

View File

@@ -5,7 +5,7 @@ The favorites tree gives a graphical representation of the favorite classes of t
[[Image:favorites-tree]]
In this tree, the folders are user-definable through the [[Organize favorites dialog: Introduction|Organize Favorites dialog]] . They have no other goal than ordering the favorites. In particular, they are entirely independent from the clusters of the system.
In this tree, the folders are user-definable through the [[Organize favorites dialog|Organize Favorites dialog]] . They have no other goal than ordering the favorites. In particular, they are entirely independent from the clusters of the system.
Clicking a class in the favorites tree edits it. Keyboard navigation is also available. Favorite classes are [[Pick-and-drop mechanism|pickable]] too, so that it is possible to send them to all interface components that accept classes.

View File

@@ -1,11 +1,9 @@
[[Property:title|Favorites tool]]
[[Property:weight|4]]
[[Property:uuid|75cfeda2-3823-ef29-130a-39e686116f40]]
* [[Favorites tool: Introduction|Introduction]]
* [[Favorites tree|Tree representation]]
* [[Favorites menu|Menu representation]]
* [[Organize Favorites dialog|Organize Favorites dialog]]
The favorites tool ( [[Image:tool-favorites-icon]] ) gives a quick access to often used classes and features. These may be either classes of a library or classes that are often being modified. They are project-wide, which means they are shared by all development windows working on the same project.
[[Image:favorites-tool]]
The favorites tool mainly consists of [[Favorites menu|the favorites menu]] and of the left-panel tool, giving a [[Favorites tree|tree representation]] of the favorite classes.

View File

@@ -1,12 +1,16 @@
[[Property:title|Organize Favorites dialog]]
[[Property:weight|3]]
[[Property:uuid|3e47cb30-c974-b0f4-1624-4bba035bd906]]
* [[Organize favorites dialog: Introduction|Introduction]]
* [[New favorite class command|New Favorite Class command]]
* [[Create favorite folder command|Create Folder command]]
* [[Move to Folder command|Move to Folder command]]
* [[Remove favorite command|Remove command]]
The organize favorites dialog provides a way of sorting the favorites.
[[Image:favorites-dialog]]
The left part of this dialog is composed of a [[Favorites tree|tree representation]] of the favorites identical to the one in the [[Favorites tool|favorites tool]] .
With it, it is possible to [[New favorite class command|add classes]] and [[Create favorite folder command|folders]] to the favorites or [[Remove favorite command|remove some]] , and also to [[Move to Folder command|spread]] the favorite classes among the favorite folders.
{{warning|Since the favorites are project-wide, any modifications made in this dialog are reported in all development windows. }}

View File

@@ -1,7 +1,7 @@
[[Property:title|Move to Folder command]]
[[Property:weight|3]]
[[Property:uuid|087439e6-dc0c-d394-b3ed-ffaaf5928b39]]
The Move to Folder command [[Image:favorites-dialog-move-to]] , located in the [[Organize favorites dialog: Introduction|Organize Favorites dialog]] , makes it possible to move favorite items (classes and folders) to specific folders. It is enabled only when an item is selected in the left-hand tree in this dialog. The source is the selected item that could be moved. You can select a different source item by clicking it in the tree, or by using the keyboard.
The Move to Folder command [[Image:favorites-dialog-move-to]] , located in the [[Organize favorites dialog|Organize Favorites dialog]], makes it possible to move favorite items (classes and folders) to specific folders. It is enabled only when an item is selected in the left-hand tree in this dialog. The source is the selected item that could be moved. You can select a different source item by clicking it in the tree, or by using the keyboard.
When pressed, a dialog is popped up, that prompts for the favorite folder the selected item should be moved to.
@@ -13,6 +13,7 @@ Pressing '''OK''' moves the source item to the destination folder. Pressing '''C
{{tip|You can also move items around by picking them in the favorites tree and dropping them where you want. }}
{{seealso|<br/>
[[Favorites tree|Favorites tree]] <br/>
}}

View File

@@ -1,7 +1,11 @@
[[Property:title|New favorite class command]]
[[Property:weight|1]]
[[Property:uuid|18be5a70-d623-a45c-cf3d-45c1dc0a2ec5]]
Located in the [[Organize favorites dialog: Introduction|Organize Favorites dialog]] , this command [[Image:favorites-dialog-new-class]] provides a way of adding a class to the favorites. When clicked, a new dialog is popped up, that allows to select a class among the clusters of the system:
Located in the [[Organize favorites dialog|Organize Favorites dialog]] , this command:
[[Image:favorites-dialog-new-class]]
provides a way of adding a class to the favorites. When clicked, a new dialog is popped up, that allows to select a class among the clusters of the system:
[[Image:favorites-new-class-dialog]]
@@ -10,7 +14,7 @@ Clicking on a class name sets its name in the top text field, whereas double-cli
The selected class goes to the root of the favorite tree. It is then possible to [[Move to Folder command|move]] it to a different favorite folder.
{{seealso|<br/>
[[Favorites tool: Introduction|Favorite tool]] <br/>
[[Favorites tool|Favorite tool]] <br/>
[[Favorites menu|Favorite menu]] <br/>
}}

View File

@@ -1,10 +1,7 @@
[[Property:title|Remove favorite command]]
[[Property:weight|4]]
[[Property:uuid|c55daacd-a7f8-294b-6b2c-9d503e6a3969]]
The Remove favorite command [[Image:favorites-dialog-remove]] discards a favorite item from the favorites. It is enabled whenever an item is selected in the left-hand tree of the [[Organize favorites dialog: Introduction|Organize favorites dialog]] .
The Remove favorite command [[Image:favorites-dialog-remove]] discards a favorite item from the favorites. It is enabled whenever an item is selected in the left-hand tree of the [[Organize favorites dialog|Organize favorites dialog]].
Pressing it removes the selected item from the favorites.

View File

@@ -2,10 +2,15 @@
[[Property:link_title|Features tool]]
[[Property:weight|3]]
[[Property:uuid|bc9b2ef1-b4c4-773a-9ba8-97143fb2727a]]
* [[Feature tool: Introduction|Introduction]]
* [[Feature tree|Tree representation]]
* [[New feature command|New feature command]]
{| border="0"
|-
| [[Image:feature-tool]]
|
And if you click on [[Image:feature-tool-signature-button|[S]]] the signature toggle button. <br/>
You will see the signature for each feature
| [[Image:feature-tool-signature]]
|}
The feature tool ( [[Image:tool-feature-icon]] ) gives a summary of all written-in features of the currently edited class. They are listed in a [[Feature tree|tree representation]] , where the nodes are the feature clauses, and the leaves are the features.
In the tool mini-toolbar, a [[New feature command|new feature command]] is available, which adds a new feature in the edited class.

View File

@@ -1,10 +1,7 @@
[[Property:title|New feature command]]
[[Property:weight|2]]
[[Property:uuid|3a670193-29dd-b829-0c90-eec8dd7e74b6]]
The new feature command [[Image:new-feature-icon]] located in the [[Feature tool: Introduction|feature tool]] acts like the [[New feature dialog: Introduction|main new feature command]] . Clicking it pops up the same dialog, making it possible to add a new feature in the currently edited class.
The new feature command [[Image:new-feature-icon]] located in the [[Feature tool|feature tool]] acts like the [[New feature dialog: Introduction|main new feature command]] . Clicking it pops up the same dialog, making it possible to add a new feature in the currently edited class.
This command is only available when the class currently in the editor is compiled, can be modified, and has a file on the disk (this may not be the case if the class is precompiled).

View File

@@ -2,12 +2,9 @@
[[Property:link_title|Groups tool]]
[[Property:weight|2]]
[[Property:uuid|0baebaa5-a9c8-4c7c-6ace-c11d82804906]]
* [[Cluster tool: Introduction|Introduction]]
* [[System tree representation|System tree representation]]
* [[New cluster command|New cluster command]]
* [[New class command|New class command]]
* [[Locate command|Locate command]]
The cluster tool ( [[Image:tool-clusters-icon]] ) is one of the tools located on the left of development windows.
[[Image:cluster-tool]]
It gives a [[System tree representation|tree representation]] of all clusters and classes of the project. The toolbar contains a [[New cluster command|new cluster command]] , a [[New class command|new class command]] , and the [[Locate command|locate command]] .

View File

@@ -1,7 +1,7 @@
[[Property:title|Locate command]]
[[Property:weight|4]]
[[Property:uuid|10d2cf53-4e11-d44c-ee05-12fc1c6c354c]]
The locate command ( [[Image:general-search-icon]] ), located in the [[Cluster tool: Introduction|cluster tool]] , provides an easy way to find a class or a cluster in the [[System tree representation|cluster tree]] .
The locate command ( [[Image:general-search-icon]] ), located in the [[Cluster tool|cluster tool]], provides an easy way to find a class or a cluster in the [[System tree representation|cluster tree]] .
Clicking it automatically expands the clusters containing the edited class or cluster and selects it.

View File

@@ -19,6 +19,3 @@ Left-clicking on any item will send it to the editor. It is also possible to [[P
[[Pick-and-drop mechanism|Dropping]] a class in this tree representation moves it to a different cluster (either the cluster it is dropped on or the cluster containing the class it is dropped on, according to where it is dropped). This is only possible if the dropped class is not in a library cluster, if its source file is readable and writable, and if the destination cluster is not a library or precompiled cluster itself.

View File

@@ -1,13 +1,10 @@
[[Property:title|Browsing tools]]
[[Property:weight|-13]]
[[Property:uuid|b4e840c3-a635-b5dd-fbd2-0db69b3d6ce1]]
* [[Browsing tools: Introduction|Introduction]]
* [[Address bars|Address bars]]
* [[Cluster tool|Cluster tool]]
* [[Feature tool|Feature tool]]
* [[Favorites tool|Favorites tool]]
* [[Windows tool|Windows tool]]
* [[Search tool|Search tool]]
The browsing tools are the address bars as well as all the tools that are in the left panel of development windows in normal mode. They help find an item in the system, such as a class, a cluster, a feature, some text, ... They include the [[Address bars|address bars]], the [[Cluster tool|cluster tool]], the [[Feature tool|feature tool]], the [[Favorites tool|favorites tool]], the [[Windows tool|windows tool]], and the [[Search tool|search tool]] .
{{seealso|<br/>
[[EiffelStudio window overview|General window overview]] }}

View File

@@ -1,10 +1,5 @@
[[Property:title|EiffelStudio interface mechanisms]]
[[Property:weight|0]]
[[Property:uuid|ae1b2f77-4853-b282-a80b-f9413bbe74a4]]
* [[Pick-and-drop mechanism|Pick-and-drop]]
* [[Pick-and-drop shortcut|Pick-and-drop shortcut]]
* [[Toolbar customization|Toolbars customization]]

View File

@@ -1,7 +1,7 @@
[[Property:title|Pick-and-drop mechanism]]
[[Property:weight|0]]
[[Property:uuid|68a85ff6-d28f-9ba5-0a5c-4eba546497b8]]
Pick-and-drop is one of Eiffel Software's exclusive technologies and is provided by [[EiffelVision Introduction|Eiffel Vision2]] . In EiffelStudio it allows you to easily send data from a component of the interface to another.
Pick-and-drop is one of Eiffel Software's exclusive technologies and is provided by [[EiffelVision Introduction|EiffelVision]]. In EiffelStudio it allows you to send data easily from a component of the interface to another.
You can pick every reference to a '''development object''' (like a class, a feature or an execution object) with a single click on the '''right''' mouse button. Then as you start moving the mouse around - not pressing any of its buttons - a pebble tracks the cursor position, and a line continuously connects the pebble to the object's original position. The pebble's shape indicates the type of the development object that you picked (oval disk for a class, cross for a feature, folder for a cluster...).

View File

@@ -5,6 +5,7 @@ In the [[EiffelStudio Editor Introduction|editor]] and the [[EiffelStudio windo
{{tip|The effect of control-picking is now configurable in the [[Preferences Reference|preferences]] . }}
{{seealso|<br/>
[[Pick-and-drop mechanism|Pick-and-drop mechanism]] }}

View File

@@ -62,7 +62,7 @@ By default, the context tool is unlinked from the rest of the window, which mean
{{seealso|<br/>
[[EiffelStudio: A Guided Tour|EiffelStudio Guided Tour]] <br/>
[[Browsing tools: Introduction|Browsing tools]] <br/>
[[Browsing tools|Browsing tools]] <br/>
[[Main toolbars|Toolbar customization]] <br/>
[[EiffelStudio Editor Introduction|Editor reference]] <br/>
[[Formatters: Introduction|Formatted information about compiled classes and features]] <br/>

View File

@@ -2,12 +2,5 @@
[[Property:link_title|General Description]]
[[Property:weight|-14]]
[[Property:uuid|9202a4d2-4fee-f4e6-1b7e-12dad9adc3d0]]
* [[EiffelStudio interface mechanisms|General interface mechanisms]]
* [[EiffelStudio window overview|EiffelStudio window overview]]
* [[Main toolbars|Main toolbars]]
* [[EiffelStudio: Key shortcuts|Key shortcuts]]
* Docking[[Docking| (See EiffelBuild documentation on docking mechanism for more details)]]
In addition to this information describing the EiffelStudio user interface, you may also want to check out the section on [[Docking|docking]] in the EiffelBuild documentation.

View File

@@ -6,7 +6,7 @@ At the top of a development window, two toolbars are displayed by default. They
You can hide toolbars (or the address bar) by unselecting them in the '''Toolbars''' sub-menu of the '''View''' menu or in the context menu that you can get by right-clicking in the empty space on the right of the bars. If you want them to be displayed again, just select them in the '''Toolbars''' sub-menu of the '''View''' menu.
In the standard toolbar, you will find buttons to manage [[Browsing tools: Introduction|tools]] and windows or that are related to the [[EiffelStudio Editor Introduction|editor]] . <br/>
In the standard toolbar, you will find buttons to manage [[Browsing tools|tools]] and windows or that are related to the [[EiffelStudio Editor Introduction|editor]] . <br/>
{{note|For both toolbars, it is possible to choose which buttons are displayed and which ones are not. See the [[Toolbar customization|Toolbars customization page]] for more information. }}

View File

@@ -1,11 +1,13 @@
[[Property:title|Metrics tool]]
[[Property:weight|-5]]
[[Property:uuid|e76d1c3b-773f-c051-bd94-3272f3ccadc6]]
* [[Metric tool: Introduction|Introduction]]
* [[Requirements|Requirements]]
* [[Definitions|Definitions]]
* [[User interface basics|User interface basics]]
One of the innovations of the EiffelStudio development environment is a set of metric facilities enabling developers and managers to obtain quantitative information about software systems and the process of producing them.
* Find out basic quantitative properties of a system, such as the number of classes, the number of features, how many times the system has been compiled and many others
* Define new properties as mathematical combinations of the basic ones, and compute the resulting values, to get the answers to such questions as what percentage of my system's routines have precondition clauses' or what is the average number of features, lines, or invariant clauses per class?
* Vary the scope of such measurements, so that the measured result may cover a single feature, a class, a cluster, an entire system or an archive of another system to make comparisons with other projects.
* Compare the result of the same metric over several of these scopes, to see for example how a project differs from those on record, or whether some parts of a project depart from the norms applied in others.
The environment will support such measurements through a simple graphical interface, closely integrated with the rest of the Eiffel Explorer. Users of the environment can start applying these facilities to their systems without learning any theory.
Metrics, however, are notoriously subject to abuse; we must be wary of the temptation to revere numbers just because they are numbers (lies, damn lies and metrics). This note presents a simple approach to software metrics designed to establish a clear and sound basis, so that we know what we are measuring, why we are measuring it, and how much value we may attach to the results.