Print version of OpenSCAD manual
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.
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
--
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 6:39 AM, L Boyd lboyd@frontiernet.net 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
Discuss@lists.openscad.org
http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org
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
The OpenSCAD Language Reference located at:
https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/The_OpenSCAD_Language
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 lboyd@frontiernet.net 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
Discuss@lists.openscad.org
http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org
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.
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.
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
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 7:39 AM, Torsten Paul Torsten.Paul@gmx.de 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
Discuss@lists.openscad.org
http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org
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.
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
Discuss@.openscad
Larry
View this message in context: http://forum.openscad.org/Print-version-of-OpenSCAD-manual-tp16593p16602.html
Sent from the OpenSCAD mailing list archive at Nabble.com.
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.