Annotation-Pushers
/
Annotation-System
1
Fork 0
Code Issues 1 Pull Requests Projects Releases Wiki Activity
Annotation-System/README.md

1.8 KiB
Raw Blame History

Fair warning: This is all under development and not production ready

hmml_to_html

Build

Clone the repo, cd hmml_to_html and run:

zsh hmml_to_html.c

(replacing zsh with your shell as appropriate)

This outputs a binary hmml_to_html

Run

Ordinary operation

./hmml_to_html test.hmml

This simply generates an HTML file (and updates cinera_topics.css if needed) from test.hmml and outputs to out.html

Note that if the .hmml file contains quotes (as test.hmml does), it would be easiest for now just to remove the quote from test.hmml. If you want quotes to work, run:

mkdir /home/matt/git/GitHub/insofaras/25fc16d58a297a486334
git clone https://gist.github.com/insofaras/25fc16d58a297a486334 /home/matt/git/GitHub/insofaras/25fc16d58a297a486334

(Seriously, the path is hardcoded for now)

Note also that cinera.css contains a body {} block at the bottom which you may want to remove / comment out

Integration

CINERA_MODE=INTEGRATE ./hmml_to_html test.hmml

This will integrate into template.html (currently hardcoded) the player and related elements generated from test.hmml and output to out.html

Feel free to play with template.html to your heart's content. If you do anything invalid, hmml_to_html will tell you what's wrong

Valid tags:

  • <!-- __CINERA_TITLE__ --> the day / episode name, intended to be used inside your own <title> element, but may be used wherever and as many times as you want on your page
  • <!-- __CINERA_INCLUDES__ --> the necessary .css and .js files, and charset setting
  • <!-- __CINERA_MENUS__ --> _ the menu bar that typically appears above the player in my samples
  • <!-- __CINERA_PLAYER__ --> the player
  • <!-- __CINERA_SCRIPT__ --> the listeners that enable interaction with the player