Is "Basic Part Design Tutorial" in line with actual Part Design workflow?

Discussions about the wiki documentation of FreeCAD and its translation.
Forum rules
Be nice to others! Respect the FreeCAD code of conduct!
User avatar
onekk
Veteran
Posts: 6205
Joined: Sat Jan 17, 2015 7:48 am
Contact:

Re: Is "Basic Part Design Tutorial" in line with actual Part Design workflow?

Post by onekk »

Roy_043 wrote: Fri Oct 14, 2022 2:06 pm The new version (20221013-pdtut-cv1.py) works fine in V0.19 and can be executed multiple times in the same document.
...
Many Thanks.

Do you think that we could make a Wiki Page out of this example, with both GUI and code?

Or it is better to make a Wiki Page targeting "FreeCAD v0.19 and higher" and make a separate page for the "scripting part?

However my limited GUI and wiki ability will need some help, there is a way to test the page prior to publish and linking in the Tutorial section.

I have started to modify the page:

https://wiki.freecadweb.org/Basic_Part_ ... torial_019

EDIT:
Hoping to not have big done mistakes, I have modified the author name, and deleted the video links, plus started to delete the faces images that are not used in the "modern way".

I have some questions about how to edit wiki pages, there is some tutorial somewhere, or I could ask here?


I'm new to this sort of things, so I don't know the "procedure" and if there is a place were discuss and test pages prior to publish them.




I've done some wiki editing but some time ago (a couple of years I think, and I remember very little about this matter)



Best Regards

Carlo D.
GitHub page: https://github.com/onekk/freecad-doc.
- In deep articles on FreeCAD.
- Learning how to model with scripting.
- Various other stuffs.

Blog: https://okkmkblog.wordpress.com/
User avatar
onekk
Veteran
Posts: 6205
Joined: Sat Jan 17, 2015 7:48 am
Contact:

Re: Is "Basic Part Design Tutorial" in line with actual Part Design workflow?

Post by onekk »

I have a problem with editing the Wiki page.

There is a way to maintain a consistent list numbering adding images in between.

I have to describe steps, to make a sketch, but when I put an image the list is reset to 1, so I have to make 4 steps and put an image on the second the number is rest to 1 after the image on the second step.

Seems that using:

Code: Select all

<ul>
# item1

# item 2

<image>
# item 3
</ul> 



is not working as it is intended in the MediaWiki Help.

Regards

Carlo D.
GitHub page: https://github.com/onekk/freecad-doc.
- In deep articles on FreeCAD.
- Learning how to model with scripting.
- Various other stuffs.

Blog: https://okkmkblog.wordpress.com/
User avatar
Roy_043
Veteran
Posts: 8550
Joined: Thu Dec 27, 2018 12:28 pm

Re: Is "Basic Part Design Tutorial" in line with actual Part Design workflow?

Post by Roy_043 »

Using images inside a numbered list often leads to issues.

Instead of

Code: Select all

# Item 1
# Item 2
# Item 3
You can then use:

Code: Select all

<ol>
<li>
Item 1
</li>
<li>
Item 2
</li>
<li>
Item 3
</li>
</ol>
Have a look at the Spreadsheet_Workbench page to see some practical examples.
User avatar
onekk
Veteran
Posts: 6205
Joined: Sat Jan 17, 2015 7:48 am
Contact:

Re: Is "Basic Part Design Tutorial" in line with actual Part Design workflow?

Post by onekk »

Roy_043 wrote: Tue Oct 18, 2022 5:52 pm Using images inside a numbered list often leads to issues.
...
Have a look at the Spreadsheet_Workbench page to see some practical examples.
TY, I will gave a look and modify the wiki page accordingly, I'm going at a slow pace, and making many mistakes, but I'm still learning.

Regards

Carlo D.
GitHub page: https://github.com/onekk/freecad-doc.
- In deep articles on FreeCAD.
- Learning how to model with scripting.
- Various other stuffs.

Blog: https://okkmkblog.wordpress.com/
User avatar
onekk
Veteran
Posts: 6205
Joined: Sat Jan 17, 2015 7:48 am
Contact:

Re: Is "Basic Part Design Tutorial" in line with actual Part Design workflow?

Post by onekk »

Roy_043 wrote: Tue Oct 18, 2022 5:52 pm ...
Hello, list are almost good but is a nightmare to follow the nesting.

I have resolved to make in another way, using headings.

Now I have some problems:
  • I've made a sketch for the side profile, but using 0.20.1 I'm not sure if the autocontraints are applied even in 0.19 (as we are targeting 0.19) and sadly I can't make test as my Arch Linux has "too new" libraries to make my 0.19 AppImage work. Could you kindly test if the Pd tut side start.png is the same in 0.19
  • Could you kindly gave me an advice if till <!-- Edited till here mark added in the edit text (in "edit view") seems decently explained.
  • Any other hints and suggestion will be appreciated.
TIA and Regards

