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

Author:halw

Browse Source 
Date:2009-07-31T23:30:07.000000Z


git-svn-id: https://svn.eiffel.com/eiffel-org/trunk@268 abb3cda0-5349-4a8f-a601-0c33ac3a8c38
This commit is contained in:
halw
2009-07-31 23:30:07 +00:00
parent 8acc8fc8ae
commit ac73102bbf
1 changed files with 11 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -12,7 +12,7 @@ Annotations for outgoing EIS links may be applicable to:
To specify a link between Eiffel and external information, you include such an annotation.
An annotation consists of:
The primary components of an annotation are:
# The '''EIS''' marker.
# The '''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 "web page".
# The '''source'''. This is the location of the external information, for example a URL, or a file name.
@@ -26,16 +26,22 @@ The following example illustrates the form of an EIS annotation written in Eiffe
EIS: "name=Project Requirement", "src=($PROJ)/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. 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.
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. In this example, the file name (src) includes '''$PROJ''', referring to a variable, defining the project location.
The '''name''' property assigns a name to this annotation. The name will be visible in the [[Information Tool]].
Similarly, the following example demonstrates how annotations look like in ECF files:
The '''protocol''' is '''PDF'''.
The '''nameddest''' property (name destination) is a specific property of PDF documents that tells the external tool for PDF documents to open the document at a particular named destination.
The '''tag''' property associates a text tag, in this case "requirement" with this link. Tags show up in the [[Information Tool]] and can be used to group annotations.
The following is an example of an annotation Eiffel configuration (.ecf) file:
<code lang="text">
<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="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].
The one major difference here is the form of the '''EIS marker'''. Here it appears in an XML attribute. '''ise_support="EIS"''' plays the same role as '''EIS:''' does in the <code>note</code> entry example above. '''ise_support''' tells the parser this <code lang="text"><note/></code> element is of interest to Eiffel Software specific tools. The <code lang="text">note</code> element in Eiffel configuration files is supported in ECF schema 1.4.
{{seealso|<br/>