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

Update for v7.1

Browse Source 
Author:halw
Date:2012-06-26T01:39:14.000000Z


git-svn-id: https://svn.eiffel.com/eiffel-org/trunk@1108 abb3cda0-5349-4a8f-a601-0c33ac3a8c38
This commit is contained in:
halw
2012-06-26 01:39:14 +00:00
parent 1cab635e6c
commit fb062c0dca
1 changed files with 4 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -13,7 +13,7 @@ To specify a link between Eiffel and external information, you include such an a
The primary components of an annotation are:
# The '''EIS''' marker.
# The '''[[Protocols|protocol]]''', which indicates the type of external information, and making it possible for EIS to determine the associated external tool. If the '''protocol''' is omitted, its value defaults to "Raw URL".
# The '''[[Protocols|protocol]]''', which indicates the type of external information, and making it possible for EIS to determine the associated external tool. If the '''protocol''' is omitted, its value defaults to "URI".
# The '''source'''. This is the location of the external information, for example a URL, or a file name.
==Syntax for Annotations==
@@ -26,14 +26,14 @@ Additionally, a special type of annotation called an '''Automatic annotation'''
The following example illustrates the form of an EIS annotation written in Eiffel source code. The annotation appears in the <code>note</code> part of a class or feature definition:
<code lang="text">
EIS: "name=Project Requirement", "src=$(PROJ)/docs/requirements.pdf", "protocol=PDF", "nameddest=4.1", "tag=requirement"
EIS: "name=Project Requirement", "src=$(system_path)/docs/requirements.pdf", "protocol=PDF", "nameddest=4.1", "tag=requirement"
</code>
The '''EIS marker''' is the label '''EIS:''' (this label is called the ''Note_name'' in the ISO/ECMA Eiffel Standard syntax). The '''EIS marker''' tells the Eiffel Information System that this particular ''Note_entry'' is of interest to EIS.
The '''name''' property assigns a name to this annotation. The name will be visible in the [[Information Tool]].
In this example, the '''source''' name (src) includes the string '''$(PROJ)''', a reference to a [[Variable Definition|variable]], '''PROJ''', which the user has defined for the the project location.
In this example, the '''source''' name (src) includes the string '''$(system_path)''', a reference to a [[Variable Definition|variable]], '''system_path''', which is a predefined variable for the the project location.
The '''protocol''' is '''PDF'''.
@@ -45,7 +45,7 @@ The following is an example of an annotation Eiffel configuration (.ecf) file:
<code lang="text">
<note>
<EIS protocol="pdf" name="Project Requirement" src="$(PROJ)/docs/requirements.pdf" nameddest="4.1"/>
<EIS protocol="pdf" name="Project Requirement" src="$(system_path)/docs/requirements.pdf" nameddest="4.1"/>
</note>
</code>
@@ -57,4 +57,3 @@ Eiffel configuration files have XML definitions, so this is just an XML version