<?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.

-->
<document xmlns="http://maven.apache.org/XDOC/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">

  <properties>
    <title>Documentation</title>
    <author email="dev@syncope.apache.org">Apache Syncope Documentation Team</author>
  </properties>

  <body>
    <section name="Documentation">
      <p>
        Finding the right documentation to read or the right people to ask is probably one of the hardest tasks for
        anyone approaching an Open Source project.<br/>
        Besides the links below, please do not forget to visit the Syncope
        <a href="https://cwiki.apache.org/confluence/display/SYNCOPE">Wiki</a>.
      </p>
      <p>
        If you find errors or omissions in the documentation, please don’t hesitate to 
        <a href="../issue-tracking">submit an issue</a> or 
        <a href="../contributing#Documentation">contribute</a>.
        We also encourage you to ask questions and discuss any aspects of the project on the 
        <a href="../mailing-lists">mailing lists or IRC</a>. New contributors are always welcome!
      </p>
      
      <subsection name="Guides">
        <div class="alert alert-warning">
          <strong>Warning!</strong> The links below apply to Syncope &ge; 2.0; for prior versions please take a look at the <a class="externalLink" href="https://cwiki.apache.org/confluence/display/SYNCOPE">Wiki</a>.
        </div>

        <table>
          <thead>
            <tr>
              <th>Name</th>
              <th width="100">2.1</th>
              <th width="100">2.0</th>
              <th width="100">dev</th>
            </tr>
          </thead>
          <tbody>
            <tr>
              <td>Getting Started</td>
              <td>
                <a href="2.1/getting-started.html">
                  <img src="../images/text-html.png"/>
                </a>
                &nbsp;
                <a href="2.1/getting-started.pdf">
                  <img src="../images/application-pdf.png"/>
                </a> 
              </td>
              <td>
                <a href="2.0/getting-started.html">
                  <img src="../images/text-html.png"/>
                </a>
                &nbsp;
                <a href="2.0/getting-started.pdf">
                  <img src="../images/application-pdf.png"/>
                </a> 
              </td>
              <td>
                <a href="https://nightlies.apache.org/syncope/2_1_X/getting-started.html">
                  <img src="../images/text-html.png"/>
                </a>
                &nbsp;
                <a href="https://nightlies.apache.org/syncope/2_1_X/getting-started.pdf">
                  <img src="../images/application-pdf.png"/>
                </a> 
              </td>
            </tr>
            <tr>
              <td>Reference Guide</td>
              <td>
                <a href="2.1/reference-guide.html">
                  <img src="../images/text-html.png"/>
                </a>
                &nbsp;
                <a href="2.1/reference-guide.pdf">
                  <img src="../images/application-pdf.png"/>
                </a> 
              </td>
              <td>
                <a href="2.0/reference-guide.html">
                  <img src="../images/text-html.png"/>
                </a>
                &nbsp;
                <a href="2.0/reference-guide.pdf">
                  <img src="../images/application-pdf.png"/>
                </a> 
              </td>
              <td>
                <a href="https://nightlies.apache.org/syncope/2_1_X/reference-guide.html">
                  <img src="../images/text-html.png"/>
                </a>
                &nbsp;
                <a href="https://nightlies.apache.org/syncope/2_1_X/reference-guide.pdf">
                  <img src="../images/application-pdf.png"/>
                </a> 
              </td>
            </tr>
          </tbody>
        </table>
      </subsection>
            
      <subsection name="References">
        <p>
          Each release of Syncope comes with sources, including JavaDocs.
          When using Maven for dependency management, IDE will automatically download the source JARs and, when 
          going hover on a Syncope class or method, show the corresponding documentation.
        </p>
        <p>
          For reference, the API and REST documentation are published online allowing easy link from emails or websites.
        </p>
        
        <table>
          <thead>
            <tr>
              <th>Name</th>
              <th width="100">Versions</th>
            </tr>
          </thead>
          <tbody>
            <tr>
              <td>REST</td>
              <td>
                <a href="../rest/2.1/index.html">2.1</a>
                &nbsp;&nbsp;
                <a href="../rest/2.0/index.html">2.0</a> 
              </td>
            </tr>
            <tr>
              <td>Javadocs</td>
              <td>
                <a href="../apidocs/2.1/index.html">2.1</a>
                &nbsp;&nbsp;
                <a href="../apidocs/2.0/index.html">2.0</a> 
              </td>
            </tr>
          </tbody>
        </table>
      </subsection>
    </section>
  </body>
</document>
