Module:PassingLoop

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

This documentation is transcluded from Module:PassingLoop/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:PassingLoop requires Module:Arguments, Module:InfoboxNeue, and Module:Status.

Function list
L 7 — p.infobox

Information

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

This defines the Passing Loop Infobox used by pages.

Example Implementation

{{Passing_Loop
|image=
Day view=A view of benyhone loop and signalbox from the direction of FM.png;
Overpass=Benyhone overpass.png
|tracks=2
|location=Between [[Fanory Mill]] and [[Llanfairpwllgwyngyllgogerychwyrndrobwllllantysiliogogogoch|Llanfairpwll]], next to [[Benyhone Loop Signal Box]]
|signal_box=[[Benyhone Loop Signal Box]]
|catch_points=At both ends
|status=in_operation
|status_description=Since [[Update Logs#Version_1.1.0|Version 1.1]]
}}

Documentation

Creates an infobox for a passing loop.

Template parameters

This template has custom formatting.

Parameter		Description	Type	Status
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
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
Catch Points	catch_points	Describes whether and where a passing loop has catch points. (en) Example At both ends	Content	optional
Location	location	The relative location of the article's subject. (en) Example Between Dovedale East and Dovedale Central	Content	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
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

---

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)

    --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 location = args.location
    local signalBox = args.signal_box
    local tracks = args.tracks
    local catchPoints = args.catch_points

	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 = 'Passing Loop'
	} )
    local labels = {
        infobox:renderItem( {
            label = 'Location',
            data = location
        } ),
        infobox:renderItem( {
            label = 'Signal Box',
            data = signalBox
        } ),
        infobox:renderItem( {
            label = 'Tracks',
            data = tracks
        } ),
        infobox:renderItem( {
            label = 'Catch Points',
            data = catchPoints
        } ),
    }
    infobox:renderSection( {
        content = table.concat(labels),
        col = 2
    } )
    
	return infobox:renderInfobox(args)
end


return p