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:
halw
2008-10-11 14:42:58 +00:00
parent 4e7cf603c4
commit c70f07f9a7
10 changed files with 52 additions and 18 deletions

View File

@@ -4,6 +4,7 @@
To find a word or an expression in a text, you can use the [[Search tool|search tool]] . If it is not displayed, you can make it appear by clicking on its icon [[Image:tool-search-icon]] in the tool bar. This tool will allow you to search a word or a regular expression and to replace it if you want to. It can be case sensitive and look for isolated words. To find a word or an expression in a text, you can use the [[Search tool|search tool]] . If it is not displayed, you can make it appear by clicking on its icon [[Image:tool-search-icon]] in the tool bar. This tool will allow you to search a word or a regular expression and to replace it if you want to. It can be case sensitive and look for isolated words.
'''Note''': The [[Search tool|search tool]] will look for the wanted word in the editor or in the context tool, depending on which one has the focus. '''Note''': The [[Search tool|search tool]] will look for the wanted word in the editor or in the context tool, depending on which one has the focus.
{{tip|There are several accelerators that will make it even easier to perform a search. They are detailed in the [[Search functionality|editor help]] . }} {{tip|There are several accelerators that will make it even easier to perform a search. They are detailed in the [[Search functionality|editor help]] . }}

View File

@@ -3,6 +3,8 @@
[[Property:uuid|6ec8ca83-fbe0-e02c-2570-68b5f3931083]] [[Property:uuid|6ec8ca83-fbe0-e02c-2570-68b5f3931083]]
Once you [[Centering tools on a component|centered the editor]] on a class, you have access to its [[Class formatters: Basic text view|basic text]]. If the class is compiled, the [[Feature tool|feature tool]] shows the list of the features that are defined or redefined in this text. You can also view [[Clickable view|clickable]], [[Class formatters: Flat view|flat]], [[Flat Contract view|flat contract]] and [[Contract view|contract]] views of the class in the editor. The class tab in the context tool can display more information. If the [[Centering tools on a component|context tool is independent]], [[Centering tools on a component|center it]] on the wanted class and select this tab. You can then see information about the features ([[Routines|routines]], [[Attributes|attributes]], [[Exported features|exported features,]] [[Class views|etc.]] ..) of the class, its [[Ancestors|ancestors]] and [[Descendants|descendants]] or its [[Clients|clients]] and [[Suppliers|suppliers]] . <br/> Once you [[Centering tools on a component|centered the editor]] on a class, you have access to its [[Class formatters: Basic text view|basic text]]. If the class is compiled, the [[Feature tool|feature tool]] shows the list of the features that are defined or redefined in this text. You can also view [[Clickable view|clickable]], [[Class formatters: Flat view|flat]], [[Flat Contract view|flat contract]] and [[Contract view|contract]] views of the class in the editor. The class tab in the context tool can display more information. If the [[Centering tools on a component|context tool is independent]], [[Centering tools on a component|center it]] on the wanted class and select this tab. You can then see information about the features ([[Routines|routines]], [[Attributes|attributes]], [[Exported features|exported features,]] [[Class views|etc.]] ..) of the class, its [[Ancestors|ancestors]] and [[Descendants|descendants]] or its [[Clients|clients]] and [[Suppliers|suppliers]] . <br/>
The [[Metrics tool|metric tool]] provides another kind of data. It allows you to compute a complete set of [[How to analyze a project|measures]] on your class. The [[Metrics tool|metric tool]] provides another kind of data. It allows you to compute a complete set of [[How to analyze a project|measures]] on your class.
{{seealso|<br/> {{seealso|<br/>
[[Looking for a class|Looking for a class]] }} [[Looking for a class|Looking for a class]] }}

View File

@@ -2,6 +2,8 @@
[[Property:weight|1]] [[Property:weight|1]]
[[Property:uuid|daff6cb5-89bd-4281-4c1e-cf031391a34b]] [[Property:uuid|daff6cb5-89bd-4281-4c1e-cf031391a34b]]
To view information about a cluster, you have to center the context tool on this component. Then the [[Metrics tool|metric tool]] will provide a complete set of measures that you will able to compute. To view information about a cluster, you have to center the context tool on this component. Then the [[Metrics tool|metric tool]] will provide a complete set of measures that you will able to compute.
{{seealso| '''See Also''' <br/> {{seealso| '''See Also''' <br/>
[[Looking for a cluster|Looking for a cluster]] <br/> [[Looking for a cluster|Looking for a cluster]] <br/>
[[How to analyze a project]] }} [[How to analyze a project]] }}

View File

