Template:Usergod

From GodWiki
Revision as of 21:00, 13 November 2019 by Djonni (talk | contribs) (Quick and dirty support for undocumented nocat parameter, since I want to use this on a talk page in a second.)
Jump to: navigation, search
Usergod
Personality: Unknown



[view] [edit] [history] [refresh]
📚 Documentation

The {{Usergod}} template is a way to show visitors to your Godwiki page information about yourself in a clear, attractive infobox. It can be as simple and easy as you want, or as elaborate as you like if you want to get fancy with it.

Simple and easy!

Here's a simple quick start template! Copy-paste this into your personal page, fill in any information you want after the equals signs, and that's it! Every parameter of the template is optional, set only what you want.

{{Usergod
| title =       <!-- A title to place in front of your name. E.g.: God, Goddess, The Great And Powerful -->
| avatar =      <!-- The name of an image to represent you. E.g.: Example-simple.png -->
| hero =        <!-- The name of your hero. Have a heroine? See next. -->
| heroine =     <!-- The name of your heroine. Have a hero? See above. -->
| personality = <!-- Your personality, if you wish to describe it. -->
| gender =      <!-- Your gender, if you wish to specify it. -->
| motto =       <!-- Your or your hero(ine)'s motto. -->
| guild =       <!-- The name of your guild, which will link to the guild's Godwiki page. -->
}}

Read on for more, if you want it. 😊

Simplest parameters

