X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=README.pod;h=fc667fef37d1467389989b3f7b883c376c771166;hb=c0f0ce8910e956686984bd11508cf7df8bd2dcd3;hp=2bf0aa84e609eaea917aa784e837b9a4f900e070;hpb=3187745294af04bb4f3ece751c5d947f373039e5;p=catagits%2FDOM-Tiny.git

diff --git a/README.pod b/README.pod
index 2bf0aa8..fc667fe 100644
--- a/README.pod
+++ b/README.pod
@@ -77,8 +77,8 @@ names are lowercased and selectors need to be lowercase as well.
   my $dom = DOM::Tiny->new('<P ID="greeting">Hi!</P>');
   say $dom->at('p[id]')->text;
 
-If XML processing instructions are found, the parser will automatically switch
-into XML mode and everything becomes case-sensitive.
+If an XML declaration is found, the parser will automatically switch into XML
+mode and everything becomes case-sensitive.
 
   # XML semantics
   my $dom = DOM::Tiny->new('<?xml version="1.0"?><P ID="greeting">Hi!</P>');
@@ -99,32 +99,34 @@ XML detection can also be disabled with the L</"xml"> method.
 L<DOM::Tiny> uses a CSS selector engine based on L<Mojo::DOM::CSS>. All CSS
 selectors that make sense for a standalone parser are supported.
 
-=head2 *
+=over
+
+=item Z<>*
 
 Any element.
 
   my $all = $dom->find('*');
 
-=head2 E
+=item E
 
 An element of type C<E>.
 
   my $title = $dom->at('title');
 
-=head2 E[foo]
+=item E[foo]
 
 An C<E> element with a C<foo> attribute.
 
   my $links = $dom->find('a[href]');
 
-=head2 E[foo="bar"]
+=item E[foo="bar"]
 
 An C<E> element whose C<foo> attribute value is exactly equal to C<bar>.
 
   my $case_sensitive = $dom->find('input[type="hidden"]');
   my $case_sensitive = $dom->find('input[type=hidden]');
 
-=head2 E[foo="bar" i]
+=item E[foo="bar" i]
 
 An C<E> element whose C<foo> attribute value is exactly equal to any
 (ASCII-range) case-permutation of C<bar>. Note that this selector is
@@ -138,7 +140,7 @@ This selector is part of
 L<Selectors Level 4|http://dev.w3.org/csswg/selectors-4>, which is still a work
 in progress.
 
-=head2 E[foo~="bar"]
+=item E[foo~="bar"]
 
 An C<E> element whose C<foo> attribute value is a list of whitespace-separated
 values, one of which is exactly equal to C<bar>.
@@ -146,7 +148,7 @@ values, one of which is exactly equal to C<bar>.
   my $foo = $dom->find('input[class~="foo"]');
   my $foo = $dom->find('input[class~=foo]');
 
-=head2 E[foo^="bar"]
+=item E[foo^="bar"]
 
 An C<E> element whose C<foo> attribute value begins exactly with the string
 C<bar>.
@@ -154,7 +156,7 @@ C<bar>.
   my $begins_with = $dom->find('input[name^="f"]');
   my $begins_with = $dom->find('input[name^=f]');
 
-=head2 E[foo$="bar"]
+=item E[foo$="bar"]
 
 An C<E> element whose C<foo> attribute value ends exactly with the string
 C<bar>.
@@ -162,20 +164,20 @@ C<bar>.
   my $ends_with = $dom->find('input[name$="o"]');
   my $ends_with = $dom->find('input[name$=o]');
 
-=head2 E[foo*="bar"]
+=item E[foo*="bar"]
 
 An C<E> element whose C<foo> attribute value contains the substring C<bar>.
 
   my $contains = $dom->find('input[name*="fo"]');
   my $contains = $dom->find('input[name*=fo]');
 
-=head2 E:root
+=item E:root
 
 An C<E> element, root of the document.
 
   my $root = $dom->at(':root');
 
-=head2 E:nth-child(n)
+=item E:nth-child(n)
 
 An C<E> element, the C<n-th> child of its parent.
 
@@ -184,7 +186,7 @@ An C<E> element, the C<n-th> child of its parent.
   my $even  = $dom->find('div:nth-child(even)');
   my $top3  = $dom->find('div:nth-child(-n+3)');
 
