MOOC Workbench: Difference between revisions

From FreeCAD Documentation
m (moved templates out of translation tags + added {{TOCright}} + Enlarged and centered workbench logo + added caption)
(Updated the installation paragraph.)
 
(9 intermediate revisions by 2 users not shown)
Line 2: Line 2:
[[Image:MOOC_workbench_icon.svg|center|240px]]
[[Image:MOOC_workbench_icon.svg|center|240px]]
<translate>
<translate>
<!--T:17-->
{{Caption|align=center|The FreeCAD MOOC External Workbench Icon}}
{{Caption|align=center|The FreeCAD MOOC External Workbench Icon}}


Line 12: Line 13:
<!--T:2-->
<!--T:2-->
The MOOC Workbench is an [[External_workbenches|external workbench]] with which you can follow interactive tutorials and make evaluation of your work directly within the FreeCAD interface. The MOOC workbench offers 2 tools: interactive tutorials and evaluations.
The MOOC Workbench is an [[External_workbenches|external workbench]] with which you can follow interactive tutorials and make evaluation of your work directly within the FreeCAD interface. The MOOC workbench offers 2 tools: interactive tutorials and evaluations.

<!--T:18-->
* Currently only in French (and hard-coded).
* Only compatible with FreeCAD Py3 and Qt5 (PySide2)
* LGPLv2 (or similar) code funded by Europe through IMT and EESAB.
* Modular: This workbench was created with the intention that the addition of tutorials and evaluations was modular. In other words, one has to add a tutorial in the {{FileName|lessons}} folder or an evaluation in the {{FileName|exercises}} folder to show up in the respective tool.


=== Interactive === <!--T:4-->
=== Interactive === <!--T:4-->
'''Interactive''' tutorials (also called Player) are step-by-step guided exercises with objective checks. It launches directly into FreeCAD and allows you to advance one step at a time of modeling of an object. The user has a text, a video and above all a check that the objectives have been achieved.
'''Interactive''' tutorials (AKA [[Image:MOOC_Player.svg|24px]] Player) are step-by-step guided exercises with objective checks. It launches directly into FreeCAD and allows you to advance one step at a time of modeling of an object. The user has a text, a video and above all a check that the objectives have been achieved.

</translate>
[[Image:MOOC_Player_Dialog_Context.png|1024px]]
<translate>
<!--T:19-->
{{Caption|align=center|MOOC Player Dialog within FreeCAD GUI}}
</translate>
[[Image:MOOC_Player_Dialog.png]]
<translate>
<!--T:20-->
{{Caption|MOOC Player Dialog close up}}


=== Evaluations === <!--T:5-->
=== Evaluations === <!--T:5-->
'''Evaluations''' (also called Grader) consist of a small program that checks certain criteria of a FreeCAD document, for example, the presence of a part body, a sketch or the final volume.
'''Evaluations''' (AKA [[Image:MOOC_Grader.svg|24px]] Grader) consist of a small program that checks certain criteria of a FreeCAD document, for example, the presence of a part body, a sketch or the final volume.
</translate>

[[Image:MOOC_Grader_Dialog.png|1024px]]
<translate>
<!--T:21-->
{{Caption|align=center|The MOOC Grader Dialog}}


==Installation== <!--T:6-->
==Installation== <!--T:6-->


<!--T:7-->
<!--T:7-->
This workbench can be easily installed and updated from the [[Image:AddonManager.svg|24px]] [[Addon Manager]] from ({{MenuCommand|Tools → Addon Manager}}) available in FreeCAD 0.17 and above. For FreeCAD 0.16 users and other install methods, please refer to [[Installing#Installing_additional_contents|installing additional contents]].
This workbench can be installed from the [[Std_AddonMgr|Addon Manager]]. For manual installation see [[Installing_more_workbenches|Installing more workbenches]].

==Limitations== <!--T:22-->

<!--T:23-->
ATM this workbench is only available in the French language.

==Technical Details== <!--T:24-->

<!--T:25-->
From a technical point of view, the workbench is composed of:
* an "API" that contains the code that analyzes the document ({{FileName|MoocChecker.py}})
* the code that executes the tutorials in the "lessons" folder ({{FileName|MoocPlayer.py}})
* the code that executes the evaluations in the "exercises" folder ({{FileName|MoocGrader.py}})

==Roadmap== <!--T:26-->
* internationalization of the workbench
* Integration of videos in FreeCAD (PySide2.QtWebEngineWidgets?)
* <s>request the integration of the workbench in the list of the addon manager</s> DONE


==Links== <!--T:8-->
==Links== <!--T:8-->
Line 30: Line 70:
* Source code hosted on Framagit: [https://framagit.org/freecad-france/mooc-workbench]
* Source code hosted on Framagit: [https://framagit.org/freecad-france/mooc-workbench]
* Official complete [https://framagit.org/freecad-france/mooc-workbench#mooc-workbench]
* Official complete [https://framagit.org/freecad-france/mooc-workbench#mooc-workbench]
* Discussion threads: [https://forum.freecadweb.org/viewtopic.php?f=9&t=37584 English] / [https://forum.freecadweb.org/viewtopic.php?f=12&t=37322 French]



== External workbenches == <!--T:10-->
== External workbenches == <!--T:10-->

Latest revision as of 20:07, 5 January 2021

Other languages:

The FreeCAD MOOC External Workbench Icon

Overview

The MOOC Workbench is an external workbench with which you can follow interactive tutorials and make evaluation of your work directly within the FreeCAD interface. The MOOC workbench offers 2 tools: interactive tutorials and evaluations.

  • Currently only in French (and hard-coded).
  • Only compatible with FreeCAD Py3 and Qt5 (PySide2)
  • LGPLv2 (or similar) code funded by Europe through IMT and EESAB.
  • Modular: This workbench was created with the intention that the addition of tutorials and evaluations was modular. In other words, one has to add a tutorial in the lessons folder or an evaluation in the exercises folder to show up in the respective tool.

Interactive

Interactive tutorials (AKA Player) are step-by-step guided exercises with objective checks. It launches directly into FreeCAD and allows you to advance one step at a time of modeling of an object. The user has a text, a video and above all a check that the objectives have been achieved.

MOOC Player Dialog within FreeCAD GUI

MOOC Player Dialog close up

Evaluations

Evaluations (AKA Grader) consist of a small program that checks certain criteria of a FreeCAD document, for example, the presence of a part body, a sketch or the final volume.

The MOOC Grader Dialog

Installation

This workbench can be installed from the Addon Manager. For manual installation see Installing more workbenches.

Limitations

ATM this workbench is only available in the French language.

Technical Details

From a technical point of view, the workbench is composed of:

  • an "API" that contains the code that analyzes the document (MoocChecker.py)
  • the code that executes the tutorials in the "lessons" folder (MoocPlayer.py)
  • the code that executes the evaluations in the "exercises" folder (MoocGrader.py)

Roadmap

  • internationalization of the workbench
  • Integration of videos in FreeCAD (PySide2.QtWebEngineWidgets?)
  • request the integration of the workbench in the list of the addon manager DONE

Links

External workbenches

FreeCAD workbenches are easy to program in Python, there are therefore many people developing additional workbenches outside of the FreeCAD main developers.

The external workbenches page has some information and tutorials on some of them, and the FreeCAD Addons project aims at gathering them and making them easily installable from within FreeCAD.

New workbenches are in development, stay tuned!