Module:Portal bar/doc: Difference between revisions

Content deleted Content added

Inline

Revision as of 21:08, 18 December 2021

This Lua module is used on approximately 173,000 pages.
To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them.

This module depends on the following other modules:

This module uses TemplateStyles:

Module:Portal bar/styles.css (sandbox)

This module implements the {{portal bar}} template. It displays a horizontal bar of portals.

See {{Portal bar/testcases}} for testcases.

Note: in order to make the test cases work, the Sandbox CSS classes have "-sand" appended to their names. If you wish to update the CSS, copy the contents of each class from Module:Portal bar/sandbox/styles.css to Module:Portal bar/styles.css, but do not alter the class names, nor just copy-paste the entire CSS file. For the current difference in CSS between Sandbox and Main, see here.

Usage

{{#invoke:Portal bar|main|''portal 1''|''portal 2 ''|...|border=''no''}}

Positional parameters - the names of the portals to be displayed.
border - if |border= is equal to no, n, false, or 0, then the portal box will have no border.
redlinks - if |redlinks= is equal to yes, y, true or include, then the portal box will show redlinked portals

Examples

{{#invoke:portal bar|main|Art|Science|Literature}}

Produces:

{{#invoke:portal bar|main|Art|Science|Literature|border=no}}

Produces:

For further examples, see Template:Portal bar/testcases.

Images

This module uses Module:Portal to get portal images. To add, change, or remove images, please see the instructions at Module:Portal#Image.

@@ Line 4: / Line 4: @@
 {{Uses TemplateStyles|Module:Portal bar/styles.css}}
 This module implements the {{tl|portal bar}} template. It displays a horizontal bar of [[WP:PORTAL|portals]].
+See {{tl|Portal bar/testcases}} for testcases.
+'''Note''': in order to make the test cases work, the Sandbox CSS classes have "-sand" appended to their names. If you wish to update the CSS, copy the contents of each class from [[Module:Portal bar/sandbox/styles.css]] to [[Module:Portal bar/styles.css]], but do '''not''' alter the class names, nor just copy-paste the entire CSS file. For the current difference in CSS between Sandbox and Main, see [https://en.wikipedia.org/wiki/Special:ComparePages?page1=Module%3APortal+bar%2Fstyles.css&rev1=&page2=Module%3APortal+bar%2Fsandbox%2Fstyles.css&rev2=&action=&diffonly=&unhide= here].
 == Usage ==