Module:File/data

From Undertale Yellow Wiki
Jump to navigation Jump to search

Additional data used in file descriptions.

Documentation

Package items

file_data.license (member; table)
Map of file license types to license text.
file_data.types (member; table)
Map of file types (used in type or file page title) to their names and categories.
file_data.authors (member; table)
Map of author names to their respective profile/article links. By default, the author of a file is "Undertale Yellow team", as specified in the default property.
file_data.numbering (member; table)
Map of number → position name. Used in numerical file descriptions, for example a mapping from File:Burgerpants face 5.png to "Burgerpants's fifth face."
file_data.typeorder (member; table)
Order of type deduction from filename. Screenshots go first because their names are usually the most complex and may include names of other types, which could confuse the file type deduction mechanism.


--- Additional data used in file descriptions.
--  @file               file_data
--  @alias              p

--- Map of file license types to license text.
--  @property           {table} file_data.license

--- Map of file types (used in <code>type</code> or file page title) to their
--  names and categories.
--  @property           {table} file_data.types

--- Map of author names to their respective profile/article links.
--  By default, the author of a file is "[[Undertale Yellow]] team", as
--  specified in the <code>default</code> property.
--  @property           {table} file_data.authors

--- Map of number &rarr; position name.
--  Used in numerical file descriptions, for example a mapping from
--  <code>File:Burgerpants face 5.png</code> to "Burgerpants's fifth face."
--  @property           {table} file_data.numbering

--- Order of type deduction from filename.
--  Screenshots go first because their names are usually the most complex and
--  may include names of other types, which could confuse the file type
--  deduction mechanism.
--  @property           {table} file_data.typeorder

--- Game's name.
--  Because the same base module is used on Deltarune Wiki, where the game's
--  name is "Deltarune."
--  @property           {string} file_data.game
local p = {
    license = {
        fairuse = 'is copyrighted. It will be used in a way that qualifies as [[wikipedia:Fair use|fair use]] under US copyright law',
        ccbysa  = 'is licensed under the [https://creativecommons.org/licenses/by-sa/3.0/ Creative Commons Attribution-Share Alike License]',
        pd      = 'is in the public domain',
        self    = 'was uploaded by the photographer or author',
        default = 'does not have information on its copyright status'
    },
    types = {
        artwork = {
            name     = 'Artwork',
            category = 'Artwork'
        },
        attack = {
            name     = 'Attack screenshot',
            category = 'Screenshots'
        },
        avatar = {
            name     = 'Avatar',
            category = 'Avatars'
        },
        background = {
        	name     = 'Background',
        	category = 'Wiki Backgrounds'
        },
        battle = {
            name     = 'Battle',
            category = 'Battle sprites'
        },
        face = {
            name     = 'Face',
            category = 'Face sprites'
        },
        item = {
            name     = 'Item',
            category = 'Item files'
        },
        location = {
            name     = 'Location',
            category = 'Location files'
        },
        map = {
            name     = 'Map',
            category = 'Maps'
        },
        misc = {
            name     = 'Miscellaneous',
            category = 'Miscellaneous files'
        },
        music = {
            name     = 'Music',
            category = 'Audio'
        },
        overworld = {
            name     = 'Overworld',
            category = 'Overworld sprites'
        },
        screenshot = {
            name     = 'Screenshot',
            category = 'Screenshots'
        },
        soundtrack = {
            name     = 'Soundtrack',
            category = 'Soundtrack files'
        }
    },
    authors = {
        ['default'] = '[[Team Undertale Yellow]]',
        ['AeroArtwork'] = '[[AeroArtwork]]',
        ['Figburn'] = '[[Figburn]]',
        ['Deadkat'] = '[[Deadkat]]',
        ['GlitchedPie'] = '[[GlitchedPie]]',
        ['NoteBlock'] = '[[NoteBlock]]',
        ['Nero'] = '[[Nero]]',
        ['TeleviQ'] = '[[TeleviQ]]',
        ['LitvacArt'] = '[[LitvacArt]]',
        ['Day'] = '[[Day]]',
        ['Deadkat'] = '[[Deadkat]]',
        ['MyNewSoundtrack'] = '[[MyNewSoundtrack]]',
        ['Ryla'] = '[[Ryla]]',
        ['Vegard Jensen'] = '[[Vegard Jensen]]',
        ['Gaziter'] = '[[Gaziter]]',
        ['Eli'] = '[[Eli]]',
        ['Noodle'] = '[[Noodle]]',
        ['Emmalume'] = '[[Emmalume]]',
        ['Barosaros'] = '[[Barosaros]]',
        ['MarshieMonarch'] = '[[MarshieMonarch]]',
        ['Toby Fox'] = '[[ut:Toby Fox|Toby Fox]]'
    },
    numbering = { -- For numerical autodescriptions. Expand if we get more.
        'first',
        'second',
        'third',
        'fourth',
        'fifth',
        'sixth',
        'seventh',
        'eighth',
        'ninth',
        'tenth'
    },
    typeorder = {
        -- Most important due to filename format
        'screenshot',
        -- Rest are sorted alphabetically
        'avatar',
        'artwork',
        'attack',
        'background',
        'battle',
        'face',
        'item',
        'location',
        'map',
        'misc',
        'music',
        'overworld',
        'soundtrack'
    },
    game = 'Undertale Yellow'
}

-- License aliases
p.license['fair use']         = p.license.fairuse
p.license['fair']             = p.license.fairuse
p.license['cc-by-sa']         = p.license.ccbysa
p.license['cc by sa']         = p.license.ccbysa
p.license['public domain']    = p.license.pd
p.license['own']              = p.license.self
-- Type aliases
p.types  ['concept']          = p.types.artwork
p.types  ['screen']           = p.types.screenshot
p.types  ['battle sprite']    = p.types.battle
p.types  ['overworld sprite'] = p.types.overworld
p.types  ['miscellaneous']    = p.types.misc
p.types  ['cover']            = p.types.soundtrack
p.types  ['cut']              = p.types.cutcontent
p.types  ['cut content']      = p.types.cutcontent
p.types  ['photo']            = p.types.photograph

return p