Brad: Creating template documentation

2018-09-25T21:34:35Z

Creating template documentation

New page

Infoboxes are informational summaries of an article's key points. '''{{tl|InfoboxStacked}}''' allows you to create infoboxes that follow a standard appearance and style with minimal markup. Refer to the example to see what the "Stacked" infobox looks like.

== Usage ==
<pre>{{InfoboxStacked
| ibname =
| ibtype =
| image =

| ibclass =
| ibbgcolor =
| ibborder =
| headerbg =

| paramname1 =
| param1 =

| paramname2 =
| param2 =

...

}}</pre>

All of {{tl|InfoboxStacked}}'s parameters are optional and, except for '''name''', do not appear if not passed or are passed with an empty parameter. Most uses of {{tl|InfoboxStacked}}s should be in templates that pass the necessary parameters to {{tl|InfoboxStacked}}. See the examples below for more details.

=== Title and type metadata ===
; ibname: The name that appears at the top of the infobox.
: ''Default: {{xt|<nowiki>{{PAGENAME}}</nowiki>}}''
; ibtype: The type of content this infobox summarizes. This is wrapped in parentheses in the rendered infobox.
; image: An image link that illustrates the article's subject. This should almost always be 250px wide.

=== Style attributes ===
; ibclass: The name of a CSS class to associate with the infobox. {{xt|infobox}} is always assigned; any classes added here are added to the infobox and do not override this class.
; ibbgcolor: A CSS color code for the background of the main portion of the infobox.
: ''Default: {{xt|#f8f9fa}}''
; ibborder: A CSS color code for the border surrounding the infobox.
: ''Default: {{xt|darkgray}}''
; headerbg: A CSS color code for the background of the '''ibname''' and '''ibtype''' parameters.
: ''Default: {{xt|#ccc}}''

=== Parameters ===
; paramnamen: The name of a parameter in the infobox, presented in order from top to bottom in the infobox's body. This text is bolded in the infobox's body. You can include as many '''paramnamen''' entries as you wish, but each should be accompanied by a '''paramn''' of the same number.
; paramn: The content of the associated parameter, typically displayed as plain text below the corresponding '''paramname''' in the infobox's body unless noted otherwise above.

== Example ==
=== Subject template example ===
You can create an infobox template that itself calls {{tl|InfoboxStacked}}. Indeed, this is the preferred way to use {{tl|InfoboxStacked}}—you can create an infobox that employs a reusable, standard set of parameters for a common subject without needing to use complex wiki code or HTML.

{{InfoboxStacked
| ibname = Test of the Obelisk
| ibtype = Discipline of Architecture Test
| image = [[File:Architecture Test Icons_Test Obelisk.png|250px|Test of the Obelisk]]

| ibclass = infobox
| ibbgcolor = #fae9d9
| ibborder = #6e5240
| headerbg = #b49478

| paramname1 = Level Required
| param1 = Level 7

| paramname2 = Other Requirements
| param2 = * [[Obelisk Construction]]
* [[Project Management]]

| paramname3 = Demonstration
| param3 = {{Demonstration|demoplayer=Catote|demodate=March 12, 2018}}
}}

<pre>{{Test
| name = Test of the Obelisk
| discipline = Architecture
| image = Architecture Test Icons_Test Obelisk.png
| level = 3
| requirements =
* [[Obelisk Construction]]
* [[Project Management]]
| demonstration = {{Demonstration|demoplayer=Catote|demodate=March 12, 2018}}
}}</pre>

The above example is {{tl|Test}}. See that template's documentation for details on its usage. {{tl|Test}} passes its content to {{tl|InfoboxStacked}} through its own defined parameters.

When creating an infobox template using {{tl|InfoboxStacked}}, you can make a parameter always appear by adding a fallback value. For example, to make the '''discipline''' parameter above a required or always-appearing parameter, change its '''param''' from {{xt|<nowiki>{{{discipline|}}}</nowiki>}} to {{xt|<nowiki>{{{discipline|''required''}}</nowiki>}}.
{{clear}}
=== Raw infobox example ===
{{InfoboxStacked
| ibname = Example arbitrary infobox
| ibtype = Example

| bgcolor = #FFF
| fgcolor = #000

| paramname1 = First
| param1 = This text appears first

| paramname2 = Second
| param2 = This text appears second
}}

You can also create arbitrary, one-off infoboxes by directly invoking {{tl|InfoboxStacked}}.
<pre>{{InfoboxStacked
| ibname = Example arbitrary infobox
| ibtype = Example

| bgcolor = #FFF
| fgcolor = #000

| paramname1 = First
| param1 = This text appears first

| paramname2 = Second
| param2 = This text appears second
}}</pre>

<noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>

Template:InfoboxStacked/doc - Revision history

Brad: Creating template documentation