Template:Sidebar games events/doc

This is a documentation subpage for Template:Sidebar games events.
It may contain usage information, categories and other content that is not part of the original template page.

This template is used on approximately 39,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

This template uses Lua:

Module:Sidebar games events (sandbox)

Usage

{{Sidebar games events
| name = {{subst:PAGENAME}}
| event = 
| games = 
| image = 

| title1 =
| event1 = 
| image1 = 
| event1.1 =
| results1.1a =
| results1.1b = 
| results1.1c = 
| event1.2 = 
| results1.2a =
| results1.2b =
| results1.2c =

| title2 =
| event2 = 
| image2 = 
| event2.1 =
| results2.1a =
| results2.1b = 
| results2.1c = 
| event2.2 = 
| results2.2a =
| results2.2b =
| results2.2c =

| prev = 
| next = 
}}

Navbar links

To suppress the view, edit, talk (navbar links), remove the |name= parameter.

Common parameters

Parameter	Values	Description
`event`	`Bobsled`, `Cycling`, ...	The name of the event (used to generate the title "`event` at `games`"). If you use this parameter, don't use `\|title=`.
`games`	`2016 Olympics`, ...	The name of the games (used to generate the title "`event` at `games`"). If you use this parameter, don't use `\|title=`.
`name`	`{{subst:PAGENAME}}`	The name of the template, used for the view, edit, talk (navbar links). To suppress these links, omit this parameter.
`image`	`[[File:Example.png\|20px]]`, ...	An image icon to be placed below the title
`caption`	`Text`	A caption for the image
`imageright`	`[[File:Example.png\|20px]]`, ...	An image icon to be placed to the right of the title
`above`	`Text`	Header text to be placed below the title and top image
`titlexx`	`Text`	Title text for the `XX` series of events (supersedes event and is rarely used)
`eventXX`	`Text`	Header text for the `XX` series of events
`imageXX`	`[[File:Example.png\|20px]]`, ...	An image icon to be placed below the eventXX header
`typeXXa`	`Text`	First data column header for the `XX` series of events
`typeXXb`	`Text`	Second data column header for the `XX` series of events
`typeXXc`	`Text`	Third data column header for the `XX` series of events
`typeXXd`	`Text`	Fourth data column header for the `XX` series of events
`eventXX.YY`	`Text`	Label for the `XX.YY` subevents
`resultsXX.YYa`	`Text`	First results data column for the `XX.YY` subevents
`resultsXX.YYb`	`Text`	Second results data column for the `XX.YY` subevents
`resultsXX.YYc`	`Text`	Third results data column for the `XX.YY` subevents
`resultsXX.YYd`	`Text`	Fourth results data column for the `XX.YY` subevents
`resultsXX.YY`	`Text`	Data for the `XX.YY` subevents (spans all data columns)
`borderXX.YY`	`y` or omit	Any non-blank value will trigger the inclusion of a horizontal border below the `XX.YY` subevents row

Other parameters

Parameter	Values	Description
`title`	`Event at the Games`, ...	A free-form title for the sidebar. If you use this parameter, don't use `\|event=` and `\|games=`.
`alignresults`	`left`, `right`, or `center`	Alignment of the results columns (default: `left`)
`alignevents`	`left`, `right`, or `center`	Alignment of the subevents columns (default: `left`)
`width`	`22em`, `200px`, ... or `auto`	Overall width of the sidebar (default: `auto`)
`maxwidth`	`22em`, `200px`, ... or `auto`	Overall maximum width of the sidebar (default: `25em`)
`float`	`left`, `right`, or `none`	Floating alignment of the sidebar on the page (default: `right`)

Examples

For usage examples, see any of the templates using this meta-template.

[[{{{event}}} at the {{{games}}}\|{{{event}}}]] at the [[{{{games}}}]]
{{{image}}}
{{{title1}}}
{{{event1}}} {{{image1}}}
{{{event1.1}}}	{{{results1.1a}}}	{{{results1.1b}}}	{{{results1.1c}}}
{{{event1.2}}}	{{{results1.2a}}}	{{{results1.2b}}}	{{{results1.2c}}}
{{{title2}}}
{{{event2}}} {{{image2}}}
{{{event2.1}}}	{{{results2.1a}}}	{{{results2.1b}}}	{{{results2.1c}}}
{{{event2.2}}}	{{{results2.2a}}}	{{{results2.2b}}}	{{{results2.2c}}}
{{{prev}}} {{{next}}}
v t e