Difference between revisions of "Template:Sign/Documentation"

From GodWiki
Jump to: navigation, search
m
(Tags: Mobile edit, Mobile web edit)
m
(Tags: Mobile edit, Mobile web edit)
Line 1: Line 1:
 
<noinclude> [[Category:Templates/Documents|{{PAGENAME}}]]</noinclude>  
 
<noinclude> [[Category:Templates/Documents|{{PAGENAME}}]]</noinclude>  
Parameters:
+
==Parameters==
 +
===Global parameters===
 
*'''title''' - the title (default: no title)
 
*'''title''' - the title (default: no title)
 
   
 
   
Line 10: Line 11:
 
   
 
   
 
*'''outerbordercolor''' - color of the top, right and bottom borders (any valid CSS color string; default: <code>#AAB</code>)  
 
*'''outerbordercolor''' - color of the top, right and bottom borders (any valid CSS color string; default: <code>#AAB</code>)  
 +
 +
=== Picture parameters===
  
 
*'''img''' - an image filename, no "Image:" or braces (default: <code>Important.png</code>)
 
*'''img''' - an image filename, no "Image:" or braces (default: <code>Important.png</code>)
Line 23: Line 26:
 
*'''emoji''' - Display an emoji instead of the image.
 
*'''emoji''' - Display an emoji instead of the image.
 
** If an emoji is used, the picture will not be displayed even if <code>|img=</code> is used.
 
** If an emoji is used, the picture will not be displayed even if <code>|img=</code> is used.
 +
 +
===Advanced parameters===
  
 
*'''height''' - the height of the template in CSS units (<code>rem</code>, <code>em</code>, <code>px</code>, etc.) (default: <code>auto</code>)
 
*'''height''' - the height of the template in CSS units (<code>rem</code>, <code>em</code>, <code>px</code>, etc.) (default: <code>auto</code>)

Revision as of 00:05, 18 December 2019

Parameters

Global parameters

  • title - the title (default: no title)
  • text - text (default: a mess of lorem ipsum)
  • bgcolor - the background color (any valid CSS color string; default: #fefefe)
  • bordercolor - Border color of the left border (any valid CSS color string; default: #999)
  • outerbordercolor - color of the top, right and bottom borders (any valid CSS color string; default: #AAB)

Picture parameters

  • img - an image filename, no "Image:" or braces (default: Important.png)
  • imgwidth - for non-standard images. It is advisable not to touch. (a valid width in px pixel units; default: 64px)
  • image-align - Override image vertical-align parameter: top, bottom, etc. (default: middle)
  • link - the link of the picture of the |img parameter become the specified target
    • If the parameter is not called at all in the template, the link will be File:<filename> by default.
    • If the parameter is called but no target is provided (link=), the linking will be turn off.
  • emoji - Display an emoji instead of the image.
    • If an emoji is used, the picture will not be displayed even if |img= is used.

Advanced parameters

  • height - the height of the template in CSS units (rem, em, px, etc.) (default: auto)
  • width - the width of the template in CSS units (rem, em, px, etc.) (default: 100%)
  • interval - the bottom margin for the sign template in CSS units (rem, em, px, etc.) (default: 0.2rem)
  • style - any general CSS style parameters to be added to the table style. Takes valid CSS. End with a semicolon (;), DO NOT include quotation marks.

Examples

{{Sign 
| title = What a nice example!
| text = [[User:Spode|Spode]] is clearly a genius
| bgcolor = #abcdef
| img = Imbox notice.png
| outerbordercolor = red
| bordercolor = green
| width = 50%
}}

Results in:

Imbox notice.png

What a nice example!

Spode is clearly a genius




{{Sign 
| title = Another example
| link= Template:Sign/Documentation
| text = The picture will link to the documentation of this template
| bgcolor = silver
| outerbordercolor = black
| bordercolor = purple
| width = 50%
}}


Results in:

Important.png

Another example

The picture's link will lead to the documentation of this template.


{{Sign 
| title = No link example
| link= 
| text = The picture's linking is desactivated with <code>link=</code>
| bgcolor = MediumSeaGreen
| outerbordercolor = black
| bordercolor = red
| width = 50%
}}

Results in:

Important.png

No link example

The picture's linking is desactivated with link=


{{Sign 
| title = Emoji example
| emoji = 🐈
| img = Example.jpg
| text = Despite the image parameter being used, only the cat emoji is displayed.
| bgcolor = Salmon
| outerbordercolor = black
| bordercolor = Blue
| width = 50%
}}

Results in:

🐈

Emoji example

Despite the image parameter being used, only the cat emoji is displayed.