Skip to content

Commit b11d387

Browse files
authored
Merge pull request #562 from gjsjohnmurray/doc-450
Update documentation to reflect the new isfs namespace syntax
2 parents bf0e6ab + e363360 commit b11d387

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

docs/ServerSide.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Next create a workspace for editing code direct on the server:
4646
"folders": [
4747
{
4848
"name": "test:USER",
49-
"uri": "isfs://test/?ns=USER"
49+
"uri": "isfs://test:user/"
5050
}
5151
],
5252
"settings": {}
@@ -62,11 +62,11 @@ An example of a two-folder workspace in which the second folder gives read-only
6262
"folders": [
6363
{
6464
"name": "test:USER",
65-
"uri": "isfs://test/?ns=USER"
65+
"uri": "isfs://test:user/"
6666
},
6767
{
6868
"name": "test:%SYS (read-only)",
69-
"uri": "isfs-readonly://test/?ns=%SYS"
69+
"uri": "isfs-readonly://test:%sys/"
7070
}
7171
],
7272
"settings": {}
@@ -79,25 +79,25 @@ Root folders can be re-sequenced using drag/drop in the Explorer view, or by edi
7979

8080
## Web Application (CSP) Files
8181

82-
To edit web application files (also known as CSP files) on a server, configure the uri as `isfs://myserver{csp_application}?ns=XXX&csp`
82+
To edit web application files (also known as CSP files) on a server, configure the uri as `isfs://myserver:xxx{csp_application}?csp`
8383

84-
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 `ns` parameter must specify the correct namespace for the web application.
84+
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.
8585

8686
```
87-
"uri": "isfs://myserver/csp/user?ns=USER&csp"
87+
"uri": "isfs://myserver:user/csp/user?csp"
8888
```
8989

9090
Changes you make to files opened from this root folder of your VS Code workspace will be saved onto the server.
9191

9292
## Filters and Display Options
9393

94-
The query string of the `uri` property accepts several parameters that control filtering and display of the server-side entities.
94+
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'.
9595

96-
- `isfs://myserver?ns=USER&type=cls`, shows only classes
97-
- `isfs://myserver?ns=USER&type=rtn`, shows only routines, mac, int and inc files
98-
- `isfs://myserver?ns=USER&generated=1`, shows generated files as well as not generated
99-
- `isfs://myserver?ns=USER&filter=%Z*.cls,%z*.cls,%Z*.mac`, comma-delimited list of search options, ignores `type`
100-
- `isfs://myserver?ns=USER&flat=1`, a flat list of files does not split packages as folders.
96+
- `isfs://myserver:user?type=cls`, shows only classes
97+
- `isfs://myserver:user?type=rtn`, shows only routines, mac, int and inc files
98+
- `isfs://myserver:user?generated=1`, shows generated files as well as not generated
99+
- `isfs://myserver:user?filter=%Z*.cls,%z*.cls,%Z*.mac`, comma-delimited list of search options, ignores `type`
100+
- `isfs://myserver:user?flat=1`, a flat list of files does not split packages as folders.
101101

102102
The options `flat` and `generated` can be combined with each other, and with `type` or `filter`. If `filter` is specified, `type` is ignored.
103103

@@ -142,16 +142,16 @@ Example with connection to different namespaces on the same server.
142142
"name": "server",
143143
},
144144
{
145-
"uri": "isfs://myapp?ns=USER",
145+
"uri": "isfs://myapp:user",
146146
"name": "user",
147147
},
148148
{
149-
"uri": "isfs://myapp?ns=%SYS",
149+
"uri": "isfs://myapp:%sys",
150150
"name": "system",
151151
},
152152
{
153-
"uri": "isfs://user@directserver:port?ns=%SYS",
154-
"name": "system",
153+
"uri": "isfs://user@hostname:port?ns=%SYS",
154+
"name": "system (alternative syntax)",
155155
}
156156
],
157157
"settings": {

0 commit comments

Comments
 (0)