Quick Start Guide
-----------------
-1. Open ``test.html`` in your browser.
+1. Open ``parser_tests_coffee.html`` in your browser.
2. Open the console (right-click, inspect this element, console)
Running Under node.js
---------------------
-Dependancies: node.js, coffeescript
+Dependencies: node.js, CoffeeScript
1. Install node.js https://nodejs.org/en/
-2. Install coffeescript. Try:
+2. Install CoffeeScript. Try:
apt-get install coffeescript
or
npm install -g coffee-script
-3. You can run the tests directly from coffeescript:
-
- coffee test.coffee
-
4. Compile to javascript:
make
-5. Run tests via compiled code:
+Now you can do any of these things in any order:
+
+* Run the tests directly from CoffeeScript:
+
+ coffee test.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
-5. Try using the parser in your own code:
+* 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'});
...
+* 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'
+ ...
+
+ 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
------------------------
--- /dev/null
+<!DOCTYPE html>
+<html lang="en">
+<head>
+ <meta charset="UTF-8">
+ <link rel="icon" href="data:;base64,iVBORw0KGgo=">
+ <title>html parser tester</title>
+</head>
+<body>
+ <h1>WHEIC html parser test page (javascript version)</h1>
+ <p>You'll need to run <code>make</code> to build the javascript files used on this page.</p>
+ <p>If you don't have node.js and CoffeeScript installed, you can <a href="parser_tests_coffee.html">use the other test page</a> which compiles the CoffeeScript files on the fly in the browser.</p>
+ <p>Check the inspector/console for test results.</p>
+ <script src="parse-html.js"></script>
+ <script src="test.js"></script>
+</body>
+</html>
--- /dev/null
+<!DOCTYPE html>
+<html lang="en">
+<head>
+ <meta charset="UTF-8">
+ <link rel="icon" href="data:;base64,iVBORw0KGgo=">
+ <title>html parser tester</title>
+</head>
+<body>
+ <h1>WHEIC html parser test page (CoffeeScript version)</h1>
+ <p>This version of the test page compiles the CoffeeScript files in the browser, so you don't have to install CoffeeScript (or node.js).</p>
+ <p>It can take a few seconds for the tests to compile.</p>
+ <p>Check the inspector/console for test results.</p>
+ <script src="parse-html.coffee" type="text/coffeescript"></script>
+ <script src="test.coffee" type="text/coffeescript"></script>
+ <script src="coffee-script.js"></script>
+</body>
+</html>
+++ /dev/null
-<!DOCTYPE html>
-<html lang="en">
-<head>
- <meta charset="UTF-8">
- <link rel="icon" href="data:;base64,iVBORw0KGgo=">
- <title>html parser tester</title>
-</head>
-<body>
- <h1>WHEIC test page.</h1>
- <p>It can take a few seconds for the tests to compile.</p>
- <p>Check the inspector/console for test results.</p>
- <script src="parse-html.coffee" type="text/coffeescript"></script>
- <script src="test.coffee" type="text/coffeescript"></script>
- <script src="coffee-script.js"></script>
-</body>
-</html>
Got questions, comments, patches, etc.? Contact Jason Woofenden