Module:Transclude random subpage/doc: Difference between revisions

Content deleted Content added

Inline

Revision as of 09:02, 7 November 2018

This is a documentation subpage for Module:Transclude random subpage.
It may contain usage information, categories and other content that is not part of the original module page.

This module depends on the following other modules:

Module:Transclude random subpage

This template pulls in the content from one subpage from a set of subpages. Designed primarily for use on portals.

Layout

{{Transclude random subpage
 |max      =
 |subpage  = 
 |rootpage =
}}

Usage

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 {{numbered subpages}} on the page and save it.
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 (if headertemplate is not specified) and {{box-footer}} for its color styles and closing. Either headertemplate must be used, or the /box-header subpage must exist for everything to work correctly.

Why this template?

This template was created to be used with {{Box-header colour}}, to replace instances of {{Random portal component}}

Example:

{{Random portal component|max=22|header=''Selected article''|subpage=Selected article}}

could be replaced by this:

{{Box-header colour|Selected article}}
{{Transclude random subpage |max=22|subpage=Selected article}}
{{Box-footer}}

This also allows a box to be modified (edited) independently of its contents, and in a way that matches the other boxes on the page.

@@ Line 1: / Line 1: @@
+{{Documentation subpage}}
-{{module rating|alpha}}
-{{Uses Lua|Module:Random}}
+{{lua|Module:Transclude random subpage}}
+<!-- EDIT TEMPLATE DOCUMENTATION AFTER THIS LINE -->
-This module implements {{tl|Transclude random subpage}}. Please see the template page for documentation.
+This template pulls in the content from one subpage from a set of subpages. Designed primarily for use on portals.
-{{portal templates navbox}}
+== Layout ==
+<pre>
+{{Transclude random subpage
+ |max      =
+ |subpage  =
+ |rootpage =
+}}
+</pre>
+== Usage ==
+* '''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 {{code|Portal:Foo}}, then a sub-page could be {{code|Portal:Foo/Selected bar}}.
+* On the {{code|Portal:Foo/Selected bar}} sub-page, place the template {{tl|numbered subpages}} on the page and save it.
+* Once the list of subject links have been created, use one of the {{code|Selected <subject>}} templates from below to format each of the subject sub-pages.
+* This template calls {{code|/box-header}} (if {{code|headertemplate}} is not specified) and {{tl|box-footer}} for its color styles and closing. Either {{code|headertemplate}} must be used, or the {{code|/box-header}} subpage must exist for everything to work correctly.
+== Why this template? ==
+This template was created to be used with {{tl|Box-header colour}}, to replace instances of {{tl|Random portal component}}
+Example:
+<code><nowiki>{{Random portal component|max=22|header=''Selected article''|subpage=Selected article}}</nowiki></code>
+could be replaced by this:
+<syntaxhighlight>
+{{Box-header colour|Selected article}}
+{{Transclude random subpage |max=22|subpage=Selected article}}
+{{Box-footer}}
+</syntaxhighlight>
+This also allows a box to be modified (edited) independently of its contents, and in a way that matches the other boxes on the page.