View source for Template:Random portal component/doc

{{Documentation subpage}}
{{lua|Module:Random portal component}}
<!-- EDIT TEMPLATE DOCUMENTATION AFTER THIS LINE -->

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

== Layout ==

<pre>
{{Random portal component
 |max      =
 |header   =
 |footer   =
 |subpage  = 
 |rootpage =
}}
</pre>

== 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.

=== 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 {{tl|numbered subpages}} on the page and save it. The template will default to 50 subject sub-pages, however you can also use {{tl|25 Numbered subpages}} or {{tl|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 further to format each of the subject sub-pages.
* This template calls '''/box-header''' and '''/box-footer''' for its color styles and closing, these must be present in your portal design for it to work correctly.

== Example ==

To see a real time example, see [[Special:Whatlinkshere/Template:{{BASEPAGENAME}}&hidelinks=1|what links here]] (the list of pages that currently transclude the {{tl|{{BASEPAGENAME}}}} template).

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

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

will produce:

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

== See also ==
{{Portal template list}}

<includeonly>

<!-- ADD CATEGORIES AFTER THIS LINE -->
[[Category:Wikipedia Portal templates|{{PAGENAME}}]]

<!-- ADD INTERWIKIS LINKS AFTER THIS LINE -->
</includeonly>