Template:Preview Only Infobox/Default: Difference between revisions

From HorizonXI Wiki
mNo edit summary
(added new optional parameters, documentation and an example)
Line 1: Line 1:
Welcome to [[:Template:Preview Only Infobox|Preview Window]] assistance. Editors may use any of the following syntax to display the following support features:<!--
Welcome to [[:Template:Preview Only Infobox|Preview Window]] assistance. Editors may use any of the following commands to display the following support features:<!--


--><section begin=commands/><ul><li>'''<nowiki>{{Template Name|bp</nowiki>:''' displays a ''boilerplate'' of this template.</li><!--
--><section begin=commands/><ul><li>'''<nowiki>{{Template Name|bp</nowiki>:''' displays a ''boilerplate'' of this template.</li><!--
Line 7: Line 7:
--><li>'''<nowiki>{{Template Name|list</nowiki>:''' generates a list of all templates that have ''preview window assistance''.</li><!--
--><li>'''<nowiki>{{Template Name|list</nowiki>:''' generates a list of all templates that have ''preview window assistance''.</li><!--
--><li>'''<nowiki>{{Template Name|nd</nowiki>:''' removes this ''documentation''.</li><!--
--><li>'''<nowiki>{{Template Name|nd</nowiki>:''' removes this ''documentation''.</li><!--
-->{{#if:{{{extra 1|}}}|<li>'''<nowiki>{{Template Name|</nowiki>{{{extra 1}}}:''' {{#if:{{{extra 1 message|}}}|{{{extra 1 message}}}}}</li>}}</ul><section end=commands/>
 
-->{{#if:{{{extra 1|}}}|<li>'''<nowiki>{{Template Name|</nowiki>{{{extra 1}}}:''' {{#if:{{{extra 1 message|}}}|{{{extra 1 message}}}}}</li>}}<!--
 
-->{{#if:{{{extra 2|}}}|<li>'''<nowiki>{{Template Name|</nowiki>{{{extra 2}}}:''' {{#if:{{{extra 2 message|}}}|{{{extra 2 message}}}}}</li>}}<!--
 
-->{{#if:{{{extra 3|}}}|<li>'''<nowiki>{{Template Name|</nowiki>{{{extra 3}}}:''' {{#if:{{{extra 3 message|}}}|{{{extra 3 message}}}}}</li>}}<!--
 
-->{{#if:{{{extra 4|}}}|<li>'''<nowiki>{{Template Name|</nowiki>{{{extra 4}}}:''' {{#if:{{{extra 4 message|}}}|{{{extra 4 message}}}}}</li>}}<!--
 
-->{{#if:{{{extra 5|}}}|<li>'''<nowiki>{{Template Name|</nowiki>{{{extra 5}}}:''' {{#if:{{{extra 5 message|}}}|{{{extra 5 message}}}}}</li>}}</ul><section end=commands/>
 
<noinclude>
== Documentation ==
This page is simply used as a transclusion on pages that are using the [[:Template:Preview Only Infobox|Preview Only Infobox]] template and the main template page documents this process. If an editor wishes to include some additional commands simply follow the below example. A total of 5 extra commands can be included.
 
=== Parameters ===
* '''extra 1:''' use this to set the name of the new command.
* '''extra 1 message:''' use this parameter to describe the purpose of the new command.
* '''extra 2:''' displays a second new command.
* '''extra 2 message:''' displays the second description of this command.
This continues up to and including '''extra 5'''.
 
=== Example ===
<pre>{{Preview Only Infobox/Default
| extra 1 = further assistance
| extra 1 message = displays further assistance.
| extra 2 = information
| extra 2 message = shows information in relation to this template.
}}</pre>
 
{{Preview Only Infobox/Default
| extra 1 = further assistance
| extra 1 message = displays further assistance.
| extra 2 = information
| extra 2 message = shows information in relation to this template.
}}</noinclude>

Revision as of 22:08, 12 September 2024

Welcome to Preview Window assistance. Editors may use any of the following commands to display the following support features:

  • {{Template Name|bp: displays a boilerplate of this template.
  • {{Template Name|command: dislays this list of available commands.
  • {{Template Name|fd: provides the template's full documentation.
  • {{Template Name|help: displays parameter help.
  • {{Template Name|list: generates a list of all templates that have preview window assistance.
  • {{Template Name|nd: removes this documentation.


Documentation

This page is simply used as a transclusion on pages that are using the Preview Only Infobox template and the main template page documents this process. If an editor wishes to include some additional commands simply follow the below example. A total of 5 extra commands can be included.

Parameters

  • extra 1: use this to set the name of the new command.
  • extra 1 message: use this parameter to describe the purpose of the new command.
  • extra 2: displays a second new command.
  • extra 2 message: displays the second description of this command.

This continues up to and including extra 5.

Example

{{Preview Only Infobox/Default
| extra 1 = further assistance
| extra 1 message = displays further assistance.
| extra 2 = information
| extra 2 message = shows information in relation to this template.
}}

Welcome to Preview Window assistance. Editors may use any of the following commands to display the following support features:

  • {{Template Name|bp: displays a boilerplate of this template.
  • {{Template Name|command: dislays this list of available commands.
  • {{Template Name|fd: provides the template's full documentation.
  • {{Template Name|help: displays parameter help.
  • {{Template Name|list: generates a list of all templates that have preview window assistance.
  • {{Template Name|nd: removes this documentation.
  • {{Template Name|further assistance: displays further assistance.
  • {{Template Name|information: shows information in relation to this template.