SigServer:SignatureXML

Back to: SigServer:Documentation

Root Element

Each signature is required to have a root element, <signature> in this case. The root tag accepts the attribute quality. It set's the quality when output as JPEG is selected. It may be set to anything between 0 - 100, default 90.

Example

<signature quality="90">
</signature>

The root element has two child elements, <variables> and <layout>.

Variables

Inside this element you may define your own variables or override an elements default value.

User defined variables

To define a variable the <set> tag is used. It has the two attributes, name and value.

Example

<signature>
	<variables>
		<set name="foo" value="bar" />
	</variables>
</signature>

The example above defines the variable @foo which has the value bar. Note that the @ should not be included in the variable's name.

Override default value

NOTE: Only text element supported for now.

To override an element's default value the <default> tag is used. It has three attributes, element, name and value.

Example

<signature>
	<variables>
		<default element="text" name="face" value="courier" />
	</variables>
</signature>

The example sets the default attribute face of the element text to courier.

Layout

All text, shapes and images are controlled by sub elements to <layout>.

Image

The <image> tag allows the user to include an image, chosen from the collection in the library section.

Attribute	Description	Values	Default
src	Sets which image that should be included.	Any title available in the library	none
position	Sets the included image's position.	x-posxy-pos	0x0
size	Sets the included image's size.	widthxheight	Image's own size
display	Sets whether the image is visible or not.	true or false	true

Shape

Attribute	Description	Values	Default
type	Defines the type of shape.	rectangle, ellipse or line	none
position	Sets the shape's position.	x-posxy-pos	0x0
size	Sets the shape's size.	widthxheight	10x10
color	Sets the shape's color.	#<hex> or R, G, B	#000000
alpha	Sets the shape's opacity. Doesn't work very well with ellipses	1-100	100
hollow	Sets whether the shape should be hollow or not.	true or false	true
thickness	Sets the border's thickness. Works on lines and hollow shapes.	1-10	1
display	Sets whether the shape is visible or not.	true or false	true

Text

Attribute	Description	Values	Default
position	Sets the text's position. Relative to the bottom left corner, if nothing else is set in the align attribute.	x-posxy-pos	0x0
size	Sets the text's size.	widthxheight	10x10
color	Sets the text's color.	#<hex> or R, G, B	#000000
alpha	Sets the text's opacity.	1-100	100
align	Sets the text's alignment.	bottom-left, bottom-right, top-left or top-right	bottom-left
face	Sets the text's face.	See font list for all font's with recommended size	verdana
angle	Sets the text's angle.	0-359	0
line-space	Sets the spacing between the lines.	number	1.5
thickness	Sets the border's thickness. Works on lines and hollow shapes.	1-10	1
display	Sets whether the text is visible or not.	true or false	true

Line

Attribute	Description	Values	Default
Same as Text except no 'position' or 'align' attribute.