add wiki pages

Author: rajrsingh

docs/Code-formatting.md

@@ -0,0 +1,27 @@
+---
+layout: default
+title: Code Formatting
+permalink: /code-formatting/
+nav_order: 3
+---
+# Code formatting
+
+In previous versions of the objectscript plugin, VSCode code completion suggested commands and functions only in UPPERCASE. Now you can select the capitalization style you prefer. There are three options:
+* upper - all uppercase
+* lower - all lower case
+* word - capitalize initial letter of each word
+
+```json
+"objectscript.format": {
+  "commandCase": "word",
+  "functionCase": "word"
+},
+```
+
+You can see how it works below.
+
+![](https://community.intersystems.com/sites/default/files/inline/images/images/ezgif_com-optimize.gif)
+
+VSCode itself has formatting support using Meta/Alt+Shift+F, and it can format code using configured rules. Currently, it can replace abbreviated commands and functions with the complete name, control capitalization as above, and fix indentation by substituting tabs for spaces.
+
+![](https://community.intersystems.com/sites/default/files/inline/images/images/ezgif_com-optimize%20(1).gif)

docs/Connect-to-InterSystems-IRIS.md

@@ -0,0 +1,31 @@
+---
+layout: default
+title: Connect to InterSystems IRIS
+permalink: /connect/
+nav_order: 2
+---
+# Connect to InterSystems IRIS
+
+To be able to use many of the plugin features, you first need to configure the connection to an InterSystems IRIS or Caché server.
+
+* Find an 'objectscript.conn' section in workspace settings by following the menu sequence File > Preferences > Settings. Do not forget to set active to true. Set port to the web port of the instance you want to connect to. By default, this is 57772 for Caché/Ensemble and 52773 for InterSystems IRIS.
+  
+  ```JSON
+  {
+    "objectscript.conn": {
+      "active": true,
+      "label": "LOCAL",
+      "host": "127.0.0.1",
+      "port": 52773,
+      "username": "user",
+      "password": "password",
+      "ns": "USER",
+      "https": false
+    },
+    "objectscript.export.folder": "src", 
+    "objectscript.serverSideEditing": false
+  }
+  ```
+
+*	Change settings to those appropriate to your Caché or InterSystems IRIS instance.
+* You will see related output in "Output" while switched to "ObjectScript" channel (right drop-down menu on top of the output window).

docs/Debugging.md

@@ -0,0 +1,48 @@
+---
+layout: default
+title: Debugging
+permalink: /debugging/
+nav_order: 5
+---
+# Debugging
+
+Example of `.vscode/launch.json` file:
+
+```JSONC
+{
+// Use IntelliSense to learn about possible attributes.
+// Hover to view descriptions of existing attributes.
+// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "objectscript",
+      "request": "launch",
+      "name": "ObjectScript Debug Class",
+      "program": "##class(User.Test).Test()",
+    },
+    {
+      "type": "objectscript",
+      "request": "launch",
+      "name": "ObjectScript Debug Routine",
+      "program": "^test",
+    },
+    {
+      "type": "objectscript",
+      "request": "attach",
+      "name": "ObjectScript Attach",
+      "processId": "${command:PickProcess}",
+      "system": true
+    }
+  ]
+}
+```
+
+See how it works for routines: 
+![](https://community.intersystems.com/sites/default/files/inline/images/images/debug_routine.gif)
+
+For classes: 
+![](https://community.intersystems.com/sites/default/files/inline/images/images/debug_class.gif)
+
+And when attached to a process:
+![](https://community.intersystems.com/sites/default/files/inline/images/images/debug_attach.gif)

docs/Export-settings.md

@@ -0,0 +1,37 @@
+---
+layout: default
+title: Export settings
+permalink: /export-settings/
+nav_order: 4
+---
+# Export settings
+
+There are a few settings that control how the code is exported to the local machine from the server. `VSCode-ObjectScript` expects that these settings follow the folders' structure taken for your project.
+
+- `objectscript.export.folder` -- Root for ObjectScript sources in the project. Default value is `src`. The empty value is accepted and considered as a root of the project.
+
+- `objectscript.export.addCategory` -- If `true` adds folders for particular file types under the folder defined in the `objectscript.export.folder` setting. Files of type `cls`, `int`, `mac` and `inc` are placed in a folder with same type. Any other file types are placed in the `oth` folder.
+You can define the structure as an object, where the property name is supplied as pattern (mask or RegExp) and the value as a folder. For example:
+
+     ```JSON
+     {
+       "%*.cls": "_cls",
+       "*.cls": "cls"
+     }
+     ```
+
+     This saves percent classes to the `_cls` folder, and any other classes to the `cls` folder.
+
+- `objectscript.export.atelier` -- Store classes and routines in format same as in Atelier, with packages as subfolders.
+
+- `objectscript.export.generated` -- Specifies that generated source code files should be exported.
+
+- `objectscript.export.filter` -- SQL filter that can be used to match the names.
+
+- `objectscript.export.category` -- Specifies a category to export: CLS = classes; RTN = routines; CSP = csp files; OTH = other. Default is `*` to export all categories. Used by command `Export all`.
+
+- `objectscript.export.noStorage` - Strip the storage xml on export.  (Useful for multiple systems).
+
+- `objectscript.export.dontExportIfNoChanges` - Don't update the local file on export if the content is identical to the server code.
+
+Export settings are also used to determine how to translate the class name to the file name and back. So, it's important to have correct settings, not just for export.

docs/Installation.md

@@ -0,0 +1,15 @@
+---
+layout: default
+title: Installation
+permalink: /installation/
+nav_order: 1
+---
+# Installation 
+
+Before using VSCode-ObjectScript, you need to install VSCode, which you can get [here](https://code.visualstudio.com/).
+
+Once VSCode is installed, you should open it, go to Extensions View by by selecting menu items View > Extensions and search for "ObjectScript", as shown in the attached screenshot, and install it.
+
+![installation](https://raw.githubusercontent.com/daimor/vscode-objectscript/master/images/installation.gif)
+
+The next step is to [Connect to InterSystems IRIS](Connect-to-InterSystems-IRIS).

docs/Server-side-editing.md

@@ -0,0 +1,104 @@
+---
+layout: default
+title: Server-side editing
+permalink: /server-side-editing/
+nav_order: 6
+---
+# Server-side editing
+
+It is possible to configure `VSCode-ObjectScript` to edit code directly on the server, which is useful in cases where source code is stored in SCM as XML and managed using Studio Source Control hooks.
+
+You can configure this mode of operation using the [multi-root workspaces](https://code.visualstudio.com/docs/editor/multi-root-workspaces) feature from VSCode.
+
+First, you should configure the connection to InterSystems as described [here](https://github.com/daimor/vscode-objectscript/wiki/Connect-to-InterSystems-IRIS).
+
+Add a file with extension `.code-workspace`, with content similar to this.
+
+```JSON
+{
+    "folders": [
+        {
+            "uri": "isfs://my-local-place",
+        }
+    ],
+    "settings": {
+        "objectscript.conn": {
+            "active": true,
+            "host": "127.0.0.1",
+            "port": 57332,
+            "username": "_SYSTEM",
+            "ns": "USER",
+            "https": false
+        },
+        "objectscript.serverSideEditing": true
+    }
+}
+```
+
+When you save this file, VSCode shows you a button with an offer to open this as a workspace. Do it.
+
+With the next start of VSCode, you see two folders in the root with the names described in the `.code-workspace` file. The `server` folder, if expanded, shows any code on configured server and namespace, routines and classes in one place. You can now edit this code. If you have SourceControl class, it should be configured to export files in the same location which is used in the VSCode workspace.
+
+Example with connection to different namespaces on the same server:
+
+```JSON
+{
+  "folders": [
+    {
+      "name": "myapp",
+      "path": ".",
+    },
+    {
+      "uri": "isfs://myapp",
+      "name": "server",
+    },
+    {
+      "uri": "isfs://myapp?ns=USER",
+      "name": "user",
+    },
+    {
+      "uri": "isfs://myapp?ns=%SYS",
+      "name": "system",
+    },
+    {
+      "uri": "isfs://user@directserver:port?ns=%SYS",
+      "name": "system",
+    }
+  ],
+  "settings": {
+    "files.exclude": {},
+    "objectscript.conn": {
+      "active": true,
+      "username": "_system",
+      "password": "SYS",
+      "ns": "MYAPP",
+      "port": 52773,
+    },
+    "objectscript.serverSideEditing": true
+  }
+}
+```
+
+## CSP support
+
+To get access to edit CSP files on a server, you can configure uri in the format `isfs://myapp{csp_application}?csp`
+For example: 
+
+```
+"uri": "isfs://myapp/csp/user?csp"
+```
+
+This gives you access to the content of the `/csp/user` CSP application, where the flag `csp` is mandatory. Any changes in this virtual folder are saved on the server.
+
+## Filters
+
+There are some more filtering options.
+
+- `isfs://myapp?type=cls`, shows only classes
+- `isfs://myapp?type=rtn`, shows only routines, mac, int and inc files
+- `isfs://myapp?generated=1`, shows generated files as well as not generated
+- `isfs://myapp?filter=%Z*.cls,%z*.cls,%Z*.mac`, is a comma-delimited list of search options, ignores `type`
+- `isfs://myapp?flat=1`, is a flat list of files that does not split packages as folders.
+- `isfs://myapp?ns=<namespace>&flat=1&generated=1&filter=%sqlcq.<namespace>*.cls, %sqlcq.<namespace>*.int`, view cached query class code and modify the .int code. Replace `<namespace>` as appropriate.
+
+`flat` and `generated` can be combined with each other, and with `type` or `filter`. When `filter` is specified `type` is ignored.