Template:TutorialInfo
Jump to navigation
Jump to search
| File:Labrps.svg Tutorial |
| Topic |
|---|
| {{{Topic}}} |
| Level |
| {{{Level}}} |
| Time to complete |
| Not provided |
| Authors |
| Not provided |
| Product version |
| {{{RPSVersion}}} |
| Example files |
| None |
| See also |
| None |
Usage
This template is the main tool to document tutorials. It should be inserted in documentation pages. See the sample on the right.
| File:Labrps.svg Tutorial |
| Topic |
|---|
| SampleTopic |
| Level |
| Beginner |
| Time to complete |
| Two hours |
| Authors |
| Nickname (Link to forum profile or other) |
| Product version |
| 0.001 |
| Example files |
| Some_file.rps (Github link or other) |
| See also |
| Tool |
{{TutorialInfo
|Topic=SampleTopic
|Level=Beginner
|Time=Two hours
|Author=Nickname (Link to forum profile or other)
|RPSVersion=0.001
|Files=Some_file.rps (Github link or other)
}}
Parameters are specified with values after the equals sign: parameter=value.
The required parameters are:
{{TutorialInfo
|Topic=SampleTopic
|Level=Beginner
|RPSVersion=0.001
}}
Other parameters may be omitted or their value left empty.
Required parameters
The following parameters are required.
- Topic
- The subcategory of this tutorial, for example: Implementation of Kaimal Spectrum Model.
- Level
- Experience level required to complete this tutorial: Beginner, Intermediate or Advanced.
- RPSVersion
- The Product version used in the creation of this tutorial. Preferably, this should be the current stable version at the moment of writing.
Optional Parameters
The following parameters are optional. If they are not included in the template, they will default to Not provided or None.
- Time
- The approximate time required to complete the tutorial.
- Author
- The author of the tutorial. A link to the author's wiki or forum profile page will allow visitors to get in touch with questions or comments.
- 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]].
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.