Module:Transclude random subpage/doc

This is a documentation subpage for Module:Transclude random subpage.
It may contain usage information, categories and other content that is not part of the original module page.

This module depends on the following other modules:

Module:Transclude random subpage

This template pulls in the content from one subpage from a set of subpages. Designed primarily for use on portals.

Layout

{{Transclude random subpage
 |max      =
 |subpage  = 
 |rootpage =
}}

Usage

rootpage: (Optional) The root of the transcluded page, e.g. Portal:Foo.
subpage: The subpage of the transcluded page, e.g. Selected picture.
max: The maximum number of sub-subpages. Must be a positive integer.

Formatting subpages

Create a sub-page first. If your portal is Portal:Foo, then a sub-page could be Portal:Foo/Selected bar.
On the Portal:Foo/Selected bar sub-page, place the template {{numbered subpages}} on the page and save it.
Once the list of subject links have been created, use one of the Selected <subject> templates from below to format each of the subject sub-pages.
This template calls /box-header (if headertemplate is not specified) and {{box-footer}} for its color styles and closing. Either headertemplate must be used, or the /box-header subpage must exist for everything to work correctly.

Why this template?

This template was created to enable {{Random portal component}} to be replaced with standard portal box notation, including {{Box-header colour}} and {{Box-footer}}.

Example:

{{Random portal component|max=22|header=''Selected article''|subpage=Selected article}}

could be replaced by this:

{{Box-header colour|Selected article}}
{{Transclude random subpage |max=22|subpage=Selected article}}
{{Box-footer}}

This also allows a box to be modified (edited) independently of its contents, and to match the other boxes on the page.