Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: web app for previewing svg markup returned by BlissSVGBuilder #22

Closed
wants to merge 2 commits into from

Conversation

klown
Copy link
Contributor

@klown klown commented Sep 30, 2024

This adds another web application to the ./apps folder, specifically ./apps/svg-preview.

The app can be run on localhost and is started by the existing npm run serveAppsDemos script. If so launched, use this following URL to access it: http://localhost:5173/apps/svg-preview/svg-preview.html

@klown klown requested a review from cindyli September 30, 2024 20:53
@klown
Copy link
Contributor Author

klown commented Sep 30, 2024

@cindyli I have requested a review from you, but I think I should modify the main README and possibly add a README to the svg-preview folder in order to document how to use this app. However, feel free to start reviewing the code while I work on the documentation.

<h1>Bliss SVG Previewer</h1>
<p>
The encoding string entered below is a space separated sequence of BCI-AV
identfiers and separators such as "/" and ";". The sequence can be as
Copy link
Contributor

Choose a reason for hiding this comment

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

Would be helpful to explain what "/" and ";" mean. Something like:

  • In the format of [12335, "/", 8499], the Bliss character 12335 and the Bliss character of 8499 are displayed side by side
  • In the format of [12335, ";", 8499], the Bliss character 12335 and the indicator 8499 are displayed in the way that the indicator 8499 is on top of the the charactor 12355

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good point. However, in exploring the Bliss SVG builder for more information, I discovered that this string will work as well: "HC8N:0,8;S4:2,10". It is used by the BMW palette for the first part of "Abs. Time", the "Abs." part.

That means that the legitimate encodings can be complicated and use letters, colons, and commas as well as slash and semi-colon. I have adjusted the code to take that all into account.

However, I can't find any documentation for the structure of these encodings. Do you know if there is any?

Copy link
Contributor

Choose a reason for hiding this comment

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

I don't know about the documentation. Hannes will know better.

@cindyli
Copy link
Contributor

cindyli commented Nov 6, 2024

@klown do you think if this pull request is still needed. Seems the SVG preview is already covered by the pull request that generates palette JSON files.

@klown
Copy link
Contributor Author

klown commented Nov 6, 2024

@klown do you think if this pull request is still needed. Seems the SVG preview is already covered by the pull request that generates palette JSON files.

No, not anymore @cindyli . It was the inspiration for the SVG string inputs for the palette generator PR.

I am closing this one as overtaken by #25.

@klown klown closed this Nov 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants