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.

Sign up for GitHub

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

Jump to bottom

Embed WaveJSON data in SVG metadata when saving #362

Open
wants to merge 2 commits into
base: trunk
Choose a base branch
from
Open

Embed WaveJSON data in SVG metadata when saving #362

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
810bdec
Embed WaveJSON data in SVG metadata when saving
bmpenuelas May 12, 2022
6c6e053
Add WaveDrom version to WaveJSON metadata tag in SVG
bmpenuelas Jun 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion lib/append-save-as-dialog.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
'use strict';

function appendSaveAsDialog (index, output) {
function appendSaveAsDialog (index, output, obj=undefined) {
var div;
var menu;

Expand Down Expand Up @@ -84,6 +84,7 @@ function appendSaveAsDialog (index, output) {
var html,
firstDiv,
svgdata,
metadataWaveJSON,
a;

html = '';
Expand All @@ -92,6 +93,10 @@ function appendSaveAsDialog (index, output) {
html += firstDiv.innerHTML.substring(166, firstDiv.innerHTML.indexOf('<g id="waves_0">'));
}
html = [div.innerHTML.slice(0, 166), html, div.innerHTML.slice(166)].join('');
if (obj) {
metadataWaveJSON = '<metadata id="wavejson">' + JSON.stringify(obj, null, 2) + '</metadata>';
Copy link

Choose a reason for hiding this comment

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

This should encode the version of wavedrom that generated the output.

This will allow later-discovered bugs to be worked around, for example. Versioning is a Good Thing™️.

Copy link
Author

Choose a reason for hiding this comment

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

This is a good idea, I'll see if I can retrieve the wavedrom version in this context, and add it to the metadata.

Copy link

Choose a reason for hiding this comment

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

I think it's globally available as WaveDrom.version (type: string)

Copy link

Choose a reason for hiding this comment

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

After further consideration, I would recommend making this a distinct option in the context menu.

You can expand here for some of the reasons

When adding the exported source JSON, the intent is to enable that text to be imported later. Therefore, have a version field is particularly important (for bugs, versioning, etc.) when including the wavedrom JSON source.

However, when exporting SVG, some folk may prefer to exclude the source. For example, some may edit the SVG manually post-creation, and it would no longer match the exported SVG, so they don't want to have to manually remove outdated metadata. As another example, authors of particularly large or complex diagrams may not want to share the JSON source.

In addition, adding the version number to all SVG output would increase the complexity of regression testing. For example, I'm considering adding some tests that ensure identical output for both PNG and SVG between builds. Adding text in the SVG which should be ignored makes that much more complex.

I think you have a handle on how to add a new option, but let me know if you would like any pointers.

Copy link
Author

Choose a reason for hiding this comment

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

I have just pushed a new commit which adds the WaveDrom version in the metadata tag, as per your first suggestion.

Personally, I would not overcomplicate it by adding more context menu options to cover cases which will be rarely used. If someone really wants to remove the wavejson data, they can do so very easily with a text editor, otherwise the metadata can simply be ignored.

Copy link
Contributor

Choose a reason for hiding this comment

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

+1 on removing version with sed (or other tool) if you really want to ...

html = html.replace('>', '>' + metadataWaveJSON);
bmpenuelas marked this conversation as resolved.
Show resolved Hide resolved
}
svgdata = 'data:image/svg+xml;base64,' + btoa(html);

a = document.createElement('a');
Expand Down
2 changes: 1 addition & 1 deletion lib/process-all.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ function processAll () {
if (obj && obj.signal && !notFirstSignal) {
notFirstSignal = true;
}
appendSaveAsDialog(i, 'WaveDrom_Display_');
appendSaveAsDialog(i, 'WaveDrom_Display_', obj);
}
// add styles
document.head.innerHTML += '<style type="text/css">div.wavedromMenu{position:fixed;border:solid 1pt#CCCCCC;background-color:white;box-shadow:0px 10px 20px #808080;cursor:default;margin:0px;padding:0px;}div.wavedromMenu>ul{margin:0px;padding:0px;}div.wavedromMenu>ul>li{padding:2px 10px;list-style:none;}div.wavedromMenu>ul>li:hover{background-color:#b5d5ff;}</style>';
Expand Down