Campaign to add language agnostic animated gifs to each FC command page on the wiki (+ possibly as tooltips within FC)

Discussions about the wiki documentation of FreeCAD and its translation.
Forum rules
Be nice to others! Respect the FreeCAD code of conduct!
User avatar
Kunda1
Veteran
Posts: 13434
Joined: Thu Jan 05, 2017 9:03 pm

Campaign to add language agnostic animated gifs to each FC command page on the wiki (+ possibly as tooltips within FC)

Post by Kunda1 »

A picture is worth a thousand words
A animated gif is worth a dozen pictures.
Example from a recent PR to add a feature request to extend sketcher:
Image
The idea is to create an additional learning visual as a reference to facilitate better/efficient comprehension of FreeCAD tools. It can also serve as another way folks could contribute to FC.
Thoughts?
Mods, please consider x-posting to the non-English speaking forums (especially the Germans) to see if there are volunteers?
Last edited by Kunda1 on Wed Jun 28, 2017 1:34 pm, edited 2 times in total.
Alone you go faster. Together we go farther
Please mark thread [Solved]
Want to contribute back to FC? Checkout:
'good first issues' | Open TODOs and FIXMEs | How to Help FreeCAD | How to report Bugs
User avatar
r-frank
Veteran
Posts: 2180
Joined: Thu Jan 24, 2013 6:26 pm
Location: Möckmühl, Germany
Contact:

Re: Campaign to add animated gifs to each FC command page on the wiki

Post by r-frank »

Hello.

Some time ago there was a big discussion about this and the conclusion was NOT to post animated gifs.
Main reason was because you need to show the FreeCAD-GUI/Interface, which is language-dependant.

So the animated gif's can't be translated while text can be translated ...
And re-clicking the animated gif's with a different language-GUI would be a PITA for the wiki translators ...

Roland
Deutsche FreeCAD Tutorials auf Youtube
My GrabCAD FreeCAD-Projects
FreeCAD lessons for beginners in english

Native german speaker - so apologies for my english, no offense intended :)
User avatar
Kunda1
Veteran
Posts: 13434
Joined: Thu Jan 05, 2017 9:03 pm

Re: Campaign to add animated gifs to each FC command page on the wiki

Post by Kunda1 »

r-frank wrote: Fri Jun 02, 2017 2:46 pm So the animated gif's can't be translated while text can be translated ...
And re-clicking the animated gif's with a different language-GUI would be a PITA for the wiki translators ...
Thanks @r-frank for the heads up. What about if the animated gifs were just made in English and then the translators could decide to include or exclude from their respective translation pages?
Alone you go faster. Together we go farther
Please mark thread [Solved]
Want to contribute back to FC? Checkout:
'good first issues' | Open TODOs and FIXMEs | How to Help FreeCAD | How to report Bugs
User avatar
r-frank
Veteran
Posts: 2180
Joined: Thu Jan 24, 2013 6:26 pm
Location: Möckmühl, Germany
Contact:

Re: Campaign to add animated gifs to each FC command page on the wiki

Post by r-frank »

I fear that documentation will come down to ONLY adding an english animted GIF.
> no offline Help-File possible (provided with the stable releases)
> wiki translators willing to create gif's won't be found easily ... a small text with one or two screenshots is written easier ...
> watching soundless gif's is boring ... quite a few newcomers on the forum are asking for written tutorials/help
Deutsche FreeCAD Tutorials auf Youtube
My GrabCAD FreeCAD-Projects
FreeCAD lessons for beginners in english

Native german speaker - so apologies for my english, no offense intended :)
User avatar
Boneshaker
Posts: 69
Joined: Sat Feb 20, 2016 2:20 pm
Location: Emden, Germany

Re: Campaign to add animated gifs to each FC command page on the wiki

Post by Boneshaker »

Hello,

from my point of view as a user those gifs are really annoying. Much to fast, no pause and reading text next to flickering images isn't nice.
IMO best practice is a series of pictures. Step 1, Step 2, …
User avatar
Kunda1
Veteran
Posts: 13434
Joined: Thu Jan 05, 2017 9:03 pm

Re: Campaign to add animated gifs to each FC command page on the wiki

Post by Kunda1 »

Thx for the feedback. I personally really like 'well made' animated gifs. They give me a glimpse into what the tool does. That's what I'm envisioning the function of an animated gif would be useful for... as a preview of what the tool does.
Alone you go faster. Together we go farther
Please mark thread [Solved]
Want to contribute back to FC? Checkout:
'good first issues' | Open TODOs and FIXMEs | How to Help FreeCAD | How to report Bugs
JMG
Posts: 287
Joined: Wed Dec 25, 2013 9:32 am
Location: Spain
Contact:

Re: Campaign to add animated gifs to each FC command page on the wiki

Post by JMG »

FreeCAD scripts, animations, experiments and more: http://linuxforanengineer.blogspot.com.es/
Open source CNC hot wire cutter project (NiCr): https://github.com/JMG1/NiCr
Exploded Assembly Workbench: https://github.com/JMG1/ExplodedAssembly
triplus
Veteran
Posts: 9471
Joined: Mon Dec 12, 2011 4:45 pm

Re: Campaign to add animated gifs to each FC command page on the wiki

Post by triplus »

Such GIF animations i guess can be useful by themselves. Therefore another way to tackle this is to start producing some well done GIF animations first. And see how things will evolve after.
User avatar
Kunda1
Veteran
Posts: 13434
Joined: Thu Jan 05, 2017 9:03 pm

Re: Campaign to add animated gifs to each FC command page on the wiki

Post by Kunda1 »

@JMG exactly! Language agnostic gifs as tooltips would rock!!!

Image
Alone you go faster. Together we go farther
Please mark thread [Solved]
Want to contribute back to FC? Checkout:
'good first issues' | Open TODOs and FIXMEs | How to Help FreeCAD | How to report Bugs
User avatar
Kunda1
Veteran
Posts: 13434
Joined: Thu Jan 05, 2017 9:03 pm

Re: Campaign to add animated gifs to each FC command page on the wiki

Post by Kunda1 »

Can we start a language agnostic animated gif git repo somewhere with guidelines on creating the gif. Size, color, duration limits, naming etc... ?
Alone you go faster. Together we go farther
Please mark thread [Solved]
Want to contribute back to FC? Checkout:
'good first issues' | Open TODOs and FIXMEs | How to Help FreeCAD | How to report Bugs
Post Reply