Home
Categories
Dictionary
Download
Project Details
Changes Log
What Links Here
How To
Syntax
Wiki usage
Tutorials
FAQ
License

Footer



It is possible to add a footer on every article and category HTML file. To do this, the simplest way is to define a footer file with the following structure:
<footer desc="text to show on the footer"/>
The generator will add it automatically to all the processed HTML files. It is possible to add complex content in the footer rather than a basic text.

For example:
   <footer>
   This a a test footer with an image: <img id="myImage" width="50px" />
   </footer>
The elements allowed in the Footer are:
  • images
  • article references
  • external links
It is possible to specify a separate left and right footers. For example:
   <footer>
      <footerLeft desc="Left Footer"/>
      <footerRight desc="Right Footer"/> 
   </footer>

Using properties

It is possible to use properties in the footer. For example:
   <footer>
      <footerLeft desc="Footer for ${version}"/>
      <footerRight desc="${articleVersion}"/> 
   </footer>

If a property is not defined (for example in the above example the articleVersion is only defined on an article), the property will be replaced by an empty String.
The onProperties attribute on the footerLeft and footerRight elements allow to specify some properties which must be defined for the footer part to be present. The list of properties is:
  • version for the wiki version. This property is defined if the version is defined
  • articleVersion for the version of the current article (the one on which the footer is added). This property is defined if the articleVersion is defined for the current article[1]
    If this is not an article, then is is not defined
  • errors for the errors of the wiki. This property is defined if there are errors for the parsing of the wiki
  • package for the package of the current element. This property is defined if the current element is in a package
For example:
   <footer>
      <footerLeft desc="Footer for ${version}"/>
      <footerRight desc="Version ${articleVersion}" onProperties="articleVersion"/> 
   </footer>

Notes

  1. ^ If this is not an article, then is is not defined

See also


Categories: Structure

docJGenerator Copyright (c) 2016-2023 Herve Girod. All rights reserved.

Project Web Hosted by SourceForge.net Copyright 1999-2010 - Geeknet, Inc., All Rights Reserved About - Legal - Help