You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@daffodil.apache.org by sh...@apache.org on 2022/03/24 22:47:06 UTC
[daffodil-site] branch main updated: Fix issues with VS Code page.
This is an automated email from the ASF dual-hosted git repository.
shanedell pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/daffodil-site.git
The following commit(s) were added to refs/heads/main by this push:
new b3926d9 Fix issues with VS Code page.
b3926d9 is described below
commit b3926d9ad63861080b3a2349a556f8f655ea92d1
Author: Shane Dell <sh...@gmail.com>
AuthorDate: Thu Mar 24 18:13:59 2022 -0400
Fix issues with VS Code page.
---
site/_includes/themes/apache/_navigation.html | 2 +-
site/_layouts/vscode.html | 2 +-
site/_vscode/1.0.0.md | 48 ++++++++++++++++++++++-----
site/vscode.md | 27 ++-------------
4 files changed, 45 insertions(+), 34 deletions(-)
diff --git a/site/_includes/themes/apache/_navigation.html b/site/_includes/themes/apache/_navigation.html
index d7fdf3f..1205789 100644
--- a/site/_includes/themes/apache/_navigation.html
+++ b/site/_includes/themes/apache/_navigation.html
@@ -4,7 +4,7 @@
<nav role="navigation">
<ul class="nav navbar-nav navbar-right">
<li><a href="/releases">Releases</a></li>
- <li><a href="/vscode">VSCode</a></li>
+ <li><a href="/vscode">VS Code</a></li>
<li id="documentation">
<a href="#" data-toggle="dropdown" class="dropdown-toggle">Docs<b class="caret"></b></a>
<ul class="dropdown-menu dropdown-left">
diff --git a/site/_layouts/vscode.html b/site/_layouts/vscode.html
index f958d3a..d21f4d6 100644
--- a/site/_layouts/vscode.html
+++ b/site/_layouts/vscode.html
@@ -5,7 +5,7 @@ permalink: /vscode/release-notes-:title
{% unless page.released %}
<div class="alert alert-warning">
- Apache Daffodil VSCode {{ page.title }} has not yet been released! The artifacts
+ Apache Daffodil {{ page.title }} has not yet been released! The artifacts
and release notes below are drafts for a proposed release of Apache
Daffodil which has not yet occurred.
</div>
diff --git a/site/_vscode/1.0.0.md b/site/_vscode/1.0.0.md
index e656a28..e96a1aa 100644
--- a/site/_vscode/1.0.0.md
+++ b/site/_vscode/1.0.0.md
@@ -2,7 +2,7 @@
released: false
apache: true
-title: 1.0.0
+title: VS Code Extension 1.0.0
date: 2022-03-17
summary: >
Initial release
@@ -17,12 +17,44 @@ source-dist:
binary-dist:
- "apache-daffodil-vscode-1.0.0.vsix"
-
-scala-version: 2.13
---
-This release contains VSCode extension used parsing/debugging a daffodil schema inside of VSCode.
-
-#### v1.0.0
-
-[GitHub v1.0.0 Closed Issues](https://github.com/apache/daffodil-vscode/issues?q=is%3Aissue+is%3Aclosed)
+This release contains a VS Code extension for debugging Daffodil schemas inside of VS Code.
+
+#### New Features
+
+* DFDL schema debugging
+* Output infoset to console, file or none
+* Scala implementation of the daffodil debugger
+* Infoset View
+ * This view dynamically updates to show the user what the current state of the infoset looks like
+* Infoset Diff View
+ * This view dynamically updates to show the user the difference of the infoset from the previous step to the current one
+* Hex View
+ * This view displays to the user the hexadeciaml of their data file
+ * This view also highlights the current byte of the data file being read
+* Session launch configuration:
+ * Both options are done utilizing file called `.vscode/launch.json`. This file can hold multiple different debugging profiles that can be selected between in VS Code
+ * Configuration via Launch wizard:
+ * The launch wizard is an interactive GUI that helps user set the values they want for the debugging configuration
+ * The launch wizard allows for creating the 1st debug profile, creating additional debug profiles and updating existing debug profiles.
+ * If the profile created is the first one the file `.vscode/launch.json` is automatically created with the profile in it
+ * If the profile is an additional profile it will be appended to the list at `.vscode/launch.json`
+ * If the profile already exists in `.vscode/launch.json`, the profile in the file will be updated upon saving
+ * via Manual Editing:
+ * The other way to customized the launch configuration is by manually editing the `.vscode/launch.json` file.
+ * This is done by editing the specific profile you wish to change. This allows easy changing of the schema file, data file and other settings.
+* Run currently opened schema file
+* Debug currently opened schema file
+* Daffodil toolbar and Command Palette:
+ * Open Infoset View
+ * Open Infoset Diff View
+ * Open Hex View
+ * Open Launch Wizard
+ * NOTE: These commands only become available when debugging has been started
+* Set breakpoints inside of main schema file
+* Set breakpoints inside of imported schemas
+
+#### Closed Issues
+
+[GitHub v1.0.0 Closed Issues](https://github.com/apache/daffodil-vscode/milestone/1?closed=1)
diff --git a/site/vscode.md b/site/vscode.md
index e7a3323..1fd1dd1 100644
--- a/site/vscode.md
+++ b/site/vscode.md
@@ -1,6 +1,6 @@
---
layout: page
-title: VSCode Extension
+title: VS Code Extension
group: nav-right
---
<!--
@@ -22,32 +22,11 @@ limitations under the License.
{% endcomment %}
-->
-#### Summary
-This page is for the Daffodil VSCode Extension.
-
-Features:
-
-* DFDL schema parsing/debugging
-* Output infoset to console, file or none
-* Session launch configuration
-* Scala implementation of the daffodil debugger
-* View infoset while debugging
-* View difference of infoset from one step to another when debugging
-* View hex of the data file
-* Launch wizard, helps create the `.vscode/launch.json`
-* Run currently opened schema file
-* Debug currently opened schema file
-* Daffodil toolbar and Command Palette:
- * Open infoset view
- * Open infoset diff view
- * Open hex view
- * Open launch wizard
-* Set breakpoints inside of main schema file
-* Set breakpoints inside of imported schemas
+The Daffodil VS Code Extension is a custom extension developed by Apache for allowing users to debug schemas inside of VS Code. The VS Code Extension also contains a Scala implemation of the Daffodil DAP Debugger that provides the users the ability to debug schemas.
#### Releases
-All recent Daffodil VSCode Extension releases are listed here. Each release below is listed by the version and date on which it was released. Clicking on the version number will take you to the release notes and downloads for that release.
+All recent Daffodil VS Code Extension releases are listed here. Each release below is listed by the version and date on which it was released. Clicking on the version number will take you to the release notes and downloads for that release.
{% assign releases = site.vscode | where: 'released', 'true' | where: 'apache', 'true' | sort: 'date' %}
{% if releases.size > 0 %}