From Brotato Wiki

(Character Pages: Replace link to "Crazy" with "One Armed", who has a lot more content)
(add "GenerateCharacterStartingWeaponsTable" in a new section called "Tables - Generated")
 
(10 intermediate revisions by 3 users not shown)
Line 4: Line 4:


=== Character Pages ===
=== Character Pages ===
If you're adding strategy information to a [[Characters|Character]] page, {{MiniIconbox|name=One Armed}} is a good point of reference. It has a table for synergies and makes liberal use of the [[Template:MiniIconbox|MiniIconbox]] template. Another good character page to reference is {{MiniIconbox|name=Mage}}, who has a section for their starting items.
If you're adding strategy information to a [[Characters|Character]] page, {{MiniIconbox|name=One Armed}} is a good point of reference. It has a table for synergies and makes liberal use of the [[Template:MiniIconbox|MiniIconbox]] template. Another good character page to reference is {{MiniIconbox|name=Mage}}, who has a section for their starting items, and {{MiniIconbox|name=Ranger}}, who has a Notes section for their starting weapons.


=== Mod Pages ===
=== Mod Pages ===
Line 39: Line 39:
|Contains and shows stats for every [[Weapons#Weapon Classes|Weapon Class]]
|Contains and shows stats for every [[Weapons#Weapon Classes|Weapon Class]]
|}
|}
To Do: Explain how to regenerate the corresponding page after adding the data


===General===
===General===
Line 79: Line 80:
|Mini icon box with a custom image and no link, intended for mod pages.
|Mini icon box with a custom image and no link, intended for mod pages.
|
|
|-
|[[Template:Version|Version]]
|Wraps around the mod's game version. Shows {{Color|color=pastelgreen|text=green}} if the version is current, {{Color|color=pastelred|text=red}} if it's behind.
|{{Version|version=1.1.6.0}} / {{Version|version=0.6.1.6}}
|-
|[[Template:LinkButton|LinkButton]]
|A link styled to look like a button - for internal wiki links
|
|-
|[[Template:ExternalLinkButton|ExternalLinkButton]]
|A link styled to look like a button - for external links
|
|}
=== Mods - StatsCard ===
{| class="wikitable"
!Template
!Description
!Preview
|-
|-
|[[Template:StatsCard|StatsCard]]
|[[Template:StatsCard|StatsCard]]
Line 98: Line 118:
|[[Template:StatsCard WeaponToggles|StatsCard_WeaponToggles]]
|[[Template:StatsCard WeaponToggles|StatsCard_WeaponToggles]]
|Toggle buttons to change all [[Template:StatsCardWeaponTabs|weapon tab]] tiers at once
|Toggle buttons to change all [[Template:StatsCardWeaponTabs|weapon tab]] tiers at once
|
|-
|[[Template:Version|Version]]
|Wraps around the mod's game version. Shows {{Color|color=pastelgreen|text=green}} if the version is current, {{Color|color=pastelred|text=red}} if it's behind.
|{{Version|version=0.6.0.7}} / {{Version|version=0.6.1.6}}
|-
|[[Template:LinkButton|LinkButton]]
|A link styled to look like a button - for internal wiki links
|
|-
|[[Template:ExternalLinkButton|ExternalLinkButton]]
|A link styled to look like a button - for external links
|
|
|}
|}
Line 133: Line 141:
|[[Template:Infobox_Elite|Infobox_Elite]]
|[[Template:Infobox_Elite|Infobox_Elite]]
|Infobox for a single [[Enemies#Elites (Danger 2+)|Elite Enemy]]
|Infobox for a single [[Enemies#Elites (Danger 2+)|Elite Enemy]]
|-
|[[Template:Infobox_Boss|Infobox_Boss]]
|Infobox for a single [[Enemies#Bosses_(Wave_20)|boss]]
|}
|}


Line 171: Line 182:
|<code><nowiki>{{Weapon}}</nowiki></code>
|<code><nowiki>{{Weapon}}</nowiki></code>
|[[Weapons|Weapon]]
|[[Weapons|Weapon]]
|Intro text
|Intro text. Set the type with <code><small><nowiki>{{Weapon|type=melee}}</nowiki></small></code> or <code><small><nowiki>{{Weapon|type=ranged}}</nowiki></small></code>
|-
|[[Template:Melee|Melee]]
|<code><nowiki>{{Melee}}</nowiki></code>
|[[Weapons|Weapon]]
|Weapon type text ([[Weapons#Melee Weapons|Melee]])
|-
|[[Template:Ranged|Ranged]]
|<code><nowiki>{{Ranged}}</nowiki></code>
|[[Weapons|Weapon]]
|Weapon type text ([[Weapons#Ranged Weapons|Ranged]])
|-
|-
|[[Template:WeaponPageClassText|WeaponPageClassText]]
|[[Template:WeaponPageClassText|WeaponPageClassText]]
Line 242: Line 243:
|[[Template:TableRowWeaponClass|TableRowWeaponClass]]
|[[Template:TableRowWeaponClass|TableRowWeaponClass]]
|Lists [[Weapons#Weapon Classes|Weapon Classes]]
|Lists [[Weapons#Weapon Classes|Weapon Classes]]
|}
===Tables - Generated ===
These tables are automatically generated, using Lua modules.
{| class="wikitable"
!Template
! Description
|-
|[[Template:GenerateCharacterStartingWeaponsTable|GenerateCharacterStartingWeaponsTable]]
|Generates a character's starting weapons table. Uses [[Module:GetStartingWeaponsTableForCharacter|this]] module. Pulls data from [[Template:Character Data|Character_Data]].
|}
|}


Line 267: Line 278:
|-
|-
|[[Template:MiscIcon|MiscIcon]]
|[[Template:MiscIcon|MiscIcon]]
|<code><nowiki>{{MiscIcon|Tree}}</nowiki></code>
|<code><nowiki>{{MiscIcon|Tree}}</nowiki></code>  
|{{MiscIcon|name=Tree}}
|{{MiscIcon|name=Tree}}
|}
|}


=== Toggles ===
===Toggles ===
Can be used to show/hide sections by clicking a button.
Can be used to show/hide sections by clicking a button.
{| class="wikitable"
{| class="wikitable"
Line 287: Line 298:
|-
|-
|[[Template:ToggleSection|ToggleSection]]
|[[Template:ToggleSection|ToggleSection]]
|Lets you make multiple toggleable sections that open/collapse from a single button.
| Lets you make multiple toggleable sections that open/collapse from a single button.
|<code><nowiki>{{ToggleSection}}</nowiki></code>
|<code><nowiki>{{ToggleSection}}</nowiki></code>
|-
|-
|[[Template:ToggleButton|ToggleButton]]
|[[Template:ToggleButton|ToggleButton]]
|Use with [[Template:ToggleSection|ToggleSection]] to make a toggle button separate from its target section(s).
|Use with [[Template:ToggleSection|ToggleSection]] to make a toggle button separate from its target section(s).
|<code><nowiki>{{ToggleButton}}</nowiki></code>
| <code><nowiki>{{ToggleButton}}</nowiki></code>
|}
|}


=== Navbox ===
===Navbox===
Tables with links for quick navigation.
Tables with links for quick navigation.
{| class="wikitable"
{| class="wikitable"
Line 307: Line 318:
|-
|-
|[[Template:NavBoxStats|NavBoxStats]]
|[[Template:NavBoxStats|NavBoxStats]]
|Navigation box for [[Stats|Stat]] pages.
|Navigation box for [[Stats|Stat]] pages.  
|<code><nowiki>{{NavBoxStats}}</nowiki></code>
| <code><nowiki>{{NavBoxStats}}</nowiki></code>
|-
|-
|[[Template:NavBoxModding|NavBoxModding]]
|[[Template:NavBoxModding|NavBoxModding]]
Line 315: Line 326:
|}
|}


=== Functions ===
===Functions===
Helper functions, used to get data with minimal template logic.
Helper functions, used to get data with minimal template logic.
{| class="wikitable"
{| class="wikitable"
!Template
!Template
!Description
!Description  
|-
|-
|[[Template:GetType|GetType]]
|[[Template:GetType|GetType]]
Line 331: Line 342:
|}
|}


=== Deprecated ===
===Deprecated===
Templates that have been replaced with new/renamed versions.
Templates that have been replaced with new/renamed versions.
{| class="wikitable"
{| class="wikitable"
Line 347: Line 358:
|[[Template:TableRowSet|TableRowSet]]
|[[Template:TableRowSet|TableRowSet]]
|[[Template:TableRowWeaponClass|TableRowWeaponClass]]
|[[Template:TableRowWeaponClass|TableRowWeaponClass]]
|-
| [[Template:Melee|Melee]]
| rowspan="2" |[[Template:Weapon|Weapon]]
| rowspan="2" |The Weapon template was expanded with options to show the melee/ranged text.
|-
|[[Template:Ranged|Ranged]]
|}
===DLC===
Templates related to the {{DLC Link|link=Abyssal Terrors DLC}}
{| class="wikitable"
!Template
!Description
|-
|[[Template:DLCLink|DLCLink]]
|Add a DLC badge after a link
|-
|[[Template:DLCBadge|DLCBadge]]
|Add a standalone DLC badge: {{DLCBadge}}
|-
|[[Template:GetDLCStatus|GetDLCStatus]]
|Check if an item/weapon is from the DLC
|-
|[[Template:DLCNotice|DLCNotice]]
|Notice saying that the current page is part of the {{DLCLink|Abyssal Terrors DLC}}
|}
===Notices===
Adds a notice, usually at the top of a page.
{| class="wikitable"
|Template
|Description
|-
|[[Template:DLCNotice|DLCNotice]]
|Says that the current page is part of the {{DLCLink|Abyssal Terrors DLC}}
|-
|[[Template:CommunityMainNotice|CommunityMainNotice]]
| Warns that content is provided by the community
|-
|[[Template:CommunityNotice|CommunityNotice]]
|Warns that the current page was written by a member of the community (eg. for a guide)
|}
|}


== Special ==
==Special==


Special wiki pages.
Special wiki pages.


* [[Special:SpecialPages]] - List of all special pages
*[[Special:SpecialPages]] - List of all special pages
* [[Special:BatchUpload]] Bulk image uploader
*[[Special:BatchUpload]] Bulk image uploader
* [[Special:UncategorizedTemplates]] - Shows all the custom templates on this wiki
*[[Special:UncategorizedTemplates]] - Shows all the custom templates on this wiki


== Admin ==
==Admin==


These are special admin pages, and aren't available for public editing.
These are special admin pages, and aren't available for public editing.


* [[MediaWiki:Common.css]] - Custom styles
*[[MediaWiki:Common.css]] - Custom styles
* [[MediaWiki:Common.js]] - Custom JavaScript
*[[MediaWiki:Common.js]] - Custom JavaScript

Latest revision as of 10:59, 6 November 2024

This page serves as a reminder/introduction for contributors, with sections listing general editing tips, plus a full list of every custom template.

General

Character Pages

If you're adding strategy information to a Character page, One Armed.png One Armed is a good point of reference. It has a table for synergies and makes liberal use of the MiniIconbox template. Another good character page to reference is Mage.png Mage, who has a section for their starting items, and Ranger.png Ranger, who has a Notes section for their starting weapons.

Mod Pages

If you want to show things like character and weapon stats, Mod:Extatonion and Mod:Isaac_Characters_Mod are excellent points of reference, as they make great use of the special templates available.

Uploads

You can upload many images at once with the Batch Uploader. View uploaded files via Special:ListFiles.

Templates

Quick reference list of useful templates. See also: Special:UncategorizedTemplates. For cleanup, see Special:UnusedTemplates.

Data

Contains all data of the specified type. Used by tables, infoboxes, Template:Iconbox, and more.

Template Description
Character_Data All data for Characters
Item_Data All data for Items
Weapon_Data All data for Weapons
Elite_Data All data for Elite Enemies
Boss_Data All data for Bosses
WeaponClass Contains and shows stats for every Weapon Class

To Do: Explain how to regenerate the corresponding page after adding the data

General

Frequently used miscellaneous templates.

Template Description Example Preview
Iconbox Shows items/weapons in a box, with lots of options. Widely used. {{Iconbox}}
MiniIconbox Mini version of Iconbox, meant for use within content. {{MiniIconbox|Acid}} Acid.png Acid
Color Colours text, eg. green. {{Color|red|-10%}} -10%
StatIcon Stat icons, eg. Damage.png (Damage) {{StatIcon|Max HP}} Max HP.png

Mods

Specifically made for mod pages, to showcase characters/items/weapons.

Template Description Preview
MiniModIconbox Mini icon box with a custom image and no link, intended for mod pages.
Version Wraps around the mod's game version. Shows green if the version is current, red if it's behind. 1.1.6.0 / 0.6.1.6
LinkButton A link styled to look like a button - for internal wiki links
ExternalLinkButton A link styled to look like a button - for external links

Mods - StatsCard

Template Description Preview
StatsCard Full item/weapon stats box, to showcase modded content. Matches the in-game design.
StatsCardWeapon Wrapper for StatsCard, with pre-filled weapon stats to save you some time.
StatsCardWeaponTabs Tabbed version of StatsCardWeapon, to show stats for every tier.
StatsCard_GridToggles Toggle buttons for filtering items. Use them to show/hide items with different stat tags.
StatsCard_WeaponToggles Toggle buttons to change all weapon tab tiers at once

Infobox

Adds a large section with lots of data. Shown on the right of the page. Some have helpers (see next section).

Template Description
Infobox_Character Infobox for a single Character. Has a helper, listed below
nfobox_Character_Helper Adds Template:Infobox_Character with pre-filled data, using the current page name.
Infobox_Item Infobox for a single Item
Infobox_Weapon Infobox for a single Weapon
Infobox_Elite Infobox for a single Elite Enemy
Infobox_Boss Infobox for a single boss

Text

Inserts pre-defined text that commonly appears on various page types.

Template Usage Page Type Description
Character {{Character}} Character Character page text. Intro for all characters
CharacterUnlockedBy {{CharacterUnlockedBy}} Character Character page text. Shows how to unlock the character
CharacterUnlocks {{CharacterUnlocks}} Character Character page text. Shows what item the character unlocks
Item {{Item}} Item Intro text
Unique {{Unique}} Item States that the item is unique
Weapon {{Weapon}} Weapon Intro text. Set the type with {{Weapon|type=melee}} or {{Weapon|type=ranged}}
WeaponPageClassText {{WeaponPageClassText}} Weapon Weapon class text
WeaponClassIntroText {{WeaponClassIntroText}} Weapon Class Intro for single weapon class page
ItemTagText {{ItemTagText|Exploration}} Many Full sentence stating the characters attributed to the specified item tag
DefaultModInstall {{DefaultModInstall}} Mod Mod install instructions link
ModDisclaimerText {{ModDisclaimerText}} Mod Mod disclaimer mentioning link safety

Text Lists

Lists data.

Template Description
WeaponClassWeapons Lists the Weapons that belong to a specific Weapon Class.
ItemTagCharacters Lists the Characters that belong to a specific Item Tag.

Tables

Makes it easier to add tables and rows for specific data sets. The page for Template:TableHeaders shows examples for every template.

Template Description
TableHeaders Table row headers for all rows listed below. The template's page has examples for all the templates below.
TableRowCharacter Lists Characters
TableRowItem Lists Items
TableRowWeapon Lists Weapons
TableRowWeaponClass Lists Weapon Classes

Tables - Generated

These tables are automatically generated, using Lua modules.

Template Description
GenerateCharacterStartingWeaponsTable Generates a character's starting weapons table. Uses this module. Pulls data from Character_Data.

Linked Icons

Add an pre-sized icon with a link to the specified item/weapon/character (eg. see Shop > Modifiers).

Most of these were widely used in common templates, prior to Iconbox being updated with options that made them redundant for such use, and MiniIconbox being created.

Template Example Preview Notes
CharacterIcon {{CharacterIcon|Well Rounded}} Well Rounded.png Well Rounded
ItemIcon {{ItemIcon|Acid}} Acid.png Acid
WeaponIcon {{WeaponIcon|Cacti Club}} Cacti Club.png Cacti Club
MiscIcon {{MiscIcon|Tree}} Tree.png Tree

Toggles

Can be used to show/hide sections by clicking a button.

Template Description Code
ToggleStart Starts a toggleable section. The template page has docs for all the other toggle templates. {{ToggleStart}}
ToggleEnd Ends a toggleable section. Required, otherwise the page will break! {{ToggleEnd}}
ToggleSection Lets you make multiple toggleable sections that open/collapse from a single button. {{ToggleSection}}
ToggleButton Use with ToggleSection to make a toggle button separate from its target section(s). {{ToggleButton}}

Navbox

Tables with links for quick navigation.

Template Description Code
NavBoxCharacters Navigation box for Character pages. {{NavBoxCharacters}}
NavBoxStats Navigation box for Stat pages. {{NavBoxStats}}
NavBoxModding Navigation box for Modding pages. {{NavBoxModding}}

Functions

Helper functions, used to get data with minimal template logic.

Template Description
GetType Gets the type for the provided thing (item, weapon, character)
GetRarity Gets the rarity for the provided item/weapon
GetVersion Gets the current game version. Used by Template:Version

Deprecated

Templates that have been replaced with new/renamed versions.

Deprecated Template New Template Reason
WeaponSet WeaponClass Renamed "weapon set" to "weapon class" after data mining showed "class" to be the official name
WeaponSetWeapons WeaponClassWeapons
TableRowSet TableRowWeaponClass
Melee Weapon The Weapon template was expanded with options to show the melee/ranged text.
Ranged

DLC

Templates related to the Abyssal Terrors DLC(DLC)

Template Description
DLCLink Add a DLC badge after a link
DLCBadge Add a standalone DLC badge: (DLC)
GetDLCStatus Check if an item/weapon is from the DLC
DLCNotice Notice saying that the current page is part of the Abyssal Terrors DLC(DLC)

Notices

Adds a notice, usually at the top of a page.

Template Description
DLCNotice Says that the current page is part of the Abyssal Terrors DLC(DLC)
CommunityMainNotice Warns that content is provided by the community
CommunityNotice Warns that the current page was written by a member of the community (eg. for a guide)

Special

Special wiki pages.

Admin

These are special admin pages, and aren't available for public editing.

Retrieved from "http://brotato.wiki.spellsandguns.com/index.php?title=Wiki_Editing&oldid=7449"