Difference between revisions of "Template:Sign/Documentation"

From GodWiki
Jump to: navigation, search
(added another example)
(Tags: Mobile edit, Mobile web edit)
m (Document unnamed parameter as synonym for text)
 
(6 intermediate revisions by one other user not shown)
Line 1: Line 1:
−
<noinclude> [[Category:Templates/Documents|{{PAGENAME}}]]</noinclude>
+
==Parameters==
−
Parameters:  
+
===Global parameters===
−
*'''title''' - the title (default: no title)
+
; {{para|title}} : ''Optional'' - The title in '''bold''' of the sign (default: no title)
 
   
 
   
−
*'''text''' - text (default: a mess of lorem ipsum)  
+
; {{para|text}} <span style="font-weight: normal; font-style: italic;">or first unnamed parameter</span> :  ''Required'' - The text content of the sign (default: a mess of lorem ipsum)  
  
−
*'''bgcolor''' - the background color (any valid CSS color string; default: <code>#fefefe</code>)
+
; {{para|bgcolor|<var>Valid CSS color string</var>}} : ''Optional'' - The background color (default: <code>#fefefe</code>)
 
   
 
   
−
*'''bordercolor''' - Border color of the left border (any valid CSS color string; default: <code>#999</code>)
+
; {{para|bordercolor|<var>Valid CSS color string</var>}} : ''Optional'' - The color of the left border (default: <code>#999</code>)
 
   
 
   
−
*'''outerbordercolor''' - color of the top, right and bottom borders (any valid CSS color string; default: <code>#AAB</code>)  
+
; {{para|outerbordercolor|<var>Valid CSS color string</var>}} : ''Optional'' - The color of the top, right and bottom borders (default: <code>#AAB</code>)  
  
−
*'''img''' - an image filename, no "Image:" or braces (default: <code>Important.png</code>)
+
=== Picture parameters===
  
−
*'''imgwidth''' - for non-standard images. It is advisable not to touch. (a valid width in <code>px</code> pixel units; default: <code>64px</code>)
+
; {{para|img|<var>filename</var>}} : ''Optional'' - An image filename (default: <code>Important.png</code>)
 +
 
 +
;{{para|imgwidth|<var>Valid width in <code>px</code> pixel units</var>}} : ''Optional'' - For non-standard images. (default: <code>64px</code>)
 
   
 
   
−
*'''image-align''' - Override image <code>vertical-align</code> parameter: <code>top</code>, <code>bottom</code>, etc. (default: <code>middle</code>)
+
;{{para|image-align}} : ''Optional'' - Override image <code>vertical-align</code> parameter: <code>top</code>, <code>bottom</code>, etc. (default: <code>middle</code>)
 +
 
 +
;{{para|link|<var>Name of the targeted page</var>}} : ''Optional'' - the link of the picture of the <code>|img </code> parameter become the specified target.
 +
:* If the parameter is not called at all in the template, the link will be <code>File:<filename></code> by default.
 +
:* If the parameter is called but no target is provided (<code>link=</code>), the linking will be turn off.
 +
 
 +
;{{para|emoji|<var>Any emoji</var>}} : ''Optional'' - 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.
 +
 
 +
;{{para|emojiwidth|<var>X%</var>}} : ''Optional'' - The width of the emoji in percent (default: 300%)
  
−
*'''link''' - the link of the picture become the specified target
+
===Advanced parameters===
−
**If the parameter is not called at all in the template, the link will be <code>File:<filename></code> by 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>)
+
; {{para|height}} : ''Optional'' - 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>100%</code>)
+
; {{para|width}} : ''Optional'' - the width of the template in CSS units (<code>rem</code>, <code>em</code>, <code>px</code>, etc.) (default: <code>100%</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>)
+
; {{para|interval}} : ''Optional'' - 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.
+
; {{para|style}} : ''Optional'' - 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.
  
 
== Examples ==  
 
== Examples ==  
Line 106: Line 115:
 
| width = 50%
 
| width = 50%
 
}}
 
}}
−
<!-- <noinclude>[[Category:Template:Documentation]]</noinclude> -->
+
 
 +
----
 +
----
 +
 
 +
<pre><nowiki>
 +
{{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%
 +
}}
 +
</Nowiki></pre>
 +
 
 +
'''Results in:'''
 +
 
 +
{{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%
 +
}}
 +
 
 +
<noinclude> [[Category:Templates/Documents|{{PAGENAME}}]]</noinclude>

Latest revision as of 10:29, 28 October 2020

Parameters

Global parameters

|title= 
Optional - The title in bold of the sign (default: no title)
|text= or first unnamed parameter 
Required - The text content of the sign (default: a mess of lorem ipsum)
|bgcolor=Valid CSS color string 
Optional - The background color (default: #fefefe)
|bordercolor=Valid CSS color string 
Optional - The color of the left border (default: #999)
|outerbordercolor=Valid CSS color string 
Optional - The color of the top, right and bottom borders (default: #AAB)

Picture parameters

|img=filename 
Optional - An image filename (default: Important.png)
|imgwidth=Valid width in px pixel units 
Optional - For non-standard images. (default: 64px)
|image-align= 
Optional - Override image vertical-align parameter: top, bottom, etc. (default: middle)
|link=Name of the targeted page 
Optional - 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=Any emoji 
Optional - Display an emoji instead of the image.
  • If an emoji is used, the picture will not be displayed even if |img= is used.
|emojiwidth=X% 
Optional - The width of the emoji in percent (default: 300%)

Advanced parameters

|height= 
Optional - the height of the template in CSS units (rem, em, px, etc.) (default: auto)
|width= 
Optional - the width of the template in CSS units (rem, em, px, etc.) (default: 100%)
|interval= 
Optional - the bottom margin for the sign template in CSS units (rem, em, px, etc.) (default: 0.2rem)
|style= 
Optional - 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.pngWhat 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.pngAnother 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.pngNo 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.
Retrieved from "https://wiki.godvillegame.com/index.php?title=Template:Sign/Documentation&oldid=122170"