Difference between revisions of "Template:Navbar-header/doc"

From blackwiki
Jump to navigation Jump to search
test>OwenBlacker
m (Corrected typo)
m (70 revisions imported)
 
(43 intermediate revisions by 28 users not shown)
Line 1: Line 1:
<includeonly>{{protected template}}{{template doc page transcluded}}</includeonly><noinclude>{{template doc page viewed directly}}</noinclude>
+
{{Documentation subpage}}
 +
{{high-use| 54856 }}
 +
{{used in system|in [[MediaWiki:Abusefilter-warning-predatory]]}}
 
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
 
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
  
 
==Usage==
 
==Usage==
Simply place '''<nowiki>{{</nowiki>'''Tnavbar-header|Heading|Name of Template'''<nowiki>}}</nowiki>''' in the header area of a given [[Wikipedia:Navigational templates|template]] to add a centred heading with right justified <span style="font-size:xx-small;">'''v''' • '''d''' • '''e'''</span> navigational functionality. If there is need for a font color other than black, use '''<nowiki>{{</nowiki>'''Tnavbar-header|Heading|Name of Template|fontcolor=#[[Web colors|html color code]]'''<nowiki>}}</nowiki>''' instead.
+
Simply place the following code in the header area of a given [[Wikipedia:Navigation template|template]] to add a centred heading with right justified view/talk/edit link functionality.
  
===Parameters===
+
<blockquote>{{tlxi|Navbar-header|heading|name of template}}</blockquote>
<hr/>
 
====''Mandatory''====
 
; 1 : (the first unnamed parameter) Text that appears centered in the titlebar (the top bar).
 
; 2 : (the second unnamed parameter) The name of the template, which is needed for the "<span style="white-space:nowrap;">view • talk • edit</span>" links to work properly on all of the pages where the template is used on. You can enter <code><nowiki>{{subst:PAGENAME}}</nowiki></code> for this value as a shortcut.
 
  
====''Optional''====
+
==Parameters==
; plain    : switched from v.d.e mode to view talk edit, if plain=1 is set.
+
===Mandatory===
; fontcolor : Specifies the title text color
+
; {{var|heading}} (first unnamed parameter): Text that appears centered in the titlebar (the top bar).
; bgcolor  : (<span style="color: red;">'''Deprecated'''</span>) It use to provide a different background color, however the code has been updated to always give a transparent background
+
; {{var|name of template}} (second unnamed parameter): The name of the template, which is needed for the "{{navbar|Navbar-header|plain=1}}" links to work properly on all of the pages where the template is used on. You can enter <code><nowiki>{{subst:PAGENAME}}</nowiki></code> for this value as a shortcut: {{tlc|Navbar-header|{{var|heading}}|<nowiki>{{subst:PAGENAME}}</nowiki>}}
  
===Note to editors with access to this template===
+
===Optional===
This template is likely represented across <span class="plainlinks">[{{fullurl:Special:Whatlinkshere/Template:{{BASEPAGENAMEE}}|limit=5000}} '''thousands''' of pages]</span>, so please tread lightly when editing here.
+
; {{para|plain|1}}: Switches from abbreviated "{{navbar|Navbar-header|mini=1}}" mode to "{{navbar|Navbar-header|plain=1}}", if plain=1 is set.
 +
; {{para|fontcolor}}: Specifies the title text color. Any choice of [[CSS colors]].
 +
 
 +
==Example==
 +
See {{tl|Article Alerts Navheader}}, for an example.
  
 
==See also==
 
