diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 301dda50..fdd2c2e0 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -5,7 +5,6 @@ on: branches: - master paths-ignore: - - "docs/**" - ".vscode/**" - ".github/**" - "**/*.md" diff --git a/.github/workflows/prerelease.yml b/.github/workflows/prerelease.yml index 8d4bb604..ebbaebe5 100644 --- a/.github/workflows/prerelease.yml +++ b/.github/workflows/prerelease.yml @@ -5,7 +5,6 @@ on: branches: - prerelease paths-ignore: - - "docs/**" - ".vscode/**" - ".github/**" - "**/*.md" diff --git a/docs/.gitignore b/docs/.gitignore deleted file mode 100644 index 85b64b4e..00000000 --- a/docs/.gitignore +++ /dev/null @@ -1,6 +0,0 @@ -_site -.sass-cache -.jekyll-cache -.jekyll-metadata -.bundle -vendor diff --git a/docs/.vscode/settings.json b/docs/.vscode/settings.json deleted file mode 100644 index e69de29b..00000000 diff --git a/docs/404.html b/docs/404.html deleted file mode 100644 index 7c56defa..00000000 --- a/docs/404.html +++ /dev/null @@ -1,26 +0,0 @@ ---- -permalink: /404.html -layout: default -nav_exclude: true ---- - - - -
-

404

- -

