Print version of OpenSCAD manual

classic Classic list List threaded Threaded
32 messages Options
12
Reply | Threaded
Open this post in threaded view
|

Print version of OpenSCAD manual

L Boyd
How important is a print version of the OpenSCAD manual as opposed to the online version?

WikiBooks expects all books to have a printable version. Personally, I find this of no value for OpenSCAD, although I have occasionally printed short sections.

The online version has grown without regard to being part of a print book. The individual topics are randomly scattered over several files with no thought to logical order, or grouping.  The WikiBooks print mechanism allows one to direct the file order, but it prints each complete file. There does not appear to be any mechanism to print selected portions. Attempting for a logical arrangement can result in some files being printed multiple times. The only real fix it to rearrange the physical file contents, once a logical order for topics has be determined,

Using the manual online allows creation of a virtual order. The disorder of the some files is only visible when scrolling from the selected topic to those adjacent. The fact that some topics are physically grouped illogically is less important than in a printed version.

The cheat sheet is a excellent example of a virtual ordering. To maintain its usefulness, it only includes the most popular topics.

An attempt a virtual order for all the contents is at https://en.wikibooks.org/wiki/OpenSCAD_User_Manual


So my question: Is maintaining a print version of OpenSCAD worthwhile or should we drop the pretense and simply state that a printable version is not available?
Larry
Reply | Threaded
Open this post in threaded view
|

Re: Print version of OpenSCAD manual

jdawgaz
There are some times, I have used OpenSCAD remotely. Read that sans Internet. Like at club meetings, where there is no internet available.
I have lamented the fact that I can't use "offline" help. Especially the cheat sheet.

I have tried the following:

wget -k -r -l20 ‐‐execute robots=off  http://www.openscad.org/cheatsheet/index.html?version=2016.01.27and that command works for some stuff, but not for the cheatsheet.

Even with the wget command, the cheatsheet still looks like this:

<code><a href="https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Using_the_2D_Subsystem#3D_to_2D_Projection">projection</a>(cut)</code>

I would LOVE a cheatsheet that I could use locally "offline".

Jerry



--
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

If 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 6:39 AM, L Boyd <[hidden email]> wrote:
How important is a print version of the OpenSCAD manual as opposed to the
online version?

WikiBooks expects all books to have a printable version. Personally, I find
this of no value for OpenSCAD, although I have occasionally printed short
sections.

The online version has grown without regard to being part of a print book.
The individual topics are randomly scattered over several files with no
thought to logical order, or grouping.  The WikiBooks print mechanism allows
one to direct the file order, but it prints each complete file. There does
not appear to be any mechanism to print selected portions. Attempting for a
logical arrangement can result in some files being printed multiple times.
The only real fix it to rearrange the physical file contents, once a logical
order for topics has be determined,

Using the manual online allows creation of a virtual order. The disorder of
the some files is only visible when scrolling from the selected topic to
those adjacent. The fact that some topics are physically grouped illogically
is less important than in a printed version.

The cheat sheet is a excellent example of a virtual ordering. To maintain
its usefulness, it only includes the most popular topics.

An attempt a virtual order for all the contents is at
https://en.wikibooks.org/wiki/OpenSCAD_User_Manual


So my question: Is maintaining a print version of OpenSCAD worthwhile or
should we drop the pretense and simply state that a printable version is not
available?



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

_______________________________________________
OpenSCAD mailing list
[hidden email]
http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org


_______________________________________________
OpenSCAD mailing list
[hidden email]
http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org
Reply | Threaded
Open this post in threaded view
|

Re: Print version of OpenSCAD manual

jon_bondy
Agreed.  Having a working local manual, no matter the technology, would
be very useful.  HTML.  Help. PDF with working links. Whatever works.

Jon

On 3/20/2016 10:06 AM, Jerry Davis wrote:

