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

# variables available in template's Velocity context

Variables are prepared in template's Velocity context by doxia-siterenderer.

## default variables defined by doxia-siterenderer

### document variables

    alignedFileName=$alignedFileName
    currentDate=$currentDate
    currentFileName=$currentFileName
    dateFormat=$dateFormat
    dateRevision=$dateRevision
    doxiaSiteRendererVersion=$doxiaSiteRendererVersion
    locale=$locale
    publishDate=$publishDate
    relativePath=$relativePath
    supportedLocales=$supportedLocales
    decoration=$decoration

### tools

    FileUtils=$FileUtils
    i18n=$i18n
    PathTool=$PathTool
    StringUtils=$StringUtils

### Velocity Generic Tools

    alternator=$alternator
    convert=$convert
    date=$date
    display=$display
    esc=$esc
    field=$field
    loop=$loop
    math=$math
    number=$number
    render=$render
    text=$text
    sorter=$sorter
    xml=$xml
    context=$context
    link=$link

\$date.format('yyyy-MM-dd', \$currentDate) = $date.format('yyyy-MM-dd', $currentDate)

### Site template-specific variables

    authors=$authors
    dateCreation=$dateCreation
    shortTitle=$shortTitle
    title=$title
    headContent=$headContent
    bodyContent=$bodyContent

## default properties defined by maven-site-plugin

    inputEncoding=$inputEncoding
    outputEncoding=$outputEncoding
    project=$project
    (project property) dummy=$dummy
    (attribute defined in attributes parameter of site plugin) att1=$att1