Difference between revisions of "Template:Intro to/doc"

From blackwiki
Jump to navigation Jump to search
imported>Evolution and evolvability
(+ example parameter)
imported>Evolution and evolvability
Line 3: Line 3:
 
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
 
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
 
== Usage ==
 
== 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.
+
This is a general purpose template for the '''"[[Help:Introduction to|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.
  
 
<pre>
 
<pre>

Revision as of 09:53, 13 March 2020

Script error: No such module "Uses TemplateStyles".

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
}}

Additional requirements

In order to function, the template looks for the presence of certain 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
/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

See also