Infobox/WorkbenchPlugin – Template

From Bohemia Interactive Community
Jump to navigation Jump to search
(Template creation)
 
m (Fix example)
 
(2 intermediate revisions by the same user not shown)
Line 12: Line 12:
This plugin is available in:
This plugin is available in:
{{Columns|2|
{{Columns|2|
{{#if: {{#pos:{{{editor}}}|world}} |
{{#if: {{#pos:{{{editor}}}|resource}} |
* {{Link|{{TemplateCase|Arma Reforger:Resource Manager{{!}}Resource Manager|{{NAMESPACE}}:Resource Manager}}}}
}}{{#if: {{#pos:{{{editor}}}|world}} |
* {{Link|{{TemplateCase|Arma Reforger:World Editor{{!}}World Editor|{{NAMESPACE}}:World Editor}}}}
* {{Link|{{TemplateCase|Arma Reforger:World Editor{{!}}World Editor|{{NAMESPACE}}:World Editor}}}}
}}{{#if: {{#pos:{{{editor}}}|particle}} |
}}{{#if: {{#pos:{{{editor}}}|particle}} |
Line 36: Line 38:
{{!}} class="align-center" {{!}}
{{!}} class="align-center" {{!}}
{{#switch:{{lc:{{{editor}}}}}
{{#switch:{{lc:{{{editor}}}}}
|editor= {{Link|{{TemplateCase|Arma Reforger:Resource Manager{{!}}Resource Manager|{{NAMESPACE}}:Resource Manager}}}} plugin
|world= {{Link|{{TemplateCase|Arma Reforger:World Editor{{!}}World Editor|{{NAMESPACE}}:World Editor}}}} plugin
|world= {{Link|{{TemplateCase|Arma Reforger:World Editor{{!}}World Editor|{{NAMESPACE}}:World Editor}}}} plugin
|particle= {{Link|{{TemplateCase|Arma Reforger:Particle Editor{{!}}Particle Editor|{{NAMESPACE}}:Particle Editor}}}} plugin
|particle= {{Link|{{TemplateCase|Arma Reforger:Particle Editor{{!}}Particle Editor|{{NAMESPACE}}:Particle Editor}}}} plugin
Line 68: Line 71:
Its error category is {{Link|:Category:Infobox/WorkbenchPlugin template usage error|Infobox/WorkbenchPlugin template usage error}}.
Its error category is {{Link|:Category:Infobox/WorkbenchPlugin template usage error|Infobox/WorkbenchPlugin template usage error}}.
|param1= name=
|param1= name=
|descr1=
|descr1= the plugin's display name
|param2= descr=
|param2= editor=
|descr2= description of the plugin's usage and actions
|descr2= in which editors can this plugin be found - can be a multiple space-separated (case-insensitive) selection of:
|param3= editor=
|descr3= in which editors can this plugin be found - can be a multiple space-separated (case-insensitive) selection of:
<div style="margin-left: 2em">
<div style="margin-left: 2em">
{{Columns|4|
{{Columns|4|
* {{Link|Arma Reforger:Resource Manager|resource}}
* {{Link|Arma Reforger:World Editor|world}}
* {{Link|Arma Reforger:World Editor|world}}
* {{Link|Arma Reforger:Particle Editor|particle}}
* {{Link|Arma Reforger:Particle Editor|particle}}
Line 85: Line 87:
}}
}}
</div>
</div>
|param4= file=
|param3= descr=
|descr4= (Optional) the editor's file path - see {{Template|Link}}
|descr3= a short description of the plugin's role(s)
|param5= shortcut=
|param4= shortcut=
|descr5= (Optional) keyboard shortcut - see {{Template|Controls}}
|descr4= (Optional) keyboard shortcut - see {{Template|Controls}}
|param5= file=
|descr5= (Optional) the editor's file path - see {{Template|Link}}


|example1= <syntaxhighlight lang="handlebars">{{Infobox/WorkbenchPlugin}}</syntaxhighlight>
|example1= <syntaxhighlight lang="handlebars">{{Infobox/WorkbenchPlugin}}</syntaxhighlight>
Line 109: Line 113:
{{Infobox/WorkbenchPlugin
{{Infobox/WorkbenchPlugin
|name= My Plugin
|name= My Plugin
|editor= badvalue
|descr= plugin description
|descr= plugin description
|editor= badvalue
}}
}}
</syntaxhighlight>
</syntaxhighlight>
|result3= {{Infobox/WorkbenchPlugin
|result3= {{Infobox/WorkbenchPlugin
|name= My Plugin
|name= My Plugin
|editor= badvalue
|descr= plugin description
|descr= plugin description
|editor= badvalue
}}
}}


Line 122: Line 126:
{{Infobox/WorkbenchPlugin
{{Infobox/WorkbenchPlugin
|name= My Plugin
|name= My Plugin
|editor= bad value
|descr= plugin description
|descr= plugin description
|editor= bad value
}}
}}
</syntaxhighlight>
</syntaxhighlight>
|result4= {{Infobox/WorkbenchPlugin
|result4= {{Infobox/WorkbenchPlugin
|name= My Plugin
|name= My Plugin
|editor= bad value
|descr= plugin description
|descr= plugin description
|editor= bad value
}}
}}


Line 163: Line 167:
|editor= world particle animation script audio behavior string procanim
|editor= world particle animation script audio behavior string procanim
|descr= The Do Something plugin does something, as the name says.
|descr= The Do Something plugin does something, as the name says.
|file= {{Link|enfusion://ScriptEditor/scripts/WorkbenchGame/ScriptEditor/SCR_BasicCodeFormatterPlugin.c}}
|shortcut= <nowiki/>
|shortcut= <nowiki/>
# {{Controls|Ctrl|Alt|Del}} in {{Link|Arma Reforger:Script Editor|Script Editor}}
# {{Controls|Ctrl|Alt|Del}} in {{Link|Arma Reforger:Script Editor|Script Editor}}
# {{Controls|Ctrl|Shift|Del}} in {{Link|Arma Reforger:World Editor|World Editor}}
# {{Controls|Ctrl|Shift|Del}} in {{Link|Arma Reforger:World Editor|World Editor}}
|file= {{Link|enfusion://ScriptEditor/scripts/WorkbenchGame/ScriptEditor/SCR_BasicCodeFormatterPlugin.c}}
}}
}}
</syntaxhighlight>
</syntaxhighlight>
Line 174: Line 178:
|editor= world particle animation script audio behavior string procanim
|editor= world particle animation script audio behavior string procanim
|descr= The Do Something plugin does something, as the name says.
|descr= The Do Something plugin does something, as the name says.
|file= {{Link|enfusion://ScriptEditor/scripts/WorkbenchGame/ScriptEditor/SCR_BasicCodeFormatterPlugin.c}}
|shortcut= <nowiki/>
|shortcut= <nowiki/>
# {{Controls|Ctrl|Alt|Del}} in {{Link|Arma Reforger:Script Editor|Script Editor}}
# {{Controls|Ctrl|Alt|Del}} in {{Link|Arma Reforger:Script Editor|Script Editor}}
# {{Controls|Ctrl|Shift|Del}} in {{Link|Arma Reforger:World Editor|World Editor}}
# {{Controls|Ctrl|Shift|Del}} in {{Link|Arma Reforger:World Editor|World Editor}}
|file= {{Link|enfusion://ScriptEditor/scripts/WorkbenchGame/ScriptEditor/SCR_BasicCodeFormatterPlugin.c}}
}}
}}


}}</noinclude>
}}</noinclude>

Latest revision as of 19:22, 15 February 2024

Create an infobox for a Workbench Editor plugin.

All parameters are named.

Its error category is Infobox/WorkbenchPlugin template usage error.

This template is used on these pages.

Usage

{{Infobox/WorkbenchPlugin|name=|editor=|descr=|shortcut=|file=}}

  • name=: the plugin's display name
  • editor=: in which editors can this plugin be found - can be a multiple space-separated (case-insensitive) selection of:
  • descr=: a short description of the plugin's role(s)
  • shortcut=: (Optional) keyboard shortcut - see {{Controls}}
  • file=: (Optional) the editor's file path - see {{Link}}
Examples
Code Result
{{Infobox/WorkbenchPlugin}}

-no name provided!-

-no editor provided!-

-no description provided!-

{{Infobox/WorkbenchPlugin
|name= My Plugin
|editor= script
|file=
}}

My Plugin

Script Editor plugin

-no description provided!-

{{Infobox/WorkbenchPlugin
|name= My Plugin
|editor= badvalue
|descr= plugin description
}}

My Plugin

-bad editor "badvalue" provided!-

plugin description

{{Infobox/WorkbenchPlugin
|name= My Plugin
|editor= bad value
|descr= plugin description
}}

My Plugin

-bad editors "bad value" provided!-

plugin description

{{Infobox/WorkbenchPlugin
|name= Basic Code Formatter
|editor= script
|descr= The Basic Code Formatter is a plugin that helps formatting code properly. Use is this way:
* Shortcut 1 to scan edited lines in the currently-opened file (or in a whole addon, depending on options)
* Shortcut 2 to scan '''all''' the lines in the currently-opened file (not depending on options)
|file= {{Link|enfusion://ScriptEditor/scripts/WorkbenchGame/ScriptEditor/SCR_BasicCodeFormatterPlugin.c}}
|shortcut= <nowiki/>
# {{Controls|Ctrl|Shift|K}}
# {{Controls|Ctrl|Alt|Shift|K}}
}}

Basic Code Formatter

Script Editor plugin

  1. Ctrl + ⇧ Shift + K
  2. Ctrl + Alt + ⇧ Shift + K

The Basic Code Formatter is a plugin that helps formatting code properly. Use is this way:

  • Shortcut 1 to scan edited lines in the currently-opened file (or in a whole addon, depending on options)
  • Shortcut 2 to scan all the lines in the currently-opened file (not depending on options)

File: SCR_BasicCodeFormatterPlugin.c

{{Infobox/WorkbenchPlugin
|name= Do Something
|editor= world particle animation script audio behavior string procanim
|descr= The Do Something plugin does something, as the name says.
|shortcut= <nowiki/>
# {{Controls|Ctrl|Alt|Del}} in {{Link|Arma Reforger:Script Editor|Script Editor}}
# {{Controls|Ctrl|Shift|Del}} in {{Link|Arma Reforger:World Editor|World Editor}}
|file= {{Link|enfusion://ScriptEditor/scripts/WorkbenchGame/ScriptEditor/SCR_BasicCodeFormatterPlugin.c}}
}}

Do Something

This plugin is available in:

  1. Ctrl + Alt + Del in Script Editor
  2. Ctrl + ⇧ Shift + Del in World Editor

The Do Something plugin does something, as the name says.

File: SCR_BasicCodeFormatterPlugin.c