Module:Special/doc

--[[

Module:Special allows for the the presentation of SPECIAL statistics across various formats, without requiring the use of parser hooks to handle the data input.

statistics
Holds the name of each special statistic in plain text format.

links
Holds the pipe linked name of each statistic, shortening the name to two characters in length on an article.

value
value takes the first argument as the base values of the SPECIAL statistics and stores them in a table format with numbered keys.

modifer
modifer takes the second argument as the SPECIAL modifier and stares them in a tbale format with numbered keys.

title
title stores the third argument as a string to use as a title, the third argument is non-essential.

perk
perk is a counter variable, which servers two roles. Firstly it is used to retrive values from the tables as the key value for use in table construction and secondly as an incrimentor in loops.

results
results stores the output of the module to be embedded in the article.

thisPerk
Takes the current value of value[perk] and assigns the value or 0, dependant on if there is a value present.

p.string
p.string takes the template arguments and and returns them in a string format.

p.table
p.table takes the arguments and returns them in a table format.

p.test
p.test is a debug function, which shouldn't be used in articles.

]]--