Difference between revisions of "Template:TutorialInfo"

From FreeCAD Documentation
Jump to: navigation, search
m (correct "Localisation#Translate_the_FreeCAD_wiki")
Line 95: Line 95:
 
==Localization==
 
==Localization==
  
The code required for this template is different if you are using a localized version. For more information see the [[Localisation#Translating_the_wiki|Localization]] page.  
+
The code required for this template is different if you are using a localized version. For more information see the [[Localisation#Translate_the_FreeCAD_wiki|Localization]] page.  
  
 
First, a localized version of this template must exist or be created.  
 
First, a localized version of this template must exist or be created.  

Revision as of 12:00, 9 November 2019

Base ExampleCommandModel.png Tutorial
Topic
{{{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.

Base ExampleCommandModel.png Tutorial
Topic
SampleTopic
Level
Beginner
Time to complete
Two hours
Author(s)
Nickname (Link to forum profile or other)
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=Nickname (Link to forum profile or other)
|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 or her with questions or comments.
Files
Optional link to example files. Use an appropriate repository (GitHub or CADinet), see forum discussion.

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.

Template:TutorialInfo/AA

where /AA is the 2 letter code for the desired language, for example /fr indicates French. This are the ISO 639-1 language codes, not country codes.

The method for calling the localized TutorialInfo template is:

{{TutorialInfo/AA
|Topic=SampleTopic
|Level=Beginner
|FCVersion=>=0.17}}

Some templates: fr, it, es, pt, pt-br, de, pl, ro, bg, cs, sk, sr, hr, ru, kk, sv, no, da, fi, nl, el, hu, tr, uk, id, ja, ko, zh, zh-cn, zw-th