diff options
author | bptato <nincsnevem662@gmail.com> | 2024-10-05 20:33:51 +0200 |
---|---|---|
committer | bptato <nincsnevem662@gmail.com> | 2024-10-05 20:33:55 +0200 |
commit | fee73e9338d30deedfb58d4bcd85cc1d5fb2c0f0 (patch) | |
tree | dae289c6088bc2f279df981a00ad7f5db7a7a888 | |
parent | b4359aea7f807932f45409cdac28d1c60889882f (diff) | |
download | chawan-fee73e9338d30deedfb58d4bcd85cc1d5fb2c0f0.tar.gz |
Update docs
-rw-r--r-- | doc/.index.md | 2 | ||||
-rw-r--r-- | doc/manual.md | 9 | ||||
-rwxr-xr-x | gendoc.sh | 2 |
3 files changed, 8 insertions, 5 deletions
diff --git a/doc/.index.md b/doc/.index.md index 7e6e6c33..a38863e6 100644 --- a/doc/.index.md +++ b/doc/.index.md @@ -1,5 +1,7 @@ # Documentation of Chame, an HTML5 parsing library written in Nim. +To get started, please read the [readme](https://git.sr.ht/~bptato/chame). + Index of the (stable) public API: * [minidom](minidom.html): minimal DOM module and a high-level interface to the diff --git a/doc/manual.md b/doc/manual.md index a1a1b1ff..a028d9ae 100644 --- a/doc/manual.md +++ b/doc/manual.md @@ -143,7 +143,7 @@ appropriate functions (`createElementImpl`, etc.) will be called by the parser. pass the **same** buffer (`inputBuf`) as in the current one. For details, see below. -Special care is required when implementing that have scripting support. The +Special care is required when implementing programs with scripting support. The HTML5 standard requires the parser to be re-entrant for supporting the `document.write` JavaScript function; therefore the parser suspends itself upon encountering a `</script>` end tag, returning a `PRES_SCRIPT` `ParseResult`. @@ -154,7 +154,7 @@ At this point, implementations have two options. If either: -* your implementation either does not support `document.write`, or +* your implementation does not support `document.write`, or * no `document.write` call has been issued by the script, or * parsing of all buffers passed by `document.write` calls has finished, @@ -265,8 +265,9 @@ while stack.len > 0: stack.add(node.childList[i]) ``` -For more advanced usage of minidom, please study the tests/tree.nim and -tests/shared/tree_common.nim which together are a runner of html5lib-tests. +For more advanced usage of minidom, please study tests/tree.nim and +tests/shared/tree_common.nim which together constitute a test runner of +html5lib-tests. For an example implementation of [htmlparseriface](htmlparseriface.html), please check the source code of [minidom](minidom.html) (and of diff --git a/gendoc.sh b/gendoc.sh index 02175778..4e7f5578 100755 --- a/gendoc.sh +++ b/gendoc.sh @@ -3,7 +3,7 @@ mkdir -p .obj/doc for f in chame/*.nim do if test "$f" = "chame/htmlparseriface.nim" then nim doc -d:nimdocdummy --outdir:.obj/doc "$f" - else nim doc --outdir:.obj/doc "$f" + else nim doc -p:test/chagashi/ --outdir:.obj/doc "$f" fi sed -i \ -e '/<\!-- Google fonts -->/,+2d' \ |