<?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 V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
<document>
  <header>
    <title>Welcome to the org.apache.forrest.plugin.output.inputModule Plugin</title>
  </header>
  <body>
    <section id="overview">
      <title>Apache Forrest - org.apache.forrest.plugin.output.inputModule Plugin</title>
      <p>
        Produces properties from an input-module. This is been managed by the
        heart of this plugin the ModuleGenerator. The generator contacts
        the input module and gets an iterator of all attribute names. This
        iterator will be then used to receive the values of the key. Till now we
        only use a Object to String cast but an input module does not have to
        return a simple String but can return any object. This may cause
        ClassCastExceptions for the values.
      </p>
    </section>
    <section id="samples">
      <title>Samples</title>
      <p>
        This section includes links to a number of samples using this plugin.
        The plugin is intended to be self documenting through these samples. If
        you require further help please ask on the user mailing list.
      </p>
      <ul>
        <li><a href="module.properties.properties">Properties of the project input 
          module</a> - used in the sitemap like 
          {properties:content.xdocs}</li>
        <li><a href="module.date.properties">Properties of the date input 
          module</a> - we cast an object to a string, but the module returns 
          java.util.Date. This causes a ClassCastException.</li>
      </ul>
      <note>
        The more samples included here the easier it is for users to understand
        this plugin. If you can provide additional samples please do so.
      </note>
    </section>
  </body>
</document>
