Module:Crossing

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

This documentation is transcluded from Module:Crossing/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 Crossing Infobox used by pages.

Example Implementation

{{Crossing
|image=
Day=Satus Level Crossing.png;
Night=Satus Level Crossing Night.png
|signal_box=[[Satus Signal Box]]
|tracks=2
|road_lanes=1
|gate_operation=Manual
|crossing_type=Manually controlled barrier
|abbreviation=SC
|closest_station=[[Satus Services]]
|xp=1250 XP
}}

Documentation

Creates an infobox for a crossing.

Template parameters
This template has custom formatting.
Parameter		Description	Type	Status
Gate Operation	`gate_operation`	The way a crossing is operated. (en) Suggested values `Manual` `Wheel` `Semi-Automatic` `Automatic` Example Manual	Content	optional
Road Lanes	`road_lanes`	The amount of road lanes of a crossing. (en) Example 2	Number	optional
Crossing Type	`crossing_type`	The type of a crossing. (en) Suggested values `Manually controlled gate` `Manually controlled barrier` `Manually controlled barrier - remote` `Manually controlled barrier - CCTV` `Manually controlled barrier - CCTV (on call)` `Manually controlled barrier - obstacle detector` `Automatic half barrier` `Automatic open crossing locally monitored` `Automatic open crossing locally monitored + barrier` `Automatic barrier crossing locally monitored` `Automatic full barrier crossing locally monitored` `User worked crossing` `Trainman operated crossing` `Open crossing` `Barrow crossing` Example Automatic half barrier	Content	optional
Signal Box	`signal_box`	The signal box(es) controlling a crossing, a station or a passing loop. (en) 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. The value of this parameter should be one or more hyperlinks. If multiple are provided, separate them with commas. Example [[Satus Signal Box]]	Line	optional
Abbreviation	`abbreviation`	The abbreviation of the name of the article's subject. It should be made of 2-3 letters. (en) Example SLS	Content	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
XP	`xp`	The XP required to control a box or a crossing. Note: The value should be separated from the unit by a space character. (en) 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. Example 1500 XP	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
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
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
Tracks	`tracks`	The amount of tracks of a passing loop, a crossing or a station. For station, this includes sidings. (en) Example 1	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 askForPages = SMWUtil.askForPages

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 signalBox = args.signal_box
    local tracks = args.tracks
    local roadLanes = args.road_lanes
    local gateOperation = args.gate_operation
    local crossingType = args.crossing_type
    local crossingCode = args.abbreviation
    local closestStation = args.closest_station
    local xp = args.xp

    local smwIdentifier = frame:preprocess("{{FULLPAGENAME}}")
    local xpRequirement = ""
    if xp then
        xpRequirement = showProperty(frame, smwIdentifier, "XP")
    else
        xpRequirement = showProperty(frame, smwIdentifier, "Signal Box.XP")
    end
    
    if not signalBox then
    	signalBox = askForPages(
    		frame,
    		"[[Category:Signal Boxes]] [[Crossings Controlled::"
    		.. smwIdentifier .. "]] <q>[[Concept:InGame]] OR [[Status::" .. status .. "]]</q>"
    		)
	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 = 'Crossing'
	} )
    local labels = {
        infobox:renderItem( {
            label = 'Signal Box',
            data = signalBox
        } ),
        infobox:renderItem( {
            label = 'Tracks',
            data = tracks
        } ),
        infobox:renderItem( {
            label = 'Road Lanes',
            data = roadLanes
        } ),
        infobox:renderItem( {
            label = 'Gate Operation',
            data = gateOperation
        } ),
        infobox:renderItem( {
            label = 'Type',
            data = crossingType
        } ),
        infobox:renderItem( {
            label = 'Crossing Code',
            data = crossingCode
        } ),
        infobox:renderItem( {
            label = 'Closest Station',
            data = closestStation
        } ),
        infobox:renderItem( {
            label = 'XP Requirement',
            data = xpRequirement
        } ),
    }
    infobox:renderSection( {
        content = table.concat(labels),
        col = 2
    } )
    
	return infobox:renderInfobox(args)
end


return p