Template:RPSObjectInfo
Jump to navigation
Jump to search
 RPS Object
|
| Group |
|---|
| {{{Group}}} |
| Name |
| {{{Name}}} |
| Plugin |
| {{{Plugin}}} |
| Release Date |
| {{{Date}}} |
| Authors |
| {{{Author}}} |
| Version |
| {{{Version}}} |
| API version |
| {{{APIVersion}}} |
| LabRPS version |
| {{{RPSVersion}}} |
| Plugin version |
| {{{PluginVersion}}} |
| Publication topic |
| {{{PublicationTopic}}} |
| Link to publication |
| {{{LinkToPublication}}} |
| Publication date |
| {{{PublicationDate}}} |
| Publication authors |
| {{{PublicationAuthor}}} |
| Example files |
| None |
| See also |
| None |
Usage
This template is the main tool to document RPS objects. It should be inserted in documentation pages. See the sample on the right.
| RPS Object
|
| Group |
|---|
| The group |
| Name |
| SampleName |
| Plugin |
| SamplePlugin |
| Release Date |
| 01/01/2022 |
| Authors |
| LabRPS Team |
| Version |
| 1 |
| API version |
| 0.001 |
| LabRPS version |
| 0.001 |
| Plugin version |
| 1 |
| Publication topic |
| SamplePublicationTopic |
| Link to publication |
| SampleLinkToPublication |
| Publication date |
| 01/01/1887 |
| Publication authors |
| SamplePublicationAuthor |
| Example files |
| Some_file.rar (Github link or other) |
| See also |
| Tool |
{{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]]
}}
Parameters are specified with values after the equals sign: parameter=value.
The required parameters are:
{{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
}}
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 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.
- 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]
- 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,
SeeAlso=[[Some Tool|Tool]].