Template:Player Navbox/doc

This template is based on and intended to be an alternative to Template:Navbox for players.

 Player Navbox Creation

Description

 * This template is aimed at being an automated and easily customizable pure HTML version specific to players and their characters. This is meant to make the process of creating a navbox for players easier, to allow for easier customization, and to make maintenance of said navbox in terms of updating character statuses to be virtually hands-off.
 * At minimum, when supplied with a player name and a list of that player's characters, this navbox will automatically sort those characters in the resulting navbox into 4 categories based on their status set in their character infobox on their page:
 * Active Characters — Characters who either have  in their infobox, or no status specified which defaults to
 * Inactive Characters — Characters who either have  or   set in their infobox.
 * Deceased Characters — Character who have  set in their infobox.
 * Other Characters — Characters who are either not using Template:Infobox character, or a custom infobox template with a name not containing the case-insensitive word " " on their page.

If desired, additional parameters can be supplied to apply some customization to this navbox, but otherwise this template will display similarly to Template:Navbox.

Parameters
{	"params": { "player": { "description": "This is the name of the player who plays the character listed in the navbox.", "example": "player=PLAYER_NAME", "type": "string", "required": true, "label": "Player", "default": "PLAYER_NAME" },		"border_color": { "label": "Border Color", "description": "This will be the color of the border around the navbox. You can specify the value in any format that would usually be accepted in the \"border-color\" property in CSS.", "example": "border_color=blue / border_color=#00f8b9 / border_color=rgb(0, 248, 185) / border_color=hsla(165, 100%, 48.6%, 1)", "type": "string", "default": "#00f8b9" },		"border_radius": { "label": "Border Radius", "description": "Any value higher than 1 will cause the navbox to have a curvature in its corners.", "example": "border_radius=20", "type": "number", "default": "1" },		"border_glow": { "label": "Border Glow", "description": "Specifies whether or not the outer border emits a glowing effect.", "example": "border_glow=true", "type": "boolean", "default": "false" },		"header_color": { "label": "Header Color", "description": "This will be the color of the header where the player's name is displayed. You can specify the value in any format that would usually be accepted for the \"background\" property in CSS.", "type": "string", "default": "#086f63", "example": "header_color=blue / header_color=#086f63 / header_color=rgba(8, 111, 99, 1) / header_color=linear-gradient(to bottom, #5bcefa, #f5a9b8, #ffffff, #f5a9b8, #5bcefa)" },		"header_font_color": { "label": "Header Font Color", "description": "This is the color that the text \"Played by: PLAYER_NAME\" will display in. You can specify the value in any format that would usually be accepted for the \"color\" property in CSS. (Currently this will not affect the font color of the player name itself if a page link is specified for the \"player\" parameter, but this can be manually specified in the following format: PLAYER_NAME . This issue may be addressed in the future.)", "example": "header_font_color=#e6e6e6 / header_font_color=rgb(99, 99, 99)", "type": "string", "default": "#e6e6e6" },		"body_color": { "label": "Body Color", "description": "This will be the color of the background in the body of the navbox. You can specify the value in any format that would usually be accepted for the \"background\" property in CSS.", "example": "body_color=blue / body_color=#012345 / body_color=rgba(0, 128, 256, 1) / body_color=linear-gradient(to bottom, #5bcefa, #f5a9b8, #ffffff, #f5a9b8, #5bcefa)", "type": "string", "default": "transparent" },		"body_font_color": { "label": "Body Font Color", "description": "This will be the color of all the character names in the body of the navbox. You can specify the value in any format that would usually be accepted for the \"color\" property in CSS. This will NOT affect the character status text OR the • separator characters.", "example": "body_font_color=#08f8b9 / body_font_color=rgb(8, 248, 185)", "type": "string", "default": "#08f8b9" },		"horizontal_rule_color": { "aliases": [ "hr_color" ],			"label": "Horizontal Rule Color", "description": "This will be the main and glow color for the lines that separate the character status groups. You can specify the value in any format that would usually be accepted in the \"border-color\" property in CSS.", "example": "horizontal_rule_color=purple / hr_color=#00f8b9 / horizontal_rule_color=rgb(0, 248, 185) / hr_color=hsla(165, 100%, 48.6%, 1)", "type": "string", "default": "#00f8b9" },		"horizontal_rule_glow": { "aliases": [ "hr_glow" ],			"label": "Horizontal Rule Glow", "description": "Specifies whether or not the line separating character status groups emits a glowing effect.", "example": "horizontal_rule_glow=true / hr_glow=true", "type": "boolean", "default": "false" },		"active_font_color": { "aliases": [ "active_color" ],			"label": "Active Font Color", "description": "This will be the color of the label for the active character section that reads \"Active Characters:\". You can specify the value in any format that would usually be accepted for the \"color\" property in CSS.", "example": "active_font_color=#3bba32 / active_color=rgb(59, 186, 50)", "type": "string", "default": "#3bba32" },		"inactive_font_color": { "aliases": [ "inactive_color" ],			"label": "Inactive Font Color", "description": "This will be the color of the label for the inactive character section that reads \"Inactive Characters:\". You can specify the value in any format that would usually be accepted for the \"color\" property in CSS.", "example": "inactive_font_color=#30ab94 / inactive_color=rgb(48, 171, 148)", "type": "string", "default": "#90a337" },		"deceased_font_color": { "aliases": [ "deceased_color" ],			"label": "Deceased Color", "description": "This will be the color of the label for the deceased character section that reads \"Deceased Characters:\". You can specify the value in any format that would usually be accepted for the \"color\" property in CSS.", "example": "deceased_font_color=#b31d1d / deceased_color=rgb(179, 29, 29)", "type": "string", "default": "#b31d1d" },		"other_font_color": { "aliases": [ "other_color" ],			"label": "Other Font Color", "description": "This will be the color of the label for the other character section that reads \"Other Characters:\". You can specify the value in any format that would usually be accepted for the \"color\" property in CSS.", "example": "other_font_color=#999999 / other_color=rgb(153, 153, 153)", "type": "string", "default": "#999999" },		"separator_color": { "aliases": [ "sep_color" ],			"label": "Separator Color", "description": "This will be the color for the \"•\" character that separates character names in the body of the navbox. You can specify the value in any format that would usually be accepted for the \"color\" property in CSS.", "example": "separator_color=#e6e6e6 / sep_color=rgb(230, 230, 230)", "type": "string", "default": "#e6e6e6" },		"text_shadow": { "label": "Text Shadow", "description": "Specifies whether or not the text in the navbox will have a shadow.", "example": "text_shadow=false", "type": "boolean", "default": "true" },		"text_shadow_offset": { "label": "Text Shadow Offset", "description": "This is the horizontal and vertical offset, respectively, of the text shadow. The text shadow appears behind and the same size as the text its shadowing. POSITIVE numbers are RIGHT and UP, and NEGATIVE numbers are LEFT and DOWN.", "example": "text_shadow_offset= -1.5px 1.5px", "type": "string", "default": "-0.8px 0.8px" },		"text_shadow_color": { "label": "Text Shadow Color", "description": "This will be the color of the shadow cast by the text. You can specify the value in any format that would usually be accepted for the \"color\" property in CSS.", "example": "text_shadow_color=purple / text-shadow_color=rgb(45, 234, 7)", "type": "string", "default": "rgba(0, 0, 0, 0.5)" },		"tabbed": { "label": "Tabbed", "description": "Specifies whether or not the navbox's character statuses should be contained all on one page or in their own tabs.", "example": "tabbed=false", "type": "boolean", "default": "true" }	},	"format": "block", "paramOrder": [ "player", "border_color", "border_radius", "border_glow", "header_color", "header_font_color", "body_color", "body_font_color", "horizontal_rule_color", "horizontal_rule_glow", "separator_color", "active_font_color", "inactive_font_color", "deceased_font_color", "other_font_color", "text_shadow", "text_shadow_offset", "text_shadow_color", "tabbed" ],	"description": "" }