Module:Featured

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

This documentation is transcluded from Module:Featured/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 4 — create_html L 50 — p.main

This template generates a Featured Article Widget from a page. It will be possible to fetch random pages in the future.

Creates a navigational box for links to other pages.

Template parameters
This template prefers block formatting of parameters.
Parameter		Description	Type	Status
title	`title`	Title of the page Example Dovedale Central	String	required
image	`image`	The file name of the image to display. The page's main image will take precedence. Example Fanory_Mill_Platform_View.jpg	String	optional
link	`link`	The page name that the button will redirect to. This is often the same as the page title Example Dovedale Central	String	required
text	`text`	The subheading text to display Example The main railway station in Dovedale	String	suggested
column	`column`	The column within the grid that the widget will be positioned in Example 2	Number	suggested
row	`row`	The row within the grid that the widget will be positioned in Example 3	Number	suggested

local getArgs  = require( 'Module:Arguments' ).getArgs
local p = {}

local function create_html(frame,page,column,row)
	local card = mw.html.create("div")
	card:addClass("home-card")
	card:addClass("home-card--button")
	card:addClass("home-card--col"..(tostring(column) or "2"))
	card:addClass("home-card--row"..(tostring(row) or "3"))
	card:css("view-transition-name","infobox-image")
	card:attr("id","home-featured")
	
	local bg = mw.html.create("div")
	bg:addClass("home-card__background")
	bg:wikitext("[[")
	if not page.image and page.title then
		bg:wikitext(frame:callParserFunction("#show","?Page Image#-") or "File:Placeholderv2.png") --Extension:PageImages and SESP not yet installed, preferably would use SS too
	elseif page.image then
		bg:wikitext("File:"..page.image)
	end
	bg:wikitext("|x200px|link=")
	bg:wikitext(page.title or page.link)
	bg:wikitext("]]")
	card:wikitext(tostring(bg))
	
	local fg = mw.html.create("div")
	fg:addClass("home-card__foreground")
	
	local badge = mw.html.create("div")
	badge:addClass("home-card__badge")
	badge:wikitext("Featured")
	fg:wikitext(tostring(badge))
	
	local header = mw.html.create("div")
	header:addClass("home-card__header")
	if not page.image then
		header:wikitext(frame:callParserFunction("BASEPAGENAME",page.title))
	else
		header:wikitext(page.title)
	end
	fg:wikitext(tostring(header))
	local label = mw.html.create("div")
	label:addClass("home-card__label")
	label:wikitext(page.text)
	fg:wikitext(tostring(label))
	card:wikitext(tostring(fg))
	return tostring(card)
end

function p.main(frame)
	local args = getArgs(frame)
	local page = {
		title=args.title,
		image=args.image or nil,
		link=args.link or "",
		text=args.text
	}
	return create_html(frame,page,args.column or args.column=="nil" and 2 or 2, args.row or args.column == "nil" and 3 or 3)
end
return p