| Subject: | Clarification about DOM-compatibility of user module may be needed in the documentation |
I got stuck with a phrase in the very beginning of perldoc XML::XPathEngine:
"In order to use the XPath engine, nodes in the user module need to
mimick DOM nodes. The degree of similitude between the user tree and a
DOM dictates how much of the XPath features can be used. A module
implementing all of the DOM should be able to use this module very
easily (you might need to add the cmp method on nodes in order to get
ordered result sets)."
In fact, the user module has to provide more methods than DOM (for
example, getRootNode) and the phrase above is very misleading. On my
machine only XML::Twig::XPath and XML::XPath::Node as well as
XML::XPathEngine itself provided getRootNode.
That's ok (I understand the necessarity of extra methods), but the
phrase above could be more specific, for example, refferring to 'nodes
implementing XML::XPath::Node interface' instead of plain 'DOM nodes'.
At least this information should be somewhere in documentation.