نمایش مبدأ برای الگو:Random portal component/توضیحات

<includeonly>{{template doc page transcluded}}</includeonly><noinclude>{{template doc page viewed directly}}</noinclude>
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
This template generates a box for a portal home page. The content is drawn randomly from a pre-defined list. Using this template makes editing portal page easy!

== Layout ==
<pre>
{{Box-header| title=header
|editpage   = 
|border     =      <!-- This is the color of the borders around Box Sections -->
|titleforeground = <!-- This is the color of the Box Section Title Bar text -->
|titlebackground = <!-- This is the color of the Box Section Title Bar -->
|background =      <!-- This is the color of the Box Section background -->
|foreground =      <!-- This is the color of the Box Section text -->
}}
{{طرح‌نما}}
{{Portal:box-footer | footer }}
</pre>

== Usage ==
Using this template for your portal page is easy! Just include these parameters
* '''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.

=== Prerequisites ===

* 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;
* 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 colour 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 [[Special:Whatlinkshere/Template:{{BASEPAGENAME}}|what links here]].

Here's a stale example of the output generated by this template.
<pre>
{{Box-header| title=header
|editpage   = Template:Lorem ipsum
|border     = Black
|titleforeground = #ffe247
|titlebackground = #A9A9A9
|background = #FFFFFF
|foreground = black
}}
{{طرح‌نما}}
{{Portal:box-footer | footer }}
</pre>

will produce:
{{Box-header| title=header
|editpage   = Template:Lorem ipsum
|border     = Black 
|titleforeground = #ffe247
|titlebackground = #A9A9A9
|background = #FFFFFF
|foreground = black}}
{{طرح‌نما}}
{{Portal:box-footer | footer }}

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

<includeonly>
<!-- ADD CATEGORIES BELOW THIS LINE -->
[[رده:الگو:درگاه‌های ایران‌پدیا]]
[[رده:الگو:ویکی‌پروژه‌ها]]

</includeonly>