-=head2 E:nth-last-child(n)
+=item E:nth-last-child(n)
 
 An C<E> element, the C<n-th> child of its parent, counting from the last one.
 
@@ -193,7 +195,7 @@ An C<E> element, the C<n-th> child of its parent, counting from the last one.
   my $even     = $dom->find('div:nth-last-child(even)');
   my $bottom3  = $dom->find('div:nth-last-child(-n+3)');
 
-=head2 E:nth-of-type(n)
+=item E:nth-of-type(n)
 
 An C<E> element, the C<n-th> sibling of its type.
 
@@ -202,7 +204,7 @@ An C<E> element, the C<n-th> sibling of its type.
   my $even  = $dom->find('div:nth-of-type(even)');
   my $top3  = $dom->find('div:nth-of-type(-n+3)');
 
-=head2 E:nth-last-of-type(n)
+=item E:nth-last-of-type(n)
 
 An C<E> element, the C<n-th> sibling of its type, counting from the last one.
 
@@ -211,109 +213,111 @@ An C<E> element, the C<n-th> sibling of its type, counting from the last one.
   my $even     = $dom->find('div:nth-last-of-type(even)');
   my $bottom3  = $dom->find('div:nth-last-of-type(-n+3)');
 
-=head2 E:first-child
+=item E:first-child
 
 An C<E> element, first child of its parent.
 
   my $first = $dom->find('div p:first-child');
 
-=head2 E:last-child
+=item E:last-child
 
 An C<E> element, last child of its parent.
 
   my $last = $dom->find('div p:last-child');
 
-=head2 E:first-of-type
+=item E:first-of-type
 
 An C<E> element, first sibling of its type.
 
   my $first = $dom->find('div p:first-of-type');
 
-=head2 E:last-of-type
+=item E:last-of-type
 
 An C<E> element, last sibling of its type.
 
   my $last = $dom->find('div p:last-of-type');
 
-=head2 E:only-child
+=item E:only-child
 
 An C<E> element, only child of its parent.
 
   my $lonely = $dom->find('div p:only-child');
 
-=head2 E:only-of-type
+=item E:only-of-type
 
 An C<E> element, only sibling of its type.
 
   my $lonely = $dom->find('div p:only-of-type');
 
-=head2 E:empty
+=item E:empty
 
 An C<E> element that has no children (including text nodes).
 
   my $empty = $dom->find(':empty');
 
-=head2 E:checked
+=item E:checked
 
 A user interface element C<E> which is checked (for instance a radio-button or
 checkbox).
 
   my $input = $dom->find(':checked');
 
-=head2 E.warning
+=item E.warning
 
 An C<E> element whose class is "warning".
 
   my $warning = $dom->find('div.warning');
 
-=head2 E#myid
+=item E#myid
 
 An C<E> element with C<ID> equal to "myid".
 
   my $foo = $dom->at('div#foo');
 
-=head2 E:not(s)
+=item E:not(s)
 
 An C<E> element that does not match simple selector C<s>.
 
   my $others = $dom->find('div p:not(:first-child)');
 
-=head2 E F
+=item E F
 
 An C<F> element descendant of an C<E> element.
 
   my $headlines = $dom->find('div h1');
 
-=head2 E E<gt> F
+=item E E<gt> F
 
 An C<F> element child of an C<E> element.
 
   my $headlines = $dom->find('html > body > div > h1');
 
-=head2 E + F
+=item E + F
 
 An C<F> element immediately preceded by an C<E> element.
 
   my $second = $dom->find('h1 + h2');
 
-=head2 E ~ F
+=item E ~ F
 
 An C<F> element preceded by an C<E> element.
 
   my $second = $dom->find('h1 ~ h2');
 
-=head2 E, F, G
+=item E, F, G
 
 Elements of type C<E>, C<F> and C<G>.
 
   my $headlines = $dom->find('h1, h2, h3');
 
-=head2 E[foo=bar][bar=baz]
+=item E[foo=bar][bar=baz]
 
 An C<E> element whose attributes match all following attribute selectors.
 
   my $links = $dom->find('a[foo^=b][foo$=ar]');
 
+=back
+
 =head1 OPERATORS
 
 L<DOM::Tiny> overloads the following operators.
