trying to make the documentation a little more straightforward to setup
[catagits/HTML-Zoom.git] / lib / HTML / Zoom / FilterBuilder.pm
index 58237ca..50398b3 100644 (file)
@@ -286,6 +286,8 @@ HTML::Zoom::FilterBuilder - Add Filters to a Stream
 
 =head1 SYNOPSIS
 
+Create an L<HTML::Zoom> instance:
+
   use HTML::Zoom;
   my $root = HTML::Zoom
       ->from_html(<<MAIN);
@@ -293,12 +295,32 @@ HTML::Zoom::FilterBuilder - Add Filters to a Stream
     <head>
       <title>Default Title</title>
     </head>
-    <body>
+    <body bad_attr='junk'>
       Default Content
     </body>
   </html>
   MAIN
 
+Create a new attribute on the  C<body> tag:
+
+  $root = $root
+    ->select('body')
+    ->set_attribute(class=>'main');
+
+Add a extra value to an existing attribute:
+
+  $root = $root
+    ->select('body')
+    ->add_to_attribute(class=>'one-column');
+
+Set the content of the C<title> tag:
+
+  $root = $root
+    ->select('title')
+    ->replace_content('Hello World');
+
+Set content from another L<HTML::Zoom> instance:
+
   my $body = HTML::Zoom
       ->from_html(<<BODY);
   <div id="stuff">
@@ -307,23 +329,27 @@ HTML::Zoom::FilterBuilder - Add Filters to a Stream
   </div>
   BODY
 
-  my $output =  $root
-    ->select('title')
-    ->replace_content('Hello World')
+  $root = $root
     ->select('body')
-    ->replace_content($body)
-    ->then
-    ->set_attribute(class=>'main')
+    ->replace_content($body);
+
+Set an attribute on multiple matches:
+
+  $root = $root
     ->select('p')
-    ->set_attribute(class=>'para')
-    ->select('#p2')
-    ->set_attribute(class=>'para2')
-    ->to_html;
+    ->set_attribute(class=>'para');
+
+Remove an attribute:
+
+  $root = $root
+    ->select('body')
+    ->remove_attribute('bad_attr');
 
 will produce:
 
 =begin testinfo
 
+  my $output = $root->to_html;
   my $expect = <<HTML;
 
 =end testinfo
@@ -332,9 +358,9 @@ will produce:
     <head>
       <title>Hello World</title>
     </head>
-    <body class="main"><div id="stuff">
+    <body class="main one-column"><div id="stuff">
       <p class="para">Well Now</p>
-      <p id="p2" class="para2">Is the Time</p>
+      <p id="p2" class="para">Is the Time</p>
   </div>
   </body>
   </html>
@@ -355,7 +381,7 @@ alter the content of that stream.
 
 This class defines the following public API
 
-=head2 set_attribute
+=head2 set_attribute ( $attr=>value | {name=>$attr,value=>$value} )
 
 Sets an attribute of a given name to a given value for all matching selections.
 
@@ -363,19 +389,37 @@ Sets an attribute of a given name to a given value for all matching selections.
       ->select('p')
       ->set_attribute(class=>'paragraph')
       ->select('div')
-      ->set_attribute(name=>'class', value=>'divider')
+      ->set_attribute(name=>'class', value=>'divider');
+
 
 Overrides existing values, if such exist.  When multiple L</set_attribute>
 calls are made against the same or overlapping selection sets, the final
 call wins.
 
-=head2 add_to_attribute
+=head2 add_to_attribute ( $attr=>value | {name=>$attr,value=>$value} )
 
-    TBD
+Adds a value to an existing attribute, or creates one if the attribute does not
+yet exist.
 
-=head2 remove_attribute
+    $html_zoom
+      ->select('p')
+      ->set_attribute(class=>'paragraph')
+      ->then
+      ->add_to_attribute(name=>'class', value=>'divider');
 
-    TBD
+Attributes with more than one value will have a dividing space.
+
+=head2 remove_attribute ( $attr | {name=>$attr} )
+
+Removes an attribute and all its values.
+
+    $html_zoom
+      ->select('p')
+      ->set_attribute(class=>'paragraph')
+      ->then
+      ->remove_attribute('class');
+
+Removes attributes from the original stream or events already added.
 
 =head2 collect