Updating documents for MVVS 2.6.0

Author: sgaikwad-rocket

docs/img/online_editing_configure_pattern_option.png

@@ -1,5 +1,10 @@
 # Change Log
 
+## Version 2.6.0: November 21, 2024
+ - Enhancement: UD compilation will read parameters from basic.mvbasic.json file.
+ - Support pattern configuration for account, folder and file filtering (only in online mode).
+ - Customer bug fixes
+  
 ## Version 2.5.1: August 23, 2024
 
  - Support for cataloging BASIC program files via right-click component in both online and offline modes.

docs/img/online_editing_server_3.png

@@ -105,15 +105,16 @@ Users can right-click a BASIC program file and select "Catalog" to catalog a sin
 
 ![](../img/catalog.png)
 
-## Catalog Settings in "catalog.mvbasic.json" file
+## Catalog Settings in "basic.mvbasic.json" file
 
 Cataloging a program makes it available to all users or to users of one account. You must catalog a program before another BASIC program can call it as an external subroutine.
 
 ```
 {
     "catalog": "",
     "arguments": "",
-    "initialCharacter": ""
+    "initialCharacter": "",
+    "ud_compile_flavor": ""
 }
 ```
 
@@ -128,7 +129,8 @@ pointing to the object file, you need not recatalog the program every time you r
     {
         "catalog": "local",
         "arguments": "",
-        "initialCharacter": ""
+        "initialCharacter": "",
+        "ud_compile_flavor": ""
     }
 
 **Normal Catalog**: Normal cataloging copies the specified object record to the system catalog space, making it available
@@ -145,7 +147,8 @@ or !, and do not specify the keyword LOCAL.
     {
         "catalog": "normal",
         "arguments": "",
-        "initialCharacter": ""
+        "initialCharacter": "",
+        "ud_compile_flavor": ""
     }
 
 **Global Catalog**: Like normal cataloging, global cataloging copies the specified object record to the system catalog
@@ -167,7 +170,8 @@ the keyword LOCAL.
     {
         "catalog": "global",
         "arguments": "",
-        "initialCharacter": "*"
+        "initialCharacter": "*",
+        "ud_compile_flavor": ""
     }
 
 ### Cataloging in Unidata
@@ -177,7 +181,8 @@ the keyword LOCAL.
     {
         "catalog": "direct",
         "arguments": "",
-        "initialCharacter": ""
+        "initialCharacter": "",
+        "ud_compile_flavor": ""
     }
 
 **Local Catalog**: Catalogs the program locally and places a copy of it in a subdirectory of the local CTLG catalog (in the account where the user is running the program). UniData creates a VOC pointer to the subdirectory.UniData creates the CTLG and the subdirectory, if they do not
@@ -186,10 +191,11 @@ already exist.
     {
         "catalog": "local",
         "arguments": "",
-        "initialCharacter": ""
+        "initialCharacter": "",
+        "ud_compile_flavor": ""
     }
 
 
-**Note 1 :** The parameter "arguments" in the catalog.mvbasic.json file is currently not supported by the catalog feature. By default, the argument is set to FORCE for both the UV and UD databases.
+**Note 1 :** The parameter "arguments" in the basic.mvbasic.json file is currently not supported by the catalog feature. By default, the argument is set to FORCE for both the UV and UD databases.
 
-**Note 2 :** If the `./rmv` configuration exists, the `catalog.mvbasic.json` file will be created during the first catalog attempt. If the `./rmv` configuration does not exist, the `config/catalog.mvbasic.json` file will be created when the extension is activated.
+**Note 2 :** If the `./rmv` configuration exists, the `basic.mvbasic.json` file will be created during the first catalog attempt. If the `./rmv` configuration does not exist, the `config/basic.mvbasic.json` file will be created when the extension is activated.

docs/usage/CHANGELOG.md