@@ -3,6 +3,8 @@
[[Property:uuid|0151eab9-ee25-210a-bed9-b2709e9fa5f0]] [[Property:uuid|0151eab9-ee25-210a-bed9-b2709e9fa5f0]]
Once you [[Centering tools on a component|centered the editor]] on a feature, you have access to its text. The feature tab in the context tool can display more information. To have access to it, you have first to center the context tool on the wanted class and select the feature tab. You can then consult the different views of the text of the feature ([[Feature formatters: Basic text view|basic text]] or [[Feature formatters: Flat view|flat]]) and other information such as its [[Callers|callers]] or its [[Descendant versions|descendant]] versions. <br/> Once you [[Centering tools on a component|centered the editor]] on a feature, you have access to its text. The feature tab in the context tool can display more information. To have access to it, you have first to center the context tool on the wanted class and select the feature tab. You can then consult the different views of the text of the feature ([[Feature formatters: Basic text view|basic text]] or [[Feature formatters: Flat view|flat]]) and other information such as its [[Callers|callers]] or its [[Descendant versions|descendant]] versions. <br/>
The [[Metrics tool|metric tool]] provides another kind of data. It enables you to compute some [[How to analyze a project|measures]] on your feature. The [[Metrics tool|metric tool]] provides another kind of data. It enables you to compute some [[How to analyze a project|measures]] on your feature.
{{seealso|<br/> {{seealso|<br/>
[[Looking for a feature|Looking for a feature]] }} [[Looking for a feature|Looking for a feature]] }}

View File

@@ -1,16 +1,27 @@
[[Property:title|Adding a class]] [[Property:title|Adding a class]]
[[Property:weight|2]] [[Property:weight|2]]
[[Property:uuid|592f9c3a-4533-d849-a0d7-5c00864e5c26]] [[Property:uuid|592f9c3a-4533-d849-a0d7-5c00864e5c26]]
A dialog window is dedicated to the creation of new classes. <br/> A dialog window is dedicated to the creation of new classes.
[[Image:new-class-dialog]] <br/>
[[Image:new-class-dialog]]
A list of all the clusters of the system lets you to choose in which one the new class will be inserted. The name of the new class and the name of the corresponding file can be set thank to two text fields above the list. It is also possible to define whether the class should be deferred or expanded, what its creation feature is (if any), what its parents are and whether the default feature clauses should be generated. A list of all the clusters of the system lets you to choose in which one the new class will be inserted. The name of the new class and the name of the corresponding file can be set thank to two text fields above the list. It is also possible to define whether the class should be deferred or expanded, what its creation feature is (if any), what its parents are and whether the default feature clauses should be generated.
{{tip|You can change the class text that is generated by default by editing the following files:$ISE_EIFFEL\studio\help\defaults\$ISE_PLATFORM\full.cls (with default feature clauses) and ...\empty.cls (without default feature clauses). }}<br/>
{{tip|You can change the class text that is generated by default by editing the following files: <br/><br/>
$ISE_EIFFEL\studio\help\defaults\$ISE_PLATFORM\full.cls (with default feature clauses) and <br/><br/>
$ISE_EIFFEL\studio\help\defaults\$ISE_PLATFORM\empty.cls (without default feature clauses). }}
To make the window appear, you can: To make the window appear, you can:
* Click [[Image:16x16--new-class-icon]] in the [[Main toolbars|standard toolbar]] . * Click [[Image:16x16--new-class-icon]] in the [[Main toolbars|standard toolbar]] .
* Select '''New class''' in the '''Tools''' menu. * Select '''New class''' in the '''Tools''' menu.
* Type the name of the new class in the class field of the [[Main address bar|main address bar]] or the [[Context tool address bar|context tool address bar]] . The current cluster will then be preselected. * Type the name of the new class in the class field of the [[Main address bar|main address bar]] or the [[Context tool address bar|context tool address bar]] . The current cluster will then be preselected.
* Use the [[Diagram tool: Introduction|diagram tool]] : Pick the icon [[Image:16x16--new-class-icon]] and drop it on the diagram in the right cluster. This will make the dialog window appear with the chosen cluster selected. * Use the [[Diagram tool: Introduction|diagram tool]] : Pick the icon [[Image:16x16--new-class-icon]] and drop it on the diagram in the right cluster. This will make the dialog window appear with the chosen cluster selected.
{{seealso|<br/> {{seealso|<br/>
[[Removing a class|Removing a class]] }} [[Removing a class|Removing a class]] }}

View File

