Footer and header files

This article is about the Footer and Header specifications

Header

It is possible to add a header on every article and category HTML file. To do this, you have to define a header file with the following structure:

   <header desc="text to show on the header"/>

The generator will add it automatically to all the processed HTML files.

it is also possible to have some text at the left and right of the header. For example:

<header left="text to show on the left" right="text to show on the right" />

Header content

It is possible to add complex content for the left part of the header left rather than a basic text.

For example^[1]

In this example, we use the built-in date property in the header

:

   <header right="Generated on ${date}">
   This a a test header with an image: <img id="image" width="50px" />
   </header>

The elements allowed in the Header are:

• images
• article references
• external links

Note that if you add a lot of content in the header, you may need to increase the header height. See css for more information.

Adding a left image in the header

It is possible to add an aligned left image in the header as for example:

To do this easily, you can add a headerImg inside the header element. For example:

   <header right="${date}">
      <headerImg id="hand" height="50px" /> My wiki
   </header>

Footer

It is possible to add a footer on every article and category HTML file. To do this, you have 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.

Footer content

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