Template:BubbleNav: Difference between revisions

From Red Faction Wiki
mNo edit summary
No edit summary
 
(5 intermediate revisions by 2 users not shown)
Line 6: Line 6:
</div>
</div>
</includeonly><noinclude>
</includeonly><noinclude>
{{BubbleNav|RFGCharacters|yes|no}}{{BubbleNav|RFOCharacters|no|yes}}
:To view, add and edit navigation presets, see [[Template:BubbleNav/data]].
<pre>
<templatedata>
{{BubbleNav}}
{
}}
"params": {
</pre>
"1": {
'''Guide to each parameter:''' View [[Template:Bubble]] for more information on how to use.
"label": "Preset",
<pre>
"description": "The preset that the navigation will use. This parameter grabs the presets from the Template:BubbleNav/data page.",
{{BubbleNav
"example": "RFGCharacters",
|title = A bubble template is used here. ONLY use the "explore" type. -
"type": "string",
 
"required": true
"explore" type:
},
Used on main game pages.
"2": {
* If the navigation is intended for use on a main game page: only put the game's link as the text.  
"label": "No Divider",
* If the navigation is intended for use on subpages: For example, if they are pages part of a larger collection, such as RF:G's locations. The text would link to the "Red Faction: Guerrilla Locations" page. Make sure to read any pages with this template for more context such as the ones just mentioned.
"description": "Sets whether the template's bottom divider is disabled. Use \"yes\" to disable the divider, \"no\" to keep the divider enabled.",
 
"example": "yes",
"none" type:
"type": "string",
This type is not intended to be used for the title, but is there if needed. This type removes the "Explore" label and only contains the text and icon.
"suggestedvalues": [
 
"yes",
|links = One or more bubble templates can be used here. ONLY use the "link" type.
"no"
 
],
|nodivider = When a {{BubbleNav}} is placed inside another template to be transcluded into another page, add "yes" as a parameter to the transclusion, e.g. {{RFGLocations|yes}}. This will denote that there should not be a divider at the bottom of the template.
"default": "no"
 
},
Use this parameter on any transcluded {{BubbleNav}}'s that are above another. Make sure the bottom-most transclusion has a divider by ommitting the parameter (e.g., {{RFGLocations}}).
"3": {
}}
"label": "Collapsed",
</pre>
"description": "Sets whether the template is collapsed by default. Use \"yes\" to set it to collapsed, \"no\" to open by default.",
 
"example": "yes",
"type": "string",
"suggestedvalues": [
"yes",
"no"
],
"default": "no"
}
},
"description": "Place at the top of pages to create a navigation bar for quick access to other pages.",
"paramOrder": [
"1",
"2",
"3"
],
"format": "inline",
"maps": {
"Test": {}
}
}
</templatedata>
<pre>{{BubbleNav|PRESET}}</pre>
'''Usage:'''
'''Usage:'''
<pre>
<pre>{{BubbleNav|RFGCharacters|no|no}}</pre>
{{BubbleNav
|title  =
{{Bubble|explore|[[Red Faction: Guerrilla]]|Icon_RFG.png|Red Faction: Guerrilla}}
|links  =
{{Bubble|link|[[RF:G Editing Main Page|Modding]]|Icon_RFG.png|RF:G Editing Main Page}}
{{Bubble|link|[[Red Faction: Guerrilla Campaign Guide|Campaign]]|Icon_RFGBadge1.png|Red Faction: Guerrilla Campaign Guide}}
{{Bubble|link|[[Red Faction: Guerrilla Multiplayer Guide|Multiplayer]]|Icon_RFGBadge2.png|Red Faction: Guerrilla Multiplayer Guide}}
{{Bubble|link|[[Wrecking Crew]]|Icon_RFGBadge3.png|Wrecking Crew}}
{{Bubble|link|[[Red Faction: Guerrilla Vehicles|Vehicles]]|Icon_RFGVehicle.png|Red Faction: Guerrilla Vehicles}}
{{Bubble|link|[[Red Faction: Guerrilla Locations|Locations]]|Icon_RFGSafehouse.png|Red Faction: Guerrilla Locations}}
}}
</pre>
 
'''Output:'''
'''Output:'''
{{BubbleNav
{{BubbleNav|RFGCharacters|no|no}}
|title  =
[[Category:Core Templates]]
{{Bubble|explore|[[Red Faction: Guerrilla]]|Icon_RFG.png|Red Faction: Guerrilla}}
|links  =
{{Bubble|link|[[RF:G Editing Main Page|Modding]]|Icon_RFG.png|RF:G Editing Main Page}}
{{Bubble|link|[[Red Faction: Guerrilla Campaign Guide|Campaign]]|Icon_RFGBadge1.png|Red Faction: Guerrilla Campaign Guide}}
{{Bubble|link|[[Red Faction: Guerrilla Multiplayer Guide|Multiplayer]]|Icon_RFGBadge2.png|Red Faction: Guerrilla Multiplayer Guide}}
{{Bubble|link|[[Wrecking Crew]]|Icon_RFGBadge3.png|Wrecking Crew}}
{{Bubble|link|[[Red Faction: Guerrilla Vehicles|Vehicles]]|Icon_RFGVehicle.png|Red Faction: Guerrilla Vehicles}}
{{Bubble|link|[[Red Faction: Guerrilla Locations|Locations]]|Icon_RFGSafehouse.png|Red Faction: Guerrilla Locations}}
}}
{{BubbleNav
|title  =
{{Bubble|explore|[[Red Faction: Guerrilla]]|Icon_RFG.png|Red Faction: Guerrilla}}
|links  =
{{Bubble|link|[[RF:G Editing Main Page|Modding]]|Icon_RFG.png|RF:G Editing Main Page}}
{{Bubble|link|[[Red Faction: Guerrilla Campaign Guide|Campaign]]|Icon_RFGBadge1.png|Red Faction: Guerrilla Campaign Guide}}
{{Bubble|link|[[Red Faction: Guerrilla Multiplayer Guide|Multiplayer]]|Icon_RFGBadge2.png|Red Faction: Guerrilla Multiplayer Guide}}
{{Bubble|link|[[Wrecking Crew]]|Icon_RFGBadge3.png|Wrecking Crew}}
{{Bubble|link|[[Red Faction: Guerrilla Vehicles|Vehicles]]|Icon_RFGVehicle.png|Red Faction: Guerrilla Vehicles}}
{{Bubble|link|[[Red Faction: Guerrilla Locations|Locations]]|Icon_RFGSafehouse.png|Red Faction: Guerrilla Locations}}
}}
</noinclude>
</noinclude>

Latest revision as of 03:39, 2 March 2024

To view, add and edit navigation presets, see Template:BubbleNav/data.

Place at the top of pages to create a navigation bar for quick access to other pages.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Preset1

The preset that the navigation will use. This parameter grabs the presets from the Template:BubbleNav/data page.

Example
RFGCharacters
Stringrequired
No Divider2

Sets whether the template's bottom divider is disabled. Use "yes" to disable the divider, "no" to keep the divider enabled.

Suggested values
yes no
Default
no
Example
yes
Stringoptional
Collapsed3

Sets whether the template is collapsed by default. Use "yes" to set it to collapsed, "no" to open by default.

Suggested values
yes no
Default
no
Example
yes
Stringoptional
{{BubbleNav|PRESET}}

Usage: 

{{BubbleNav|RFGCharacters|no|no}}

Output:

    • Retrieved from "https://www.redfactionwiki.com/w/index.php?title=Template:BubbleNav&oldid=14175"