Basics

• selector => $text

  Scalar: Replace the inner content with this as Text.

    $ts->process($template, {
        'h1' => 'foo & bar',   # <h1></h1> =>
                               # <h1>foo &amp; bar</h1>
         
        '.foo@href' => '/foo', # <a href="#" class="foo">bar</a> =>
                               # <a href="/foo" class="foo">bar</a>
    });
      

• selector => \$html

  Scalar-ref: Replace the inner content with this as fragment XML/HTML.

    $ts->process($template, {
        'h1' => \'<a href="#">foo</a>bar', # <h1></h1> =>
                                           # <h1><a href="#">foo</a>bar</h1>
    });
      

• selector => undef

  undef: Delete the element/attirbute that the selector indicates.

    $ts->process($template, {
        'h1'            => undef, # <div><h1>foo</h1>bar</div> =>
                                  # <div>bar</div>
        
        'div.foo@class' => undef, # <div class="foo">foo</div> =>
                                  # <div>foo</div>
    });
      

• selector => XML::LibXML::Node

  Replace the inner content by the node. XML::LibXML::Attr isn't supported.

    $ts->process($template, {
        'h1' => do { XML::LibXML::Text->new('foo') },
    });
      

• selector => Template::Semantic::Document

  Replace the inner content by another "process()"-ed result.

    $ts->process('wrapper.html', {
        'div#content' => $ts->process('inner.html', ...),
    });
      

• selector => { 'selector' => $value, ... }

  Hash-ref: Sub query of the part.

    $ts->process($template, {
        # All <a> tag *in <div class="foo">* disappears
        'div.foo' => {
            'a' => undef,
        },
        
        # same as above
        'div.foo a' => undef,
        
        # xpath '.' = current node (itself)
        'a#bar' => {
            '.'       => 'foobar',
            './@href' => 'foo.html',
        },
        
        # same as above
        'a#bar'       => 'foobar',
        'a#bar/@href' => 'foo.html',
    });
      

Loop

•

selector => [ \%row, \%row, ... ]

Array-ref of Hash-refs: Loop the part as template. Each item of the array-ref should be hash-ref.

  $ts->process(\*DATA, {
      'table.list tr' => [
          { 'th' => 'aaa', 'td' => '001' },
          { 'th' => 'bbb', 'td' => '002' },
          { 'th' => 'ccc', 'td' => '003' },
      ],
  });
  
  __DATA__
  <table class="list">
      <tr>
          <th></th>
          <td></td>
      </tr>
  </table>
    

Output:

  <table class="list">
      <tr>
          <th>aaa</th>
          <td>001</td>
      </tr>
      <tr>
          <th>bbb</th>
          <td>002</td>
      </tr>
      <tr>
          <th>ccc</th>
          <td>003</td>
      </tr>
  </table>
    

Callback

•

selector => \&foo

Code-ref: Callback subroutine. The callback receives

  $_    => innerHTML
  $_[0] => XML::LibXML::Node object (X::L::Element, X::L::Attr, ...)
    

Its return value is handled per this list of value types (scalar to replace content, undef to delete, etc.).

  $ts->process($template, {
      # samples
      'h1' => sub { "bar" }, # <h1>foo</h1> => <h1>bar</h1>
      'h1' => sub { undef }, # <h1>foo</h1> => disappears
      
      # sample: use $_
      'h1' => sub { uc },  # <h1>foo</h1> => <h1>FOO</h1>
      
      # sample: use $_[0]
      'h1' => sub {
          my $node = shift;
          $node->nodeName; # <h1>foo</h1> => <h1>h1</h1>
      },
  });
    

Filter

•

selector => [ $value, filter, filter, ... ]

Array-ref of Scalars: Value and filters. Filters may be

A) Callback subroutine (code reference)

B) Defined filter name

C) Object like Text::Pipe ("it->can('filter')")

  $ts->process($template, {
      'h1' => [ 'foo', sub { uc }, sub { "$_!" } ], # => <h1>FOO!</h1>
      'h2' => [ ' foo ', 'trim', sub { "$_!" } ],   # => <h2>FOO!</h2>
      'h3' => [ 'foo', PIPE('UppercaseFirst') ],    # => <h3>Foo</h3>
  });