Template:TutorialInfo
Tutorial |
Topic |
---|
{{{Topic}}} |
Level |
{{{Level}}} |
Time to complete |
Not provided |
Authors |
Not provided |
FreeCAD version |
{{{FCVersion}}} |
Example files |
None |
See also |
None |
Usage
This template is the main tool to document tutorials. It should be inserted in documentation pages right after the <languages/>
and <translate>
tags.
See the sample on the right.
Tutorial |
Topic |
---|
SampleTopic |
Level |
Beginner |
Time to complete |
Two hours |
Authors |
Nickname (Link to forum profile or other) |
FreeCAD version |
0.17 |
Example files |
Some_file.fcstd (Github link or other) |
See also |
Tool |
{{TutorialInfo |Topic=SampleTopic |Level=Beginner |Time=Two hours |Author=Nickname (Link to forum profile or other) |FCVersion=0.17 |Files=Some_file.fcstd (Github link or other) }}
Parameters are specified with values after the equals sign: parameter=value
.
The required parameters are:
{{TutorialInfo |Topic=SampleTopic |Level=Beginner |FCVersion=0.17 }}
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: 2D Drafting, Modeling, Rendering or Architecture.
- Level
- Experience level required to complete this tutorial: Beginner, Intermediate or Advanced.
- FCVersion
- The FreeCAD 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 or CADinet), see forum discussion.
- See Also
- Optional links to other related commands, for example,
SeeAlso=[[Some Tool|Tool]]
.
Localization
The code required for this template is different if you are using a localized version. For more information see the Localization page.
First, a localized version of this template must exist or be created.
The localized template must be named:
Template:TutorialInfo/AA
where /AA
is the letter code for the desired language, for example /fr
indicates French. These are the ISO 639-1 language codes, and not country codes.
The method for calling the localized TutorialInfo template is:
{{TutorialInfo/AA |Topic=SampleTopic |Level=Beginner |FCVersion=>=0.17}}