discuss@lists.openscad.org

OpenSCAD general discussion Mailing-list

View all threads

OpenSCAD Tutorial - Google Season of Docs

TP
Torsten Paul
Tue, Oct 22, 2019 4:10 PM

As we are now in the middle of the GSoD timeline, here's
an update of what happened so far.

We decided that the final place for the tutorial will
be also on Wikibooks, some initial pages are places there
to register the book name, but it's not the latest state
of documentation.
(https://en.wikibooks.org/wiki/OpenSCAD_Tutorial)

For now the ongoing work can be found on our file server
as PDF files per chapter:

http://files.openscad.org/tutorial/

If you have some time to spare, please have a look and
provide feedback on what's good and/or what should be
improved. Also examples that could be used for later
chapters could be very helpful.

ciao,
Torsten.

As we are now in the middle of the GSoD timeline, here's an update of what happened so far. We decided that the final place for the tutorial will be also on Wikibooks, some initial pages are places there to register the book name, but it's not the latest state of documentation. (https://en.wikibooks.org/wiki/OpenSCAD_Tutorial) For now the ongoing work can be found on our file server as PDF files per chapter: http://files.openscad.org/tutorial/ If you have some time to spare, please have a look and provide feedback on what's good and/or what should be improved. Also examples that could be used for later chapters could be very helpful. ciao, Torsten.
R
Robin2
Tue, Oct 22, 2019 8:06 PM

This is very interesting.

The first thing that occurred to me is a question I have posed in this Forum
before - who is the "customer?" or, "what sort of user is OpenSCAD trying to
attract?" And "what is the purpose of using OpenSCAD?" or "why would one
want to use OpenSCAD?"

I think it would actually be useful to have an introductory chapter that
sets these things out clearly because doing so will {A} give the author(s)
focus and {B} forestall comments that are unrelated to the purpose of the
tutorial and {C} give the reader the information to decide whether or not to
read the Tutorial.

I hope the aim is to attract anyone who is looking for a convenient way to
create a 3D model (most likely for 3D printing) using a program that has a
fairly easy learning curve.

The next thing that occurred to me is how the content of the tutorial seems
a million miles away from the discussion in many (most?) of the Threads on
this Forum - they tend to be about very esoteric problems in OpenSCAD, far
beyond the scope of a beginner.

As far as the content is concerned, I wonder if there is rather too much of
the "follow along". I suspect it may be challenging the reader's attention
span, especially with the modern tendency to expect everything in a
sound-bite. That might be alleviated with an index and a style that allows
the reader to skip to the parts that interest him or her. However that would
require that a person could start at (say) Chapter 4 without needing to have
created his Chapter 4 starting point by working through all the stuff in the
earlier chapters. Perhaps there could be a simple way to download all the
script that would be needed at the start of Chapter 4. (By the way I just
mention Chapter 4 at random for illustration).

Finally (for now) if (as I hope) the aim is to attract users from all walks
of life and not just those with prior programming experience I believe some
effort should be put into creating an easy to use GUI front end for
OpenSCAD. I gave some details of my own attempt to do so (ClikScad) in a
recent Forum Thread. I am not claiming any greatness for my own attempt  but
I hope it may provide a basis for discussion about the idea of a GUI.

...R

--
Sent from: http://forum.openscad.org/

This is very interesting. The first thing that occurred to me is a question I have posed in this Forum before - who is the "customer?" or, "what sort of user is OpenSCAD trying to attract?" And "what is the purpose of using OpenSCAD?" or "why would one want to use OpenSCAD?" I think it would actually be useful to have an introductory chapter that sets these things out clearly because doing so will {A} give the author(s) focus and {B} forestall comments that are unrelated to the purpose of the tutorial and {C} give the reader the information to decide whether or not to read the Tutorial. I hope the aim is to attract anyone who is looking for a convenient way to create a 3D model (most likely for 3D printing) using a program that has a fairly easy learning curve. The next thing that occurred to me is how the content of the tutorial seems a million miles away from the discussion in many (most?) of the Threads on this Forum - they tend to be about very esoteric problems in OpenSCAD, far beyond the scope of a beginner. As far as the content is concerned, I wonder if there is rather too much of the "follow along". I suspect it may be challenging the reader's attention span, especially with the modern tendency to expect everything in a sound-bite. That might be alleviated with an index and a style that allows the reader to skip to the parts that interest him or her. However that would require that a person could start at (say) Chapter 4 without needing to have created his Chapter 4 starting point by working through all the stuff in the earlier chapters. Perhaps there could be a simple way to download all the script that would be needed at the start of Chapter 4. (By the way I just mention Chapter 4 at random for illustration). Finally (for now) if (as I hope) the aim is to attract users from all walks of life and not just those with prior programming experience I believe some effort should be put into creating an easy to use GUI front end for OpenSCAD. I gave some details of my own attempt to do so (ClikScad) in a recent Forum Thread. I am not claiming any greatness for my own attempt but I hope it may provide a basis for discussion about the idea of a GUI. ...R -- Sent from: http://forum.openscad.org/
R
Robin2
Tue, Oct 22, 2019 8:11 PM

Why has my Reply on this Topic appeared under some other user's name?

I strongly object to this in principle.

And from a practical point of view it means I cannot make a necessary edit
to my text.

...Robin2

--
Sent from: http://forum.openscad.org/

Why has my Reply on this Topic appeared under some other user's name? I strongly object to this in principle. And from a practical point of view it means I cannot make a necessary edit to my text. ...Robin2 -- Sent from: http://forum.openscad.org/
M
MichaelAtOz
Tue, Oct 22, 2019 11:51 PM

OpenSCAD mailing list wrote

Why has my Reply on this Topic appeared under some other user's name?

I strongly object to this in principle.

And from a practical point of view it means I cannot make a necessary edit
to my text.

...Robin2

--
Sent from: http://forum.openscad.org/


OpenSCAD mailing list

Discuss@.openscad

Yes, apologies to all, I stuffed-up Mailman DMARC settings.
Looks like it is back to normal now.
Normal still means if you have an address from a domain with DMARC policy of
Reject* it will have difficulties. I've been trying to fix this integration
issue with Nabble.

  • such as yahoo and any of their friends like aol.

Admin - email* me if you need anything, or if I've done something stupid...

  • click on my MichaelAtOz label, there is a link to email me.

Unless specifically shown otherwise above, my contribution is in the Public Domain; to the extent possible under law, I have waived all copyright and related or neighbouring rights to this work. Obviously inclusion of works of previous authors is not included in the above.

The TPP is no simple “trade agreement.”  Fight it! http://www.ourfairdeal.org/  time is running out!

Sent from: http://forum.openscad.org/

OpenSCAD mailing list wrote > Why has my Reply on this Topic appeared under some other user's name? > > I strongly object to this in principle. > > And from a practical point of view it means I cannot make a necessary edit > to my text. > > ...Robin2 > > > > -- > Sent from: http://forum.openscad.org/ > > _______________________________________________ > OpenSCAD mailing list > Discuss@.openscad > http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org Yes, apologies to all, I stuffed-up Mailman DMARC settings. Looks like it is back to normal now. Normal still means if you have an address from a domain with DMARC policy of Reject* it will have difficulties. I've been trying to fix this integration issue with Nabble. * such as yahoo and any of their friends like aol. ----- Admin - email* me if you need anything, or if I've done something stupid... * click on my MichaelAtOz label, there is a link to email me. Unless specifically shown otherwise above, my contribution is in the Public Domain; to the extent possible under law, I have waived all copyright and related or neighbouring rights to this work. Obviously inclusion of works of previous authors is not included in the above. The TPP is no simple “trade agreement.” Fight it! http://www.ourfairdeal.org/ time is running out! -- Sent from: http://forum.openscad.org/
R
Robin2
Wed, Oct 23, 2019 7:54 AM

This is a test to see if this Post is correctly attributed to me

...Robin2

--
Sent from: http://forum.openscad.org/

This is a test to see if this Post is correctly attributed to me ...Robin2 -- Sent from: http://forum.openscad.org/
R
Robin2
Wed, Oct 23, 2019 8:02 AM

Some comments on the proposed Tutorial ...

This is very interesting.

The first thing that occurred to me is a question I have posed in this Forum
before - who is the "customer?" or, "what sort of user is OpenSCAD trying to
attract?" And "what is the purpose of using OpenSCAD?" or "why would one
want to use OpenSCAD?"

I think it would actually be useful to have an introductory chapter that
sets these things out clearly because doing so will {A} give the author(s)
focus and {B} forestall comments that are unrelated to the purpose of the
tutorial and {C} give the reader the information to decide whether or not to
read the Tutorial.

I hope the aim is to attract anyone who is looking for a convenient way to
create a 3D model (most likely for 3D printing) using a program that has a
fairly easy learning curve.

The next thing that occurred to me is how the content of the tutorial seems
a million miles away from the discussion in many (most?) of the Threads on
this Forum - they tend to be about very esoteric problems in OpenSCAD, far
beyond the scope of a beginner. However this is not a criticism of the
Tutorial - I believe it should be aimed at beginners.

As far as the content is concerned, I wonder if there is rather too much of
the "follow along". I suspect it may be challenging the reader's attention
span, especially with the modern tendency to expect everything in a
sound-bite. That might be alleviated with an index and a style that allows
the reader to skip to the parts that interest him or her. However that would
require that a person could start at (say) Chapter 4 without needing to have
created his Chapter 4 starting point by working through all the stuff in the
earlier chapters. Perhaps there could be a simple way to download all the
script that would be needed at the start of Chapter 4. (By the way I just
mention Chapter 4 at random for illustration).

Finally (for now) if (as I hope) the aim is to attract users from all walks
of life and not just those with prior programming experience I believe some
effort should be put into creating an easy to use GUI front end for
OpenSCAD. I gave some details of my own attempt to do so (ClikScad) in a
recent Forum Thread. I am not claiming any greatness for my own attempt  but
I hope it may provide a basis for discussion about the idea of a GUI.

...Robin2

--
Sent from: http://forum.openscad.org/

Some comments on the proposed Tutorial ... This is very interesting. The first thing that occurred to me is a question I have posed in this Forum before - who is the "customer?" or, "what sort of user is OpenSCAD trying to attract?" And "what is the purpose of using OpenSCAD?" or "why would one want to use OpenSCAD?" I think it would actually be useful to have an introductory chapter that sets these things out clearly because doing so will {A} give the author(s) focus and {B} forestall comments that are unrelated to the purpose of the tutorial and {C} give the reader the information to decide whether or not to read the Tutorial. I hope the aim is to attract anyone who is looking for a convenient way to create a 3D model (most likely for 3D printing) using a program that has a fairly easy learning curve. The next thing that occurred to me is how the content of the tutorial seems a million miles away from the discussion in many (most?) of the Threads on this Forum - they tend to be about very esoteric problems in OpenSCAD, far beyond the scope of a beginner. However this is not a criticism of the Tutorial - I believe it should be aimed at beginners. As far as the content is concerned, I wonder if there is rather too much of the "follow along". I suspect it may be challenging the reader's attention span, especially with the modern tendency to expect everything in a sound-bite. That might be alleviated with an index and a style that allows the reader to skip to the parts that interest him or her. However that would require that a person could start at (say) Chapter 4 without needing to have created his Chapter 4 starting point by working through all the stuff in the earlier chapters. Perhaps there could be a simple way to download all the script that would be needed at the start of Chapter 4. (By the way I just mention Chapter 4 at random for illustration). Finally (for now) if (as I hope) the aim is to attract users from all walks of life and not just those with prior programming experience I believe some effort should be put into creating an easy to use GUI front end for OpenSCAD. I gave some details of my own attempt to do so (ClikScad) in a recent Forum Thread. I am not claiming any greatness for my own attempt but I hope it may provide a basis for discussion about the idea of a GUI. ...Robin2 -- Sent from: http://forum.openscad.org/
PR
Peter Ragosch
Wed, Oct 23, 2019 11:24 AM

Am Tue, 22 Oct 2019 18:10:36 +0200
schrieb Torsten Paul via Discuss discuss@lists.openscad.org:

For now the ongoing work can be found on our file server
as PDF files per chapter:

http://files.openscad.org/tutorial/

ciao,
Torsten.


OpenSCAD mailing list
Discuss@lists.openscad.org
http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org

Well done Thorsten! Keep it up!

With this tutorial, anyone who can read and write should now be able to
find their way into the scripting language of OpenSCAD.

Although I already have experience with (some commands/parts of)
OpenSCAD, I have read these chapters with great interest. For my
knowledge level, it was not necessary to work through the given
examples in detail, only the study of the source code was sufficient.
However, one explanation or the other of the given code gave me a new
and deeper insight.

As Robin2 already wrote in the first section of his email, an
Introductory chapter and a Table of Contents (as usual) certainly makes
sense.

Curious, I wait for more chapters of this tutorial and hope that in
later chapters some of the "very esoteric problems in OpenSCAD", far
beyond my knowledge, will be discussed.

--
Mit freundlichen Grüßen
Best Regards

Peter Ragosch

Am Tue, 22 Oct 2019 18:10:36 +0200 schrieb Torsten Paul via Discuss <discuss@lists.openscad.org>: > For now the ongoing work can be found on our file server > as PDF files per chapter: > > http://files.openscad.org/tutorial/ > > > ciao, > Torsten. > > > _______________________________________________ > OpenSCAD mailing list > Discuss@lists.openscad.org > http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org > Well done Thorsten! Keep it up! With this tutorial, anyone who can read and write should now be able to find their way into the scripting language of OpenSCAD. Although I already have experience with (some commands/parts of) OpenSCAD, I have read these chapters with great interest. For my knowledge level, it was not necessary to work through the given examples in detail, only the study of the source code was sufficient. However, one explanation or the other of the given code gave me a new and deeper insight. As Robin2 already wrote in the first section of his email, an Introductory chapter and a Table of Contents (as usual) certainly makes sense. Curious, I wait for more chapters of this tutorial and hope that in later chapters some of the "very esoteric problems in OpenSCAD", far beyond my knowledge, will be discussed. -- Mit freundlichen Grüßen Best Regards Peter Ragosch
JB
Jordan Brown
Wed, Oct 23, 2019 9:40 PM

On 10/22/2019 1:06 PM, Robin2 via Discuss wrote:

Finally (for now) if (as I hope) the aim is to attract users from all walks
of life and not just those with prior programming experience I believe some
effort should be put into creating an easy to use GUI front end for
OpenSCAD. I gave some details of my own attempt to do so (ClikScad) in a
recent Forum Thread. I am not claiming any greatness for my own attempt  but
I hope it may provide a basis for discussion about the idea of a GUI.

Have you looked at BlocksCAD?

https://www.blockscad3d.com/editor/

On 10/22/2019 1:06 PM, Robin2 via Discuss wrote: > Finally (for now) if (as I hope) the aim is to attract users from all walks > of life and not just those with prior programming experience I believe some > effort should be put into creating an easy to use GUI front end for > OpenSCAD. I gave some details of my own attempt to do so (ClikScad) in a > recent Forum Thread. I am not claiming any greatness for my own attempt but > I hope it may provide a basis for discussion about the idea of a GUI. Have you looked at BlocksCAD? https://www.blockscad3d.com/editor/
R
Robin2
Thu, Oct 24, 2019 7:05 AM

JordanBrown wrote

Have you looked at BlocksCAD?

Yes.

Do you use Blocksad regularly?

...R

--
Sent from: http://forum.openscad.org/

JordanBrown wrote > Have you looked at BlocksCAD? Yes. Do you use Blocksad regularly? ...R -- Sent from: http://forum.openscad.org/
P
Parkinbot
Thu, Oct 24, 2019 8:16 AM

Thorsten,

the screen shots seem to use orthogonal view. Isn't that a bit
counterintuitive? If it is intended, then it might be a good idea, to
mention at least the other view. I have noticed that in the user manual both
views are used for screen shots.

Personally I use this view only in special situations, e.g. together with
axes alignment (Top, Bottom ...). Therefore I wonder if someone would use it
deliberatly in 3D model development.

  • Rudolf -

--
Sent from: http://forum.openscad.org/

Thorsten, the screen shots seem to use orthogonal view. Isn't that a bit counterintuitive? If it is intended, then it might be a good idea, to mention at least the other view. I have noticed that in the user manual both views are used for screen shots. Personally I use this view only in special situations, e.g. together with axes alignment (Top, Bottom ...). Therefore I wonder if someone would use it deliberatly in 3D model development. - Rudolf - -- Sent from: http://forum.openscad.org/