This is an automated email from the ASF dual-hosted git repository.
CoverRyan pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/daffodil-vscode.git
The following commit(s) were added to refs/heads/main by this push:
new 61d0fbd4 Update Wiki.md
61d0fbd4 is described below
commit 61d0fbd486afb5f2855fd6affb7f58aa52f10aed
Author: CoverRyan <[email protected]>
AuthorDate: Tue Jul 7 17:13:09 2026 -0400
Update Wiki.md
Update Introduction-to-Daffodil-VS-Code-Extension.md
---
doc/Introduction-to-Daffodil-VS-Code-Extension.md | 52 +++++++++++------------
doc/Wiki.md | 43 ++++++++++---------
2 files changed, 47 insertions(+), 48 deletions(-)
diff --git a/doc/Introduction-to-Daffodil-VS-Code-Extension.md
b/doc/Introduction-to-Daffodil-VS-Code-Extension.md
index 32b6adcf..2f4446b8 100644
--- a/doc/Introduction-to-Daffodil-VS-Code-Extension.md
+++ b/doc/Introduction-to-Daffodil-VS-Code-Extension.md
@@ -17,23 +17,23 @@
|<div style="width:200px"></div>|<div style="width:250px"></div>|
|:---|---|
-|Introduction to the<br>**Apache Daffodil Extension** <br>for <br>**Visual
Studio Code**<br><br>||
+|Introduction to the<br>**Apache Daffodil Extension** <br>for <br>**Visual
Studio Code**<br><br>|<img width="1720" height="970" alt="image"
src="https://github.com/user-attachments/assets/79fcd741-0849-4470-a77e-bab855b8359d";
/>|
|<div style="width:160px"></div>|<div style="width:325px"></div>|
|:---|---|
-|**The Mission:<br>Make Daffodil Coding & Debugging
Easier**<br><br><br><br>The Command Line Interface with existing Daffodil
debugging capability is non\-intuitive and difficult to
master<br><br><br><br><br><br><br><br>||
+|**The Mission:<br>Make Daffodil Coding & Debugging
Easier**<br><br><br><br>The Command Line Interface with existing Daffodil
debugging capability is non\-intuitive and difficult to
master<br><br><br><br><br><br><br><br>|<img width="1133" height="856"
alt="image"
src="https://github.com/user-attachments/assets/5688433a-2f7f-4063-8dc5-8230d260c431";
/>|
|<div style="width:200px"></div>|<div style="width:205px"></div>|
|:---|---|
-|**The Solution:<br>Integrate Daffodil with VS Code**<br><ul><li>Source Level
Debugging</li><li> Breakpoints</li><li>Single Stepping</li><li>Syntax
Highlighting</li><li>Context Aware Code Completion Assistance</li><li>Data view
& Location Tracking</li><li>Interactive Infoset
Viewing</li></ul>||
+|**The Solution:<br>Integrate Daffodil with VS Code**<br><ul><li>Source Level
Debugging</li><li> Breakpoints</li><li>Single Stepping</li><li>Syntax
Highlighting</li><li>Context Aware Code Completion Assistance</li><li>Data view
& Location Tracking</li><li>Interactive Infoset Viewing</li></ul>|<img
width="1718" height="741" alt="image"
src="https://github.com/user-attachments/assets/85ecaaff-29ad-4fb4-8627-7b7e8c8d15b5";
/>|
|<div style="width:200px"></div>|<div style="width:205px"></div>|
|:---|---|
-|**The How:**<br><br><br><br><br><br><ul><li>VS Code plug\-in
extension</li><li>DAPodil interface server</li><li>Ωedit \& Data
Editor</li><li>Apache Daffodil w/ integrated
Debugger</li></ul><br><br><br><br>||
+|**The How:**<br><br><br><br><br><br><ul><li>VS Code plug\-in
extension</li><li>DAPodil interface server</li><li>Ωedit \& Data
Editor</li><li>Apache Daffodil w/ integrated
Debugger</li></ul><br><br><br><br>|<img width="754" height="582" alt="image"
src="https://github.com/user-attachments/assets/f706fee7-7f74-4d29-8667-efbab75ddda2";
/>|
@@ -46,66 +46,66 @@
|<div style="width:200px"></div>|<div style="width:205px"></div>|
|:---|:---|
-|**IDE Basics**<br><br>Integrated Development Environment<br>A single program
that integrates all the steps of software
development<ul><li>***Editing***</li><li>Compiling</li><li>Execution</li><li>Debugging</li><li>Version
Control</li></ul>||
+|**IDE Basics**<br><br>Integrated Development Environment<br>A single program
that integrates all the steps of software
development<ul><li>***Editing***</li><li>Compiling</li><li>Execution</li><li>Debugging</li><li>Version
Control</li></ul>|<img width="763" height="409" alt="image"
src="https://github.com/user-attachments/assets/11720529-6d0e-466d-94e7-d79a1e7cb62f";
/>|
|<div style="width:200px"></div>|<div style="width:205px"></div>|
|:---|:---|
-|**IDE Basics**<br><br>Integrated Development Environment<br>A single program
that integrates all the steps of software
development<ul><li>Editing</li><li>***Compiling***</li><li>Execution</li><li>Debugging</li><li>Version
Control</li></ul>||
+|**IDE Basics**<br><br>Integrated Development Environment<br>A single program
that integrates all the steps of software
development<ul><li>Editing</li><li>***Compiling***</li><li>Execution</li><li>Debugging</li><li>Version
Control</li></ul>|<img width="724" height="388" alt="image"
src="https://github.com/user-attachments/assets/87110d0c-4499-48d4-afb2-4f74705b658f";
/>|
|<div style="width:200px"></div>|<div style="width:205px"></div>|
|:---|:---|
-|**IDE Basics**<br><br>Integrated Development Environment<br>A single program
that integrates all the steps of software
development<ul><li>Editing</li><li>Compiling</li><li>***Execution***</li><li>Debugging</li><li>Version
Control</li></ul>||
+|**IDE Basics**<br><br>Integrated Development Environment<br>A single program
that integrates all the steps of software
development<ul><li>Editing</li><li>Compiling</li><li>***Execution***</li><li>Debugging</li><li>Version
Control</li></ul>|<img width="759" height="548" alt="image"
src="https://github.com/user-attachments/assets/b1f0f204-a0e6-4b6c-83ca-dfc21871ec1e";
/>|
|<div style="width:200px"></div>|<div style="width:205px"></div>|
|:---|:---|
-|**IDE Basics**<br><br>Integrated Development Environment<br>A single program
that integrates all the steps of software
development<ul><li>Editing</li><li>Compiling</li><li>Execution</li><li>***Debugging***</li><li>Version
Control</li></ul>||
+|**IDE Basics**<br><br>Integrated Development Environment<br>A single program
that integrates all the steps of software
development<ul><li>Editing</li><li>Compiling</li><li>Execution</li><li>***Debugging***</li><li>Version
Control</li></ul>|<img width="852" height="635" alt="image"
src="https://github.com/user-attachments/assets/72b0fa5d-c056-4c23-8e88-3cc47bdb3f7b";
/>|
|<div style="width:200px"></div>|<div style="width:205px"></div>|
|:---|:---|
-|**IDE Basics**<br><br>Integrated Development Environment<br>A single program
that integrates all the steps of software
development<ul><li>Editing</li><li>Compiling</li><li>Execution</li><li>Debugging</li><li>***Version
Control***</li></ul>||
+|**IDE Basics**<br><br>Integrated Development Environment<br>A single program
that integrates all the steps of software
development<ul><li>Editing</li><li>Compiling</li><li>Execution</li><li>Debugging</li><li>***Version
Control***</li></ul>|<img width="881" height="565" alt="image"
src="https://github.com/user-attachments/assets/30d430b9-81ba-4e9d-9ce1-46147e416d84";
/>|
|<div style="width:200px"></div>|<div style="width:205px"></div>|
|:---|:---:|
-|Install VS Code<br><br><br><br><ul><li>Free and built on open
source</li><li>Available for Windows, Linux, macOS and web
browsers</li></ul><br><br><br>|<br>*Click Image for Download Page:*[](https://code.visualstudio.com/Download)|
+|Install VS Code<br><br><br><br><ul><li>Free and built on open
source</li><li>Available for Windows, Linux, macOS and web
browsers</li></ul><br><br><br>|<br>*Click Image for Download Page:*<a
href="https://code.visualstudio.com/Download"; rel="nofollow" class><img
width="1039" height="466" alt="Supported platforms" title="Download VS Code
Here"
src="https://github.com/user-attachments/assets/bae78dad-a0c1-4c8a-8392-b69b3036c150";
/></a>|
|<div style="width:200px"></div>|<div style="width:205px"></div>|
|:---|:---|
-|**Installing the Daffodil Extension**<br><br><ol><li>***In VS Code, click on
the Extensions Icon.***
<br></li></ol><br><br><br><br><br><br>||
+|**Installing the Daffodil Extension**<br><br><ol><li>***In VS Code, click on
the Extensions Icon.***</li></ol><br><br><br><br><br><br>|<img width="718"
height="405" alt="image"
src="https://github.com/user-attachments/assets/3f0a7b56-d4fe-46ec-ab05-22df6c3d1125";
/>|
|<div style="width:200px"></div>|<div style="width:205px"></div>|
|:---|:---|
-|**Installing the Daffodil Extension**<br><br><ol><li>In VS Code, click on the
Extensions Icon</li><li>***Then enter “daffodil” in the search
box***</li><br><br><br><br></ol>||
+|**Installing the Daffodil Extension**<br><br><ol><li>In VS Code, click on the
Extensions Icon</li><li>***Then enter “daffodil” in the search
box***</li><br><br><br><br></ol>|<img width="718" height="407" alt="image"
src="https://github.com/user-attachments/assets/56bf69cc-52cb-44f1-a426-4b8dd5e919eb";
/>|
|<div style="width:200px"></div>|<div style="width:205px"></div>|
|:---|:---|
-|**Installing the Daffodil Extension**<br><br><ol><li>In VS Code, click on the
Extensions Icon.</li><li>Then enter “daffodil” in the search
box</li><li>***Click on the Apache Daffodil
tile***</li><br><br><br>||
+|**Installing the Daffodil Extension**<br><br><ol><li>In VS Code, click on the
Extensions Icon.</li><li>Then enter “daffodil” in the search
box</li><li>***Click on the Apache Daffodil tile***</li><br><br><br>|<img
width="718" height="407" alt="image"
src="https://github.com/user-attachments/assets/d889e93e-1952-4b23-a53c-849d19fa6f1d";
/>|
|<div style="width:200px"></div>|<div style="width:205px"></div>|
|:---|:---|
-|**Installing the Daffodil Extension**<br><br><ol><li>In VS Code, click on the
Extensions Icon.</li><li>Then enter “daffodil” in the search box</li><li>Click
on the Apache Daffodil tile</li><li>***Click on the*** `Install`
***button***</li><br><br>||
+|**Installing the Daffodil Extension**<br><br><ol><li>In VS Code, click on the
Extensions Icon.</li><li>Then enter “daffodil” in the search box</li><li>Click
on the Apache Daffodil tile</li><li>***Click on the*** `Install`
***button***</li><br><br>|<img width="712" height="405" alt="image"
src="https://github.com/user-attachments/assets/c960481b-7aa7-4398-b742-574eca928c15";
/>|
|<div style="width:200px"></div>|<div style="width:205px"></div>|
|:---|:---|
-|**Installing the Daffodil Extension**<br><br><ol><li>In VS Code, click on the
Extensions Icon.</li><li>Then enter “daffodil” in the search box</li><li>Click
on the Apache Daffodil tile</li><li>Click on the Install button</li><li>***Upon
installation, the*** `Install` ***button will be replaced by*** `Disable`
***&*** `Uninstall`
***buttons***</li></ol>||
+|**Installing the Daffodil Extension**<br><br><ol><li>In VS Code, click on the
Extensions Icon.</li><li>Then enter “daffodil” in the search box</li><li>Click
on the Apache Daffodil tile</li><li>Click on the Install button</li><li>***Upon
installation, the*** `Install` ***button will be replaced by*** `Disable`
***&*** `Uninstall` ***buttons***</li></ol>|<img width="712" height="405"
alt="image"
src="https://github.com/user-attachments/assets/ba17e4e8-5127-4da7-a258-02eb2df320da";
/>|
|<div style="width:200px"></div>|<div style="width:205px"></div>|
|:---|:---:|
-|***Configuring for First Use***<br>*Create a working
directory*<br><ul><li>Sample data file</li><li>Sample schema
file</ul><br><br><br>*[Free sample schemas
here](https://github.com/DFDLSchemas)*|*This
example uses a Daffdile logo saved as a PNG file*|
+|***Configuring for First Use***<br>*Create a working
directory*<br><ul><li>Sample data file</li><li>Sample schema
file</ul><br><br><br>*[Free sample schemas
here](https://github.com/DFDLSchemas)*|<img width="629" height="225"
alt="image"
src="https://github.com/user-attachments/assets/b9a0eaa1-0f25-4b6d-96dd-db1a97f1f284";
/><br>*This example uses a Daffdile logo saved as a PNG file*|
|<div style="width:200px"></div>|<div style="width:205px"></div>|
|:---|:---|
-|***Configuring for First Use***<br>*Open the working
directory*<br><br><br><ol><li>Click `File`</li><li>Click `Open
Folder`</li><li>Navigate to & Select your
folder<br><br><br></ol></li><br><br>||
+|***Configuring for First Use***<br>*Open the working
directory*<br><br><br><ol><li>Click `File`</li><li>Click `Open
Folder`</li><li>Navigate to & Select your
folder<br><br><br></ol></li><br><br>|<img width="779" height="422" alt="image"
src="https://github.com/user-attachments/assets/87ce73a7-be11-461f-a187-e9f7e9138bb5";
/>|
Note that if you wind up working on multiple DFDL projects in different
folders, you will need to configure **each folder** with its own launch.json
file
@@ -114,20 +114,20 @@ Another important issue to note when choosing working
directories is that VSCode
|<div style="width:200px"></div>|<div style="width:205px"></div>|
|:---|:---|
|***Configuring for First Use***<br>*Configuring Launch.json
file*<br><br><ul><li>Open the *Launch Config Wizard*<ul><li>Press `Ctrl` +
`Shift` + `P`</li><li>In the search bar that opens, begin entering:
"Daffodil"</li><li>When the list shows `Daffdodil Debug: Configure
launch.json`, select
it</li></ul></li></ul>||
-|<ul><li>The Launch Config Wizard will open in a new
tab.</li></ul><br><br><br><br><br><br>||
+|<ul><li>The Launch Config Wizard will open in a new
tab.</li></ul><br><br><br><br><br><br>|<img width="938" height="538"
alt="image"
src="https://github.com/user-attachments/assets/b3620c0b-a572-4512-ba7b-d96b189de37e";
/>|
Note that the debugger **should** run with the **default settings**. You may
simply scroll down to the bottom of the configuration wizard and click the
`SAVE` button, then close the wizard.<br>If you run into a problem, the most
likely problem is that you have not yet opened a working folder/directory. If
VS Code opens settings.json instead of launch.json make sure that you have
created and opened the intended folder/directory. The second most likely
culprit is a port conflict and you ca [...]
|<div style="width:200px"></div>|<div style="width:205px"></div>|
|:---|:---|
-|***Configuring for First Use***<br>*Launch Config
Wizard*<br><br><ul><li>Launch config: The file can hold multiple
configurations.</li><ul><p>1. Enter a name for the new
configuration<br>   or<br>2. Select a previous configuration
from the drop-down list</p>||
+|***Configuring for First Use***<br>*Launch Config
Wizard*<br><br><ul><li>Launch config: The file can hold multiple
configurations.</li><ul><p>1. Enter a name for the new
configuration<br>   or<br>2. Select a previous configuration
from the drop-down list</p>|<img width="480" height="164" alt="image"
src="https://github.com/user-attachments/assets/ce08ac08-d2b9-4122-9a93-c9bd3dc3ebff";
/>|
|<div style="width:200px"></div>|<div style="width:205px"></div>|
|:---|:---|
|***Configuring for First Use***<br>*Launch Config Wizard*||
-|*Main Schema File/Input Data File*<br>The input files can be hard coded into
the configuration by clicking the `Browse` button and navigating to the file
and clicking on it||
+|*Main Schema File/Input Data File*<br>The input files can be hard coded into
the configuration by clicking the `Browse` button and navigating to the file
and clicking on it|<img width="480" height="115" alt="image"
src="https://github.com/user-attachments/assets/36e051e7-614b-4d28-a0e9-4431cebd4b2b";
/>|
Leave the `${command:AskForSchemaName}`/`${command:AskForDataName}` values and
you will be prompted for the file names each time you execute a parse. *This
option can be useful if you will be testing with a variety of input files,
rather than running the same files repeatedly*
@@ -136,8 +136,7 @@ Leave the
`${command:AskForSchemaName}`/`${command:AskForDataName}` values and y
|<div style="width:200px"></div>|<div style="width:205px"></div>|
|:---|:---|
|***Configuring for First Use***<br>*Launch Config Wizard*||
-|*Root and RootNameSpace Element*<br>For simple schemas, this field should be
left empty. Unless specified no string should be in either field, so that they
can default to null value not string. |<img width="519" height="240"
alt="image"
src="https://github.com/user-attachments/assets/5d395a41-1592-4f1c-ac24-c66165198f99";
/>
-|
+|*Root and RootNameSpace Element*<br>For simple schemas, this field should be
left empty. Unless specified no string should be in either field, so that they
can default to null value not string. |<img width="519" height="240"
alt="image"
src="https://github.com/user-attachments/assets/5d395a41-1592-4f1c-ac24-c66165198f99";
/>|
@@ -150,14 +149,14 @@ Leave the
`${command:AskForSchemaName}`/`${command:AskForDataName}` values and y
|<div style="width:200px"></div>|<div style="width:205px"></div>|
|:---|:---|
|***Configuring for First Use***<br>*Launch Config Wizard*||
-|*Classpath*<br><ul><li>Complex schemas often require multiple locations and
JAR files. The debugger needs to know where to find these additional
files</li></ul>*Infoset*<ul><li>Infoset Format - Select XML or JSON for the
ouput</li><li>Output Type - store output to a file or stream to
console</li><li>Output Infoset Path - specify the location for the output
file</li></ul>||
+|*Classpath*<br><ul><li>Complex schemas often require multiple locations and
JAR files. The debugger needs to know where to find these additional
files</li></ul>*Infoset*<ul><li>Infoset Format - Select XML or JSON for the
ouput</li><li>Output Type - store output to a file or stream to
console</li><li>Output Infoset Path - specify the location for the output
file</li></ul>|<img width="517" height="444" alt="image"
src="https://github.com/user-attachments/assets/79f8e77f-96d4-474a-a174-719
[...]
|<div style="width:200px"></div>|<div style="width:205px"></div>|
|:---|:---|
|***Configuring for First Use***<br>*Launch Config Wizard*||
-|<ul><li>Open Data Editor - Display contents of file being parsed. Defaults to
Hex, but many configurable settings. Tracks position in file and allows
modification of data.</li><li>Open Infoset Diff View - Can show the difference
between output results of the current and previous parse.</li><li>Open Infoset
View - Displays the partial resulting output of the file parsing. Note that
parser often backtracks when portions of the parse are determined to be
incorrect.</li></ul>|![](images/new [...]
+|<ul><li>Open Data Editor - Display contents of file being parsed. Defaults to
Hex, but many configurable settings. Tracks position in file and allows
modification of data.</li><li>Open Infoset Diff View - Can show the difference
between output results of the current and previous parse.</li><li>Open Infoset
View - Displays the partial resulting output of the file parsing. Note that
parser often backtracks when portions of the parse are determined to be
incorrect.</li></ul>|<img width="35 [...]
|<div style="width:200px"></div>|<div style="width:205px"></div>|
|:---|:---|
@@ -173,13 +172,12 @@ Leave the
`${command:AskForSchemaName}`/`${command:AskForDataName}` values and y
|<div style="width:200px"></div>|<div style="width:205px"></div>|
|:---|:---|
|***Configuring for First Use***<br>*Launch Config Wizard*<br>Data Editor
Configuration||
-|<ul><li>Omega-edit port - allows user to specify which port will be used for
communication between VS Code & the backend server.</li><li>Name/location of
the log file which records communication between VS Code and the backend
server.</li><li>Drop down list of the valid log
levels.</li></ul>||
+|<ul><li>Omega-edit port - allows user to specify which port will be used for
communication between VS Code & the backend server.</li><li>Name/location of
the log file which records communication between VS Code and the backend
server.</li><li>Drop down list of the valid log levels.</li></ul>|<img
width="481" height="257" alt="image"
src="https://github.com/user-attachments/assets/07449ba7-dac0-4ae4-9040-6460e1320215";
/>|
|<div style="width:200px"></div>|<div style="width:205px"></div>|
|:---|:---|
|***Configuring for First Use***<br>*Launch Config Wizard*||
-|Don't forget to save your configuration settings!<br><br>If you have a
problem saving your settings, verify that you have opened a valid working
folder.||
-|||
+|Don't forget to save your configuration settings!<br><br>If you have a
problem saving your settings, verify that you have opened a valid working
folder.|<img width="204" height="54" alt="image"
src="https://github.com/user-attachments/assets/0d3667c5-c5e7-4313-a681-ec3b4de5bebb";
/>|
|<div style="width:200px"></div>|<div style="width:205px"></div>|
diff --git a/doc/Wiki.md b/doc/Wiki.md
index d4963dee..1028d7d5 100644
--- a/doc/Wiki.md
+++ b/doc/Wiki.md
@@ -88,7 +88,7 @@ The Apache Daffodil™ Extension for Visual Studio Code
provides a Daffodil Data
### [Data
Editor](https://github.com/apache/daffodil-vscode/wiki/Apache-Daffodil%E2%84%A2-Extension-for-Visual-Studio-Code:-v1.4.1#data-editor-1)
-<img width="800" src="images/v1.3.1/DE-brief.png" alt="Data Editor">
+<img width="800" height="435" alt="image"
src="https://github.com/user-attachments/assets/2373bc28-8bf8-47aa-bba2-0b01b5648e96";
/>
The Apache Daffodil™ Extension for Visual Studio Code provides an integrated
data editor. It is akin to a hex editor but tuned specifically for challenging
Daffodil use cases. As an editor designed for Daffodil developers by Daffodil
developers, features of the tool will evolve quickly to address the specific
needs of the Daffodil community.
@@ -628,37 +628,37 @@ A Daffodil Parse will then be launched. The DFDL Schema
file and input data file
This version of the Apache Daffodil™ Extension for Visual Studio Code includes
a new Data Editor. To use the Data Editor, open the VS Code command palette
and select `Daffodil Debug: Data Editor`.
-<img width="800" src="images/DE-cmd-palette.png"/>
+<img width="800" height="166" alt="image"
src="https://github.com/user-attachments/assets/f9877154-cfe4-48e4-9b56-e58919d1e7f2";
/>
A notification message will appear that informs where the Data Editor logged
to. If problems occur, check this log file.
-<img width="400" src="images/v1.3.1/DE-logging.png"/>
+<img width="400" height="103" alt="image"
src="https://github.com/user-attachments/assets/8b86e875-a4b6-4f56-94ae-aa11b5bdd9b5";
/>
Once the extension is connected to the server, the bottom left corner of the
Data Editor shows the version of the Ωedit™ server powering the editor, and the
port it's connected to. Hovering over the filled circle shows the CPU load
average, the memory usage of the server in bytes, the server session count, the
server uptime measured in seconds, and the round-trip latency measured in
milliseconds.
-<img width="800" src="images/v1.3.1/DE-heartbeat.png"/>
+<img width="800" height="24" alt="image"
src="https://github.com/user-attachments/assets/ab749aaa-c177-41e6-a40c-313a1862586f";
/>
After selecting a file to edit, there will be a table with controls at the top
of the Data Editor.
-<img width="800" src="images/v1.3.1/DE-top-controls.png"/>
+<img width="800" height="101" alt="image"
src="https://github.com/user-attachments/assets/f924546e-a581-4acb-9b68-824f8a401305";
/>
The first section of the table is called `File Metrics` and it contains the
path of the file being edited, its initial size in bytes [`Disk Size`], the
size as the file is being edited [`Computed Size`], and the detected Content
Type. When changes are committed, the `Save` button will become enabled,
allowing the changes to be saved to the file. The `Redo` and `Undo` buttons
will redo and undo edit change transactions. The `Revert All` button will
revert all edit changes since the fil [...]
-<img width="400" src="images/v1.3.1/DE-filemetrics.png"/>
+<img width="400" height="149" alt="image"
src="https://github.com/user-attachments/assets/77b0aa5d-5fb5-42d2-a857-814ed91e3c70";
/>
The `Data Profiler` allows for byte frequency profiling of all or a section of
the file starting at an editable start offset and ending at an editable end
offset, or an editable length of bytes. The offsets and lengths will use the
chosen `Address Radix`. The frequency scale can be either `Linear` or
`Logrithmic`. The graph can have either an `ASCII` overlay that appears behind
the graph, or `None` for no overlay behind the graph. Hover over the bars to
see the byte frequency and val [...]
📝 Note: The maximum length of bytes profiled in this version is capped at
10,000,000 (10M).
-<img width="400" src="images/v1.3.1/DE-profiler.png"/>
+<img width="400" height="593" alt="image"
src="https://github.com/user-attachments/assets/e645c3f8-abe7-48dc-a5dd-03d10361dd51";
/>
The second section of the table is called `Search`, and it allows for seeking
a desired offset and searching of byte sequences in the given `Edit Encoding`
in the edited file. The `Seek` input box uses the selected `Address Radix` as
the seek radix. If the `Edit Encoding` can be case-insensitive, a `Case
Insensitive` toggle (located inside the `Search` input box) will be displayed
allowing for that option to be enabled. The found sequences can be examined
using the `First`, `Prev`, `Ne [...]
-<img width="800" src="images/v1.3.1/DE-search.png"/>
+<img width="800" height="247" alt="image"
src="https://github.com/user-attachments/assets/f1268b69-a66d-4c43-9aed-e3623c8125e7";
/>
Found sequences can also be replaced in the given `Edit Encoding` by filling
in a replacement sequence and clicking the `Replace...` button.
-<img width="800" src="images/v1.3.1/DE-replace.png"/>
+<img width="800" height="234" alt="image"
src="https://github.com/user-attachments/assets/ad0fcb71-799f-40a8-b764-1b4a77275023";
/>
The third section of the table is called `Settings`, and it allows for setting
the `Display Radix`, `Edit Encoding`, and `Editing` modes.
@@ -666,45 +666,45 @@ The `Display Radix` can be one of *Hexadecimal*,
*Decimal*, *Octal*, or *Binary*
The `Edit Encoding` can be one of *Hexadecimal*, *Binary*, *ASCII (7-Bit)*,
*Latin-1 (8-bit)*, *UTF-8*, or *UTF-16LE* and will affect the selected bytes
being edited in the `Edit` viewport.
-<img width="800" src="images/v1.3.1/DE-settings.png">
+<img width="800" height="299" alt="image"
src="https://github.com/user-attachments/assets/7dd63b25-a223-4d64-abda-b908050c0494";
/>
In `Single Byte Edit Mode`, individual bytes may be *deleted*, *inserted* (to
the left or the right of the selected byte), and *overwritten* in the `Single
Byte Edit Window` that appears when a byte in the `Physical` or `Logical`
viewports is clicked.
Mouse over the buttons of the `Ephemeral Edit Window` to determine what each
button does. Mouse over the `Input Box` and it will show the byte offset
position in the `Address Radix` selected radix. Buttons will become enabled or
disabled depending on whether there is valid input in the `Input Box`. Values
entered in the `Input Box` must match the format set by the byte `Display
Radix` when editing bytes in the `Physical` viewport or be in *Latin-1 (8-bit
ASCII)* format when editing by [...]
-<img width="800" src="images/v1.3.1/DE-SBM-1.png"/>
+<img width="800" height="282" alt="image"
src="https://github.com/user-attachments/assets/903c5ac6-51df-4cd0-a620-460c10ecdcac";
/>
When clicking on a single byte in either the `Physical` or `Logical`
viewports, the `Data Inspector` will populate giving the value of the byte in
Latin-1, and various integer formats for the selected endianness. The `Data
Inspector` will also show the byte offset position in the `Address Radix`
selected radix. The values in the `Data Inspector` are editable by clicking on
the value and entering a new value.
-<img width="800" src="images/v1.3.1/DE-data_inspector-edit.png"/>
+<img width="800" height="201" alt="image"
src="https://github.com/user-attachments/assets/7cd48e4c-8471-4329-bbef-64bf38642212";
/>
In `Multiple Byte Edit Mode`, a segment of bytes is selected from either the
`Physical` or `Logical` viewports, then the selected segment of bytes is edited
in the `Edit` viewport using the selected `Edit Encoding`.
-<img width="800" src="images/v1.3.1/DE-MBM-edit_encoding.png"/>
+<img width="800" height="239" alt="image"
src="https://github.com/user-attachments/assets/92730bf2-d41a-4536-af8c-8931210af230";
/>
Now changes are made in the selected `Edit Encoding`.
-<img width="800" src="images/v1.3.1/DE-MBM-1.png"/>
+<img width="800" height="390" alt="image"
src="https://github.com/user-attachments/assets/dd57edbc-1ef2-4ca8-aadc-714e9adc85a1";
/>
When valid changes have been made to the segment of bytes in the `Edit`
viewport, the `Apply` button will become enabled.
-<img width="800" src="images/v1.3.1/DE-MBM-2.png"/>
+<img width="800" height="427" alt="image"
src="https://github.com/user-attachments/assets/765704aa-66cf-4c2d-a3de-b9a649f9832e";
/>
Once editing of the selected segment is completed and is valid, the `Apply`
button is pressed, and the edited segment replaces the selected segment. As
with changes made in `Single Byte Mode`, changes in `Multiple Byte Edit Mode`
are also applied as edit transactions that can be undone and redone.
-<img width="800" src="images/v1.3.1/DE-MBM-apply_change.png"/>
+<img width="800" height="430" alt="image"
src="https://github.com/user-attachments/assets/82f94e79-716f-42e7-a8e8-75b3473b78f6";
/>
Byte addresses can be expressed in *hexadecimal*, *decimal*, or *octal*. The
selected `Address Radix` is also what is used entering an offset into the
`Offset` input and for offsets and length in the `Data Profiler`. If an offset
is entered in the `Offset` input and the `Address Radix` is changed, the offset
will automatically be converted into the selected radix.
-<img width="800" src="images/v1.3.1/DE-address-hex.png"/>
+<img width="800" height="202" alt="image"
src="https://github.com/user-attachments/assets/c34980fe-8196-4f2b-b322-5aaa628ffd56";
/>
<br/>
-<img width="800" src="images/v1.3.1/DE-address-dec.png"/>
+<img width="800" height="205" alt="image"
src="https://github.com/user-attachments/assets/52255840-1dbd-4f9c-906f-86ce712a9e1a";
/>
The Data Editor supports light and dark modes. The mode is determined by the
VSCode theme. If the VSCode theme is set to a light theme, the Data Editor
will be in light mode. If the VSCode theme is set to a dark theme, the Data
Editor will be in dark mode.
-<img width="800" src="images/Theme-selection.png"/>
+<img width="800" height="126" alt="image"
src="https://github.com/user-attachments/assets/c922becb-f8ff-4f2c-a26b-d0ed126fb573";
/>
<br/>
-<img width="800" src="images/v1.3.1/DE-light-theme.png"/>
+<img width="800" height="424" alt="image"
src="https://github.com/user-attachments/assets/9928487e-7ad7-4646-9f05-6d17800fd6ab";
/>
## Navigation
@@ -712,7 +712,8 @@ The Data Editor can be navigated using the mouse or
keyboard.
Clicking on the `File Progress Indicator Bar` will navigate to the position in
the file that corresponds to the position clicked.
-<img width="800" src="images/v1.3.1/DE-navigation.png"/>
+<img width="800" height="65" alt="image"
src="https://github.com/user-attachments/assets/f52adf1a-8dc0-44ad-9b73-5d44ae82a74c";
/>
+
Below the `File Progress Indicator Bar` are a series of buttons that allow for
navigating the file. The `Home` button will take you to the beginning, the
`Page Up` button will take you to the previous page, the `Page Down` button
will take you to the next page, and the `End` button will take you to the end.
The `Line Up` button will take you to the previous line, and the `Line Down`
button will take you to the next line.
