## how to use this code
##################################
#
-# See README.md for how to pre-compile this file, or compile it in the browser.
+# See README.md for how to run this file in the browser or in node.js.
#
-# This file exports a single useful function: parse_tml
-#
-# Once you include this file in a page (see index.html for an example) you'll
-# have window.wheic
+# This file exports a single useful function: parse_tml, and some constants
+# (see the bottom of this file for those.)
#
# Call it like this:
#
#
# wheic.parse_html({fragment: "body", html: "<p><b>hi</p>"})
#
-# This code can _almost_ run outside the browser (eg under node.js). To get it
-# to run without the browser would require native implementation of
-# decode_named_char_ref(). The current implementation of that function uses the
-# browser's DOM api, to save space (the list of valid named characters is
-# massive.)
+# return value is an array of Nodes, see "class Node" below.
# This code is a work in progress, eg try search this file for "fixfull",
# "TODO" and "FIXME"
#
# example: open_els = [a, b, c, d, e, f, g]
#
-# "grows downwards" means it's visualized like this: (index: el, names)
+# "grows downwards" means it's visualized like this: (index: el "names")
#
# 6: g "start of the list", "topmost", "first"
# 5: f