Template:Comparison/doc

This template is used to generate a mobile-friendly comparison display. The display shows a horizontal list of up-to five characters, each with their own color which may be defined per-usage of the template. Next, several "attributes" can be defined, like "tall", "short", "female", "House Rahl", any characterist of comparison. Those "attributes" display as starburst shapes which take on the color of those characters which it applies to, complete with a legend and optional footer to explain the relationships.


 * See installation instructions or the template shall not work.

Installation
This template relies on two dependency templates, two extensions, and a CSS file to function properly, and you will need an Administrator to set them up; if you are not an Administrator, you will need to ask one to do these things for you. To make sure everything transfers smoothly to your wiki, do the following:  Ensure that Loops, Variables, and Arrays are all enabled on your wiki, which you can check by going to Special:Version and CMD+F/CTRL+F searching for "Loops", "Variables", and "Arrays". If any return "not found", then contact your Wiki Representative if you have one, or contact Fandom support directly if you don't, to have them enable the extensions for you. ''These extensions will probably not be enabled on your wiki — they are disabled by default on Fandom.  Install the CSS, which is located at [/load.php?debug=true&mode=articles&only=styles&articles=u:miyadaiku:MediaWiki:Comparison.css MediaWiki:Comparison.css]. If you are an Administrator, you can copy this CSS directly into [ MediaWiki:Comparison.css on your wiki], and then add this line of CSS to the very top of [ MediaWiki:Common.css] :

If you know what you are doing, you can also import the file directly from Miyadaiku Wiki, although this isn't recommended as we cannot update the templates and CSS together from Miyadaiku Wiki.  Import templates. Go to this page, add the following list into the box:

Template:Comparison Template:Comparison/char Template:Comparison/doc Template:Comparison/footer Template:Comparison/row Template:Comparison/shape Template:Comparison/trim

Next, hit "Export". After that, import the templates to your wiki by uploading the file you just downloaded (detailed instructions). Finally, classify |the main template as Data, and everything else you just imported as Non-article.  You're done!

Parameter notes

 * footer: Optional, if set to "hidden", hides the footer at the bottom of the template.
 * char-X: Accepts parameters 1 through 5 (e.g. char-1, char-5) to define a character using plain text, single-line — NO LINKS, see warning blow for link instructions.
 * Add an -symbol after your input, followed by a hex code or any other valid CSS color, to set the color for that character. Add another  -symbol after that, followed by a full URL or wikitext link, to make your character a clickable link.
 * Example: . No brackets.
 * Attributes: Simple 1,2,3...etc (up to 30) parameters are used to define individual attributes. This is the syntax: | @  @
 * Plain text portion: This should be simple text (no links!) providing the attribute name.
 * Character codes: c1, c2, c3, c4, and c5 are the five character codes, and they correspond with the characters you've defined as char-1, char-2, et cetera. If a given attribute, say, "human", applies to all characters, you would type "c1,c2,c3,c4,c5" here — however, if char-5 was an alien for example, you would only type "c1,c2,c3,c4", so that the "human" attribute only applies to the first four characters that are actually human. You can assign an attribute to only one character or all of them, in any order. If you do not assign an attribute to at least one character, the attribute will not display and an error will throw for that attribute.
 * WARNING: If you have not defined five characters but attempt to assign "c5" to an attribute, an error will be thrown for that attribute and it will not display.
 * WARNING: If you add gobbledygook text after the first -symbol, or even just something other than the comma-separated character codes, an error will be thrown for that attribute and it will not display.
 * Optional link: If you would like your attribute to be a clickable link, add a third -symbol after the character codes, followed by a full URL or a wikitext link (no brackets!).
 * Sample syntaxes: |Tall @ c3  |Short @ c4,c2 @ wiktionary:Short  |Test  @ c5 @ https://google.com
 * LINK WARNING: Do not wrap the plain text portion of ANY of these parameters in wikitext links (i.e.,  ). Instead, you MUST define a link after the second  -symbol (without brackets!).

Default color sets

 * Character 1: #005BC9
 * Character 2: #9400C9
 * Character 3: #C90000
 * Character 4: #C99E00
 * Character 5: #00C900

Character codes

 * char-1: c1
 * char-2: c2
 * char-3: c3
 * char-4: c4
 * char-5: c5