diff --git a/documentation/current/eiffelstudio/_images/edit_automatic_eis_entry_dialog.png b/documentation/current/eiffelstudio/_images/edit_automatic_eis_entry_dialog.png new file mode 100644 index 00000000..63446acd Binary files /dev/null and b/documentation/current/eiffelstudio/_images/edit_automatic_eis_entry_dialog.png differ diff --git a/documentation/current/eiffelstudio/_images/edit_automatic_eis_entry_dialog.png.data b/documentation/current/eiffelstudio/_images/edit_automatic_eis_entry_dialog.png.data new file mode 100644 index 00000000..a73c6db5 --- /dev/null +++ b/documentation/current/eiffelstudio/_images/edit_automatic_eis_entry_dialog.png.data @@ -0,0 +1,3 @@ +title=edit automatic eis entry dialog +author=halw +path=content/edit-automatic-eis-entry-dialog diff --git a/documentation/current/eiffelstudio/_images/groups-tool_1.png b/documentation/current/eiffelstudio/_images/groups-tool_1.png new file mode 100644 index 00000000..3f8a7d07 Binary files /dev/null and b/documentation/current/eiffelstudio/_images/groups-tool_1.png differ diff --git a/documentation/current/eiffelstudio/_images/groups-tool_1.png.data b/documentation/current/eiffelstudio/_images/groups-tool_1.png.data new file mode 100644 index 00000000..9030165e --- /dev/null +++ b/documentation/current/eiffelstudio/_images/groups-tool_1.png.data @@ -0,0 +1,3 @@ +title=groups-tool +author=halw +path=content/groups-tool diff --git a/documentation/current/eiffelstudio/eiffelstudio-reference/browsing-tools/groups-tool/index.wiki b/documentation/current/eiffelstudio/eiffelstudio-reference/browsing-tools/groups-tool/index.wiki index f70e0bd3..b6839338 100644 --- a/documentation/current/eiffelstudio/eiffelstudio-reference/browsing-tools/groups-tool/index.wiki +++ b/documentation/current/eiffelstudio/eiffelstudio-reference/browsing-tools/groups-tool/index.wiki @@ -3,7 +3,7 @@ [[Property:uuid|0baebaa5-a9c8-4c7c-6ace-c11d82804906]] [[Image:tool-clusters-icon]] -[[Image:cluster-tool]] +[[Image:groups-tool]] The groups tool gives a [[System tree representation|tree representation]] of all clusters, libraries and classes of the project. The toolbar contains a [[New cluster command|new cluster command]] , a [[New class command|new class command]] , and the [[Locate command|locate command]] . diff --git a/documentation/current/eiffelstudio/eiffelstudio-reference/eiffel-information-system/eis-outgoing/index.wiki b/documentation/current/eiffelstudio/eiffelstudio-reference/eiffel-information-system/eis-outgoing/index.wiki index a752aa7c..cbb2ac64 100644 --- a/documentation/current/eiffelstudio/eiffelstudio-reference/eiffel-information-system/eis-outgoing/index.wiki +++ b/documentation/current/eiffelstudio/eiffelstudio-reference/eiffel-information-system/eis-outgoing/index.wiki @@ -5,10 +5,7 @@ Annotations for outgoing EIS links may be applicable to: * An individual class or feature. In this case the annotation appears in the class text, as part of an Eiffel note clause (the obsolete keyword indexing may still be supported, depending upon which syntax level is chosen in project preferences). -* A target, library or cluster. In this case the annotation appears in the associated ECF file; EiffelStudio provides support for entering it through a Information (EIS) Tool. -{{seealso|
-[[Information Tool|Information Tool]] }} - +* A target, library or cluster. In this case the annotation appears in the associated ECF file; EiffelStudio provides support for entering it through the [[Information Tool|Information Tool]]. To specify a link between Eiffel and external information, you include such an annotation. @@ -21,15 +18,21 @@ The primary components of an annotation are: Annotations can occur in Eiffel source code and in project configuration files (.ecf). The format of the '''EIS marker''' varies depending upon the context in which it is used. The rest of the annotation format is the same in both contexts. +Individual annotations can be placed in Eiffel files either through the [[Information Tool]] or by manual editing of the files. + +Additionally, a special type of annotation called an '''Automatic annotation''' can be specified for Eiffel configuration [[general target options|targets]]. An automatic annotation on a target will put an implicit annotation with a variable source on each class in the target. An implicit annotation on any particular class can be overridden by an explicitly coded annotation, when necessary. + The following example illustrates the form of an EIS annotation written in Eiffel source code. The annotation appears in the note part of a class or feature definition: -EIS: "name=Project Requirement", "src=($PROJ)/docs/requirements.pdf", "protocol=PDF", "nameddest=4.1", "tag=requirement" +EIS: "name=Project Requirement", "src=$(PROJ)/docs/requirements.pdf", "protocol=PDF", "nameddest=4.1", "tag=requirement" -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 '''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. + 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. @@ -39,9 +42,12 @@ The '''tag''' property associates a text tag, in this case "requirement" with th The following is an example of an annotation Eiffel configuration (.ecf) file: - + + + + -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 note entry example above. '''ise_support''' tells the parser this element is of interest to Eiffel Software specific tools. The note element in Eiffel configuration files is supported in ECF schema version 1.4. +Eiffel configuration files have XML definitions, so this is just an XML version of what was coded into an Eiffel class above. The annotation appears in a element. The '''''' element plays role of '''EIS marker''', just as '''EIS:''' does in the note entry in the source code example above. The '''''' element in Eiffel configuration files is supported in ECF schema version 1.4 and later. {{seealso|
diff --git a/documentation/current/eiffelstudio/eiffelstudio-reference/eiffel-information-system/eis-outgoing/information-tool/annotation-management.wiki b/documentation/current/eiffelstudio/eiffelstudio-reference/eiffel-information-system/eis-outgoing/information-tool/annotation-management.wiki index ae683578..3050418d 100644 --- a/documentation/current/eiffelstudio/eiffelstudio-reference/eiffel-information-system/eis-outgoing/information-tool/annotation-management.wiki +++ b/documentation/current/eiffelstudio/eiffelstudio-reference/eiffel-information-system/eis-outgoing/information-tool/annotation-management.wiki @@ -23,8 +23,25 @@ By pressing '''Delete''', or clicking the ''delete'' button [[Image:16x16--gener {{note|Multiple entries in the annotation list can be deleted by selecting them all prior to clicking ''delete''. }} +==Enabling and disabling automatic annotation entries== + +Automatic annotations can be enabled for a particular project target. Once enabled, each class in the target will exhibit an implicit annotation with a particular source. You can define the source at the same time you enable automatic annotations for a target. + +To enable automatic annotations, select the desired target in the information tree. When you do this, the button on the bottom toolbar with the automatic annotation [[Image:automatic annotation icon]] icon becomes enabled. Click this button and you will see the '''Edit Automatic EIS Entry'' dialog box as in Figure 1. + + +[[Image:edit automatic eis entry dialog]] + +Figure 1. The Edit Automatic EIS Entry dialog + + +You enable automatic annotations by checking the box labeled '''Enable Auto-Entry'''. You construct an appropriate source from explicit strings and/or variable names in the are labeled '''Source'''. + +You can disable automatic annotation entries on a target by invoking the Edit Automatic EIS Entry dialog box and un-checking the '''Enable Auto-Entry''' checkbox. + + +{{note|Most changes made to annotations via the Information Tool are irreversible. However, changes made to annotations on a class or feature which is currently open in the Editor Pane may be reversed by using the editor's '''Undo''' command. The '''undo''' feature should be used with caution as the '''undo''' does not function in some early EIS versions.}} -{{note| All means to manage annotations via the tool are inreversible, except that the location - class or feature - has been opened in the editor, thus undo can be achieved via the editor. Removing is prompted on user demands. The tag tree is automatically updated when annotations are added/modified/removed or through system sweeping. }} diff --git a/documentation/current/eiffelstudio/eiffelstudio-reference/eiffel-information-system/eis-outgoing/information-tool/browsing-information.wiki b/documentation/current/eiffelstudio/eiffelstudio-reference/eiffel-information-system/eis-outgoing/information-tool/browsing-information.wiki index 472a21fb..602a6818 100644 --- a/documentation/current/eiffelstudio/eiffelstudio-reference/eiffel-information-system/eis-outgoing/information-tool/browsing-information.wiki +++ b/documentation/current/eiffelstudio/eiffelstudio-reference/eiffel-information-system/eis-outgoing/information-tool/browsing-information.wiki @@ -28,7 +28,7 @@ The following columns are available in the list: * '''[[Protocols|Protocol]]''' - the type of the Source. * '''Source''' - the address of the resource, typically a URL or file path. Variables can be used. * '''Tags''' - terms or phrases used to categorize annotations. Tags are separated by '''","''' -* '''Override''' - +* '''Override''' - checkbox is checked if an implicit, automatically generated annotation is being overridden by the annotation in this list entry. If this list entry is itself an implicit annotation, this column shows the automatic annotation [[Image: automatic annotation icon]] icon. Override is defined only for annotations on classes. * '''Others''' - other related attributes. Attributes are separated by '''","''' {{note|EIS ignores any attributes in '''Others''' which are not used by the '''protocol'''. }} diff --git a/documentation/current/eiffelstudio/eiffelstudio-reference/eiffel-information-system/eis-outgoing/information-tool/protocols.wiki b/documentation/current/eiffelstudio/eiffelstudio-reference/eiffel-information-system/eis-outgoing/information-tool/protocols.wiki index 9dc03d8a..fcceff75 100644 --- a/documentation/current/eiffelstudio/eiffelstudio-reference/eiffel-information-system/eis-outgoing/information-tool/protocols.wiki +++ b/documentation/current/eiffelstudio/eiffelstudio-reference/eiffel-information-system/eis-outgoing/information-tool/protocols.wiki @@ -1,15 +1,15 @@ [[Property:title|Protocols]] [[Property:weight|2]] [[Property:uuid|69b4d9d4-570e-e7ac-087b-88449a608d0b]] -EIS supports following protocols now: +EIS supports following protocols: * Raw URL: 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) -** type: "file" is used to open PDF files in PDF reader. Otherwise in a browser. -** page: Specify the page number to navigate to. -** nameddest: Specify the named destination to navigate to. - - +* PDF: PDF protocol supports three attributes: "type" "page" and "nameddest". (Windows only) +** '''type''' - "file" is used to open PDF files in PDF reader. Otherwise in a browser. +** '''page''' - a page number at which to open a document. +** '''nameddest''' - a named destination at which to open a document. + +{{note|The status of supported protocols described above is as of EiffelStudio version 6.4. }} diff --git a/documentation/current/eiffelstudio/eiffelstudio-reference/eiffel-information-system/eis-outgoing/information-tool/variable-definition.wiki b/documentation/current/eiffelstudio/eiffelstudio-reference/eiffel-information-system/eis-outgoing/information-tool/variable-definition.wiki index d8daf89e..2e02aec6 100644 --- a/documentation/current/eiffelstudio/eiffelstudio-reference/eiffel-information-system/eis-outgoing/information-tool/variable-definition.wiki +++ b/documentation/current/eiffelstudio/eiffelstudio-reference/eiffel-information-system/eis-outgoing/information-tool/variable-definition.wiki @@ -12,9 +12,9 @@ EIS supports following types of variables which can be used in '''Source''' of a ** group_name ** target_name -{{note|This kind of variable can only be used in a component that is enclosed in a component to which the variable name refers. For example, '''feature_name''' has no effect if used in a target component.}} +{{note|This kind of variable is only valid in a annotation that is associated with a component to which the variable name refers. For example, '''feature_name''' has no effect if used in a '''target''' component.}} -* Individual system or library preferences. This kind of variable is defined in .ecf files, can be accessed via Project Setting dialog by following a path such as: +* Individual system or library preferences. This kind of variable is defined in your Project Settings. Manage these variables by following this path in the System tree on the left of the Project Setting dialog: System -> Target -> Advanced -> Variables diff --git a/documentation/current/eiffelstudio/eiffelstudio-reference/eiffelstudio-editor/automatic-completion/class-name-auto-complete.wiki b/documentation/current/eiffelstudio/eiffelstudio-reference/eiffelstudio-editor/automatic-completion/class-name-auto-complete.wiki index 57aa48da..18828f27 100644 --- a/documentation/current/eiffelstudio/eiffelstudio-reference/eiffelstudio-editor/automatic-completion/class-name-auto-complete.wiki +++ b/documentation/current/eiffelstudio/eiffelstudio-reference/eiffelstudio-editor/automatic-completion/class-name-auto-complete.wiki @@ -6,7 +6,7 @@ The EiffelStudio editor will complete class names automatically. This means, for a_variable_name: LI and then triggers the auto-complete, one of two things will happen: -* If there is only one class name in the universe that begins `LI', then that class name will be automatically placed in the editor pane at the cursor. +* If there is only one accessible class name that begins `LI', then that class name will be automatically placed in the editor pane at the cursor. * If there is more than one such class name, the editor will propose a list of possible valid class names, as seen in Figure 1. Auto-completion can be triggered by pressing Ctrl+Shift+Space or by following the [[Edit menu commands|edit menu]] path: @@ -42,9 +42,9 @@ Note that not all of the options are applicable to class name auto-completion. S * [[Image:hide non-matching entries icon]] (F1) Hide non-matching entries. * [[Image:query return type icon]] (F2) Show query return types. * [[Image:feature signatures icon]] (F3) Show feature signatures. -* [[Image:disambiguated name icon]] (F4) Show disambiguated names. +* [[Image:disambiguated name icon]] (F4) Show disambiguated names. (Applicable to .NET overloaded feature names.) * [[Image:obsolete items icon]] (F5) Show obsolete items. -* [[Image:show descriptions icon]] (F6) Show description of selected item. +* [[Image:show descriptions icon]] (F6) Show description of selected item in the ''tool tip'' area at the bottom of the window. (See Figure 1) * [[Image:remember list size icon]] (F7) Remember the size of the completion list between triggerings.