> There are some times, I have used OpenSCAD remotely. Read that sans
> Internet. Like at club meetings, where there is no internet available.
> I have lamented the fact that I can't use "offline" help. Especially
> the cheat sheet.
>
> I have tried the following:
>
> wget -k -r -l20 ‐‐execute robots=off
> http://www.openscad.org/cheatsheet/index.html?version=2016.01.27, and
> that command works for some stuff, but not for the cheatsheet.
>
> Even with the wget command, the cheatsheet still looks like this:
>
> <code><a
> href="https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Using_the_2D_Subsystem#3D_to_2D_Projection">projection</a>(cut)</code>
>
> I would LOVE a cheatsheet that I could use locally "offline".
>
> Jerry
>
>


_______________________________________________
OpenSCAD mailing list
[hidden email]
http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org
Reply | Threaded
Open this post in threaded view
|

Re: Print version of OpenSCAD manual

doug.moen
In reply to this post by L Boyd
The OpenSCAD Language Reference located at:

is a "printable version". What that really means is that it is organized as a single long HTML file, and the table of contents at the top is accurate, since it is automatically generated from the contents. You can search the entire language reference manual using the "search within this page" feature of your web browser. The benefits of this version, for me, have nothing to do with printing.

There is another table of contents for the Language Reference Manual at https://en.wikibooks.org/wiki/OpenSCAD_User_Manual, but it isn't not automatically generated from the print version. It's not maintained, and it's inaccurate/out of date. It should be deleted, or we should find some way to transclude the correct TOC from the print version.

I don't use the regular user manual, but if I did, I would prefer to use the printable version, to take advantage of online searchability. Sounds like it needs some maintenance. I recently fixed some bad problems with duplicated content in the "printable" version of the language reference manual, and from your description, it sounds like the user manual suffers from the same problems.

Doug Moen.

On 20 March 2016 at 09:39, L Boyd <[hidden email]> wrote:
How important is a print version of the OpenSCAD manual as opposed to the
online version?

WikiBooks expects all books to have a printable version. Personally, I find
this of no value for OpenSCAD, although I have occasionally printed short
sections.

The online version has grown without regard to being part of a print book.
The individual topics are randomly scattered over several files with no
thought to logical order, or grouping.  The WikiBooks print mechanism allows
one to direct the file order, but it prints each complete file. There does
not appear to be any mechanism to print selected portions. Attempting for a
logical arrangement can result in some files being printed multiple times.
The only real fix it to rearrange the physical file contents, once a logical
order for topics has be determined,

Using the manual online allows creation of a virtual order. The disorder of
the some files is only visible when scrolling from the selected topic to
those adjacent. The fact that some topics are physically grouped illogically
is less important than in a printed version.

The cheat sheet is a excellent example of a virtual ordering. To maintain
its usefulness, it only includes the most popular topics.

An attempt a virtual order for all the contents is at
https://en.wikibooks.org/wiki/OpenSCAD_User_Manual


So my question: Is maintaining a print version of OpenSCAD worthwhile or
should we drop the pretense and simply state that a printable version is not
available?



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

_______________________________________________
OpenSCAD mailing list
[hidden email]
http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org




_______________________________________________
OpenSCAD mailing list
[hidden email]
http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org
tp3
Reply | Threaded
Open this post in threaded view
|

Re: Print version of OpenSCAD manual

tp3
In reply to this post by jon_bondy
On 03/20/2016 03:10 PM, jon wrote:
> Agreed.  Having a working local manual, no matter the technology, would
> be very useful.  HTML.  Help. PDF with working links. Whatever works.
>
The tool to create that is already there. Runsun created a nice
script to fetch and cleanup the HTML pages.

http://forum.openscad.org/Use-openscad-offliner-for-offline-documentation-td13096.html

It would be nice to integrate that into the build process and
deliver it as off-line manual, probably also as additional
package.

The main challenge is how to handle that as we don't want to
scrape Wikibooks every time a new build is done. So the process
needs to be a little bit more than just call in every build.

