Template:Intro to/doc

From MOASSpedia
Jump to navigation Jump to search

Usage

This is a general purpose template for the "Introduction to x" tutorial series. Using this template ensures consistent formatting for all pages in the series. Similarly, editing this template controls the formatting of all pages in the series. On a mobile device this page reflows to place the tabs bar above the contents.

{{Intro to
 |contents = main content of tutorial page
 |exercise = a worked example displayed as a collapsed template at the bottom of the page
}}

The buttons can also be customised

{{Intro to
 ....
 |prev     = true/false to show/hide button at bottom of tab list
 |prevlink = link target for button at bottom of tab list
 |prevtext = text show on button at bottom of tab list
 |next     = true/false to show/hide button at end of the tab series
 |nextlink = link target for button at end of the tab series
 |nexttext = text show on button at end of the tab series
 |sandbox  = true/false to show/hide button to link to testing sandbox
 |prevsubpage = manually specify the previous subpage in the series (defaults to looking for sequentially numbered subpage)
 |nextsubpage = manually specify the next subpage in the series (defaults to looking for sequentially numbered subpage)
 |navbox   = manually specify a navbox at the bottom of the page (defaults to [[template:Introduction/navigation]])
}}

Additional requirements

In order to function, the template looks for the presence of sequentially numbered subpages:

/#: Each page in the series should be saved as a numbered subpage, e.g. Help:Introduction_to_x/1. The template automatically links to the next numbered subpage. If the next numbered subpage doesn't exist, it links back to Help:Getting started (there are optional overrides of |prevsubpage= and |nextsubpage= if the subpages are not sequentially numbered)
/tabs: You must also create a /tabs page to contain the information for the left hand tab bar (See Template:Intro to/tabs for details)
/base: You may additionally create a /base page to contain a consistent bottom section to be shown on all pages in the series (See Template:Intro to/base for details)

Tables

Due to technical limitations, tables have to be written in a separate page (usually a /table subpage) and transcluded into the template.

For example: Help:Introduction_to_talk_pages/3 transcludes Help:Introduction_to_talk_pages/3/table 1

Formatting

Note, the formatting for this template is stored in Template:Intro to/styles.css

See also