Template:Chalkboard/doc

From RationalWiki
Jump to navigation Jump to search

This template is for creating custom chalkboards, e.g. "to do" lists on user pages & suchlike. For a simple chalkboard, use the following code. The text can include internal & external links. These will show up lime green (for unused links) or yellow (for pages you have visited).

Parameters:

1: Title; (optional but note: if not given then Content (below) must be specified as "2= nnnnn") Default: "CHALKBOARD"
2: Content; (Required)
{{chalkboard | TITLE | insert text here}}
position: (optional) CSS float value: left, right, none. Default: right
width: (optional) use any valid CSS length measurement or %. Default: 250px
height: (optional) defines maximum height, use any valid CSS length measurement. Default: none
frame: (optional) border-type, none, hidden, dotted, dashed, solid, double, groove, ridge,inset, outset. Default: ridge
bcolor: (optional) color of border. Default:#663300
bwidth: (optional) width of border, use any valid CSS length measurement. Default: 7px
background: (optional) color of board background. Default: #101010
color: (optional) text color. Default: white (#FFFFFF)
text: (optional) text size. Default: 100%

Bullet points (with *) or numbering (with "#") can be used in the text:

{{chalkboard | EXAMPLE |
#First Item
#Second Item
#And so on
*Or with [[goat|bullet]] points
*Like this
*And so on
}}


By default the chalkboard appears on the right. If you want it on the left, add the position like this:

{{chalkboard | TITLE | insert text here | position = left}}


The default chalkboard width is 250px. To make it wider or narrower, you can add the width:

{{chalkboard | TITLE | insert text here | width = 300px}}


If you want the chalkboard to have a maximum height (a scroll bar will appear when it fills up), set it like this:

{{chalkboard | TITLE | insert text here | height = 500px}}


The default text size is 100%, but it can be adjusted to get larger or smaller text:

{{chalkboard | TITLE | insert text here | text = 90%}}


The default background color is #101010 which is an RGB hexadecimal color of very dark gray, but it can be adjusted to any color, either with an RGB number, or common color names:

{{chalkboard | TITLE | insert text here | background = navy}}


Similarly, the text color can be changed (with the "color" parameter) from the default (white), but remember that links within the chalkboard will still be green and yellow:

{{chalkboard | TITLE | insert text here | color = #FFCCCC}}


The default border color is 663300 which is an RGB hexadecimal color that is brownish, but it can be adjusted to any color:

{{chalkboard | TITLE | insert text here | bcolor = #556677}}


The default frame is ridhe which gives the illusion that their is a frame around the blackboard, but it can be adjusted to inset, solid, or any other HTML border, like this:

{{chalkboard | TITLE | insert text here | frame = inset}}


The default border is 7px wide, but it can be set:

{{chalkboard | TITLE | insert text here | bwidth = 10px}}


Any or all of these parameters can be used together. For example:

{{chalkboard | TITLE | insert text here | position = left | width = 300px | height = 500px | background = maroon | bcolor = gray | color = #FFFF99 | text = 90%}}