ciao,
  Torsten.



_______________________________________________
OpenSCAD mailing list
[hidden email]
http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org
-- Torsten
tp3
Reply | Threaded
Open this post in threaded view
|

Re: Print version of OpenSCAD manual

tp3
In reply to this post by L Boyd
On 03/20/2016 02:39 PM, L Boyd wrote:
> WikiBooks expects all books to have a printable version. Personally, I find
> this of no value for OpenSCAD, although I have occasionally printed short
> sections.
>
Is that somewhere in the official docs? I did not find it when reading
quickly over the "What is Wikibooks" pages...

ciao,
  Torsten.


_______________________________________________
OpenSCAD mailing list
[hidden email]
http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org
-- Torsten
Reply | Threaded
Open this post in threaded view
|

Re: Print version of OpenSCAD manual

jdawgaz
I found the github link in that thread, and downloaded and ran the openscad_offliner.py script.

got this:

dir_docs= openscad_docs

dir_imgs= openscad_docs/imgs

dir_styles= styles

dir_styles_full= openscad_docs/styles


[1] ====================================

[1] Page #  1

[1] Downloading: https://en.wikibooks.org/wiki/OpenSCAD_User_Manual

[1] # stylesheet link found

[1] # href = /w/load.php?debug=false&lang=en&modules=ext.flaggedRevs.basic%7Cext.gadget.extlinks%7Cext.inputBox.styles%7Cext.tmh.thumbnail.styles%7Cext.uls.nojs%7Cext.visualEditor.desktopArticleTarget.noscript%7Cext.wikimediaBadges%7Cmediawiki.legacy.commonPrint%2Cshared%7Cmediawiki.raggett%2CsectionAnchor%7Cmediawiki.skinning.interface%7Cmediawiki.ui.button%2Ccheckbox%2Cinput%7Cskins.vector.styles%7Cwikibase.client.init&only=styles&skin=vector

[1] # :: download_style( /w/load.php?debug=false&lang=en&modules=ext.flaggedRevs.basic%7Cext.gadget.extlinks%7Cext.inputBox.styles%7Cext.tmh.thumbnail.styles%7Cext.uls.nojs%7Cext.visualEditor.desktopArticleTarget.noscript%7Cext.wikimediaBadges%7Cmediawiki.legacy.commonPrint%2Cshared%7Cmediawiki.raggett%2CsectionAnchor%7Cmediawiki.skinning.interface%7Cmediawiki.ui.button%2Ccheckbox%2Cinput%7Cskins.vector.styles%7Cwikibase.client.init&only=styles&skin=vector )

[1] # :: Assign style name: style_0.css

[1] # :: Downloading new style: /w/load.php?debug=false&lang=en&modules=ext.flaggedRevs.basic%7Cext.gadget.extlinks%7Cext.inputBox.styles%7Cext.tmh.thumbnail.styles%7Cext.uls.nojs%7Cext.visualEditor.desktopArticleTarget.noscript%7Cext.wikimediaBadges%7Cmediawiki.legacy.commonPrint%2Cshared%7Cmediawiki.raggett%2CsectionAnchor%7Cmediawiki.skinning.interface%7Cmediawiki.ui.button%2Ccheckbox%2Cinput%7Cskins.vector.styles%7Cwikibase.client.init&only=styles&skin=vector

Traceback (most recent call last):

  File "./openscad_offliner.py", line 516, in <module>

    handle_page(folder=dir_docs)

  File "./openscad_offliner.py", line 485, in handle_page

    handle_styles( soup, ind )

  File "./openscad_offliner.py", line 130, in handle_styles

    download_style_from_link_tag( soup_link=link, ind=ind )

  File "./openscad_offliner.py", line 149, in download_style_from_link_tag

    (stylename,redirect_path) = download_style( url=href, ind=ind )

  File "./openscad_offliner.py", line 216, in download_style

    response = urllib2.urlopen(url)

  File "/System/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/urllib2.py", line 154, in urlopen

    return opener.open(url, data, timeout)

  File "/System/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/urllib2.py", line 423, in open

    protocol = req.get_type()

  File "/System/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/urllib2.py", line 285, in get_type

    raise ValueError, "unknown url type: %s" % self.__original