@@ -29,9 +29,9 @@ The compilation result will display in the VS Code terminal.
 
 **Note**: Using this method, compiled programs will not be cataloged.
 
-For UniData, different flavors are supported. You can select “Pick” flavor or “UniData” flavor when using right-click compile:
+For UniData, different flavors are supported. Right-click in the file you want to compile then select "Compile BASIC programs". It will read the language value from the basic.mvbasic.json file, with the value set to: "ud_compile_flavor". [Please see this section to set ud_compile_flavor value.](./Compile.md#unidata-compile-flavor-in-basicmvbasicjson-file)
 
-![](../img/compile_basic_in_unidata_with_different_flavors.png)
+![](../img/compile_from_context.png)
 
 ### From a file explorer
 
@@ -91,18 +91,19 @@ You can find task properties in the [VS Code official documents](https://code.vi
 - **targets**: a list that contains the files you want to compile. The value should be the file's relative path. Please see the examples section for more details.
 - **compile**: compilation related settings. It contains following configurable items.
   - **dataSource**: Must be "UNIVERSE" or "UNIDATA", depending on the connected U2 server.
-  - **language**: (For UniData only) The programming language flavor. Must be "UniBasic" or "Pick". If not set, "UniBasic" is the default.
+  - **language**: (For UniData only) The programming language flavor. Must be "UniBasic" or "Pick". If not set, "UniBasic" is the default, **but It will read the language value from the basic.mvbasic.json file, with the value set to: "ud_compile_flavor".** [Please see this section to set ud_compile_flavor value.](./Compile.md#unidata-compile-flavor-in-basicmvbasicjson-file)
   - **catalog**: For UniVerse, you can select "global", "local" or "normal". For UniData, you can select "global", "local" or "direct". If not set, files will not be cataloged.
   - **initialCharacter**: (For UniVerse only) The initial character of the cataloged program can only be set when the **catalog** parameter is set to “global”.
   - **arguments**: Put additional compilation arguments here. For more details, please refer UniVerse / UniData user manual for more details. By default, this setting doesn’t appear in the configuration file. Please add it manually if needed.
 #### Run build task
 
 Select "Run build task" from the "Terminal" menu to start the build task.
 
-**Note**: Ensure that a U2 server has been connected. Otherwise, an error will occur.
+**Note 1**: Ensure that a U2 server has been connected. Otherwise, an error will occur.
 
 ![](../img/compile_from_menu_3.png)
 
+**Note 2**: Once you click on "Run build task," it will compile BASIC using the compile flavor value set to ud_compile_flavor in the basic.mvbasic.json file, instead of compiling with the "language" value specified in the task (for Unidata).
 
 ## UniVerse Compile Task Examples
 
@@ -281,7 +282,7 @@ Select "Run build task" from the "Terminal" menu to start the build task.
 - Add source code relative path to "targets". In this example, SAMPLE_FILE is in the BP folder
 - "dataSource" must be "UNIDATA" for UniData
 - No need to set "catalog" if you don't want to catalog programs
-- You can select the language flavor in "language". In this example, the language flavor is "UniBasic"
+- You can select the language flavor in "language". In this example, the language flavor is "UniBasic", **but It will read the language value from the basic.mvbasic.json file, with the value set to: "ud_compile_flavor".** [Please see this section to set ud_compile_flavor value.](./Compile.md#unidata-compile-flavor-in-basicmvbasicjson-file)
 
 
 
@@ -315,7 +316,7 @@ Select "Run build task" from the "Terminal" menu to start the build task.
 ```
 
 - You can add multiple source code relative paths to "targets"
-- Set "language" to "Pick" flavor
+- Set "language" to "Pick" flavor, **but It will read the language value from the basic.mvbasic.json file, with the value set to: "ud_compile_flavor".** [Please see this section to set ud_compile_flavor value.](./Compile.md#unidata-compile-flavor-in-basicmvbasicjson-file)
 - Set "catalog" to "global" if you want to perform global cataloging
 
 
@@ -392,4 +393,60 @@ Select "Run build task" from the "Terminal" menu to start the build task.
 }
 ```
 
-- Compile the BASIC program with arguments "-L" and "-X".
+- Compile the BASIC program with arguments "-L" and "-X".
+
+## Unidata Compile Flavor in basic.mvbasic.json File
+
+By Uusing the VS Code task, users can compile or catalog multiple BASIC programs at the same time. BASIC compilation will use the specified Task propetiesproperties (except the "language" property).
+
+
+```json
+{
+	"version": "2.0.0",
+	"tasks": [
+		{
+			"type": "BASIC",
+			"targets": [
+				"BP/SAMPLE_FILE"
+			],
+			"compile": {
+				"dataSource":"UNIDATA", 
+                "language": "UniBasic"
+			},
+			"problemMatcher": [],
+			"label": "BASIC: Build",
+			"group": {
+				"kind": "build",
+				"isDefault": true
+			}
+		}
+    ]
+}
+```
+
+It will read the language value from the basic.mvbasic.json file, with the value set to: "ud_compile_flavor"
+
+	{
+        "catalog": "direct",
+        "arguments": "",
+        "initialCharacter": "",
+        "ud_compile_flavor": "Pick"
+    }
+
+**Example 1**. Compile a single BASIC program with flavor UniBasic.
+
+	{
+        "catalog": "local",
+        "arguments": "",
+        "initialCharacter": "",
+        "ud_compile_flavor": "UniBasic"
+    }
+
+**Example 2**. Compile a single BASIC program with flavor revelation.
+
+	{
+        "catalog": "local",
+        "arguments": "",
+        "initialCharacter": "",
+        "ud_compile_flavor": "revelation"
+    }

docs/usage/Catalog.md

@@ -40,11 +40,11 @@ This configuration file contains the settings for feature Group View. If you nee
 
 ## Catalog Configuration
 
-The configuration file name is "catalog.mvbasic.json". 
+The configuration file name is "basic.mvbasic.json". 
 
-This configuration file contains the parameters for the Catalog feature. If you need to change the catalog type, arguments, or initial character, please update the settings in this file. See [Catalog Settings in "catalog.mvbasic.json" file](./Catalog.md#quick-catalog) for more information.
+This configuration file contains the parameters for the Catalog feature. If you need to change the catalog type, arguments, or initial character, please update the settings in this file. See [Catalog Settings in "basic.mvbasic.json" file](./Catalog.md#quick-catalog) for more information.
 
-**Note:** If either `./rmv` or `./rmvonline` configuration exists, the `catalog.mvbasic.json` file will be created during the first catalog attempt. If the `./rmv` configuration does not exist, the `config/catalog.mvbasic.json` file will be created when the extension is activated.
+**Note:** If either `./rmv` or `./rmvonline` configuration exists, the `basic.mvbasic.json` file will be created during the first catalog attempt. If the `./rmv` configuration does not exist, the `config/basic.mvbasic.json` file will be created when the extension is activated.
 
 ## Configuration Files
 

docs/usage/Compile.md

@@ -40,13 +40,16 @@ Before debugging, open the BASIC program first.
 
 ### Debugging without a launch file
 
- - Click the **Run and Debug** icon on left menu bar. The **Run and Debug** view will display if you have no `launch.json` file in your project.
+ - Click the **Run and Debug** icon on from the left menu bar. The **Run and Debug** view will display if you have no `launch.json` file in your project.
 
  - Click the **Run and Debug** button to start debugging the currently focused BASIC program file. 
 
 ![](../img/run_and_debug.png)
 
-The BASIC program file will be compiled first. If successful, the debugging process will stop at the first runnable line of code in the program file.
+The BASIC program file will be compiled first.
+For UniData, there are different compilation flavors and it will read the compile flavor from basic.mvbasic.json, with the value set to: "ud_compile_flavor". [Please see this section to set ud_compile_flavor value.](./Compile.md#unidata-compile-flavor-in-basicmvbasicjson-file)
+ 
+On successful compilation, the debugging process will stop at the first runnable line of code in the program file.
 
 ### Debug with launch file
 

docs/usage/Configuration.md

@@ -58,6 +58,8 @@ By accessing the configuration file, you can perform actions such as adding, edi
 
  - **"port"**: By default, the port is set to 31438, but you can change this according to your U2 server configuration.
 
+ - **"filterPatterns"**_(Optional)_: Used to specify filter patterns for Accounts, Folders and Files.
+
 There are additional methods available to edit the configuration file: 
 
  - Right-click on a tree view node and select "Add New Server" to add a new U2 server configuration. 
@@ -86,6 +88,32 @@ If you wish to disconnect from a U2 server, right-click the corresponding server
 
 ![](../img/online_editing_connection_icon.png)
 
+### Filtering
+
+Users can establish filters to filter out information which that they user do not want the MVVS to display. Users can configure MVVS to filter out certain file names. This is done to minimize the amount number of unnecessary files listed.
+
+In the Configure Patterns option, enter the account/folder/file name patterns you want to match. Separate each pattern with a comma. Pattern matching characters are:
+ * \* = any string
+ * ? = any character
+
+#### **Steps to Configure Filter Pattern**
+**Access Configuration**:
+* Right-click the server name, account, or folder.
+* Select the "Configure Pattern" option.
+
+![](../img/online_editing_configure_pattern_option.png)
+
+**Enter Filter Pattern**:
+* Add your desired filter pattern to the servers.mvbasic.json file.
+* Save the changes.
+
+**Refresh Connection**:
+* If you are already connected to the server, manually refresh it to apply the changes.
+
+**View Filtered Results**:
+* Expand the specific server or folder to see only the filtered accounts, folders, and files.
+
+
 ### Editing BASIC programs
 
 Once connected to a U2 server, you can expand the server node to access and view the BASIC program files stored on that server.
@@ -118,14 +146,14 @@ Users can right-click a BASIC program file and select “” to compile a single
 
 ![](../img/catalog_compile.png)
 
-For UniData, there are multiple compilation commands for different flavors.
+For UniData, there are multiple compilation commands for different flavors. Please refer [UD Compilation here](./Compile.md#unidata-compile-flavor-in-basicmvbasicjson-file)
 
 #### Quick catalog
 Users can right-click a BASIC program file and select "Catalog" to catalog a single file for both Universe and Unidata databases 
 
 ![](../img/catalog.png)
 
-Clicking on 'Catalog' will use the parameters from the catalog.mvbasic.json file to catalog the file. If you need to change the catalog type, arguments, or initial character, please update the settings in this file. See [Catalog Settings in "catalog.mvbasic.json" file](./Catalog.md#quick-catalog) for more information.
+Clicking on 'Catalog' will use the parameters from the basic.mvbasic.json file to catalog the file. If you need to change the catalog type, arguments, or initial character, please update the settings in this file. See [Catalog Settings in "basic.mvbasic.json" file](./Catalog.md#quick-catalog) for more information.
 
 #### Compile / Catalog with configuration file
 The configuration file can help a user to compile and catalog multiple files.
@@ -152,4 +180,4 @@ Most of the LSP (Language Server Protocol) features are supported, but there are
 
  - Do not click on another account's folder before completing the cataloging of the current BASIC program. Doing so may result in cataloging the wrong BASIC program on the U2 server side. 
 
- - The parameter "arguments" in the catalog.mvbasic.json file is currently not supported by the catalog feature. By default, the argument is set to FORCE for both the UV and UD databases.
+ - The parameter "arguments" in the basic.mvbasic.json file is currently not supported by the catalog feature. By default, the argument is set to FORCE for both the UV and UD databases.