Module:InfoboxNeue/doc: Difference between revisions

Revision as of 23:23, 19 June 2023

This is a documentation subpage for Module:InfoboxNeue.

It contains usage information, categories, and other content that is not part of the original module 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 23 — translate L 39 — restoreUnderscore L 45 — formatNumber L 67 — methodtable.tableToCommaList L 80 — methodtable.formatRange L 108 — methodtable.addUnitIfExists L 121 — methodtable.renderMessage L 142 — methodtable.renderImage L 175 — methodtable.renderIndicator L 207 — methodtable.renderHeader L 255 — methodtable.renderSection L 304 — methodtable.renderLinkButton L 341 — methodtable.renderFooter L 348 — isNonEmpty L 405 — methodtable.renderFooterButton L 420 — methodtable.renderItem L 469 — methodtable.renderInfobox L 479 — renderSnippet L 516 — methodtable.showDescIfDiff L 526 — InfoboxNeue.showDescIfDiff L 535 — InfoboxNeue.new L 566 — InfoboxNeue.fromArgs

This module is used by Lua modules to build infobox.

Components

Image

infobox:renderImage( 'Pico at New Babbage 1 1.jpg' )

Indicator

Parameter	Description	Type	Status
`data`	Data of the indicator	string	required
`desc`	Description of the indicator	string	optional
`class`	HTML classes to be added to the indicator	string	optional

infobox:renderIndicator( {
	data = 'Indicator',
	desc = 'Indicator message',
} )

Header

Parameter	Description	Type	Status
`title`	Title of the infobox	string	required
`subtitle`	Subtitle of the infobox	string	optional

infobox:renderHeader( {
	title = 'Title',
	subtitle = 'Subtitle'
} )

Message

This is a shortcut way to create a message wrapped in a section.

Parameter	Description	Type	Status
`title`	Title of the message	string	required
`desc`	Description of the message	string	optional

infobox:renderMessage( {
	title = 'Message title',
	desc = 'Message description'
} )

Item

Parameter	Description	Type	Status
`data`	Data of the item	string	required
`label`	Label of the item	string	optional
`desc`	Description of the item	string	optional
`row`	Whether to display the item in a row	boolean	optional
`spacebetween`	Whether to put space between elements in the item	boolean	optional
`colspan`	Number of columns that the item spans	int	optional

infobox:renderItem( {
	label = 'Item label',
	data = 'Item data'
} )

Section

This is used to wrap items into a section.

Parameter	Description	Type	Status
`content`	Content of the section	string	required
`title`	Title of the section	string	optional
`subtitle`	Subtitle of the section	string	optional
`col`	Number of columns in the section	int	optional
`class`	HTML classes to be added to the section	string	optional

infobox:renderSection( {
	title = 'Section title',
	content = table.concat( sectionTable ),
	col = 3
} )

Layout

Row

-- Create items
sectionTable = {
	infobox:renderItem( {
		label = 'Bacon',
		data = 'Good',
		row = true,
		spacebetween = true
	} ),
	infobox:renderItem( {
		label = 'Pancetta',
		data = 'Great',
		row = true,
		spacebetween = true
	} ),
	infobox:renderItem( {
		label = 'Prosciutto',
		data = 'Wonderful',
		row = true,
		spacebetween = true
	} )
}

-- Create section with items
infobox:renderSection( {
	title = 'Row layout',
	subtitle = 'This is an example of the row layout.',
	content = table.concat( sectionTable )
} )

List

-- Create items
sectionTable = {
	infobox:renderItem( {
		data = 'Bacon is good',
		desc = 'Bacon ipsum dolor amet burgdoggen boudin spare ribs pork pork chop drumstick beef. Jowl turkey pork, kevin shankle shank shoulder. ',
	} ),
	infobox:renderItem( {
		data = 'Pancetta is great',
		desc = 'Kevin pig fatback, alcatra pancetta sirloin venison tri-tip shankle kielbasa meatloaf spare ribs beef. Corned beef salami kielbasa tenderloin swine spare ribs andouille.',
	} ),
	infobox:renderItem( {
		data = 'Prosciutto is wonderful',
		desc = 'Venison chicken meatloaf, ground round swine short ribs shankle short loin tenderloin jerky capicola. Prosciutto venison sirloin beef brisket pancetta.',
	} )
}

-- Create section with items
infobox:renderSection( {
	title = 'List layout',
	subtitle = 'This is an example of the list layout.',
	content = table.concat( sectionTable )
} )

Grid

Quick facts:

InfoboxNeue

2 col grid layout

This is an example of the two column grid layout.

Bacon

Good

Pancetta

Great

Prosciutto

Wonderful

Capicola

Delightful

3 col grid layout

This is an example of the three column grid layout.

Bacon

Good

Pancetta

Great

Prosciutto

Wonderful

Capicola

Delightful

4 col grid layout

This is an example of the four column grid layout.

Bacon

Good

Pancetta

Great

Prosciutto

Wonderful

Capicola

Delightful

-- Create items
sectionTable = {
	infobox:renderItem( {
		label = 'Bacon',
		data = 'Good'
	} ),
	infobox:renderItem( {
		label = 'Pancetta',
		data = 'Great'
	} ),
	infobox:renderItem( {
		label = 'Prosciutto',
		data = 'Wonderful'
	} ),
	infobox:renderItem( {
		label = 'Capicola',
		data = 'Delightful'
	} )
}

-- Create section with items
infobox:renderSection( {
	title = '2 col grid layout',
	subtitle = 'This is an example of the two column grid layout.',
	content = table.concat( sectionTable ),
	col = 2
} )

infobox:renderSection( {
	title = '3 col grid layout',
	subtitle = 'This is an example of the three column grid layout.',
	content = table.concat( sectionTable ),
	col = 3
} )

infobox:renderSection( {
	title = '4 col grid layout',
	subtitle = 'This is an example of the four column grid layout.',
	content = table.concat( sectionTable ),
	col = 4
} )