Path Section Preparation for 0.17

Discussions about the wiki documentation of FreeCAD and its translation.
Forum rules
Be nice to others! Respect the FreeCAD code of conduct!
renatorivo
Veteran
Posts: 2611
Joined: Tue Feb 21, 2012 8:07 pm
Location: Torino - Italy

Re: Path Section Preparation for 0.17

Post by renatorivo »

chrisb wrote: Sun Jan 28, 2018 6:04 pm Herbert, to make it clear: It is not forbidden to show the english variant of a panel, but it must be separated from the 3D view.
There is a motivation. NormandC never speaks in vain. The 3D view is the same for everyone. The panel can be easily reproduced in the desired language.
herbk wrote: Sun Jan 28, 2018 5:40 pm The translation pages at crowdin are showing 100% translated since a while, but if i swith FC to "german" i have still a few words translated.
You have to wait for the translation be imported into the FreeCAD code, or create a new .qm file and then compile FreeCAD yourself.
Described in Italian here https://forum.freecadweb.org/viewtopic. ... 057#p85603

Renato
herbk
Veteran
Posts: 2660
Joined: Mon Nov 03, 2014 3:45 pm
Location: Windsbach, Bavarya (Germany)

Re: Path Section Preparation for 0.17

Post by herbk »

No problem... pics are without the panel.

But some questions to the panels...:
On most Operations we have two different panels where the parameters are to change. One (the gray like on the pic above) which i get on starting a operation and the Data Box.
Both boxes don't have the same contend and some operations don't have the gray box. To give the help pages a structure which is near the structure of FC, i want to seperate the description to.

To give it a headline, i need to know a name/Label of the gray box?

Several parameters are only to change at the Data Box, also if the operation has a "Gray Box". Is that intended or just not implemented jet?

The Data Box contends also some parameters which are on other WBs to, - like the placement e.g.. If there allready is a help page for that, i think i can link to it, or are there reasons not use it?
Gruß Herbert
renatorivo
Veteran
Posts: 2611
Joined: Tue Feb 21, 2012 8:07 pm
Location: Torino - Italy

Re: Path Section Preparation for 0.17

Post by renatorivo »

herbk wrote: Mon Jan 29, 2018 9:02 am Both boxes don't have the same contend and some operations don't have the gray box. To give the help pages a structure which is near the structure of FC, i want to seperate the description to.
It would be useful and more understandable to group the options with the same header, both in the configuration panel and in the options.
herbk wrote: Mon Jan 29, 2018 9:02 am Several parameters are only to change at the Data Box, also if the operation has a "Gray Box". Is that intended or just not implemented jet?
Some options depend on the Tool controller. Perhaps it is not possible to manage two settings at the same time. You have to close the operation and then open the Tool Controller again.
herbk wrote: Mon Jan 29, 2018 9:02 am The Data Box contends also some parameters which are on other WBs to, - like the placement e.g.. If there allready is a help page for that, i think i can link to it, or are there reasons not use it?
If it is relevant, what is already described must always be linked. This avoids updating a part and forgetting another part.

Correct me if I'm wrong.

Renato
User avatar
sliptonic
Veteran
Posts: 3460
Joined: Tue Oct 25, 2011 10:46 pm
Location: Columbia, Missouri
Contact:

Re: Path Section Preparation for 0.17

Post by sliptonic »

herbk wrote: Mon Jan 29, 2018 9:02 am
But some questions to the panels...:
On most Operations we have two different panels where the parameters are to change. One (the gray like on the pic above) which i get on starting a operation and the Data Box.
Both boxes don't have the same contend and some operations don't have the gray box. To give the help pages a structure which is near the structure of FC, i want to seperate the description to.
The 'property pane', which all objects have, comes from FreeCAD. It will always have all the properties of the object exposed. The task panels are from Path. We designed them to be clean, easy to use, and intuitive. Sometimes we chose to leave off more 'advanced' features to achieve this goal.

My opinion (and it's just an opinion) is that we shouldn't try to document the GUI. If we're relying on pictures to show which properties exist and their location/relation to each other, then we're making a mistake. GUIs can change over time and pictures are hard to edit. So they tend to become obsolte fast. I also think users are smart enough to hunt around without relying on a picture.

Instead, we should document the option, what they mean and how they interact. This should be in text whenever possible. Text is easy to translate and also easy to edit so more likely to stay up-to-date.

There's obviously good reasons to use pictures but always ask yourself; 'is this picture likely to be meaningful in the next version?'
renatorivo
Veteran
Posts: 2611
Joined: Tue Feb 21, 2012 8:07 pm
Location: Torino - Italy

Re: Path Section Preparation for 0.17

Post by renatorivo »

Link to https://www.freecadweb.org/wiki/Path_Workbench

Now the commands are listed in alphabetical order, directly on the page.
- In the translation the alphabetical order is lost.
- It is tradition that the commands are in the order of the drop-down menu
- Commands are always collected in a {{Template: ---}}

I prepared the https://www.freecadweb.org/wiki/Template:Path_Commands

In the drop down menu is missing https://www.freecadweb.org/wiki/Path_MillFace

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

Re: Path Section Preparation for 0.17

Post by renatorivo »

User avatar
sliptonic
Veteran
Posts: 3460
Joined: Tue Oct 25, 2011 10:46 pm
Location: Columbia, Missouri
Contact:

Re: Path Section Preparation for 0.17

Post by sliptonic »

renatorivo wrote: Thu Feb 08, 2018 9:41 pm Hi.
There are two pages "Pocket 3D"
https://www.freecadweb.org/wiki/Path_3DPocket
https://www.freecadweb.org/wiki/Path_Pocket_3D
which to keep?
Path_Pocket_3D is where the real content should live.
herbk
Veteran
Posts: 2660
Joined: Mon Nov 03, 2014 3:45 pm
Location: Windsbach, Bavarya (Germany)

Re: Path Section Preparation for 0.17

Post by herbk »

sliptonic wrote: Mon Jan 29, 2018 4:07 pmPing...
Hi Sliptonic,
did you make the picture an the main Path Wikipage? If yes, would you please post the FC file for it (if you still have it), i want to use it on the german WIkipage to.
Gruß Herbert
User avatar
sliptonic
Veteran
Posts: 3460
Joined: Tue Oct 25, 2011 10:46 pm
Location: Columbia, Missouri
Contact:

Re: Path Section Preparation for 0.17

Post by sliptonic »

The model is here: https://github.com/sliptonic/PathTortur ... part.fcstd

I didn't save it with the Job and operations though.
Post Reply