==See also==
;{{tl|Tnavbar}}: This template [[Wikipedia:Transclusion|transcludes]] tnavbar, the source is more customizable.
+
; {{tl|Navbar}}: This template [[Wikipedia:Transclusion|transcludes]] navbar, the source is more customizable.
;{{tl|Tnavbar-navframe}}: For use in conjunction with [[Wikipedia:NavFrame|Navframe divs]], positions <small>v • d • e</small> opposite of the [hide]/[show] feature.
+
; {{tl|Navbar-navframe}}: For use in conjunction with [[Wikipedia:NavFrame#NavFrame divs|NavFrame divs]], positions {{navbar|Navbar-header|mini=1}} opposite of the [hide]/[show] feature.
;{{tl|Tnavbar-collapsible}}: For use in conjunction with [[Wikipedia: NavFrame#Collapsible tables|Collapsible tables]],floats <small>v • d • e</small> opposite of the [hide]/[show] feature
+
; {{tl|Navbar-collapsible}}: For use in conjunction with [[Wikipedia:NavFrame#Collapsible tables|collapsible tables]], floats {{navbar|Navbar-header|mini=1}} opposite of the [hide]/[show] feature
  
 
Make use of meta-template to reduce code bloat and simplify editing:
 
Make use of meta-template to reduce code bloat and simplify editing:
{{Navigational templates}}
+
{{Navigation templates}}
 +
 
  
<includeonly>
+
<includeonly>{{Sandbox other||
 
<!-- ADD CATEGORIES BELOW THIS LINE -->
 
<!-- ADD CATEGORIES BELOW THIS LINE -->
[[Category:Internal link templates|Tnavbar-header/doc]]
+
[[Category:Internal link templates]]
 
+
}}</includeonly>
<!-- ADD INTERWIKIS BELOW THIS LINE -->
 
[[ca:Plantilla:Tnavbar-header]]
 
[[cy:Nodyn:Bar llywio-pennyn]]
 
[[es:Plantilla:Encap]]
 
[[fr:Modèle:Tnavbar-header]]
 
[[hr:Predložak:Tnavbar-header]]
 
[[hu:Sablon:Navifejléc]]
 
[[id:Templat:Tnavbar-header]]
 
[[ku:Şablon:Tnavbar-header]]
 
[[lv:Veidne:Tnavbar-header]]
 
[[ms:Templat:Tnavbar-header]]
 
[[no:Mal:Tnavbar-header]]
 
[[oc:Modèl:Tnavbar-header]]
 
[[pt:Predefinição:Tnavbar-header]]
 
[[ro:Format:Tnavbar-header]]
 
[[sq:Stampa:Tnavbar-header]]
 
[[sl:Predloga:Prednavmeni-glava]]
 
[[su:Citakan:Tnavbar-header]]
 
[[te:మూస:Tnavbar-header]]
 
[[tr:Şablon:Tnavbar-header]]
 
[[zh:Template:Tnavbar-header]]
 
 
 
</includeonly>
 

Latest revision as of 16:44, 6 September 2020

Usage

Simply place the following code in the header area of a given template to add a centred heading with right justified view/talk/edit link functionality.

{{Navbar-header|heading|name of template}}

Parameters

Mandatory

heading (first unnamed parameter)
Text that appears centered in the titlebar (the top bar).
name of template (second unnamed parameter)
The name of the template, which is needed for the "" links to work properly on all of the pages where the template is used on. You can enter {{subst:PAGENAME}} for this value as a shortcut: {{Navbar-header|heading|{{subst:PAGENAME}}}}

Optional

|plain=1
Switches from abbreviated "" mode to "", if plain=1 is set.
|fontcolor=
Specifies the title text color. Any choice of CSS colors.

Example

See {{Article Alerts Navheader}}, for an example.

See also

{{Navbar}}
This template transcludes navbar, the source is more customizable.
{{Navbar-navframe}}
For use in conjunction with NavFrame divs, positions opposite of the [hide]/[show] feature.
{{Navbar-collapsible}}
For use in conjunction with collapsible tables, floats opposite of the [hide]/[show] feature

Make use of meta-template to reduce code bloat and simplify editing:

Navigation templates comparison
Collapsible Header color Image Groups Style (body)
parameter/s
Examples
{{Navbox}} collapsible navbox Left/right of body Yes Yes
{{Navbox with collapsible groups}} collapsible navbox Left/right of body and/or in each list Yes Yes
{{Navbox with columns}} collapsible navbox Left/right of columns No Yes
Collapsible attributes
Type CSS classes JavaScript Collapses when Custom
initial state
Nesting
Collapsible tables collapsible Defined in Common.js 2 or more autocollapse on page Yes Yes