Template:Random portal component/doc

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

This template generates a box for a portal home page. The content is drawn randomly from a pre-defined list.

Layout

{{Random portal component
 |max      =
 |header   =
 |footer   =
 |subpage  = 
 |seed     =
 |rootpage =
}}

Usage

• header: (optional) The header text of the box. If no header is passed to the template, the default is the subpage name.
• footer: (optional) The footer text in the box. e.g Nominations for selected picture
• 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.
• seed: (optional) The default seed is 17 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.

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. The template will default to 50 subject sub-pages, however you can also use {{25 Numbered subpages}} or {{75 Numbered subpages}} for more or less sub-pages;
• 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 and /box-footer for it's color styles and closing, consequently - these must be present in your portal design for it to work correctly.

Example

To see a real time example, see what links here.

Here's a stale example of the output generated by this template.

{{Portal:Box-header | title=header
|editpage   = Template:Lorem ipsum
|border     = Black
|titleforeground = #ffe247
|titlebackground = #A9A9A9
|background = #FFFFFF
|foreground = black
}}
{{Lorem}}
{{Portal:box-footer | footer }}

will produce:

edit 

header

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.