Skip to content

andrewtacon/DigitalSolutionsNotebook

Repository files navigation

Digital Solutions Notebook

TL;DR This is a notebook extension that runs HTML, Javascript (including P5.js) and SQL. Files need to have an extension *.dsnote to be recognised by the notebook.

Demo on Youtube https://www.youtube.com/embed/cEEfh6m_9lg

HTML

Notebook can display almost any HTML, CSS and JS scripting in tags. Image files can be placed in the same folder as the notebook and referenced by name and they render. All html is referenced in the global scope of the notebook so changes can be made to the look of the entire workbook with CSS.

Limitations: Cannot play audio or video. This is a limitation of the VSCode environment. Also, images won't show up in created iframes unless remotely referenced by http(s).

Javascript

Javascript runs in the main scope of the notebook. So inputs in one cell can be used in another. It essentially wraps whatever is written into script tags and executed via eval. You can access and change elements refered to by name in HTML cells and dynamically change them.

Console logs are routed back to the notebook and show up in the output.

p5.js

p5.js cells create a document in an iframe and attach it to the cell output. Each instance is self contained and cannot be affected by other parts of the document.

If you enter code without the setup() and draw() functions it will render statically to the screen in a small window. The window should automatically resize to fit the canvas size created.

Probably try and avoid using windowWidth and windowHeight variables to set frame size to avoid disappointment.

SQL

SQL runs using sql.js under the hood. All standard SQL queries work.

Extra commands:

  1. DUMP - prints out all data in all tables
  2. CLEAR - clears the database from memory
  3. LOAD filename.db - loads a file resident in the folder of the notebook
  4. SAVE filename.db - saves the database to file in the folder of the notebook
  5. DBDIAGRAM - generates a relational database schema from simple databases - inspired by the code for dBizzy Extension. No guarantee will work for complex databases.
  6. DICTIONARY - generates a data dictionary for the database present. No guarantee it will work for complex databases.

Limitations:

  • Sound is not available in any form (a limitation of the VSCode environment), likewise for video playback.
  • p5js can only load images using the loadImage() function. All other load...() functions will not work in this edition. Probably fix this if VSCode ever supports audio playback.

About

VSCode extension for QCAA Digital Solutions. Allows SQL, JavaScript (including p5js) and HTML.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published