To be deleted: several wiki pages.

Discussions about the wiki documentation of FreeCAD and its translation.
vocx
Posts: 4641
Joined: Thu Oct 18, 2018 9:18 pm

Re: To be deleted: several wiki pages.

Postby vocx » Wed Jul 29, 2020 12:44 am

Roy_043 wrote:
Tue Jul 28, 2020 10:20 am
...
Reason in all cases: There is no such command (at least not in the GUI, some of these names do occur in the src).
...
Where in the source? Is the source commented out?

A command may be defined in the source, but if the name of the command is missing in a particular place it won't be shown in the menus and toolbars. This could mean that the author of the command probably thought that the command was still not good enough for mainstream use, so he or she decided to "hide" it.

You can test if a command is actually defined by using runCommand.

Code: Select all

Gui.runCommand("Mesh_Transform")
Always add the important information to your posts if you need help.
To support the documentation effort, and code development, your donation is appreciated: paypal.
User avatar
Roy_043
Posts: 1562
Joined: Thu Dec 27, 2018 12:28 pm

Re: To be deleted: several wiki pages.

Postby Roy_043 » Wed Jul 29, 2020 8:00 am

vocx wrote:
Wed Jul 29, 2020 12:44 am
You can test if...
I have actually already done that. But IMO that should not be necessary: if a command is not accessible in the GUI it should not be documented.
vocx
Posts: 4641
Joined: Thu Oct 18, 2018 9:18 pm

Re: To be deleted: several wiki pages.

Postby vocx » Wed Jul 29, 2020 4:20 pm

Roy_043 wrote:
Wed Jul 29, 2020 8:00 am
...But IMO that should not be necessary: if a command is not accessible in the GUI it should not be documented.
Yes, and no. I think we should keep older pages if the command was recently obsoleted. For example, in Draft we created a few commands and others were removed in the transition from 0.17 to 0.18 and 0.19, so we try to handle the situation by using the {{Version}} and {{Obsolete}} templates. I think this helps users of older versions because as we know, not everybody is using the same version always. Some people are stuck on older versions for different reasons.

But in this particular case, maybe these Mesh commands were removed a long time ago, so you are right, and we don't need to keep them.
Always add the important information to your posts if you need help.
To support the documentation effort, and code development, your donation is appreciated: paypal.
User avatar
Roy_043
Posts: 1562
Joined: Thu Dec 27, 2018 12:28 pm

Re: To be deleted: several wiki pages.

Postby Roy_043 » Wed Jul 29, 2020 7:31 pm

In an ideal world complete sets of documentation would be available for several older versions. But this is not the case.

vocx wrote:
Wed Jul 29, 2020 4:20 pm
we try to handle the situation
It is an inconsistent solution at best. There are other commands whose wiki documentation has already been rewritten for the V0.19 version. So the user of an older version should not rely on the wiki but use Std_OnlineHelp (command with a confusing name) or Std_WhatsThis.

Probably 10 years from now those obsolete pages will still be floating around, having accumulated dozens of small edits in the interim.

To make things more manageable maybe there should be an 'Obsolete' category?
vocx
Posts: 4641
Joined: Thu Oct 18, 2018 9:18 pm

Re: To be deleted: several wiki pages.

Postby vocx » Wed Jul 29, 2020 8:00 pm

Roy_043 wrote:
Wed Jul 29, 2020 7:31 pm
...
Probably 10 years from now those obsolete pages will still be floating around, having accumulated dozens of small edits in the interim.

To make things more manageable maybe there should be an 'Obsolete' category?
Yes, maybe that makes sense. What I always expect is that as FreeCAD becomes more popular, more people will join in maintaining the documentation; for example yourself, if more people like you join the project then maybe we can make larger decisions on how to handle this.
Always add the important information to your posts if you need help.
To support the documentation effort, and code development, your donation is appreciated: paypal.
User avatar
Roy_043
Posts: 1562
Joined: Thu Dec 27, 2018 12:28 pm

Re: To be deleted: several wiki pages.

Postby Roy_043 » Tue Aug 04, 2020 8:08 am

Some of the pages I have mentioned before have been deleted, but their translations have been left behind. In some case there also are 'Translations:' 'fragments' related to the page. These fragments are not listed below:

https://wiki.freecadweb.org/Std_CreateGroup/en
https://wiki.freecadweb.org/Std_CreateGroup/fr
https://wiki.freecadweb.org/Std_CreateGroup/it

