Introducing XWeb

The Basics
Using CSS
Parameters
Images
Advanced XWeb
References
 
Makefile
CSS Classes
Parameters
Images
XPath
XSLT

XWeb Makefile Structure

<background>

Appears in:

Attributes:

color
Specifies the background color (optional).
imageURL
If given the image will be used as background image.
imageMode
Specifies how the image given should be placed, possible values are "scaled", "origin" or "center".

Description:

Specifies how the background is rendered with the internal renderer.

<copy>

Appears in:

Description:

Any document using this style will be just copied into the output.

<directory>

Appears in:

Children:

Attributes:

targetDir
A subdirectory where the output in this directory should be put.
sourceDir
A subdirectory where the input for this directory can be found.
id
An optional id which can be used to refer to this directory in an XSLT process.
type
The optional type can be used to generate images using a <sectionStyle>.

Description:

A directory is used to structure the input and output files without creating an item in the navigation.

<documentStyle>

Appears in:

Children:

Attributes:

type
The type name we use for this style.

Description:

Document styles define how the documents in the site are processed. They must contain exactly one process definition and can contain one or more images or image groups.

<entry>

Appears in:

Attributes:

sourceFile
The input file for this entry.
targetFile
The output file for this entry.
type
The type name of the documentStyle to use.
id
An optional id that can be used to refer to this entry in XSLT processes.
title
The optional title can be used for rendering different text on images (banners). If not given the name will be used.
name
The name is used to create text in the navigation.

Description:

Each entry defines one page in the output including the process to create it and the way it will be represented in the navigation.

<file>

Appears in:

Attributes:

sourceFile
The input file for this entry.
targetFile
The output file for this entry.
type
The type name of the documentStyle to use.
id
An optional id that can be used to refer to this entry in XSLT processes.

Description:

A file is similar to an entry since it defines the same type of processing information but it does not create any navigation entry.

<font>

Appears in:

Attributes:

name
The family name for the font.
size
The size in points.
bold
Set to true if the font should be rendered in bold.
italic
Set to true if the font should be rendered in italics.

Description:

Defines a font to use by the internal renderer.

<image>

Appears in:

Attributes:

type
Refers to the name of an image style.

Description:

A reference to an image style.

<imageGroup> (1)

Appears in:

Attributes:

name
The image group refered.

Description:

A reference to an image group.

<imageGroup> (2)

Appears in:

Children:

Attributes:

name
The name used for references.

Description:

This groups a number of images for refering them at once.

<imageStyle>

Appears in:

Children:

Attributes:

width
The width of the image to create.
height
The height of the image to create.
fileNamePattern
A file name containing "%n" which will be replaced with the name of the entry/section. It includes the file extension.
type
The type name used for refering to this style.
render
If this optional attribute is set to "title" the title of an entry or section will be used as text if given.

Description:

This defines how to render images. It must contain either the <svg> child or one or both of the others. If the <svg> child is given the image will be rendered as SVG graphic, otherwise the internal renderer will be used. The output format is determined by the extension of the fileNamePattern attribute.

<index>

Appears in:

Attributes:

sourceFile
The input file for this entry.
targetFile
The output file for this entry.
type
The type name of the documentStyle to use.

Description:

The index is used only in multi-layout sites and will be put above all subdirectories for layouts. Otherwise it is treated as a normal <file> entry.

<layout>

Appears in:

Children:

Attributes:

outputDir
A subdirectory to put all files created using this layout into. Optional for first, mandatory on every other layout.

Description:

This section defines how to render the structure. Multiple versions can be given to create different versions of the site using the same content.

<parameter>

Appears in:

Attributes:

name
The name of the parameter.
value
The value the parameter will be set to.

Description:

Sets a parameter for an XSLT stylesheet.

<position>

Appears in:

Attributes:

hAlign
The horizontal align of the text. Possible values: "left", "center", "right".
vAlign
The vertical align of the text. Possible values: "bottom", "center", "top".
offsetX
An additional offset applied to the text, relative to the position calculated from the alignments.
offsetY
An additional offset applied to the text, relative to the position calculated from the alignments.

Description:

Determines the position of the text on the image rendered by the internal renderer.

<programCall>

Appears in:

Attributes:

commandLine
The command called.

Description:

Calls an external process using a command line call. The values "%s" and "%t" will be replaced with the paths for the source and target files respecitvely.

<section>

Appears in:

Children:

Attributes:

targetDir
A subdirectory where the output in this section should be put.
sourceDir
A subdirectory where the input for this section can be found.
id
An optional id which can be used to refer to this section in an XSLT process.
type
The optional type can be used to generate images using a <sectionStyle>.
name
The name used to render buttons.
title
The optional title can be used to replace the name on special images (e.g. banners).

Description:

A section has two purposes: it structures the input and output by using subdirectories and it creates an entry in the navigation to access all pages created from this section.

<sectionStyle>

Appears in:

Children:

Attributes:

type
The type name used to refer to this definition.

Description:

A section style can be used to attach images and image groups to section to create buttons and banners for a section.

<shadow>

Appears in:

Attributes:

color
The color for the shadow.
offsetX
The horizontal offset relative to the text position.
offsetY
The veritcal offset relative to the text position.

Description:

If a shadow is given the text will be rendered with a shadow of the given color and offset.

<structure>

Appears in:

Children:

Description:

The main element for structuring the content.

<svg>

Appears in:

Attributes:

xwebid
Determines the id used for text replacement.

Description:

Used to render SVG images it can contain any SVG code. Any text in the SVG with the id set to whatever the xwebid attribute gives will be replaced with the name or title of the section/entry.

<text>

Appears in:

Children:

Attributes:

color
The color of the text.

Description:

This determines how the internal renderer will render the text part of an image.

<website>

Children:

Attributes:

baseURL
The URL where the final site will be located.
sourceDir
The input directory given either absolute or relative to the makefile.
targetDir
The output directory given either absolute or relative to the makefile.
version
The version of the file format, typically the version of XWeb needed to render the site.

Description:

The root element.

<xsl>

Appears in:

Children:

Attributes:

stylesheet
The stylesheet to use.
navigationElement
Optional, if given the navigation information will be copied into the first element with the given name.

Description:

Defines an XSLT process with the given stylesheet. Input is either the source file (innermost process) or the output of another XSLT process (<xsl> child given).