Carlo D.
GitHub page: https://github.com/onekk/freecad-doc.
- In deep articles on FreeCAD.
- Learning how to model with scripting.
- Various other stuffs.

Blog: https://okkmkblog.wordpress.com/
User avatar
Roy_043
Veteran
Posts: 8550
Joined: Thu Dec 27, 2018 12:28 pm

Re: Is "Basic Part Design Tutorial" in line with actual Part Design workflow?

Post by Roy_043 »

Some initial comments:
  1. When applying dimensional constraints you instruct the user to select endpoints of lines, when just selecting the line would save one click and therefore be preferable IMO.
  2. Do not include V0.19 instructions that are different from the V0.20 instructions. This can only cause confusion. It suggests that certain features were removed in V0.20. When the tutorial is finished let's verified if it can be used in V0.19.
  3. Because it is a beginner's tutorial the purpose of the initial rectangular base sketch needs to be explained a little bit more.
  4. Same sketch: explain that the user needs to click on the X axis for the first point.
  5. Same sketch: explain the automatic constraints that are created.
  6. The initial rectangular sketch needs to be symmetrical relative to its Y axis.
  7. You are using expressions to link dimensions to the base sketch. Keeping in mind this is a beginner's tutorial, maybe use external geometry for that purpose instead?
  8. In a formula editor image you have "<<Sketch>>.Constraints.width" with the result being 50mm. This is incorrect, it should be 26mm.
Link to the page: Basic_Part_Design_Tutorial_019.
User avatar
onekk
Veteran
Posts: 6205
Joined: Sat Jan 17, 2015 7:48 am
Contact:

Re: Is "Basic Part Design Tutorial" in line with actual Part Design workflow?

Post by onekk »

Roy_043 wrote: Sat Oct 22, 2022 9:57 am ...

Many thanks, I will try to follow your advices.

I have some problem with images.

I have done modifications, loading new versions of images, but the image are not modified, but if I try to upload the image with a different name it tells me that is duplicated. I've tried to reload the page with the F5 in browser, but the image is always the "old image".

I have to wait to see new images?

Regards

Carlo D.
GitHub page: https://github.com/onekk/freecad-doc.
- In deep articles on FreeCAD.
- Learning how to model with scripting.
- Various other stuffs.

Blog: https://okkmkblog.wordpress.com/
User avatar
Roy_043
Veteran
Posts: 8550
Joined: Thu Dec 27, 2018 12:28 pm

Re: Is "Basic Part Design Tutorial" in line with actual Part Design workflow?

Post by Roy_043 »

There is some 'latency' in the way the Wiki serves images. The larger the image the longer it takes for an updated image to be displayed.
User avatar
onekk
Veteran
Posts: 6205
Joined: Sat Jan 17, 2015 7:48 am
Contact:

Re: Is "Basic Part Design Tutorial" in line with actual Part Design workflow?

Post by onekk »

Roy_043 wrote: Sun Oct 23, 2022 1:53 pm There is some 'latency' in the way the Wiki serves images. The larger the image the longer it takes for an updated image to be displayed.
Thanks, I'm trying to adapt the tutorial with your suggestion, but it is slow as I have to check editing very often, there is a way to delete old editings, so the story will be more short, maybe this could be done by an admin, obviously when the page is finished?

I leave it until tomorrow, and see if images were changed, if not how to check if there are problems with files.

I use png files produced with a screenshot program and cropped with graphicsmagick.


EDIT: probably it is a problem with firefox cache with images, I have deleted cookies saved data for frecadweb.org and new images are shown.

Regards

Carlo D.
Last edited by onekk on Mon Oct 24, 2022 9:02 am, edited 1 time in total.
GitHub page: https://github.com/onekk/freecad-doc.
- In deep articles on FreeCAD.
- Learning how to model with scripting.
- Various other stuffs.

Blog: https://okkmkblog.wordpress.com/
User avatar
onekk
Veteran
Posts: 6205
Joined: Sat Jan 17, 2015 7:48 am
Contact:

Re: Is "Basic Part Design Tutorial" in line with actual Part Design workflow?

Post by onekk »

Roy_043 wrote: Sun Oct 23, 2022 1:53 pm ...
OK lesson learned, I have to press "CTRL+F5" in Firefox to force cache reload, to see modified images.

Could you kindly "give an eye" to the modified page, is not perfect, but I have deleted references at v0.19 and 0.20 and added a warning at top of the file to say that the screenshots are made with 0.20.1 and "not tested yet" on 0.19.

I hope to have been more clear and guide more the "newbie", but as a "newbie" myself on Wiki editing, and in general on writing Wiki Pages I need some "tutoring" myself.

Thanks in advance and Regards

Carlo D.
GitHub page: https://github.com/onekk/freecad-doc.
- In deep articles on FreeCAD.
- Learning how to model with scripting.
- Various other stuffs.

Blog: https://okkmkblog.wordpress.com/
Post Reply