Template:Bubble: Difference between revisions

Revision as of 09:40, 28 January 2024

A bubble with icon and text for use in BubbleNav templates.

Template parameters
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
Type	`1`	Used to determine the bubble's style. Use "explore" for the title of a preset, "link" for the links section of the preset. Suggested values `explore` `link` `none` Example explore	String	required
Text	`2`	Text that shows to the right of the bubble's icon. Write a link as the text if the bubble's type is "link". Either write a link and/or description if the bubble's type is "explore". Example [[Red Faction: Guerrilla Locations]]	String	required
Icon	`3`	An icon shown to the left of the text. Omit if there is no icon. Example Icon_RFG.png	File	optional
Icon Link	`4`	The page that the icon redirects to. It should be the same page that is linked inside the bubble's text. Omit if there is no icon. Example Red Faction: Guerrilla	Page name	optional

Usage:

{{Bubble| TYPE | TEXT | ICON | ICON_LINK }}

{{Bubble|explore|[[Red Faction: Guerrilla]]|Icon_RFG.png|Red Faction: Guerrilla}}
{{Bubble|explore|[[Red Faction: Guerrilla Locations]]|Icon_RFG.png|Red Faction: Guerrilla Locations}}
{{Bubble|link|[[Parker (Sector)|Parker]]|Icon_RFG.png|Parker (Sector)}}

Output:

EXPLORE

Red Faction: Guerrilla

EXPLORE

Red Faction: Guerrilla Locations

EXPLORE

Parker

@@ Line 7: / Line 7: @@
 {{{2}}}
 </div></includeonly><noinclude>
-<pre>
+<templatedata>
-{{Bubble|}}
+{
-</pre>
+	"params": {
-'''Guide to each parameter:''' This template is intended to be used with [[Template:BubbleNav]]. Visit the page for more information on the bubble types.
+		"1": {
-<pre>
+			"label": "Type",
-{{Bubble| TYPE | TEXT | ICON | ICON LINK }}
+			"description": "Used to determine the bubble's style. Use \"explore\" for the title of a preset, \"link\" for the links section of the preset.",
+			"example": "explore",
-Each parameter is separated by the vertical bar/pipe symbol "|", there are no parameter names used in this template. The template will only work correctly if the order of parameters is also correct. Make sure to read the Usage section for more examples.
+			"type": "string",
+			"suggestedvalues": [
-type:
+				"explore",
-"explore", "link" or "none".
+				"link",
+				"none"
-text:
+			],
-The link or text that's going to show in the box to right of the icon.
+			"required": true
+		},
-icon:
+		"2": {
-An image shown to the left of the text. Only write the image name with its extension and no other formatting, e.g. "Icon_RFG.png". "icon" and "icon link" can be ommitted if an icon isn't needed for the bubble.
+			"label": "Text",
+			"description": "Text that shows to the right of the bubble's icon. Write a link as the text if the bubble's type is \"link\". Either write a link and/or description if the bubble's type is \"explore\".",
-icon link:
+			"example": "[[Red Faction: Guerrilla Locations]]",
-The link that the icon will redirect to. Make sure it's the SAME link you use inside "text" and write it without any brackets. For example, if the text was "[[Red Faction: Guerrilla Vehicles|Vehicles]]" or "[[Mount Vogel]]", the icon link would be "Red Faction: Guerrilla Vehicles" and "Mount Vogel" respectively.
+			"type": "string",
-</pre>
+			"required": true
+		},
+		"3": {
+			"label": "Icon",
+			"description": "An icon shown to the left of the text. Omit if there is no icon.",
+			"example": "Icon_RFG.png",
+			"type": "wiki-file-name"
+		},
+		"4": {
+			"label": "Icon Link",
+			"description": "The page that the icon redirects to. It should be the same page that is linked inside the bubble's text. Omit if there is no icon.",
+			"example": "Red Faction: Guerrilla",
+			"type": "wiki-page-name"
+		}
+	},
+	"description": "A bubble with icon and text for use in BubbleNav templates.",
+	"paramOrder": [
+		"1",
+		"2",
+		"3",
+		"4"
+	],
+	"format": "inline"
+}
+</templatedata>
 '''Usage:'''
+<pre>{{Bubble| TYPE | TEXT | ICON | ICON_LINK }}</pre>
 <pre>
 {{Bubble|explore|[[Red Faction: Guerrilla]]|Icon_RFG.png|Red Faction: Guerrilla}}
 {{Bubble|explore|[[Red Faction: Guerrilla Locations]]|Icon_RFG.png|Red Faction: Guerrilla Locations}}
 {{Bubble|link|[[Parker (Sector)|Parker]]|Icon_RFG.png|Parker (Sector)}}
-{{Bubble|none|Locations of [[Red Faction: Guerrilla]]|Icon_RFGSafehouse.png|Red Faction: Guerrilla}}
 </pre>
 '''Output:'''
-* "explore" bubble:
 {{Bubble|explore|[[Red Faction: Guerrilla]]|Icon_RFG.png|Red Faction: Guerrilla}}
 {{Bubble|explore|[[Red Faction: Guerrilla Locations]]|Icon_RFG.png|Red Faction: Guerrilla Locations}}
+{{Bubble|link|[[Parker (Sector)|Parker]]|Icon_RFG.png|Parker (Sector)}}</noinclude>
-* "link" bubble:
-{{Bubble|link|[[Parker (Sector)|Parker]]|Icon_RFG.png|Parker (Sector)}}
-* "none" bubble:
-{{Bubble|none|Locations of [[Red Faction: Guerrilla]]|Icon_RFGSafehouse.png|Red Faction: Guerrilla}}
-</noinclude>