User:Willscrlt/UBX/ClanBox/doc
 | This is a documentation subpage for User:Willscrlt/UBX/ClanBox. It may contain usage information, categories and other content that is not part of the original user template page. |
{{User:Willscrlt/UBX/ClanBox}} and {{User:Willscrlt/UBX/Clan}} are interrelated userbox templates for displaying your Scottish clan affiliation on your user page.
{{User:Willscrlt/UBX/ClanBox}} is a customized userbox that is preformatted to display the text "This user is of Clan ___" on a dark leather-brown background. There is room for up to two images, with the intention of having the clan badge or crest appear on the left, and the clan tartan appear on the right. If no left image is specified, the word "Clan" will appear instead. There is also room to provide your sept and the clan motto. All the usual userbox attributes (border, background, and text colors and sizes, etc.) are overrideable if you dislike the default choices.
{{User:Willscrlt/UBX/Clan}} is a "smart" userbox that requires one attribute, your last name (actually, your clan or sept name if your last name is different), and tries to determine all of the information needed to determine your clan, sept, badge or crest, tartan, and motto for you automagically. If your clan or sept is not recognized by the template, then you should use the generic ClanBox template instead. The other alternative is to edit the Clan template and add your clan and sept information to the template so it is recognized, which would help other people, too. To do it's "magic", the Clan template uses parser functions and other esoteric template logic. Please test your changes in a sandbox before committing them to the live template to be sure your updates do not break anything.
Usage
Clan - For recognized clan names
This template currently only recognizes the clans and septs of Clan Cameron, Clan Campbell, Clan Murray, and Clan Spalding. Simply enter your last name (or the name of your clan or sept if your last name is different), and the userbox should display the correct information. If not, you can override it using the attributes shown for ClanBox below.
{User:Willscrlt/UBX/Clan|Name of clan only}}
ClanBox - For all other clan names
- Super-simple
This only works when the article is named "Clan Name". Enter just the name of the clan, without the word "Clan", and do not wikilink it. Sept names are not recognized unless they have their own article titled "Clan Name".
{{User:Willscrlt/UBX/ClanBox | clan = Name }}
- Standard attributes
See the next section for details on each attribute. All attributes, except Clan are optional.
{{User:Willscrlt/UBX/ClanBox
| clan =
| article =
| sept =
| motto =
| img1 =
| img1-s =
| img2 =
| img2-s =
| border2-c =
}}
- All options
To override any default used by either template, add as many of the following custom attributes as you like. All attributes, except Clan are optional.
{{User:Willscrlt/UBX/ClanBox
| clan = Name of clan (without the word "Clan"); do not wikilink it
| article = Article name only if not "Clan __"; do not wikilink it
| sept = Sept name if applicable; can be wikilinked
| motto = the motto; can be wikilinked
| img1 = left image (usually the clan badge or crest); do not include "File:"
| img1-s = left image width in pixels (px) (optional, defaults to 40)
| img2 = right image (usually the clan tartan); do not include "File:"
| img2-s = right image width in pixels (px) (optional, defaults to 40)
| border2-c = border color around right image (optional, defaults to no border)
| border-c = border color for the userbox (optional, defaults to dark brown)
| id-c = background color for the left image (optional, defaults to brown)
| id2-c = background color for the right image (optional, defaults to brown)
| info-c = background color for the center text (optional, defaults to brown)
| id-fc = text color for the left image area if no image (opt., def=tan)
| id2-fc = text color for the right image area if no image (opt., def=tan)
| info-fc = text color for the center text (optional, defaults to goldenrod)
| link-fc = linked text color for the center text (optional, defaults to gold)
| id-s = text size in points (pt) for the left if no image (opt., def=12)
| id2-s = text size in points (pt) for the right if no image (opt., def=12)
| info-s = text size in points (pt) for the center (optional, defaults to 8)
| id = completely override the left side with your own content
| id2 = completely override the right side with your own content
| info = completely override the center with your own content
}}
- Note: If you find yourself overriding a large number of default options, it probably is easier on the server and on you to customize one of my standard userboxes instead.
Examples
| Clan | This user is of the [[|Clan ]] |
|
This user is of the Clan Cameron—"Aonaibh Ri Chéile" | .png){kind=small}
|
{{User:Willscrlt/UBX/Clan|Cameron}}
|
|
This user is of the MacChlerich sept of Clan Cameron—"Aonaibh Ri Chéile" |
|
{{User:Willscrlt/UBX/Clan|MacChlerich}}
|
This user is of the Clan Campbell—"Ne Obliviscaris" | 
|
{{User:Willscrlt/UBX/Clan|Campbell}}
|
|
This user is of the Conochie sept of Clan Campbell—"Ne Obliviscaris" |
|
{{User:Willscrlt/UBX/Clan|Conochie}}
|
This user is of the Clan Murray—"Tout Pret" | .png){kind=small}
|
{{User:Willscrlt/UBX/Clan|Murray}}
|
|
This user is of the Morray sept of Clan Murray—"Tout Pret" |
|
{{User:Willscrlt/UBX/Clan|Morray}}
| Clan | This user is of the Clan Spalding—"Nobile servitium" |
{{User:Willscrlt/UBX/Clan|Spalding}}
|
This user is of the Fotheringham sept of Clan Lindsay—"Endure fort" | .svg){kind=small}
|
{{User:Willscrlt/UBX/ClanBox
| clan = Lindsay
| sept = Fotheringham
| motto = Endure fort
| img1 = Clan member crest badge - Clan Lindsay.svg
| img2 = Arms of Lindsay (Earl Crawford).svg
| img1-s = 32
| id2-c = white
}}
See also