Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
sgaikwad-rocket committed Jun 27, 2024
2 parents 6f8d208 + b4ce341 commit 1927b0d
Show file tree
Hide file tree
Showing 7 changed files with 37 additions and 4 deletions.
Binary file added docs/img/online_editing_compile_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/online_editing_compile_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/online_editing_compile_3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/online_editing_compile_4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 13 additions & 2 deletions docs/usage/KnownIssues.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,8 +92,6 @@

**MVVS-1314** delete currently connected server should also disconnect from current connection in online editing mode.

**MVVS-1320** Execute offline editing mode commands will disable online editing mode.


## Others

Expand All @@ -107,3 +105,16 @@

**MVVS-1326** Duplicated file path used on the Linux environment.

**MVVS-1374** Delete file exception if other user locked same BASIC on the server side

**MVVS-1373** Compilation failed if user clicked another account folder in ROCKET EXPLORER

**MVVS-1372** read BASIC file exception after sorted files in different order

**MVVS-1369** MVVS code exception for the included file

**MVVS-1367** Receive U2 XToolSub read directory record exception for ".swp" file

**MVVS-1366** Unable to open account folder if user has no WRITE access to the VOC file

**MVVS-1364** U2 XToolSub file lock exception when compiled BASIC is opened in another
26 changes: 24 additions & 2 deletions docs/usage/OnlineEditing.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ By accessing the configuration file, you can perform actions such as adding, edi

![](../img/online_editing_server_3.png)

- **"datasource"**: Must be either UNIVERSE or UNIDATA. In the online editing feature, you can only choose one data source.
- **"datasource"**: Must be either UNIVERSE or UNIDATA. In the online editing feature, you can only choose one data source. If you change the data source, the extension must be restarted for the change to take affect.

- **"address"**: Specify the address of the U2 server.

Expand Down Expand Up @@ -110,12 +110,34 @@ Here is the synchronization process when editing a BASIC program file:

4. After successfully applying the WRITE lock to the BASIC file on the server side, the extension will overwrite the corresponding file with the local copy of the BASIC program. All changes made on the server side will be overwritten without warning.

### Compile and catalog
Before using the compilation or catalog functions, a U2 database account must already connected.

#### Quick compile
Users can right-click a BASIC program file and select “” to compile a single file.

![](../img/online_editing_compile_1.png)

For UniData, there are multiple compilation commands for different flavors.

#### Compile / Catalog with configuration file
The configuration file can help a user to compile and catalog multiple files.
Select “Configure Default Build Task…” from the Terminal menu, and then select “BASIC: Online Editing build” to create a build task.

![](../img/online_editing_compile_2.png)

![](../img/online_editing_compile_3.png)

A default task file will be generated. For more information on this file, see the “Compile” documentation.

![](../img/online_editing_compile_4.png)

### Limitation:
Most of the LSP (Language Server Protocol) features are supported, but there are some limitations.

- Features like Go to Definition, Rename, and Find References may not be able to locate references or definitions in other files.

- Compilation and debugging functionalities are currently not supported.
- Debugging related functions are currently not supported.

- Custom documentation features are also not supported now.

Expand Down
Binary file added docs/usage/onlineEditing.docx
Binary file not shown.

0 comments on commit 1927b0d

Please sign in to comment.