Template:Plugin
Jump to navigation
Jump to search
|
|
| Description |
|---|
| {{{Description}}} |
| Author |
| [[User:{{{Author}}}|{{{Author}}}]] |
| Download |
| None |
| Features |
| None |
| Plugin Version |
| 1.0 |
| Date last modified |
| None |
| LabRPS Version(s) |
| None |
| Default shortcut |
| None |
| See also |
| None |
This template is the main tool to document plugins. It should be inserted as the first line in documentation pages. See a sample to the right.
|
|
| Description |
|---|
| This plugin improves the solid shapes in all ways. Plugin version: 1.0 Last modified: 2018-11-20 Author: WikiUserName |
| Author |
| WikiUserName |
| Download |
| None |
| Features |
| None |
| Plugin Version |
| 1.0 |
| Date last modified |
| 2018-11-20 |
| LabRPS Version(s) |
| None |
| Default shortcut |
| None |
| See also |
| None |
{{Plugin
|Name=SomePlugin
|Description=This plugin improves the solid shapes in all ways.
|Author=WikiUserName
|Download=[https://wiki.labrps.com/images/2/2c/Text-x-python.png Text-x-python.png]
|Version=1.0
|Date=2018-11-20
}}
The required parameters are:
{{Plugin
|Name=SomePlugin
|Description=This plugin improves the solid shapes in all ways.
|Author=WikiUserName
|Download=Possible files to download, example the icon toolBar ...
|Date=2018-11-20
|Version=1.0
|RPSVersion= 0.1.0
}}
Other parameters may be omitted or their value left empty.
Required parameters
Parameters are specified with its value after the equals sign, parameter=value.
Each parameter in the list is separated by a pipe symbol |.
|... |Name=SomePlugin|Author=WikiUserName| ...
Parameters can be placed in the same line, or each in a separate line.
|... |Name=SomePlugin |Author=WikiUserName | ...
The following parameters are required.
- Name
- The properly capitalized name of the plugin to be documented.
- The name is used to retrieve the icon graphic
Name.svgorName.pngfrom the wiki repository. The template works properly if the icon does not exist; in this case, a generic icon
is displayed. - Description
- A description for the plugin, this description will be displayed in Addon manager.
- Author
- The author of the plugin. This name is linked to the user's page in the wiki, that is, User:Author. Since plugins are not part of the official LabRPS code, users should direct their questions about them to their particular creators. The author of a plugin should be reachable in the [1], with the same username as in the wiki.
- Download
- Possible files to download, example the icon toolBar and other file. Give the complete link of the object ex:
Download=[https://wiki.labrps.com/images/2/2c/Text-x-python.png Text-x-python.png] - Date
- All plugins must have a date. This is helpful to indicate the last time the plugin was modified, and warn the user of the age of the code. Plugins that are very old may be obsolete and may not work with a recent version of LabRPS.
- RPSVersion
- LabRPS version(s) to run the plugin example:
RPSVersion=0.1.0
Optional Parameters
The following parameters are optional. If they are not included in the template, they will display a default value.
- Features
- Other help link for the plugin example Video, Tutorials page related on the plugin.
- Version
- The version of the plugin. If no value is given, it will default to
1.0. This is helpful for authors, so that they can document particular versions of their own plugins. - Shortcut
- Some plugins may introduce shortcuts to launch specific tools. Indicate the shortcut buttons to press with this value. If no value is given, it will default to None.
- SeeAlso
- Features implemented in this plugin, for example,
SeeAlso=[[Some Tool|Tool]]. - Icon
- An image file different from
Name.svgorName.pngto use as icon. This can be used to include a specific icon that is not named after the command, for example,Icon=Some_other_name.svg