Template:Preview Only Infobox

Usage

This template was originally designed to provide help and support to editors when viewing a page in "preview mode". It's since been expanded upon and now provides several different versions of preview mode assistance that will hopefully help editors even further. To see a full list of existing template with this feature, please see this page. If you would like to add this feature to a template, follow the stepw below.

Step 1: Create a new sub-page of the template in question. As our example: Template:Used In/Help

Step 2: Paste the below code onto the page. Ensure to tailor the code to your template ie. replace "Template Name" with the required template name, include the associated parameters, etc.

Unfortunately the wiki markups < pre > & < includeonly > cannot be displayed correctly, due to their function. When copy and pasting this section, please remove the spaces from these markups. There's two < includeonly >'s that can be found both at the very beginning and very end of the code. There is also two < pre >'s that can be found within the "boilerplate" and "help" sections.

< includeonly >{{#switch:{{lc:{{{1|}}}}}<!--

-->|bp|boilerplate = 
{{Preview Only Infobox|These parameters are the ones most commmonly used for the Horizon server. 
<pre>{{Template Name
| = add as many parameters as required
}}< /pre>|disable={{{1|}}}}}<!--

-->|help = 
{{Preview Only Infobox|
<pre>{{Template Name
| parameter = {short explanation on how each one should be filled out}
}}< /pre>|disable={{{1|}}}}}<!--

-->|fd = {{Preview Only Infobox|{{Template:Name/Documentation}}
|disable={{{1|}}}}}<!--

-->|nd|no documentation = <!--

-->|list = {{Preview Only Infobox|{{Preview Only Infobox/List}}
|disable={{{1|}}}}}<!--

-->|command|commands = {{Preview Only Infobox|{{Preview Only Infobox/Default}}}}<!--

-->|#default = {{Preview Only Infobox|{{Preview Only Infobox/Default}}}}}}
</ includeonly >

Step 3: Decide whether you would prefer the preview only infobox to display as default or when the editor "turns it on". The copied text from step 2 is set to display as default. To change this, change the #default line to the following:

-->|#default = }}

Step 4: Add the following code to the top of the original template page in question. To continue our example, this would be on page Template:Used In.

< includeonly >< onlyinclude > {{Item Statistics/Help|{{{1}}}}}< /onlyinclude >< /includeonly >

If an "< includeonly >" and/or "< onlyinclude >" are already present on the template page, simply slot this code in above everything, on the very first line.

Step 5: If your template page has documentation, it needs moving to its own sub-page. In our example, this would be moved to Template:Used In/Documentation. This documentation then needs transcluding back onto the template page. To do this use this following code and if this step isn't completed, the command "fd" sadly won't work.

{{Template Name/Documentation}}

Step 6: Add the template to the list of templates that have preview window infoboxes on this page.

Step 7: Test that it works! The following commands will appear when you type the code {{Template Name|}} on any page.

• {{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.

Optional Steps

These optional steps can be taken to further expand the preview window assistance.

Adding Extra Commands

Step 1: On the "Template:Template Name/Help" page, add the following code on its own line.

-->|??? = {{Preview Only Infobox|
preview message
|disable={{{1|}}}}}<!--

Step 2: Replace ??? with the command name of choice (currently existing examples: nd, help, list etc.).

Step 3: Replace "preview message" with your own. This can include custom boilerplates, additional documentation, transclusions etc.

Step 4: Find the " #default " command and update it to reflect the following.

-->|#default = {{Preview Only Infobox|{{Preview Only Infobox/Default
| extra 1 = ???
| extra 1 message = description of the ??? command.
}}}}}}

Step 5: As in step 2, replace the ??? with the command name of choice.

Step 6: Replace the description to briefly inform the editor of its purpose. The new command will now automatically appear in the preview window.