wheic
=====

This project is to build a HTML5 parser, then use that to build a WYSIWYG html
editor for the browser.

The code is written in CoffeeScript for modern browsers. The HTML5 parser can
also run under node.js.


Status
------

HTML5 parser: all (1581) tests pass. Works in the browser and node.js

WYSIWYG editor: planning stages


Quick Start Guide
-----------------

1.	Open ``parser_tests_coffee.html`` in your browser.

2.	Open the console (right-click, inspect this element, console)

3.	After a few seconds, you should see "Tests passed: 1581, Failed: 0" in the
	console.

4.	Try running the parser in the console, example:

		window.wheic_parser.parse("<p>foo</p>", {fragment: "body"})

For further reading, see "Running Under node.js" below.


Running Under node.js
---------------------

Dependencies: node.js, CoffeeScript

1.	Install node.js https://nodejs.org/en/

2.	Install CoffeeScript. Try:

		apt-get install coffeescript
	or

		npm install -g coffee-script

4.	Compile to javascript:

		make

Now you can do any of these things in any order:

*	Run the tests directly from CoffeeScript:

		coffee parser_tests.coffee

*	Test the compiled (javascript) parser in your favorite browser by opening
	up ``parser_tests.html`` and looking at the console.

*	Run tests via compiled code:

		nodejs parser_tests.js

*	Try using the parser in your own javascript node.js project:

		var html5 = require('./parser.js');
		var dom = html5.parse("<p>hi</p>", {fragment: 'body'});
		...

*	Try using the parser in your own CoffeeScript node.js project:

		html5 = require './parser.js'
		dom = html5.parse "<p>hi</p>", fragment: 'body'
		...

	Note: the CoffeeScript compile time is significant, so you'll want to use
	the compiled javascript even though you could use the ``.coffee`` version.


Feedback, Questions, Etc
------------------------

Please communicate directly with Jason Woofenden by email: jason@jasonwoof.com
or on freenode /msg JasonWoof