Template:Start tab/doc

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

This template is used on approximately 5,700 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.

Templates {{Start tab}} and {{End tab}} can be used to create a tabbed interface on portals, projects, help pages and user pages. They should not be used in articles.

Usage

{{Start tab
|tab-1               = <!-- up to |tab-20= -->
|link-1              = <!-- up to |link-20= -->
|image-1             = <!-- up to |image-20= -->
|rounding            = 
|border              = 
|off tab color       = 
|on tab color        = 
|tab spacing percent = 
|tab font-size       = 
|tab alignment       = 
|nowrap              = 
|frame               = 
|frame color         = 
|no margin           =
}}

<!-- Text for main part of page goes here. -->

{{End tab
|tab-1         = 
|link-1        = 
|tab-2         = 
|link-2        = 
|tab-3         = <!-- up to |tab-10= -->
|link-3        = <!-- up to |link-10= -->
|off tab color = 
|border        = 
|rounding      = 
}}

{{End tab}} is optional. It makes a "Next page:" button to go to the next tab. If {{Start tab}} has |frame = yes then either {{End tab}} or </div></div> is required to close the frame.

Parameters

General
tab-n: The name of the tab, where "n" is number of the tab up to 20.
link-n: The tab link location, where "n" is number of the tab up to 20.
image-n: Name of optional image (set to 20px) to place next to tab title number n.
rounding: Add rounding effect to edges of tab boxes.
border: Border style.
off tab color: Color of the currently unselected tabs.
on tab color: Color of the currently selected tab.
tab spacing percent: Override the width between the tabs.
tab font-size: Override the font size of the text in the tab.
tab alignment: Override alignment of tab's title (left/center/right).
nowrap: Prevent long names from wrapping on each tab.
frame: Set to yes to add a page frame underneath the tabs. This can be closed by adding </div></div> or {{End tab}} to the end of the page, or wherever else you want the frame to close. This option cannot be used on talk pages, and is generally not recommended as it breaks VisualEditor and the reply tool.
frame color: Background color for frame. Default is on tab color.
no margin: Set to yes to disable the margin in between the tabs.

Freeform
freeform-n: Set freeform-n = yes to allow for arbitrary code in that tab's tab-n entry rather than just being plain text and a link. See below. When using the freeform attribute, the link attribute remains empty; for example:

|freeform-1 = yes
|tab-1      = [http://www.nytimes.com/ ''The New York Times'']
|link-1     = 
|image-1    =

This example below is how it would be used for internal pages or subpages for sandboxes, talk page archives, and other pages.

| freeform-2 = yes
| tab-2  = Sandbox ([[User:Example/Sandbox/1|1]] {{dot}} [[User:Example/Sandbox/2|2]] {{dot}} [[User:Example/Sandbox/3|3]])

tab-n: The name of the tab, where "n" is number of the tab up to 20.
link-n: The tab link location, where "n" is number of the tab up to 20.
link2-n: The tab 2nd link location, where "n" is number of the tab up to 20. (only applies when using freeform-n)
link3-n: The tab 3rd link location, where "n" is number of the tab up to 20. (only applies when using freeform-n)
link4-n: The tab 4th link location, where "n" is number of the tab up to 20. (only applies when using freeform-n)
link5-n: The tab 5th link location, where "n" is number of the tab up to 20. (only applies when using freeform-n)

The maximum number of available tabs is 20.
To use the next page feature, end the page with the {{End tab}} template.

Each tab needs a link attribute with the title of the page it refers to, and a tab attribute with a label for the tab. If the current page title matches a link then that tab will be styled differently. The freeform attribute can be used with any tab (for instance |freeform-2=yes to allow for a freeform label with multiple internal and external links if desired; otherwise, the text in tab is used as a wikilink to the page specified by link.

Special use
preums: Internally used only on Template:Page tabs

Examples

Example for Wikipedia:WikiProject Athletics:

{{Start tab
| tab-1   = Current page
| link-1  = Template:Start tab
| tab-2   = Project
| link-2  = Wikipedia:WikiProject Athletics
| tab-3   = Project talk
| link-3  = Wikipedia talk:WikiProject Athletics
| tab-4   = Olympics Project
| link-4  = Wikipedia:WikiProject Olympics
| image-4 = Olympic Rings.svg
| frame   = yes
}}

Text for main part of page goes here.

{{End tab
| tab-1  = Current page
| link-1 = Template:Start tab
| tab-2  = Project
| link-2 = Wikipedia:WikiProject Athletics
| tab-3  = Project talk
| link-3 = Wikipedia talk:WikiProject Athletics
| tab-4  = Olympics Project
| link-4 = Wikipedia:WikiProject Olympics
| frame  = yes
}}

Text for main part of page goes here.

Next page: Current page→

Example for Wikipedia:WikiProject Athletics with rounding:

{{Start tab
| tab-1         = Current page
| link-1        = Template:Start tab
| image-1       = Curly Brackets.svg
| tab-2         = Project
| link-2        = Wikipedia:WikiProject Athletics
| tab-3         = Project talk
| link-3        = Wikipedia talk:WikiProject Athletics
| tab-4         = Olympics Project
| link-4        = Wikipedia:WikiProject Olympics
| image-4       = Olympic Rings.svg
| rounding      = 5em
| border        = 1px solid #808080
| off tab color = #f0f0ff
| tab alignment = center 
| frame         = yes
}}

Text for main part of page goes here.

{{End tab
| tab-1         = Current page
| link-1        = Template:Start tab
| tab-2         = Project
| link-2        = Wikipedia:WikiProject Athletics
| tab-3         = Project talk
| link-3        = Wikipedia talk:WikiProject Athletics
| tab-4         = Olympics Project
| link-4        = Wikipedia:WikiProject Olympics
| rounding      = 5em
| border        = 1px solid #808080
| off tab color = #f0f0ff
| frame         = yes
}}