discuss@lists.openscad.org

OpenSCAD general discussion Mailing-list

View all threads

Print version of OpenSCAD manual

LB
L Boyd
Mon, Mar 21, 2016 11:29 AM

@Doug: I basically agree with you suggested order for the language portion of
the manual.
Why don't you post it in a new thread so we can discuss it separate from the
debate about how the TOC should look.

doug.moen wrote

@Larry: I agree, I'd like to reorganize the material in the Language
manual
into a more logical order, and make the automatically generated TOC easier
to navigate.

My bigger plan is to reorganize the contents based on data types and the
operations on those types, because I think this will give a more logical
and useful structure. It'll be something like this:

1. General
2. Constructing 3D Objects
3. Constructing 2D Objects
4. Geometric Operations
5. Booleans
6. Numbers
7. Strings
8. Lists
9. Linear Algebra (Vectors and Matrices)
10. Functions and Modules
11. Scripts
12. Other

Larry

View this message in context: http://forum.openscad.org/Print-version-of-OpenSCAD-manual-tp16593p16624.html
Sent from the OpenSCAD mailing list archive at Nabble.com.

@Doug: I basically agree with you suggested order for the language portion of the manual. Why don't you post it in a new thread so we can discuss it separate from the debate about how the TOC should look. doug.moen wrote > @Larry: I agree, I'd like to reorganize the material in the Language > manual > into a more logical order, and make the automatically generated TOC easier > to navigate. > > My bigger plan is to reorganize the contents based on data types and the > operations on those types, because I think this will give a more logical > and useful structure. It'll be something like this: > > 1. General > 2. Constructing 3D Objects > 3. Constructing 2D Objects > 4. Geometric Operations > 5. Booleans > 6. Numbers > 7. Strings > 8. Lists > 9. Linear Algebra (Vectors and Matrices) > 10. Functions and Modules > 11. Scripts > 12. Other ----- Larry -- View this message in context: http://forum.openscad.org/Print-version-of-OpenSCAD-manual-tp16593p16624.html Sent from the OpenSCAD mailing list archive at Nabble.com.
LB
L Boyd
Mon, Mar 21, 2016 11:54 AM

@michael: Glad someone besides me finds the non-automatic TOC  more useful
even if it does require manual maintenance.


Larry

View this message in context: http://forum.openscad.org/Print-version-of-OpenSCAD-manual-tp16593p16626.html
Sent from the OpenSCAD mailing list archive at Nabble.com.

@michael: Glad someone besides me finds the non-automatic TOC more useful even if it does require manual maintenance. ----- Larry -- View this message in context: http://forum.openscad.org/Print-version-of-OpenSCAD-manual-tp16593p16626.html Sent from the OpenSCAD mailing list archive at Nabble.com.
R
runsun
Mon, Mar 21, 2016 2:21 PM

MichaelAtOz wrote

Are you talking about:

