Difference between revisions of "Template:PortalButton/Documentation"

From blackwiki
Jump to navigation Jump to search
test>Cesdeva
(→‎ Documentation: adjusting)
test>Cesdeva
Line 83: Line 83:
 
For instances where multiple buttons are required to sit together, there exists an extra set of parameters.
 
For instances where multiple buttons are required to sit together, there exists an extra set of parameters.
  
They are enabled by default. If using an individual button, disable these parameters using <code>|multi=no</code>.
+
These are not enabled by default. If using an individual button, enable these parameters using <code>|multi=yes</code>.
  
This will de-activate the default values for <code>|display=</code> and <code>|adjust=</code>.
+
This will activate the default values for <code>|display=</code> and <code>|adjust=</code>.
 
</p>
 
</p>
 
</br>
 
</br>
Line 91: Line 91:
 
'''&nbsp;The full list of extra parameters:'''
 
'''&nbsp;The full list of extra parameters:'''
 
</div>
 
</div>
'''|multi=''' (default yes)
+
'''|multi=''' (default empty)
 
</br>
 
</br>
 
'''|display=''' (default is inline-block)
 
'''|display=''' (default is inline-block)

Revision as of 15:49, 2 June 2018

This is a documentation page, and not a template.

 Documentation

This template is in Alpha-testing. See testcases for latest developments.
The Portal Button template is designed to provide a rounded-edge wrapper for intra-wiki linked images; giving the appearance of a 'button' to users. Utilisation of purpose-made graphics can add further semantic meaning. The wrapper incorporates the CSS overflow:hidden attribute, which in combination with the width attribute will crudely 'crop' images. Normal image sizing syntax is optional but will be overidden horizontally by the value in the |width parameter.

 Parameters

|width= (Div width, default is 25%)
|float= (left or right, default none) |background-c= (color, default #efefef) |border-w= (Border width, default 2px) |border-t= (Border type, default solid) |border-c= (Border color, default #efefef) |border-r= (Border radius, default 20px) |margin= (Margin around div, default 5px) |overflow= (Overflow, default hidden) |image= (File name, default PButton2.jpg) |image-t= (Type, default frameless)
|alt= (Description of image or target)
|link= (Target, default Portal:Contents/) |image-s= (Image size; pair with |Width) |text-c= (Font color, default #FFFF)
|font-wt= (Font weight, default none, options are bold and italics.)
|text= (Add text below image, centered)

To transclude the template, copy and paste the following text:

{{PortalButton
|width=
|float=
|background-c
|border-w=
|border-t
|border-c=
|border-r=
|margin=
|overflow=
|image=
|link=
|image-s=
|text-c=
|font-wt=
|text=
}}

Be sure to remove any parameters you don't fill, otherwise rendering will be affected.


 Multiple buttons:

For instances where multiple buttons are required to sit together, there exists an extra set of parameters.

These are not enabled by default. If using an individual button, enable these parameters using |multi=yes.

This will activate the default values for |display= and |adjust=.


 The full list of extra parameters:

|multi= (default empty)
|display= (default is inline-block)
|adjust= (sets relative positioning, default 5%)

 To create an inline-block grid:

Just place PortalButton templates directly below each other in the markup.

 Example:

{{PortalButton}}
{{PortalButton}}
{{PortalButton}}
{{PortalButton}}
{{PortalButton}}
{{PortalButton}}

 Individual button examples

Geogdivhills2.jpg

Churchdiv2.jpg

Overlookingcheshire2.jpg Geography

Brayheadcross.jpg Religion