FEM page title

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

FEM page title

Post by renatorivo »

Hi,
the title of some FEM pages is too long, it's hard to read, and the cursor does not help
titolo-troppo-lungo.png
titolo-troppo-lungo.png (29.03 KiB) Viewed 2846 times
see
FEM_BeamCrossSectionDefinition
FEM_ShellThicknessDefinition
FEM_DisplacementConstraint
FEM_RunFrequencyAnalysis

I'm planning to rename pages in this way
FEM Analysis
FEM Solver
FEM Mesh
FEM Material
FEM Section
FEM Thickness
FEM Nodes
FEM Fixed
FEM Displacement
FEM Force
FEM Pressure
FEM Bearing
FEM Gear
FEM Pulley
FEM Start
FEM Frequency
FEM Purge
FEM Show

suggestions for improvement?
Thanks
Renato
User avatar
bernd
Veteran
Posts: 12849
Joined: Sun Sep 08, 2013 8:07 pm
Location: Zürich, Switzerland
Contact:

Re: FEM page title

Post by bernd »

good idea, find my2cents

FEM Section --> How about --> FEM CrossSection
FEM Frequency --> FEM_RunFrequencyAnalysis --> could be deleted
FEM Start --> stay at FEM_Calculation
FEM Run --> instead FEM_RunCalculiXccx

cheers bernd

BTW: there are some new tools in FEM and there will be even more shortly ...
User avatar
bernd
Veteran
Posts: 12849
Joined: Sun Sep 08, 2013 8:07 pm
Location: Zürich, Switzerland
Contact:

Re: FEM page title

Post by bernd »

@renato:
How about the move of the FEM pages? Will it happen? We need to add some (a lot :D ) new tools. We would use the new names for them from beginning.
renatorivo
Veteran
Posts: 2611
Joined: Tue Feb 21, 2012 8:07 pm
Location: Torino - Italy

Re: FEM page title

Post by renatorivo »

bernd wrote:We need to add some (a lot :D ) new tools.
excellent :D
bernd wrote:How about the move of the FEM pages?
Sorry, I devoted my time to the manual.

After some testing, I must say that I made a mistake.
What causes the problem is not the title, but the "Name" in the template GuiCommand.
I do not know if I'm allowed to change this name, and how.
titolo-troppo-lungo2.png
titolo-troppo-lungo2.png (42.09 KiB) Viewed 2764 times
Renato
User avatar
yorik
Founder
Posts: 13640
Joined: Tue Feb 17, 2009 9:16 pm
Location: Brussels
Contact:

Re: FEM page title

Post by yorik »

Yes, you can change the name, but beware that that name is used to get the icon (an icon with the same name), so you might need to re-upload the icon under a new name too.

Basically there is one important rule: the wiki page name must be exactly the command name in FreeCAD. Unfortunately there is no easy way to get the exact command name, other than looking directly into the code (into src/Mod/*WorkbenchName*/InitGui.py for pure python workbenches, or in src/Mod/*Workbenchname*/Gui/Workbench.cpp for C++ and hybrid python/C++ ones.

For example, for FEM, all command names are listed here: https://github.com/FreeCAD/FreeCAD/blob ... kbench.cpp

But that is only for the wiki page name itself. What appears in the Guicommand template could be different, if needed, for ex. to make it easier to understand (for example, add spaces inside the name)
User avatar
bernd
Veteran
Posts: 12849
Joined: Sun Sep 08, 2013 8:07 pm
Location: Zürich, Switzerland
Contact:

Re: FEM page title

Post by bernd »

yorik wrote:Basically there is one important rule: the wiki page name must be exactly the command name in FreeCAD. Unfortunately there is no easy way to get the exact command name, other than looking directly into the code (into src/Mod/*WorkbenchName*/InitGui.py for pure python workbenches, or in src/Mod/*Workbenchname*/Gui/Workbench.cpp for C++ and hybrid python/C++ ones.

For example, for FEM, all command names are listed here: https://github.com/FreeCAD/FreeCAD/blob ... kbench.cpp
Ahh I did not know about the rule but it makes sense to me!

Renato are you gone rename FEM wiki pages?
renatorivo
Veteran
Posts: 2611
Joined: Tue Feb 21, 2012 8:07 pm
Location: Torino - Italy

Re: FEM page title

Post by renatorivo »

yorik wrote:Yes, you can change the name, but beware that that name is used to get the icon (an icon with the same name), so you might need to re-upload the icon under a new name too.
ok, this is not a problem
yorik wrote:Basically there is one important rule: the wiki page name must be exactly the command name in FreeCAD. Unfortunately there is no easy way to get the exact command name, other than looking directly into the code (into src/Mod/*WorkbenchName*/InitGui.py for pure python workbenches, or in src/Mod/*Workbenchname*/Gui/Workbench.cpp for C++ and hybrid python/C++ ones.

For example, for FEM, all command names are listed here: https://github.com/FreeCAD/FreeCAD/blob ... kbench.cpp

But that is only for the wiki page name itself. What appears in the Guicommand template could be different, if needed, for ex. to make it easier to understand (for example, add spaces inside the name)
Also ok for this

Then
- FEM_Analysis that's okay
- FEM_ShellThicknessDefinition must be "Fem_ShellThickness"
- FEM_BeamCrossSectionDefinition must be "Fem_BeamSection"
- ecc...
If this is correct I make the changes.
renatorivo
Veteran
Posts: 2611
Joined: Tue Feb 21, 2012 8:07 pm
Location: Torino - Italy

Re: FEM page title

Post by renatorivo »

bernd wrote:Renato are you gone rename FEM wiki pages?
Done :)
User avatar
bernd
Veteran
Posts: 12849
Joined: Sun Sep 08, 2013 8:07 pm
Location: Zürich, Switzerland
Contact:

Re: FEM page title

Post by bernd »

renatorivo wrote:
bernd wrote:Renato are you gone rename FEM wiki pages?
Done :)
cool, much better than before !
User avatar
yorik
Founder
Posts: 13640
Joined: Tue Feb 17, 2009 9:16 pm
Location: Brussels
Contact:

Re: FEM page title

Post by yorik »

renatorivo wrote:Then
- FEM_Analysis that's okay
- FEM_ShellThicknessDefinition must be "Fem_ShellThickness"
- FEM_BeamCrossSectionDefinition must be "Fem_BeamSection"
- ecc...
If this is correct I make the changes.
Yes exactly.

The reason for this is that so these pages are picked by the "What's this?" button in FreeCAD...
Post Reply