Module:Train

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

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

Information

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

This defines the Train Infobox used by pages.

Example Implementation

{{Train
| image=450 still shot.png|Exterior
|top_speed=125 mph
|powered_by=Electric
|spawn_points=[[Dovedale Central]]
|coaches=4
|doors=16
|date_added=1st October 2023
|operator=Dovedale West Railway
|status=in_service
|status_description=Since [[Update Logs#Version 1|Version 1]]
}}

Documentation

Creates an infobox for a train.

Template parameters
This template has custom formatting.
Parameter		Description	Type	Status
Acceleration	`acceleration`	The linear acceleration of a train. Please do not use the ''sup'' tags to superscript the 2 in the unit, instead paste the character ². (en) Example 9.81 m/s²	Line	optional
Powered By	`powered_by`	A train's power system. (en) Suggested values `Diesel` `Electric` `Steam` `Hybrid` Example Electric	Content	optional
Doors	`doors`	Total number of doors on a coach or train, excluding gangway doors. (en) Example 2	Number	optional
Operator	`operator`	The fictional operator which the train runs with. You should only use fictional names. If you are unsure the name does not conflict with trademarks, leave this blank. (en) Example Dovedale West Railway	Content	optional
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
Spawn Points	`spawn_points`	All the spawn points of a train or coach. (en) The value of this parameter should be one or more hyperlinks. If multiple are provided, separate them with commas. Example [[Dovedale Central]], [[Masonfield]]	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
Top Speed	`top_speed`	The top speed of a train. (en) Example 125 mph	Line	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
Coaches	`coaches`	The total number of coaches a train has. (en) Example 4	Number	optional

local getArgs  = require( 'Module:Arguments' ).getArgs
local infobox = require( 'Module:InfoboxNeue' ):new()
local getStatus = require("Module:Status").get
local SMWUtil = require("Module:SMWUtil")
local showProperty = SMWUtil.get
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

    -- Infomation
    local totalCoaches = args.coaches
    local totalDoors = args.doors
    local power = args.powered_by
    local spawn = args.spawn_points

    -- Statistics
    local topSpeed = args.top_speed
    local acceleration = args.acceleration

    --Other Info
    local status = args.status
    local statusDescription = args.status_description
    local operator = args.operator

    -- 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 ""),
            "Coaches=" .. (totalCoaches or ""),
            "Doors=" .. (totalDoors or ""),
            "Powered By=" .. (power or ""),
            "Spawn Points=" .. (spawn or ""),
            "Acceleration=" .. (acceleration or ""),
            "Top Speed=" .. (topSpeed or ""),
            "Operator=" .. (operator 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 = 'Train'
	} )

    
    -- display sps if sps provided as top speed
    local useLegacySpeedUnit = topSpeed:match("sps$") ~= nil

    local trainInfo = {
    	infobox:renderItem( {
            label = 'Power',
            data = power,
            row = true,
		    spacebetween = true
        } ),
        infobox:renderItem( {
            label = 'Top Speed',
            data = showProperty(frame, smwIdentifier, "Top Speed" .. (useLegacySpeedUnit and " # sps" or "")),
            row = true,
		    spacebetween = true
        } ),
        infobox:renderItem( {
            label = 'Acceleration',
            data = showProperty(frame, smwIdentifier, "Acceleration"),
            row = true,
		    spacebetween = true
        } ),
        infobox:renderItem( {
            label = 'Number of Coaches',
            data = totalCoaches,
            row = true,
		    spacebetween = true
        } ),
        infobox:renderItem( {
            label = 'Number of Doors',
            data = totalDoors,
            row = true,
		    spacebetween = true
        } ),
        infobox:renderItem( {
            label = 'Spawn Points',
            data = spawn,
            row = true,
		    spacebetween = true
        } ),
    }
    infobox:renderSection( {
        title="Statistics",
        content = table.concat(trainInfo),
    } )
    local trainInfoExtended = {
        infobox:renderItem( {
            label = 'Operator',
            data = operator,
        } ),
    }
    infobox:renderSection( {
        title = "Other Information",
        content = table.concat(trainInfoExtended),
        col = 2
    } )
    
	return infobox:renderInfobox(args)
end


return p