Template:TutorialInfo: Difference between revisions

From FreeCAD Documentation
(+ Category:Template + Tutorial)
mNo edit summary
Line 60: Line 60:
* Make sure you add the localized version of this template to the Languages list below.
* Make sure you add the localized version of this template to the Languages list below.


[[Category:Template/it]]
[[Category:Template]]
[[Category:Tutorials/it]]
[[Category:Tutorials]]


</noinclude> <!-- Note to editors: This must be the last line of the Template. Do Not Remove This Line. -->
</noinclude> <!-- Note to editors: This must be the last line of the Template. Do Not Remove This Line. -->

Revision as of 12:42, 18 October 2014

Tutorial

Class
{{{Class}}}
Level
{{{Level}}}
Time to complete
Not provided
Author
Not provided
FreeCAD version
0.14.3700 or greater
Example File(s)
None


Usage

This Template is the main anchor on documenting Tutorials. It should be inserted as the first line in new documents.

The minimum code required for this template usage is: (sample result to right)

{{TutorialInfo|Class=SampleClass|Level=Beginner|FCVersion=0.14.3700 or greater}}

Tutorial

Class
SampleClass
Level
Beginner
Time to complete
Not provided
Author
Not provided
FreeCAD version
0.14.3700 or greater
Example File(s)
None


Minimum Parameters

The following parameters are used in the format [parameter]=[value], with each parameter in the list separated by a pipe symbol (|):

Class
The subcategory of this tutorial. Proposed classes are: 2D Drafting, Modeling, Rendering.
Level
Experience level required to complete this tutorial: Beginner, Intermediate, Advanced.
FCVersion
The FreeCAD version used in the creation of this tutorial. 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

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|Class=SampleClass|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.