Module:Place

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

This documentation is transcluded from Module:Place/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 9 — p.infobox

Information

This uses the InfoboxNeue module. for more information, visit Star Citizen.

This defines the Place Infobox used by pages.

Example Implementation

{{Place
|image=Dam-box-day.png
|usage=To control the dam. 
|closest_station=[[Pallion Harbour]]
|title=Control Box
|status=in_operation
|status_description=Since [[Update Logs#Version 1|Version 1]]
}}

Documentation

Creates an infobox for a place or a landmark.

Template parameters
This template has custom formatting.
Parameter		Description	Type	Status
Use Subobject	`use_subobject`	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!	Boolean	optional
Image	`image`	The thumbnail or gallery of the article. To just set the thumbnail, set the value to the name of the image (with its extension). To create a gallery, use the following format: ''Title1=Image1.png;Title2=Image2.jpg''. The file prefixes are optional for both formats. (en) Example Exterior=Placeholder.png;Interior=Placeholder.png	Content	required
Title	`title`	The title of the article's subject. The page name is the default value. For SMW subobjects, setting the title is important for the correct name to be displayed in queries. (en) Example Dovedale Central	Content	optional
Status Description	`status_description`	Information about the status. Example: The version in which the feature was added into or removed from the game. (en) Example Since [[Update Logs#Version 1\|Version 1]]	Content	optional
Detailed Usage	`detailed_usage`	The full description on a landmark's usage. If this is not set, then the value of Property:Usage will be used instead. (en) Example This was designed for trainings, it was opened and used for trainings for a short while. It houses two training rooms, a staff room and two locomotives, as well as training equipment. Currently, regular trainings are not held here, but people are free to explore this area.	Content	optional
Usage	`usage`	A short description on a landmark's usage. (en) Example To control the water flow.	Content	optional
Closest Station	`closest_station`	The closest station to the article's subject. (en) The value of this parameter should be one or more hyperlinks. If multiple are provided, separate them with commas. Example [[Satus Services]]	Line	optional
Status	`status`	The current status of the article's subject. (en) Suggested values `removed` `unknown` `in_development` `under_testing` `not_in_service` `out_of_service` `steam_only` `diesel_only` `available` `in_operation` `in_service` `public` `admin_only` `closed` `in_use` Example in_operation	Content	required

local getArgs  = require( 'Module:Arguments' ).getArgs
local infobox = require( 'Module:InfoboxNeue' ):new()
local getStatus = require("Module:Status").get
local SMWUtil = require("Module:SMWUtil")
local createSubobject = SMWUtil.createSubobject

local p = {}

function p.infobox(frame)
    local args = getArgs(frame)

    --Main arguments
    local imgPath = args.image
    local title = args.title or mw.title.getCurrentTitle().text
    local captionTitle = args.caption_title
    local caption = args.caption
    local status = args.status
    local statusDescription = args.status_description

    local usage = args.usage
    local detailed_usage = args.detailed_usage
    local closestStation = args.closest_station
    
    -- meta properties
    local use_subobject = args.use_subobject
    local smwIdentifier = frame:preprocess("{{FULLPAGENAME}}")

    if use_subobject == "true" then
        smwIdentifier = smwIdentifier .. "#" .. title
        createSubobject(frame, title, {
        	"Title=" .. (title or ""),
            "Image=" .. (imgPath or ""),
            "Usage=" .. (usage or ""),
            "Detailed Usage=" .. (detailed_usage or usage or ""),
            "Closest Station=" .. (closestStation or ""),
            "Status=" .. (status or ""),
            "Status Description=" .. (statusDescription or "")
        })
    end

	infobox:renderImageOrGallery(imgPath)

    if status then
        local text, class = getStatus(status)
        infobox:renderIndicator( {
            data = text,
            desc = statusDescription,
            class = class
        } )
    else
    	-- render the caption indicator only if there was no status provided
    	infobox:renderIndicator( {
        	data = captionTitle,
        	desc = caption,
    	} )
	end

	infobox:renderHeader( {
		title = title,
		subtitle = 'Landmark'
	} )

    local usageStr = ""
    if usage and detailed_usage then
        usageStr = string.format("<span class=\"smw-highlighter smwttinline\" data-state=\"inline\">%s<span class=\"smwttcontent\">%s</span></span>", usage, detailed_usage)
    elseif usage then
        usageStr = usage
    elseif detailed_usage then
        usageStr = detailed_usage
    end

    local labels = {
        infobox:renderItem( {
            label = 'Usage',
            data = usageStr
        } ),
        infobox:renderItem( {
            label = 'Closest Station',
            data = closestStation
        } ),
    }
    infobox:renderSection( {
        content = table.concat(labels),
        col = 2
    } )
    
	return infobox:renderInfobox(args)
end


return p