Module:Description: Difference between revisions

[unchecked revision]

[checked revision]

Latest revision as of 14:01, 27 February 2021

Documentation[edit source]

This module provides the back end functionality of the Template:Description. If the template is passed an item name, this module pulls the item's description from Module:ItemData.

Usage[edit source]

See Template:Description

local p = {}

local Utils = require('Module:Utils')

-- Main entry point for the Module
function p.main(frame)
    -- get args from the Template
    local args = Utils.normaliseArgs(frame)

    -- Check if an item is given, return its description from
    -- Module:ItemData if it item is specified
    if args.item then
        local itemData = mw.loadData( "Module:ItemData" )
        if itemData.items[args.item] == nil then
            return 'None'
        elseif itemData.items[args.item].description == '' then
            return 'None'
        else
            return itemData.items[args.item].description
        end
    -- Check if text was given, return the text if so
    elseif args.text then
        return args.text
    -- Error condition, item and text are not given
    else
        local errormsg = 'Improper usage. Please see [[Template:Description]] for help'
        return errormsg
    end
end

return p

@@ Line 1: / Line 1: @@
 local p = {}
--- Grabs args from the parent frame
+local Utils = require('Module:Utils')
--- Trims and parses the args into a table, then returns the table
-function norm()
-    local origArgs = mw.getCurrentFrame():getParent().args
-    local args = {}
-    for k, v in pairs( origArgs ) do
-        v = mw.text.trim( tostring( v ) )
-        if v ~= '' then
-            args[k] = v
-        end
-    end
-    return args
-end
 -- Main entry point for the Module
-function p.main()
+function p.main(frame)
      -- get args from the Template
-     local args = norm()
+     local args = Utils.normaliseArgs(frame)
      -- Check if an item is given, return its description from
      -- Module:ItemData if it item is specified
      if args.item then
-         local itemData = require( "Module:ItemData" )
+         local itemData = mw.loadData( "Module:ItemData" )
          if itemData.items[args.item] == nil then
              return 'None'