Adding version to GuiCommand template?

Discussions about the wiki documentation of FreeCAD and its translation.
Forum rules
Be nice to others! Respect the FreeCAD code of conduct!

Is it a good idea to add an "Introduced in version" field in a command page infobox?

Yes, let's do it (it's OK for old pages to have an empty field)
7
100%
No, the infobox has enough fields already
0
No votes
Other (please reply what in the topic)
0
No votes
 
Total votes: 7
User avatar
NormandC
Veteran
Posts: 18589
Joined: Sat Feb 06, 2010 9:52 pm
Location: Québec, Canada

Adding version to GuiCommand template?

Post by NormandC »

Hey guys,

I've been playing with the GuiCommand template. That's what generates the infobox in command pages.

The first thing I would like to do is to add an "Introduced in version" field, to indicate in what version of FreeCAD the tool was added.
FC_wiki_GuiCommand_Version_01.png
FC_wiki_GuiCommand_Version_01.png (25.78 KiB) Viewed 1782 times

With this, the "==Notes==" section that a few pages have at the bottom would be unnecessary. I think this would be simpler.

FC_wiki_Command_Page_Notes_01.png
FC_wiki_Command_Page_Notes_01.png (4.22 KiB) Viewed 1782 times

What would happen to all existing pages that do not have a version field? They would look like this:

FC_wiki_GuiCommand_Version_02.png
FC_wiki_GuiCommand_Version_02.png (25.06 KiB) Viewed 1782 times

Realistically we won't be able to fill this new "Version" field for all command pages. I think it's OK to have an empty field.

So what do you guys think? Pinging a few active forum/wiki contributors, but feedback from all is welcome. Thanks!

yorik wrote:
renatorivo wrote:
chrisb wrote:
bejant wrote:
ulrich1a wrote:
HarryGeier wrote:
chrisb
Veteran
Posts: 54177
Joined: Tue Mar 17, 2015 9:14 am

Re: Adding version to GuiCommand template?

Post by chrisb »

Very good proposal!
Instead of leaving it blank for unknown, is it possible to have a simple dash "-"? The meaning would be something like "Once upon a time" or "long, long time ago" or "in the days when wishes not came true".
A Sketcher Lecture with in-depth information is available in English, auf Deutsch, en français, en español.
User avatar
NormandC
Veteran
Posts: 18589
Joined: Sat Feb 06, 2010 9:52 pm
Location: Québec, Canada

Re: Adding version to GuiCommand template?

Post by NormandC »

Sure! And the advantage would be that the field would not be squished.

FC_wiki_GuiCommand_Version_03.png
FC_wiki_GuiCommand_Version_03.png (25.62 KiB) Viewed 1771 times

chrisb wrote: Sun Oct 14, 2018 8:46 pm "in the days when wishes not came true".
LOL :D
ulrich1a
Veteran
Posts: 1957
Joined: Sun Jul 07, 2013 12:08 pm

Re: Adding version to GuiCommand template?

Post by ulrich1a »

Yes, it is ok and does not harm.

Ulrich
renatorivo
Veteran
Posts: 2611
Joined: Tue Feb 21, 2012 8:07 pm
Location: Torino - Italy

Re: Adding version to GuiCommand template?

Post by renatorivo »

It's OK for me.
User avatar
NormandC
Veteran
Posts: 18589
Joined: Sat Feb 06, 2010 9:52 pm
Location: Québec, Canada

Re: Adding version to GuiCommand template?

Post by NormandC »

Thanks guys.

chrisb wrote: Sun Oct 14, 2018 8:46 pm Instead of leaving it blank for unknown, is it possible to have a simple dash "-"?
I realized today, unfortunately, all the existing pages will get the "squished" field. Otherwise, we would need to edit all the pages and add the following to the GuiCommand template:

Code: Select all

|Version=-
Which would be an enormous task. But, we could have the dash for all new pages.
chrisb
Veteran
Posts: 54177
Joined: Tue Mar 17, 2015 9:14 am

Re: Adding version to GuiCommand template?

Post by chrisb »

NormandC wrote: Mon Oct 15, 2018 4:05 pm I realized today, unfortunately, all the existing pages will get the "squished" field. Otherwise, we would need to edit all the pages and add the following to the GuiCommand template:

Code: Select all

|Version=-
Which would be an enormous task. But, we could have the dash for all new pages.
Squished is not that bad for existing pages..
A Sketcher Lecture with in-depth information is available in English, auf Deutsch, en français, en español.
User avatar
bejant
Veteran
Posts: 6075
Joined: Thu Jul 11, 2013 3:06 pm

Re: Adding version to GuiCommand template?

Post by bejant »

I like letting the reader know when a tool / function was added to FreeCAD. It can help someone who is using an old FreeCAD version realize why they might not see a particular tool in their FreeCAD version, so +1 from me (and I did vote).

I think I long ago had added a few simple notes in parenthesis onto a few wiki WB pages (probably Sketcher and Part Design) noting the FreeCAD version into which a particular tool was introduced. Looking at the Sketcher wiki page, it looks like the trend has mostly continued:
https://www.freecadweb.org/wiki/Sketche ... #The_tools
User avatar
Kunda1
Veteran
Posts: 13434
Joined: Thu Jan 05, 2017 9:03 pm

Re: Adding version to GuiCommand template?

Post by Kunda1 »

NormandC wrote:
Honestly, i think this is smart and professional, I like this proposal. And in theory, this should be really easy to implement if we install this mediawiki extension: https://mediawiki.org/wiki/Extension:MassEditRegex
We could add it to all languages (that we have installed so far).
An aside, it would also make implementing https://forum.freecadweb.org/viewtopic.php?f=21&t=31424 easier

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
NormandC
Veteran
Posts: 18589
Joined: Sat Feb 06, 2010 9:52 pm
Location: Québec, Canada

Re: Adding version to GuiCommand template?

Post by NormandC »

I finally changed the template, and also the existing translated templates. I started to manually add the Version parameter to PartDesign command pages that were added in v0.17, and update the translated pages. It's going to be a tedious job...
Post Reply