Template:Portal component/doc

From CWS Planet
Jump to navigation Jump to search

Usage

Using this template for your portal page is easy!

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

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

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.

Full page • Suggest • Archive

Prerequisites

  • Create a subpage first. If your portal is Portal:Foo, then a subpage could be Portal:Foo/Selected article.
  • Next step vary according to mode:
  1. random number: Under that subpage, create subpage to that page, named 1, 2, 3, ... with no prefixing 0. And it does not start with 0.
  2. random list: Under that subpage, create subpage to that page, named regularly as their source topics in Wikipedia for e.g. : History, Vector, etc.
  3. deterministic:In this subpage, write your topic

Modes

The default mode is deterministic. Three modes are available. Mode is determined by template according to pararameters passed:

  1. random number: act exactly as : template:random portal component with nominate but footer parameter is called archive footer . this mode basic features:
    1. topics randomly chosen
    2. nominate and archive selected topic link in footer
  2. random list :accepts a list in the call of template instead of numbers, but you must list the names of all topics, this mode basic features:
    1. topics randomly chosen
    2. nominate and archive selected topic link in footer
    3. a link to fullpage of topic : applied that you named the subsubpage e.g.History exactly as the fullpage article
  3. deterministic:the same topic is always displayed in theportal component.

Parameters

Using this template for your portal page is easy! Just include these parameters : subgrouped accorrding to usage in which mode:

  • All:
    • header: The header text of the box.
  • random number and random list modes:
    • archive footer: (optional) The footer text in the box; it link to an archive page that is located at Portal:yourportal/Subpage name e.g. /Selected picture. If no footer text is passed the default Text is Archive
    • subpage: The subpage of the transcluded page, e.g. Selected picture
    • max: The maximum number of sub-subpages. Must be a positive integer. Default max=1.
    • 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.
  • deterministic mode only:
    • footer: define what appears in footer
  • random listmode only:
    • () any other unnamed parameters is consider as element of random list

See also

Main portal creation templates
  • {{Box portal skeleton}}—Used to create portal main pages.
  • {{Random portal component}}—Used on the portal main page to randomly display articles from the portal sub-pages.
  • {{Random portal component with nominate}}—Used on the portal main page to randomly display articles from the portal sub-pages, adding the option to nominate other Featured foo articles.
  • {{Random subpage}}—Used on the portal main page to randomly display articles from the portal sub-pages. This template is best used for creating randomly populated Did you know... sections on the portal main page that are intended to include multiple Did you know... facts.
  • {{Subpage}}—Used to output a box containing a link to subpage.
  • {{Numbered subpages}}—Used to create article links on portal sub-pages with 50 links.
  • {{Random box-header subpage}}—Used to transclude a numbered subpage.
Main portal page formatting templates
3
Templates that configure links
3
These templates are used to format the articles on the sub-pages

{{Selected X}}—Generic template for situations not listed hereafter.

3
Related templates