Differences

This shows you the differences between two versions of the page.

--- visionx:eplug_guide [2020/06/05 16:58]
cduncan [Features]
+++ visionx:eplug_guide [2020/06/05 17:34]
cduncan [Build options]
@@ Line 47: / Line 47: @@
 {{:visionx:eplug_guide:preferences-license.png?nolink|The EPlug License Preference Page.}}
-In the preferences you can also view various information about the license, including the time remaining until it is expiring if it is a trial license.
+In the preferences, you can also view various information about the license, including the time remaining until it is expiring if it is a trial license.
 ====== Using EPlug ======
@@ Line 67: / Line 67: @@
 ===== Commands =====
-[[https://eplug.sibvisions.com/|EPlug]] provides various commands which can be used to navigate the project. These are either available from the context menu on a source file, or can be assigned custom keybindings through the Eclipse preferences.
+[[https://eplug.sibvisions.com/|EPlug]] provides various commands which can be used to navigate the project. These are either available from the context menu on a source file or can be assigned custom keybindings through the Eclipse preferences.
 {{:visionx:eplug_guide:eplug-context-menu.png?nolink|The EPlug context menu that can be accessed through the editor.}}
@@ Line 79: / Line 79: @@
 Opens the complement class of the currently open file.
-The complement class is the "counterpart" of every class on the client or server. So when invoked on a workscreen (client-side), it will open the server-side LCO class, and vice versa.
+The complement class is the "counterpart" of every class on the client or server. So, when invoked on a workscreen (client-side), it will open the server-side LCO class and vice versa.
 ==== Go To application.xml ====
@@ Line 105: / Line 105: @@
 The biggest and most important feature of [[https://eplug.sibvisions.com/|EPlug]] is the support for DataBooks, both ''%%RemoteDataBook%%''s and ''%%MemDataBook%%''s to be exact.
-Because DataBooks are using ''%%String%%''s to identify columns (instead of properties or Enums), it cannot be covered by the default functionality of Eclipse and the Java compiler. [[https://eplug.sibvisions.com/|EPlug]] extends Eclipse with additional functionality to be able to provide various features on and around DataBooks and column names.
+Because DataBooks use ''%%String%%''s to identify columns (instead of properties or Enums), it cannot be covered by the default functionality of Eclipse and the Java compiler. [[https://eplug.sibvisions.com/|EPlug]] extends Eclipse with additional functionality to be able to provide various features on and around DataBooks and column names.
-Both, the ''%%RemoteDataBook%%'' and the ''%%MemDataBook%%'' are supported out of the box. In the case of a ''%%MemDataBook%%'', the metadata is not requested from the data source (because there is none), but the metadata is directly extracted from the code itself.
+Both the ''%%RemoteDataBook%%'' and the ''%%MemDataBook%%'' are supported out of the box. In the case of a ''%%MemDataBook%%'', the metadata is not requested from the data source (because there is none), but the metadata is directly extracted from the code itself.
-==== Compile time checks ====
+==== Compile Time Checks ====
-Column names are checked during compilation if they are correct or not. This is done by actually requesting the metadata from the data source and comparing the names against it. In the case of the ''%%MemDataBook%%'' the metadata is built directly from the code.
+Column names are checked during compilation if they are correct or not. This is done by actually requesting the metadata from the data source and comparing the names against it. In the case of the ''%%MemDataBook%%'', the metadata is built directly from the code.
 {{:visionx:eplug_guide:databook-compile-time-check.png?nolink|The workscreen source with a mistyped column name being highlighted.}}
@@ Line 117: / Line 117: @@
 Quick fixes are provided in the case that a column name has been misspelled to make it easier to fix simple errors.
-==== Hover tips ====
+==== Hover Tips ====
-When hovering over a column name, a hover tip is displayed which shows all the information about the column that is available. The information includes:
+When hovering over a column name, a hover tip is displayed that shows all the information about the column that is available. The information includes:
   * Name
@@ Line 129: / Line 129: @@
 {{:visionx:eplug_guide:databook-hover-tip.png?nolink|The hover tip of a column name showing various informations and properties of the column.}}
-==== Code completion ====
+==== Code Completion ====
-Column names are also offered in the code completion dialog, complete with all available information about them.
+Column names are also offered in the code completion dialog as well as all available information about them.
 {{:visionx:eplug_guide:databook-code-completion.png?nolink|The code completion of Eclipse showing column names for the current DataBook.}}
@@ Line 137: / Line 137: @@
 The same information as in the hover tips is being displayed alongside all columns that can be selected in the code completion dialog.
-==== DataBooks view ====
+==== DataBooks View ====
-Additionally there is the DataBooks View, which does list all DataBooks and all columns in the currently edited file together with their datatype and label.
+Additionally, there is the DataBooks view which lists all DataBooks and all columns in the currently edited file together with their datatype and label.
 {{:visionx:eplug_guide:databooks-view.png?nolink|The DataBooks View displaying the currently used DataBooks.}}
@@ Line 151: / Line 151: @@
 {{:visionx:eplug_guide:project-properties-databook.png?nolink|The project preferences with the DataBook node selected.}}
-=== Check the DataBooks on refresh ===
+=== Check the DataBooks on Refresh ===
-When enabled, DataBooks are checked when a refresh of the file is performed, not only when the file is build.
+When enabled, DataBooks are checked when a refresh of the file is performed and not only when the file is build.
-=== Check DataBooks while you type ===
+=== Check DataBooks While You Type ===
 When enabled, DataBooks are checked as you type without the need to save and/or build the file.
@@ Line 161: / Line 161: @@
 This is especially useful when working with ''%%MemDataBook%%''s, as their metadata might have been typed just seconds before being used.
-==== Build options ====
+==== Build Options ====
 The build behavior can also be changed in the project preferences.
@@ Line 167: / Line 167: @@
 {{:visionx:eplug_guide:project-build-properties.png?nolink|The project build properties of EPlug.}}
-=== Action when no metadata was provided ===
+=== Action When No Metadata Was Provided ===
-This option allows to control how the plugin behaves when no metadata could be acquired for the DataBook that is being checked. Please note that "no metadata could be acquired" is not the same as "acquiring failed", for example it could be that a DataBook is the parameter of a function. In that case is not possible to determine from where the DataBook originated, so no metadata can be determined.
+This option allows you to control how the plugin behaves when no metadata could be acquired for the DataBook that is being checked. Please note that "no metadata could be acquired" is not the same as "acquiring failed". For example, it could be that a DataBook is the parameter of a function. In that case, is not possible to determine from where the DataBook originated, and so no metadata can be determined.
 With this option, the behavior for such a situation can be controlled, whether the plugin should issue a notice/warning/error or do nothing.
@@ Line 175: / Line 175: @@
 === Check DataSource of RemoteDataBooks ===
-This option allows to control whether the datasource on ''%%RemoteDataBook%%''s should be checked if it is correctly set or not. This is basically a check whether the name of the ''%%RemoteDataBook%%'' can be mapped to a server-side storage object.
+This option allows you to control whether the datasource on ''%%RemoteDataBook%%''s should be checked if it is correctly set or not. This is basically a check if the name of the ''%%RemoteDataBook%%'' can be mapped to a server-side storage object.
 ===== Actions =====