Template:Portal bar/doc: Difference between revisions

From Zoophilia Wiki
Jump to navigationJump to search
← Older edit
VisualWikitext
meta>Mr. Stradivarius
update with border=no info
Ookami (talk | contribs)
1,664 edits
m 58 revisions imported
 
(26 intermediate revisions by 16 users not shown)
Line 1: Line 1:
{{Documentation subpage}}
{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
{{High-use|76388}}
{{lua|Module:Portal bar}}
{{Warning|'''This template is only transcluded (visible) in mobile view when the <code><nowiki>border=n</nowiki></code> parameter  is implemented'''. See [[Wikipedia:Portal#How to add portal links to articles|how to add portal links to articles]] for more information.}}
The primary purpose of this template is for when using {{tl|Portal}} would cause formating problems.  
{{Warning|{{strong|This template does not belong in the "See also" section.}} Per [[MOS:SECTIONORDER]], this template is bottom matter and goes below standard navigation templates, and above geographical coordinates and authority control templates.}}


For [http://en.wikipedia.org/w/index.php?title=Kurdistan&oldid=523742112#See_also example] sometimes images and infoboxes can push a regular <nowiki>{{portal}}</nowiki> outside of the See also section. This template [http://en.wikipedia.org/w/index.php?title=Kurdistan&oldid=525548023#See_also doesn't have] that problem.  
The primary purpose of this template is for when using {{tlx|portal}} would cause formatting problems. This template forms a horizontal bar instead of a vertical, sidebar-like template. Please note that this template {{strong|[[MOS:ORDER|does not belong]]}} in the "See also" section.


Another example: This template is well suited for articles that have more portals than related articles in the "See also" section, which would cause a regular <nowiki>{{portal}}</nowiki> sprawl into the next section, although a regular <nowiki>{{portal}}</nowiki> with {{tl|clear}} would sometimes work better depending on how much whitespace <nowiki>{{portal}} with {{clear}}</nowiki> would cause.
{{Lua|Module:Portal bar}}


=== Usage ===
== Usage ==
To add the template to a page, use the following code:
{{xref|See {{section link|Module:Portal|Image}} on how to add, update, or remove portal images.}}


<pre>
=== Border ===
{{Portal bar|portal 1|portal 2|...}}
To add the template to a page:
</pre>
: &rarr; <code><nowiki>{{Portal bar|Biology|Fungi|Plants|Science}}</nowiki></code>
{{Portal bar|Biology|Fungi|Plants|Science}}


For a version with no border, use border=no:
=== No border ===
For a version with no border that can be seen in [[WP:MOBILE|mobile view]]:
: &rarr; <code><nowiki>{{Portal bar|Biology|Fungi|Plants|Science|border=n}}</nowiki></code>
{{Portal bar|Biology|Fungi|Plants|Science|border=n}}


<pre>
Portal bar with border extends to the full width of the article, and that can be a problem with right-floating items. To use space better, remove the border.  
{{Portal bar|portal 1|portal 2|...|border=no}}
</pre>


===Location===
== Error tracking ==
Within articles, this template is meant to be placed at the bottom of the article in the ''See also'' section.
If the {{{type|template}}} is used incorrectly, the page will be added to a tracking category.


===Image===
The tracking categories are not applied if any of the following is true:
The portal image name is found using [[Module:Portal]]. Please see [[Module:Portal#Image]] for instructions on how to add, update, or remove an image.
# Tracking is specially disabled for that usage. This is done by setting the optional parameter {{para|tracking}} to any the following values: <code><nowiki>no</nowiki></code>, <code><nowiki>n</nowiki></code>, <code><nowiki>false</nowiki></code>
# the template is used on a page in any of these namespaces: Talk, User, User talk, Wikipedia talk, File talk, Template talk, Category talk, Portal talk, Draft, Draft talk, Module talk
# The title page on which the template is used includes any of the following case-insensitive strings: "/archive", "/doc", "/test"


===Examples===
* [[:Category:Portal templates without a parameter]] — (population {{PAGESINCATEGORY:Portal templates without a parameter}})
<pre>
* [[:Category:Portal templates with redlinked portals]] — (population {{PAGESINCATEGORY:Portal templates with redlinked portals}})
{{Portal bar|Biology|Fungi|Plants|Science}}
* [[:Category:Portal templates with all redlinked portals]] — (population {{PAGESINCATEGORY:Portal templates with all redlinked portals}})
</pre>
:{{Purge page|''Purge page to update totals''}}


Produces:
== TemplateData ==
{{Collapse top|[[WP:TemplateData|TemplateData]] documentation used by [[WP:VisualEditor|VisualEditor]] and other tools}}
{{TemplateData header|noheader=1}}
<templatedata>
{
"params": {
"1": {
"required": true,
"type": "string/line",
"description": "The first portal, without surrounding text. For example, use \"Science\" to display the science portal."
},
"2": {
"type": "string/line",
"description": "The second portal."
},
"3": {
"type": "string/line",
"description": "The third portal."
},
"4": {
"type": "string/line",
"description": "The fourth portal"
},
"5": {
"type": "string/line",
"description": "The fifth portal."
},
"border": {
"type": "string/line",
"description": "Set this to \"no\" if you do not want to display a border around the portals. You can also use \"n\", \"false\", or \"0\"."
}
},
"description": "This template adds a bar of portals. It is usually used just above an article's navboxes or in its \"See also\" section when using [[Template:Portal]] would cause formatting problems."
}
</templatedata>
{{Collapse bottom}}


{{Portal bar|Biology|Fungi|Plants|Science}}
== See also ==
{{clear}}
* {{tl|Portal}}
* {{tl|Subject bar}}


<pre>
<includeonly>{{Sandbox other||
{{Portal bar|Biology|Fungi|Plants|Science|border=no}}
[[Category:Exclude in print]]
</pre>
 
Produces:
 
{{Portal bar|Biology|Fungi|Plants|Science|border=no}}
{{clear}}
 
===See also===
*[[Template:Portal]]
*[[Template:Portal-inline]]
*[[Template:Subject bar]]
 
<includeonly>
<!-- Categories -->
[[Category:Internal link templates]]
[[Category:Internal link templates]]
[[Category:Wikipedia Portal navflags]]
[[Category:Wikipedia Portal navflags]]
[[Category:Exclude in print]]
}}</includeonly>
 
<!--Interwikis-->
[[ms:Templat:Portal bar]]
[[fr:Modèle:Portail]]
</includeonly>

Latest revision as of 13:35, 3 September 2020

The primary purpose of this template is for when using {{portal}} would cause formatting problems. This template forms a horizontal bar instead of a vertical, sidebar-like template. Please note that this template does not belong in the "See also" section.

Usage

See Module:Portal § Image on how to add, update, or remove portal images.

Border

To add the template to a page:

→ {{Portal bar|Biology|Fungi|Plants|Science}}


No border

For a version with no border that can be seen in mobile view:

→ {{Portal bar|Biology|Fungi|Plants|Science|border=n}}


Portal bar with border extends to the full width of the article, and that can be a problem with right-floating items. To use space better, remove the border.

Error tracking

If the template is used incorrectly, the page will be added to a tracking category.

The tracking categories are not applied if any of the following is true:

  1. Tracking is specially disabled for that usage. This is done by setting the optional parameter |tracking= to any the following values: no, n, false
  2. the template is used on a page in any of these namespaces: Talk, User, User talk, Wikipedia talk, File talk, Template talk, Category talk, Portal talk, Draft, Draft talk, Module talk
  3. The title page on which the template is used includes any of the following case-insensitive strings: "/archive", "/doc", "/test"
Purge page to update totals

TemplateData

TemplateData documentation used by VisualEditor and other tools
This is the TemplateData for this template, used by TemplateWizard, VisualEditor and other tools.
TemplateData for Portal bar

This template adds a bar of portals. It is usually used just above an article's navboxes or in its "See also" section when using [[Template:Portal]] would cause formatting problems.

Template parameters

ParameterDescriptionTypeStatus
11

The first portal, without surrounding text. For example, use "Science" to display the science portal.

Linerequired
22

The second portal.

Lineoptional
33

The third portal.

Lineoptional
44

The fourth portal

Lineoptional
55

The fifth portal.

Lineoptional
borderborder

Set this to "no" if you do not want to display a border around the portals. You can also use "n", "false", or "0".

Lineoptional

See also


Retrieved from "https://zoophilia.wiki/index.php?title=Template:Portal_bar/doc&oldid=88747"