Template:TutorialInfo: Difference between revisions

Revision as of 18:54, 21 November 2018

Topic
Tutorial
{{{Topic}}}
Level
{{{Level}}}
Time to complete
Not provided
Author
Not provided
FreeCAD version
{{{FCVersion}}}
Example files
None

Usage

This template is the main tool to document tutorials. It should be inserted as the first line in documentation pages, after the <languages/> and <translate> tags. See a sample to the right.

Topic
Tutorial
SampleTopic
Level
Beginner
Time to complete
Two hours
Author
Vocx
FreeCAD version
0.17
Example files
Some_file.fcstd (Github link or other)

{{TutorialInfo
|Topic=SampleTopic
|Level=Beginner
|FCVersion=0.17
|Time=Two hours
|Author=Vocx
|Files=Some_file.fcstd (Github link or other)
}}

The required parameters are:

{{TutorialInfo
|Topic=SampleTopic
|Level=Beginner
|FCVersion=0.17
}}

Other parameters may be omitted or their value left empty.

Required parameters

Parameters are specified with its value after the equals sign, parameter=value.

Each parameter in the list is separated by a pipe symbol |.

|... |Topic=SampleTopic|Level=Beginner| ...

Parameters can be placed in the same line, or each in a separate line.

|...
|Topic=SampleTopic
|Level=Beginner
| ...

The following parameters are required.

Topic: The subcategory of this tutorial, for example: 2D Drafting, Modeling, Rendering, Architecture.
Level: Experience level required to complete this tutorial: Beginner, Intermediate, 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 code, they will default to a value of "None".

Time: The approximate time required to complete the tutorial.
Author: Author of the tutorial. A link to the author's wiki or forum profile page will allow visitors to reach him/her with questions or comments.
Files: Optional link to example files. An appropriate repository needs to be determined (GitHub or CADinet, see forum discussion

Full code

Empty:

{{TutorialInfo
|Topic=
|Level=
|Time=
|Author=
|FCVersion=
|Files=
}}

Prefilled, keep the right option

{{TutorialInfo
|Topic=2D Drafting/Modeling/Rendering
|Level=Beginner/Intermediate/Advanced
|Time=
|Author=
|FCVersion=
|Files=
}}

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 2 letter code for the desired language, for example /fr = French localization.
The method for calling the localized TutorialInfo template in a Tutorial document is:
```
{{TutorialInfo/AA|Topic=SampleTopic|Level=Beginner|FCVersion=>=0.14.3700}}
```
where /AA is the 2 letter code for the desired language, for example /fr = French localization.
Make sure you add the localized version of this template to the Languages list below.

@@ Line 64: / Line 64: @@
 Other parameters may be omitted or their value left empty.
-===Minimum Parameters===
+===Required parameters===
+Parameters are specified with its value after the equals sign, <code>parameter=value</code>.
-The following parameters are used in the format [parameter]=[value], with each parameter in the list separated by a pipe symbol (|):
-;Topic : The subcategory of this tutorial. Proposed topics are: 2D Drafting, Modeling, Rendering.
+Each parameter in the list is separated by a pipe symbol <code>|</code>.
-;Level : Experience level required to complete this tutorial: Beginner, Intermediate, Advanced.
+ <nowiki>|... |Topic=SampleTopic|Level=Beginner| ...</nowiki>
-;FCVersion : The FreeCAD version used in the creation of this tutorial. This should be the current stable version at the moment of writing.
+Parameters can be placed in the same line, or each in a separate line.
+ <nowiki>|...
+|Topic=SampleTopic
+|Level=Beginner
+| ...</nowiki>
+The following parameters are required.
+;Topic
+: The subcategory of this tutorial, for example: 2D Drafting, Modeling, Rendering, Architecture.
+;Level
+: Experience level required to complete this tutorial: Beginner, Intermediate, 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===