Template:TutorialInfo: Difference between revisions

From FreeCAD Documentation
(Removed Command Reference and User Documentation categories)
m (Author to Author(s))
(31 intermediate revisions by 8 users not shown)
Line 1: Line 1:
{|class="wikitable ct" width=100% height=100% style="float: right; width: 230px; margin-left: 1em" |
{|class="fcinfobox wikitable ct" height=100% style="width: 230px; float: right; margin-left: 1em" |
| class="ctTitle" style="font-weight: bold; font-size: 125%;" | [[File:Base_ExampleCommandModel.png|32px]] Tutorial
| class="ctTitle"|
=== [[File:Base_ExampleCommandModel.png|32px]] Tutorial ===
|-
|-
! class="ctOdd"|Class
! class="ctOdd"|Topic
|-
|-
| class="ctEven"|{{{Class}}}
| class="ctEven"|{{{Topic}}}
|-
|-
! class="ctOdd"|Level
! class="ctOdd"|Level
Line 13: Line 12:
! class="ctOdd"|Time to complete
! class="ctOdd"|Time to complete
|-
|-
| class="ctEven"|{{{Time|Not provided}}}
| class="ctEven"|{{{Time|''Not provided''}}}
|-
|-
! class="ctOdd"|Author
! class="ctOdd"|Author(s)
|-
|-
| class="ctEven"|{{{Author|Not provided}}}
| class="ctEven"|{{{Author|''Not provided''}}}
|-
|-
! class="ctOdd"|FreeCAD version
! class="ctOdd"|FreeCAD version
|-
|-
| class="ctEven"|{{{FCVersion|0.14.3700 or greater}}}
| class="ctEven"|{{{FCVersion}}}
|-
|-
! class="ctOdd"|Example File(s)
! class="ctOdd"|Example files
|-
|-
| class="ctEven"|{{{Files|None}}}
| class="ctEven"|{{{Files|''None''}}}
|-
|-
| class="ctToc"|<br/>__TOC__
| class="ctToc"|<br/>__TOC__
|}
|}
[[Category:Tutorials]]
[[Category:User Documentation]]


<noinclude> <!-- Note to editors: Do Not Remove This Line. -->
<noinclude> <!-- Note to editors: Do Not Remove This Line. -->


==Usage==
==Usage==
This Template is the main anchor on documenting Tutorials. It should be inserted as the first line in new documents.
This template is the main tool to document tutorials. It should be inserted as the first line in documentation pages, after the <nowiki><languages/></nowiki> and <nowiki><translate></nowiki> tags.
See a sample to the right.


{{TutorialInfo
The minimum code required for this template usage is: (sample result to right)
|Topic=SampleTopic
<pre>{{TutorialInfo|Class=SampleClass|Level=Beginner|FCVersion=0.14.3700 or greater}}</pre>
|Level=Beginner
{{TutorialInfo|Class=SampleClass|Level=Beginner|FCVersion=0.14.3700 or greater}}
|FCVersion=0.17
|Time=Two hours
|Author=Nickname (Link to forum profile or other)
|Files=Some_file.fcstd (Github link or other)
}}


<nowiki>{{TutorialInfo
===Minimum Parameters===
|Topic=SampleTopic
The following parameters are used in the format [parameter]=[value], with each parameter in the list separated by a pipe symbol (|):
|Level=Beginner
;Class : The subcategory of this tutorial. Proposed classes are: 2D Drafting, Modeling, Rendering.
|FCVersion=0.17
;Level : Experience level required to complete this tutorial: Beginner, Intermediate, Advanced.
|Time=Two hours
;FCVersion : The FreeCAD version used in the creation of this tutorial. This should be the current stable version at the moment of writing.
|Author=Nickname (Link to forum profile or other)
|Files=Some_file.fcstd (Github link or other)
}}</nowiki>

The required parameters are:
<nowiki>{{TutorialInfo
|Topic=SampleTopic
|Level=Beginner
|FCVersion=0.17
}}</nowiki>

Other parameters may be omitted or their value left empty.

===Required parameters===
Parameters are specified with its value after the equals sign, <code>parameter=value</code>.

Each parameter in the list is separated by a pipe symbol <code>|</code>.
<nowiki>|... |Topic=SampleTopic|Level=Beginner| ...</nowiki>
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===
===Optional Parameters===
The following parameters are optional. If they are not included in the template code, they will default to a value of "None".
The following parameters are optional. If they are not included in the template code, they will default to a value of ''None''.
;Time
;Time : The approximate time required to complete the tutorial.
: 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.
;Author
;Files : Optional link to example files. An appropriate repository needs to be determined (GitHub or CADinet, see [http://forum.freecadweb.org/viewtopic.php?f=21&t=7635#p62352 forum discussion]
: 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 [http://forum.freecadweb.org/viewtopic.php?f=21&t=7635#p62352 forum discussion].


==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.
<pre>
Template:TutorialInfo/AA
</pre>

where <code>/AA</code> is the 2 letter code for the desired language, for example <code>/fr</code> indicates French.
This are the [https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes ISO 639-1] ''language'' codes, not country codes.


The method for calling the localized TutorialInfo template is:
* First, a localized version of this template must exist or be created.
<pre>{{TutorialInfo/AA
* The localized template must be named: <pre>Template:TutorialInfo/AA</pre> where '''''/AA''''' is the 2 letter code for the desired language, for example '''''/fr''''' = French localization.
|Topic=SampleTopic
* The method for calling the localized TutorialInfo template in a Tutorial document is: <pre>{{TutorialInfo/AA|Class=SampleClass|Level=Beginner|FCVersion=>=0.14.3700}}</pre> where '''''/AA''''' is the 2 letter code for the desired language, for example '''''/fr''''' = French localization.
|Level=Beginner
* Make sure you add the localized version of this template to the Languages list below.
|FCVersion=>=0.17}}
</pre>


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


[[Category:Template:Doc]]
</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 09:43, 27 November 2019

Tutorial
Topic
{{{Topic}}}
Level
{{{Level}}}
Time to complete
Not provided
Author(s)
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.

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