Template:Navbar/doc: Difference between revisions

<noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude><!---PLEASE ADD METADATA TO THE <includeonly> SECTION AT THE BOTTOM OF THIS PAGE--->

== Usage ==

===General===

Copyable examples when inside a given [[Wikipedia:Navigation templates|template]] adds navbar navigational functionality:

:<tt><nowiki>{{navbar|{{subst:PAGENAME}}|mini=1}}</nowiki></tt>

:<tt><nowiki>{{navbar|{{subst:PAGENAME}}|plain=1}}</nowiki></tt>

:<tt><nowiki>{{navbar|{{subst:PAGENAME}}|fontstyle=color:green}}</nowiki></tt>

The <code><nowiki>{{subst:PAGENAME}}</nowiki></code> will be substituted with the template's name when parsed by the servers.

<nowiki>{{navbar|navbar/doc}}</nowiki> gives: {{navbar|navbar/doc}}

== Examples ==

===Required parameters===

*<code><nowiki>{{navbar|Name of Template}}</nowiki></code> the template name is required.

===Optional parameters===

{| class="wikitable"

! Options !! Parameters !! Produces...

|-

| Normal || <code><nowiki>{{navbar|Template Name}}</nowiki></code> || {{navbar|navbar/doc}}

|-

| Different text || <code><nowiki>{{navbar|Template Name|text=This template:}}</nowiki></code> || {{navbar|navbar/doc|text=This template:}}

|-

| No "This box:" text. || <code><nowiki>{{navbar|Template Name|plain=1}}</nowiki></code> || {{navbar|navbar/doc|plain=1}}

|-

| Short version. || <code><nowiki>{{navbar|Template Name|mini=1}}</nowiki></code> || {{navbar|navbar/doc|mini=1}}

|-

| For a color option. || <code><nowiki>{{navbar|Template Name|fontstyle=color:green}}</nowiki></code> || {{navbar|navbar/doc|fontstyle=color:green}}

|-

| With brackets.

| <code><nowiki>{{navbar|Template Name|brackets=1}}</nowiki></code>

| {{navbar|navbar/doc|brackets=1}}

|}

<!--- PLEASE ADD METADATA TO THE <includeonly> SECTION HERE --->

<includeonly>

[[Category:Administrator templates|{{PAGENAME}}]]

<!-- [[en:Template:Navbar]] -->

</includeonly>