ValueError: unknown url type: /w/load.php?debug=false&lang=en&modules=ext.flaggedRevs.basic%7Cext.gadget.extlinks%7Cext.inputBox.styles%7Cext.tmh.thumbnail.styles%7Cext.uls.nojs%7Cext.visualEditor.desktopArticleTarget.noscript%7Cext.wikimediaBadges%7Cmediawiki.legacy.commonPrint%2Cshared%7Cmediawiki.raggett%2CsectionAnchor%7Cmediawiki.skinning.interface%7Cmediawiki.ui.button%2Ccheckbox%2Cinput%7Cskins.vector.styles%7Cwikibase.client.init&only=styles&skin=vector




--
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

If 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 7:39 AM, Torsten Paul <[hidden email]> wrote:
On 03/20/2016 02:39 PM, L Boyd wrote:
> WikiBooks expects all books to have a printable version. Personally, I find
> this of no value for OpenSCAD, although I have occasionally printed short
> sections.
>
Is that somewhere in the official docs? I did not find it when reading
quickly over the "What is Wikibooks" pages...

ciao,
  Torsten.


_______________________________________________
OpenSCAD mailing list
[hidden email]
http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org


_______________________________________________
OpenSCAD mailing list
[hidden email]
http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org
Reply | Threaded
Open this post in threaded view
|

Re: Print version of OpenSCAD manual

L Boyd
In reply to this post by doug.moen
I disagree with the statement that the contents at https://en.wikibooks.org/wiki/OpenSCAD_User_Manual, is not maintained and is inaccurate/out of date. When was the last time you looked at it?
Larry
Reply | Threaded
Open this post in threaded view
|

Re: Print version of OpenSCAD manual

L Boyd
In reply to this post by tp3
I found it when learning to use WikiBooks. Don't remember exactly where.

tp3 wrote
On 03/20/2016 02:39 PM, L Boyd wrote:
> WikiBooks expects all books to have a printable version. Personally, I find
> this of no value for OpenSCAD, although I have occasionally printed short
> sections.
>
Is that somewhere in the official docs? I did not find it when reading
quickly over the "What is Wikibooks" pages...

ciao,
  Torsten.


_______________________________________________
OpenSCAD mailing list
[hidden email]
http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org
Larry
Reply | Threaded
Open this post in threaded view
|

Re: Print version of OpenSCAD manual

runsun
In reply to this post by jdawgaz
jdawgaz wrote
I found the github link in that thread, and downloaded and ran the
openscad_offliner.py script. got this:
I'll take a look.
$ Runsun Pan, PhD
$ libs: scadx, doctest, faces(git), offline doc(git), runscad.py(2,git), editor of choice: CudaText ( OpenSCAD lexer); $ Tips; $ Snippets
Reply | Threaded
Open this post in threaded view
|

Re: Print version of OpenSCAD manual

jdawgaz
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

If 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 <[hidden email]> wrote:
jdawgaz wrote
> I found the github link in that thread, and downloaded and ran the
> openscad_offliner.py script. got this:

I'll take a look.



-----

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

_______________________________________________
OpenSCAD mailing list
[hidden email]
http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org


_______________________________________________
OpenSCAD mailing list
[hidden email]
http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org
Reply | Threaded
Open this post in threaded view
|

Re: Print version of OpenSCAD manual

doug.moen
In reply to this post by L Boyd
@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 <[hidden email]> wrote:
I disagree with the statement that the contents at
https://en.wikibooks.org/wiki/OpenSCAD_User_Manual, is not maintained and is
inaccurate/out of date. When was the last time you looked at it?



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

