Template:Random subpage/doc

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

Template layout

{{Random subpage}}
or
{{Random subpage|page=<page name>|start=<number>|end=<number>|seed=<number>}}
or
{{Random subpage|<page name>|<number>|<number>|<number>}}

Usage

This template transcludes a numbered sub-page that is randomly selected between the "start"-numbered sub-page and the "end"-numbered sub-page as follows:

{{<page name>/<randomly selected number between "start" and "end">}}

It may be used with or without parameters as follows:

1|page: The name of the page to be displayed (without the subpage number). The default is empty.
2|start: The starting sub-subpage number. Must be a positive integer. The default is 1.
3|end: The ending sub-subpage number. Must be a positive integer. The default is 2.
4|seed: (optional) The default seed is 2 and can be set to any other integer value (used to generate distinct values on the same page). Prime numbers work best, such as 2, 3, 5, 7, 11, 13, 17, 19, 23, 29, 31, 37, 41, 43, 47, 53, 59, 61, 67, 71, 73, 79, 83, 89, 97, 101, 103, 107, 109, and 113.

Example

This template can be used to display a list of randomly selected items from a group of numbered subpages. For example, portals that use "Did you know..." sections can randomly display four items from a page named "Portal:Foo/Did you know" that has sixteen numbered subpages as follows:

{{Random subpage|page=Portal:Foo/Did you know|start=1|end=4|seed=2}}
{{Random subpage|page=Portal:Foo/Did you know|start=5|end=8|seed=3}}
{{Random subpage|page=Portal:Foo/Did you know|start=9|end=12|seed=5}}
{{Random subpage|page=Portal:Foo/Did you know|start=13|end=16|seed=7}}