Module:TemplateDataGenerator

Module documentation[view][edit][history][purge]

This documentation is transcluded from Module:TemplateDataGenerator/doc. Changes can be proposed in the talk page.

This module is unused.

This module is neither invoked by a template nor required/loaded by another module. If this is in error, make sure to add {{Documentation}}/{{No documentation}} to the calling template's or parent's module documentation.

Function list
L 21 — p.convertSMWType L 29 — p.generateTemplateData

This template automatically generates template data for a given list of semantic properties. Visit this link for more information on TemplateData.

Example usage

{{TemplateDataGenerator
|description=Creates an infobox for a coach.
|Image
|Title
|Seats
|Doors
|Spawn Points
|Coupled With
|Status
|Status Description
}}

Automatically creates template data for a given list of semantic properties.

Template parameters[Edit template data]
This template has custom formatting.
Parameter		Description	Type	Status
Description	`description`	A short text that describes the template.	String	suggested
Format	`format`	The format that should be used for the template. Suggested values `\n{{_\n\|_=_\n}}\n`	Line	optional
Supports Subobjects	`supports_subobjects`	Whether the template supports the "use_subobject" parameter to define all properties as a subobject.	Boolean	optional

local getArgs  = require( 'Module:Arguments' ).getArgs
local SMWUtil = require("Module:SMWUtil")
local showProperty = SMWUtil.get

local p = {}

-- All types that have a direct equivalent in TemplateData are listed here.
-- Other types will be converted to "unknown" by default.
local convertedTypes = {
    ["Boolean"] = "boolean",
    ["Number"] = "number",
    ["Page"] = "line", -- using line instead of wiki-page-name to support hyperlinks and multiple pages
    ["Text"] = "content",
    ["URL"] = "url",
    ["Date"] = "date",
    ["Quantity"] = "line"
}

--- Converts the name of an SMW type to the corresponding type key for the TemplateData extension
---@param smwType string the name of the SMW type that should be converted
function p.convertSMWType(smwType)
    return convertedTypes[smwType]
end

--- Creates template data for a list of SMW properties.
--- The property names are specified via anonymous parameters.
--- The description can be set via the 'description' parameter.
--- If a provided parameter name starts with "-", it is marked as SMW based and a notice is added to the description.
function p.generateTemplateData(frame)
    local args = getArgs(frame)
    local description = args.description
    local format = args.format or "\n{{_\n|_=_\n}}\n"
    local supportsSubobjects = args.supports_subobjects

    local data = {}
    data["description"] = description
    data["format"] = format

    local params = {}
    local i = 1
    while args[i] do
        local propertyName = args[i]
        local smwBased = false
        if string.sub(propertyName, 1, 1) == "-" then
            smwBased = true
            propertyName = string.sub(propertyName, 2)
        end

        local fullPropertyName = "Property:" .. propertyName
        local paramName = showProperty(frame, fullPropertyName, "Parameter Name")

        if paramName ~= nil and mw.text.trim(paramName) ~= "" then
            local paramData = {}

            paramData["label"] = propertyName
            local smwType = showProperty(frame, fullPropertyName, "Has type", {"link=none"})
            paramData["type"] = p.convertSMWType(smwType)
            local paramDescription = showProperty(frame, fullPropertyName, "Property description")
            if smwBased then
                paramDescription = paramDescription .. " Note: This parameter is automatically retrieved from the data of other pages by default. You should only set this parameter to overwrite this value or if no value was set automatically."
            end
            if smwType == "Page" then
                paramDescription = paramDescription .. " The value of this parameter should be one or more hyperlinks. If multiple are provided, separate them with commas."
            end
            paramData["description"] = paramDescription
            paramData["required"] = showProperty(frame, fullPropertyName, "Parameter Required") == "true"
            paramData["example"] = showProperty(frame, fullPropertyName, "Example Value")
            local allowedValues = showProperty(frame, fullPropertyName, "Allows value")

            if allowedValues and mw.text.trim(allowedValues) ~= "" then
                paramData["suggestedvalues"] = mw.text.split(allowedValues, ",")
            end

            params[paramName] = paramData
        end
        
        i = i + 1
    end

    if supportsSubobjects == "true" then
        params["use_subobject"] = {
            label = "Use Subobject",
            type = "boolean",
            description = "Whether to use a subobject to define semantic properties for the infobox. Only set this to true if there are multiple infoboxes or a tabber with multiple articles on the page!"
        }
    end

    data["params"] = params

    return frame:extensionTag("templatedata", mw.text.jsonEncode(data))
end

return p