Editing Module:Portal bar/doc

{{Sandbox other||{{module rating|protected}}
{{High-use}}}}
{{Lua|Module:Portal|Module:Yesno|Module:No globals|Module:Arguments}}
{{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 ==

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

* Positional parameters - the names of the portals to be displayed.
* <code>border</code> - if {{para|border}} is equal to <code>no</code>, <code>n</code>, <code>false</code>, or <code>0</code>, then the portal box will have no border.
* <code>redlinks</code> - if {{para|redlinks}} is equal to <code>yes</code>, <code>y</code>, <code>true</code> or <code>include</code>, then the portal box will show redlinked portals

== Examples ==
*<code><nowiki>{{#invoke:portal bar|main|Art|Science|Literature}}</nowiki></code>

Produces:

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

*<code><nowiki>{{#invoke:portal bar|main|Art|Science|Literature|border=no}}</nowiki></code>

Produces:

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

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