_______________________________________________
OpenSCAD mailing list
[hidden email]
http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org




_______________________________________________
OpenSCAD mailing list
[hidden email]
http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org
Reply | Threaded
Open this post in threaded view
|

Re: Print version of OpenSCAD manual

L Boyd
The table of contents for the language reference manual at /OpenSCAD_User_Manual was the same as the table of contents in /OpenSCAD_User_Manual/The_OpenSCAD_Language until someone recently deleted the copy from /OpenSCAD_User_Manual/The_OpenSCAD_Language.

Yes, the automatically generated one needs less work to maintain. The problem is it reflects the lack of logical order to the contents.  When coupled with the length of the generated TOC, it becomes very difficult to use it for navigation.

In the long run, it would be desirable to reorganize the content of the various files to reflect a more logical order, thus allowing the generated TOC to be easier to navigate.

Larry
Reply | Threaded
Open this post in threaded view
|

Re: Print version of OpenSCAD manual

doug.moen
@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 <[hidden email]> wrote:
The table of contents for the language reference manual at
/OpenSCAD_User_Manual was the same as the table of contents in
/OpenSCAD_User_Manual/The_OpenSCAD_Language until someone recently deleted
the copy from /OpenSCAD_User_Manual/The_OpenSCAD_Language.

Yes, the automatically generated one needs less work to maintain. The
problem is it reflects the lack of logical order to the contents.  When
coupled with the length of the generated TOC, it becomes very difficult to
use it for navigation.

In the long run, it would be desirable to reorganize the content of the
various files to reflect a more logical order, thus allowing the generated
TOC to be easier to navigate.





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

_______________________________________________
OpenSCAD mailing list
[hidden email]
http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org




_______________________________________________
OpenSCAD mailing list
[hidden email]
http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org
Reply | Threaded
Open this post in threaded view
|

Re: Print version of OpenSCAD manual

runsun
In reply to this post by doug.moen
doug.moen wrote
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.
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: scadx, doctest, faces(git), offline doc(git), runscad.py(2,git), editor of choice: CudaText ( OpenSCAD lexer); $ Tips; $ Snippets
Reply | Threaded
Open this post in threaded view
|

Re: Print version of OpenSCAD manual

doug.moen
@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 <[hidden email]> wrote:
doug.moen wrote
> 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.

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.

_______________________________________________
OpenSCAD mailing list
[hidden email]
http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org




_______________________________________________
OpenSCAD mailing list
[hidden email]
http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org
Reply | Threaded
Open this post in threaded view
|

Re: Print version of OpenSCAD manual

MichaelAtOz
Administrator
In reply to this post by doug.moen
doug.moen wrote
There is another table of contents for the Language Reference Manual at
https://en.wikibooks.org/wiki/OpenSCAD_User_Manual, but it isn't not
automatically generated from the print version. It's not maintained, and
it's inaccurate/out of date. It should be deleted, or we should find some
way to transclude the correct TOC from the print version.
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 - 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!
Reply | Threaded
Open this post in threaded view
|

Re: Print version of OpenSCAD manual

MichaelAtOz
Administrator
This post was updated on .
In reply to this post by runsun
runsun wrote
doug.moen wrote
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.
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
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).
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!
Reply | Threaded
Open this post in threaded view
|

Re: Print version of OpenSCAD manual

MichaelAtOz
Administrator
runsun 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
They did nothing.
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!
Reply | Threaded
Open this post in threaded view
|

Re: Print version of OpenSCAD manual

MichaelAtOz
Administrator
Personally, I think the print versions are less useful, but as per Doug doing searches on it that is obviously a usage style difference.

Before I re-jigged the non-print TOC it was generated and looked like:


I do think the current version is a more usable TOC, even tho it needs manual handling.
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!
12