FEM documentation missing on the Wiki

About the development of the FEM module/workbench.

Moderator: bernd

User avatar
bernd
Posts: 7745
Joined: Sun Sep 08, 2013 8:07 pm
Location: Zürich, Switzerland

Re: FEM documentation missing on the Wiki

Postby bernd » Mon Mar 19, 2018 11:49 am

How it goes:

- the file https://github.com/FreeCAD/FreeCAD/blob ... kbench.cpp defines the FEM commands. They start with FEM_XXXX
- any of the commands there should have a wiki page with exact the same name as the command
- The links to these pages are created in a template. See https://www.freecadweb.org/wiki/Template:FEM_Tools
- I udated the template a few days ago. Any command from the workbench file should have a link in the template which directs to a wiki page.
- ATM lots of this pages could be empty.
- In the templates some commands have wrong icons. The icons are in https://github.com/FreeCAD/FreeCAD/tree ... rces/icons . If an icon is saved as file on the wiki it should be linked on https://www.freecadweb.org/wiki/Artwork ... es.5CIcons Afterwards it could be used in the template.

What needs to be done? What is most important?
- check if every command from https://github.com/FreeCAD/FreeCAD/blob ... kbench.cpp is on the template and has its wiki page.
- Replace the wrong icon links on the template with the right one. If an icon is missing add it to the wiki and include it in the artwork.

bernd
User avatar
bernd
Posts: 7745
Joined: Sun Sep 08, 2013 8:07 pm
Location: Zürich, Switzerland

Re: FEM documentation missing on the Wiki

Postby bernd » Mon Mar 19, 2018 5:22 pm

svg icons should be used in the template in above post! In artwork all FEM icons are in svg.
User avatar
bernd
Posts: 7745
Joined: Sun Sep 08, 2013 8:07 pm
Location: Zürich, Switzerland

Re: FEM documentation missing on the Wiki

Postby bernd » Mon Mar 19, 2018 7:47 pm

fixed most of the icons too.

The pages needs content --- :)
User avatar
OakLD
Posts: 97
Joined: Fri Jan 12, 2018 7:38 pm
Location: Brno

Re: FEM documentation missing on the Wiki

Postby OakLD » Tue Mar 20, 2018 4:03 pm

bernd wrote:
Mon Mar 19, 2018 11:49 am
How it goes:

- the file https://github.com/FreeCAD/FreeCAD/blob ... kbench.cpp defines the FEM commands. They start with FEM_XXXX
- any of the commands there should have a wiki page with exact the same name as the command
- The links to these pages are created in a template. See https://www.freecadweb.org/wiki/Template:FEM_Tools
- I udated the template a few days ago. Any command from the workbench file should have a link in the template which directs to a wiki page.
- ATM lots of this pages could be empty.
- In the templates some commands have wrong icons. The icons are in https://github.com/FreeCAD/FreeCAD/tree ... rces/icons . If an icon is saved as file on the wiki it should be linked on https://www.freecadweb.org/wiki/Artwork ... es.5CIcons Afterwards it could be used in the template.

What needs to be done? What is most important?
- check if every command from https://github.com/FreeCAD/FreeCAD/blob ... kbench.cpp is on the template and has its wiki page.
- Replace the wrong icon links on the template with the right one. If an icon is missing add it to the wiki and include it in the artwork.

bernd
All right, I think I get all the points and I can access all the resources mentioned. I believe I'll get used to that in a bit of time and do the documentation up to expected standards :-)

I tried to use the icons the same way they were used elsewhere in WIKI, it worked, but I understand your point with SVG. I tested SVG icon with the first icon on hand (found the SVG from the page you provided a link) and it worked, so when I have a bit of time, I'll update all of them.

I'll go also slowly through the WIKI list of commands you provided (which I figured out myself, I was just confused that here in this thread is a list of different WIKI pages) and see what I could complete. Some stuff is same/similar in all the software (like Ansys, CalculiX, SolidWorks), but some might be specific to FreeCAD.

As for the specific stuff, I wasn't able to figure out what are used detailed display optoins for, in the pipeline scale dialog: Style (Flow|Zero) and Visibility (Out grayed|Out invisible) - those did not made any apparent differences in the case of the simple test models I tried them with.
Regards,

Oak
User avatar
bernd
Posts: 7745
Joined: Sun Sep 08, 2013 8:07 pm
Location: Zürich, Switzerland

Re: FEM documentation missing on the Wiki

Postby bernd » Tue Mar 20, 2018 6:40 pm

OakLD wrote:
Tue Mar 20, 2018 4:03 pm
so when I have a bit of time, I'll update all of them.
done already :)


OakLD wrote:
Tue Mar 20, 2018 4:03 pm
As for the specific stuff, I wasn't able to figure out what are used detailed display optoins for, in the pipeline scale dialog: Style (Flow|Zero) and Visibility (Out grayed|Out invisible) - those did not made any apparent differences in the case of the simple test models I tried them with.
mhh I do not know exactly either. But this should be discussed in a separate new topic.
User avatar
Kunda1
Posts: 4402
Joined: Thu Jan 05, 2017 9:03 pm

Re: FEM documentation missing on the Wiki

Postby Kunda1 » Thu May 31, 2018 12:24 am

bernd wrote:ping
Any plans for issue #3052 ?
Want to contribute back to FC? Checkout:
#lowhangingfruit | Use the Source, Luke. | How to Help FreeCAD | How to report FC bugs and features
User avatar
Kunda1
Posts: 4402
Joined: Thu Jan 05, 2017 9:03 pm

Re: FEM documentation missing on the Wiki

Postby Kunda1 » Wed Dec 19, 2018 12:18 pm

Want to contribute back to FC? Checkout:
#lowhangingfruit | Use the Source, Luke. | How to Help FreeCAD | How to report FC bugs and features
User avatar
bernd
Posts: 7745
Joined: Sun Sep 08, 2013 8:07 pm
Location: Zürich, Switzerland

Re: FEM documentation missing on the Wiki

Postby bernd » Wed Dec 19, 2018 3:42 pm

What's this a new version of Artwork ?
User avatar
uwestoehr
Posts: 456
Joined: Sun Jan 27, 2019 3:21 am

Re: FEM documentation missing on the Wiki

Postby uwestoehr » Wed Feb 27, 2019 11:01 pm

I added at least few sentences about the new FEM features in 0.18:
https://www.freecadweb.org/wiki/Release ... _Workbench
and
https://www.freecadweb.org/wiki/Release ... l_Handling
bernd wrote:
Wed Dec 19, 2018 3:42 pm
Bernd, could you please write some more since you know what the news are?
User avatar
uwestoehr
Posts: 456
Joined: Sun Jan 27, 2019 3:21 am

Re: FEM documentation missing on the Wiki

Postby uwestoehr » Wed Mar 13, 2019 12:16 am

uwestoehr wrote:
Wed Feb 27, 2019 11:01 pm
I added at least few sentences about the new FEM features in 0.18:
https://www.freecadweb.org/wiki/Release ... _Workbench
and
https://www.freecadweb.org/wiki/Release ... l_Handling
bernd wrote:
Wed Dec 19, 2018 3:42 pm
Bernd, could you please write some more since you know what the news are?
Ping!