SigServer:Templates: Difference between revisions
 (New page: {{TOCright}}  Back to: SigServer:Documentation  =Templates= To provide a simple alternative to the fairly complicated Signature XML.  == Create custom templa...)  | 
				No edit summary  | 
				||
| Line 49: | Line 49: | ||
*Third level contains arguments passed to the module.  | *Third level contains arguments passed to the module.  | ||
The colons are important. Everything without the colon is considered a comment regardless of the indentation level.  | |||
== Reference ==  | |||
Reference categorized after indentation level.  | |||
=== Level One ===  | |||
*Group names. Must start with a capital letter and may contain alpha-numeric characters.  | |||
=== Level Two ===  | |||
*Variable names. Must start with a letter and may contain alpha-numeric characters.  | |||
*Title of group. If not specified it falls back on group name.  | |||
*Description of group (optional)  | |||
=== Level Three ===  | |||
*'''title''':   | |||
*'''description  | |||
{| class="wikitable"  | |||
|-  | |||
! Name !! Description !! Optional  | |||
|-  | |||
| title || Sets variable title on wizard page. Falls back on variable name if missing. || Yes  | |||
|-  | |||
| description || Sets the description of the variable || Yes  | |||
|}  | |||
[[Category:SigServer]]  | [[Category:SigServer]]  | ||
Revision as of 19:59, 4 May 2008
Back to: SigServer:Documentation
Templates
To provide a simple alternative to the fairly complicated Signature XML.
Create custom template
Start of with an empty signature of one of the following sizes.
- 468x136 (ARC limit)
 - 468x60 (Full size banner)
 - 350x70 (Half size banner)
 - 350x19 (Userbar)
 - 234x60
 
The easiest way is to enter simple mode and use the wizard, create a signature using a template and then switch back to advanced mode.
The template options is set inside a XML comment (<!-- -->) on the first line spanning multiple lines down.
Example
<!--
Template data goes here
-->
<signature>
    <layout>
        <text>
            <line>Hello World!</line>
        </text>
    </layout>
</signature>
Syntax
The template data is whitespace sensitive. It means that indentation is crucial. An indentation level can be either a tab or 4 spaces. Anything more or less will cause things to malfunction.
Group:
    title:       Group title
    description: Group description
    variable:
        title:            Variable name
        description:      Variable description
        module:           modulename
            argumentname: value
In short this means the following:
- No indentation means the beginning of a new group.
 - One level of indentation means the beginning of a variable unless name equals title or description.
 - Two levels of indentation contains variable properties such as title, description and properties.
 - Third level contains arguments passed to the module.
 
The colons are important. Everything without the colon is considered a comment regardless of the indentation level.
Reference
Reference categorized after indentation level.
Level One
- Group names. Must start with a capital letter and may contain alpha-numeric characters.
 
Level Two
- Variable names. Must start with a letter and may contain alpha-numeric characters.
 - Title of group. If not specified it falls back on group name.
 - Description of group (optional)
 
Level Three
- title:
 - description
 
| Name | Description | Optional | 
|---|---|---|
| title | Sets variable title on wizard page. Falls back on variable name if missing. | Yes | 
| description | Sets the description of the variable | Yes |