Bug #61125 for XML-LibXML: Some documentation typos

Mon Sep 06 17:00:54 2010 rrt [...] sc3d.org - Ticket created

Subject:

Some documentation typos

1. XML::LibXML::Parser: node whose subtree will be the content obtained by parsing the external resource; Although this is level of nesting is visible from the DOM it is transparent to XPath data model, so it is possible to match nodes in an unexpanded entity by the same XPath expression as if the entity was expanded. See also ext_ent_handler. "Although this is level of nesting is" -> "although this nesting is" "was expanded" -> "were expanded" (subjunctive needed here) "labeled labeled" -> "labeled" "XML:LibXML" -> "XML::LibXML" The function "load_html" is incorrectly headed "load_xml". After this function, the indenting goes wrong: all the rest of the parsing functions are indented by one extra level. The indenting should return to the top level at the paragraph starting "The functions described above are implemented to parse well formed documents." 2. XML::LibXML::Element parse_xml_chunk -> parse_balanced_chunk (use the current name, not the old one) 3. XML::LibXML "considered a bad practice" -> "considered bad practice"

Wed Nov 24 19:30:44 2010 daniel.frett [...] ccci.org - Correspondence added

From:

daniel.frett [...] ccci.org

attached a patch, the only thing this patch doesn't address is the load_xml => load_html change because it was already applied On Mon Sep 06 17:00:54 2010, rrt wrote: Show quoted text

> 1. XML::LibXML::Parser: > > node whose subtree will be the content obtained by parsing > the external resource; Although this is level of nesting is visible > from the DOM it is transparent to XPath data model, so it is > possible to match nodes in an unexpanded entity by the same XPath > expression as if the entity was expanded. See also > ext_ent_handler. > > "Although this is level of nesting is" -> "although this nesting is" > "was expanded" -> "were expanded" (subjunctive needed here) > > "labeled labeled" -> "labeled" > > "XML:LibXML" -> "XML::LibXML" > > The function "load_html" is incorrectly headed "load_xml". After this > function, the indenting goes wrong: all the rest of the parsing > functions are indented by one extra level. The indenting should return > to the top level at the paragraph starting "The functions described > above are implemented to parse well formed documents." > > 2. XML::LibXML::Element > > parse_xml_chunk -> parse_balanced_chunk (use the current name, not the > old one) > > 3. XML::LibXML > > "considered a bad practice" -> "considered bad practice"

Subject:

RT61125.patch

diff --git a/docs/libxml.dbk b/docs/libxml.dbk index 089844b..f77d7dc 100644 --- a/docs/libxml.dbk +++ b/docs/libxml.dbk @@ -635,7 +635,7 @@ $xml_document = $doc->toString(); # returns a byte string <para>DOM methods also accept binary strings in the original encoding of the document to which the node belongs (UTF-8 is assumed if the node is not attached to any document). Exploiting this feature is NOT RECOMMENDED - since it is considered a bad practice. + since it is considered bad practice. </para> <programlisting><![CDATA[ my $doc = XML::LibXML:Document->new('1.0','iso-8859-2'); @@ -1149,6 +1149,7 @@ $dom = $parser->load_html(...); </para> </listitem> </varlistentry> + </variablelist> <para>Parsing HTML may cause problems, especially if the ampersand ('&') is used. This is a common @@ -1348,9 +1349,6 @@ $dom = $parser->load_html(...); </listitem> </varlistentry> </variablelist> - - - </variablelist> </sect2> <sect2> @@ -1593,7 +1591,7 @@ local $XML::LibXML::setTagCompression = 1;</programlisting> IMPORTANT NOTE: This documentation reflects the parser flags available in libxml2 2.7.3. Some options have no effect if an older version of libxml2 is used. </para> - <para>Each of the flags listed below is labeled labeled</para> + <para>Each of the flags listed below is labeled</para> <variablelist> <varlistentry> <term>/parser/</term> @@ -1681,11 +1679,10 @@ local $XML::LibXML::setTagCompression = 1;</programlisting> when substitution of an external entity is disabled, the entity will be represented in the document tree by a XML_ENTITY_REF_NODE node whose subtree will be the content obtained by parsing the external resource; - Although this is level - of nesting is visible from the DOM + Although this nesting is visible from the DOM it is transparent to XPath data model, so it is possible to match nodes in an unexpanded entity by the same XPath expression - as if the entity was expanded. See also ext_ent_handler. + as if the entity were expanded. See also ext_ent_handler. </para> </listitem> </varlistentry> @@ -1848,7 +1845,7 @@ $parser->input_callbacks($c); <listitem> <para>/parser/</para> <para>THIS OPTION IS EXPERIMENTAL!</para> - <para>Although quite powerful, XML:LibXML's DOM implementation is incomplete with respect to + <para>Although quite powerful, XML::LibXML's DOM implementation is incomplete with respect to the DOM level 2 or level 3 specifications. XML::GDOME is based on libxml2 as well and and provides a rather complete DOM implementation by wrapping libgdome. This flag allows you to make @@ -4345,7 +4342,7 @@ $ec14nstring = $node->toStringEC14N($with_comments, $xpath_expression, $xpath <para><emphasis>Note that appendWellBalancedChunk() is only left for compatibility reasons</emphasis>. Implicitly it uses</para> - <programlisting> my $fragment = $parser->parse_xml_chunk( $chunk ); + <programlisting> my $fragment = $parser->parse_balanced_chunk( $chunk ); $node->appendChild( $fragment );</programlisting> <para>This form is more explicit and makes it easier to control the flow of a script.</para>

Wed Nov 24 19:30:45 2010 The RT System itself - Status changed from 'new' to 'open'

Thu Jun 23 03:51:38 2011 SHLOMIF [...] cpan.org - Correspondence added

Fixed on CPAN by applying Daniel's patch. Thanks for the report.

Thu Jun 23 03:51:39 2011 SHLOMIF [...] cpan.org - Status changed from 'open' to 'resolved'