https://wiki.freecadweb.org/Std_OnlineHelpPython/en
https://wiki.freecadweb.org/Std_OnlineHelpPython/fr
https://wiki.freecadweb.org/Std_OnlineHelpPython/it
https://wiki.freecadweb.org/Std_OnlineHelpPython/jp
https://wiki.freecadweb.org/Std_OnlineHelpPython/ro
https://wiki.freecadweb.org/Std_OnlineHelpPython/ru

https://wiki.freecadweb.org/Std_Panels/en
https://wiki.freecadweb.org/Std_Panels/fr
https://wiki.freecadweb.org/Std_Panels/it
https://wiki.freecadweb.org/Std_Panels/ro
https://wiki.freecadweb.org/Std_Panels/ru

https://wiki.freecadweb.org/Std_PythonConsole/de
https://wiki.freecadweb.org/Std_PythonConsole/en
https://wiki.freecadweb.org/Std_PythonConsole/fr
https://wiki.freecadweb.org/Std_PythonConsole/it
https://wiki.freecadweb.org/Std_PythonConsole/ro
https://wiki.freecadweb.org/Std_PythonConsole/ru

https://wiki.freecadweb.org/Std_ToggleVisibilityAll/de
https://wiki.freecadweb.org/Std_ToggleVisibilityAll/en
https://wiki.freecadweb.org/Std_ToggleVisibilityAll/fr
https://wiki.freecadweb.org/Std_ToggleVisibilityAll/it
https://wiki.freecadweb.org/Std_ToggleVisibilityAll/ro
https://wiki.freecadweb.org/Std_ToggleVisibilityAll/ru

https://wiki.freecadweb.org/Std_ViewIvStereo/de
https://wiki.freecadweb.org/Std_ViewIvStereo/en
https://wiki.freecadweb.org/Std_ViewIvStereo/fr
https://wiki.freecadweb.org/Std_ViewIvStereo/it
https://wiki.freecadweb.org/Std_ViewIvStereo/jp
https://wiki.freecadweb.org/Std_ViewIvStereo/ro
https://wiki.freecadweb.org/Std_ViewIvStereo/ru
Last edited by Roy_043 on Tue Aug 04, 2020 8:37 am, edited 1 time in total.
User avatar
Roy_043
Posts: 1562
Joined: Thu Dec 27, 2018 12:28 pm

Re: To be deleted: several wiki pages.

Postby Roy_043 » Tue Aug 04, 2020 8:16 am

And some new ones.

Actually the 1st page has already been mentioned, but I have included it here with its translations.
Again: 'Translations:' 'fragments' have not been included in the list.

https://wiki.freecadweb.org/Std_AboutQt (already mentioned)
https://wiki.freecadweb.org/Std_AboutQt/en
https://wiki.freecadweb.org/Std_AboutQt/fr
https://wiki.freecadweb.org/Std_AboutQt/it
https://wiki.freecadweb.org/Std_AboutQt/ja
https://wiki.freecadweb.org/Std_AboutQt/jp
https://wiki.freecadweb.org/Std_AboutQt/ro
https://wiki.freecadweb.org/Std_AboutQt/ru

https://wiki.freecadweb.org/Std_DlgMacroStop/jp

https://wiki.freecadweb.org/Std_OnlineHelpWebsite
https://wiki.freecadweb.org/Std_OnlineHelpWebsite/jp

https://wiki.freecadweb.org/Std_PythonWebsite
https://wiki.freecadweb.org/Std_PythonWebsite/en
https://wiki.freecadweb.org/Std_PythonWebsite/fr
https://wiki.freecadweb.org/Std_PythonWebsite/it
https://wiki.freecadweb.org/Std_PythonWebsite/jp
https://wiki.freecadweb.org/Std_PythonWebsite/pl
https://wiki.freecadweb.org/Std_PythonWebsite/ro
https://wiki.freecadweb.org/Std_PythonWebsite/ru

https://wiki.freecadweb.org/Std_TipOfTheDay/ru

https://wiki.freecadweb.org/Std_View_3D/it

https://wiki.freecadweb.org/Std_ViewExamples/jp
https://wiki.freecadweb.org/Std_ViewExamples/ru

https://wiki.freecadweb.org/Std_Workbench_Menu (blank?)
https://wiki.freecadweb.org/Std_Workbench_Menu/de
https://wiki.freecadweb.org/Std_Workbench_Menu/en
https://wiki.freecadweb.org/Std_Workbench_Menu/fr
https://wiki.freecadweb.org/Std_Workbench_Menu/it
https://wiki.freecadweb.org/Std_Workbench_Menu/ro
https://wiki.freecadweb.org/Std_Workbench_Menu/ru