Difference between revisions of "Template:Sign/Documentation"

From GodWiki
Jump to: navigation, search
Line 1: Line 1:
 
<noinclude> [[Category:Templates/Documents|{{PAGENAME}}]]</noinclude>  
 
<noinclude> [[Category:Templates/Documents|{{PAGENAME}}]]</noinclude>  
 
Parameters:  
 
Parameters:  
*'''title''' - the title (default: no title)  
+
*'''title''' - the title (default: no title)
 +
 
*'''text''' - text (default: a mess of lorem ipsum)  
 
*'''text''' - text (default: a mess of lorem ipsum)  
*'''bgcolor''' - the background color (any valid CSS color string; default: <code>#fefefe</code>)  
+
 
*'''bordercolor''' - Border color of the left border (any valid CSS color string; default: <code>#999</code>)  
+
*'''bgcolor''' - the background color (any valid CSS color string; default: <code>#fefefe</code>)
 +
 +
*'''bordercolor''' - Border color of the left border (any valid CSS color string; default: <code>#999</code>)
 +
 
*'''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>)  
 +
 
*'''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>)
*'''imgwidth''' - for non-standard images. It is advisable not to touch. (a valid width in <code>px</code> pixel units; default: <code>64px</code>)  
+
 
 +
*'''imgwidth''' - for non-standard images. It is advisable not to touch. (a valid width in <code>px</code> pixel units; default: <code>64px</code>)
 +
 
*'''image-align''' - Override image <code>vertical-align</code> parameter: <code>top</code>, <code>bottom</code>, etc. (default: <code>middle</code>)
 
*'''image-align''' - Override image <code>vertical-align</code> parameter: <code>top</code>, <code>bottom</code>, etc. (default: <code>middle</code>)
*'''link''' - the link of the picture became the specified target (default: <code>File:''filename''</code>)
+
 
 +
*'''link''' - the link of the picture became the specified target
 +
**If the parameter is not called at all in the template, the link will be <code>File:filename</code> default.
 +
**If the parameter is called but no target is provided (<code>link=</code>), the linking will be turn off.
 +
 
 
*'''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>)
 +
 
*'''width''' - the width of the template in CSS units (<code>rem</code>, <code>em</code>, <code>px</code>, etc.) (default: <code>80%</code>)
 
*'''width''' - the width of the template in CSS units (<code>rem</code>, <code>em</code>, <code>px</code>, etc.) (default: <code>80%</code>)
 +
 
*'''interval''' - the bottom margin for the sign template in CSS units (<code>rem</code>, <code>em</code>, <code>px</code>, etc.) (default: <code>0.2rem</code>)
 
*'''interval''' - the bottom margin for the sign template in CSS units (<code>rem</code>, <code>em</code>, <code>px</code>, etc.) (default: <code>0.2rem</code>)
 +
 
*'''style''' - any general CSS style parameters to be added to the table style. Takes valid CSS. End with a semicolon (<code>;</code>), '''DO NOT''' include quotation marks.
 
*'''style''' - any general CSS style parameters to be added to the table style. Takes valid CSS. End with a semicolon (<code>;</code>), '''DO NOT''' include quotation marks.
  

Revision as of 13:18, 22 November 2019

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)
  • 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 became the specified target
    • If the parameter is not called at all in the template, the link will be File:filename default.
    • If the parameter is called but no target is provided (link=), the linking will be turn off.
  • 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: 80%)
  • 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.

Example

{{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.pngWhat a nice example!
Spode is clearly a genius