Eiffel Information System - Revision history

Ted: /* Change analysis */

2013-04-04T10:29:04Z

‎Change analysis

Ted at 09:55, 4 April 2013

2013-04-04T09:55:05Z

Ted: /* EiffelStudio Action Protocol (Incoming Implementation) */

2013-04-04T09:21:33Z

‎EiffelStudio Action Protocol (Incoming Implementation)

Pgcrism: /* Syntax for Annotations */

2013-03-07T08:02:19Z

‎Syntax for Annotations

Ted: /* Syntax for Annotations */

2012-06-26T04:30:50Z

‎Syntax for Annotations

Ted: /* Variables */

2012-05-07T11:16:35Z

‎Variables

Ted: /* Protocol */

2012-05-07T11:15:19Z

‎Protocol

Ted: /* Variables */

2012-05-07T11:13:43Z

‎Variables

Ted: /* Protocol */

2012-05-07T09:21:05Z

‎Protocol

Manus: Remove usage of

2009-08-03T15:04:01Z

Remove usage of <br>

@@ Line 162: / Line 162: @@
 == Change analysis ==
-Within EiffelStudio 7.3, there will be new functions in Infomation tool to track changes on target or external resouce side, and potentially affected items either side are listed.
+Within EiffelStudio 7.3, there will be new functions in Infomation tool to track changes on target or external resouce side, and potentially affected items on either side are listed.
 * New functions are:
 ** List of elements of current system that would be affected by external resource changes. (The first version limits the external resource to local files.)
@@ Line 168: / Line 168: @@
 ** Change acknowledgement.
-Typical work flow:
+Typical work flow to demo affected external resources caused by current system change:
+# Open a class, add an Information entry with an external source in the class.
 [[Image:Information_Tool_change_analysis.PNG]]

← Older revision		Revision as of 09:55, 4 April 2013
Line 160:		Line 160:

	The protocol is loaded through [https://svn.origo.ethz.ch/eiffelstudio/trunk/Src/framework/command_tunnel Command Tunnel Library]. This library is now only implemented on Windows.		The protocol is loaded through [https://svn.origo.ethz.ch/eiffelstudio/trunk/Src/framework/command_tunnel Command Tunnel Library]. This library is now only implemented on Windows.
		+
		+	== Change analysis ==
		+	Within EiffelStudio 7.3, there will be new functions in Infomation tool to track changes on target or external resouce side, and potentially affected items either side are listed.
		+	* New functions are:
		+	** List of elements of current system that would be affected by external resource changes. (The first version limits the external resource to local files.)
		+	** List of external resources that might be affected by changes of current system. (No limit of the type of external resources)
		+	** Change acknowledgement.
		+
		+	Typical work flow:
		+	*
		+
		+	[[Image:Information_Tool_change_analysis.PNG]]

@@ Line 138: / Line 138: @@
 ***** (Default) = "%ISE_EIFFEL%\studio\spec\windows\bin\estudio.exe" /ec_action eisi:"%1"
-=== EiffelStudio Action Protocol (Incoming Implementation) ===
+=== EiffelStudio Action Protocol ===
-{{red|(immature and incomplete)}} <br>
 EiffelStudio uses estudio.exe to interact with all existing instances of ec.exe. The protocol is used for this goal.
 The action protocol can be used for those tools that want to control running EiffelStudio instances. For the moment, this is completely transparent to end users because of its immaturity.

@@ Line 75: / Line 75: @@
    <e>EIS: "name=Project Requirement", "src=$(SYSTEM_PATH)/docs/requirements.pdf", "protocol=PDF", "nameddest=4.1", "tag=requirement"</e>
-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 — set at any of the above 5 levels, rather than the second one "Context related built in variables" — 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 part of the requirements document.
+The label (Note_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 — set at any of the above 5 levels, rather than the second one "Context related built in variables" — 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 part of the requirements document.
 Similarly, the following example demonstrates how annotations look like in ECF files:

@@ Line 73: / Line 73: @@
 The following example illustrates the basic form of an EIS note entry:
-   <e>EIS: "name=Project Requirement", "src=$(PROJ)/docs/requirements.pdf", "protocol=PDF", "nameddest=4.1", "tag=requirement"</e>
+   <e>EIS: "name=Project Requirement", "src=$(SYSTEM_PATH)/docs/requirements.pdf", "protocol=PDF", "nameddest=4.1", "tag=requirement"</e>
 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 — set at any of the above 5 levels, rather than the second one "Context related built in variables" — 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 part of the requirements document.

@@ Line 46: / Line 46: @@
 ** ISE_DOC_UUID	= http://doc.eiffel.com/isedoc/uuid
 ** ISE_DOC_REF = http://doc.eiffel.com/isedoc/eis
-** SYSTEM_PATH, the written location of current entry
+** SYSTEM_PATH, the path of the system in which current entry is written
 * Context related built in variables. These variables can be used in a specific context. For instance, '''feature_name''' refers to the name of the feature in which the annotation is written.
 ** feature_name

@@ Line 63: / Line 63: @@
 * URI: This protocol does not need to specified. By default, it will be taken if nothing is specified or unknown protocol is specified.
-* PDF: PDF protocol supports three attributes for now. "type" "page" and "nameddest". (Windows only)
+* PDF: PDF protocol supports three parameters for now. "type" "page" and "nameddest". (Windows only)
 ** type: "file" is used to open PDF files in the PDF reader. Otherwise it opens in a browser.
 ** page: Specify the page number to navigate to.
 ** nameddest: Specify the named destination to navigate to.
-* DOC: Microsoft Word document. (Not implemented)
+* DOC: Microsoft Word document. "bookmark" parameter is supported (Windows Only)
 === Syntax for Annotations ===

@@ Line 100: / Line 100: @@
 The tool is an output of the EIS outgoing mechanism. Through the tool, users can graphically manage all EIS information in current system. See [[Information (EIS) Tool]] for more information.
-There is a screen shot of the tool.<br>
+There is a screen shot of the tool.
 [[Image:Information_(EIS)_Tool.PNG]]