<?xml version="1.0" encoding="UTF-8"?>
<!--
  Licensed to the Apache Software Foundation (ASF) under one or more
  contributor license agreements.  See the NOTICE file distributed with
  this work for additional information regarding copyright ownership.
  The ASF licenses this file to You under the Apache License, Version 2.0
  (the "License"); you may not use this file except in compliance with
  the License.  You may obtain a copy of the License at

      http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
-->
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.0//EN" "../../dtd/document-v10.dtd">

<document>
  <header>
    <title>LinkTranslatorMapAction in Cocoon</title>
    <version>0.9</version>
    <type>Technical document</type>
    <authors>
      <person name="Your Name" email="your-email"/>
    </authors>
    <abstract>This document describes the LinkTranslatorMapAction of Cocoon.</abstract>
  </header>
  <body>
    <s1 title="LinkTranslatorMapAction">
      <table>
        <tr>
          <td>NAME</td><td>link-translator-map</td>
        </tr>
        <tr>
          <td>WHAT</td><td>The <code>LinkTranslatorMapAction</code> component is used 
            setup a simple link rewriting.
          </td>
        </tr>
        <tr>
          <td>TYPE</td><td>Action, Sitemap Component</td>
        </tr>
        <tr>
          <!-- choose Core, the block name, or Scratchpad 
            depending on where LinkTranslatorMapAction sources live
          -->
          <td>BLOCK</td><td>Block-Mail/Scratchpad</td>
        </tr>
        <tr>
          <td>CLASS</td><td>org.apache.cocoon.acting.LinkTranslatorMapAction</td>
        </tr>
        <!-- uncomment folling tr iff LinkTranslatorMapAction is deprecated -->
        <!--tr>
          <td>DEPRECATED</td><td>Cocoon 2.0, 2.1</td>
        </tr-->
        <tr>
          <td>SINCE</td><td>Cocoon 2.1</td>
        </tr>
        <tr>
          <td>CACHEABLE</td><td>not applicable</td>
        </tr>
      </table>
    </s1>
    <s1 title="Description">
      <p>
        The <code>LinkTranslatorMapAction</code> sets up a simple link rewriting
        mapping.
      </p>
    </s1>
    <s1 title="Usage">
      <p>
        Keeping outbounding links independing from its publishing URI 
        is a simple usage scenario of <code>LinkTranslatorMapAction</code>.
      </p>
      <s2 title="Sitemap pipeline examples">
        <p>
        </p>
        <source><![CDATA[
<map:match pattern="mail/*.html">
  <map:action type="link-translator-map">
    <!-- sitemap parameters -->
    <map:parameter name="main.css" value="../main.css"/>
  </map:action>
</map:match>
        ]]></source>
      </s2>
      
      <s2 title="Sitemap component configuration example">
        <p></p>
        <source><![CDATA[
<map:actions...
  <map:action name="link-translator-map" 
    src="org.apache.cocoon.acting.LinkTranslatorMapAction"
    logger="sitemap.action.link-translator-map" 
  />
  ...
</map:actions>
...
]]></source>
      </s2>
      <s2 title="Configuration">
        <p>
          Explain the sitemap action configuration, options when declaring template action
        </p>
      </s2>
      <s2 title="Setup">
        <p>
          Explain the sitemap action setup, ie options when using template action
        </p>
      </s2>
      <s2 title="Effect on Object Model and Sitemap Parameters">
        <p>
        
        </p>
      </s2>
    </s1>
    <s1 title="Bugs/Caveats">
      <p>
        Describe limitation, bugs of LinkTranslatorMapAction 
      </p>
    </s1>
    <s1 title="History">
      <p>
        01-05-02: initial creation
      </p>
    </s1>
    <s1 title="See also">
      <p>
        Links to related components pages.
      </p>
    </s1>
  </body>
</document>

