Template:PluginInfo

File:Labrps.svg Plugin
Name
{{{Name}}}
Phenomenon
{{{Phenomenon}}}
Release Date
{{{Date}}}
Authors
{{{Author}}}
Version
{{{Version}}}
RPS version
{{{RPSVersion}}}
Files
None
See also
None

Usage

This template is the main tool to document plugins. It should be inserted in documentation pages. See the sample on the right.

File:Labrps.svg Plugin
Name
{{{Name}}}
Phenomenon
Stochastic wind
Release Date
01/01/2023
Authors
Nickname (Link to forum profile or other)
Version
1
RPS version
0.001
Files
Some_file.rar (Github link or other)
See also
Tool

|Topic=SampleName
|Phenomenon=Stochastic wind 
|Date=01/01/2023
|Author=Nickname (Link to forum profile or other)
|Version = 1
|RPSVersion=0.001
|Files=Some_file.rar (Github link or other)
|SeeAlso=[[GuiCommand_model|Tool]]
}}

Parameters are specified with values after the equals sign: parameter=value.

The required parameters are:

|Topic=SampleName
|Phenomenon=Stochastic wind 
|Date=01/01/2023
|Author=Nickname (Link to forum profile or other)
|Version = 1
|RPSVersion=0.001
}}

Other parameters may be omitted or their value left empty.

Required parameters

The following parameters are required.

Name

The name of the plugin, for example: windLab.

Phenomenon

The random phenomenon for which the plugin has been developed. Example: Stochastic Wind Velocity.

Version

The version of the plugin.

RPSVersion

The LabRPS version used in the development of this plugin. Preferably, this should be the current stable version for which the plugin has been successfuly tested.

Optional Parameters

The following parameters are optional. If they are not included in the template, they will default to Not provided or None.

Files

Optional link to plugin files. Use an appropriate repository (GitHub).

See Also

Optional links to other related commands, for example, SeeAlso=[[Some Tool|Tool]].