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: Penrose sound #822

Merged
merged 2 commits into from Jan 11, 2022
Merged

feat: Penrose sound #822

merged 2 commits into from Jan 11, 2022

Conversation

keenancrane
Copy link
Collaborator

Description

This PR adds a proof-of-concept for annotating Penrose diagrams with audio. Audio annotations are potentially useful for increasing the accessibility of diagrams for, e.g., the blind or partially sighted.

It also updates the renderer to specify the xmlns string as the first attribute in the global svg tag, which was needed to get the example to work. (It seems writing this attribute first is required for some browsers to provide the correct behavior for certain SVG features.)

Checklist

  • I have commented my code, particularly in hard-to-understand areas
  • My changes generate no new ESLint warnings

Open questions

See README.md for some comments about features that would need to be supported in order to make sound a first-class entity in Penrose diagrams, namely, referencing external audio files (which is related to the ongoing question of how to reference external SVG files), and inserting the appropriate definitions at the top of the SVG.

@keenancrane keenancrane changed the title Penrose sound feat: Penrose sound Jan 11, 2022
@codecov
Copy link

codecov bot commented Jan 11, 2022

Codecov Report

Merging #822 (2a05e6b) into main (514bfb6) will not change coverage.
The diff coverage is 0.00%.

❗ Current head 2a05e6b differs from pull request most recent head 48750be. Consider uploading reports for the commit 48750be to get more accurate results
Impacted file tree graph

@@           Coverage Diff           @@
##             main     #822   +/-   ##
=======================================
  Coverage   67.60%   67.60%           
=======================================
  Files          61       61           
  Lines        7669     7669           
  Branches     1384     1384           
=======================================
  Hits         5185     5185           
  Misses       2475     2475           
  Partials        9        9           
Impacted Files Coverage Δ
packages/core/src/renderer/Renderer.ts 32.87% <0.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 514bfb6...48750be. Read the comment docs.

@keenancrane keenancrane merged commit 80cc169 into main Jan 11, 2022
@wodeni wodeni deleted the penrose-sound branch May 24, 2022 18:36
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.

None yet

2 participants