SigServer:SignatureXML: Difference between revisions

From AniDB
Jump to navigation Jump to search
No edit summary
Line 23: Line 23:
  <signature>
  <signature>
  <variables>
  <variables>
  <set name="foo" value="bar">
  <set name="foo" value="bar" />
  </variables>
  </variables>
  </signature>
  </signature>
Line 30: Line 30:


==== Override default value ====
==== Override default value ====
'''NOTE: Only works for the text element.'''
'''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 ===
=== Layout ===

Revision as of 15:23, 3 December 2007

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>.

The layout is contolled by a XML based scripting language. Each signature must have the root tag (<signature>). The <signature> tag has two subelements: <variables> and <layout>. When using JPEG as output the <signature> accepts the attribute quality. It may be any value between 1-100. Default value is 100 (Max).

The <variables> tag enables the user to define his own variables using a sub element called <set>. <set> has the following attributes, which both are required, <set name="testvar" value="test" />. To access the variable @ followed by the variable's name is used. A variable can only be accessed inside the curly brackets, i.e. Template:@testvar; will output test and just @testvar will output @testvar.

The default value for each tag (only text supported at the moment) may be overridden using the <default> tag. It is a sub tag of the <variables> tag. Example usage so override the default text color: <default element="text" name="color" value="#FFFFFF" />. That sets the text default color to white.

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