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= RPS Object |- ! class="ctOdd"|Group |- | class="ctEven"|{{{Group}}} |- ! class="ctOdd"|Name |- | class="ctEven"|{{{Name}}} |- ! class="ctOdd"|Plugin |- | class="ctEven"|{{{Plugin}}} |- ! class="ctOdd"|Release Date |- | class="ctEven"|{{{Date}}}..."

2022-08-20T16:40:09Z

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= RPS Object |- ! class="ctOdd"|Group |- | class="ctEven"|{{{Group}}} |- ! class="ctOdd"|Name |- | class="ctEven"|{{{Name}}} |- ! class="ctOdd"|Plugin |- | class="ctEven"|{{{Plugin}}} |- ! class="ctOdd"|Release Date |- | class="ctEven"|{{{Date}}}..."

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=]] RPS Object
|-
! class="ctOdd"|Group
|-
| class="ctEven"|{{{Group}}}
|-
! class="ctOdd"|Name
|-
| class="ctEven"|{{{Name}}}
|-
! class="ctOdd"|Plugin
|-
| class="ctEven"|{{{Plugin}}}
|-
! class="ctOdd"|Release Date
|-
| class="ctEven"|{{{Date}}}
|-
! class="ctOdd"|Authors
|-
| class="ctEven"|{{{Author}}}
|-
! class="ctOdd"|Version
|-
| class="ctEven"|{{{Version}}}
|-
! class="ctOdd"|API version
|-
| class="ctEven"|{{{APIVersion}}}
|-
! class="ctOdd"|LabRPS version
|-
| class="ctEven"|{{{RPSVersion}}}
|-
! class="ctOdd"|Plugin version
|-
| class="ctEven"|{{{PluginVersion}}}
|-
! class="ctOdd"|Publication topic
|-
| class="ctEven"|{{{PublicationTopic}}}
|-
! class="ctOdd"|Link to publication
|-
| class="ctEven"|{{{LinkToPublication}}}
|-
! class="ctOdd"|Publication date
|-
| class="ctEven"|{{{PublicationDate}}}
|-
! class="ctOdd"|Publication authors
|-
| class="ctEven"|{{{PublicationAuthor}}}
|-
! class="ctOdd"|Example files
|-
| class="ctEven"|{{{Files|''None''}}}
|-
! class="ctOdd"|See also
|-
| class="ctEven"|{{{SeeAlso|''None''}}}
|-
| class="ctToc"|<br>__TOC__
|}
[[Category:RPS Objects]]<noinclude>

==Usage==

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

{{RPSObjectInfo
|Group=The group
|Name=SampleName
|Plugin=SamplePlugin
|Date=01/01/2022
|Author=LabRPS Team
|Version=1
|APIVersion=0.001
|RPSVersion=0.001
|PluginVersion=1
|PublicationTopic=SamplePublicationTopic
|LinkToPublication=SampleLinkToPublication
|PublicationDate=01/01/1887
|PublicationAuthor=SamplePublicationAuthor
|Files=Some_file.rar (Github link or other)
|SeeAlso=[[GuiCommand_model|Tool]]
}}

<pre>
{{RPSObjectInfo
|Group=The group
|Name=SampleName
|Plugin=SamplePlugin
|Date=01/01/2022
|Author=LabRPS Team
|Version=1
|APIVersion=0.001
|RPSVersion=0.001
|PluginVersion=1
|PublicationTopic=SamplePublicationTopic
|LinkToPublication=SampleLinkToPublication
|PublicationDate=01/01/1887
|PublicationAuthor=SamplePublicationAuthor
|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>
{{RPSObjectInfo
|Group=The group
|Name=SampleName
|Plugin=SamplePlugin
|Date=01/01/2022
|Author=LabRPS Team
|Version=1
|APIVersion=0.001
|RPSVersion=0.001
|PluginVersion=1
|PublicationTopic=SamplePublicationTopic
|LinkToPublication=SampleLinkToPublication
|PublicationDate=01/01/1887
|PublicationAuthor=SamplePublicationAuthor
}}
</pre>

Other parameters may be omitted or their value left empty.

===Required parameters===

The following parameters are required.

;Group
: The group the object belongs to. Example: Spectrum model. Please, find [[RPS_Object_Groups|here]] the list of all available RPS object groups.
;Name
: The name of the object. Example Kaimal Spectrum Model.
;Plugin
: The name of the plugin that implements the object. Make it as a link to the plugin page. Example: [[windLab_Plugin|windLab]].
;Date
: The release date of the plugin
;Author
: The name of the contributors to the implementation of the object. A link to the author's wiki or forum profile page will allow visitors to get in touch with questions or comments.
;Version
: The version of the object
;APIVersion
: The version of the API used
;RPSVersion
: The version of LabRPS the object is successfuly tested with.
;PluginVersion
: The version of the plugin that implements the object
;PublicationTopic
: The topic of publication paper where the object was proposed. Example: An efficient simulation method for vertically distributed stochastic wind velocity field based on approximate piecewise wind spectrum
;LinkToPublication
: The link to that publication paper. Example: [[https://doi.org/10.1016/j.jweia.2016.01.005 https://doi.org/10.1016/j.jweia.2016.01.005]]
;PublicationDate
: The date of the publication paper. Example: 10 February 2016
;PublicationAuthor
: The authors of the paper. Example: Koffi Togbenou et al.

===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 example 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:RPSObjectInfo - Revision history