92
edits
SigServer:SignatureXML: Difference between revisions
Jump to navigation
Jump to search
no edit summary
m (→Shape: Added italics to type values) |
Soulweaver (talk | contribs) No edit summary |
||
| (6 intermediate revisions by 4 users not shown) | |||
| Line 4: | Line 4: | ||
= Root Element = | = 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. | Each signature is required to have a root element, <tt><signature></tt> 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 <tt>0 - 100</tt>, default <tt>90</tt>. | ||
'''Example''' | '''Example''' | ||
| Line 15: | Line 15: | ||
Inside this element you may override an element's default value. | Inside this element you may override an element's default value. | ||
To override default element values the <defaults> tag is used. Inside the <defaults> tag elements are defined as usual. | To override default element values the <tt><defaults></tt> tag is used. Inside the <tt><defaults></tt> tag elements are defined as usual. | ||
'''Example''' | '''Example''' | ||
| Line 31: | Line 31: | ||
== Layout == | == Layout == | ||
All text, shapes and images are controlled by sub elements to < | All text, shapes and images are controlled by sub elements to <tt><layout></tt>. | ||
Please note that all items are added sequentially in the order listed in your signature's XML code. For example, if you draw some text first in your code, and then draw an opaque rectangle in that same location later on in your code, the rectangle will be drawn over top of that text, so only the rectangle will be visible. Make sure you draw your bottommost layers first to avoid that kind of problem. | |||
=== Image === | === Image === | ||
The < | The <tt><image></tt> tag allows the user to include an image, chosen from the collection in the library section. | ||
{| class="wikitable" | {| class="wikitable" | ||
| Line 40: | Line 42: | ||
! Attribute !! Description !! Values !! Default | ! Attribute !! Description !! Values !! Default | ||
|- | |- | ||
| src || Sets which image that should be included. || Any title available in the library || ''none'' | | src || Sets which image that should be included. Can't be used together with attribute ''anime''. || Any title available in the library || ''none'' | ||
|- | |||
| anime || Includes the image of the ID provided. Can't be used together with attribute ''src''. || Any Anime ID || ''none'' | |||
|- | |- | ||
| position || Sets the included image's position. || ''x-pos''x''y-pos''|| 0x0 | | position || Sets the included image's position. (X and Y must be integers) || ''x-pos''x''y-pos''|| 0x0 | ||
|- | |- | ||
| size || Sets the included image's size. || ''width''x''height'' || Image's own size | | size || Sets the included image's size. (width and height must be integers) || ''width''x''height'' || Image's own size | ||
|- | |- | ||
| display || Sets whether the image is visible or not. || ''true'' or ''false'' || true | | display || Sets whether the image is visible or not. || ''true'' or ''false'' || true | ||
|- | |||
| method || Sets resizing method. Crop cuts of excess parts. Resize scales the image to fit given size. Cropresize resizes then crops and maintains aspect ratio. || ''crop'', ''resize'' or ''cropresize'' || cropresize | |||
|- | |||
| restricted || Display restricted images, i.e. explicit images a.k.a. hentai. || ''true'' or ''false''|| false | |||
|} | |} | ||
=== Shape === | === Shape === | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
| Line 57: | Line 64: | ||
| type || Defines the type of shape. || ''rectangle'', ''ellipse'', ''pie'', ''arc'' or ''line'' || ''none'' | | type || Defines the type of shape. || ''rectangle'', ''ellipse'', ''pie'', ''arc'' or ''line'' || ''none'' | ||
|- | |- | ||
| position || Sets the shape's position. || ''x-pos''x''y-pos''|| 0x0 | | position || Sets the shape's position. (X and Y must be integers) || ''x-pos''x''y-pos''|| 0x0 | ||
|- | |- | ||
| size || Sets the shape's size. || ''width''x''height'' || 10x10 | | size || Sets the shape's size. (width and height must be integers) || ''width''x''height'' || 10x10 | ||
|- | |- | ||
| color || Sets the shape's | | color || Sets the shape's colour. || ''#<hex>'' or ''R, G, B'' || #000000 | ||
|- | |- | ||
| alpha || Sets the shape's opacity. Doesn't work very well with ellipses || ''1-100'' || 100 | | alpha || Sets the shape's opacity. Doesn't work very well with ellipses (must be an integer) || ''1-100'' || 100 | ||
|- | |- | ||
| hollow || Sets whether the shape should be hollow or not. || ''true'' or ''false'' || false | | hollow || Sets whether the shape should be hollow or not. || ''true'' or ''false'' || false | ||
|- | |- | ||
| thickness || Sets the border's thickness. Works on lines and hollow shapes. || ''1-10'' || 1 | | thickness || Sets the border's thickness. Works on lines and hollow shapes. (must be an integer) || ''1-10'' || 1 | ||
|- | |- | ||
| display || Sets whether the shape is visible or not. || ''true'' or ''false'' || true | | display || Sets whether the shape is visible or not. || ''true'' or ''false'' || true | ||
|- | |- | ||
| angle ''(pie and arc only)'' || Sets the pie's/arc's start and end angle in degrees (only positive angles) || ''stop'' or ''start''-''end''; ''0-720'' || 0-90 | | angle ''(pie and arc only)'' || Sets the pie's/arc's start and end angle in degrees (only positive angles and they must be integers) || ''stop'' or ''start''-''end''; ''0-720'' || 0-90 | ||
|} | |} | ||
=== Text === | === Text === | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
! Attribute !! Description !! Values !! Default | ! 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-pos''x''y-pos''|| 0x0 | | position || Sets the text's position. Relative to the bottom left corner, if nothing else is set in the align attribute. (X and Y must be integers) || ''x-pos''x''y-pos''|| 0x0 | ||
|- | |- | ||
| size || Sets the text's size. || ''width''x''height'' || 10x10 | | size || Sets the text's size. (width and height must be integers) || ''width''x''height'' || 10x10 | ||
|- | |- | ||
| color || Sets the text's | | color || Sets the text's colour. || ''#<hex>'' or ''R, G, B'' || #000000 | ||
|- | |- | ||
| alpha || Sets the text's opacity. || ''1-100'' || 100 | | alpha || Sets the text's opacity. (must be an integer) || ''1-100'' || 100 | ||
|- | |- | ||
| align || Sets the text's alignment. | | align || Sets the text's alignment. Note that the vertical alignment currently only considers the positioning of the first line. || Any combination of ''bottom'', ''middle'', ''top'' and ''left'', ''center'', ''right'' with a dash in between || bottom-left | ||
|- | |- | ||
| face || Sets the text's face. || See [[SigServer:Fonts|font list]] for all font's with recommended size || verdana | | face || Sets the text's face. || See [[SigServer:Fonts|font list]] for all font's with recommended size || verdana | ||
|- | |- | ||
| angle || Sets the text's angle. || ''0-359'' || 0 | | angle || Sets the text's angle. (must be an integer) || ''0-359'' || 0 | ||
|- | |- | ||
| line-space || Sets the spacing between the lines. || ''number'' || 1.5 | | 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 | | thickness || Sets the border's thickness. Works on lines and hollow shapes. (must be an integer) || ''1-10'' || 1 | ||
|- | |- | ||
| display || Sets whether the text is visible or not. || ''true'' or ''false'' || true | | display || Sets whether the text is visible or not. || ''true'' or ''false'' || true | ||
| Line 102: | Line 108: | ||
==== Line ==== | ==== Line ==== | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||