Module Layout

This is an organized representation of most of the modules used in this Wikia. Note that these should ideally all be automatically categorized in Category:Lua modules.

Layout

The "Data" column states if the module just stores data or actually does processing. Data modules do not need unit tests. Automatically updated data modules are handled by the Python scripts that read the master data and update the Wikia.

All Modules

Module	Data	For	Templates	Purpose
Ability	X	Abil	NewAbilityText CharacterStatAbilities	Parse and show bundled abilities from the master data.
Ability/Data	X	Abil		Stores info needed to classify and decrypt abilities.
Ability/Introspect	X	Abil	Ability Introspection	Shows all broken abilities so editors can interpret them.
AlternateForms	X	Char	AltForms	Makes the "alternate forms" section in CST.
Artists/Data	Manual	Char		Relates JP knight names to their artist names.
Artists	X	Char		Gets the artist for a knight in the CST.
BundledAbilityList	Auto	Abil		Relates bundled ability ids to their master data.
Categories	Manual	Code		Stores all categories used in scripts.
Character	X	Char		Handles everything related to parsing knights from the master data.
CharacterNames	Manual	Char		Relates JP knight names to all their other names.
CharacterStat	X	CST	CharacterStat CharacterStatStats	Shows individual character page info. Ex: Kayana.
CST/Extras	X	CST		Shows the "extra info" section in the CST.
CST/Portrait	X	CST		Shows the character's full picture in the CST.
CST/Skills	X	CST		Shows the skill section in the CST.
CST/Stats/Templates	Manual	CST		Rendering data for CST/Stats.
CST/Stats	X	CST	CharacterStatStats *	Shows the stats section in the CST.
CST	X	CST		Shows the topmost section on character cards.
CImage	X	Char	CImage	Shows character images.
DispAbilList	X	Abil	DisplayAbilityList	Shows all abilities.
DispCharList	X	Char	CharList	Shows multiple characters in various ways.
Dungeon	X	Stg		Shows one or more subjugation stages. Ex: Ev101.
Equipment/Data	Auto	Eq		Stores equipment data from the master data.
Equipment/Names	Semi	Eq		Relates JP equipment names to EN names.
Equipment	X	Eq	DisplayEquipTable	Shows the equipment section in the CST.
Event/Data/001-050	Manual	Evt		Stores data from events one to 50.
Event/Data/051-100	Manual	Evt		Stores data from events 51 to 100.
Event/Data/101-150	Manual	Evt		Stores data from events 101 to 150.
Event/Data/151-200	Manual	Evt		Stores data from events 151 to 200.
Event/Data/201-250	Manual	Evt		Stores data from events 201 to 250.
Event/Data/251-300	Manual	Evt		Stores data from events 251 to 300.
Event/Data	Manual	Evt		Defines constants for the sub-modules.
Event/Templates	Manual	Evt		Stores stuff used for rendering info in event pages.
Event	X	Evt	CurrentEvent (unused?) EventList ThinBanner	Does pretty much everything related to events.
EventDefaults	X	Evt		Applies defaults to event stages. This lets the event data sub-modules be much shorter.
EventPage	X	Evt	EventParagraphOpener EventCurrencyUsage GetGuestParty EventEquips	Displays parts of individual event pages.
EventPanelMissions	X	Evt	EventPanelMissions	Shows the panel missions section in event pages.
EventPicker	X	Evt		Helps other modules choose the correct event data sub-module when loading an event.
EventQuests	X	Evt	EventQuests	Shows the quests section in event pages.
EventShop/Table	Manual	Ware		Defines how EventShop outputs.
EventShop	X	Ware	ShowWares	Shows various parts of the Wares page.
FlowerFamily	X	CST	FlowerFamilyTest	Translates the flower family from the master data. Used in the CST.
FlowerFamily/List	Manual	CST		Stores all flower family data.
FlowerFamily/Translation	Manual	CST		Relates JP flower family names to EN names.
FlowerMemories	X	FM	FlowerMemoryStat	Shows individual flower memory page info. Ex: FM 1000000.
FlowerMemories/AbilityData	Auto	FM		Stores all flower memory ability data.
FlowerMemories/Artists	Manual	FM		Relates flower memory ID to their artists.
FlowerMemories/Data	Auto	FM		Stores all flower memory data.
FlowerMemories/Names	Manual	FM		Relates JP flower memory names to English names.
KnightIdAndName/Data	Auto	Char		Relates character IDs and names for (reverse) lookups.
KnightQuotes	X	Char	Knightquote	Shows the quotes section in character pages.
ListCharacters	X	Char	ListCharacters	Shows character lists based on filter parameters. Uses WaifuList.
MasterCharacterData	Auto	Char		Relates knight ids to their master data info.
MiscData	Manual	Code		Stores misc data. Unused?
Names/Data	Manual	Code		Relates JP item names to EN names. Also gives them EN abbreviations. Not used yet.
OtherCharactersList	Manual	Char		States which knights are unusual to obtain. Used in character list generators.
OtherStages/Data	Manual	Stg		Stores stage data for non-events.
Romanize	X	Char		Converts JP text to EN. Used for knight names in the CST.
ScribuntoTest	X	Code	ScribuntoTest	Provides the unit testing framework.
ShowCharListBasic	X	Char	CharList	Shows the old version of the character list.
ShowEventStages	X	Stg	ShowEventStages	Shows all stages for some event.
ShowFMList	X	FM	Template:ShowFMList	Shows multiple FMs as icons.
Skill	X	Skill	SkillDescription	Parses and shows knight skills.
SkillList	Auto	Skill		Stores skill info from the master data.
Skin/Data	Auto	Char		Stores skin info from the master data.
StageTable	X	Stg		Shows a subjugation stage.
StyleClass/Data	Manual	Code		Stores info used to expand abbreviated knight/skill/ability data passed to the javascript grapher.
UnitTest	X	Code	UnitTest	Runs various tests.
Utils	X	Code		Defines useful methods shared among all modules.
WaifuList	X	Char	WaifuList	Shows a list of knights. Parameters control the output.
Wares/Data	Manual	Ware		Stores info to be rendered by Wares.
Wares	X	Ware	GetWaresDate GetWaresTab	Shows various parts of the Wares page.

