Author:halw

Date:2009-07-20T22:55:00.000000Z


git-svn-id: https://svn.eiffel.com/eiffel-org/trunk@254 abb3cda0-5349-4a8f-a601-0c33ac3a8c38

documentation/current/eiffelstudio/eiffelstudio-reference/eiffel-information-system/eis-outgoing/index.wiki

@@ -4,8 +4,8 @@
 ==Annotations==
 
 Annotations may be applicable to:
-*  An individual class or feature. In this case the annotation figures in the class text, as part of an Eiffel <code>note</code> clause (<code>indexing</code> is still supported, it depends on which syntax level users choose).
-*  A target, library or cluster. In this case the annotation figures in the associated ECF file; EiffelStudio provides support for entering it through a Information (EIS) Tool. 
+*  An individual class or feature. In this case the annotation appears in the class text, as part of an Eiffel <code>note</code> clause (the obsolete keyword <code>indexing</code> may still be supported, depending upon which syntax level is chosen in project preferences).
+*  A target, library or cluster. In this case the annotation appears in the associated ECF file; EiffelStudio provides support for entering it through a Information (EIS) Tool. 
 {{seealso|<br/>
 [[Information Tool|Information Tool]]  }}
 
@@ -14,7 +14,7 @@ The basic way to specify a dependency is to include such an annotation. The requ
 *  The "EIS" marker
 
 However the following parts are suggested:
-*  The "protocol", indicating the type of external information, and making it possible for EIS to determine the associated external tool. Without the "protocol" part, the source defaults to be web page.
+*  The "protocol", indicating the type of external information, and making it possible for EIS to determine the associated external tool. If the "protocol" part is omitted, the source defaults to be web page.
 *  The source, identification of where to find information itself, for example a URL, or a file name. 
 
 ==Syntax for Annotations==
@@ -24,7 +24,7 @@ The following example illustrates the basic form of an EIS note entry:
 EIS: "name=Project Requirement", "src=($PROJ)/docs/requirements.pdf", "protocol=PDF", "nameddest=4.1", "tag=requirement"
 </code>
 
-The label (Node_entry as called in the ECMA/ISO Eiffel Standard syntax) is '''EIS'''. '''EIS''' Note_value tells the Eiffel Information System that this Note_entry is of interest to EIS, as distinct from any other information that might be expressed through a Note_entry. The file name (src) includes '''$PROJ''', referring to a variable, defining the project location. The protocol is PDF. The '''nameddest''' property (name destination) is a specific property of PDF documents. The tag '''requirement''' indicating that this entry links the enclosing Eiffel class or feature with some parts of the requirement documents.
+The label (or Note_name as it is called in the ECMA/ISO Eiffel Standard syntax) is '''EIS:'''. The '''EIS:''' Note_name tells the Eiffel Information System that this Note_entry is of interest to EIS, as distinct from any other information that might be expressed through a Note_entry. In this example, the file name (src) includes '''$PROJ''', referring to a variable, defining the project location. The protocol is PDF. The '''nameddest''' property (name destination) is a specific property of PDF documents. The tag '''requirement''' indicating that this entry links the enclosing Eiffel class or feature with some parts of the requirement documents.
 
 
 Similarly, the following example demonstrates how annotations look like in ECF files: 
@@ -33,7 +33,7 @@ Similarly, the following example demonstrates how annotations look like in ECF f
 <note ise_support="EIS" protocol="pdf" name="Project Requirement" src="($PROJ)/docs/requirements.pdf" nameddest="4.1"/></code>
 
 
-There is only one major difference here - the attribute '''ise_support'''. '''ise_support''' takes place of label of Node_entry. '''EIS''' plays the same role as the one appears in note entry. '''ise_support''' tells the parser the note element is of interest of tools from ISE rather than other third-party ones. The note element in ECF is supported in [schema 1.4].
+There is only one major difference here - the attribute '''ise_support'''. '''ise_support="EIS"''' takes place of Note_name '''EIS:'''. '''EIS''' plays the same role as it does in a <code>note</code> entry. '''ise_support''' tells the parser this note element is of interest to tools from ISE rather than other third-party ones. The note element in ECF is supported in [schema 1.4].
 
 
 {{seealso|<br/>

documentation/current/eiffelstudio/eiffelstudio-reference/eiffel-information-system/eis-outgoing/information-tool/annotation-management.wiki

@@ -1,18 +1,19 @@
 [[Property:title|Annotation Management]]
 [[Property:weight|1]]
 [[Property:uuid|696457ef-ac1f-40c1-a0da-54900d9cccf8]]
-Information Tool provides information management functions: adding, modifying and removing. 
+The Information Tool provides information management functions: adding, modifying and removing. 
+
 {{note|Annotation management is only available in lists coresponding to nodes rather than tag nodes - all tags and "Items without tag". }}
 
 ==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. One could modify the new entry into what he wants. See the following section '''Modifying'''.
+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.  
 
 ==Modifying==
 
-To modify an annotation, one can use Information Tool or do it by code.
-*  By Information Tool, a line in the annotation list should be selected, 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 recommented). 
+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]]  }}
 

documentation/current/eiffelstudio/eiffelstudio-reference/eiffel-information-system/eis-outgoing/information-tool/variable-definition.wiki

@@ -12,9 +12,9 @@ EIS supports following types of variables which can be used in '''Source''' of a
 **  group_name 
 **  target_name 
 
-{{note|This kind of variables can only be used in components that are enclosed in those the variable name refers to. For example, '''feature_name''' has no effect if used in a target component.}}
+{{note|This kind of variable can only be used in a component that is enclosed in a component to which the variable name refers. For example, '''feature_name''' has no effect if used in a target component.}}
 
-*  Individual system or library preferences. This kind of variables are defined in .ecf files, can be accessed via Project Setting dialog by following a path such as:
+*  Individual system or library preferences. This kind of variable is defined in .ecf files, can be accessed via Project Setting dialog by following a path such as:
 <code lang="text">
 	System -> Target -> Advanced -> Variables
 </code>