<?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.
-->
        
<ui:composition xmlns="http://www.w3.org/1999/xhtml"
                xmlns:ui="http://java.sun.com/jsf/facelets"
                xmlns:tr="http://myfaces.apache.org/trinidad">

    Train is a UIXProcess component that renders a train. A train is a horizontal series of
    train stations connected by a horizontal line. Each train station is an image and text describing the page in
    the multi-page process.

    <br/>

    The train takes a model of type org.apache.myfaces.trinidad.model.MenuModel. The last node along the focusPath and its siblings are rendered

    <tr:spacer height="12px"/>

    <tr:outputText value="There are two common scenarios for processes, &quot;Plus One&quot; and &quot;Max Visited&quot;
        which are explained below. "/>

    <tr:panelList>
        <tr:outputText value="&quot;Plus One&quot; - from the current step the user can navigate to any previous
            page and the next page. If the user is on the 5th step of a process and goes back to step 2, then the user can
            only navigate from step 2 to step 1 and step 3"/>
        <tr:outputText value="&quot;Max Visited&quot; - the user can navigate to the max visited page. If the user
            is currently on the max visited page then the user can also navigate to the next page. If the user is on the
            5th step of a process and goes back to step 2, then the user can navigate from step 2 to steps 1, 2, 3, 4,
            and 5."/>
    </tr:panelList>

    <tr:spacer height="12px"/>

    <tr:outputText value="The class org.apache.myfaces.trinidad.model.ProcessMenuModel  and
        org.apache.myfaces.trinidad.model.ProcessUtils  were created to support the &quot;Plus One&quot; and
        &quot;Max Visited&quot; scenarios. Please see the javadoc for these classes for more information. "/>

    <tr:spacer height="12px"/>

    <tr:outputText value="When the focusPath is not focused on a top level node, images are rendered before and
        after the train to indicate that this train is part of a sub-process "/>
    
</ui:composition>