@@ -390,7 +394,7 @@ objects. All selectors listed in L</"SELECTORS"> are supported.
 
   $dom = $dom->append('<p>I ♥ DOM::Tiny!</p>');
 
-Append HTML/XML fragment to this node.
+Append HTML/XML fragment to this node (for all node types other than C<root>).
 
   # "<div><h1>Test</h1><h2>123</h2></div>"
   $dom->parse('<div><h1>Test</h1></div>')
@@ -423,8 +427,8 @@ node's content.
   my $result = $dom->at('div ~ p');
 
 Find first descendant element of this element matching the CSS selector and
-return it as a L<DOM::Tiny> object or return C<undef> if none could be found.
-All selectors listed in L</"SELECTORS"> are supported.
+return it as a L<DOM::Tiny> object, or C<undef> if none could be found. All
+selectors listed in L</"SELECTORS"> are supported.
 
   # Find first element with "svg" namespace definition
   my $namespace = $dom->at('[xmlns\:svg]')->{'xmlns:svg'};
@@ -580,7 +584,7 @@ L</"SELECTORS"> are supported.
 
   my $namespace = $dom->namespace;
 
-Find this element's namespace or return C<undef> if none could be found.
+Find this element's namespace, or return C<undef> if none could be found.
 
   # Find namespace for an element with namespace prefix
   my $namespace = $dom->at('svg > svg\:circle')->namespace;
@@ -592,8 +596,8 @@ Find this element's namespace or return C<undef> if none could be found.
 
   my $sibling = $dom->next;
 
-Return L<DOM::Tiny> object for next sibling element or C<undef> if there are no
-more siblings.
+Return L<DOM::Tiny> object for next sibling element, or C<undef> if there are
+no more siblings.
 
   # "<h2>123</h2>"
   $dom->parse('<div><h1>Test</h1><h2>123</h2></div>')->at('h1')->next;
@@ -602,7 +606,7 @@ more siblings.
 
   my $sibling = $dom->next_node;
 
-Return L<DOM::Tiny> object for next sibling node or C<undef> if there are no
+Return L<DOM::Tiny> object for next sibling node, or C<undef> if there are no
 more siblings.
 
   # "456"
@@ -617,8 +621,11 @@ more siblings.
 
   my $parent = $dom->parent;
 
-Return L<DOM::Tiny> object for parent of this node or C<undef> if this node has
-no parent.
+Return L<DOM::Tiny> object for parent of this node, or C<undef> if this node
+has no parent.
+
+  # "<b><i>Test</i></b>"
+  $dom->parse('<p><b><i>Test</i></b></p>')->at('i')->parent;
 
 =head2 parse
 
@@ -627,7 +634,7 @@ no parent.
 Parse HTML/XML fragment.
 
   # Parse XML
-  my $dom = DOM::Tiny->new->xml(1)->parse($xml);
+  my $dom = DOM::Tiny->new->xml(1)->parse('<foo>I ♥ DOM::Tiny!</foo>');
 
 =head2 preceding
 
@@ -655,7 +662,7 @@ before this node as L<DOM::Tiny> objects.
 
   $dom = $dom->prepend('<p>I ♥ DOM::Tiny!</p>');
 
-Prepend HTML/XML fragment to this node.
+Prepend HTML/XML fragment to this node (for all node types other than C<root>).
 
   # "<div><h1>Test</h1><h2>123</h2></div>"
   $dom->parse('<div><h2>123</h2></div>')
@@ -687,7 +694,7 @@ node's content.
 
   my $sibling = $dom->previous;
 
-Return L<DOM::Tiny> object for previous sibling element or C<undef> if there
+Return L<DOM::Tiny> object for previous sibling element, or C<undef> if there
 are no more siblings.
 
   # "<h1>Test</h1>"
@@ -697,7 +704,7 @@ are no more siblings.
 
   my $sibling = $dom->previous_node;
 
-Return L<DOM::Tiny> object for previous sibling node or C<undef> if there are
+Return L<DOM::Tiny> object for previous sibling node, or C<undef> if there are
 no more siblings.
 
   # "123"
