LabRPS at 11:50, 19 April 2024

2024-04-19T11:50:51Z

← Older revision		Revision as of 04:50, 19 April 2024
Line 36:		Line 36:
	\| class="ctToc"\|<br>__TOC__		\| class="ctToc"\|<br>__TOC__
	\|}		\|}
	<noinclude><!-- Note to editors: Do Not Remove This Tag. -->		[[Category:Plugins]]<noinclude><!-- Note to editors: Do Not Remove This Tag. -->

	==Usage==		==Usage==

LabRPS at 11:46, 19 April 2024

2024-04-19T11:46:59Z

← Older revision		Revision as of 04:46, 19 April 2024
Line 36:		Line 36:
	\| class="ctToc"\|<br>__TOC__		\| class="ctToc"\|<br>__TOC__
	\|}		\|}
	~~[[Category:Plugins]]~~<noinclude><!-- Note to editors: Do Not Remove This Tag. -->		<noinclude><!-- Note to editors: Do Not Remove This Tag. -->

	==Usage==		==Usage==

LabRPS at 15:37, 20 August 2022

2022-08-20T15:37:59Z

← Older revision		Revision as of 08:37, 20 August 2022
Line 1:		Line 1:
	{\|class="fcinfobox wikitable ct" height=100% style="width: 230px; float: right; margin-left: 1em" \|		{\|class="fcinfobox wikitable ct" height=100% style="width: 230px; float: right; margin-left: 1em" \|
	\| class="ctTitle" style="font-weight: bold; font-size: 125%;" \| [[File:labrps.svg\|32px\|link=]] ~~Tutorial~~		\| class="ctTitle" style="font-weight: bold; font-size: 125%;" \| [[File:labrps.svg\|32px\|link=]] Plugin
	\|-		\|-
	! class="ctOdd"\|Name		! class="ctOdd"\|Name

LabRPS: Created page with "{|class="fcinfobox wikitable ct" height=100% style="width: 230px; float: right; margin-left: 1em" | | class="ctTitle" style="font-weight: bold; font-size: 125%;" | link= Tutorial |- ! class="ctOdd"|Name |- | class="ctEven"|{{{Name}}} |- ! class="ctOdd"|Phenomenon |- | class="ctEven"|{{{Phenomenon}}} |- ! class="ctOdd"|Release Date |- | class="ctEven"|{{{Date}}} |- ! class="ctOdd"|Authors |- | class="ctEven"|{{{Au..."

2022-08-20T15:35:12Z

Created page with "{|class="fcinfobox wikitable ct" height=100% style="width: 230px; float: right; margin-left: 1em" | | class="ctTitle" style="font-weight: bold; font-size: 125%;" | 32px|link= Tutorial |- ! class="ctOdd"|Name |- | class="ctEven"|{{{Name}}} |- ! class="ctOdd"|Phenomenon |- | class="ctEven"|{{{Phenomenon}}} |- ! class="ctOdd"|Release Date |- | class="ctEven"|{{{Date}}} |- ! class="ctOdd"|Authors |- | class="ctEven"|{{{Au..."

New page

{|class="fcinfobox wikitable ct" height=100% style="width: 230px; float: right; margin-left: 1em" |
| class="ctTitle" style="font-weight: bold; font-size: 125%;" | [[File:labrps.svg|32px|link=]] Tutorial
|-
! class="ctOdd"|Name
|-
| class="ctEven"|{{{Name}}}
|-
! class="ctOdd"|Phenomenon
|-
| class="ctEven"|{{{Phenomenon}}}
|-
! class="ctOdd"|Release Date
|-
| class="ctEven"|{{{Date}}}
|-
! class="ctOdd"|Authors
|-
| class="ctEven"|{{{Author}}}
|-
! class="ctOdd"|Version
|-
| class="ctEven"|{{{Version}}}
|-
! class="ctOdd"|RPS version
|-
| class="ctEven"|{{{RPSVersion}}}
|-
! class="ctOdd"|Files
|-
| class="ctEven"|{{{Files|''None''}}}
|-
! class="ctOdd"|See also
|-
| class="ctEven"|{{{SeeAlso|''None''}}}
|-
| class="ctToc"|<br>__TOC__
|}
[[Category:Plugins]]<noinclude>

==Usage==

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

{{PluginInfo
|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]]
}}

<pre>
|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]]
}}
</pre>

Parameters are specified with values after the equals sign: <code>parameter=value</code>.

The required parameters are:

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

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, <code><nowiki>SeeAlso=[[Some Tool|Tool]]</nowiki></code>.

[[Category:Template:Doc]]
[[Category:Template]]
</noinclude>

Template:PluginInfo - Revision history

LabRPS at 11:50, 19 April 2024

LabRPS at 11:46, 19 April 2024

LabRPS at 15:37, 20 August 2022