spiegel-keyman/web/bulk_rendering
2022-10-31 10:25:16 +07:00
..
build.sh refactor(common): rename builder_has_action and document 2022-09-21 10:21:35 +10:00
compare.html fix(web): bulk rendering docs 2021-01-22 16:07:45 +11:00
index.html fix(web): bulk renderer using video stream capture 2021-01-22 15:51:38 +11:00
README.md chore(web): cleanup, tweaks per code review 2022-10-31 10:25:16 +07:00
renderer_core.ts chore(web): cleanup, tweaks per code review 2022-10-31 10:25:16 +07:00
tsconfig.json chore(web): drops non-pred text dependence on es6-shim 2022-05-31 09:11:20 +07:00

Bulk renderer

This renderer loads all the cloud keyboards from api.keyman.com and renders each of them to the document, saving each render as an inline (data-url) PNG for easy comparison.

Using the bulk renderer

  1. build.sh to build the renderer (must have already built KeymanWeb in ../source/, ./build.sh -debug).
  2. Open index.html (via http, not via file, as otherwise fonts will not be accessible).
  3. Choose whether you wish to render all layers or just the default layer for each keyboard.
  4. If desired, filter out keyboards by id (regex).
  5. Run the render.
    • Note that it is preferable to run this on an actual device if possible.
      • If no prompt is given re: screensharing when you click the 'run' button, use Chrome's Developer Tools on a desktop or laptop to run this via emulation instead.
      • If emulating a mobile device, when prompted to screenshare, be sure to share the Chrome tab. The screen capture system will fail to capture the OSK properly otherwise.
  6. Save the result to a .html file, either before.html or after.html.
  7. When swapping versions, don't forget to rebuild.

compare.html

Compare allows you to load two runs of the renderer side-by-side (simply save the run to either before.html or after.html in this folder). It defaults to a width of 20% which you might need to tweak depending on the size of your display and the width of the OSK images.