-wheic
-=====
+Peach HTML5 Editor
+==================
-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.
+This is a WYSIWYG HTML5 editor for the browser.
Status
------
-HTML5 parser: all (1581) tests pass. Works in the browser and node.js
+Early development stages.
+
+The HTML5 parser component passes the full test suite (1581 tests).
+
+The interface is starting to exist.
+
+
+Technologies
+------------
+
+Programming language: CoffeeScript (compiles to javascript)
+
+Interface: Implemented using the DOM api. No ``contenteditable`` or jquery.
-WYSIWYG editor: planning stages
Quick Start Guide
4. Try running the parser in the console, example:
- window.wheic.parse_html("<p>foo</p>", {fragment: "body"})
+ window.peach_parser.parse("<p>foo</p>", {fragment: "body"})
For further reading, see "Running Under node.js" below.
* Run the tests directly from CoffeeScript:
- coffee test.coffee
+ 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 test.js
+ nodejs parser_tests.js
* Try using the parser in your own javascript node.js project:
- var wheic = require('./parse-html.js');
- var dom = wheic.parse_html("<p>hi</p>", {fragment: 'body'});
+ 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:
- wheic = require './parse-html.js'
- dom = wheic.parse_html "<p>hi</p>", fragment: 'body'
+ 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