Path tutorial
Forum rules
Be nice to others! Respect the FreeCAD code of conduct!
Be nice to others! Respect the FreeCAD code of conduct!
Path tutorial
Hi guys,
We currently only have a Path_scripting tutorial in the wiki. The Path WB has been available since 0.16, but it seems new changes have been introduced to the 0.17 development version. Should we develop a tutorial for the 0.16 version based on the current stable version and videos published for it, or would it be wise to wait for the 0.17 release?
We currently only have a Path_scripting tutorial in the wiki. The Path WB has been available since 0.16, but it seems new changes have been introduced to the 0.17 development version. Should we develop a tutorial for the 0.16 version based on the current stable version and videos published for it, or would it be wise to wait for the 0.17 release?
Need help? Feel free to ask, but please read the guidelines first
Re: Path tutorial
It would be very wise to wait for the 0.17 version. There are things in the queue waiting to be adapted to further planned changes.
A Sketcher Lecture with in-depth information is available in English, auf Deutsch, en français, en español.
- kkremitzki
- Veteran
- Posts: 2517
- Joined: Thu Mar 03, 2016 9:52 pm
- Location: Illinois
Re: Path tutorial
The 0.16 vs 0.17 wiki issues are going to start popping up more and more. There's a mediawiki solution for it: https://www.mediawiki.org/wiki/Namespaces
Re: Path tutorial
Oh yeah. More and more new users coming here and already on 0.17.The 0.16 vs 0.17 wiki issues are going to start popping up more and more.
So a 0.17 page would be 0.17:Path_Workbench ?
How does the user know which one to look for? Do we clone all the pages?
Re: Path tutorial
Or maybe dev:Path_Workbench?NormandC wrote:So a 0.17 page would be 0.17:Path_Workbench ?
- kkremitzki
- Veteran
- Posts: 2517
- Joined: Thu Mar 03, 2016 9:52 pm
- Location: Illinois
Re: Path tutorial
Right, once the custom namespace is created, pages which *could* have 0.17-specific updates will now have a place to live. There's an extension:NormandC wrote:Oh yeah. More and more new users coming here and already on 0.17.The 0.16 vs 0.17 wiki issues are going to start popping up more and more.
So a 0.17 page would be 0.17:Path_Workbench ?
How does the user know which one to look for? Do we clone all the pages?
https://www.mediawiki.org/wiki/Extension:Duplicator
that will allow pages to be easily cloned into the new namespace, although really old/big ones may need to be copy+pasted manually.
My suggestion: rather than use a 0.17 namespace, we future-proof it by calling it "dev". Then, when 0.17 releases, we can do a batch move of all dev-namespace pages into a new "stable" namespace. If that version then is no longer the stable major version but is still supported, then those pages can be moved into a numbered version like 0.17. If, instead, that version will no longer be supported, the pages could be dumped into an "unsupported" namespace. That way it is clear that the content of a wiki page may work, but is not guaranteed to do so.
That's sort of a long view, but in general, I think "dev" and "stable" should be the short-term response plan around the 0.17 release fracas.
Re: Path tutorial
Ahem.kkremitzki wrote:My suggestion: rather than use a 0.17 namespace, we future-proof it by calling it "dev".
NormandC wrote:Or maybe dev:Path_Workbench?
Seems sensible, but a lot of work, and not many people maintain the wiki's content... Then there are the translations.kkremitzki wrote:That's sort of a long view, but in general, I think "dev" and "stable" should be the short-term response plan around the 0.17 release fracas.
- kkremitzki
- Veteran
- Posts: 2517
- Joined: Thu Mar 03, 2016 9:52 pm
- Location: Illinois
Re: Path tutorial
Yeah, I took too long to write up that reply...NormandC wrote:Ahem.kkremitzki wrote:My suggestion: rather than use a 0.17 namespace, we future-proof it by calling it "dev".
NormandC wrote:Or maybe dev:Path_Workbench?
Yeah, before implementing something this big I'd definitely like to test it in my staging environment and see how it impacts everything, including translations.Seems sensible, but a lot of work, and not many people maintain the wiki's content... Then there are the translations.kkremitzki wrote:That's sort of a long view, but in general, I think "dev" and "stable" should be the short-term response plan around the 0.17 release fracas.
I don't think it's much more work beyond the long-term maintenance that would otherwise be done with documentation. Right now, if this feature were set up, current maintainers of pages could start making changes they may have already wanted to, and which may already exist in sandbox pages, which are themselves a namespace; namespaces are already in use informally. Changes to the "dev" namespace can be made up until 0.17 release, at which point it will be cleared out into "stable" which can continue to have known-good pages added to it. The "dev" namespace at that point will be mostly empty for a long time.
Anyway, we have dragged this thread quite off topic for a while. This big of a change should definitely be tested, so let's postpone further discussion until I get a working testbed set up, eh? Then I'll create a new thread for it.
Re: Path tutorial
I have to confess, that I recommend to give the 0.17 a try as soon as it comes to Path Workbench. There has been so much clarification of concepts and so much development, that I wouldn't use the 0.16 Path Workbench at all.
The situation in Path WB is different from PartDesign Next, because Part Design has a well known, well settled, well debugged stable version in 0.16, while Path Workbench hadn't reached this level of maturity.
So I wouldn't care much about the 0.16 wiki and go straight to the 0.17. I had offered to contribute to a 0.17 documentation but sliptonic stopped me doing possibly useless work because things change too fast. So we might wait a little bit longer and meanwhile point newcomers to dedicated forum threads.
The situation in Path WB is different from PartDesign Next, because Part Design has a well known, well settled, well debugged stable version in 0.16, while Path Workbench hadn't reached this level of maturity.
So I wouldn't care much about the 0.16 wiki and go straight to the 0.17. I had offered to contribute to a 0.17 documentation but sliptonic stopped me doing possibly useless work because things change too fast. So we might wait a little bit longer and meanwhile point newcomers to dedicated forum threads.
A Sketcher Lecture with in-depth information is available in English, auf Deutsch, en français, en español.
Re: Path tutorial
Seems like a sensible option to me.chrisb wrote:So we might wait a little bit longer and meanwhile point newcomers to dedicated forum threads.
Please keep us updated on that. The idea is good, I suggest looking at how other CAD programs and companies manage their documentation and see if we can adopt any useful ideas from them.kkremitzki wrote: Yeah, before implementing something this big I'd definitely like to test it in my staging environment and see how it impacts everything, including translations.
My suggestions are to look for:
- Solidworks documentation. It's sorted per year/release version and some stuff is blatantly copied and pasted from previous versions because changes did not occur in some areas.
- Siemens NX documentation. Access is somewhat limited, though I have a Learning Advantage license that allows me to view the latest documentation for new releases. Documentation is handled in the same way as Solidworks: copy+paste for things that haven't changed at all.
- SolidEdge Documentation
- Autodesk Inventor
Need help? Feel free to ask, but please read the guidelines first