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

Updated for v7.1

Browse Source 
Author:halw
Date:2012-06-26T02:16:00.000000Z


git-svn-id: https://svn.eiffel.com/eiffel-org/trunk@1110 abb3cda0-5349-4a8f-a601-0c33ac3a8c38
This commit is contained in:
halw
2012-06-26 02:16:00 +00:00
parent 36baee020b
commit 45e7751cf2
1 changed files with 16 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
documentation/current/eiffelstudio/eiffelstudio-reference/eiffel-information-system/eis-outgoing/information-tool/browsing-information.wiki
View File

@@ -1,10 +1,11 @@
[[Property:title|Browsing Information]] [[Property:title|Browsing Information]]
[[Property:weight|0]] [[Property:weight|0]]
[[Property:uuid|2260eabd-cbc9-c385-6295-96474249953f]] [[Property:uuid|2260eabd-cbc9-c385-6295-96474249953f]]
[[Image:information tool v64]] [[Image:information tool v71|1000px]]
Figure 1: The Information Tool Figure 1: The Information Tool
==Information Tree== ==Information Tree==
On the left of the tool window is the information tree. The tree displays all locations which contain annotations, as well as a subtree of tags by which annotations can be organized. Clicking or pressing enter on a node of the tree displays the list of annotations associated with that node. In Figure 1, the node APPLICATION, a class, has been selected, and its annotations are listed on the right. On the left of the tool window is the information tree. The tree displays all locations which contain annotations, as well as a subtree of tags by which annotations can be organized. Clicking or pressing enter on a node of the tree displays the list of annotations associated with that node. In Figure 1, the node APPLICATION, a class, has been selected, and its annotations are listed on the right.
@@ -15,31 +16,35 @@ You can navigate to the following types of nodes in the information tree:
* Library * Library
* Class * Class
* Feature * Feature
* Targets without tags * Items without tags
* Listed tag
==Annotation List== ==Annotation List==
The annotation list appears on the right of the tool window. The annotation list appears on the right of the tool window.
The following columns are available in the list: The following columns are available in the list:
* '''Location''' - the development object where that piece of annotation belongs to. Typical locations are target, cluster, class and feature. * '''Target''' - the development object where that piece of annotation belongs to. Typical locations are target, cluster, class and feature.
* '''Name''' - the name of the annotation.
* '''[[Protocols|Protocol]]''' - the type of the Source.
* '''Source''' - the address of the resource, typically a URL or file path. Variables can be used. * '''Source''' - the address of the resource, typically a URL or file path. Variables can be used.
* '''Parameters''' - additional information relevant to certain protocols, for example, a page number in a PDF document.
* '''[[Protocols|Protocol]]''' - the type of the Source.
* '''Name''' - the name of the annotation.
* '''Tags''' - terms or phrases used to categorize annotations. Tags are separated by '''","''' * '''Tags''' - terms or phrases used to categorize annotations. Tags are separated by '''","'''
* '''Override''' - checkbox is checked if an implicit, automatically generated annotation is being overridden by the annotation in this list entry. If this list entry is itself an implicit annotation, this column shows the automatic annotation [[Image: automatic annotation icon]] icon. Override is defined only for annotations on classes. * '''Override''' - checkbox is checked if an implicit, automatically generated annotation is being overridden by the annotation in this list entry. If this list entry is itself an implicit annotation, this column shows the automatic annotation [[Image: automatic annotation icon]] icon. Override is defined only for annotations on classes.
* '''Others''' - other related attributes. Attributes are separated by '''","'''
{{note|EIS ignores any attributes in '''Others''' which are not used by the '''protocol'''. }}
{{tip| Clicking on title of each column sorts that column. }}
{{note|EIS ignores any parameters in '''Parameters''' which are not used by the '''protocol''' specified in the entry. }}
{{tip| Clicking on title of each column sorts the list based on the values in that column. }}
==Opening Resources== ==Opening Resources==
The resources associated with a particular annotation can be opened by double-clicking on the annotation in the Information Tool list. Alternatively, you can use the arrow keys to highlight the annotation in the Information Tool list and then press enter. EIS opens the resource associated with the annotation using the external tool for the resource's protocol. So, for example, Raw URL resources will be opened in the default web browser. The most straightforward way of opening a resource is to select the annotation containing the resource and click the "Go to" button on the status bar below the annotation list.
The resource associated with a particular annotation can also be opened by double-clicking on the annotation in the Information Tool list. Alternatively, you can use the arrow keys to highlight the annotation in the Information Tool list and then press enter. EIS opens the resource associated with the annotation using the external tool for the resource's protocol. So, for example, URI resources will be opened in the default web browser.
While using EiffelStudio, pressing '''F1''' while the cursor is in the editor pane will access annotations associated with the Eiffel object that is currently shown in the editor pane. If only one annotation is available, then its resource is automatically opened by EIS. If more than one annotation is available, the '''Select help document''' dialog box (see Figure 2) appears providing the name and type of the available resources. You can use the dialog to choose which resources you wish to display. While using EiffelStudio, pressing '''F1''' while the cursor is in the editor pane will access annotations associated with the Eiffel object that is currently shown in the editor pane. If only one annotation is available, then its resource is automatically opened by EIS. If more than one annotation is available, the '''Select help document''' dialog box (see Figure 2) appears providing the name and type of the available resources. You can use the dialog to choose which resources you wish to display.
@@ -59,4 +64,3 @@ The progress bar in the bottom of the tool indicates the progress of a currently