Infobox/WorkbenchPlugin – Template

From Bohemia Interactive Community
Revision as of 18:22, 15 February 2024 by Lou Montana (talk | contribs) (Fix example)
Jump to navigation Jump to search

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