Skip to content

Commit 443039a

Browse files
gjsjohnmurraygjsjohnmurray
committed
mark JSON in doc as json instead of js
1 parent 1078e01 commit 443039a

File tree

3 files changed

+108
-108
lines changed

3 files changed

+108
-108
lines changed

‎docs/Configuration.md

Lines changed: 104 additions & 104 deletions
Original file line numberDiff line numberDiff line change
@@ -1,105 +1,105 @@
1-
---
2-
layout: default
3-
title: Configuration
4-
permalink: /configuration/
5-
nav_order: 5
6-
---
7-
# Configuration
8-
9-
The settings that define an InterSystems IRIS server and the connection to the server are crucial to the functioning of VS Code in developing in ObjectScript.
10-
11-
## Configuring a Server
12-
13-
First, configure one or more servers. Open the settings editor by selecting **File > Preferences > Settings** (**Code > Preferences > Settings** on Mac) from the menu. Select the **User** or **Workspace** settings level by selecting it at the top of the settings window. For example, the following screen shot shows Workspace selected:
14-
15-
![Workspace selected.](../assets/images/ClickWorkspace.png "workspace selected")
16-
17-
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 correct place in the settings UI. The following screen shot shows InterSystems Server Manager selected:
18-
19-
![Select server manager.](../assets/images/ServerManagerSelect.png "select server manager")
20-
21-
And this screen shot shows Server Manager area of the edit pane:
22-
23-
![Server manager settings.](../assets/images/ServerManagerSettings.png "server manager settings")
24-
25-
You need to edit the server configuration in the settings.json file, so your only option is to click *Edit in settings.json*.
26-
27-
To configure a server, enter code something like this:
28-
29-
```js
30-
"intersystems.servers": {
31-
"test": {
32-
"webServer": {
33-
"scheme": "http",
34-
"host": "localhost",
35-
"port": 52774,
36-
},
37-
"username": "_SYSTEM",
38-
},
39-
},
40-
```
41-
42-
The components of this server definition are:
43-
44-
- **test** - an arbitrary name to identify this server
45-
- **webServer** - The collection of properties that define the web server.
46-
- **scheme** - The protocol used for connections.
47-
- **host** - the host for this server
48-
- **port** - the WebServer port number for this server
49-
- **username** - the username to use in logging in to this server.
50-
- **password** - password for the specified username. Entering the password in this file is acceptable only in limited situations with very low need for security.
51-
52-
If you do not add a password to the server definition, anyone using the server needs to supply the password. Or, you can store the password securely in the system Keychain. The InterSystems Server Manager adds the following commands for managing stored passwords to the Command Palette:
53-
54-
- **InterSystems Server Manager: Clear Password from Keychain** - remove password for selected server
55-
- **InterSystems Server Manager: Store Password in Keychain** - select a server and enter a password
56-
57-
## Configuring a Server Connection
58-
59-
Select InterSystems ObjectScript from the settings editor extensions list. You need to edit the server configuration in the settings.json file, so your click *Edit in settings.json* under the heading **Objectscript: conn**.
60-
61-
You should enter code something like this:
62-
63-
```js
64-
"objectscript.conn": {
65-
"ns": "USER",
66-
"server": "tst",
67-
"active": true,
68-
},
69-
```
70-
The components of this server definition are:
71-
72-
- **ns** - namespace to use on the server
73-
- **server** - server name as specified in the server configuration
74-
- **active** - specifies whether the connection is active.
75-
76-
## Configuring Export from Server
77-
78-
Select InterSystems ObjectScript from the settings editor extensions list. Find the section labeled **Objectscript: conn**. You can edit many of the export settings in the settings editor. For others you need to edit the settings.json file.
79-
80-
You export configuration looks something like this:
81-
82-
```js
83-
"objectscript.export": {
84-
"folder": "",
85-
"addCategory": true,
86-
"atelier": true,
87-
"generated": false,
88-
"filter": "",
89-
"category": "*",
90-
"noStorage": false,
91-
"dontExportIfNoChanges": false,
92-
"maxConcurrentConnections": 0
93-
},
94-
```
95-
The components of this export definition are:
96-
97-
- **folder** - Folder for source code.
98-
- **addCategory** - Add a category folder to the export path.
99-
- **atelier** - Export source code as Atelier does, with packages placed in subfolders.
100-
- **generated** - Export generated source code files.
101-
- **filter** -
102-
- **category** - Specifies a category of source code to export: CLS = classes; RTN = routines; CSP = csp files; OTH = other. The default is *, export everything.
103-
- ****noStorage** - Strip the storage XML on export. This is useful for multiple systems.
104-
- **dontExportIfNoChanges** - Don't update the local file if the content is identical to what is on the server.
1+
---
2+
layout: default
3+
title: Configuration
4+
permalink: /configuration/
5+
nav_order: 5
6+
---
7+
# Configuration
8+
9+
The settings that define an InterSystems IRIS server and the connection to the server are crucial to the functioning of VS Code in developing in ObjectScript.
10+
11+
## Configuring a Server
12+
13+
First, configure one or more servers. Open the settings editor by selecting **File > Preferences > Settings** (**Code > Preferences > Settings** on Mac) from the menu. Select the **User** or **Workspace** settings level by selecting it at the top of the settings window. For example, the following screen shot shows Workspace selected:
14+
15+
![Workspace selected.](../assets/images/ClickWorkspace.png "workspace selected")
16+
17+
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 correct place in the settings UI. The following screen shot shows InterSystems Server Manager selected:
18+
19+
![Select server manager.](../assets/images/ServerManagerSelect.png "select server manager")
20+
21+
And this screen shot shows Server Manager area of the edit pane:
22+
23+
![Server manager settings.](../assets/images/ServerManagerSettings.png "server manager settings")
24+
25+
You need to edit the server configuration in the settings.json file, so your only option is to click *Edit in settings.json*.
26+
27+
To configure a server, enter code something like this:
28+
29+
```json
30+
"intersystems.servers": {
31+
"test": {
32+
"webServer": {
33+
"scheme": "http",
34+
"host": "localhost",
35+
"port": 52774,
36+
},
37+
"username": "_SYSTEM",
38+
},
39+
},
40+
```
41+
42+
The components of this server definition are:
43+
44+
- **test** - an arbitrary name to identify this server
45+
- **webServer** - The collection of properties that define the web server.
46+
- **scheme** - The protocol used for connections.
47+
- **host** - the host for this server
48+
- **port** - the WebServer port number for this server
49+
- **username** - the username to use in logging in to this server.
50+
- **password** - password for the specified username. Entering the password in this file is acceptable only in limited situations with very low need for security.
51+
52+
If you do not add a password to the server definition, anyone using the server needs to supply the password. Or, you can store the password securely in the system Keychain. The InterSystems Server Manager adds the following commands for managing stored passwords to the Command Palette:
53+
54+
- **InterSystems Server Manager: Clear Password from Keychain** - remove password for selected server
55+
- **InterSystems Server Manager: Store Password in Keychain** - select a server and enter a password
56+
57+
## Configuring a Server Connection
58+
59+
Select InterSystems ObjectScript from the settings editor extensions list. You need to edit the server configuration in the settings.json file, so your click *Edit in settings.json* under the heading **Objectscript: conn**.
60+
61+
You should enter code something like this:
62+
63+
```json
64+
"objectscript.conn": {
65+
"ns": "USER",
66+
"server": "tst",
67+
"active": true,
68+
},
69+
```
70+
The components of this server definition are:
71+
72+
- **ns** - namespace to use on the server
73+
- **server** - server name as specified in the server configuration
74+
- **active** - specifies whether the connection is active.
75+
76+
## Configuring Export from Server
77+
78+
Select InterSystems ObjectScript from the settings editor extensions list. Find the section labeled **Objectscript: conn**. You can edit many of the export settings in the settings editor. For others you need to edit the settings.json file.
79+
80+
You export configuration looks something like this:
81+
82+
```json
83+
"objectscript.export": {
84+
"folder": "",
85+
"addCategory": true,
86+
"atelier": true,
87+
"generated": false,
88+
"filter": "",
89+
"category": "*",
90+
"noStorage": false,
91+
"dontExportIfNoChanges": false,
92+
"maxConcurrentConnections": 0
93+
},
94+
```
95+
The components of this export definition are:
96+
97+
- **folder** - Folder for source code.
98+
- **addCategory** - Add a category folder to the export path.
99+
- **atelier** - Export source code as Atelier does, with packages placed in subfolders.
100+
- **generated** - Export generated source code files.
101+
- **filter** -
102+
- **category** - Specifies a category of source code to export: CLS = classes; RTN = routines; CSP = csp files; OTH = other. The default is *, export everything.
103+
- ****noStorage** - Strip the storage XML on export. This is useful for multiple systems.
104+
- **dontExportIfNoChanges** - Don't update the local file if the content is identical to what is on the server.
105105
- **maxConcurrentConnections** - The maximum number of export connections. (0 = Unlimited)

‎docs/RunDebug.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ If no launch configurations are available, you are prompted to create one:
1414

1515
Clicking the link creates and opens a `launch.json` file containing the following default information:
1616

17-
```js
17+
```json
1818
{
1919
"version": "0.2.0",
2020
"configurations": [
@@ -35,7 +35,7 @@ These attributes are mandatory for any launch configuration:
3535

3636
In addition, for an **objectscript** configuration, you need to supply the attribute **program**, which specifies the executable or file to run when launching the debugger, as shown in the following example:
3737

38-
```js
38+
```json
3939
"launch": {
4040
"version": "0.2.0",
4141
"configurations": [

‎docs/ServerSide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ First configure the connection to InterSystems as described in [Configuration](.
1212

1313
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 of any folder where there are settings for the connection.
1414

15-
```js
15+
```json
1616
{
1717
"folders": [
1818
{
@@ -35,7 +35,7 @@ Save the file, giving it an arbitrary name with the extension `.code-workspace`.
3535
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.
3636

3737
Example with connection to different namespaces on the same server.
38-
```js
38+
```json
3939
{
4040
"folders": [
4141
{

0 commit comments

Comments
 (0)