title
A title to place before the God's name. E.g., |title=The Great and Powerful; |title=God
avatar
Supply an filename for your avatar image (e.g., my-super-cool-godville-avatar.jpg. If the filename supplied is not found on the wiki, you'll be given a link to upload it.
hero or heroine
The name of your hero or heroine. This will be made into a link to a Godwiki page with your hero or heroine's name.
personality
Your personality, if you wish to describe it.
gender
Your gender, if you wish to describe it.
motto
Your, or your hero or heroine's, motto.
guild
The name of your guild, which will link to your guild's Godwiki page.

Done! Read on if you'd like to add some colour to your infobox, and if you'd like to add more details and information to your infobox, you can read about more parameters.

Simplest colours

The default colour scheme for the infobox is a transparent background and simple white borders between rows. The template offers a few ways to change the colour scheme to anything you like. The simplest way is to use the |highlighthex= parameter. It will apply a single, simple color scheme to the whole template for you. Below are some examples; paste the parameter into your template and voila!

Deities of Godville
Example God or Goddess
Header
Label Data

|highlighthex=#FFDD88

Deities of Godville
Example God or Goddess
Header
Label Data

|highlighthex=#FF9966

Deities of Godville
Example God or Goddess
Header
Label Data

|highlighthex=#2ECC71

Deities of Godville
Example God or Goddess
Header
Label Data

|highlighthex=#BB8FCE

Deities of Godville
Example God or Goddess
Header
Label Data

|highlighthex=#FF33CC

Those are just some examples, there are countless possible colours to choose from (well, 16.8 million colours to choose from, but I've never counted that high). You can take a look at htmlcolorcodes.com and pick any color, just copy the hex value (#xxxxxx) into the highlighthex parameter (|highlighthex=#xxxxxx) and preview your new colour to make sure it turned out like you expected.

You can, if you like, also have more control over the colours used in different parts of the template. For more advanced colour and style options, see § Colour and style parameters below.

Basic parameters

All parameters are optional. If no parameters are supplied at all, only the header with the name of the current page styled as a {{god}} link will be shown.

title
A title to place before the God's name. E.g., |title=The Great and Powerful; |title=God
avatar
Supply an filename for your avatar image (e.g., my-super-cool-godville-avatar.jpg. If the filename supplied is not found on the wiki, you'll be given a link to upload it.
hero or heroine
The name of your hero or heroine. This will be made into a link to a Godwiki page with your hero or heroine's name.
personality
Your personality, if you wish to describe it.
gender
Your gender, if you wish to describe it.
motto
Your, or your hero or heroine's, motto.
guild
The name of your guild, which will link to your guild's Godwiki page.
temple
breeder
ark
shop
pairs
These parameters will appear as medals after the God's name in the header. Traditionally these are set with when you achieved the medal (e.g., |temple=10/02/2018 13:38, or =09:29, 3 November 2019 (UTC), or =December 1st, 2018, or whatever). See Template:God/Documentation for more details.
postnomial
A title for after the God's name. E.g., |postnomial=the Inedible.
subheader
A subheader can be placed immediately below the header, above the image.
avatar
Supply an image name for your avatar. Note that this doesn't need [[File:filename.ext|thumb...]] and all that, you'll end up with a weird result. Just give it the file name and trust the template to format your picture for you.
caption
A caption that will appear underneath the avatar image.
hero
heroine
personality
gender
motto
town
guild
All as described above, in § Simplest parameters. See there for more details.
pronouns
If you wish to specify them, they will appear below the gender row.
herolabel
If supplied, the contents of this parameter will replace Hero or Heroine in the label column. So, for example, |herolabel=Mister results in Mister   Hero Name; |herolabel=Champion results in Champion   Hero Name
To avoid confusion, heroinelabel will also work.
herolink=no
If this parameter is set to any no-like value, the hero name in the infobox will not be turned into a link.
To avoid confusion, heroinelink will also work.
domain
Your "domain", your area of influence in the world (whichever world you like).
below
As per |above=, anything set here will appear at the very bottom of the infobox.

Extra sections

The template can be used to display extended information about your guild, your pantheon positions, and more.

Guild section

guildimage
An image image name for a guild emblem. If supplied, this will appear at the top of the guild section, with the guild name as the caption.
position
A position in a guild's organisation.
rank
Guild rank.
guildlink=no
If this parameter is set to any no-like value, the guild name in the infobox will not automatically be turned into a link.
guildcustomheader1-50
guildcustomlabel1-50
guildcustomdata1-50
Advanced Up to 50 custom rows can be added to the Guild section. See § Custom section below for more detail on how these parameters work.

Pantheon section

Long Term

gratitude
might
templehood
gladiatorship
storytelling

Short Term

mastery
construction
taming
survival
savings
creation
destruction
arkeology
catch
duelersjr
duelerssr

Guild

unity
popularity
duelery
adventure
Give these parameters a numeric value (for example, |might=1234), and it will display a nicely formatted link to that position in the pantheon. If you provide it with anything but a numeric value, the value of the parameter will be displayed exactly as given. So, if |might=I'm the best, whatever., the cell will display I'm the best, whatever..
pantheonsubheaders = yes/no
This parameter can be used to switch the Long Term, Short Term and Guild subheaders on or off. If |pantheonsubheaders=yes (or and yes-like value), a subheader will be displayed if any parameters of that type are given. |pantheonsubheaders=no (or any no-like value) will turn the subheaders off. The default behaviour is that the subheaders will appear if there is at least one pantheon from more than one of the groupsbeing shown. Use this if you only supply a couple of pantheons and don't want the subheaders, or if you definitely want the subheader to appear even if you only supply pantheons of one kind.
pantheoncustomheader1-50
pantheoncustomlabel1-50
panethoncustomdata1-50
Advanced Up to 50 custom rows can be added to the Pantheon section. See the custom section below for more detail on how these parameters work.

Custom section

This section contains some advanced ways to customise the template. It isn't simple, and requires a bit of effort, but can can be used to do cool stuff.

This template allows you to create your own custom section appearing at the bottom of the infobox, displaying anything you like, any way you like. Uses for this are unlimited, but might include:

  • Embedding your hero information into your god infobox
  • Details of the various aspects and manifestations your divinity takes on in the world
  • A list (or table of badges) of your in-game achievements
  • Details of your role-playing character(s) in the forums
  • Or anything at all that you can think of.

Because the custom section is highly configurable, it allows you to set your own headers, labels, and data fields, and also allows for the display of an image with caption.

customsection
Text for the custom section header.
customemoji
An emoji to appear to the left of the customsection header, if desired (e.g., |customemoji=⚔️. This will be keep the header text correctly balanced in the center. If you only want the custom section header to be an emoji, set it with customsection (e.g., |customsection=🌙.
customimage
customcaption
An image and caption to appear immediately below the custom header.
customheader1-99
customlabel1-99
customdata1-99
Labels and data to appear in rows 1-99. These can be set in any combination:
  • If a label parameter is set but the data is not supplied for that row, it will not appear.
  • If a data parameter is set without a label, it will take up the entire row. (For example, the guild name takes up a whole row this way.)
  • If label and data parameters are set for a row, they will both appear.
  • If a header is set for a row, it will appear instead of any label or data values supplied for that row, which will not be seen.
See the example below. |customheader1=Custom header 1 appears instead of |customlabel1=... or |customdata1=....
Deities of Godville
Usergod 
Example custom section
Custom header 1
Custom label 2 Custom data 2
Custom data 3
{{Usergod
|customsection=Example custom section
|customheader1=Custom header 1
|customlabel1=This won't be visible
|customdata1=Neither will this
|customlabel2=Custom label 2
|customdata2=Custom data 2
|customdata3=Custom data 3
|customlabel4=This label has no data, so won't appear
}}

Colour and style parameters

A note on links and colours
Unfortunately, there's no way to change the colours of the links in the infobox. Whatever colour scheme you decide on, the links will always be the same blue and red colours as they are everywhere on the wiki.

In order to allow for people who would like to colour their text and without any links, the following parameters are supported:

guildlink=no
If this parameter is set to any no-like value, the guild name in the infobox will not be turned into a link.
herolink=no
If this parameter is set to any no-like value, the hero name in the infobox will not be turned into a link.
To avoid confusion, heroinelink will also work.
name
Setting this parameter will disable the automatic linking of the deity's name in the infobox header.

For all pantheon parameters, providing anything which is not a raw number or mathematical expression will suppress linking. (I.e., |templehood=1000 would create a link; |templehood=1,000th would not.)

For a clever hack from Emptysora which doesn't change the link colour, but allows you to have correctly coloured text with the link beside, see User talk:Djonni/Template sandbox#A bit of a hack for the link colors.

highlighthex
If you give this parameter a six-character hex code in #RRGGBB format, it will create a simple colour scheme for the whole table. The colour given will be set as the header and label colour, and lighter version of it will be used for the data cells and internal borders.
bodycolor
Sets a color for the background of the whole infobox. This color will be seen in any area where another color is not explicitly set. By default, the background is transparent; or, if |highlighthex= is set to any value, the background will default to a neutral off-white (#f8f9fa).
Any valid HTML color value can be set here. Hex values (i.e. #RRGGBB), color names (purple, slateblue, etc).
Pro tip: Set this to a light, non-white colour and combine with highlighthex to create interesting colour schemes. Highlighthex works by applying transparency to data cells, so the bodycolor will be mixed with it in those areas.
headercolor
datacolor
These parameters can be used instead of highlighthex to specify a color for the headers and labels (|headercolor=) and the data cells (|datacolor=). These parameters will cause |highlighthex= to be ignored in the applicable places, if it's set.
Any valid HTML color value can be set here. Hex values (i.e. #RRGGBB), color names (purple, slateblue, etc).
imagecolor
This parameter can be used instead of highlighthex to specify a color for the background of the image and caption areas. If this parameter is not set, the |datacolor= and |highlighthex= parameters will be used in that order.
Any valid HTML color value can be set here. Hex values (i.e. #RRGGBB), color names (purple, slateblue, etc).
bordercolor
Sets a color for the borders below each row of the infobox table. The default colour value used is #F4F6F6 or, if |highlighthex= is set, the border colour will be halfway between the label and data background colors (due to overlaid transparencies).
Any valid HTML color value can be set here. Hex values (i.e. #RRGGBB), color names (purple, slateblue, etc).
bodystyle
subheaderstyle
imagestyle
abovestyle
belowstyle
navstyle
headerstyle
labelstyle
datastyle
Know CSS? Want to place your own custom CSS into any of these fields? Go ahead! The contents of these parameters will be passed directly to {{Infobox}} after the default styles, meaning that the values you supply here will overwrite and replace what comes before them. This will allow you to create your own interesting, spectacular, creative and horrible styles for your Usergod infobox. With great power comes greatly uglified infoboxes.

Subsection style parameters

emoji=no
icons=no
Don't love these new-fangled pictograms the kids these days use instead of words? No problem! Just set either |emoji=no or |icons=no and they'll be disabled. (Default behaviour is the same as |emoji=yes.)
guildhighlighthex
guildheadercolor
guilddatacolor
guildbordercolor
These parameters work as you expect to apply colours only to the Guild subsection of the infobox.
guildstyle
CSS to be applied to the whole Guild subsection.
guildheaderstyle
guildlabelstyle
guilddatastyle
guildimagestyle
CSS to be applied to header, label, data and image cells of the Guild subsection.
pantheonhighlighthex
pantheonheadercolor
pantheondatacolor
pantheonbordercolor
These parameters work as you expect to apply colours only to the Pantheon subsection.
pantheonstyle
CSS to be applied to the whole Pantheon subsection.
guildheaderstyle
guildlabelstyle
guilddatastyle
CSS to be applied to the header, label, and data cells of the Pantheon subsection.
customhighlighthex
customheadercolor
customimagecolor
customdatacolor
custombordercolor
These parameters work as you expect to apply colours only to the Custom subsection.
customstyle
CSS to be applied to the entire Custom subsection.
customheaderstyle
customimagestyle
customlabelstyle
customdatastyle
CSS to be applied to the header, image, label, and data cells of the Custom subsection.
customrowstylen
customlabelstylen
customdatastylen
Styling to be applied to specific rows or cells of the custom section.

Misc

nocat
If set to any value, the template will not apply [[Category:Gods]] to the page in which it appears. The default behaviour for the template is to correctly categorise the page.