Module:Coach

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

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

Example Implementation

{{Coach
|image=Steam Carriage.png
|seats=4
|spawn_points=[[Satus Services]]
|doors=N/A
|gangway_doors=No
|coupled_with=[[Steam Train]]
|status=removed
|status_description=Removed in [[Update Logs#Version 1|Update 1.0]].
}}

Documentation

Creates an infobox for a coach.

Template parameters

This template has custom formatting.

Parameter		Description	Type	Status
Seats	seats	Total number of seats on a coach. (en) Example 4	Number	optional
Doors	doors	Total number of doors on a coach or train, excluding gangway doors. (en) Example 2	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
Gangway Doors	gangway_doors	Whether a coach has gangway doors. (en) Suggested values Yes No Example Yes	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
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
Coupled With	coupled_with	The train types the coach is usually coupled with. (en) The value of this parameter should be one or more hyperlinks. If multiple are provided, separate them with commas. Example [[Steam Train]]	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 seats = args.seats
    local spawn = args.spawn_points
    local gangwayDoors = args.gangway_doors
    local doors = args.doors
    local coupledWith = args.coupled_with

	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 = 'Coach'
	} )
    local labels = {
        infobox:renderItem( {
            label = 'Seats',
            data = seats
        } ),
        infobox:renderItem( {
            label = 'Spawn Points',
            data = spawn
        } ),
        infobox:renderItem( {
            label = 'Doors',
            data = doors
        } ),
        infobox:renderItem( {
            label = 'Gangway Doors',
            data = gangwayDoors
        } ),
        infobox:renderItem( {
            label = 'Coupled With',
            data = coupledWith
        } ),
    }
    infobox:renderSection( {
        content = table.concat(labels),
        col = 2
    } )
    
	return infobox:renderInfobox(args)
end


return p