mirror of
https://github.com/EiffelSoftware/eiffel-org.git
synced 2025-12-08 07:42:33 +01:00
Author:admin
Date:2008-09-17T13:53:28.000000Z git-svn-id: https://svn.eiffel.com/eiffel-org/trunk@3 abb3cda0-5349-4a8f-a601-0c33ac3a8c38
This commit is contained in:
jfiat
@@ -0,0 +1,13 @@
|
||||
[[Property:title|Change data share mode]]
|
||||
[[Property:weight|3]]
|
||||
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]] ).
|
||||
|
||||
{{note| '''Note''': This command only applies to the development window where it is invoked, and this setting is not automatically saved when exiting EiffelStudio. }}
|
||||
|
||||
{{seealso| '''See Also''' <br/>
|
||||
[[Development Window Preferences|Change the default data sharing]] <br/>
|
||||
}}
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,20 @@
|
||||
[[Property:title|Context tool address bar]]
|
||||
[[Property:weight|2]]
|
||||
The address bar of the context tool has a different look from the [[Main address bar|main address bar]] , but provides the same functionality.
|
||||
|
||||
[[Image:context-address-bar]]
|
||||
|
||||
It also contains history arrows, and by clicking on the cluster, class or feature name, a window is popped up that contains fields similar to the ones of the [[Main address bar|main address bar]] , except that a cluster can also be entered, since the diagram tool and the metrics also work with clusters:
|
||||
|
||||
[[Image:context-address-window]]
|
||||
|
||||
{{tip| '''Tip''': Labels in this address bar are pickable, to send the address to other tools easily. }}
|
||||
|
||||
{{note| '''Note''': The context tool only has an address bar if it is unlinked from the editor. }}
|
||||
|
||||
{{seealso| '''See Also''' <br/>
|
||||
[[Change data share mode|Unlinking the context tool]] }}
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,10 @@
|
||||
[[Property:title|Address bars]]
|
||||
[[Property:weight|1]]
|
||||
* [[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]]
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,20 @@
|
||||
[[Property:title|Main address bar]]
|
||||
[[Property:weight|1]]
|
||||
The main address bar is located in the top part of windows, between the two [[Main toolbars|main toolbars]] (when they are displayed).
|
||||
|
||||
[[Image:main-address-bar]]
|
||||
|
||||
It has several components:
|
||||
* History back and forth arrows [[Image:view-previous-icon]] and [[Image:view-next-icon]]
|
||||
* Fields where the current class or feature name is displayed
|
||||
* View icons to change the view displayed in the editor [[Image:view-editor-icon]] , [[Image:view-clickable-icon]] , [[Image:view-flat-icon]] , [[Image:view-contracts-icon]] and [[Image:view-flat-contracts-icon]]
|
||||
|
||||
It is possible to type a class or feature name to center the editor on it. Typing a class name that does not exist in the set of known classes pops up a dialog to create a class of that name.
|
||||
|
||||
{{tip| '''Tip''': Wildcards (* and ?) are available in these fields. }}
|
||||
|
||||
{{tip| '''Tip''': The history is also accessible in the '''View/Go to''' menu. }}
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
[[Property:title|Favorites menu]]
|
||||
[[Property:weight|2]]
|
||||
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]] .
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
[[Property:title|Favorites tree]]
|
||||
[[Property:weight|1]]
|
||||
The favorites tree gives a graphical representation of the favorite classes of the system, as opposed to the favorites menu.
|
||||
|
||||
[[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.
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,10 @@
|
||||
[[Property:title|Favorites tool]]
|
||||
[[Property:weight|4]]
|
||||
* [[Favorites tool: Introduction|Introduction]]
|
||||
* [[Favorites tree|Tree representation]]
|
||||
* [[Favorites menu|Menu representation]]
|
||||
* [[Organize Favorites dialog|Organize Favorites dialog]]
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
[[Property:title|Create favorite folder command]]
|
||||
[[Property:weight|2]]
|
||||
This command [[Image:favorites-dialog-new-folder]] is accessible in the Organize favorites dialog. When clicked, a dialog is popped up that prompts for a name for the new folder:
|
||||
|
||||
[[Image:favorites-new-folder-dialog]]
|
||||
|
||||
After typing the name of the new folder, pressing '''OK''' adds it to the root of the favorites.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
[[Property:title|Organize Favorites dialog]]
|
||||
[[Property:weight|3]]
|
||||
* [[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]]
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,21 @@
|
||||
[[Property:title|Move to Folder command]]
|
||||
[[Property:weight|3]]
|
||||
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.
|
||||
|
||||
When pressed, a dialog is popped up, that prompts for the favorite folder the selected item should be moved to.
|
||||
|
||||
[[Image:favorites-choose-folder-dialog]]
|
||||
|
||||
Select the destination folder by expanding the tree and by clicking it. The top tree item, named Favorites, represents the root of the favorites.
|
||||
|
||||
Pressing '''OK''' moves the source item to the destination folder. Pressing '''Cancel''' discards the dialog box and does not move the source item.
|
||||
|
||||
{{tip| '''Tip''': You can also move items around by picking them in the favorites tree and dropping them where you want. }}
|
||||
|
||||
{{seealso| '''See Also''' <br/>
|
||||
[[Favorites tree|Favorites tree]] <br/>
|
||||
}}
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,18 @@
|
||||
[[Property:title|New favorite class command]]
|
||||
[[Property:weight|1]]
|
||||
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:
|
||||
|
||||
[[Image:favorites-new-class-dialog]]
|
||||
|
||||
Clicking on a class name sets its name in the top text field, whereas double-clicking it automatically selects it and closes the dialog box. It is also possible to directly type the name of the wanted class in the top text field to select it.
|
||||
|
||||
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| '''See Also''' <br/>
|
||||
[[Favorites tool: Introduction|Favorite tool]] <br/>
|
||||
[[Favorites menu|Favorite menu]] <br/>
|
||||
}}
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
[[Property:title|Remove favorite command]]
|
||||
[[Property:weight|4]]
|
||||
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]] .
|
||||
|
||||
Pressing it removes the selected item from the favorites.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,24 @@
|
||||
[[Property:title|Feature tree]]
|
||||
[[Property:weight|1]]
|
||||
[[Image:feature-tree]]
|
||||
|
||||
The feature tree gives a summary of all the features of the currently edited class. They are in the same order as they are in the class file, and they are grouped by their feature clause.
|
||||
|
||||
The icon relative to the feature clause indicates the export status of the features inside it:
|
||||
* [[Image:folder-features-all-icon]] means features are exported to all classes
|
||||
* [[Image:folder-features-some-icon]] means features are exported to some classes
|
||||
* [[Image:folder-features-none-icon]] means features are not exported
|
||||
|
||||
The icon on the features indicates the nature of the feature:
|
||||
* [[Image:feature-attribute-icon]] for attributes
|
||||
* [[Image:feature-once-icon]] for once and constant features
|
||||
* [[Image:feature-deferred-icon]] for deferred features
|
||||
* [[Image:feature-external-icon]] for external features
|
||||
* [[Image:feature-frozen-routine-icon]] for frozen features
|
||||
* [[Image:feature-routine-icon]] for normal Eiffel routines
|
||||
|
||||
Clicking a feature or a feature clause in the tree centers the editor on it. Key navigation is also available. All features can be [[Pick-and-drop mechanism|picked]] , to [[Pick-and-drop mechanism|be dropped]] them into any component of the interface that accepts features.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,10 @@
|
||||
[[Property:title|Feature tool]]
|
||||
[[Property:link_title|Features tool]]
|
||||
[[Property:weight|3]]
|
||||
* [[Feature tool: Introduction|Introduction]]
|
||||
* [[Feature tree|Tree representation]]
|
||||
* [[New feature command|New feature command]]
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
[[Property:title|New feature command]]
|
||||
[[Property:weight|2]]
|
||||
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.
|
||||
|
||||
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).
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
[[Property:title|Cluster tool]]
|
||||
[[Property:link_title|Groups tool]]
|
||||
[[Property:weight|2]]
|
||||
* [[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]]
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
[[Property:title|Locate command]]
|
||||
[[Property:weight|4]]
|
||||
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]] .
|
||||
|
||||
Clicking it automatically expands the clusters containing the edited class or cluster and selects it.
|
||||
|
||||
[[Pick-and-drop mechanism|Dropping]] a class or a cluster on it expands the clusters containing the searched item and selects it.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
[[Property:title|New class command]]
|
||||
[[Property:weight|3]]
|
||||
The new class command ( [[Image:new-class-icon]] ) located in the cluster tool toolbar creates a class in the same fashion as the main new class command. The only difference is that when using the cluster tool command, the new class is by default located in the cluster selected in the [[System tree representation|cluster tree]] (or the parent cluster of the selected class, if a class is selected).
|
||||
|
||||
A dialog is then popped up in which it is possible to select the name of the new class, the name of the file it should be created in (by default ".e" is appended to the name of the new class to generate the file name), and the cluster in which the new class should be inserted. Only clusters that are not libraries are displayed in the list, since library clusters cannot be modified.
|
||||
|
||||
[[Image:new-class-dialog]]
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,16 @@
|
||||
[[Property:title|New cluster command]]
|
||||
[[Property:weight|2]]
|
||||
The new cluster command ( [[Image:new-cluster-icon]] ) located in the cluster tool toolbar creates a cluster in the same fashion as the main new cluster command. The only difference is that when using the cluster tool command, the new cluster is by default located in the cluster selected in the [[System tree representation|cluster tree]] (or the selected class's parent cluster, if a class is selected).
|
||||
|
||||
A dialog is then popped up in which it is possible to select the name of the new cluster and the cluster in which the new cluster should be inserted. Only clusters that are not libraries are displayed in the list.
|
||||
|
||||
[[Image:new-cluster-dialog]]
|
||||
|
||||
Enabling the '''recursive''' option makes the compiler search not only the cluster directory but also all its sub-directories for classes. <br/>
|
||||
The '''library''' option optimizes compilations, since the classes inside a library cluster are compiled only once. However, if you modify the classes inside a library cluster, the modifications will not be taken into account in your project. Besides, you cannot add or remove classes in a library cluster, so use this option with care: if you intend to create new classes inside this cluster later in your design, do not select the library option. You should use this option only if the new cluster is given an existing directory, which already contains classes that you will not modify.
|
||||
|
||||
{{tip| '''Tip''': You don't have to enter a path for the new cluster if you choose to create a sub-cluster: the new cluster directory will be a sub-directory of the directory of the parent cluster, and its name will be the name of the newly created cluster. }}
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
[[Property:title|System tree representation]]
|
||||
[[Property:weight|1]]
|
||||
The cluster tool is mainly composed of a tree representation of the system.
|
||||
|
||||
[[Image:cluster-tree]]
|
||||
|
||||
Here is the meaning of the symbols of the cluster tree:
|
||||
* [[Image:folder-cluster-icon]] , [[Image:folder-cluster-readonly-icon]] , [[Image:folder-blank-icon]] , [[Image:folder-override-cluster-icon]] , [[Image:folder-hidden-cluster-icon]] , are clusters (normal, readonly, subfolder in a recursive cluster, override cluster, hidden/implementation cluster)
|
||||
* [[Image:folder-library-icon]] are libraries
|
||||
* [[Image:folder-assembly-icon]] are assemblies
|
||||
* [[Image:folder-namespace-icon]] are namespaces in assemblies
|
||||
* [[Image:class-normal-icon]] , [[Image:class-frozen-icon]] , [[Image:expanded-normal-icon]] , [[Image:class-deferred-icon]] , [[Image:class-overriden-normal-icon]] , [[Image:class-override-normal-icon]] are compiled classes (normal, frozen, expanded, deferred, overriden, overriding)
|
||||
* Greyed out classes are classes outside the system.
|
||||
* Classes and clusters that are part of a readonly group are shown with a lock (for clusters) or brighter icon than normal (they cannot be modified)
|
||||
* [[Image:folder-target-icon]] are targets
|
||||
|
||||
Left-clicking on any item will send it to the editor. It is also possible to [[Pick-and-drop mechanism|pick]] items to send them to various components of the development window.
|
||||
|
||||
[[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.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
[[Property:title|Browsing tools]]
|
||||
[[Property:weight|-13]]
|
||||
* [[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]]
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,43 @@
|
||||
[[Property:title|Search tool]]
|
||||
[[Property:weight|6]]
|
||||
==Description and usage==
|
||||
|
||||
EiffelStudio includes a search tool which allows you to look for a word or a pattern in the editor, the class tool, the feature tool or the output tool, and to replace it by another word if you want. It is located in the left part of the development window, like the cluster tool or the favorites for instance.
|
||||
|
||||
To make it appear, if it is not displayed, click on the search icon [[Image:tool-search-icon]] or choose the '''Search''' entry in the '''Edit''' menu. The search panel is divided in three parts (see Fig. 1).
|
||||
|
||||
[[Image:search-tool]]
|
||||
|
||||
Fig. 1: Search panel
|
||||
|
||||
In the top part, you will find a combo box and a check box. The title of this text field is "Search for:", it will be used to enter the pattern you want to look for. The button is labeled "Replace with". If you click on it, another text field will appear. If you click again, the second text field will be hidden. This text field will be used to enter the word which you want the editor to use to replace found patterns. <br/>
|
||||
In the middle part of the search panel, you will find search options. They are described below. <br/>
|
||||
The bottom part contains two buttons: "Search" and "Replace". Click on the first one to launch the search for the pattern entered in the "Search for" field. The "Replace" button will be active only if the "Replace with" field is displayed. Press this button if you want to replace the last found pattern by the contents of the "Replace with" text field.
|
||||
|
||||
==Options==
|
||||
|
||||
The options are located in the middle of the search panel. There are five buttons, each of them corresponding to an option:
|
||||
*
|
||||
Match case: If this option is selected, the search will be case-sensitive, which means that if you search for "example", the tool will highlight "example" but not "EXAMPLE" or "Example", as there are no capital letters in the searched pattern.
|
||||
|
||||
* Whole word: If this option is selected, the tool will look for isolated words. A word is isolated if it is surrounded by spaces or if it is at the beginning or the end of a line.
|
||||
*
|
||||
Use wildcards: If this option is not selected, the tool will look for the exact sequence of letters you entered in the "Search for" field. If it is selected, you will be able to use '*' and '?'wildcards. '?' in the searched pattern is equivalent to any character. For instance, "sample" and "simple" will be highlighted if you look for "s?mple". <br/>
|
||||
'*' is equivalent to any sequence of characters, including no characters at all. It means that if you search for "exam*ple", every piece of text beginning with "exam" and finishing with "ple" will be highlighted. Use it in combination with "Whole word" to search for words beginning with "exam" and finishing with "ple".
|
||||
|
||||
*
|
||||
Replace all: If it is selected when you press the "Replace" button, every occurrence of the searched pattern will be replaced with the content of the "Replace with" field. It is possible to activate this option only if the "Replace with" field is displayed.
|
||||
|
||||
*
|
||||
Search backwards: If this option is selected, the tool will highlight the previous occurrence of the searched pattern instead of the next occurrence when you press the "Search" button.
|
||||
|
||||
|
||||
'''Note''': If the search tool hits one end of the text, it will automatically continue from the other end. <br/>
|
||||
|
||||
|
||||
{{seealso| '''See Also''' <br/>
|
||||
There are keyboard shortcuts and menu entries to launch searches without using the search tool directly. They are described the [[Search functionality|editor section]] of this help. }}
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,10 @@
|
||||
[[Property:title|Windows tool]]
|
||||
[[Property:weight|5]]
|
||||
* [[Windows tool: Introduction|Introduction]]
|
||||
* [[Window list|Window list]]
|
||||
* [[Window menu|Window menu]]
|
||||
* [[Window related commands|Window related commands]]
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
[[Property:title|Window list]]
|
||||
[[Property:weight|1]]
|
||||
The window list is the main part of the [[Windows tool: Introduction|window tool]] .
|
||||
|
||||
[[Image:windows-tool]]
|
||||
|
||||
It displays all opened development windows. Left-clicking a development window in the list raises it so that it becomes the top-level window. Right-clicking one pops up a context menu.
|
||||
|
||||
The four first commands, '''Close''', '''Minimize''', '''Maximize''' and '''Raise''', are relative to the clicked development window. The last command, '''New window''', creates a new development window.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,7 @@
|
||||
[[Property:title|Window menu]]
|
||||
[[Property:weight|2]]
|
||||
The '''window''' menu is divided into two parts. The first one is composed of the [[Window related commands|window-related commands]] . The second one is the list of all opened development windows. Clicking any of these raises the selected development window, so that it becomes the top-level window.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
[[Property:title|Window related commands]]
|
||||
[[Property:weight|3]]
|
||||
A few commands give the possibility to manage the development windows globally. They are located both in the [[Window menu|Window menu]] and in the main toolbar.
|
||||
* '''New window''': this command ( [[Image:new-window-icon]] ) creates a new empty development window. Note that it is also possible to [[Pick-and-drop mechanism|drop]] a class or a feature on it to create a development window that is immediately centered on the dropped item.
|
||||
* '''Minimize all''': this command ( [[Image:windows-minimize-all-icon]] ) iconifies all development windows.
|
||||
* '''Raise all''': this command ( [[Image:windows-raise-all-icon]] ) raises all minimized development windows.
|
||||
* '''Raise unsaved windows''': this command raises all the development windows that have not been saved. It may be combined with the '''Minimize all''' command to find easily which development windows need to be saved.
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user