@@ -833,13 +840,13 @@ C<root>, C<tag> or C<text>.
   my $value = $dom->val;
 
 Extract value from form element (such as C<button>, C<input>, C<option>,
-C<select> and C<textarea>) or return C<undef> if this element has no value. In
+C<select> and C<textarea>), or return C<undef> if this element has no value. In
 the case of C<select> with C<multiple> attribute, find C<option> elements with
-C<selected> attribute and return an array reference with all values or C<undef>
-if none could be found.
+C<selected> attribute and return an array reference with all values, or
+C<undef> if none could be found.
 
   # "a"
-  $dom->parse('<input name="test" value="a">')->at('input')->val;
+  $dom->parse('<input name=test value=a>')->at('input')->val;
 
   # "b"
   $dom->parse('<textarea>b</textarea>')->at('textarea')->val;
@@ -855,12 +862,15 @@ if none could be found.
   $dom->parse('<select multiple><option selected>e</option></select>')
     ->at('select')->val->[0];
 
+  # "on"
+  $dom->parse('<input name=test type=checkbox>')->at('input')->val;
+
 =head2 wrap
 
   $dom = $dom->wrap('<div></div>');
 
-Wrap HTML/XML fragment around this node, placing it as the last child of the
-first innermost element.
+Wrap HTML/XML fragment around this node (for all node types other than C<root>),
+placing it as the last child of the first innermost element.
 
   # "<p>123<b>Test</b></p>"
   $dom->parse('<b>Test</b>')->at('b')->wrap('<p>123</p>')->root;
@@ -878,8 +888,8 @@ first innermost element.
 
   $dom = $dom->wrap_content('<div></div>');
 
-Wrap HTML/XML fragment around this node's content, placing it as the last
-children of the first innermost element.
+Wrap HTML/XML fragment around this node's content (for C<root> and C<tag>
+nodes), placing it as the last children of the first innermost element.
 
   # "<p><b>123Test</b></p>"
   $dom->parse('<p>Test<p>')->at('p')->wrap_content('<b>123</b>')->root;
@@ -893,7 +903,7 @@ children of the first innermost element.
   $dom     = $dom->xml($bool);
 
 Disable HTML semantics in parser and activate case-sensitivity, defaults to
-auto detection based on processing instructions.
+auto detection based on XML declarations.
 
 =head1 COLLECTION METHODS
 
@@ -952,8 +962,8 @@ passed to the callback and is also available as C<$_>.
   # Longer version
   my $first = $collection->first(sub { $_->$method(@args) });
 
-  # Find first value that contains the word "dom"
-  my $interesting = $collection->first(qr/dom/i);
+  # Find first value that contains the word "tiny"
+  my $interesting = $collection->first(qr/tiny/i);
 
   # Find first value that is greater than 5
   my $greater = $collection->first(sub { $_ > 5 });
@@ -984,8 +994,8 @@ C<$_>.
   # Longer version
   my $new = $collection->grep(sub { $_->$method(@args) });
 
-  # Find all values that contain the word "dom"
-  my $interesting = $collection->grep(qr/dom/i);
+  # Find all values that contain the word "tiny"
+  my $interesting = $collection->grep(qr/tiny/i);
 
   # Find all values that are greater than 5
   my $greater = $collection->grep(sub { $_ > 5 });
@@ -1019,8 +1029,8 @@ passed to the callback and is also available as C<$_>.
   # Longer version
   my $new = $collection->map(sub { $_->$method(@args) });
 
-  # Append the word "dom" to all values
-  my $domified = $collection->map(sub { $_ . 'dom' });
+  # Append the word "tiny" to all values
+  my $domified = $collection->map(sub { $_ . 'tiny' });
 
 =head2 reduce
 
@@ -1114,9 +1124,21 @@ Report any issues on the public bugtracker.
 
 Dan Book <dbook@cpan.org>
 
+Code and tests adapted from L<Mojo::DOM>, a lightweight DOM parser by the L<Mojolicious> team.
+
+=head1 CONTRIBUTORS
+
+=over
+
+=item Matt S Trout (mst)
+
+=back
+
 =head1 COPYRIGHT AND LICENSE
 
-This software is Copyright (c) 2015 by Dan Book.
+Copyright (c) 2008-2015 Sebastian Riedel.
+
+Copyright (c) 2015 L</"AUTHOR"> and L</"CONTRIBUTORS"> for adaptation to standalone format.
 
 This is free software, licensed under: