Skip to content

Document Data Editor debug launch options#1701

Open
omribz156 wants to merge 2 commits into
apache:mainfrom
omribz156:codex/daffodil-data-editor-wiki
Open

Document Data Editor debug launch options#1701
omribz156 wants to merge 2 commits into
apache:mainfrom
omribz156:codex/daffodil-data-editor-wiki

Conversation

@omribz156
Copy link
Copy Markdown

Summary:

  • Document the Data Editor launch configuration options in the wiki source.
  • Explain how the Data Editor opens with the debugger and follows parser byte position while stepping or stopping at breakpoints.

Fixes #1695

Verification:

  • git diff --check

  • Static doc check for openDataEditor, dataEditor, Open Data Editor, omega-edit Port, parser location, and byte position in doc/Wiki.md

  • I have added the following documentation for these changes

This was implemented with Codex assistance, with the final diff reviewed before posting.

Comment thread doc/Wiki.md
* The Restart button will stop the current execution and begin again from the beginning.
* The Stop button will immediately terminate and abort all processing.

When the Data Editor is open during a debug session, it tracks the parser location in the input data. As the debugger pauses on entry, steps through the schema, or stops at breakpoints, the Data Editor highlights the corresponding byte position so the schema, infoset, and input data can be compared together.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would just add another sentence stating that for DFDL debug session the Data Editor removes the ability to select a file as it's fed the target file from the activation command.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added this sentence in the launch section. It now says the Data Editor uses the debug launch target file and does not prompt for a separate file selection during a DFDL debug session.

@stricklandrbls stricklandrbls added documentation Improvements or additions to documentation good first issue Good for newcomers data editor Issues related to the Data Editor capability configuration issues related to configuration labels May 17, 2026
Comment thread doc/Wiki.md Outdated
}
```

Set `openDataEditor` to `true` to open the Data Editor when the debug session starts. The `dataEditor` settings configure the Ωedit server port and Data Editor logging. Leave `logging.file` empty to use the default OS app-data/XDG log location, or set it to a specific log file path. The launch config wizard also exposes these settings as **Open Data Editor**, **omega-edit Port**, **Log File**, and **Log Level**.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would also add the defined enumerations for logging.level as they are written in the Omega Edit repo. Those are:

"trace",
"debug",
"info",
"warn",
"error",
"fatal"

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added the accepted Ωedit server log-level values, and verified them against the current @omega-edit/server repository before updating the docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

configuration issues related to configuration data editor Issues related to the Data Editor capability documentation Improvements or additions to documentation good first issue Good for newcomers

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

Task: Update Missing Data Editor Items in Wiki

2 participants