Structure

<navigation>

Note that <submenu> takes the same attributes as the <navigation> tag.

Attributes

bg=color
Sets the background color of the background image.

bgsrc=image.ppm
Sets the background to the given image map. The attributes tile and resize, described below also work here.

fs
Applies a Floyd-Steinberg dithering to the result. Most of the time it is much better to increase the number of colors instead of dithering the image, but sometimes when using very complex background images dithering is acceptable.

height=int
Sets the height of the generated menu. If not used the height adjusts itself.

horiz
Makes the menu horizontal, all boxstyles are rotated 90 degrees counter-clockwise.

imgbase=path
Imgbase can be used to simplify the use of graphics in your menu. Path can be /home/johndoe/gfx/. This will then be used as a prefix to all images. Note that the path must be relative to the virtual file system root.

indent=int
Int specifies the amount of indentation.

jpeg[=quality]
Converts all images to JPEG by running cjpeg. Quality ranges from 0..100 and defaults to 80.

maxwidth
If the text in a menu box is wider that maxwidth it will be word wrapped to fit.

mirrortile
Mirrortiles the background image.

preload
Generates extra Java-script code used for preloading all images used in the menu. This may speed up the delivery of the pages since the requested images already are in the client's local cache when requested.

quant=number_of_colors
Quantifies the image with this number of colors. The default is set in the configuration interface, normally around 32. Using a lower number will decrease the image (file)size, but make the text look more 'edgy', and if you use complex backgrounds or image textures, more colors will be needed. At most 255 colors can be used, and less than 2 is quite useless.

scaletofit
Scales the background image to fit the size of the generated menu.

selected=int
Determines which menu item should be selected. Starts from 1. Any number out of range, eg. -1, will generate the menu without any selected item.

tile
Tiles the background image.

transparent[=color]
Makes the resulting GIF image transparent at pixels with the color set here. Defaults to the background color of the current document, set in the standard HTML <body> tag. Cannot be used together with the jpeg attribute (or obviously the text attribute).

width=int
Sets the width of the generated menu. If not used the width adjusts itself.

<boxstyle>

Attributes

alpha=alphavalue|alphamap.ppm
Can either be an integer value (0 to 255), or a PPM image file. This alpha value determines how much of the background or the image for the current box will show. 0 means nothing, 255 means everything. See also the alphainvert attribute below.

alphainvert
Inverts alpha values and alpha images. Useful if you're a firm believer in alpha values being the other way around. :-)

bg=color
Sets the background color of the current cell.

fg=color|texturemap.ppm
Can either be a color or a filename that is to be used as a texturemap. Texturemaps must be PPM-files. Note that this attribute can only be used in cells with the text attribute.

height=int
Sets the current cell's height in pixels.

left|middle|right
Sets the current cell's horizontal position. One (and only one) of these identifiers is required for each <boxstyle> cell.

mirrortile
This attribute will make all image maps (including alphas) tiled to the actual size of the cell. The tiling will be mirrored so that no rough edges appears.

mouseover
This attribute is used to specify the appearance of the menu when the mouse pointer points at it.

rot=degrees
Rotates all image maps (including alphas) clock-wise.

scaletofit
This attribute will resize all image maps (including alphas).

selected
This attributes is used to specify the appearance of the parts of the menu who are selected.

shadow[=color[,distance[,blur_amount[,direction]]]]
Draws a blurred drop-shadow behind the text. distance defaults to 3 pixels. direction is entered using clock-wise degrees and defaults to 135. color defaults to black. blur_amount defaults to 2.

src=image.ppm
A PPM file that is to be placed in the text box. Used together with the tile and resize attributes below.

tile
This attribute will make all image maps (including alphas) tiled to the actual size of the cell.

top|text|delimit|bottom
Sets the current cell's vertical position. One (and only one) of these identifiers is required for each <boxstyle> cell.

width=int
Sets the current cell's width in pixels.

<textstyle>

Attributes

left|center|right
Sets the text-align to either left, right or center. Defaults to left.

font="font name"
Specifies which font that is to be used. You can get a font-list by accessing the configuration interface.

There are several modifiers available: bold, italic, black and light.

If the requested version of the font is available, it will be used to render the text, otherwise the closest match will be used.

size=[2..7]
Specifies the font size of the text.

spacing=int
Adds int amount of spacing around the text. Defaults to 5.

xspacing=int
Adds int amount of spacing to the left and right of the text. Defaults to 5.

yspacing=int
Adds int amount of spacing above and below the text. Defaults to 5.


<mi>

Attributes

href=url
Set's the url for the current menu item.

status=text
Sets the text that will show up in the status bar when the mouse hovers over the link.

selected
States if the menu choice should be selected.


Text menus

The Navigation module also allows for text menus. These menus are generated html-tables and do not take the same number of attributes as the graphical menus. The <boxstyle>tags cannot be used in text menus.


<navigation>

Attributes

text
Makes the menu based on text and tables.

horiz
Makes the menu horizontal. All boxstyles are rotated 90 degrees counter-clockwise.


<textstyle>

Attributes

framecol=color
Sets the frame color.

framewidth=width
Sets the width (in pixels) of the frame.

spacing=int
Adds int amount of spacing around the text. Defaults to 5.

textbg=color
Sets the background color of the cells. Default is lightblue.

textbgsel=color
Sets the background color of the selected cells. Defaults to darkblue.

textcol=color
Sets the textcolor of the current cell.