Module:Station

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

This documentation is transcluded from Module:Station/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.

Module:Station requires Module:Arguments, Module:InfoboxNeue, and Module:Status.

Module:Station loads styles from Module:Station/styles.css.

Module:Station has a the Sandbox page Module:Station/Sandbox.

To Avoid disruption, any changes should be tested in the Sandbox. Changes can be added once fully tested.

Function list
L 8 — p.infobox

Information

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

This defines the Station Infobox used by pages.

Example Implementation

{{Station
|image=Abermoore Unfinished.png
|preceding=[[Dovedale East]]
|following=Terminus
|signal_box=[[Masonfield Signal Box]]
|abbreviation=FM
|number_of_platforms=5
|number_of_tracks=6
|dispatching=No
|status=in_operation
}}

Documentation

Creates an infobox for a station.

Template parameters

This template has custom formatting.

Parameter		Description	Type	Status
Preceding Station	preceding	The preceding station of a station. (en) The value of this parameter should be one or more hyperlinks. If multiple are provided, separate them with commas. Example [[Dovedale Central]]	Line	optional
Preceding Steam Station	preceding_steam	The preceding station for steam-only services of a station. This should not be used if the station accepts all services. (en) The value of this parameter should be one or more hyperlinks. If multiple are provided, separate them with commas. Example [[Dale Green]]	Line	optional
Signal Box	signal_box	The signal box(es) controlling a crossing, a station or a passing loop. (en) 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
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
Following Diesel Station	following_diesel	The following station for diesel-only services of a station. This should not be used if the station accepts both Electric and Diesel services. (en) The value of this parameter should be one or more hyperlinks. If multiple are provided, separate them with commas. Example [[Perthtyne]]	Line	optional
Dispatching	dispatching	Whether a station supports dispatching. (en) Example yes	Boolean	optional
Preceding Diesel Station	preceding_diesel	The preceding station for diesel-only services of a station. This should not be used if the station accepts both Electric and Diesel services. (en) The value of this parameter should be one or more hyperlinks. If multiple are provided, separate them with commas. Example [[Fanory Mill]]	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
Platforms	platforms	The number of platforms a station has. This does not include sidings. (en) Example 3	Number	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
Following Station	following	The following station of a station. (en) The value of this parameter should be one or more hyperlinks. If multiple are provided, separate them with commas. Example [[Gleethrop End]]	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
Following Steam Station	following_steam	The following station for steam-only services of a station. This should not be used if the station accepts all services. (en) The value of this parameter should be one or more hyperlinks. If multiple are provided, separate them with commas. Example [[Glassbury Junction]]	Line	optional

---

local getArgs  = require( 'Module:Arguments' ).getArgs
local infobox = require( 'Module:InfoboxNeue' ):new()

local getStatus = require("Module:Status").get

local p = {}

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

    --[[Deprecated arguments:
    image1: replaced with image (Does not support galleries)
    --]]

    --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

    --Services
    local preceding = args.preceding
    local following = args.following
    --Disel
    local dieselPreceding = args.preceding_diesel --optional
    local dieselFollowing = args.following_diesel --optional
    --Steam
    local steamPreceding = args.preceding_steam --optional
    local steamFollowing = args.following_steam --optional

    --Station Info
    local signalBox = args.signal_box
    local stationCode = args.abbreviation or args.station_code

    --Station Info (Other)
    local totalPlatforms = args.platforms or args.number_of_platforms
    local totalTracks = args.tracks or args.number_of_tracks
    local dispatch = args.dispatching


	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 = 'Station'
	} )
    if following or preceding then
        local stations = {
            infobox:renderItem( {
                label = 'Preceding Station',
                data = preceding
            } ),
            infobox:renderItem( {
                label = 'Following Station',
                data = following
            } ),
        }
        infobox:renderSection( {
            content = table.concat(stations),
            col = 2
        } )
    end

    if dieselFollowing or dieselPreceding then
        local dieselStations = {
            infobox:renderItem( {
                label = 'Preceding Station',
                data = dieselPreceding
            } ),
            infobox:renderItem( {
                label = 'Following Station',
                data = dieselFollowing
            } ),
        }
        infobox:renderSection( {
            title = "Diesel Services",
            content = table.concat(dieselStations),
            col = 2
        } )
    end

    if steamFollowing or steamPreceding then
        local steamStations = {
            infobox:renderItem( {
                label = 'Preceding Station',
                data = steamPreceding
            } ),
            infobox:renderItem( {
                label = 'Following Station',
                data = steamFollowing
            } ),
        }
        infobox:renderSection( {
            title = "Steam Services",
            content = table.concat(steamStations),
            col = 2
        } )
    end

	local stationInfo = { --two column section
		infobox:renderItem( {
			label = 'Signal Box',
			data = signalBox
		} ),
		infobox:renderItem( {
			label = 'Station Code',
			data = stationCode
		} ),
	}

    infobox:renderSection( {
		title = 'Station Information',
		content = table.concat(stationInfo),
		col = 2
	} )

    local stationInfoExtended = { --three column section
        infobox:renderItem( {
			label = 'Number of platforms',
			data = totalPlatforms
		} ),
        infobox:renderItem( {
			label = 'Number of tracks',
			data = totalTracks
		} ),
        infobox:renderItem( {
			label = 'Dispatching',
			data = dispatch
		} )
    }

    infobox:renderSection( {
		content = table.concat(stationInfoExtended),
		col = 3
	} )

	return infobox:renderInfobox(args)
end


return p