Flower Knight Girl Wikia
Register
Advertisement
Flower Knight Girl Wikia

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

Modules
Purpose Module Template (Wrapper) Data Sources
All character data
Individual character pages
Skill translations Skill SkillDescription SkillList
Ability translations
Plant family translations
Event pages
GetGuestParty WaifuList
Event quests EventQuests EventQuests EventPicker
Stage data
Wares display
Equipment display & associations Equipment DisplayEquipTable
Artists Artists Artists/Data
Categories Categories
Translation Romanize Names/Data
Quotes KnightQuotes Knightquote
Character Lists
Stability / Testing UnitTest UnitTest (Ideally all modules)
AbilityUnitTest Ability
ScribuntoTest ScribuntoTest
ScribuntoUnit
Editing Utils
Other MiscData

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.

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
Advertisement