thanks, runsun.

--
Extra Ham Operator: K7AZJ
Registered Linux User: 275424
Raspberry Pi and Arduino developer

The most exciting phrase to hear in science - the one that heralds new
discoveries - is not "Eureka!" but "That's funny...".- Isaac. Asimov

I
*f you give someone a program, you will frustrate them for a day; if you
teach them how to program, you will frustrate them for a lifetime. *-
Anonymous

If writing good code requires very little comments, then writing really
excellent code requires no comments at all!- Ken Thompson

On Sun, Mar 20, 2016 at 2:40 PM, runsun runsun@gmail.com wrote:

@Larry:

The table of contents for the language reference manual at
/OpenSCAD_User_Manual is different from the table of contents in
/OpenSCAD_User_Manual/The_OpenSCAD_Language.

That's to be expected, because the former has to be edited by hand, while
the latter is automatically updated each time somebody modifies the
language reference manual.

There are lots of sections missing from the manually edited table of
contents, that are present in the automatically generated one. For example,
section 1.6 (Getting Input), section 6.1.2 (intersection_for), sections
6.2.5 to 6.2.8 (vector and matrix operations), section 8.7 (parent_module).

I also noticed that the automatically generated TOC was missing a section
header for Use and Include, so I just added the missing header.

I did some research and I find there is no way to transclude the
automatically generated table of contents from The_OpenSCAD_Language into
OpenSCAD_User_Manual. I don't like the idea of having two TOCs that are out
of sync, so my proposal is to delete the one that is manually maintained,
and keep the automatically generated one.

On 20 March 2016 at 17:36, L Boyd lboyd@frontiernet.net 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.

I've made a start at that with my recent changes, but that's just been
minor cleanup work, fixing obvious bugs. And currently, the automatically
generated TOC has basically the same structure as the manually edited one:
neither is ideal.

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

One way to shorten the automatically generated TOC is to limit the depth to
2 or 3, which causes MediaWiki to ignore section headers deeper than this
(currently we have up to 4 levels of section headers).

On 20 March 2016 at 20:06, L Boyd lboyd@frontiernet.net wrote:

doug.moen wrote

I've added some markups on both pages to transclude the table_of_content on
/OpenSCAD_User_Manual/The_OpenSCAD_Language to /OpenSCAD_User_Manual so we
don't need to edit it by hand any more. Not sure if it works 'cos it is
awaiting approval from Michael.

Ref:
https://en.wikipedia.org/wiki/Wikipedia:Transclusion#Selective_transclusion
https://en.wikipedia.org/wiki/Help:Labeled_section_transclusion

$  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-tp16593p16612.html
Sent from the OpenSCAD mailing list archive at Nabble.com.

@runsun: I read the same documentation as you did, and tested something
similar. The problem was that when I transcluded the TOC tag into
OpenSCAD_User_Manual, the TOC was expanded into the user manual TOC,
not the language manual TOC. That said, if you can make it work, that will
be great. (I ran my test by publishing a change to The_OpenSCAD_Language,
and previewing a change to OpenSCAD_User_Manual. The transcluded TOC
was expanded incorrectly in the preview, and that's when I gave up.)

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

doug.moen wrote

I have done much of the customisation of that TOC, in an endeavour to have
direct links to the individual keywords rather than just to the section as
per the automatically generated one. Also to keep it compact so you don't
need to scroll the TOC.

I do periodically update it, but haven't got to it for a while.

I have just taken a copy so if people want to do something else, I'll just
stick it as sandbox page and use it myself.

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-tp16593p16615.html
Sent from the OpenSCAD mailing list archive at Nabble.com.

runsun wrote

Are you talking about:
{{#section:OpenSCAD User Manual/The OpenSCAD language|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).

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-tp16593p16617.html
Sent from the OpenSCAD mailing list archive at Nabble.com.

runsun wrote

They did nothing.

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-tp16593p16618.html
Sent from the OpenSCAD mailing list archive at Nabble.com.