discuss@lists.openscad.org

OpenSCAD general discussion Mailing-list

View all threads

User manual order

DM
doug moen
Tue, Nov 10, 2015 4:22 AM

I am hoping that L will put both the print and online editions into the
same order.

On Monday, 9 November 2015, ctchin c.t.chin@szu.edu.cn wrote:

I hear you, L.  I had the same idea even before 2015-03 was released but
...
with due respect to the developers/writers who contributed so much already,
a pure re-ordering without adding and correcting the text would not be
satisfactory.  For example:

Matrix multiplication:

https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/The_OpenSCAD_Language#Matrix_Multiplication
The text is completely inadequate.  It is not reasonable to expect most
readers to understand "matrix multiplication", as many have never learned
linear algebra and most who have do not retain that knowledge.  At least a
reference (e.g. Wikipedia) and an example is needed. The behavior of
ill-posed matrix multiplication () should be explained (result in undef).

The text for minkowski() is also inadequate,  it is not an easy concept to
explain but at least an attempt should be made, and at least two examples
(2D and 3D) should be given.

There are more!

I've been wondering about the "source code" for the documentation,
especially with the "online" and "print" editions being somewhat different.
Where can I find the list(s) and the files themselves?  Then I can actually
put in my (draft) edit for the community to consider instead of just
whining
about it on the mailing list.

--
View this message in context:
http://forum.openscad.org/User-manual-order-tp14271p14331.html
Sent from the OpenSCAD mailing list archive at Nabble.com.


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

I am hoping that L will put both the print and online editions into the same order. On Monday, 9 November 2015, ctchin <c.t.chin@szu.edu.cn> wrote: > I hear you, L. I had the same idea even before 2015-03 was released but > ... > with due respect to the developers/writers who contributed so much already, > a pure re-ordering without adding and correcting the text would not be > satisfactory. For example: > > Matrix multiplication: > > https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/The_OpenSCAD_Language#Matrix_Multiplication > The text is completely inadequate. It is not reasonable to expect most > readers to understand "matrix multiplication", as many have never learned > linear algebra and most who have do not retain that knowledge. At least a > reference (e.g. Wikipedia) and an example is needed. The behavior of > ill-posed matrix multiplication () should be explained (result in undef). > > The text for minkowski() is also inadequate, it is not an easy concept to > explain but at least an attempt should be made, and at least two examples > (2D and 3D) should be given. > > There are more! > > I've been wondering about the "source code" for the documentation, > especially with the "online" and "print" editions being somewhat different. > Where can I find the list(s) and the files themselves? Then I can actually > put in my (draft) edit for the community to consider instead of just > whining > about it on the mailing list. > > > > > -- > View this message in context: > http://forum.openscad.org/User-manual-order-tp14271p14331.html > Sent from the OpenSCAD mailing list archive at Nabble.com. > > _______________________________________________ > OpenSCAD mailing list > Discuss@lists.openscad.org <javascript:;> > http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org > > >
LB
L Boyd
Fri, Nov 13, 2015 4:28 PM

The main page contents list has been revised close to what I proposed. The
language reference is now logically separate from the rest of the user
manual. There are links on the main page to where you will find printable
version of the 2 manuals.

The printable versions are now in the same order as the main page. These are
not a second  copy of the contents.  Instead, when you visit the printable
page, the latest versions of the various components are assembled into a
single page.

Besides being printable as a unit, the manual can be viewed online. The
table of contents has active links just like the main page.

Yes, the contents can be improved. I encourage each of you to do something
about it. WikiBooks allows you to edit portions without rewriting the whole
book. Jerry, you should definitely work on the getting started chapter.

Hopefully the revised organization is helpful.

Larry

--
View this message in context: http://forum.openscad.org/User-manual-order-tp14271p14448.html
Sent from the OpenSCAD mailing list archive at Nabble.com.

The main page contents list has been revised close to what I proposed. The language reference is now logically separate from the rest of the user manual. There are links on the main page to where you will find printable version of the 2 manuals. The printable versions are now in the same order as the main page. These are not a second copy of the contents. Instead, when you visit the printable page, the latest versions of the various components are assembled into a single page. Besides being printable as a unit, the manual can be viewed online. The table of contents has active links just like the main page. Yes, the contents can be improved. I encourage each of you to do something about it. WikiBooks allows you to edit portions without rewriting the whole book. Jerry, you should definitely work on the getting started chapter. Hopefully the revised organization is helpful. Larry -- View this message in context: http://forum.openscad.org/User-manual-order-tp14271p14448.html Sent from the OpenSCAD mailing list archive at Nabble.com.
DM
doug moen
Fri, Nov 13, 2015 4:41 PM

Thank you.

On Friday, 13 November 2015, L Boyd lboyd@frontiernet.net wrote:

The main page contents list has been revised close to what I proposed. The
language reference is now logically separate from the rest of the user
manual. There are links on the main page to where you will find printable
version of the 2 manuals.

The printable versions are now in the same order as the main page. These
are
not a second  copy of the contents.  Instead, when you visit the printable
page, the latest versions of the various components are assembled into a
single page.

Besides being printable as a unit, the manual can be viewed online. The
table of contents has active links just like the main page.

Yes, the contents can be improved. I encourage each of you to do something
about it. WikiBooks allows you to edit portions without rewriting the whole
book. Jerry, you should definitely work on the getting started chapter.

Hopefully the revised organization is helpful.

Larry

--
View this message in context:
http://forum.openscad.org/User-manual-order-tp14271p14448.html
Sent from the OpenSCAD mailing list archive at Nabble.com.


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

Thank you. On Friday, 13 November 2015, L Boyd <lboyd@frontiernet.net> wrote: > The main page contents list has been revised close to what I proposed. The > language reference is now logically separate from the rest of the user > manual. There are links on the main page to where you will find printable > version of the 2 manuals. > > The printable versions are now in the same order as the main page. These > are > not a second copy of the contents. Instead, when you visit the printable > page, the latest versions of the various components are assembled into a > single page. > > Besides being printable as a unit, the manual can be viewed online. The > table of contents has active links just like the main page. > > Yes, the contents can be improved. I encourage each of you to do something > about it. WikiBooks allows you to edit portions without rewriting the whole > book. Jerry, you should definitely work on the getting started chapter. > > Hopefully the revised organization is helpful. > > Larry > > > > > -- > View this message in context: > http://forum.openscad.org/User-manual-order-tp14271p14448.html > Sent from the OpenSCAD mailing list archive at Nabble.com. > > _______________________________________________ > OpenSCAD mailing list > Discuss@lists.openscad.org <javascript:;> > http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org > > >