Template:PluginInfo: Difference between revisions
Jump to navigation
Jump to search
BathAfrica (talk | contribs) m 2 revisions imported: Full 75-template migration with source revision history from wiki.sybma.com |
BathAfrica (talk | contribs) m 1 revision imported: Make tested BathAfrica compatibility revisions current |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 22: | Line 22: | ||
| class="ctEven"|{{{Version}}} | | class="ctEven"|{{{Version}}} | ||
|- | |- | ||
! class="ctOdd"| | ! class="ctOdd"|Product version | ||
|- | |- | ||
| class="ctEven"|{{{RPSVersion}}} | | class="ctEven"|{{{RPSVersion}}} | ||
| Line 93: | Line 93: | ||
: The version of the plugin. | : The version of the plugin. | ||
;RPSVersion | ;RPSVersion | ||
: The | : The Product 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=== | ===Optional Parameters=== | ||
| Line 107: | Line 107: | ||
[[Category:Template]] | [[Category:Template]] | ||
</noinclude><!-- Note to editors: Do Not Remove This Tag. --> | </noinclude><!-- Note to editors: Do Not Remove This Tag. --> | ||
<noinclude> | |||
---- | |||
Migrated from [https://wiki.sybma.com/index.php?title=Template:PluginInfo SiteMasterDoc]. Original revision history and imported contributor names are retained. See [[BathAfrica:Template migration]] for compatibility changes and unresolved image dependencies. Legacy examples do not establish current BathAfrica product capabilities. | |||
</noinclude> | |||
Latest revision as of 07:18, 29 October 2026
| File:Labrps.svg Plugin |
| Name |
|---|
| {{{Name}}} |
| Phenomenon |
| {{{Phenomenon}}} |
| Release Date |
| {{{Date}}} |
| Authors |
| {{{Author}}} |
| Version |
| {{{Version}}} |
| Product 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 |
| Product 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 Product 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]].
Migrated from SiteMasterDoc. Original revision history and imported contributor names are retained. See BathAfrica:Template migration for compatibility changes and unresolved image dependencies. Legacy examples do not establish current BathAfrica product capabilities.