Skip to content

Commit 890528a

Browse files
committed
docs(XMLDiff): Improve formatting and clarity in XMLDiff with VSCode documentation
1 parent c4cb9ed commit 890528a

File tree

1 file changed

+5
-11
lines changed

1 file changed

+5
-11
lines changed

Docs/XMLDIffWithVSCode.egosoft

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ This document describes how to use XMLDiff with Visual Studio Code.
1313
[size=130][u]Steps[/u][/size]
1414
[list=1]
1515
[*] Prepare a folders structure like the following:
16-
[/list]
1716
[code=plaintext]
1817
RootExtensionFolder
1918
│ XMLDiffAndPatch
@@ -26,14 +25,13 @@ This document describes how to use XMLDiff with Visual Studio Code.
2625
│ md.modified
2726
│ md.original
2827
[/code]
29-
[list=1]
3028
[*] You can skip creation [b]*.original[/b] folders, if you will use the [b]extracted[/b] files folder.
3129
[*] Copy the [url=https://github.com/chemodun/X4-XMLDiffAndPatch/raw/main///forVSCode/RunXMLDiff.bat]RunXMLDiff.bat[/url] file to the root of your project.
3230
[*] Copy the [b]XMLDiff.exe[/b] file to the [b]XMLDiffAndPatch[/b] folder in the root of your project.
3331
[*] Install the VSCode extension [url=https://marketplace.visualstudio.com/items?itemName=emeraldwalk.RunOnSave]Run on Save[/url] by [url=https://marketplace.visualstudio.com/publishers/emeraldwalk]emeraldwalk[/url]
3432
[*] Open the settings of the extension by pressing [b]Ctrl + ,[/b] and search for [b]runOnSave.commands[/b]
3533
[*] Add the following configuration to the settings:
36-
[/list] 7.1 In case of not to use the "Extracted" files folder, i.e. with [b]*.original[/b] folders:
34+
[list=1] [*]In case of not to use the "Extracted" files folder, i.e. with [b]*.original[/b] folders:
3735

3836
[code=json]
3937
"commands": [
@@ -44,7 +42,7 @@ This document describes how to use XMLDiff with Visual Studio Code.
4442
]
4543
[/code]
4644

47-
7.2. With the [b]extracted[/b] folder, which is outside the project folder:
45+
[*] With the [b]extracted[/b] folder, which is outside the project folder:
4846

4947
[code=json]
5048
"commands": [
@@ -56,7 +54,7 @@ This document describes how to use XMLDiff with Visual Studio Code.
5654
[/code]
5755

5856
Take in account that with the [b]extracted[/b] folder you still can use the [b]*.original[/b] folders for original files. It will be used first, if they exist, otherwise the script will use the [b]extracted[/b] folder.
59-
[list=1]
57+
/[list]
6058
[*] Save the settings and close the settings tab.
6159
[/list]
6260
Now you can modify the [b]*.modified[/b] files and the [b]RunXMLDiff.bat[/b] will be executed automatically on save.
@@ -90,15 +88,11 @@ RunXMLDiff.bat "C:\path\to\md.modified\file.xml" "C:\path\to\XMLDiff.exe" "C:\pa
9088
[*] [b]Extract Type and Filename[/b]: The script extracts the type (e.g., [b]aiscript[/b] or [b]md[/b]) and filename from the modified file path.
9189
[*] [b]Determine Target File Path[/b]: The script constructs the target file path by removing [b].modified[/b] from the modified file path.
9290
[*] [b]Determine Original File Path[/b]:
93-
[/list][list][list]
9491
[*] If the [b]OriginalFilesPath[/b] is provided, the original file path is constructed as [b]OriginalFilesPath\type\filename[/b].
9592
[*] If the [b]OriginalFilesPath[/b] is not provided, the original file path is constructed by replacing [b].modified[/b] with [b].original[/b] in the modified file path.
96-
[/list]
97-
[/list]4. [b]Check Existence[/b]:
98-
[list][list]
93+
[*][b]Check Existence[/b]:
9994
[*] The script checks for the existence of [b]XMLDiff.exe[/b], the modified file, the original file, and the target file directory.
100-
[/list]
101-
[/list]5. [b]Run XMLDiff[/b]: If all checks pass, the script runs [b]XMLDiff.exe[/b] with the appropriate parameters to generate the diff file.
95+
[*][b]Run XMLDiff[/b]: If all checks pass, the script runs [b]XMLDiff.exe[/b] with the appropriate parameters to generate the diff file.
10296

10397
[size=125][u]Error Handling[/u][/size]
10498

0 commit comments

Comments
 (0)