{{#section:OpenSCAD User Manual/The OpenSCAD language|TableOfContent}}
<--{{OpenSCAD User Manual/The OpenSCAD
Language|transcludesection=TableOfContent}}-->

It doesn't look any different in preview. I just rolled it back as it was
conflicting with my updates.
I'll retry it after I save my updates (the list Doug had above).

Yes, but also the markup in the source doc (OpenSCAD language), in which I
tried two different approaches:

<section begin=TableOfContent /> <onlyinclude> {{#ifeq:{{{transcludesection|TableOfContent}}}|TableOfContent| __TOC__ <p style="page-break-after:always;"> </p> }} </onlyinclude> <section end=TableOfContent />

I imagine that they have to be accepted for the transclusion-accepting doc
to work.

But I guess you guys know that, so I'll leave it here.


$  Runsun Pan, PhD $ libs: doctest , faces ( git ), offline doc ( git ), runscad.py( 1 , 2 , git ), synwrite( 1 , 2 );  $ tips: hash( 1 , 2 ), sweep( 1 , 2 ), var( 1 , 2 ), lerp , animGif , prodVid , precision( 1 , 2 ), xl-control , type , rounded polygon

--
View this message in context: http://forum.openscad.org/Print-version-of-OpenSCAD-manual-tp16593p16630.html
Sent from the OpenSCAD mailing list archive at Nabble.com.

MichaelAtOz wrote > Are you talking about: >> {{#section:OpenSCAD User Manual/The OpenSCAD language|TableOfContent}} >> <--{{OpenSCAD User Manual/The OpenSCAD >> Language|transcludesection=TableOfContent}}--> > It doesn't look any different in preview. I just rolled it back as it was > conflicting with my updates. > I'll retry it after I save my updates (the list Doug had above). Yes, but also the markup in the source doc (OpenSCAD language), in which I tried two different approaches: > <section begin=TableOfContent /> > <onlyinclude> > {{#ifeq:{{{transcludesection|TableOfContent}}}|TableOfContent| > __TOC__ > <p style="page-break-after:always;"> > </p> > }} > </onlyinclude> > <section end=TableOfContent /> I imagine that they have to be accepted for the transclusion-accepting doc to work. But I guess you guys know that, so I'll leave it here. ----- $ Runsun Pan, PhD $ libs: doctest , faces ( git ), offline doc ( git ), runscad.py( 1 , 2 , git ), synwrite( 1 , 2 ); $ tips: hash( 1 , 2 ), sweep( 1 , 2 ), var( 1 , 2 ), lerp , animGif , prodVid , precision( 1 , 2 ), xl-control , type , rounded polygon -- View this message in context: http://forum.openscad.org/Print-version-of-OpenSCAD-manual-tp16593p16630.html Sent from the OpenSCAD mailing list archive at Nabble.com.
R
runsun
Mon, Mar 21, 2016 3:18 PM

@jdawgaz:

The bug in the openscad_offliner appears to be a cross-platform issue. The
original version was developed in Linux. I've got it to work in Windows now.

In fact, I took a step further to include a openscad_doc.zip. You should be
able to just extract that file and no need to run the script by yourself,
unless a most recent version is needed.


$  Runsun Pan, PhD $ libs: doctest , faces ( git ), offline doc ( git ), runscad.py( 1 , 2 , git ), synwrite( 1 , 2 );  $ tips: hash( 1 , 2 ), sweep( 1 , 2 ), var( 1 , 2 ), lerp , animGif , prodVid , precision( 1 , 2 ), xl-control , type , rounded polygon

--
View this message in context: http://forum.openscad.org/Print-version-of-OpenSCAD-manual-tp16593p16631.html
Sent from the OpenSCAD mailing list archive at Nabble.com.

@jdawgaz: The bug in the openscad_offliner appears to be a cross-platform issue. The original version was developed in Linux. I've got it to work in Windows now. In fact, I took a step further to include a openscad_doc.zip. You should be able to just extract that file and no need to run the script by yourself, unless a most recent version is needed. ----- $ Runsun Pan, PhD $ libs: doctest , faces ( git ), offline doc ( git ), runscad.py( 1 , 2 , git ), synwrite( 1 , 2 ); $ tips: hash( 1 , 2 ), sweep( 1 , 2 ), var( 1 , 2 ), lerp , animGif , prodVid , precision( 1 , 2 ), xl-control , type , rounded polygon -- View this message in context: http://forum.openscad.org/Print-version-of-OpenSCAD-manual-tp16593p16631.html Sent from the OpenSCAD mailing list archive at Nabble.com.
DM
doug moen
Mon, Mar 21, 2016 5:01 PM

@runsun: The changes don't have to be accepted before you can test your
code. After all, the person doing the accepting has to be able to see what
he's accepting, right? I was able to test a similar approach (using
#section-h instead of #section), and got results, just not the results I
wanted. I reverted my changes already, so they never reached the acceptance
stage.

On 21 March 2016 at 10:21, runsun runsun@gmail.com wrote:

MichaelAtOz wrote

Are you talking about:

{{#section:OpenSCAD User Manual/The OpenSCAD language|TableOfContent}}
<--{{OpenSCAD User Manual/The OpenSCAD
Language|transcludesection=TableOfContent}}-->

It doesn't look any different in preview. I just rolled it back as it was
conflicting with my updates.
I'll retry it after I save my updates (the list Doug had above).

Yes, but also the markup in the source doc (OpenSCAD language), in which I
tried two different approaches:

<section begin=TableOfContent /> <onlyinclude> {{#ifeq:{{{transcludesection|TableOfContent}}}|TableOfContent| __TOC__ <p style="page-break-after:always;"> </p> }} </onlyinclude> <section end=TableOfContent />

I imagine that they have to be accepted for the transclusion-accepting doc
to work.

But I guess you guys know that, so I'll leave it here.


$  Runsun Pan, PhD $ libs: doctest , faces ( git ), offline doc ( git ),
runscad.py( 1 , 2 , git ), synwrite( 1 , 2 );  $ tips: hash( 1 , 2 ),
sweep( 1 , 2 ), var( 1 , 2 ), lerp , animGif , prodVid , precision( 1 , 2
), xl-control , type , rounded polygon

--
View this message in context:
http://forum.openscad.org/Print-version-of-OpenSCAD-manual-tp16593p16630.html
Sent from the OpenSCAD mailing list archive at Nabble.com.


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

@runsun: The changes don't have to be accepted before you can test your code. After all, the person doing the accepting has to be able to see what he's accepting, right? I was able to test a similar approach (using #section-h instead of #section), and got results, just not the results I wanted. I reverted my changes already, so they never reached the acceptance stage. On 21 March 2016 at 10:21, runsun <runsun@gmail.com> wrote: > MichaelAtOz wrote > > Are you talking about: > >> {{#section:OpenSCAD User Manual/The OpenSCAD language|TableOfContent}} > >> <--{{OpenSCAD User Manual/The OpenSCAD > >> Language|transcludesection=TableOfContent}}--> > > It doesn't look any different in preview. I just rolled it back as it was > > conflicting with my updates. > > I'll retry it after I save my updates (the list Doug had above). > > Yes, but also the markup in the source doc (OpenSCAD language), in which I > tried two different approaches: > > > <section begin=TableOfContent /> > > <onlyinclude> > > {{#ifeq:{{{transcludesection|TableOfContent}}}|TableOfContent| > > __TOC__ > > <p style="page-break-after:always;"> > > </p> > > }} > > </onlyinclude> > > <section end=TableOfContent /> > > I imagine that they have to be accepted for the transclusion-accepting doc > to work. > > But I guess you guys know that, so I'll leave it here. > > > > > ----- > > $ Runsun Pan, PhD $ libs: doctest , faces ( git ), offline doc ( git ), > runscad.py( 1 , 2 , git ), synwrite( 1 , 2 ); $ tips: hash( 1 , 2 ), > sweep( 1 , 2 ), var( 1 , 2 ), lerp , animGif , prodVid , precision( 1 , 2 > ), xl-control , type , rounded polygon > > > > > > -- > View this message in context: > http://forum.openscad.org/Print-version-of-OpenSCAD-manual-tp16593p16630.html > Sent from the OpenSCAD mailing list archive at Nabble.com. > > _______________________________________________ > OpenSCAD mailing list > Discuss@lists.openscad.org > http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org > > >
R
runsun
Mon, Mar 21, 2016 5:44 PM

doug.moen wrote

@runsun: The changes don't have to be accepted before you can test your
code. After all, the person doing the accepting has to be able to see what
he's accepting, right?

That's true --- if the change doesn't depend on other pages. But what I
tried was a markup on page-A depends on a markup on page-B. Only if the
markup on B is accepted, and thus an anchor is existing to be located, will
the markup on A be able to locate it and show effect. So to see if the
markup on A works, the markup on B has to be accepted.

Of course, if the wikibook is designed in such a way that a transclusion on
A is to link to a modification on B that is not yet accepted, then it'd be
another story.


$  Runsun Pan, PhD $ libs: doctest , faces ( git ), offline doc ( git ), runscad.py( 1 , 2 , git ), synwrite( 1 , 2 );  $ tips: hash( 1 , 2 ), sweep( 1 , 2 ), var( 1 , 2 ), lerp , animGif , prodVid , precision( 1 , 2 ), xl-control , type , rounded polygon

--
View this message in context: http://forum.openscad.org/Print-version-of-OpenSCAD-manual-tp16593p16636.html
Sent from the OpenSCAD mailing list archive at Nabble.com.

doug.moen wrote > @runsun: The changes don't have to be accepted before you can test your > code. After all, the person doing the accepting has to be able to see what > he's accepting, right? That's true --- if the change doesn't depend on other pages. But what I tried was a markup on page-A depends on a markup on page-B. Only if the markup on B is accepted, and thus an anchor is existing to be located, will the markup on A be able to locate it and show effect. So to see if the markup on A works, the markup on B has to be accepted. Of course, if the wikibook is designed in such a way that a transclusion on A is to link to a modification on B that is not yet accepted, then it'd be another story. ----- $ Runsun Pan, PhD $ libs: doctest , faces ( git ), offline doc ( git ), runscad.py( 1 , 2 , git ), synwrite( 1 , 2 ); $ tips: hash( 1 , 2 ), sweep( 1 , 2 ), var( 1 , 2 ), lerp , animGif , prodVid , precision( 1 , 2 ), xl-control , type , rounded polygon -- View this message in context: http://forum.openscad.org/Print-version-of-OpenSCAD-manual-tp16593p16636.html Sent from the OpenSCAD mailing list archive at Nabble.com.
DM
doug moen
Mon, Mar 21, 2016 6:56 PM

@runsun: Only if the
markup on B is accepted, and thus an anchor is existing to be located, will
the markup on A be able to locate it and show effect. So to see if the
markup on A works, the markup on B has to be accepted.

Yes, but for the third time, I already tested a version of your changes
without waiting for my changes to B to be accepted. All I needed to do was
publish my changes to B. One thing to note: I was logged in to Wikipedia
when I did this, and that might change the behaviour. Otherwise, I don't
know why the same procedure wouldn't work for you.

On 21 March 2016 at 13:44, runsun runsun@gmail.com wrote:

doug.moen wrote

@runsun: The changes don't have to be accepted before you can test your
code. After all, the person doing the accepting has to be able to see

what

he's accepting, right?

That's true --- if the change doesn't depend on other pages. But what I
tried was a markup on page-A depends on a markup on page-B. Only if the
markup on B is accepted, and thus an anchor is existing to be located, will
the markup on A be able to locate it and show effect. So to see if the
markup on A works, the markup on B has to be accepted.

Of course, if the wikibook is designed in such a way that a transclusion on
A is to link to a modification on B that is not yet accepted, then it'd be
another story.


$  Runsun Pan, PhD $ libs: doctest , faces ( git ), offline doc ( git ),
runscad.py( 1 , 2 , git ), synwrite( 1 , 2 );  $ tips: hash( 1 , 2 ),
sweep( 1 , 2 ), var( 1 , 2 ), lerp , animGif , prodVid , precision( 1 , 2
), xl-control , type , rounded polygon

--
View this message in context:
http://forum.openscad.org/Print-version-of-OpenSCAD-manual-tp16593p16636.html
Sent from the OpenSCAD mailing list archive at Nabble.com.


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

@runsun: Only if the markup on B is accepted, and thus an anchor is existing to be located, will the markup on A be able to locate it and show effect. So to see if the markup on A works, the markup on B has to be accepted. Yes, but for the third time, I already tested a version of your changes without waiting for my changes to B to be accepted. All I needed to do was publish my changes to B. One thing to note: I was logged in to Wikipedia when I did this, and that might change the behaviour. Otherwise, I don't know why the same procedure wouldn't work for you. On 21 March 2016 at 13:44, runsun <runsun@gmail.com> wrote: > doug.moen wrote > > @runsun: The changes don't have to be accepted before you can test your > > code. After all, the person doing the accepting has to be able to see > what > > he's accepting, right? > > That's true --- if the change doesn't depend on other pages. But what I > tried was a markup on page-A depends on a markup on page-B. Only if the > markup on B is accepted, and thus an anchor is existing to be located, will > the markup on A be able to locate it and show effect. So to see if the > markup on A works, the markup on B has to be accepted. > > Of course, if the wikibook is designed in such a way that a transclusion on > A is to link to a modification on B that is not yet accepted, then it'd be > another story. > > > > > ----- > > $ Runsun Pan, PhD $ libs: doctest , faces ( git ), offline doc ( git ), > runscad.py( 1 , 2 , git ), synwrite( 1 , 2 ); $ tips: hash( 1 , 2 ), > sweep( 1 , 2 ), var( 1 , 2 ), lerp , animGif , prodVid , precision( 1 , 2 > ), xl-control , type , rounded polygon > > > > > > -- > View this message in context: > http://forum.openscad.org/Print-version-of-OpenSCAD-manual-tp16593p16636.html > Sent from the OpenSCAD mailing list archive at Nabble.com. > > _______________________________________________ > OpenSCAD mailing list > Discuss@lists.openscad.org > http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org > > >
M
MichaelAtOz
Mon, Mar 21, 2016 11:47 PM

I tried it with both, didn't do anything. But I'm no expert.

People are aware that the printed versions are basically transcluded from
the main manual?


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

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!

View this message in context: http://forum.openscad.org/Print-version-of-OpenSCAD-manual-tp16593p16643.html
Sent from the OpenSCAD mailing list archive at Nabble.com.

I tried it with both, didn't do anything. But I'm no expert. People are aware that the printed versions are basically transcluded from the main manual? ----- Admin - PM me if you need anything, or if I've done something stupid... 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! -- View this message in context: http://forum.openscad.org/Print-version-of-OpenSCAD-manual-tp16593p16643.html Sent from the OpenSCAD mailing list archive at Nabble.com.
JD
Jerry Davis
Mon, Mar 21, 2016 11:53 PM

I looked up transclude in my dictionary and was not found, so what does
that mean?
On Mar 21, 2016 4:48 PM, "MichaelAtOz" oz.at.michael@gmail.com wrote:

I tried it with both, didn't do anything. But I'm no expert.

People are aware that the printed versions are basically transcluded from
the main manual?


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

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!

View this message in context:
http://forum.openscad.org/Print-version-of-OpenSCAD-manual-tp16593p16643.html
Sent from the OpenSCAD mailing list archive at Nabble.com.


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

I looked up transclude in my dictionary and was not found, so what does that mean? On Mar 21, 2016 4:48 PM, "MichaelAtOz" <oz.at.michael@gmail.com> wrote: > I tried it with both, didn't do anything. But I'm no expert. > > People are aware that the printed versions are basically transcluded from > the main manual? > > > > ----- > Admin - PM me if you need anything, or if I've done something stupid... > > 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! > -- > View this message in context: > http://forum.openscad.org/Print-version-of-OpenSCAD-manual-tp16593p16643.html > Sent from the OpenSCAD mailing list archive at Nabble.com. > > _______________________________________________ > OpenSCAD mailing list > Discuss@lists.openscad.org > http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org >
M
MichaelAtOz
Tue, Mar 22, 2016 12:14 AM

transclude https://www.mediawiki.org/wiki/Transclusion  , copies sections
into another book.


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

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!

View this message in context: http://forum.openscad.org/Print-version-of-OpenSCAD-manual-tp16593p16645.html
Sent from the OpenSCAD mailing list archive at Nabble.com.

transclude <https://www.mediawiki.org/wiki/Transclusion> , copies sections into another book. ----- Admin - PM me if you need anything, or if I've done something stupid... 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! -- View this message in context: http://forum.openscad.org/Print-version-of-OpenSCAD-manual-tp16593p16645.html Sent from the OpenSCAD mailing list archive at Nabble.com.