* To be deprecated.

Old Table

This is the old table used for showing the modules in this Wikia. It is no longer updated and will be deleted eventually.

Stages

Stages and dungeons have a complex relationship with the whole Wikia. This tree illustrates how they interact. Note that a dungeon is a collection of stages.

Disclaimer: I'm writing this now so I have a clear plan of the future layout. Some things may not be interacting in exactly this fashion yet.

• Module:EventPicker can return one event entry out of any of the following.
  • Module:Event/Data/001-050 is independent.
  • Module:Event/Data/051-100 is independent.
  • Module:Event/Data/101-150 is independent.
• Module:Dungeon fetches dungeon info from events and non-events.
  • Module:EventPicker used to load one event out of the all the event data modules.
  • Module:OtherStages/Data used if an "other" stage is being displayed.
  • Module:EventDefaults applies default values to event stages.
• Module:StageTable outputs one stage's data for Wikia.
  • Module:Dungeon used to fetch a stage's data.
• Module:EventDefaults applies default values to event stages. Should be independent.
• Module:Event/Data ???
• Module:Event does way too much stuff.
  • Module:WaifuList used for showing guest parties associated with individual events.
• Module:EventQuests shows daily quest info.

Testing

To try and not let issues appear to users, any edits to a module/template can be copied into Module:Sandbox, Template:Sandbox, or any similarly named thing.

Unit tests are done in hopes of maintaining the code. ScribuntoTest was imported into this Wikia for that purpose. So far, these unit test modules exists.

Unit Tester	Output
Module:Event/Data/testcases	Module_talk:Event/Data
Module:ShowCharListBasic/testcases	Module_talk:ShowCharListBasic
Module:StageTable/testcases	Module_talk:StageTable
Module:WaifuList/testcases	Module_talk:WaifuList

Errors

In the same way the above table exists to help editors code in Scribunto, we also have a standard of adding Category:Errors to any pages producing wrong input. People can watch this page for issues. It is intended to show bugs made by editors.

Also, Category:Pages_with_script_errors is automatically generated by the Wikia for us. It shows pages where Lua modules have crashed. These are bugs made by the programmers.

Check Category:ScribuntoUnit failed tests for any failing tests.

Replacements

This is the list of things that are going to replace other things. Ideally, this table will be empty and this section will be removed entirely.

Replacements

Old	New
Template:Eventshop	Template:ShowWares
Template:StageData	Template:ShowEventStages
Template:ShowEventStage	Template:ShowEventStages
Template:ShowEventStages1to8	Template:ShowEventStages