The codename system is a system used by the wiki that allows attributes to be assigned to releases and series. At its core this system documents the releases in the scope of the wiki, and acknowledges series that these releases fall into, however it also governs a number of further systems and presentational methods.
Contents
System[edit source]
The system is written in JavaScript and resides in the Common loaded to every page. It uses JavaScript classes and arrays to create two lists, rel
for releases (e.g. game, film), and ser
for series (e.g. compilations, sub-series).
Each release and series is referred to by what is known as a codename. This is a short code used to refer to and identify the release or series.
Uses[edit source]
Scope list[edit source]
The releases defined in the list are the same releases that fall into first-tier scope. The order they are added in are the order they appear in the list. An attribute also exists to define a parent release (e.g. the parent release of Final Fantasy X-2 is Final Fantasy X) or to make them an exception and remove them from the scope (e.g. Legacy Final Fantasy XIV).
Class colors[edit source]
Each release and series has its own set of colors that it uses to style presentation structures such as tables and infoboxes. Two classes exist for each, the a
and the b
classes, which correlate to headers and sub-headers.
The way these may be used differ depending on the circumstance. For example, navboxes and galleries have a class parameter that take the codename.
When writing tables, there are two ways these can be employed. The main method is to put the codename in the table's class
attribute. Then for every row or cell that needs to be the header or sub-header color, a
or b
is placed into that element's class
attribute.
The alternative method is to define one cell and row at a time, and place "[codename] a"
or "[codename] b"
(sans brackets; double quotes needed because of inner space) in the element's class
attribute. This is better used in circumstances where only one cell or row needs a class, such as in a table that covers multiple releases specifically.
a
and b
classes do not work on Microsoft Internet Explorer or Opera (Nintendo 3DS version at least), so in those browsers the colors fall back to the defaults.
Side icons[edit source]
The side icon system appears in articles and details what releases an article covers. These are represented by a colored crystal (relating to the release's header color) and a short text abbreviation identifying the release.
Side icons are added via the {{sideicon}}
template where its first and only parameter is the codename for the release being covered. Multiple can be used on a page if the article covers multiple releases. The side icon system also adds the releases to a JavaScript variable, wgReleasesCovered
.
[edit source]
Releases and series are entitled to navboxes, and the appearance of a navbox changes depending on this system. In addition to utilizing class colors, navboxes for releases and series (defined by the template name matching their codename) are enlarged and have their title written in the FFWiki font.
Background images can also be defined. These are small images that appear on the left side of the navbox.
Defining[edit source]
Name[edit source]
Each release and series is identified with a codename. The codename follows a number of rules. The codename cannot be used by another release or series. The codename can be no longer than eight characters. The codename can only contain alphanumeric characters (no dashes, no spaces, case sensitive, both lowercase and uppercase allowed). The codename cannot start with a number.
Initials are typically used. For titles in the main series "FF" is followed by the numeral. In spin-offs of the main series the "FF" is dropped but the subtitle is added to the end, e.g. "VIIAC". If the initialism is two letters long then an alternative is preferred (e.g. "BravelyD" over "BD"). Related releases should follow similar naming schemes.
Colors[edit source]
Class colors decide what colors are associated with a release or series. Class colors are defined in two parts, the background color and the text color. The background color is any hexadecimal color. The text color is either "black" or "white", and also defines whether to use light or dark link colors.
The colors are often derived from the release's logo. In cases where a similar logo is not found, then any colors distinctively from the release's cover art work as an alternative.
With series without logos, colors are often amalgamations from other titles in the series, or based off the color theme of the titular element (e.g. Chocobo Series with yellow and orange).
Side icon text[edit source]
The sideicon text can appear over one or two rows. If the icon is set to appear over two rows one line should be set to be small. The amount of space for text is limited, so usually contained in the text is an abbreviation of the title.
The syntax for sideicon text when inserting it is either "[line 1]
" or "[line 1]|[line 2]
". Adding "(small)
" to the front of a line will make that line's text smaller, though this cannot be done for both lines.
[edit source]
Navbox background images are navbox images that appear on the left. They are 170 pixels in width and 30 pixels high and are mostly transparent. The image needs its leftmost 50px left transparent to account for the {{tnav}}
.
The image should feature something representative of the feature, typically the logo. It should not contain any text. If the logo is not suitable then the cover art or something iconic from the feature will be a suitable replacement.
The image should not be cropped on its horizontal edges, but can on its vertical edges.
Documentation[edit source]
Scope list[edit source]
- Final Fantasy series
- Main series
- Final Fantasy II series
- Final Fantasy IV: The Complete Collection
- Final Fantasy V series
- Compilation of Final Fantasy VII
- Final Fantasy X series
- Ivalice series
- Final Fantasy XII series
- Vana'diel series
- Fabula Nova Crystallis
- Lightning Saga
- Final Fantasy XV Universe
- Final Fantasy Type-0 series
- Versus epic
- Final Fantasy Tactics Advance series
- Crystal Defenders series
- Final Fantasy Crystal Chronicles series
- SaGa series
- Dissidia Final Fantasy series
- Theatrhythm Final Fantasy series
- Final Fantasy Artniks series
- Chocobo series
- Chocobo's Dungeon series
- Final Fantasy Fables series
- Chocobo Collection
- Final Fantasy: Unlimited series
- Final Fantasy
- Final Fantasy II
- Final Fantasy III
- Final Fantasy IV
- Final Fantasy V
- Final Fantasy VI
- Final Fantasy VII
- Final Fantasy VII: Advent Children
- Before Crisis -Final Fantasy VII-
- Dirge of Cerberus -Final Fantasy VII-
- Dirge of Cerberus Lost Episode -Final Fantasy VII-
- Crisis Core -Final Fantasy VII-
- Last Order -Final Fantasy VII-
- Final Fantasy VII: On the Way to a Smile
- Final Fantasy VII The Kids Are Alright: A Turks Side Story
- Hoshi o Meguru Otome
- Final Fantasy VII: Snowboarding
- Final Fantasy VII G-Bike
- Final Fantasy VII Remake Kaiga no Naka no Chōsatai
- Final Fantasy VII Remake
- Final Fantasy VIII
- Final Fantasy IX
- Final Fantasy X
- Final Fantasy XI
- Final Fantasy XII
- Final Fantasy XIII
- Final Fantasy XIV
- Final Fantasy XV
- Final Fantasy XVI
- Final Fantasy Tactics
- Final Fantasy Tactics Advance
- Final Fantasy Tactics S
- Crystal Defenders
- Vagrant Story
- Final Fantasy Type-0
- Final Fantasy Crystal Chronicles
- Final Fantasy Mystic Quest
- Final Fantasy Adventure
- The Final Fantasy Legend
- Final Fantasy Legend II
- Final Fantasy Legend III
- Final Fantasy: The 4 Heroes of Light
- Final Fantasy Dimensions
- Final Fantasy Dimensions II
- Dissidia Final Fantasy
- Theatrhythm Final Fantasy
- Pictlogica Final Fantasy
- Final Fantasy Airborne Brigade
- Final Fantasy Artniks
- Final Fantasy All the Bravest
- Final Fantasy Record Keeper
- Final Fantasy Explorers
- Final Fantasy World Wide Words
- Final Fantasy Brave Exvius
- World of Final Fantasy
- Mobius Final Fantasy
- Chocobo Racing
- Chocobo no Fushigi na Dungeon
- Final Fantasy Fables: Chocobo Tales
- Chocobo Stallion
- Dice de Chocobo
- Chocobo Panic
- Final Fantasy: Unlimited
- Final Fantasy: The Spirits Within
- Final Fantasy Trading Card Game
- Final Fantasy Lost Stranger
Class codes[edit source]
Series | ||||||
---|---|---|---|---|---|---|
Codename | Header | Subheader | ||||
series | series a | series b | ||||
main | main a | main b | ||||
IIseries | IIseries a | IIseries b | ||||
IVCC | IVCC a | IVCC b | ||||
Vseries | Vseries a | Vseries b | ||||
compVII | compVII a | compVII b | ||||
Spira | Spira a | Spira b | ||||
Ival | Ival a | Ival b | ||||
XIIser | XIIser a | XIIser b | ||||
Vanadiel | Vanadiel a | Vanadiel b | ||||
FNC | FNC a | FNC b | ||||
LSaga | LSaga a | LSaga b | ||||
XVUniverse | XVUniverse a | XVUniverse b | ||||
T0series | T0series a | T0series b | ||||
Versus | Versus a | Versus b | ||||
TAseries | TAseries a | TAseries b | ||||
CDseries | CDseries a | CDseries b | ||||
CCseries | CCseries a | CCseries b | ||||
SaGa | SaGa a | SaGa b | ||||
DissiSer | DissiSer a | DissiSer b | ||||
TheatSer | TheatSer a | TheatSer b | ||||
ArtSer | ArtSer a | ArtSer b | ||||
Choco | Choco a | Choco b | ||||
CDungeon | CDungeon a | CDungeon b | ||||
Fables | Fables a | Fables b | ||||
CCollect | CCollect a | CCollect b | ||||
Unltd | Unltd a | Unltd b |
Releases | ||||||
---|---|---|---|---|---|---|
Codename | Header | Subheader | ||||
FFI | FFI a | FFI b | ||||
FFII | FFII a | FFII b | ||||
FFIIHnD | FFIIHnD a | FFIIHnD b | ||||
FFIII | FFIII a | FFIII b | ||||
FFIV | FFIV a | FFIV b | ||||
IVCCI | IVCCI a | IVCCI b | ||||
IVTAY | IVTAY a | IVTAY b | ||||
FFV | FFV a | FFV b | ||||
LotC | LotC a | LotC b | ||||
FFVI | FFVI a | FFVI b | ||||
FFVII | FFVII a | FFVII b | ||||
FFVIIR | FFVIIR a | FFVIIR b | ||||
VIIAC | VIIAC a | VIIAC b | ||||
VIIBC | VIIBC a | VIIBC b | ||||
VIIDoC | VIIDoC a | VIIDoC b | ||||
DoCLE | DoCLE a | DoCLE b | ||||
VIICC | VIICC a | VIICC b | ||||
VIILO | VIILO a | VIILO b | ||||
OtWtaS | OtWtaS a | OtWtaS b | ||||
VIILBT | VIILBT a | VIILBT b | ||||
HwMO | HwMO a | HwMO b | ||||
VIISB | VIISB a | VIISB b | ||||
VIIGB | VIIGB a | VIIGB b | ||||
VIIRKnNnC | VIIRKnNnC a | VIIRKnNnC b | ||||
FFVIII | FFVIII a | FFVIII b | ||||
FFIX | FFIX a | FFIX b | ||||
FFX | FFX a | FFX b | ||||
FFXEC | FFXEC a | FFXEC b | ||||
X2 | X2 a | X2 b | ||||
X2LM | X2LM a | X2LM b | ||||
X2p5 | X2p5 a | X2p5 b | ||||
FFXWill | FFXWill a | FFXWill b | ||||
FFXI | FFXI a | FFXI b | ||||
FFGrand | FFGrand a | FFGrand b | ||||
FFXII | FFXII a | FFXII b | ||||
XIIRW | XIIRW a | XIIRW b | ||||
D2H | D2H a | D2H b | ||||
FFXIII | FFXIII a | FFXIII b | ||||
XIII2 | XIII2 a | XIII2 b | ||||
LR | LR a | LR b | ||||
XIIIE0 | XIIIE0 a | XIIIE0 b | ||||
XIIIEi | XIIIEi a | XIIIEi b | ||||
XIII2FB | XIII2FB a | XIII2FB b | ||||
XIII2FA | XIII2FA a | XIII2FA b | ||||
XIIIRem | XIIIRem a | XIIIRem b | ||||
XIV1 | XIV1 a | XIV1 b | ||||
FFXIV | FFXIV a | FFXIV b | ||||
FFXV | FFXV a | FFXV b | ||||
XVKG | XVKG a | XVKG b | ||||
XVBH | XVBH a | XVBH b | ||||
JMV | JMV a | JMV b | ||||
KKWDD | KKWDD a | KKWDD b | ||||
FFXVI | FFXVI a | FFXVI b | ||||
FFT | FFT a | FFT b | ||||
FFTA | FFTA a | FFTA b | ||||
FFTA2 | FFTA2 a | FFTA2 b | ||||
FFTS | FFTS a | FFTS b | ||||
CrystD | CrystD a | CrystD b | ||||
CDVS | CDVS a | CDVS b | ||||
VagrS | VagrS a | VagrS b | ||||
Type0 | Type0 a | Type0 b | ||||
Agito | Agito a | Agito b | ||||
T0RotIB | T0RotIB a | T0RotIB b | ||||
FFCC | FFCC a | FFCC b | ||||
CCRoF | CCRoF a | CCRoF b | ||||
CCMLaaK | CCMLaaK a | CCMLaaK b | ||||
CCEoT | CCEoT a | CCEoT b | ||||
CCMLaaD | CCMLaaD a | CCMLaaD b | ||||
CCTCB | CCTCB a | CCTCB b | ||||
FFMQ | FFMQ a | FFMQ b | ||||
FFA | FFA a | FFA b | ||||
FFL | FFL a | FFL b | ||||
FFL2 | FFL2 a | FFL2 b | ||||
FFL3 | FFL3 a | FFL3 b | ||||
T4HoL | T4HoL a | T4HoL b | ||||
FFD | FFD a | FFD b | ||||
FFD2 | FFD2 a | FFD2 b | ||||
DFF2008 | DFF2008 a | DFF2008 b | ||||
D012 | D012 a | D012 b | ||||
DFFNT | DFFNT a | DFFNT b | ||||
DFFOO | DFFOO a | DFFOO b | ||||
TFF | TFF a | TFF b | ||||
TFFCC | TFFCC a | TFFCC b | ||||
TFFASC | TFFASC a | TFFASC b | ||||
PFF | PFF a | PFF b | ||||
FFAB | FFAB a | FFAB b | ||||
Artniks | Artniks a | Artniks b | ||||
ArtDive | ArtDive a | ArtDive b | ||||
FFATB | FFATB a | FFATB b | ||||
FFRK | FFRK a | FFRK b | ||||
FFE | FFE a | FFE b | ||||
FFWWW | FFWWW a | FFWWW b | ||||
FFBE | FFBE a | FFBE b | ||||
WotV | WotV a | WotV b | ||||
WoFF | WoFF a | WoFF b | ||||
Mobius | Mobius a | Mobius b | ||||
ChocoR | ChocoR a | ChocoR b | ||||
ChocoD | ChocoD a | ChocoD b | ||||
ChocoD2 | ChocoD2 a | ChocoD2 b | ||||
FablesCT | FablesCT a | FablesCT b | ||||
ChocoME | ChocoME a | ChocoME b | ||||
FablesCD | FablesCD a | FablesCD b | ||||
ChocoS | ChocoS a | ChocoS b | ||||
DdC | DdC a | DdC b | ||||
ChocoP | ChocoP a | ChocoP b | ||||
FFU | FFU a | FFU b | ||||
FFUA | FFUA a | FFUA b | ||||
FFUA2 | FFUA2 a | FFUA2 b | ||||
FFUwU | FFUwU a | FFUwU b | ||||
FFUonPC | FFUonPC a | FFUonPC b | ||||
TSW | TSW a | TSW b | ||||
FFTCG | FFTCG a | FFTCG b | ||||
FFLS | FFLS a | FFLS b |
Sideicons[edit source]
Template theme backgrounds[edit source]
Series | ||||||
---|---|---|---|---|---|---|
Codename | Header | |||||
series Final Fantasy series | ![]() | |||||
compVII Compilation of Final Fantasy VII | ![]() | |||||
Spira Final Fantasy X series | ![]() | |||||
Ival Ivalice series | ![]() | |||||
FNC Fabula Nova Crystallis | ![]() | |||||
LSaga Lightning Saga | ![]() | |||||
XVUniverse Final Fantasy XV Universe | ![]() | |||||
Choco Chocobo series | ![]() |
Customization[edit source]
Logged-in users can modify their personal CSS JS files to change codename displays for them.
With CSS, a user can modify the background color, text color, and navbox images of a series or release. These can be added to User:[username]/common.css.
To change the background color and text color of a series or release, the following can be added:
.[codename].a, .[codename] .a {
background-color: [background];
color: [text];
}
in which instances of "[codename]
" are replaced with the codename of the desired release or series, "[background]
" is replaced by the desired background color, and "[text]
" is replaced by the desired text color. The above code is for a
classes, but replacing the a
s with b
s would apply make the change apply to the b
class.
It is also possible to change the navbox image. To do this, the following can be added:
#[codename]-nav .va-navbox-maintitle {
background-image: url("[url]"), linear-gradient(to right, #FFFFFF 100px, rgba(255, 255, 255, 0) 300px);
}
in which "[codename]
" is replaced with the codename of the desired release or series, and "[url]
" is replaced with the URL of the desired replacement image.