@@ -2,8 +2,11 @@
[[Property:weight|0]] [[Property:weight|0]]
[[Property:uuid|76a118a9-270e-fbc4-567d-e2ce031585d4]] [[Property:uuid|76a118a9-270e-fbc4-567d-e2ce031585d4]]
It is possible to create new clusters from EiffelStudio. A dialog window has been designed to help you do so. It is possible to create new clusters from EiffelStudio. A dialog window has been designed to help you do so.
[[Image:new-cluster-dialog]] [[Image:new-cluster-dialog]]
There are three ways to make this window appear. You can: There are three ways to make this window appear. You can:
* Click [[Image:16x16--new-cluster-icon]] in the [[Main toolbars|standard toolbar]] . * Click [[Image:16x16--new-cluster-icon]] in the [[Main toolbars|standard toolbar]] .
* Click [[Image:new-cluster-icon]] in the [[Cluster tool|cluster tool]] . * Click [[Image:new-cluster-icon]] in the [[Cluster tool|cluster tool]] .
@@ -15,6 +18,7 @@ If you want to create a subcluster, give it a name and select its parent in the
To import an existing cluster, you can also go to the '''Groups''' section in the [[Group Options|Project Settings dialog]] and click '''Add cluster'''. Although this solution may be slightly more tedious, it gives access to more options. To import an existing cluster, you can also go to the '''Groups''' section in the [[Group Options|Project Settings dialog]] and click '''Add cluster'''. Although this solution may be slightly more tedious, it gives access to more options.
{{seealso|<br/> {{seealso|<br/>
[[Removing a cluster|Removing a cluster]] }} [[Removing a cluster|Removing a cluster]] }}

View File

@@ -7,6 +7,7 @@ This dialog also allows you to select which target to compile and you can also s
'''Reset user settings''' removes all stored custom information about the project (but not the configuration of the project itself). For example last used target, locations where this project has been compiled, arguments and working directory. '''Reset user settings''' removes all stored custom information about the project (but not the configuration of the project itself). For example last used target, locations where this project has been compiled, arguments and working directory.
{{seealso|<br/> {{seealso|<br/>
[[EiffelStudio: Creating a new project|Creating a new project]] }} [[EiffelStudio: Creating a new project|Creating a new project]] }}

View File

@@ -1,15 +1,21 @@
[[Property:title|Eiffel Scheme Syntax]] [[Property:title|Eiffel Scheme Syntax]]
[[Property:weight|0]] [[Property:weight|0]]
[[Property:uuid|503b260c-99c5-06fb-2953-8899866c1c51]] [[Property:uuid|503b260c-99c5-06fb-2953-8899866c1c51]]
<code>'''eiffel:?<''eiffel-resource''>'''</code> The Eiffel scheme syntax is:
<code lang="text">
eiffel:?<eiffel-resource>
</code>
<''eiffel-resource''> is a combination of following parts, connected by '''&''' if more than one part are required: where <eiffel-resource> is a combination of following parts, connected by '''&''' if more than one part are required:
* <''systeme''>, in the form of system=to_be_replaced, '''to_be_replaced''' consists of system_name or uuid of the system, or both connected by "'''.'''".
* <''targete''>, in the form of target=to_be_replaced, '''to_be_replaced''' consists of target_name or uuid of the system, or both connected by "'''.'''". * <system>, in the form of system=to_be_replaced, '''to_be_replaced''' consists of system_name or uuid of the system, or both connected by "'''.'''".
* <''clustere''>, in the form of cluster=to_be_replaced, '''to_be_replaced''' is the name of the cluster. * <target>, in the form of target=to_be_replaced, '''to_be_replaced''' consists of target_name or uuid of the system, or both connected by "'''.'''".
* <''classe''>, in the form of class=to_be_replaced, '''to_be_replaced''' is the name of the class. * <cluster>, in the form of cluster=to_be_replaced, '''to_be_replaced''' is the name of the cluster.
* <''featuree''>, in the form of feature=to_be_replaced, '''to_be_replaced''' is the name of the feature. * <class>, in the form of class=to_be_replaced, '''to_be_replaced''' is the name of the class.
* <feature>, in the form of feature=to_be_replaced, '''to_be_replaced''' is the name of the feature.
{{note|All parts above are unordered. }} {{note|All parts above are unordered. }}

View File

@@ -20,16 +20,25 @@ However the following parts are suggested:
==Syntax for Annotations== ==Syntax for Annotations==
The following example illustrates the basic form of an EIS note entry: 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. 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]] }} Similarly, the following example demonstrates how annotations look like in ECF files:
<code><note ise_support="EIS" protocol="pdf" name="Project Requirement" src="($PROJ)/docs/requirements.pdf" nameddest="4.1"/></code>
<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]. 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]] }}

View File

@@ -1,9 +1,5 @@
[[Property:title|Information Tool]] [[Property:title|Information Tool]]
[[Property:weight|0]] [[Property:weight|0]]
[[Property:uuid|26e2c799-b48a-c588-cdf1-dd47b1994b09]] [[Property:uuid|26e2c799-b48a-c588-cdf1-dd47b1994b09]]
* [[Browsing Information|Browsing Annotations]]
* [[Annotation Management|Annotation Management]]