mirror of
https://github.com/EiffelSoftware/eiffel-org.git
synced 2026-04-05 09:39:31 +02:00
Author:halw
Date:2008-10-11T14:42:58.000000Z git-svn-id: https://svn.eiffel.com/eiffel-org/trunk@77 abb3cda0-5349-4a8f-a601-0c33ac3a8c38
This commit is contained in:
@@ -20,16 +20,25 @@ However the following parts are suggested:
|
||||
==Syntax for Annotations==
|
||||
|
||||
The following example illustrates the basic form of an EIS note entry:
|
||||
<code>EIS: "name=Project Requirement", "src=($PROJ)/docs/requirements.pdf", "protocol=PDF", "nameddest=4.1", "tag=requirement"</code>
|
||||
<code lang="text">
|
||||
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.
|
||||
|
||||
{{seealso|<br/>
|
||||
[[Variable Definition|Variable Definition]] }}
|
||||
<code><note ise_support="EIS" protocol="pdf" name="Project Requirement" src="($PROJ)/docs/requirements.pdf" nameddest="4.1"/></code>
|
||||
|
||||
Similarly, the following example demonstrates how annotations look like in ECF files:
|
||||
|
||||
<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''' 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].
|
||||
|
||||
|
||||
{{seealso|<br/>
|
||||
[[Variable Definition|Variable Definition]] }}
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,9 +1,5 @@
|
||||
[[Property:title|Information Tool]]
|
||||
[[Property:weight|0]]
|
||||
[[Property:uuid|26e2c799-b48a-c588-cdf1-dd47b1994b09]]
|
||||
* [[Browsing Information|Browsing Annotations]]
|
||||
* [[Annotation Management|Annotation Management]]
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user