Page not found :(

-

The requested page could not be found.

-
diff --git a/docs/Configuration.md b/docs/Configuration.md deleted file mode 100644 index 7a124eb2..00000000 --- a/docs/Configuration.md +++ /dev/null @@ -1,265 +0,0 @@ ---- -layout: forward -target: https://docs.intersystems.com/components/csp/docbook/DocBook.UI.Page.cls?KEY=GVSCO -time: 4 - -title: Configuration -permalink: /configuration/ -nav_order: 4 ---- - -{: .warning } -This documentation has been moved to the [InterSystems Documentation site](https://docs.intersystems.com/components/csp/docbook/DocBook.UI.Page.cls?KEY=GVSCO_config). This page will be removed soon. - -# Configuration - -VS Code settings enable you to customize various aspects of its behavior. The InterSystems extensions provide settings used to configure VS Code for ObjectScript development. - -{: #code-configuration-basic} - -## Basic Configuration - -VS Code has a concept of a [workspace](https://code.visualstudio.com/docs/editor/workspaces), which is a set of directories you want to use when you're working on a particular project. In the simplest setup when you are working within a single directory, a VS Code workspace is just the root folder of your project. In this case you keep workspace-specific settings in two files inside a `.vscode` directory located at the root of your project. Those two files are `settings.json`, which contains most configuration settings, and `launch.json`, which contains debugging configurations. - -Here is the simplest `settings.json` file content for an ObjectScript project: - -{: #code-workspace-simple} - -```json -{ - "objectscript.conn": { - "ns": "USER", - "active": true, - "host": "localhost", - "port": 52773, - "username": "_SYSTEM" - } -} -``` - -However, a better strategy is to let the [InterSystems Server Manager](https://marketplace.visualstudio.com/items?itemName=intersystems-community.servermanager) handle the server connection information as described [later](#config-server). That extension also allows you to store your password securely, so please use it. Then in `settings.json` you only need to specify the server name, which you set up in Server Manager: - -```json -{ - "objectscript.conn": { - "server": "iris", - "ns": "USER", - "active": true - } -} -``` - -If you need ObjectScript compilation flags other than the default ones, add an `"objectscript.compileFlags"` property to `settings.json` (more compileFlags information is [available here](/vscode-objectscript/settings#vscode-objectscript)): - -{: #code-workspace-compileFlags} - -```json -{ - "objectscript.conn": { - "server": "iris", - "ns": "USER", - "active": true, - }, - "objectscript.compileFlags": "cuk/compileembedded=1" -} -``` - -Here is the simplest `launch.json` file content, with which you can debug the method `Test` in the class `Example.Service`, passing 2 parameters as input (see ["Running and Debugging"](/vscode-objectscript/rundebug/) for more information): - -{: #code-workspace-simple-debug} - -```json -{ - "version": "0.2.0", - "configurations": [ - { - "type": "objectscript", - "request": "launch", - "name": "Example.Service.Test", - "program": "##class(Example.Service).Test(\"answer\",42)" - } - ] -} -``` - -If you want to debug a running process, `launch.json` should have a section like this, which will present a dropdown menu of running processes: - -{: #code-workspace-simple-debug-process} - -```json -{ - "version": "0.2.0", - "configurations": [ - { - "type": "objectscript", - "request": "attach", - "name": "Example-attach-to-process", - "processId": "${command:PickProcess}" - } - ] -} -``` - -Note that `"configurations"` is an array, so you can define multiple configurations and choose the one to use from a dropdown menu in the Debug pane. - -{: #code-workspaces} - -## VS Code Workspaces - -If your project requires more than a single root folder, you need to use a feature called multi-root workspaces. See [Multi-root Workspaces](https://code.visualstudio.com/docs/editor/multi-root-workspaces) in the VS Code documentation. - -In this case settings are stored in a file with a `*.code-workspace` suffix. The filename's extension must be *.code-workspace*, for example `test.code-workspace`. This workspace file can be located anywhere. It defines what root folders the workspace consists of, and may also store other settings that would otherwise be stored in `settings.json` or `launch.json`. Settings in a root folder's `.vscode/settings.json` or `.vscode/launch.json` will override those in the workspace file, so be careful to use one or the other unless you truly need to leverage this flexibility. - -You can have a workspace file even if you are only working with a single root folder. Indeed, if you are [working server-side](../serverside/) you will always be using a workspace file. - -To edit **InterSystems ObjectScript** extension settings in a `*.code-workspace` file in VS Code, open the workspace using **File > Open Workspace from File...**, select **File > Preferences > Settings** (**Code > Preferences > Settings** on Mac) and select the Workspace tab. Search for **objectscript: conn**, and click on *Edit in settings.json*. VS Code opens the `*.code-workspace` file for that workspace. - -The **InterSystems ObjectScript** extension uses the multi-root workspaces feature to support ObjectScript development directly in namespaces on InterSystems servers. - -## Settings - -Many available settings are general to VS Code, and you can learn about them in the [Visual Studio Code Documentation](https://code.visualstudio.com/docs). The InterSystems Server Manager, InterSystems ObjectScript, and InterSystems Language Server extensions supply additional settings you can use to define InterSystems IRIS servers and connections to those servers. - -There are several levels on which settings are stored and used: - -- **User** - User settings are stored in a file location specific to you and apply globally to any instance of VS Code or any VS Code workspace that you open. -- **Workspace** - Workspace settings are stored in a file inside the workspace and apply to anyone who opens the workspace. -- **Folder** - If more than one folder is present in the workspace, you can select the folder where the settings file is stored by selecting from the Folder drop down list. - -For example, the following screen shot shows the Workspace level selected: - -![Workspace selected.](../assets/images/ClickWorkspace.png "workspace selected") - -See the VS Code documentation section [User and Workspace Settings](https://code.visualstudio.com/docs/getstarted/settings). - -See the [Settings Reference page](../settings/) for a list of all settings contributed by the extensions in the pack. - -{: #config-server} -## Configuring a Server - -First, configure one or more servers. You can use the plus sign (`+`) at the top of the InterSystems Tools view to add a server. For more information on this view, see the section [InterSystems Tools View](../extensionui#intersystems-tools-view). - -![Add server.](../assets/images/add-server.png "add server") - -Provide the following values when prompted: - -- **Name of new server definition** - An arbitrary name to identify this server. -- **Description (optional)** - A brief description of the server. -- **Hostname or IP address of web server** - The host of the InterSystems server, or a standalone web server that publishes the web services of your target InterSystems server via the InterSystems Web Gateway. -- **Port of web server** - The WebServer port number for this server's private web server, or the port number of the standalone web server. -- **Username** - The username to use when logging in to this server. -- **Confirm connection type** - The protocol used for connections. Possible values are **http** and **https**. - -Once you have entered these values the server definition is stored in your user-level `settings.json` file, and the server appears at the top of the **Recent** folder in the InterSystems Tools view. - -If you want to store a password for this server definition, select **Store Password in Keychain** from the context menu for the server in the InterSystems Tools view. If you do not store a password, users are prompted for a password each time they connect to the server. To remove a password from the keychain, Select **Clear Password from Keychain** from the server context menu. For more information, see [Server Context Menu](../extensionui#server-context-menu). - -You can create a configuration for a server that is not currently running. - -If you are connecting via a standalone web server which publishes services for more than one InterSystems server you will need to edit the server configuration in your `settings.json` file to add a `pathPrefix` property. See the next section. - -## Editing a Server Configuration - -If you need to modify a server configuration select **File > Preferences > Settings** (**Code > Preferences > Settings** on Mac) from the menu. Select the **User** settings level. Find **Extensions** in the list in the left pane of the editor window, click to open, then select **InterSystems Server Manager** from the list to find the **InterSystems Server Manager** area of the edit pane, as illustrated in the following screen shot: - -![Server manager settings.](../assets/images/ServerManagerSettings.png "server manager settings") - -Click *Edit in settings.json*. - -The InterSystems Tools view provides an alternate path to this `settings.json` file. Click the `...` button and select **Edit Settings**. - -![Edit settings.](../assets/images/edit-settings.png "edit settings") - -The server configuration in *settings.json* looks similar to the following, with the values you entered when you configured the server: - -```json -{ - "intersystems.servers": { - "iris-1": { - "webServer": { - "scheme": "http", - "host": "localhost", - "port": 52773 - }, - "username": "_SYSTEM" - } - } -} -``` -The components of the server definition are as follows: - -- **iris-1** - An arbitrary name to identify this server. -- **webServer** - The collection of properties that define the web server through which you will connect. This can either be the InterSystems server's private web server or a standalone web server configured as an InterSystems Web Gateway. - - **scheme** - The protocol used for connections (http or https). - - **host** - The host of the web server. - - **port** - The port number for this web server. - - **pathPrefix** - Only required when connecting through a standalone web server that publishes the target server's web services under a subfolder. -- **username** - The username to use in logging in to this server. -- **password** - Password for the specified username. Entering the password as plaintext in this file is acceptable only in limited situations with very low need for security. - -If you do not store the password securely in your workstation keychain or add it to the server definition, anyone using the server needs to supply the password. The InterSystems Server Manager provides the following commands for managing stored passwords in the Command Palette: - -- **InterSystems Server Manager: Clear Password from Keychain** - Remove the password for a selected server. -- **InterSystems Server Manager: Store Password in Keychain** - Select a server or create a new one, then enter a password. - -{: #config-server-conn} -## Configuring a Server Connection - -Open the folder where you want client-side files to be located. Select the **ObjectScript Explorer** button on the Activity Bar. Select the **Choose Server and Namespace** button. This action opens a dialog that lets you select a server or create a new one. Once you have selected a server and namespace, connection configuration is complete. VS Code adds the server and namespace to the status bar, as shown in the following screen shot. - -![Connection information in the status bar.](../assets/images/action-for-server-start.png "connection information in the status bar") - -You cannot create a connection to a server that is not running. - -## Editing a Server Connection - -If you need to modify a server connection select **File > Preferences > Settings** (**Code > Preferences > Settings** on Mac) from the menu. Select the **Workspace** settings level. Search for **objectscript: conn**, and click on *Edit in settings.json*. - -The connection configuration looks like this: - -```json -"objectscript.conn": { - "ns": "USER", - "server": "iris-1", - "active": true, -}, -``` - -The components of this configuration are: - -- **ns** - Namespace to use on the server -- **server** - Server name as specified in the server configuration -- **active** - Specifies whether the connection is active. - -{: #server-actions-menu} -## Add Custom Entries to the Server Actions Menu - -Click on the server and namespace in the status bar to open a list of actions you can take for this server: - -![Select action for server.](../assets/images/action-for-server.png "select action for server") - -You can add custom entries to this list using the `objectscript.conn.links` configuration object, which contains key-value pairs where the key is the label displayed in the menu and the value is the uri to open. The following variables are available for substitution in the uri: - -- **${host}** - The hostname of the connected server. For example, `localhost` -- **${port}** - The port of the connected server. For example, `52773` -- **${serverUrl}** - The full connection string for the server. For example, `http://localhost:52773/pathPrefix` -- **${ns}** - The namespace that we are connected to, URL encoded. For example, `%25SYS` or `USER` -- **${namespace}** - The raw `ns` parameter of the connection. For example, `sys` or `user` -- **${username}** - The username you are connected as. -- **${classname}** - The name of the currently opened class, or the empty string if the currently opened document is not a class. -- **${classnameEncoded}** - URL encoded version of **\${classname}**. -- **${project}** - The currently opened server-side project, or the empty string. - -An example links configuration looks like this: - -```json -"objectscript.conn": { - "links": { - "Portal Explorer": "${serverUrl}/csp/sys/exp/%25CSP.UI.Portal.ClassList.zen?$NAMESPACE=${ns}" - }, -} -``` - -And the resulting Server Actions Menu looks like this: - -![Server actions with custom links.](../assets/images/server-actions-with-links.png "server actions menu with custom links") diff --git a/docs/ExtensionUI.md b/docs/ExtensionUI.md deleted file mode 100644 index 80602670..00000000 --- a/docs/ExtensionUI.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -layout: forward -target: https://docs.intersystems.com/components/csp/docbook/DocBook.UI.Page.cls?KEY=GVSCO -time: 4 - -title: InterSystems Extensions UI -permalink: /extensionui/ -nav_order: 3 ---- - -{: .warning } -This documentation has been moved to the [InterSystems Documentation site](https://docs.intersystems.com/components/csp/docbook/DocBook.UI.Page.cls?KEY=GVSCO_ui). This page will be removed soon. - -# InterSystems Extensions User Interface - -The InterSystems extensions add additional capability to the VS Code user interface to support development in ObjectScript. These additions are based on the standard VS Code UI, which is described in the section [User Interface](https://code.visualstudio.com/docs/getstarted/userinterface) in the VS Code documentation. - -## Explorer View - -Select the Explorer view button in the Activity Bar to open the view. - -![Explorer view button.](../assets/images/explorer.png "explorer view button") - -The Explorer view is a standard VS Code view. InterSystems extensions add the following items to context menus in the this view: - -- **Add Server Namespace to Workspace...** - in context menu of folders -- **Import and Compile** - in context menu of folders and files when you are connected to an InterSystems server -- **Import Without Compilation** - in context menu of folders and files when you are connected to an InterSystems server - -{: #intersystems-tools-view} -## InterSystems Tools View - -The InterSystems Server Manager extension supplies an InterSystems Tools view. Select the InterSystems Tools view button in the Activity Bar to open the view. - -![InterSystems Tools button.](../assets/images/intersystems-tools.png "intersystems tools button") - -### Viewing Server Resources - -This view shows server resources in a tree format. - -![Server tree view.](../assets/images/server-tree-view.png "server tree view") - -As you can see, the view groups servers into a variety of folders, such as currently in use, favorites, and recently used. Within the view, you can perform operations on the servers. When you move the cursor over a server listing, command buttons appear which let you mark the server as a favorite, or open the Management Portal for the server in either the simple browser in a VS Code tab or in an external browser: - -- ![Add to starred.](../assets/images/add-to-starred.png "add to starred") -- ![Open Management Portal in tab.](../assets/images/management-portal-tab.png "open management portal in the simple browser in VS Code") -- ![Open Management Portal in browser.](../assets/images/management-portal-browser.png "open management portal in browser") - -#### Notes About the VS Code Simple Browser - -Only one Simple Browser tab can be open at a time, so launching a second server's Management Portal replaces the previous one. - -If the server version is InterSystems IRIS 2020.1.1 or later you need to change a setting on the suite of web applications that implement Management Portal. The Simple Browser is not be permitted to store the Portal's session management cookies, so the Portal must be willing to fall back to using the CSPCHD query parameter mechanism. - -In Management Portal, select **System Administration > Security > Applications > Web Applications**. Enter `/csp/sys` in the **filter** field to find the five web applications whose path begins with `/csp/sys`. - -![Portal web app list.](../assets/images/five-web-apps.png "portal web app list") - -For each application, select the link in the **name** column to edit the application definition. In the section labeled **Session Settings**, change the the value of **Use Cookie for Session** from **Always** to **Autodetect**. - -![Edit session setting.](../assets/images/edit-webapp.png "edit session setting") - -Save the change. This change is not thought to have any adverse effects on the usage of Portal from ordinary browsers, which continue to use session cookies. - -### Viewing and Editing Source Code on the Server - -Expand the target server, then expand its **Namespaces** folder. Hover over the target namespace to reveal its command buttons: - -![Namespace edit buttons.](../assets/images/namespace-buttons.png "namespace edit buttons") - -- Click the **edit pencil** button to add an *isfs://server:namespace/* folder to your VS Code workspace. -- Click the **viewing eye** button to add an *isfs-readonly://server:namespace/* folder to your VS Code workspace. -- Hold the **alt** or **option** key while clicking the edit or view button to add a folder that gives you access to server-side web application files (for example, CSP files). - -If you want to add a folder that shows only a single project's contents, expand the target namespace and the **Projects** folder to reveal the projects in the target namespace. Hover over the target project to reveal its command buttons: - -![Project edit buttons.](../assets/images/project-buttons.png "project edit buttons") - -- Click the **edit pencil** button to add an *isfs://server:namespace/?project=prjname* folder to your VS Code workspace. -- Click the **viewing eye** button to add an *isfs-readonly://server:namespace/?project=prjname* folder to your VS Code workspace. - -Once you have added a server-side namespace to the workspace, VS Code opens the Explorer view showing the added namespace. The following screen shot shows the **Sample** and **User** packages in the **src** folder on the client, and the **Sample** and **User** packages in the **USER** namespace on the server, with read-only access. - -![Client-side and server-side namespaces.](../assets/images/client-server.png "client-side and server-side namespaces") - -Learn more about isfs and isfs-readonly folders in the section [Configuration for Server-side Editing](../serverside). - -If you are already doing client-side editing of your code, for example, managing it with Git, be sure you understand the consequences of also doing server-side editing using isfs. The ObjectScript extension's README outlines the differences between client-side and server-side editing. If in doubt, limit yourself to isfs-readonly by only using the eye icon. - -### Adding a Server - -You can use the plus sign (`+`) at the top of the view to add a server as described in the section [Configuring a Server](../configuration/#config-server). - -{: #server-context-menu} -### Server Context Menu - -Servers listed in the InterSystems Tools view provide a context menu which provides access to several commands, including storing and clearing passwords in the keychain. - -![Server context menu.](../assets/images/server-context-menu.png "server context menu") - -A submenu enables you to set the color of the icon to the left of the server name. The following screen shot shows this menu, and the icon color set to red. - -![Set icon color.](../assets/images/set-icon-color.png "set icon color") - -### Import Server Connections - -On Windows, the Server Manager can create connection entries for all connections you previously defined with the original Windows app called InterSystems Server Manager. This action is available from the '...' menu at the top right corner of Server Manager's tree, as shown in the following screen shot. - -![Import servers from registry.](../assets/images/import-servers.png "import servers from registry") - -## ObjectScript View - -The InterSystems ObjectScript extension supplies an ObjectScript view container. The button to select this appears in the Activity Bar: - -![ObjectScript button.](../assets/images/objectscript.png "objectscript button") - -This view container contains two views: the ObjectScript Explorer and the Projects Explorer. For more information about the Projects Explorer, see the [Working with Projects](../projects/#explorer) page. - -When a VS Code workspace is not connected to an InterSystems IRIS server, the ObjectScript Explorer provides a button that lets you select a server and namespace. Once the workspace is connected to an InterSystems IRIS server, the ObjectScript Explorer shows files on the server, grouped by type of file. - -If the workspace is configured for server-side editing, the ObjectScript Explorer is not available. In this configuration, the Explorer view lists files on the server, not on the local machine, making the ObjectScript view irrelevant. - -The ObjectScript Explorer provides the following items: - -- **Compile** - Compiles files on the server. -- **Delete** - Deletes files from the server. -- **Export** - Exports files to the workspace on the client. -- **Server Command Menu...** - Pick a command from menus configured on the server. -- **Server Source Control...** - Pick a command from menus configured on the server. - -The InterSystems IRIS documentation section [Extending Studio](https://docs.intersystems.com/irislatest/csp/docbook/Doc.View.cls?KEY=ASC#ASC_Hooks_extending_studio) describes how to configure menus for source code control and other purposes. Entries from menus named **%SourceMenu** and **%SourceContext** appear in the **Server Source Control...** quickpick provided the source control class doesn't disable the entry, for example, disabling checkout if it knows that the file is already checked out. - -Entries from menus with any other name appear in the **Server Command Menu...**. - -## Views and View Containers - -Technically the **InterSystems Tools** and **ObjectScript** entities described above are what VS Code calls [view containers](https://code.visualstudio.com/api/extension-capabilities/extending-workbench#view-container). The **InterSystems Tools** view container has a single view called **Servers**. The **ObjectScript** view container has two views: **Explorer** and **Projects**. - -When a VS Code container has only a single view in it the view header merges with the container header, with the two names separated by a colon. - -Views can be dragged between containers, so for example you could move Explorer off its ObjectScript container and onto the InterSystems Tools container. Or move Servers onto the ObjectScript container. Or move either of them onto VS Code's main Explorer container. - -## Server Connection Status Bar Item - -The connection status of the current server can be seen in the [VS Code status bar](https://code.visualstudio.com/api/ux-guidelines/status-bar). If the server connection is active, the connected server and namespace will be shown in the status bar. If the server connection info is defined in the [`intersystems.servers` setting object](../settings/#intersystems-servermanager), the name of the server and namepsace will be shown: - -![Status bar name](../assets/images/server-status-bar.png "status bar name") - -Otherwise, the host, port and namespace will be shown: - -![Status bar host port](../assets/images/action-for-server-start.png "status bar host port") - -Hover over the status bar item to see more detailed connection information, like a full connection URL and the username of the connection. Click on the status bar item to open the Server Actions menu. Custom entries [can be added](../configuration/#server-actions-menu) to this menu. - -If the server connection is inactive, the connection info or the word `ObjectScript` will be shown, accompanied by an error or warning icon: - -![Status bar error](../assets/images/server-status-bar-error.png "status bar error") - -Hover over the status bar item to see more detailed error information. Click on the status bar item to open a menu that will help you activate your connection. diff --git a/docs/Gemfile b/docs/Gemfile deleted file mode 100644 index f5eb484c..00000000 --- a/docs/Gemfile +++ /dev/null @@ -1,33 +0,0 @@ -source "https://rubygems.org" -# Hello! This is where you manage which Jekyll version is used to run. -# When you want to use a different version, change it below, save the -# file and run `bundle install`. Run Jekyll with `bundle exec`, like so: -# -# bundle exec jekyll serve -# -# This will help ensure the proper Jekyll version is running. -# Happy Jekylling! -# gem "jekyll", "~> 4.1.0" -# This is the theme. -# gem "just-the-docs" -# If you want to use GitHub Pages, remove the "gem "jekyll"" above and -# uncomment the line below. To upgrade, run `bundle update github-pages`. -gem "github-pages", group: :jekyll_plugins -# If you have any plugins, put them here! -gem "kramdown", ">= 2.3.1" -# group :jekyll_plugins do -# gem "jekyll-feed", "~> 0.12" -# end -gem "activesupport", ">=6.1.7.2" - -# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem -# and associated library. -platforms :mingw, :x64_mingw, :mswin, :jruby do - gem "tzinfo", "~> 2.0" - gem "tzinfo-data" -end - -# Performance-booster for watching directories on Windows -gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin] - -gem "webrick" diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock deleted file mode 100644 index ced9084c..00000000 --- a/docs/Gemfile.lock +++ /dev/null @@ -1,282 +0,0 @@ -GEM - remote: https://rubygems.org/ - specs: - activesupport (7.1.3.3) - base64 - bigdecimal - concurrent-ruby (~> 1.0, >= 1.0.2) - connection_pool (>= 2.2.5) - drb - i18n (>= 1.6, < 2) - minitest (>= 5.1) - mutex_m - tzinfo (~> 2.0) - addressable (2.8.6) - public_suffix (>= 2.0.2, < 6.0) - base64 (0.2.0) - bigdecimal (3.1.8) - coffee-script (2.4.1) - coffee-script-source - execjs - coffee-script-source (1.12.2) - colorator (1.1.0) - commonmarker (0.23.10) - concurrent-ruby (1.2.3) - connection_pool (2.4.1) - dnsruby (1.72.1) - simpleidn (~> 0.2.1) - drb (2.2.1) - em-websocket (0.5.3) - eventmachine (>= 0.12.9) - http_parser.rb (~> 0) - ethon (0.16.0) - ffi (>= 1.15.0) - eventmachine (1.2.7) - eventmachine (1.2.7-x64-mingw32) - execjs (2.9.1) - faraday (2.9.0) - faraday-net_http (>= 2.0, < 3.2) - faraday-net_http (3.1.0) - net-http - ffi (1.16.3) - forwardable-extended (2.6.0) - gemoji (4.1.0) - github-pages (231) - github-pages-health-check (= 1.18.2) - jekyll (= 3.9.5) - jekyll-avatar (= 0.8.0) - jekyll-coffeescript (= 1.2.2) - jekyll-commonmark-ghpages (= 0.4.0) - jekyll-default-layout (= 0.1.5) - jekyll-feed (= 0.17.0) - jekyll-gist (= 1.5.0) - jekyll-github-metadata (= 2.16.1) - jekyll-include-cache (= 0.2.1) - jekyll-mentions (= 1.6.0) - jekyll-optional-front-matter (= 0.3.2) - jekyll-paginate (= 1.1.0) - jekyll-readme-index (= 0.3.0) - jekyll-redirect-from (= 0.16.0) - jekyll-relative-links (= 0.6.1) - jekyll-remote-theme (= 0.4.3) - jekyll-sass-converter (= 1.5.2) - jekyll-seo-tag (= 2.8.0) - jekyll-sitemap (= 1.4.0) - jekyll-swiss (= 1.0.0) - jekyll-theme-architect (= 0.2.0) - jekyll-theme-cayman (= 0.2.0) - jekyll-theme-dinky (= 0.2.0) - jekyll-theme-hacker (= 0.2.0) - jekyll-theme-leap-day (= 0.2.0) - jekyll-theme-merlot (= 0.2.0) - jekyll-theme-midnight (= 0.2.0) - jekyll-theme-minimal (= 0.2.0) - jekyll-theme-modernist (= 0.2.0) - jekyll-theme-primer (= 0.6.0) - jekyll-theme-slate (= 0.2.0) - jekyll-theme-tactile (= 0.2.0) - jekyll-theme-time-machine (= 0.2.0) - jekyll-titles-from-headings (= 0.5.3) - jemoji (= 0.13.0) - kramdown (= 2.4.0) - kramdown-parser-gfm (= 1.1.0) - liquid (= 4.0.4) - mercenary (~> 0.3) - minima (= 2.5.1) - nokogiri (>= 1.13.6, < 2.0) - rouge (= 3.30.0) - terminal-table (~> 1.4) - github-pages-health-check (1.18.2) - addressable (~> 2.3) - dnsruby (~> 1.60) - octokit (>= 4, < 8) - public_suffix (>= 3.0, < 6.0) - typhoeus (~> 1.3) - html-pipeline (2.14.3) - activesupport (>= 2) - nokogiri (>= 1.4) - http_parser.rb (0.8.0) - i18n (1.14.5) - concurrent-ruby (~> 1.0) - jekyll (3.9.5) - addressable (~> 2.4) - colorator (~> 1.0) - em-websocket (~> 0.5) - i18n (>= 0.7, < 2) - jekyll-sass-converter (~> 1.0) - jekyll-watch (~> 2.0) - kramdown (>= 1.17, < 3) - liquid (~> 4.0) - mercenary (~> 0.3.3) - pathutil (~> 0.9) - rouge (>= 1.7, < 4) - safe_yaml (~> 1.0) - jekyll-avatar (0.8.0) - jekyll (>= 3.0, < 5.0) - jekyll-coffeescript (1.2.2) - coffee-script (~> 2.2) - coffee-script-source (~> 1.12) - jekyll-commonmark (1.4.0) - commonmarker (~> 0.22) - jekyll-commonmark-ghpages (0.4.0) - commonmarker (~> 0.23.7) - jekyll (~> 3.9.0) - jekyll-commonmark (~> 1.4.0) - rouge (>= 2.0, < 5.0) - jekyll-default-layout (0.1.5) - jekyll (>= 3.0, < 5.0) - jekyll-feed (0.17.0) - jekyll (>= 3.7, < 5.0) - jekyll-gist (1.5.0) - octokit (~> 4.2) - jekyll-github-metadata (2.16.1) - jekyll (>= 3.4, < 5.0) - octokit (>= 4, < 7, != 4.4.0) - jekyll-include-cache (0.2.1) - jekyll (>= 3.7, < 5.0) - jekyll-mentions (1.6.0) - html-pipeline (~> 2.3) - jekyll (>= 3.7, < 5.0) - jekyll-optional-front-matter (0.3.2) - jekyll (>= 3.0, < 5.0) - jekyll-paginate (1.1.0) - jekyll-readme-index (0.3.0) - jekyll (>= 3.0, < 5.0) - jekyll-redirect-from (0.16.0) - jekyll (>= 3.3, < 5.0) - jekyll-relative-links (0.6.1) - jekyll (>= 3.3, < 5.0) - jekyll-remote-theme (0.4.3) - addressable (~> 2.0) - jekyll (>= 3.5, < 5.0) - jekyll-sass-converter (>= 1.0, <= 3.0.0, != 2.0.0) - rubyzip (>= 1.3.0, < 3.0) - jekyll-sass-converter (1.5.2) - sass (~> 3.4) - jekyll-seo-tag (2.8.0) - jekyll (>= 3.8, < 5.0) - jekyll-sitemap (1.4.0) - jekyll (>= 3.7, < 5.0) - jekyll-swiss (1.0.0) - jekyll-theme-architect (0.2.0) - jekyll (> 3.5, < 5.0) - jekyll-seo-tag (~> 2.0) - jekyll-theme-cayman (0.2.0) - jekyll (> 3.5, < 5.0) - jekyll-seo-tag (~> 2.0) - jekyll-theme-dinky (0.2.0) - jekyll (> 3.5, < 5.0) - jekyll-seo-tag (~> 2.0) - jekyll-theme-hacker (0.2.0) - jekyll (> 3.5, < 5.0) - jekyll-seo-tag (~> 2.0) - jekyll-theme-leap-day (0.2.0) - jekyll (> 3.5, < 5.0) - jekyll-seo-tag (~> 2.0) - jekyll-theme-merlot (0.2.0) - jekyll (> 3.5, < 5.0) - jekyll-seo-tag (~> 2.0) - jekyll-theme-midnight (0.2.0) - jekyll (> 3.5, < 5.0) - jekyll-seo-tag (~> 2.0) - jekyll-theme-minimal (0.2.0) - jekyll (> 3.5, < 5.0) - jekyll-seo-tag (~> 2.0) - jekyll-theme-modernist (0.2.0) - jekyll (> 3.5, < 5.0) - jekyll-seo-tag (~> 2.0) - jekyll-theme-primer (0.6.0) - jekyll (> 3.5, < 5.0) - jekyll-github-metadata (~> 2.9) - jekyll-seo-tag (~> 2.0) - jekyll-theme-slate (0.2.0) - jekyll (> 3.5, < 5.0) - jekyll-seo-tag (~> 2.0) - jekyll-theme-tactile (0.2.0) - jekyll (> 3.5, < 5.0) - jekyll-seo-tag (~> 2.0) - jekyll-theme-time-machine (0.2.0) - jekyll (> 3.5, < 5.0) - jekyll-seo-tag (~> 2.0) - jekyll-titles-from-headings (0.5.3) - jekyll (>= 3.3, < 5.0) - jekyll-watch (2.2.1) - listen (~> 3.0) - jemoji (0.13.0) - gemoji (>= 3, < 5) - html-pipeline (~> 2.2) - jekyll (>= 3.0, < 5.0) - kramdown (2.4.0) - rexml - kramdown-parser-gfm (1.1.0) - kramdown (~> 2.0) - liquid (4.0.4) - listen (3.9.0) - rb-fsevent (~> 0.10, >= 0.10.3) - rb-inotify (~> 0.9, >= 0.9.10) - mercenary (0.3.6) - mini_portile2 (2.8.6) - minima (2.5.1) - jekyll (>= 3.5, < 5.0) - jekyll-feed (~> 0.9) - jekyll-seo-tag (~> 2.1) - minitest (5.23.1) - mutex_m (0.2.0) - net-http (0.4.1) - uri - nokogiri (1.16.5) - mini_portile2 (~> 2.8.2) - racc (~> 1.4) - octokit (4.25.1) - faraday (>= 1, < 3) - sawyer (~> 0.9) - pathutil (0.16.2) - forwardable-extended (~> 2.6) - public_suffix (5.0.5) - racc (1.8.0) - rb-fsevent (0.11.2) - rb-inotify (0.11.1) - ffi (~> 1.0) - rexml (3.2.8) - strscan (>= 3.0.9) - rouge (3.30.0) - rubyzip (2.3.2) - safe_yaml (1.0.5) - sass (3.7.4) - sass-listen (~> 4.0.0) - sass-listen (4.0.0) - rb-fsevent (~> 0.9, >= 0.9.4) - rb-inotify (~> 0.9, >= 0.9.7) - sawyer (0.9.2) - addressable (>= 2.3.5) - faraday (>= 0.17.3, < 3) - simpleidn (0.2.3) - strscan (3.1.0) - terminal-table (1.8.0) - unicode-display_width (~> 1.1, >= 1.1.1) - typhoeus (1.4.1) - ethon (>= 0.9.0) - tzinfo (2.0.6) - concurrent-ruby (~> 1.0) - tzinfo-data (1.2021.5) - tzinfo (>= 1.0.0) - unicode-display_width (1.8.0) - uri (0.13.0) - wdm (0.1.1) - webrick (1.7.0) - -PLATFORMS - ruby - x64-mingw32 - -DEPENDENCIES - activesupport (>= 6.1.7.2) - github-pages - kramdown (>= 2.3.1) - tzinfo (~> 2.0) - tzinfo-data - wdm (~> 0.1.1) - webrick - -BUNDLED WITH - 2.2.15 diff --git a/docs/Installation.md b/docs/Installation.md deleted file mode 100644 index 118e718c..00000000 --- a/docs/Installation.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -layout: forward -target: https://docs.intersystems.com/components/csp/docbook/DocBook.UI.Page.cls?KEY=GVSCO -time: 4 - -title: Installation -permalink: /installation/ -nav_order: 2 ---- - -{: .warning } -This documentation has been moved to the [InterSystems Documentation site](https://docs.intersystems.com/components/csp/docbook/DocBook.UI.Page.cls?KEY=GVSCO_install). This page will be removed soon. - -# Installation - -## Install VS Code - -Your first step is to install VS Code: - -1. Go to the [Visual Studio Code download page](https://code.visualstudio.com/). -1. Download an appropriate build for your platform. -1. Open the downloaded file and follow the installation instructions. - -## Install the InterSystems ObjectScript Extensions - -Next, you need to install the following extensions: - -- InterSystems Language Server -- InterSystems ObjectScript -- InterSystems Server Manager - -These extension are grouped together in the InterSystems ObjectScript Extension Pack. Run VS Code. From within the application, click the extensions button in the Activity Bar on the left edge of the VS Code window: - -![Extensions button.](../assets/images/extensions.png "extensions button") - -Type `intersystems` in the search field to find these extensions in the Marketplace, as illustrated in the following screen shot: - -![Search in Marketplace.](../assets/images/marketplace.png "search in marketplace") - -You can install all the required extensions in one step by clicking on the **Install** button for the InterSystems ObjectScript Extension Pack. You can also install each extension separately by clicking the **install** button for the required extension. diff --git a/docs/LowCode.md b/docs/LowCode.md deleted file mode 100644 index 5825315e..00000000 --- a/docs/LowCode.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -layout: forward -target: https://docs.intersystems.com/components/csp/docbook/DocBook.UI.Page.cls?KEY=GVSCO -time: 4 - -title: Low-Code Editors -permalink: /low-code/ -nav_order: 11 ---- - -{: .warning } -This documentation has been moved to the [InterSystems Documentation site](https://docs.intersystems.com/components/csp/docbook/DocBook.UI.Page.cls?KEY=GVSCO_lowcode). This page will be removed soon. - -# Low-Code Editors - -VS Code contains support for low-code editors via its [Custom Editors API](https://code.visualstudio.com/api/extension-guides/custom-editors). As InterSystems redevelops its suite of low-code editors for Interoperability components, support for integration with this extension will be included. This page lists the currently supported low-code editors and describes how to use them in VS Code. - -## Supported Editors - -The following list contains all InterSystems low-code editors that support integration with VS Code, along with the earliest version of InterSystems IRIS that contains the support: - -* Rule Editor (2023.1) - -## Opening a Low-Code Editor - -To open a low-code editor, first open the class that contains the Interoperability component that you want to edit, right-click on the editor tab and select the `Reopen Editor With...` option: - -![Reopen Editor With](../assets/images/reopen-editor-with.png "reopen editor with") - -You will then be prompted with a list of editors to choose from: - -![Select Editor](../assets/images/low-code-select.png "select editor") - -Once you select the editor, it will replace the text editor for the selected class. If the editor cannot be loaded, a modal dialog will be shown that contains the reason and the class will be automatically reopened in the default text editor. A low-code [editor tab](https://code.visualstudio.com/docs/getstarted/userinterface#_tabs) will behave the same as a text editor tab. - -## How They Work - -This section describes how the low-code editors are integrated in VS Code to create a hassle-free editing experience. Note that while low-code editors are supported for both client-side and server-side workflows, an active server connection is required even when working client-side. - -* VS Code sends your credentials to the editor so you don't have to log in again. -* A save, undo, redo or revert action triggered by VS Code (via keyboard shortcuts, for example) will trigger the corresponding action in the editor. -* When the state of the class changes from clean to dirty (or vice versa) in the editor, the underlying text document will also be made dirty/clean. -* When the class is saved or compiled by the editor, VS Code will pull the changes from the server and update the text document. -* If the `objectscript.compileOnSave` setting is enabled and the class was saved by the editor, the class will also be compiled by the editor. - -Note that the changes you make in the low-code editor are only synced to the underlying text document when you save them in the editor. Therefore, it is ***strongly*** recommended that you only open and edit the document in one editor (text or low-code) at once to avoid overwriting changes. The low-code editors provide support for server-side source control natively. The underlying text document is kept in sync after saves so changes can be stored in client-side source control. diff --git a/docs/Projects.md b/docs/Projects.md deleted file mode 100644 index 56c8d00c..00000000 --- a/docs/Projects.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -layout: forward -target: https://docs.intersystems.com/components/csp/docbook/DocBook.UI.Page.cls?KEY=GVSCO -time: 4 - -title: Working with Projects -permalink: /projects/ -nav_order: 9 ---- - -{: .warning } -This documentation has been moved to the [InterSystems Documentation site](https://docs.intersystems.com/components/csp/docbook/DocBook.UI.Page.cls?KEY=GVSCO_project). This page will be removed soon. - -# Working with Projects - -A project is a named set of class definitions, routines, include files, web application files or custom documents. All files in a project must be in the same namespace on the same InterSystems server. Each document can be associated with any number of projects. Each namespace can contain any number of projects. - -## Why Projects? - -You are not required to use projects in VS Code, but you should consider using them if: - -* You work [server-side](../serverside) and the `type` and `filter` [query parameters](../serverside/#filters-and-display-options) are not granular enough. -* You work server-side and want to edit CSP and non-CSP files in the same workspace folder. -* You work client-side and want to group together many files to export with a single click. -* You are migrating from InterSystems Studio and want to keep using an existing project. - -{: #explorer} -## Projects Explorer - -The easiest way to manage projects is using the Projects Explorer, which is in the [ObjectScript view](../extensionui/#objectscript-view): - -![Projects Explorer](../assets/images/projects-explorer.png "projects explorer") - -Initally, the Projects explorer contains a root node for each server and namespace connection that exists for the current workspace. It can be expanded to show all projects in that namespace on the server, and expanding the project node will show its contents: - -![Projects Explorer Expanded](../assets/images/projects-explorer-expanded.png "projects explorer expanded") - -You can also add root nodes for namespaces on any server configured using the InterSystems Server Manager extension. To do so, click on the plus (`+`) button at the top of the view. - -The following sections will describe how to use the Projects Explorer and other tools to work with projects. - -{: #creating} -## Creating Projects - -There are two ways to create projects in VS Code: - -* Right-click on a server-namespace node in the Projects Explorer and select the `Create Project` menu option. -* Open the command palette and run the `ObjectScript: Create Project` command. - -Project names are required to be unique per server-namespace and may optionally have a description. The description is shown when hovering over the project's node in the Projects Explorer or below its name when selecting one in a dropdown menu. - -{: #modifying} -## Modifying Projects - -There are three ways to add or remove items from a project: - -* Using the Projects Explorer: - * To add items, right-click on the project node or one of the document type nodes (i.e. `Classes` or `Routines`) and select the `Add Items to Project...` menu option. If you clicked on a document type node, you will only be shown documents of that type to add. - * To remove an item, right-click on its node and select the `Remove from Project` menu option. If you remove a package or directory node, all of its children will also be removed from the project. You may also right-click on the project node and select the `Remove Items from Project...` menu option to be presented with a multi-select dropdown that allows you to remove multiple items at once. -* Within a workspace folder configured to view or edit documents in a project directly on the server: - * To add items, right-click a root `isfs(-readonly)` folder that has the `project` query parameter in its URI and select the `Add Items to Project...` menu option. - * To remove an item, right-click on its node and select the `Remove from Project` menu option. If you remove a package or directory node, all of its children will also be removed from the project. You may also right-click on a root `isfs(-readonly)` folder that has the `project` query parameter in its URI and select the `Remove Items from Project...` menu option to be presented with a multi-select dropdown that allows you to remove multiple items at once. -* Using commands: - - Open the command palette and select the `ObjectScript: Add Items to Project...` or `ObjectScript: Remove Items from Project...` command. - -### Add to Project UI - -The `Add to Project` command implements a custom multi-select dropdown that is shown regardless of how it is invoked. Items that are in the namespace and not already in the project are shown. The elements of this UI are described in more detail below: - -![Add to Project UI](../assets/images/add-to-project.png "add to project UI") - -* Title bar row: - * Click the icons to show or hide system and generated items, respectively. -* Input box row: - * Click the check box to select all items that are currently shown. - * Type in the input box to filter the items that are shown. - * Click the **OK** button to add the selected items to the project. -* Item rows: - * Click the check box to select the item. If the item is a package or CSP directory, all of its contents will be selected as well, even though the check boxes for those items don't appear selected. - * The icon preceding the name represents its type. It corresponds to the icons in the Projects Explorer and [ObjectScript Explorer](../extensionui/#objectscript-view). - * The more prominent text is the short name of the item, as it would appear in a file system. - * The less prominent text is the full name of the item, including its package or CSP directory. - * Click the arrow icon at the far right of the row to show or hide its contents. - -{: #deleting} -## Deleting Projects - -There are two ways to delete projects in VS Code: - -* Right-click on a project node in the Projects Explorer and select the `Delete Project` menu option. -* Open the command palette and run the `ObjectScript: Delete Project` command. - -{: #server-side} -## Editing Project Contents Server-Side - -There are a few methods to create a workspace folder to view or edit documents in a project directly on the server: - -* Follow the steps [here](../serverside/#config-server-side) and select the project. -* Right-click in the [Explorer view](../extensionui/#explorer-view) and select the `Add Server Namespace to Workspace` menu option. -* Use the InterSystems Tools view, as described [here](../extensionui/#viewing-and-editing-source-code-on-the-server). -* Right-click on a project node in the [Projects Explorer](../projects/#explorer) and select the `Add Workspace Folder For Project` menu option. -* Add a folder to your `.code-workspace` file directly: -```json -{ - "uri": "isfs://myserver:user/?project=prjname", - "name": "prjname" -} -``` - -{: #client-side} -## Editing Project Contents Client-Side - -The entire contents of the project can be easily exported to your local file system for client-side editing. To do so, simply right-click on the project you'd like to export and select the `Export Project Contents` menu option. - -## Notes - -If you are getting `ERROR #5540: SQLCODE: -99 Message: User abc is not privileged for the operation` when you try to expand the Projects Explorer or view a project's contents in a virtual folder, then grant user abc (or a SQL role they hold) the following SQL permissions: - -```SQL -GRANT SELECT, INSERT, UPDATE, DELETE ON %Studio.Project, %Studio.ProjectItem TO abc -GRANT EXECUTE ON %Studio.Project_ProjectItemsList TO abc -``` diff --git a/docs/ReportingIssues.md b/docs/ReportingIssues.md deleted file mode 100644 index 662ee54d..00000000 --- a/docs/ReportingIssues.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -layout: forward -target: https://docs.intersystems.com/components/csp/docbook/DocBook.UI.Page.cls?KEY=GVSCO -time: 4 - -title: Reporting Issues -permalink: /feedback/ -nav_order: 8 ---- - -{: .warning } -This documentation has been moved to the [InterSystems Documentation site](https://docs.intersystems.com/components/csp/docbook/DocBook.UI.Page.cls?KEY=GVSCO_reporting). This page will be removed soon. - -# Reporting Issues - -[InterSystems ObjectScript for VS Code](https://docs.intersystems.com/components/csp/docbook/DocBook.UI.Page.cls?KEY=GVSCO) consists of three collaborating VS Code extensions. This modular architecture also means there are three different GitHub repositories where issues can be created. Fortunately VS Code itself helps with the task. You will need a GitHub account. Here's how: - -1. From the Help menu in VS Code choose 'Report Issue'. Alternatively, open the Command Palette and run `Help: Report Issue...`. - -2. When the dialog appears, use the first dropdown to classify your issue: - - Bug Report - - Feature Request - - Performance Issue - -3. In the second dropdown pick 'An extension' - -4. The third dropdown lets you pick one of your installed extensions. You can type a few characters to find the right entry. For example, `isls` quickly selects "InterSystems Language Server". - - Which one to choose? Here's a guide: - - InterSystems Language Server - - code coloring - - Intellisense - - InterSystems ObjectScript - - export, import and compile - - ObjectScript Explorer (browsing namespace contents) - - direct server-side editing using `isfs://` folders in a workspace - - integration with server-side source control etc - - InterSystems Server Manager - - Server Browser on the InterSystems Tools view - - password management in local keychain - - definition and selection of entries in `intersystems.servers` - - If unsure, pick InterSystems ObjectScript. - -5. Type a descriptive one-line summary of your issue. The dialog may offer a list of existing issues which could be duplicates. If you don't find one that covers yours, proceed. - -6. Enter details. If your VS Code is authenticated to GitHub the dialog's button is captioned "Create on GitHub" and clicking it will open the issue, then load it in your browser so you can edit it. Otherwise it reads "Preview on GitHub" and launches a browser page where you must complete and submit your report. - - Tips for use on the GitHub page: - - - Paste images from your clipboard directly into the report field. For hard-to-describe issues an animated GIF or a short MP4 gets bonus points. The `Developer: Toggle Screencast Mode` in VS Code can help your recording make more sense. - - Link to other issues by prefixing the target number with # - - Remember that whatever you post here is visible to anyone on the Internet. Mask/remove confidential information. Be polite. diff --git a/docs/RunDebug.md b/docs/RunDebug.md deleted file mode 100644 index 8d789d34..00000000 --- a/docs/RunDebug.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -layout: forward -target: https://docs.intersystems.com/components/csp/docbook/DocBook.UI.Page.cls?KEY=GVSCO -time: 4 - -title: Running and Debugging -permalink: /rundebug/ -nav_order: 5 ---- - -{: .warning } -This documentation has been moved to the [InterSystems Documentation site](https://docs.intersystems.com/components/csp/docbook/DocBook.UI.Page.cls?KEY=GVSCO_debug). This page will be removed soon. - -# Running and Debugging - -The InterSystems ObjectScript Extension provides support for ObjectScript debugging. It takes advantage of the debugging capabilities built into VS Code, so you may find these VS Code documentation resources useful: - -- [Debugging Intro Video](https://code.visualstudio.com/docs/introvideos/debugging) -- [Debugging User Guide](https://code.visualstudio.com/docs/editor/debugging) - -Also, InterSystems Learning Services has produced [a short video](https://learning.intersystems.com/course/view.php?id=1795&ssoPass=1) which walks through the steps in this documentation page that you may find useful. - -## Debug Configurations - -In order to run or debug an ObjectScript class or routine or attach to a running process, you must create a debug configuration. Some other languages default to running the currently active file, but to run ObjectScript, you must specify the routine or ClassMethod to use or the running process to attach to. - -Click the run button in the Activity Bar: - -![Run button.](../assets/images/run.png "run button") - -If no debug configurations are available, you are prompted to create one: - -![Create debug configuration.](../assets/images/CreateLaunchConfig.png "create debug configuration") - -Clicking the link opens a dialog containing a list of debug environments. Select **ObjectScript Debug**. - -![Select debug environment.](../assets/images/debug-environment.png "select debug environment") - -Once you have chosen a debug environment, VS Code creates and opens a `launch.json` file containing the following default content: - -```json -{ - "version": "0.2.0", - "configurations": [ - { - "type": "objectscript", - "request": "launch", - "name": "XDebug" - } - ] -} -``` - -These attributes are mandatory for any debug configuration: - -- **type** - Identifies the type of debugger to use. In this case, `objectscript`, supplied by the InterSystems ObjectScript extension. -- **request** - Identifies the type of action for this launch configuration. Possible values are `launch` and `attach`. -- **name** - An arbitrary name to identify the configuration. This name appears in the Start Debugging drop down list. - -In addition, for an **objectscript launch** configuration, you need to supply the attribute **program**, which specifies the routine or ClassMethod to run when launching the debugger, as shown in the following example: - -```json -"launch": { - "version": "0.2.0", - "configurations": [ - - { - "type": "objectscript", - "request": "launch", - "name": "ObjectScript Debug HelloWorld", - "program": "##class(Test.MyClass).HelloWorld()", - }, - { - "type": "objectscript", - "request": "launch", - "name": "ObjectScript Debug GoodbyeWorld", - "program": "##class(Test.MyOtherClass).GoodbyeWorld()", - }, - ] -} -``` - -For an **objectscript attach** configuration, you may supply the following attributes: - -- **processId** - Specifies the ID of process to attach to as a `string` or `number`. Defaults to `"${command:PickProcess}"`, which provides a dropdown list of process ID's to attach to at runtime. -- **system** - Specifies whether to allow attaching to system process. Defaults to `false`. - -The following example shows multiple valid **objectscript attach** configurations: - -```json -"launch": { - "version": "0.2.0", - "configurations": [ - { - "type": "objectscript", - "request": "attach", - "name": "Attach 1", - "processId": 5678 - }, - { - "type": "objectscript", - "request": "attach", - "name": "Attach 2", - "system": true - }, - ] -} -``` - -## Starting a Debugging Session - -You can select a debug configuration from the list VS Code provides in the Run and Debug field at the top of the debug side bar: - -![Select debug configuration.](../assets/images/select-config.png "select debug configuration") - -Clicking on the green arrow runs the currently selected debug configuration. - -When starting **objectscript launch** debug session, make sure that the file containing the **program** that you are debugging is open in your editor and is the active tab. VS Code will start a debug session with the server of the file in the active editor (the tab that the user is focused on). This also applies to **objectscript attach** debug sessions. - -This extension uses WebSockets to communicate with the InterSystems server during debugging. If you are experiencing issues when trying to start a debugging session, check that the InterSystems server's web server allows WebSocket connections. - -Debugging commands and items on the **Run** menu function much as they do for other languages supported by VS Code. For information on VS Code debugging, see the documentation resources listed at the start of this section. - -{: #rest} -## Debugging a REST Service - -The InterSystems ObjectScript Extension provides a [Webview](https://code.visualstudio.com/api/extension-guides/webview)-based graphical user interface that allows you to send a REST request and automatically start debugging the process on the server that handles it. With the InterSystems file that you want to debug open in the active text editor, you can show the GUI using the `Debug REST Service...` command. The command can be accessed in the command palette, editor context menu or editor tab context menu. Follow the directions in the GUI to build your REST request and click the `Start Debugging` button to send the request and connect the debugger. Be sure you have a breakpoint set somewhere in the code that handles the request. - -## Troubleshooting Debugger Issues - -If you are experiencing issues using the debugger, please follow these steps before opening an issue on GitHub. Note that the trace global may contain confidential information, so you should review the contents and mask/remove anything that you want to keep private. - -1. Open a terminal on your server and `zn` to the namespace containing the class or routine you are debugging. -2. Run the command `Kill ^IRIS.Temp.Atelier("debug")`, then `Set ^IRIS.Temp.Atelier("debug") = 1` to turn on the Atelier API debug logging feature. If you are on Caché or Ensemble, the global is `^CacheTemp.ISC.Atelier("debug")`. -3. In VS Code, start a debugging session using the configuration that produces the error. -4. Once the error appears, copy the contents of the `^IRIS.Temp.Atelier("debug")` global and add it to your GitHub issue. -5. After you capture the log, run the command `Kill ^IRIS.Temp.Atelier("debug")`, then `Set ^IRIS.Temp.Atelier("debug") = 0` to turn logging back off again. - -{: #terminal} -## Using the WebSocket Terminal - -The InterSystems ObjectScript Extension provides support for a WebSocket-based command-line interface for executing ObjectScript commands on a connected server. The server can be on the same system as VS Code, or a remote system. This feature is only supported when connecting to InterSystems IRIS version 2023.2 or later. - -The WebSocket terminal supports the following features: - -- VS Code's [shell integration](https://code.visualstudio.com/docs/terminal/shell-integration) feature so your command history and output will be captured by VS Code and can be accessed by its UI. -- Multi-line editing. An additional editable line will be added when the user presses `Enter` and there are unclosed `{` or `(` in the command input. -- Syntax coloring for command input. (Toggleable using the `objectscript.webSocketTerminal.syntaxColoring` setting) -- Syntax checking for entered command input with detailed error messages reported along with the standard `` error. -- Many features of the [standard terminal](https://docs.intersystems.com/irislatest/csp/docbook/DocBook.UI.Page.cls?KEY=GTER_intro), including: - - The Read command - - Interrupts (`Ctrl-C`) - - Namespace switches - - [Custom terminal prompts](https://irisdocs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?LIBRARY=%25SYS&CLASSNAME=%25SYSTEM.Process#TerminalPrompt) (except code 7) - - Shells like SQL (`Do $SYSTEM.SQL.Shell()`) and Python (`Do $SYSTEM.Python.Shell()`) - -The WebSocket terminal does not support [command-line debugging](https://docs.intersystems.com/irislatest/csp/docbook/DocBook.UI.Page.cls?KEY=GCOS_debug) since the InterSystems ObjectScript Extension contains an interactive debugger. Users are also discouraged from using [routine editing commands](https://docs.intersystems.com/irislatest/csp/docbook/DocBook.UI.Page.cls?KEY=RCOS_ZCOMMANDS) since VS Code with the InterSystems ObjectScript Extension Pack provides an excellent ObjectScript editing experience. - -Note that the terminal process is started using the JOB command, so if you have a [`^%ZSTART` routine](https://docs.intersystems.com/iris20223/csp/docbook/Doc.View.cls?KEY=GSTU_customize_startstop) enabled the `JOB` subroutine will be called at the start of the process, not `LOGIN` like the standard terminal. Also, the [`ZWELCOME` routine](https://docs.intersystems.com/irislatest/csp/docbook/DocBook.UI.Page.cls?KEY=GTER_intro#GTER_zwelcome) will not be run before the first command prompt is shown. - -The WebSocket terminal can be opened from [the command palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette) using the `ObjectScript: Launch WebSocket Terminal` command. The WebSocket terminal connection will be established using the current server connection. A WebSocket terminal connection can also be opened from the [Terminal Profiles menu](https://code.visualstudio.com/docs/terminal/basics#_terminal-shells). - -## Troubleshooting WebSocket Terminal Issues - -If you are experiencing issues using the WebSocket terminal, please follow these steps before opening an issue on GitHub. Note that the trace global may contain confidential information, so you should review the contents and mask/remove anything that you want to keep private. - -1. Open a standard terminal on your server and `zn` to the namespace containing the class or routine you are debugging. -2. Run the command `Kill ^IRIS.Temp.Atelier("terminal")`, then `Set ^IRIS.Temp.Atelier("terminal") = 1` to turn on the Atelier API terminal logging feature. -3. In VS Code, launch the WebSocket terminal and run the commands that produce the error. -4. Once the error appears, copy the contents of the `^IRIS.Temp.Atelier("terminal")` global and add it to your GitHub issue. -5. After you capture the log, run the command `Kill ^IRIS.Temp.Atelier("terminal")`, then `Set ^IRIS.Temp.Atelier("terminal") = 0` to turn logging back off again. diff --git a/docs/ServerSide.md b/docs/ServerSide.md deleted file mode 100644 index 0f919007..00000000 --- a/docs/ServerSide.md +++ /dev/null @@ -1,228 +0,0 @@ ---- -layout: forward -target: https://docs.intersystems.com/components/csp/docbook/DocBook.UI.Page.cls?KEY=GVSCO -time: 4 - -title: Server-side Editing -permalink: /serverside/ -nav_order: 6 ---- - -{: .warning } -This documentation has been moved to the [InterSystems Documentation site](https://docs.intersystems.com/components/csp/docbook/DocBook.UI.Page.cls?KEY=GVSCO_ssworkflow). This page will be removed soon. - -# Server-side Editing - -You can configure the InterSystems ObjectScript extension to edit code directly on the server, using the [multi-root workspaces](https://code.visualstudio.com/docs/editor/multi-root-workspaces) VS Code feature. This type of configuration is useful in cases where source code is stored in a Source Code Management (SCM) product interfaced to the server. For example you might already be using the Source Control menu in InterSystems Studio or Portal, implemented by a source control class that extends `%Studio.SourceControl.Base`. - -{: #config-server-side} -## Configuring for Server-side Editing - -First configure the `intersystems.servers` entry for your server, as described in [Configuring a Server](../configuration#config-server). - -Next create a workspace for editing code directly on the server: - -1. Open VS Code. You must perform the following steps starting with no folder or workspace open, so if a folder or workspace is already open, close it. -1. Open the Explorer view if it is not already visible. -1. Click the button labeled **Choose Server and Namespace** in the Explorer view, as shown in the following screen shot: - - ![Explorer view.](../assets/images/ss-explorer-view.png "explorer view") -1. Pick a server from the list, or click the **+** sign to create a new server configuration: - - ![Choose a server.](../assets/images/ss-choose-server.png "choose a server") -1. Enter credentials if prompted. -1. Pick a namespace from the list retrieved from the target server: - - ![Choose a namespace.](../assets/images/ss-choose-namespace.png "choose a namespace") -1. Pick an access mode from the list: - - ![Choose an access type.](../assets/images/ss-access-type.png "choose an access type") -1. Pick the files to show: - - ![Choose files.](../assets/images/ss-files.png "choose files") - - If you chose to show web application files, pick an optional web application to show files from: - - ![Choose web app.](../assets/images/ss-pick-webapp.png "choose web app") - - If you chose to show a project's contents, pick the project: - - ![Choose project.](../assets/images/ss-pick-project.png "choose project") - - If you create your own filter, pick the filter options: - - ![Choose filter options.](../assets/images/ss-query-params.png "choose filter options") -1. If you want to reopen this workspace in the future, use the command **File > Save Workspace As...** to save it as a `.code-workspace` file. - -Note that the ObjectScript Explorer view is not visible in the ObjectScript view container. Because the files listed in the Explorer view are all on the server, the ObjectScript Explorer is not needed for this configuration. - -The `.code-workspace` file is a JSON file which you can edit directly, as described in the section [VS Code Workspaces](../configuration/#code-workspaces). A simple example looks like this: -```json -{ - "folders": [ - { - "name": "iris184:USER", - "uri": "isfs://iris184:user" - } - ], - "settings": {} -} -``` -- The `name` property provides a name for this server-side folder. -- The `uri` property indicates the location of resources on the server. The supplied value has three components: - - The first component can be either `isfs` or `isfs-readonly`. These values specify that this folder is on an InterSystems IRIS server. `isfs-readonly` specifies read-only access. - - The value following `/` specifies the name of the server. - - The value following `:` specifies the namespace (lowercase). - -The string `isfs` which appears in the **uri** for folders configured for server-side editing is an abbreviation created by InterSystems which stands for **InterSystems File Service**. It implements the VS Code [FileSystemProvider API](https://code.visualstudio.com/api/references/vscode-api#FileSystemProvider), which lets you make any remote location look like a local one. It works well for making artefacts in an InterSystems IRIS namespace look like local files. - -To add more root folders to your workspace, giving you access to code in a different namespace, or on a different server, use the context menu on your existing root folder to invoke the `Add Server Namespace to Workspace...` command. This command is also available on the Command Palette. - -An example of a two-folder workspace in which the second folder gives read-only access to the %SYS namespace: -```json -{ - "folders": [ - { - "name": "iris184:USER", - "uri": "isfs://iris184:user" - }, - { - "name": "iris184:%SYS (read-only)", - "uri": "isfs-readonly://iris184:%sys" - } - ], - "settings": {} -} -``` - -Workspaces can also consist of a mixture of server-side folders and local folders. Use the context menu's `Add Folder to Workspace...` option to add a local folder. - -Root folders can be re-sequenced using drag/drop in the Explorer view, or by editing the order their definition objects appear within the `folders` array in the JSON. - -## Configuring Storage for Folder-specific Settings - -When you use VS Code to edit source code on the client, the settings model allows you to specify folder-specific settings in a `.vscode\settings.json` file located in a workspace root folder. These settings take precedence when you work under that workspace root folder. - -If you use an isfs-type workspace to operate directly in a namespace on a server, you need to configure that server to support storing and serving up the `.vscode\settings.json` file. The `.vscode` subfolder of a workspace root folder also stores folder-specific code snippets and debug configurations. These are available when using this configuration. - -Use the **Management Portal** to create a web application named **_vscode** on the server. Select **System Administration > Security > Applications > Web Applications**, then **Create New Web Application**: - -![Create a web application.](../assets/images/web-app.png "create a web application") - -Enter the following values: - -- **Name** - /_vscode -- **Description** - enter a brief description -- **Namespace** - select **%SYS** -- **Enable Application** - select -- **Enable** - select **CSP/ZEN** -- **Allowed Authentication Methods** - select **Password** -- **CSP File Settings: Physical Path** - enter a physical path appropriate for your platform and install folder -- **CSP File Settings: Web Settings** - Clear **Auto Compile** - -Be sure to save the configuration. If you have an isfs-type workspace root folder that connects to a namespace on this server, it can now write and read folder-specific settings: - -![The server settings folder.](../assets/images/ss-settings-folder.png "the server settings folder") - -You can also create a folder-specific snippets file via **Preferences: Configure User Snippets**: - -![server-side snippets.](../assets/images/ss-snippets.png "server-side snippets") - -To edit the server-side namespace-specific files for all namespaces directly through VS Code, add an isfs-type root folder with the following uri: - -``` -isfs://servername:%sys/_vscode?csp -``` - -For a single namespace (for example, USER): - -``` -isfs://servername:%sys/_vscode/USER?csp -``` - -## Web Application (CSP) Files - -To edit web application files (also known as CSP files) on a server, configure the uri as `isfs://myserver:xxx{csp_application}?csp` - -For example, the following uri gives you access to the server-side files of the `/csp/user` application. The `csp` query parameter is mandatory and the suffix on the server name must specify the correct namespace for the web application. - -``` -"uri": "isfs://myserver:user/csp/user?csp" -``` - -Changes you make to files opened from this root folder of your VS Code workspace will be saved onto the server. - -## Filters and Display Options - -The query string of the `uri` property accepts several parameters that control filtering and display of the server-side entities. The examples below access the USER namespace on the server whose definition is named 'myserver'. - -- `isfs://myserver:user/?generated=1`, shows generated files as well as not generated -- `isfs://myserver:user/?filter=%Z*.mac,%z*.mac`, comma-delimited list of search options. The default is `*.cls,*.inc,*.mac,*.int`. To see all files, use `*`. -- `isfs://myserver:user/?project=prjname`, shows only files in project `prjname`. Cannot be combined with any other parameter. -- `isfs://myserver:user/?mapped=0`, hides files that are mapped from a non-default database - -The options `generated` and `mapped` can be combined with each other, and with `filter`. - -To modify the query parameters or name of an existing workspace folder, run the `Modify Server-Side Workspace Folder...` command from the command palette or the file explorer context menu. - -## Advanced Workspace Configurations - -This section gives examples of some more complex workspace definitions for server-side editing. - -Use **File > New File** to create a new file. Add content similar to the following example. Note that `my-project` in the `isfs://` uri, should be the same as the `name` property (i.e. the root display name) of any local folder where specialized settings for the connection are being stored in a `.vscode/settings.json` file. - -```json -{ - "folders": [ - { - "name": "my-project", - "path": ".", - }, - { - "uri": "isfs://my-project", - "name": "server" - } - ], - "settings": { - } -} -``` - -Save the file, giving it an arbitrary name with the extension `.code-workspace`. VS Code shows you a button with an offer to open this workspace. Click the button. - -When VS Code starts next, you see two folders in the root with the names described in the .code-workspace file. Expand the `server` folder to see code on the 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 the way, to export files in the same location which used in VS Code workspace. - -Example with connection to different namespaces on the same server. -```json -{ - "folders": [ - { - "name": "myapp", - "path": ".", - }, - { - "uri": "isfs://myapp", - "name": "server", - }, - { - "uri": "isfs://myapp:user", - "name": "user", - }, - { - "uri": "isfs://myapp:%sys", - "name": "system", - }, - { - "uri": "isfs://user@hostname:port?ns=%SYS", - "name": "system (alternative syntax)", - } - ], - "settings": { - "files.exclude": {}, - "objectscript.conn": { - "active": true, - "username": "_system", - "password": "SYS", - "ns": "MYAPP", - "port": 52773, - } - } -} -``` diff --git a/docs/SettingsReference.md b/docs/SettingsReference.md deleted file mode 100644 index 993ea1b3..00000000 --- a/docs/SettingsReference.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -layout: forward -target: https://docs.intersystems.com/components/csp/docbook/DocBook.UI.Page.cls?KEY=GVSCO -time: 4 - -title: Settings Reference -permalink: /settings/ -nav_order: 7 ---- - -{: .warning } -This documentation has been moved to the [InterSystems Documentation site](https://docs.intersystems.com/components/csp/docbook/DocBook.UI.Page.cls?KEY=GVSCO_settings). This page will be removed soon. - -# Settings Reference - -The extensions in the InterSystems ObjectScript Extension Pack provide many settings that allow you to configure their behavior. Below you will find a table containing all settings for each extension in the pack, as well as a short description, the type of value they accept, the default value and any other notes that may be useful to you. Please see [this VS Code documentation page](https://code.visualstudio.com/docs/getstarted/settings) for more information about settings and how to change them. - -{: #language-server} -## InterSystems Language Server - -| Setting | Description | Type | Default | Notes | -| ------- | ----------- | ---- | ------- | ----- | -| `"intersystems.language-server.diagnostics.classes"` | Controls whether error diagnostics are provided when a class that is being referred to doesn't exist in the database. | `boolean` | `true` | | -| `"intersystems.language-server.diagnostics.deprecation"` | Controls whether strikethrough warning diagnostics are provided when a class or class member that is being referred to is deprecated. | `boolean` | `true` | | -| `"intersystems.language-server.diagnostics.parameters"` | Controls whether warning diagnostics are provided when a class Parameter has an invalid type or the assigned value of the Parameter doesn't match the declared type. | `boolean` | `true` | | -| `"intersystems.language-server.diagnostics.routines"` | Controls whether error diagnostics are provided when a routine or include file that is being referred to doesn't exist in the database. | `boolean` | `false` | | -| `"intersystems.language-server.diagnostics.suppressSyntaxErrors"` | Controls the languages that syntax error diagnosics will be suppressed for. | `array` | `[]` | Each array element must be one of `"COS"`, `"SQL"`, `"CLS"`, `"HTML"`, `"PYTHON"`, `"XML"`, `"JAVA"`, `"JAVASCRIPT"` or `"CSS"`. | -| `"intersystems.language-server.diagnostics.zutil"` | Controls whether diagnostics are provided when a deprecated or superseded `$ZUTIL` function is being called. | `boolean` | `true` | | -| `"intersystems.language-server.formatting.commands.case"` | Controls the case that ObjectScript commands will be changed to during a document formatting request. | `"upper"`, `"lower"` or `"word"` | `"word"` | | -| `"intersystems.language-server.formatting.commands.length"` | Controls the length that ObjectScript commands will be changed to during a document formatting request. | `"short"` or `"long"` | `"long"` | | -| `"intersystems.language-server.formatting.expandClassNames"` | Controls whether short class names will be expanded to include a package during a document formatting request. | `boolean` | `false` | | -| `"intersystems.language-server.formatting.system.case"` | Controls the case that ObjectScript system functions and variables will be changed to during a document formatting request. | `"upper"`, `"lower"` or `"word"` | `"upper"` | | -| `"intersystems.language-server.formatting.system.length"` | Controls the length that ObjectScript system functions and variables will be changed to during a document formatting request. | `"short"` or `"long"` | `"long"` | | -| `"intersystems.language-server.hover.commands"` | Controls whether hover information is provided for ObjectScript commands. | `boolean` | `true` | | -| `"intersystems.language-server.hover.preprocessor"` | Controls whether hover information is provided for ObjectScript preprocessor directives. | `boolean` | `true` | | -| `"intersystems.language-server.hover.system"` | Controls whether hover information is provided for ObjectScript system functions and variables. | `boolean` | `true` | | -| `"intersystems.language-server.refactor.exceptionVariable"` | The name of the exception variable inserted in a 'Wrap in Try/Catch' refactor. | `string` | `"ex"` | | -| `"intersystems.language-server.signaturehelp.documentation"` | Controls whether documentation for a method is shown when a SignatureHelp is active. | `boolean` | `true` | This setting does not affect documentation for macro SignatureHelp views, which is always shown. | -| `"intersystems.language-server.suggestTheme"` | Controls whether the extension will suggest that one of the InterSystems default themes be used if neither one is active upon extension activation. | `boolean` | `true` | | -| `"intersystems.language-server.trace.server"` | Traces the communication between VS Code and the language server. | `"off"`, `"messages"` or `"verbose"` | `"off"` | Any trace information will be logged to the `InterSystems Language Server` Output channel. | - -{: #vscode-objectscript} -## InterSystems ObjectScript - -| Setting | Description | Type | Default | Notes | -| ------- | ----------- | ---- | ------- | ----- | -| `"objectscript.autoPreviewXML"` | Automatically preview XML export files in UDL format. | `boolean` | `false` | | -| `"objectscript.autoShowTerminal"` | Automatically show terminal when connected to docker-compose. | `boolean` | `false` | | -| `"objectscript.compileFlags"` | Compilation flags. | `string` | `"cuk"` | Common compilation flags are ***b*** (compile dependent classes), ***k*** (keep generated source code) and ***u*** (skip related up-to-date documents). For descriptions of all available flags and qualifiers, click [here](https://docs.intersystems.com/irislatest/csp/docbook/Doc.View.cls?KEY=RCOS_vsystem#RCOS_vsystem_flags_qualifiers). | -| `"objectscript.compileOnSave"` | Automatically compile an InterSystems file when saved in the editor. | `boolean` | `true` | | -| `"objectscript.conn"` | Configures the active server connection. | `object` | `undefined` | See the [Configuration page](../configuration/#config-server-conn) for more details on configuring server connections. | -| `"objectscript.conn.ns"` | InterSystems server's namespace to use. | `string` | `undefined` | | -| `"objectscript.conn.active"` | Should the connection be active on startup. | `boolean` | `false` | | -| `"objectscript.conn.username"` | InterSystems server's user name. | `string` | `undefined` | | -| `"objectscript.conn.password"` | InterSystems server's password. | `string` | `undefined` | It's not recommended to specify your password in a config file except when you are using the default password | -| `"objectscript.conn.server"` | InterSystems server's name in Server Manager settings from which to get connection info. | `string` | `undefined` | Specify only `ns` and `active` when using this setting. See the [Server Manager README](https://github.com/intersystems-community/intersystems-servermanager) for more details. | -| `"objectscript.conn.docker-compose"` | Configures the active server port using information from a file which must be named `docker-compose.yml` in the project's root directory. | `object` | `undefined` | | -| `"objectscript.conn.docker-compose.service"` | InterSystems service's name in `docker-compose.yml`. | `string` | `undefined` | | -| `"objectscript.conn.docker-compose.internalPort"` | InterSystems service's internal port in `docker-compose.yml`. | `object` | `undefined` | This should almost always be 52773 unless your IRIS server is configured in a non-standard way | -| `"objectscript.debug.copyToClipboard"` | Show inline `Copy Invocation` CodeLens action for ClassMethods and Routine Labels. | `boolean` | `true` | | -| `"objectscript.debug.debugThisMethod"` | Show inline `Debug` CodeLens action for ClassMethods and Routine Labels. | `boolean` | `true` | | -| `"objectscript.explorer.alwaysShowServerCopy"` | Always show the server copy of a document in the ObjectScript Explorer. | `boolean` | `false` | | -| `"objectscript.export"` | Configures the files that the `Export Code from Server` command will export from the server to the local workspace folder. | `object` | `undefined` | | -| `"objectscript.export.addCategory"` | Add a category folder to the beginning of the export path. | `boolean` or `object` | `false` | | -| `"objectscript.export.atelier"` | Export source code as Atelier did it, with packages as subfolders. | `boolean` | `true` | This setting only affects classes, routines, include files and DFI files. | -| `"objectscript.export.category"` | Category of source code to export: `CLS` = classes; `RTN` = routines; `CSP` = csp files; `OTH` = other. Default is `*` = all. | `string` or `object` | `"*"` | | -| `"objectscript.export.dontExportIfNoChanges"` | Do not rewrite the local file if the content is identical to what came from the server. | `boolean` | `false` | | -| `"objectscript.export.exactFilter"` | SQL filter to limit what to export. | `string` | `""` | The filter is applied to document names using the [LIKE predicate](https://irisdocs.intersystems.com/irislatest/csp/docbook/DocBook.UI.Page.cls?KEY=RSQL_like) (i.e. `Name LIKE 'exactFilter'`). If provided, `objectscript.export.filter` is ignored. | -| `"objectscript.export.filter"` | SQL filter to limit what to export. | `string` | `""` | The filter is applied to document names using the [LIKE predicate](https://irisdocs.intersystems.com/irislatest/csp/docbook/DocBook.UI.Page.cls?KEY=RSQL_like) (i.e. `Name LIKE '%filter%'`). | -| `"objectscript.export.folder"` | Folder for exported source code within workspace. | `string` | `"src"` | This setting is relative to the workspace folder root. | -| `"objectscript.export.generated"` | Export generated source code files, such as INTs generated from classes. | `boolean` | `false` | | -| `"objectscript.export.map"` | Map file names before export, with regexp pattern as a key and replacement as a value. | `object` | `{}` | For example, `{ \"%(.*)\": \"_$1\" }` to make % classes or routines use underscore prefix instead. | -| `"objectscript.export.mapped"` | Export source code files mapped from a non-default database. | `boolean` | `true` | | -| `"objectscript.export.maxConcurrentConnections"` | Maximum number of concurrent export connections. | `number` | `0` | 0 = unlimited | -| `"objectscript.export.noStorage"` | Strip the storage definition on export. | `boolean` | `false` | Can be useful when working across multiple systems. | -| `"objectscript.format.commandCase"` | Case for commands. | `"upper"`, `"lower"` or `"word"` | `"word"` | Has no effect if the `InterSystems Language Server` extension is installed and enabled. | -| `"objectscript.format.functionCase"` | Case for system functions and system variables. | `"upper"`, `"lower"` or `"word"` | `"word"` | Has no effect if the `InterSystems Language Server` extension is installed and enabled. | -| `"objectscript.ignoreInstallServerManager"` | Do not offer to install the [intersystems-community.servermanager](https://marketplace.visualstudio.com/items?itemName=intersystems-community.servermanager) extension. | `boolean` | `false` | | -| `"objectscript.importOnSave"` | Automatically save a client-side InterSystems file on the server when saved in the editor. | `boolean` | `true` | | -| `"objectscript.multilineMethodArgs"` | List method arguments on multiple lines, if the server supports it. | `boolean` | `false` | Only supported on IRIS 2019.1.2, 2020.1.1+, 2021.1.0+ and subsequent versions! On all other versions, this setting will have no effect. | -| `"objectscript.openClassContracted"` | Automatically collapse all class member folding ranges when a class is opened for the first time. | `boolean` | `false` | | -| `"objectscript.overwriteServerChanges"` | Overwrite a changed server version without confirmation when importing the local file. | `boolean` | `false` | | -| `"objectscript.projects.webAppFileExtensions"` | When browsing a virtual workspace folder that has a project query parameter, all files with these extensions will be automatically treated as web application files. Extensions added here will be appended to the default list and should **NOT** include a dot. | `string[]` | `[]` | Default extensions: `["csp","csr","ts","js","css","scss","sass","less","html","json","md","markdown","png","svg","jpeg","jpg","ico","xml","txt"]` | -| `"objectscript.serverSourceControl .disableOtherActionTriggers"` | Prevent server-side source control 'other action' triggers from firing. | `boolean` | `false` | | -| `"objectscript.showExplorer"` | Show the ObjectScript Explorer view. | `boolean` | `true` | | -| `"objectscript.showGeneratedFileDecorations"` | Controls whether a badge is shown in the file explorer and open editors view for generated files. | `boolean` | `true` | | -| `"objectscript.showProposedApiPrompt"` | Controls whether a prompt to enable VS Code proposed APIs is shown when a server-side workspace folder is opened. | `boolean` | `true` | | -| `"objectscript.studioActionDebugOutput"` | Log in JSON format the action that VS Code should perform as requested by the server. | `boolean` | `false` | Actions will be logged to the `ObjectScript` Output channel. | -| `"objectscript.suppressCompileErrorMessages"` | Suppress popup messages about errors during compile, but still focus on Output view. | `boolean` | `false` | | -| `"objectscript.suppressCompileMessages"` | Suppress popup messages about successful compile. | `boolean` | `true` | | -| `"objectscript.webSocketTerminal.syntaxColoring"` | Enable syntax coloring for command input in the InterSystems WebSocket Terminal. | `boolean` | `true` | | - -{: #intersystems-servermanager} -## InterSystems Server Manager - -| Setting | Description | Type | Default | Notes | -| ------- | ----------- | ---- | ------- | ----- | -| `"intersystems.servers"` | InterSystems servers that other extensions connect to. Each property of this object names a server and holds nested properties specifying how to connect to it. | `object` | `undefined` | See the [Configuration page](../configuration/#config-server) for more details on configuring servers. | diff --git a/docs/Studio.md b/docs/Studio.md deleted file mode 100644 index 9e030d72..00000000 --- a/docs/Studio.md +++ /dev/null @@ -1,633 +0,0 @@ ---- -layout: forward -target: https://docs.intersystems.com/components/csp/docbook/DocBook.UI.Page.cls?KEY=GVSCO -time: 4 - -title: Migrating from Studio -permalink: /studio/ -nav_order: 10 ---- - -{: .warning } -This documentation has been moved to the [InterSystems Documentation site](https://docs.intersystems.com/components/csp/docbook/DocBook.UI.Page.cls?KEY=GVSCO_fromstudio). This page will be removed soon. - -# Migrating from Studio - -The extensions that make up the [InterSystems ObjectScript Extension Pack](../installation/#install-the-intersystems-objectscript-extensions) contain many useful features that make migrating from InterSystems Studio easy. This page highlights a few of them. - -## Server-side Editing - -VS Code can be configured to edit code directly on a server, which is analogous to Studio's architecture. However, VS Code enhances this workflow with support for having multiple server-namespaces open at the same time (using VS Code's [multi-root workspace feature](https://code.visualstudio.com/docs/editor/multi-root-workspaces)) and for granularly [filtering the files](../serverside/#filters-and-display-options) shown for each server-namespace. See the [`Server-side Editing` documentation page](../serverside/) for more information on how to configure this feature. - -## Server-side Source Control - -VS Code supports server-side source control without requiring any additional configuration. Server-side source control is supported for both server-side and client-side editing. If a source control class is [active](https://docs.intersystems.com/irislatest/csp/docbook/DocBook.UI.Page.cls?KEY=ASC#ASC_Hooks_creating_and_activating_sc_class), its hooks will be fired automatically for document lifecycle events like creation, first edit, save and deletion. The server source contol menu can also be accessed in these locations: - -- The source control icon in the top-right portion of the window when a document is open. -- An open document's context menu. -- A node of the [ObjectScript Explorer's](../extensionui/#objectscript-view) context menu. -- A node of the VS Code [Explorer's](https://code.visualstudio.com/docs/getstarted/userinterface#_explorer) context menu. - -## Server-side Projects - -VS Code supports using existing Studio projects, as well as the creation, modification and deletion of them. See the [`Working with Projects` documentation page](../projects/) for more information about this feature and how to use it. - -## Accurate Syntax Coloring - -The [InterSystems Language Server extension](https://marketplace.visualstudio.com/items?itemName=intersystems.language-server) leverages VS Code's [semantic tokens API](https://code.visualstudio.com/api/language-extensions/semantic-highlight-guide) to provide the same accurate syntax coloring for InterSystems ObjectScript and other embedded languages that Studio users are familiar with. For more information on how to customize the syntax colors for InterSystems tokens, see the [Language Server's README](https://github.com/intersystems/language-server#syntax-color-customization). [A command](../studio/#load-studio-syntax-colors-command) is provided for Windows users to migrate their existing color customizations from Studio. - -## Import Server Definitions Command - -The [InterSystems Server Manager extension](https://marketplace.visualstudio.com/items?itemName=intersystems-community.servermanager) provides the `Import Servers from Windows Registry` command, which will import any Studio server defintions from your Windows registry into VS Code so you can continue using them without having to do the migration youself. To invoke the command, [open the command palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette), find the `InterSystems Server Manager: Import Servers from Windows Registry` menu option and run it. - -## Load Studio Snippets Command - -The [InterSystems ObjectScript extension](https://marketplace.visualstudio.com/items?itemName=intersystems-community.vscode-objectscript) provides the `Load Studio Snippets` command, which will load any user defined snippets from Studio into VS Code. It works by reading the locations of Studio user defined snippets files from the Windows registry, converting the snippets contained in those files to VS Code's JSON format and lastly writing the snippets to a new global snippets file called `isc-studio.code-snippets`. This command will only convert snippets for ObjectScript, Class Definition Language (UDL) or HTML; all others will be ignored. To invoke the command, [open the command palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette) and run the `ObjectScript: Load Studio Snippets` option. - -After loading the snippets it is recommended that you consider opening the generated file and enhancing the snippets so that they take advantage of [features available in VS Code](https://code.visualstudio.com/docs/editor/userdefinedsnippets) that Studio does not support, like tabstops and variable substitution. To open the file, click on the `Open File` button in the success notification box, or click on the Settings gear in the bottom-left corner of the window, select the `Configure User Snippets` menu option, and then select the `isc-studio.code-snippets` file in the dropdown that appears. - -## Load Studio Syntax Colors Command - -The [InterSystems ObjectScript extension](https://marketplace.visualstudio.com/items?itemName=intersystems-community.vscode-objectscript) provides the `Load Studio Syntax Colors` command, which will load the editor background and syntax foreground colors from Studio into VS Code. It works by reading the color configurations from the Windows registry and storing them in VS Code's [User Settings](https://code.visualstudio.com/docs/getstarted/settings) as customizations of one of the InterSystems default themes provided by the Language Server extension. The command uses the background color loaded from Studio to determine which default theme it should modify, and will activate the modified theme automatically. This command will not load foreground colors for any syntax tokens that have a custom background color because per-token background colors are not supported in VS Code. This command requires that the [InterSystems Language Server extension](https://marketplace.visualstudio.com/items?itemName=intersystems.language-server) is installed and active. To invoke the command, [open the command palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette) and click the `ObjectScript: Load Studio Syntax Colors` option. - -## New File Commands - -The [InterSystems ObjectScript extension](https://marketplace.visualstudio.com/items?itemName=intersystems-community.vscode-objectscript) provides commands for creating new Interoperability classes. Commands are provided for Business Operation, Business Process, Business Rule, Business Service and Data Transformation classes. These commands are modeled after the wizards in Studio's [`File` → `New...` → `Production` menu](https://docs.intersystems.com/irislatest/csp/docbook/DocBook.UI.Page.cls?KEY=GSTD_Commands#GSTD_Commands_File). The commands are shown in the `New File...` menu, which can be opened from the `File` menu (`File` → `New File...`) or the `Get Started` welcome page. - -## XML Import/Export Commands - -The [InterSystems ObjectScript extension](https://marketplace.visualstudio.com/items?itemName=intersystems-community.vscode-objectscript) provides commands for importing and exporting XML files. The commands can be invoked from [the command palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette) under the titles `Import XML Files...` and `Export Documents to XML File...`. These commands require an active server connection (the one from the currently opened document will be used if one is open), and the server's version must be 2023.2 or greater. - -## Keyboard Shortcuts - -In general, VS Code keyboard shortcuts are infinitely customizable as described in the docs. However, the IDE comes configured with a number of shortcuts that match Studio. Download a cheat sheet here. - -This section provides a mapping table for Studio users to more quickly adapt your shortcut muscle memory from Studio to VS Code with the ObjectScript extension. - -### General - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
StudioVS CodeActionVS Code Notes
F8F11Toggles Full Screen Display of Studio menus and editor window.
Ctrl+NCtrl+NNew Document
Ctrl+OCtrl+OOpen Document
Ctrl+Shift+OCtrl+K Ctrl+OOpen ProjectOpens a folder on-disk (if you're not using client-side source control, opens a Studio project from ObjectScript pane).
Ctrl+PCtrl+PPrint
Ctrl+SCtrl+SSave
Ctrl+Shift+IExportFor client-side editing, use the Export Code from Server command from the command palette or export from the ObjectScript Explorer.
Ctrl+IImport LocalFor client-side editing, files are imported on save by default. You can also use the Import and Compile command in the file explorer content menu. For server-side editing, right-click on an isfs workspace folder and select the Import Local Files... command.
- -### Display - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
StudioVS CodeActionVS Code Notes
Ctrl++Ctrl+K Ctrl+J, Ctrl+K Ctrl+0Expand, Collapse All
Ctrl+Left Select plus iconCtrl+K Ctrl+], Ctrl+K Ctrl+[Expand, Collapse All Block Sections
Ctrl+Shift+VCtrl+Shift+VView Others. Opens documents related to the current document, such as MAC or INT routines.
Alt+2Ctrl+Shift+UToggle Output window display
Alt+5Toggles Code Snippets window - displayCode Snippets exist in VS Code but there's no UI.
Alt+6Ctrl+Shift+FToggles Find in Files window - display
Ctrl+Alt++, Ctrl+Alt+-Ctrl++, Ctrl+-Increase, Decrease Font
Ctrl+Alt+SpaceCtrl+Shift+P
(start typing render)		Toggles display of Whitespace Symbols, spaces, newlines, and tabs
Ctrl+Balways onToggle Bracket Matching
Ctrl+TabCtrl+Shift+]Next Window
Ctrl+Shift+TabCtrl+Shift+[Previous Window
- -### Navigation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
StudioVS CodeActionVS Code Notes
Home, EndHome, EndGo To Beginning, End of Line
Ctrl+Home, Ctrl+EndCtrl+Home, Ctrl+EndGo To Beginning, End of Document
Ctrl+-, Ctrl+Shift+-Alt ⇦, Alt ⇨Go Back, Forward
PgUp, PgDnPgUp, PgDnPage Up, Down
Ctrl+PgUp, Ctrl+PgDnAlt+PgUp, Alt+PgDnGo to top, bottom of visible page
Ctrl+↓, Ctrl+↑Ctrl+↓, Ctrl+↑Scroll Down, Up
Ctrl+GCtrl+Shift+OGotoYou can use Ctrl+T to find a symbol across files. More information can be found in the VS Code docs.
Ctrl+F3, Ctrl+Shift+F3F8, Shift+F8Go To Next, Previous Error
Alt+F3, Alt+Shift+F3F8, Shift+F8Go to Next, Previous Warning
Ctrl+]Ctrl+Shift+\Go To Bracket
- -### Editing - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
StudioVS CodeActionVS Code Notes
Ctrl+DeleteDelete Next Word or to End of WordTry an extension such as Emacs Friendly Keymap
Ctrl+Backspace or Ctrl+Shift+DeleteDelete Previous Word or to Start of WordTry an extension such as Emacs Friendly Keymap
Ctrl+Shift+LCtrl+Shift+KDelete Line
Ctrl+C or Ctrl+InsertCtrl+CCopy
Shift+Delete or Ctrl+XCtrl+XCut
Ctrl+LCtrl+XCut Line
Ctrl+V or Shift+InsertCtrl+VPaste
Ctrl+ACtrl+ASelect All
Ctrl+Z, Ctrl+Y or Ctrl+Shift+ZCtrl+Z, Ctrl+Shift+ZUndo, Redo
Ctrl+SpaceCtrl+SpaceShow Studio Assist Popup/Trigger Code CompletionIn VS Code, code completion will pop up as you type so using this keybinding is often not necessary.
Ctrl+~Toggle Tab ExpansionUse indent menu in bottom bar.
Ctrl+U, Ctrl+Shift+UUppercase, Lowercase SelectionTry an extension such as change-case
Ctrl+Alt+UTitlecase (Initial Caps) SelectionTry an extension such as change-case
Ctrl+((Insert Open and Close Parentheses. (Does not work on German and Swiss keyboards.*)
Ctrl+{{Insert Open and Close Braces.
Ctrl+=Ctrl+Shift+P (type format...)Indentation Cleanup. Cleans up indentation on a selected block of whole lines of text.
Ctrl+/, Ctrl+Shift+/Ctrl+/Comment, Uncomment Line or block of text
Ctrl+Alt+/, Ctrl+Shift+Alt+/Ctrl+/Comment Markers Added to, Removed from Block of Text
Ctrl+EIn an ObjectScript document, commands in a selection are replaced with their full names.With the InterSystems Language Server installed, you can configure its formatter to expand command names and then format some or all of your document.
Ctrl+Shift+ECompress CommandsWith the InterSystems Language Server installed, you can configure its formatter to contract command names and then format some or all of your document.
- -### Find and Replace - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
StudioVS CodeActionVS Code Notes
Ctrl+F, Ctrl+HCtrl+F, Ctrl+HFind, Replace
F3, Shift+F3F3, Shift+F3Find Next, Previous
Ctrl+Shift+FCtrl+Shift+F, Ctrl+Shift+HFind, Replace in Files
Ctrl+, (comma)Ctrl+PSearch for class
Ctrl+Shift+G, Ctrl+Alt+GAlt+⇨, Alt+⇦Go To, Go Back
- -### Bookmarks - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
StudioVS CodeActionVS Code Notes
Ctrl+F2Toggle Bookmark on Current LineTry a 3rd party extension
F2, Shift+F2Go to Next, Previous BookmarkTry a 3rd party extension
Ctrl+Shift+F2Clear All BookmarksTry a 3rd party extension
- -### Build and Compile - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
StudioVS CodeActionVS Code Notes
F7Ctrl+Shift+F7Rebuilds All Documents in Project
Ctrl+F7Ctrl+F7Compile Active Document
Ctrl+Shift+F7Compile with OptionsExecute the Import and Compile Current File with Specified Flags... from the command palette.
- -### Debugging - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
StudioVS CodeActionVS Code Notes
Ctrl+Shift+ADebug AttachSee the debugging documentation page for how to debug a running process.
F9F9Debug Toggle Breakpoint on Current Line
Ctrl+F5, Shift+F5F5, Shift+F5Debug Start, Stop
Ctrl+Shift+F5Ctrl+Shift+F5Debug Restart
F11, Shift+F11F11, Shift+F11Debug Step Into, Out
F10F10Debug Step Over
diff --git a/docs/_config.yml b/docs/_config.yml deleted file mode 100644 index a272972a..00000000 --- a/docs/_config.yml +++ /dev/null @@ -1,75 +0,0 @@ -# Welcome to Jekyll! -# -# For technical reasons, this file is *NOT* reloaded automatically when you use -# 'bundle exec jekyll serve'. If you change this file, please restart the server process. -# -# If you need help with YAML syntax, here are some quick references for you: -# https://learn-the-web.algonquindesign.ca/topics/markdown-yaml-cheat-sheet/#yaml -# https://learnxinyminutes.com/docs/yaml/ -# -# Site settings -# These are used to personalize your new site. If you look in the HTML files, -# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on. -# You can create any custom variable you would like, and they will be accessible -# in the templates via {{ site.myvariable }}. - -title: InterSystems ObjectScript for VS Code -# email: your-email@example.com -description: >- # this means to ignore newlines until "baseurl:" - InterSystems ObjectScript language support for Visual Studio Code. -baseurl: "/vscode-objectscript" # the subpath of your site, e.g. /blog -url: "https://intersystems-community.github.io" # the base hostname & protocol for your site, e.g. http://example.com -# twitter_username: "" -# github_username: "" - -# Build settings -# theme: "just-the-docs" -remote_theme: pmarsceill/just-the-docs - -# plugins: - # - jekyll-feed - -logo: "/assets/images/vscode_objectscript_logo_title.png" - -color_scheme: isc - -search_enabled: true -search: - heading_level: 2 - previews: 3 - -aux_links: - "GitHub Repo": - "https://github.com/intersystems-community/vscode-objectscript" - -footer_content: "Copyright © 2023 InterSystems Corp. Distributed under an MIT license." - -ga_tracking: GTM-PKG7GB - -callouts: - warning: - title: "Warning" - color: red - note: - title: "Note" - color: yellow - - # Exclude from processing. -# The following items will not be processed, by default. -# Any item listed under the `exclude:` key here will be automatically added to -# the internal "default list". -# -# Excluded items can be processed by explicitly listing the directories or -# their entries' file path in the `include:` list. -# -# exclude: -# - .sass-cache/ -# - .jekyll-cache/ -# - gemfiles/ -# - Gemfile -# - Gemfile.lock -# - node_modules/ -# - vendor/bundle/ -# - vendor/cache/ -# - vendor/gems/ -# - vendor/ruby/ diff --git a/docs/_layouts/forward.html b/docs/_layouts/forward.html deleted file mode 100644 index 1e48d44a..00000000 --- a/docs/_layouts/forward.html +++ /dev/null @@ -1,45 +0,0 @@ - - - - - - {% assign time = 0 %} - {% assign targetname = page.target %} - - {% if page.time %} - {% assign time = page.time %} - {% endif %} - - {% if page.targetname %} - {% assign targetname = page.targetname %} - {% endif %} - - {% capture title %}Redirecting to {{ targetname }}{% endcapture %} - {% if page.targettitle %} - {% assign title = page.targettitle %} - {% endif %} - - - {{ title }} - - - -

{{ title }}

- - {% if page.message %} -

{{ page.message }}

- {% else %} - -

This documentation has been moved to the InterSystems Documentation site. This page will be removed soon!

- {% endif %} - -

Redirecting to {{ targetname }} in {{ time }} seconds.

- - - diff --git a/docs/_sass/color_schemes/isc.scss b/docs/_sass/color_schemes/isc.scss deleted file mode 100644 index 16eed0d4..00000000 --- a/docs/_sass/color_schemes/isc.scss +++ /dev/null @@ -1,14 +0,0 @@ -$link-color: #333695; - -.side-bar { - max-width: 300px !important; -} - -.main { - margin-left: 320px !important; - max-width: 1200px !important; -} - -th, td { - vertical-align: top; -} diff --git a/docs/assets/images/ClickWorkspace.png b/docs/assets/images/ClickWorkspace.png deleted file mode 100644 index 45c04257..00000000 Binary files a/docs/assets/images/ClickWorkspace.png and /dev/null differ diff --git a/docs/assets/images/CreateLaunchConfig.png b/docs/assets/images/CreateLaunchConfig.png deleted file mode 100644 index 46e3107c..00000000 Binary files a/docs/assets/images/CreateLaunchConfig.png and /dev/null differ diff --git a/docs/assets/images/ServerManagerSelect.png b/docs/assets/images/ServerManagerSelect.png deleted file mode 100644 index d36b5158..00000000 Binary files a/docs/assets/images/ServerManagerSelect.png and /dev/null differ diff --git a/docs/assets/images/ServerManagerSettings.png b/docs/assets/images/ServerManagerSettings.png deleted file mode 100644 index c586ed90..00000000 Binary files a/docs/assets/images/ServerManagerSettings.png and /dev/null differ diff --git a/docs/assets/images/action-for-server-start.png b/docs/assets/images/action-for-server-start.png deleted file mode 100644 index 61649a9e..00000000 Binary files a/docs/assets/images/action-for-server-start.png and /dev/null differ diff --git a/docs/assets/images/action-for-server-start.psd b/docs/assets/images/action-for-server-start.psd deleted file mode 100644 index 89bc2ac1..00000000 Binary files a/docs/assets/images/action-for-server-start.psd and /dev/null differ diff --git a/docs/assets/images/action-for-server.png b/docs/assets/images/action-for-server.png deleted file mode 100644 index 5609353a..00000000 Binary files a/docs/assets/images/action-for-server.png and /dev/null differ diff --git a/docs/assets/images/add-server.png b/docs/assets/images/add-server.png deleted file mode 100644 index aa860807..00000000 Binary files a/docs/assets/images/add-server.png and /dev/null differ diff --git a/docs/assets/images/add-to-project.png b/docs/assets/images/add-to-project.png deleted file mode 100644 index 8912ca17..00000000 Binary files a/docs/assets/images/add-to-project.png and /dev/null differ diff --git a/docs/assets/images/add-to-starred.png b/docs/assets/images/add-to-starred.png deleted file mode 100644 index 269a7550..00000000 Binary files a/docs/assets/images/add-to-starred.png and /dev/null differ diff --git a/docs/assets/images/client-server.png b/docs/assets/images/client-server.png deleted file mode 100644 index 6f42afce..00000000 Binary files a/docs/assets/images/client-server.png and /dev/null differ diff --git a/docs/assets/images/debug-environment.png b/docs/assets/images/debug-environment.png deleted file mode 100644 index b1a73189..00000000 Binary files a/docs/assets/images/debug-environment.png and /dev/null differ diff --git a/docs/assets/images/edit-settings.png b/docs/assets/images/edit-settings.png deleted file mode 100644 index 526b552f..00000000 Binary files a/docs/assets/images/edit-settings.png and /dev/null differ diff --git a/docs/assets/images/edit-webapp.png b/docs/assets/images/edit-webapp.png deleted file mode 100644 index 7404f952..00000000 Binary files a/docs/assets/images/edit-webapp.png and /dev/null differ diff --git a/docs/assets/images/explorer.png b/docs/assets/images/explorer.png deleted file mode 100644 index a25f7a7d..00000000 Binary files a/docs/assets/images/explorer.png and /dev/null differ diff --git a/docs/assets/images/extensions.png b/docs/assets/images/extensions.png deleted file mode 100644 index 4da665d9..00000000 Binary files a/docs/assets/images/extensions.png and /dev/null differ diff --git a/docs/assets/images/five-web-apps.png b/docs/assets/images/five-web-apps.png deleted file mode 100644 index 50dd171d..00000000 Binary files a/docs/assets/images/five-web-apps.png and /dev/null differ diff --git a/docs/assets/images/import-servers.png b/docs/assets/images/import-servers.png deleted file mode 100644 index aba5b35d..00000000 Binary files a/docs/assets/images/import-servers.png and /dev/null differ diff --git a/docs/assets/images/intersystems-tools.png b/docs/assets/images/intersystems-tools.png deleted file mode 100644 index c890bf27..00000000 Binary files a/docs/assets/images/intersystems-tools.png and /dev/null differ diff --git a/docs/assets/images/isc_logo_eye.png b/docs/assets/images/isc_logo_eye.png deleted file mode 100644 index f1f93af2..00000000 Binary files a/docs/assets/images/isc_logo_eye.png and /dev/null differ diff --git a/docs/assets/images/low-code-select.png b/docs/assets/images/low-code-select.png deleted file mode 100644 index 1db9fafc..00000000 Binary files a/docs/assets/images/low-code-select.png and /dev/null differ diff --git a/docs/assets/images/management-portal-browser.png b/docs/assets/images/management-portal-browser.png deleted file mode 100644 index 996a1180..00000000 Binary files a/docs/assets/images/management-portal-browser.png and /dev/null differ diff --git a/docs/assets/images/management-portal-tab.png b/docs/assets/images/management-portal-tab.png deleted file mode 100644 index fbdcd436..00000000 Binary files a/docs/assets/images/management-portal-tab.png and /dev/null differ diff --git a/docs/assets/images/marketplace.png b/docs/assets/images/marketplace.png deleted file mode 100644 index 4e34c717..00000000 Binary files a/docs/assets/images/marketplace.png and /dev/null differ diff --git a/docs/assets/images/namespace-buttons.png b/docs/assets/images/namespace-buttons.png deleted file mode 100644 index 80708661..00000000 Binary files a/docs/assets/images/namespace-buttons.png and /dev/null differ diff --git a/docs/assets/images/new-server.png b/docs/assets/images/new-server.png deleted file mode 100644 index 4d2d7ef1..00000000 Binary files a/docs/assets/images/new-server.png and /dev/null differ diff --git a/docs/assets/images/objectscript.png b/docs/assets/images/objectscript.png deleted file mode 100644 index 5233758e..00000000 Binary files a/docs/assets/images/objectscript.png and /dev/null differ diff --git a/docs/assets/images/project-buttons.png b/docs/assets/images/project-buttons.png deleted file mode 100644 index 62310b26..00000000 Binary files a/docs/assets/images/project-buttons.png and /dev/null differ diff --git a/docs/assets/images/projects-explorer-expanded.png b/docs/assets/images/projects-explorer-expanded.png deleted file mode 100644 index 0c037ccc..00000000 Binary files a/docs/assets/images/projects-explorer-expanded.png and /dev/null differ diff --git a/docs/assets/images/projects-explorer.png b/docs/assets/images/projects-explorer.png deleted file mode 100644 index ba63403b..00000000 Binary files a/docs/assets/images/projects-explorer.png and /dev/null differ diff --git a/docs/assets/images/reopen-editor-with.png b/docs/assets/images/reopen-editor-with.png deleted file mode 100644 index dc54f9e7..00000000 Binary files a/docs/assets/images/reopen-editor-with.png and /dev/null differ diff --git a/docs/assets/images/run.png b/docs/assets/images/run.png deleted file mode 100644 index 1d16be83..00000000 Binary files a/docs/assets/images/run.png and /dev/null differ diff --git a/docs/assets/images/select-config.png b/docs/assets/images/select-config.png deleted file mode 100644 index 8004e82a..00000000 Binary files a/docs/assets/images/select-config.png and /dev/null differ diff --git a/docs/assets/images/server-actions-with-links.png b/docs/assets/images/server-actions-with-links.png deleted file mode 100644 index a55f76c7..00000000 Binary files a/docs/assets/images/server-actions-with-links.png and /dev/null differ diff --git a/docs/assets/images/server-context-menu.png b/docs/assets/images/server-context-menu.png deleted file mode 100644 index 1c243b18..00000000 Binary files a/docs/assets/images/server-context-menu.png and /dev/null differ diff --git a/docs/assets/images/server-status-bar-error.png b/docs/assets/images/server-status-bar-error.png deleted file mode 100644 index dfe305bb..00000000 Binary files a/docs/assets/images/server-status-bar-error.png and /dev/null differ diff --git a/docs/assets/images/server-status-bar.png b/docs/assets/images/server-status-bar.png deleted file mode 100644 index 04c1346e..00000000 Binary files a/docs/assets/images/server-status-bar.png and /dev/null differ diff --git a/docs/assets/images/server-tree-view.png b/docs/assets/images/server-tree-view.png deleted file mode 100644 index 84169404..00000000 Binary files a/docs/assets/images/server-tree-view.png and /dev/null differ diff --git a/docs/assets/images/set-icon-color.png b/docs/assets/images/set-icon-color.png deleted file mode 100644 index 0fab70ba..00000000 Binary files a/docs/assets/images/set-icon-color.png and /dev/null differ diff --git a/docs/assets/images/ss-access-type.png b/docs/assets/images/ss-access-type.png deleted file mode 100644 index bf9212f2..00000000 Binary files a/docs/assets/images/ss-access-type.png and /dev/null differ diff --git a/docs/assets/images/ss-choose-namespace.png b/docs/assets/images/ss-choose-namespace.png deleted file mode 100644 index 799e2bf9..00000000 Binary files a/docs/assets/images/ss-choose-namespace.png and /dev/null differ diff --git a/docs/assets/images/ss-choose-server.png b/docs/assets/images/ss-choose-server.png deleted file mode 100644 index 933e893e..00000000 Binary files a/docs/assets/images/ss-choose-server.png and /dev/null differ diff --git a/docs/assets/images/ss-explorer-view.png b/docs/assets/images/ss-explorer-view.png deleted file mode 100644 index 74855f07..00000000 Binary files a/docs/assets/images/ss-explorer-view.png and /dev/null differ diff --git a/docs/assets/images/ss-files.png b/docs/assets/images/ss-files.png deleted file mode 100644 index 03e429c4..00000000 Binary files a/docs/assets/images/ss-files.png and /dev/null differ diff --git a/docs/assets/images/ss-pick-project.png b/docs/assets/images/ss-pick-project.png deleted file mode 100644 index a0608d92..00000000 Binary files a/docs/assets/images/ss-pick-project.png and /dev/null differ diff --git a/docs/assets/images/ss-pick-webapp.png b/docs/assets/images/ss-pick-webapp.png deleted file mode 100644 index 8a0eabdf..00000000 Binary files a/docs/assets/images/ss-pick-webapp.png and /dev/null differ diff --git a/docs/assets/images/ss-query-params.png b/docs/assets/images/ss-query-params.png deleted file mode 100644 index 241b0274..00000000 Binary files a/docs/assets/images/ss-query-params.png and /dev/null differ diff --git a/docs/assets/images/ss-settings-folder.png b/docs/assets/images/ss-settings-folder.png deleted file mode 100644 index bfcd68f5..00000000 Binary files a/docs/assets/images/ss-settings-folder.png and /dev/null differ diff --git a/docs/assets/images/ss-snippets.png b/docs/assets/images/ss-snippets.png deleted file mode 100644 index 1166a648..00000000 Binary files a/docs/assets/images/ss-snippets.png and /dev/null differ diff --git a/docs/assets/images/vscode_objectscript_logo.png b/docs/assets/images/vscode_objectscript_logo.png deleted file mode 100644 index 3608e3f9..00000000 Binary files a/docs/assets/images/vscode_objectscript_logo.png and /dev/null differ diff --git a/docs/assets/images/vscode_objectscript_logo_title 2.pxm b/docs/assets/images/vscode_objectscript_logo_title 2.pxm deleted file mode 100644 index b3a24e3d..00000000 Binary files a/docs/assets/images/vscode_objectscript_logo_title 2.pxm and /dev/null differ diff --git a/docs/assets/images/vscode_objectscript_logo_title.png b/docs/assets/images/vscode_objectscript_logo_title.png deleted file mode 100644 index ce65ae48..00000000 Binary files a/docs/assets/images/vscode_objectscript_logo_title.png and /dev/null differ diff --git a/docs/assets/images/web-app.png b/docs/assets/images/web-app.png deleted file mode 100644 index afdbe804..00000000 Binary files a/docs/assets/images/web-app.png and /dev/null differ diff --git a/docs/assets/js/zzzz-search-data.json b/docs/assets/js/zzzz-search-data.json deleted file mode 100644 index 0a6c3e5c..00000000 --- a/docs/assets/js/zzzz-search-data.json +++ /dev/null @@ -1,58 +0,0 @@ ---- -permalink: /assets/js/search-data.json ---- -{ - {%- assign i = 0 -%} - {% for page in site.html_pages %} - {%- if page.title and page.search_exclude != true -%} - {%- assign page_content = page.content -%} - {%- assign heading_level = site.search.heading_level | default: 2 -%} - {%- for j in (2..heading_level) -%} - {%- assign tag = '' -%} - {%- assign title = titleAndContent[0] | replace_first: '>', '

' | split: '

' -%} - {%- assign title = title[1] | strip_html -%} - {%- assign content = titleAndContent[1] -%} - {%- assign url = page.url -%} - {%- if title == page.title and parts[0] == '' -%} - {%- assign title_found = true -%} - {%- else -%} - {%- assign id = titleAndContent[0] -%} - {%- assign id = id | split: 'id="' -%} - {%- if id.size == 2 -%} - {%- assign id = id[1] -%} - {%- assign id = id | split: '"' -%} - {%- assign id = id[0] -%} - {%- capture url -%}{{ url | append: '#' | append: id }}{%- endcapture -%} - {%- endif -%} - {%- endif -%} - {%- unless i == 0 -%},{%- endunless -%} - "{{ i }}": { - "doc": {{ page.title | jsonify }}, - "title": {{ title | jsonify }}, - "content": {{ content | replace: '