User manual improvement
Open, Needs TriagePublic

Description

Actual GCompris user manual is not easy to use.

  • it is not well organised. This is simply a list of all our activities and there are now more than 170 of them!

If it is quite easy to use CTRL-Z to find the application we are looking to, it is not pleasant to read trough.

  • the file is huge 23 Megs

Proposition:
1- Reorganise the user manual grouping activities per domain and subdomain (the way we have in GCompris). You can see an illustration of this organisation here:
https://en.wikitolearn.org/User:Allon/GCompris_Cookbook
2- Adjust screenshots sizes to keep enough quality while reducing the file size to a maximum of 5 Megs

No need to reinvent the wheel, as we have three python scripts that combined together will produce an excellent result:
1- https://invent.kde.org/education/gcompris/-/tree/userManual/tools
This script generates the user manuals in every languages translated
2- https://invent.kde.org/websites/gcompris-net/-/blob/master/gcompris.py
This script has the particularity of using QQmlComponent allowing in python to access the content of ActivityInfo.qml in the form of an object.
ActivityInfo.qml contains each activity descriptions used to create the user manual.
3- see attachement


Part of this draft script groups activities per domain and subdomain like found in the gcompris application itself.

echarruau updated the task description. (Show Details)Dec 31 2021, 10:50 AM
jjazeix updated the task description. (Show Details)Jan 2 2022, 6:24 PM