mirror of
https://github.com/EiffelSoftware/eiffel-org.git
synced 2025-12-07 23:32:42 +01:00
Author:halw
Date:2009-08-03T01:48:36.000000Z git-svn-id: https://svn.eiffel.com/eiffel-org/trunk@270 abb3cda0-5349-4a8f-a601-0c33ac3a8c38
This commit is contained in:
@@ -2,6 +2,6 @@
|
||||
[[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|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|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|cluster tool]] . This tool will then show where the class is in the universe.
|
||||
* You may use the [[Groups tool|groups 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|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 [[Groups tool|groups tool]] . This tool will then show where the class is in the universe.
|
||||
|
||||
|
||||
@@ -1,28 +1,28 @@
|
||||
[[Property:title|Annotation Management]]
|
||||
[[Property:weight|1]]
|
||||
[[Property:uuid|696457ef-ac1f-40c1-a0da-54900d9cccf8]]
|
||||
The Information Tool provides information management functions: adding, modifying and removing.
|
||||
The Information Tool gives you the ability to '''add''', '''modify''', and '''remove''' annotations from within the tool. When you manage annotations via the Information Tool, the appropriate text changes are made to the annotation targets. So, for example, if you use the Information Tool to add an annotation to a class, you will see the annotation after a new '''EIS marker''' in the <code>note</code> part of the class text.
|
||||
|
||||
{{note|Annotation management is only available in lists coresponding to nodes rather than tag nodes - all tags and "Items without tag". }}
|
||||
|
||||
{{note|Annotation management is not available in lists corresponding to tag nodes in the information tree. That is, annotations listed in ''All tags'', ''Items without tag'', and nodes for specific named tags cannot be altered. }}
|
||||
|
||||
Of course, you can also use the EiffelStudio editor or an external editor to manage annotations in Eiffel source code and configuration files using the annotation syntax described in [[EIS: Outgoing]]. The advantage to using the Information Tool is that the tool modifies the files for you, making the process less prone to error.
|
||||
|
||||
==Adding==
|
||||
|
||||
For each kind of nodes in the information tree, related annotations are listed in the right annotaton list. At the end of such lists, double clicking the blank line with '''"..."''' in the '''Name''' column creates a new unnamed annotation. You can then modify the new entry as you wish.
|
||||
For each node in the information tree, the list of associated annotations is visible to the right. At the bottom the list, there is an entry that is blank, except for the '''Name''' column which contains an ellipsis (" ... "). Double clicking the blank line creates a new unnamed annotation. You can then modify the new entry as you wish.
|
||||
|
||||
==Modifying==
|
||||
|
||||
To modify an annotation, one can use the Information Tool or modify it by code.
|
||||
* Using Information Tool, select a line in the annotation list, then click into columns and activate editing/choosing mode. Once the editing area drop down list is deactivated, the modification is done and synchronized into code automatically.
|
||||
* By code, one simply modifies code in the editor, or .ecf files in external editor (not recommended).
|
||||
{{seealso|<br/>
|
||||
[[EIS: Outgoing|Syntax for Annotations]] }}
|
||||
|
||||
Select a line in the annotation list, then click into a column you wish to change. This will activate ''editing/choosing'' mode. Now you can edit text in the column or if the column is a drop down list, you can choose an alternative entry. Once the editing area drop down list is deactivated, the modification is done and synchronized into code automatically.
|
||||
|
||||
==Removing==
|
||||
|
||||
By pressing '''Delete''', or clicking the third button on the bottom toolbar deletes all selected annotations in the list. And corresponding code is synchronized.
|
||||
By pressing '''Delete''', or clicking the ''delete'' button [[Image:16x16--general-delete-icon]] on the bottom toolbar, you will delete any selected annotations in the list. This deletes the annotation entries from the list and also from the corresponding the Eiffel class or configuration text.
|
||||
|
||||
|
||||
{{note|Multiple entries in the annotation list can be deleted by selecting them all prior to clicking ''delete''. }}
|
||||
|
||||
{{note|Annotation list can be multi-selected. }}
|
||||
|
||||
{{note| All means to manage annotations via the tool are inreversible, except that the location - class or feature - has been opened in the editor, thus undo can be achieved via the editor. Removing is prompted on user demands. The tag tree is automatically updated when annotations are added/modified/removed or through system sweeping. }}
|
||||
|
||||
|
||||
@@ -52,8 +52,8 @@ Figure 2: The Select Help Document dialog box
|
||||
==Sweeping Information==
|
||||
|
||||
Sweeping annotation information will update the Information Tool with current data for all the annotations in the current system. There are two approaches to sweeping information:
|
||||
* '''Automatic''' - EIS automatically sweeps information at times when Information tool is visible. Toggling down the automatic sweeping button [[Image:automatic sweeping icon]] on the bottom toolbar activates this function.
|
||||
* '''Manual''' - Clicking the manual sweeping button [[Image:manual sweeping icon]] on the bottom toolbar triggers an immediate manual sweep.
|
||||
* '''Automatic''' - EIS automatically sweeps information at times when Information tool is visible. On the bottom toolbar, clicking the ''automatic sweeping'' toggle button [[Image:automatic sweeping icon]] to the ''down'' position activates automatic sweeping. Clicking the button back to the ''up'' position disables automatic sweeping.
|
||||
* '''Manual''' - Clicking the ''manual sweeping'' button [[Image:manual sweeping icon]] on the bottom toolbar triggers an immediate manual sweep.
|
||||
|
||||
The progress bar in the bottom of the tool indicates the progress of a currently executing sweep..
|
||||
|
||||
|
||||
Reference in New Issue
Block a user