discuss@lists.openscad.org

OpenSCAD general discussion Mailing-list

View all threads

feature request: offline documentation

DM
doug moen
Sun, Jul 5, 2015 10:46 PM

The Print_version puts the entire User Manual onto a single HTML web page.
This is good as an intermediate step towards creating a PDF file. I'm not
the sort of person who would print the User Manual, but I suppose we should
support this use case. Maybe we can find a shell command for generating a
PDF file from
https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Print_version and put
that in the OpenSCAD build process.

However, if I am browsing the user manual interactively, using my laptop,
then I certainly don't want the PDF version, I prefer HTML. Then I can
follow links, I can open different sections in different tabs, there are no
page breaks to navigate past, and so on. If I am browsing HTML, then it is
not obvious that I want the entire User Manual on a single page. Isn't it
more pleasant to browse a web of interconnected documents?

Doug Moen.

On 5 July 2015 at 18:21, Peter Falke stempeldergeschichte@googlemail.com
wrote:

@doug Me thinks you meant:

https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Print_version

2015-07-06 0:10 GMT+02:00 doug moen doug@moens.org:

You don't need to move the manual to github.

I just tried this using Google Chrome: navigate to
https://en.wikibooks.org/wiki/OpenSCAD_User_Manual, then "Save as
complete web page". This created OpenSCAD.html and an OpenSCAD directory,
containing the complete user manual in HTML. I can open OpenSCAD.html from
my local hard drive using a web browser, and I get the user manual.

If we can find a tool that does this from the command line, then we can
add this command to the build process.

On 5 July 2015 at 16:35, Torsten Paul Torsten.Paul@gmx.de wrote:

On 07/05/2015 10:10 PM, Jerry Davis wrote:

I am thinking the ideal solution would be to have one source (html),
that
can be used for both online and offline documentation. And if the html
"shipped" with the application, then the help from the application
(would
default to the offline version).

Right, that's another option. It has one big drawback though. As the

current manual is a Wiki, it's very easy to contribute to the
documentation.

Having it on github or so might create an additional barrier to just fix
something or include additional info in the documentation.

I'm not sure which way is going to be better in the long run, but I do
fear losing contributions by people who don't want to bother with github.

ciao,
Torsten.


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

--
stempeldergeschichte@googlemail.com karsten@rohrbach.de

P.S. Falls meine E-Mail kürzer ausfällt als Dir angenehm ist:
Ich probiere gerade aus kurze Antworten statt gar keine Antworten zu
schreiben.
Wenn Du gerne mehr lesen möchtest, dann lass es mich bitte wissen.

P.S. In case my e-mail is shorter than you enjoy:
I am currently trying short replies instead of no replies at all.
Please let me know, if you like to read more.

Enjoy!


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

The Print_version puts the entire User Manual onto a single HTML web page. This is good as an intermediate step towards creating a PDF file. I'm not the sort of person who would print the User Manual, but I suppose we should support this use case. Maybe we can find a shell command for generating a PDF file from https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Print_version and put that in the OpenSCAD build process. However, if I am browsing the user manual interactively, using my laptop, then I certainly don't want the PDF version, I prefer HTML. Then I can follow links, I can open different sections in different tabs, there are no page breaks to navigate past, and so on. If I am browsing HTML, then it is not obvious that I want the entire User Manual on a single page. Isn't it more pleasant to browse a web of interconnected documents? Doug Moen. On 5 July 2015 at 18:21, Peter Falke <stempeldergeschichte@googlemail.com> wrote: > @doug Me thinks you meant: > > https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Print_version > > 2015-07-06 0:10 GMT+02:00 doug moen <doug@moens.org>: > >> You don't need to move the manual to github. >> >> I just tried this using Google Chrome: navigate to >> https://en.wikibooks.org/wiki/OpenSCAD_User_Manual, then "Save as >> complete web page". This created OpenSCAD.html and an OpenSCAD directory, >> containing the complete user manual in HTML. I can open OpenSCAD.html from >> my local hard drive using a web browser, and I get the user manual. >> >> If we can find a tool that does this from the command line, then we can >> add this command to the build process. >> >> On 5 July 2015 at 16:35, Torsten Paul <Torsten.Paul@gmx.de> wrote: >> >>> On 07/05/2015 10:10 PM, Jerry Davis wrote: >>> >>>> I am thinking the ideal solution would be to have one source (html), >>>> that >>>> can be used for both online and offline documentation. And if the html >>>> "shipped" with the application, then the help from the application >>>> (would >>>> default to the offline version). >>>> >>>> Right, that's another option. It has one big drawback though. As the >>> current manual is a Wiki, it's very easy to contribute to the >>> documentation. >>> >>> Having it on github or so might create an additional barrier to just fix >>> something or include additional info in the documentation. >>> >>> I'm not sure which way is going to be better in the long run, but I do >>> fear losing contributions by people who don't want to bother with github. >>> >>> >>> ciao, >>> Torsten. >>> >>> >>> _______________________________________________ >>> OpenSCAD mailing list >>> Discuss@lists.openscad.org >>> http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org >>> >>> >> >> _______________________________________________ >> OpenSCAD mailing list >> Discuss@lists.openscad.org >> http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org >> >> > > > -- > stempeldergeschichte@googlemail.com <karsten@rohrbach.de> > > P.S. Falls meine E-Mail kürzer ausfällt als Dir angenehm ist: > Ich probiere gerade aus kurze Antworten statt gar keine Antworten zu > schreiben. > Wenn Du gerne mehr lesen möchtest, dann lass es mich bitte wissen. > > P.S. In case my e-mail is shorter than you enjoy: > I am currently trying short replies instead of no replies at all. > Please let me know, if you like to read more. > > Enjoy! > > _______________________________________________ > OpenSCAD mailing list > Discuss@lists.openscad.org > http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org > >
FV
Frank van der Hulst
Sun, Jul 5, 2015 11:00 PM

"Save as Complete Web Page" would only work from the "Print_version"
page... it downloads the one page you're looking at, including images, etc
on that page, but it will still contain links to other pages which won't be
downloaded. When I tried it, there were also still numerous links to images
which didn't download... probably due to security settings in my browser or
something like that.

On Mon, Jul 6, 2015 at 10:10 AM, doug moen doug@moens.org wrote:

You don't need to move the manual to github.

I just tried this using Google Chrome: navigate to
https://en.wikibooks.org/wiki/OpenSCAD_User_Manual, then "Save as
complete web page". This created OpenSCAD.html and an OpenSCAD directory,
containing the complete user manual in HTML. I can open OpenSCAD.html from
my local hard drive using a web browser, and I get the user manual.

If we can find a tool that does this from the command line, then we can
add this command to the build process.

On 5 July 2015 at 16:35, Torsten Paul Torsten.Paul@gmx.de wrote:

On 07/05/2015 10:10 PM, Jerry Davis wrote:

I am thinking the ideal solution would be to have one source (html), that
can be used for both online and offline documentation. And if the html
"shipped" with the application, then the help from the application (would
default to the offline version).

Right, that's another option. It has one big drawback though. As the

current manual is a Wiki, it's very easy to contribute to the
documentation.

Having it on github or so might create an additional barrier to just fix
something or include additional info in the documentation.

I'm not sure which way is going to be better in the long run, but I do
fear losing contributions by people who don't want to bother with github.

ciao,
Torsten.


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

"Save as Complete Web Page" would only work from the "Print_version" page... it downloads the one page you're looking at, including images, etc on that page, but it will still contain links to other pages which won't be downloaded. When I tried it, there were also still numerous links to images which didn't download... probably due to security settings in my browser or something like that. On Mon, Jul 6, 2015 at 10:10 AM, doug moen <doug@moens.org> wrote: > You don't need to move the manual to github. > > I just tried this using Google Chrome: navigate to > https://en.wikibooks.org/wiki/OpenSCAD_User_Manual, then "Save as > complete web page". This created OpenSCAD.html and an OpenSCAD directory, > containing the complete user manual in HTML. I can open OpenSCAD.html from > my local hard drive using a web browser, and I get the user manual. > > If we can find a tool that does this from the command line, then we can > add this command to the build process. > > On 5 July 2015 at 16:35, Torsten Paul <Torsten.Paul@gmx.de> wrote: > >> On 07/05/2015 10:10 PM, Jerry Davis wrote: >> >>> I am thinking the ideal solution would be to have one source (html), that >>> can be used for both online and offline documentation. And if the html >>> "shipped" with the application, then the help from the application (would >>> default to the offline version). >>> >>> Right, that's another option. It has one big drawback though. As the >> current manual is a Wiki, it's very easy to contribute to the >> documentation. >> >> Having it on github or so might create an additional barrier to just fix >> something or include additional info in the documentation. >> >> I'm not sure which way is going to be better in the long run, but I do >> fear losing contributions by people who don't want to bother with github. >> >> >> ciao, >> Torsten. >> >> >> _______________________________________________ >> OpenSCAD mailing list >> Discuss@lists.openscad.org >> http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org >> >> > > _______________________________________________ > OpenSCAD mailing list > Discuss@lists.openscad.org > http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org > >
DM
doug moen
Sun, Jul 5, 2015 11:05 PM

I've tested the procedure that I described, and it works for me. I'm using
Chrome on MacOS.

We still need a platform independent and reliable way to do this from the
command line, in order to integrate it into the build as I suggested. I
figure that "wget -r" will probably work. I'll try testing that later this
evening.

On 5 July 2015 at 19:00, Frank van der Hulst drifter.frank@gmail.com
wrote:

"Save as Complete Web Page" would only work from the "Print_version"
page... it downloads the one page you're looking at, including images, etc
on that page, but it will still contain links to other pages which won't be
downloaded. When I tried it, there were also still numerous links to images
which didn't download... probably due to security settings in my browser or
something like that.

On Mon, Jul 6, 2015 at 10:10 AM, doug moen doug@moens.org wrote:

You don't need to move the manual to github.

I just tried this using Google Chrome: navigate to
https://en.wikibooks.org/wiki/OpenSCAD_User_Manual, then "Save as
complete web page". This created OpenSCAD.html and an OpenSCAD directory,
containing the complete user manual in HTML. I can open OpenSCAD.html from
my local hard drive using a web browser, and I get the user manual.

If we can find a tool that does this from the command line, then we can
add this command to the build process.

On 5 July 2015 at 16:35, Torsten Paul Torsten.Paul@gmx.de wrote:

On 07/05/2015 10:10 PM, Jerry Davis wrote:

I am thinking the ideal solution would be to have one source (html),
that
can be used for both online and offline documentation. And if the html
"shipped" with the application, then the help from the application
(would
default to the offline version).

Right, that's another option. It has one big drawback though. As the

current manual is a Wiki, it's very easy to contribute to the
documentation.

Having it on github or so might create an additional barrier to just fix
something or include additional info in the documentation.

I'm not sure which way is going to be better in the long run, but I do
fear losing contributions by people who don't want to bother with github.

ciao,
Torsten.


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

I've tested the procedure that I described, and it works for me. I'm using Chrome on MacOS. We still need a platform independent and reliable way to do this from the command line, in order to integrate it into the build as I suggested. I figure that "wget -r" will probably work. I'll try testing that later this evening. On 5 July 2015 at 19:00, Frank van der Hulst <drifter.frank@gmail.com> wrote: > "Save as Complete Web Page" would only work from the "Print_version" > page... it downloads the one page you're looking at, including images, etc > on that page, but it will still contain links to other pages which won't be > downloaded. When I tried it, there were also still numerous links to images > which didn't download... probably due to security settings in my browser or > something like that. > > > > > On Mon, Jul 6, 2015 at 10:10 AM, doug moen <doug@moens.org> wrote: > >> You don't need to move the manual to github. >> >> I just tried this using Google Chrome: navigate to >> https://en.wikibooks.org/wiki/OpenSCAD_User_Manual, then "Save as >> complete web page". This created OpenSCAD.html and an OpenSCAD directory, >> containing the complete user manual in HTML. I can open OpenSCAD.html from >> my local hard drive using a web browser, and I get the user manual. >> >> If we can find a tool that does this from the command line, then we can >> add this command to the build process. >> >> On 5 July 2015 at 16:35, Torsten Paul <Torsten.Paul@gmx.de> wrote: >> >>> On 07/05/2015 10:10 PM, Jerry Davis wrote: >>> >>>> I am thinking the ideal solution would be to have one source (html), >>>> that >>>> can be used for both online and offline documentation. And if the html >>>> "shipped" with the application, then the help from the application >>>> (would >>>> default to the offline version). >>>> >>>> Right, that's another option. It has one big drawback though. As the >>> current manual is a Wiki, it's very easy to contribute to the >>> documentation. >>> >>> Having it on github or so might create an additional barrier to just fix >>> something or include additional info in the documentation. >>> >>> I'm not sure which way is going to be better in the long run, but I do >>> fear losing contributions by people who don't want to bother with github. >>> >>> >>> ciao, >>> Torsten. >>> >>> >>> _______________________________________________ >>> OpenSCAD mailing list >>> Discuss@lists.openscad.org >>> http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org >>> >>> >> >> _______________________________________________ >> OpenSCAD mailing list >> Discuss@lists.openscad.org >> http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org >> >> > > _______________________________________________ > OpenSCAD mailing list > Discuss@lists.openscad.org > http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org > >
TP
Torsten Paul
Sun, Jul 5, 2015 11:19 PM

On 07/06/2015 01:05 AM, doug moen wrote:

I've tested the procedure that I described, and it works for me. I'm using
Chrome on MacOS.

We still need a platform independent and reliable way to do this from the
command line, in order to integrate it into the build as I suggested. I
figure that "wget -r" will probably work. I'll try testing that later this
evening.

In my view the output of this is not looking nice enough to count as official
documentation shipped with OpenSCAD.

Yes the text content is all there, but most of the images seem to be broken
as they still link to the online version and there are some links that are
already broken in the Print_version page. And all the navigation boxes
scattered around in the text do not make it very appealing to read.

Also there is still the issue that the Print_version is not maintained, try
searching for "list comprehensions" or "text()".
That's fixable of cause, but every change in topics/pages in the main document
will break the print version again.

ciao,
Torsten.

On 07/06/2015 01:05 AM, doug moen wrote: > I've tested the procedure that I described, and it works for me. I'm using > Chrome on MacOS. > > We still need a platform independent and reliable way to do this from the > command line, in order to integrate it into the build as I suggested. I > figure that "wget -r" will probably work. I'll try testing that later this > evening. > In my view the output of this is not looking nice enough to count as official documentation shipped with OpenSCAD. Yes the text content is all there, but most of the images seem to be broken as they still link to the online version and there are some links that are already broken in the Print_version page. And all the navigation boxes scattered around in the text do not make it very appealing to read. Also there is still the issue that the Print_version is not maintained, try searching for "list comprehensions" or "text()". That's fixable of cause, but every change in topics/pages in the main document will break the print version again. ciao, Torsten.
JD
Jerry Davis
Mon, Jul 6, 2015 12:27 AM

wget -r -k does not work.

I have done some searching and maybe httrack (http://www.httrack.com/) will
work.

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, Jul 5, 2015 at 6:19 PM, Torsten Paul Torsten.Paul@gmx.de wrote:

On 07/06/2015 01:05 AM, doug moen wrote:

I've tested the procedure that I described, and it works for me. I'm using
Chrome on MacOS.

We still need a platform independent and reliable way to do this from the
command line, in order to integrate it into the build as I suggested. I
figure that "wget -r" will probably work. I'll try testing that later this
evening.

In my view the output of this is not looking nice enough to count as

official
documentation shipped with OpenSCAD.

Yes the text content is all there, but most of the images seem to be broken
as they still link to the online version and there are some links that are
already broken in the Print_version page. And all the navigation boxes
scattered around in the text do not make it very appealing to read.

Also there is still the issue that the Print_version is not maintained, try
searching for "list comprehensions" or "text()".
That's fixable of cause, but every change in topics/pages in the main
document
will break the print version again.

ciao,
Torsten.


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

wget -r -k does not work. I have done some searching and maybe httrack (http://www.httrack.com/) will work. 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, Jul 5, 2015 at 6:19 PM, Torsten Paul <Torsten.Paul@gmx.de> wrote: > On 07/06/2015 01:05 AM, doug moen wrote: > >> I've tested the procedure that I described, and it works for me. I'm using >> Chrome on MacOS. >> >> We still need a platform independent and reliable way to do this from the >> command line, in order to integrate it into the build as I suggested. I >> figure that "wget -r" will probably work. I'll try testing that later this >> evening. >> >> In my view the output of this is not looking nice enough to count as > official > documentation shipped with OpenSCAD. > > Yes the text content is all there, but most of the images seem to be broken > as they still link to the online version and there are some links that are > already broken in the Print_version page. And all the navigation boxes > scattered around in the text do not make it very appealing to read. > > Also there is still the issue that the Print_version is not maintained, try > searching for "list comprehensions" or "text()". > That's fixable of cause, but every change in topics/pages in the main > document > will break the print version again. > > > ciao, > Torsten. > > > _______________________________________________ > OpenSCAD mailing list > Discuss@lists.openscad.org > http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org >
DM
doug moen
Mon, Jul 6, 2015 12:29 AM

What I'm proposing is a shell script that recursively downloads the User
Manual HTML and all its dependencies. There are lots of open source tools
for doing this, we just need to pick one that works for us. If there are
broken images, then that's just a bug in the shell script that would have
to be fixed.

The navigation bars are all wrapped in DIV elements with CSS IDs and
CLASSes, so they can be hidden by adding a few lines of CSS to the
appropriate file.

I don't have the shell script right now, but it seems like something that
would be easy for me to write.

On 5 July 2015 at 19:19, Torsten Paul Torsten.Paul@gmx.de wrote:

On 07/06/2015 01:05 AM, doug moen wrote:

I've tested the procedure that I described, and it works for me. I'm using
Chrome on MacOS.

We still need a platform independent and reliable way to do this from the
command line, in order to integrate it into the build as I suggested. I
figure that "wget -r" will probably work. I'll try testing that later this
evening.

In my view the output of this is not looking nice enough to count as

official
documentation shipped with OpenSCAD.

Yes the text content is all there, but most of the images seem to be broken
as they still link to the online version and there are some links that are
already broken in the Print_version page. And all the navigation boxes
scattered around in the text do not make it very appealing to read.

Also there is still the issue that the Print_version is not maintained, try
searching for "list comprehensions" or "text()".
That's fixable of cause, but every change in topics/pages in the main
document
will break the print version again.

ciao,
Torsten.


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

What I'm proposing is a shell script that recursively downloads the User Manual HTML and all its dependencies. There are lots of open source tools for doing this, we just need to pick one that works for us. If there are broken images, then that's just a bug in the shell script that would have to be fixed. The navigation bars are all wrapped in DIV elements with CSS IDs and CLASSes, so they can be hidden by adding a few lines of CSS to the appropriate file. I don't have the shell script right now, but it seems like something that would be easy for me to write. On 5 July 2015 at 19:19, Torsten Paul <Torsten.Paul@gmx.de> wrote: > On 07/06/2015 01:05 AM, doug moen wrote: > >> I've tested the procedure that I described, and it works for me. I'm using >> Chrome on MacOS. >> >> We still need a platform independent and reliable way to do this from the >> command line, in order to integrate it into the build as I suggested. I >> figure that "wget -r" will probably work. I'll try testing that later this >> evening. >> >> In my view the output of this is not looking nice enough to count as > official > documentation shipped with OpenSCAD. > > Yes the text content is all there, but most of the images seem to be broken > as they still link to the online version and there are some links that are > already broken in the Print_version page. And all the navigation boxes > scattered around in the text do not make it very appealing to read. > > Also there is still the issue that the Print_version is not maintained, try > searching for "list comprehensions" or "text()". > That's fixable of cause, but every change in topics/pages in the main > document > will break the print version again. > > > ciao, > Torsten. > > > _______________________________________________ > OpenSCAD mailing list > Discuss@lists.openscad.org > http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org > >
JD
Jerry Davis
Mon, Jul 6, 2015 12:37 AM

httrack might work to get all web pages, but they might come across as
markdown. if so, I think pandoc can be used to convert to html.

so maybe a combination of the two might be in order.

this is the bad about markdown sites. the good is obvious.

jerry

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, Jul 5, 2015 at 7:29 PM, doug moen doug@moens.org wrote:

What I'm proposing is a shell script that recursively downloads the User
Manual HTML and all its dependencies. There are lots of open source tools
for doing this, we just need to pick one that works for us. If there are
broken images, then that's just a bug in the shell script that would have
to be fixed.

The navigation bars are all wrapped in DIV elements with CSS IDs and
CLASSes, so they can be hidden by adding a few lines of CSS to the
appropriate file.

I don't have the shell script right now, but it seems like something that
would be easy for me to write.

On 5 July 2015 at 19:19, Torsten Paul Torsten.Paul@gmx.de wrote:

On 07/06/2015 01:05 AM, doug moen wrote:

I've tested the procedure that I described, and it works for me. I'm
using
Chrome on MacOS.

We still need a platform independent and reliable way to do this from the
command line, in order to integrate it into the build as I suggested. I
figure that "wget -r" will probably work. I'll try testing that later
this
evening.

In my view the output of this is not looking nice enough to count as

official
documentation shipped with OpenSCAD.

Yes the text content is all there, but most of the images seem to be
broken
as they still link to the online version and there are some links that are
already broken in the Print_version page. And all the navigation boxes
scattered around in the text do not make it very appealing to read.

Also there is still the issue that the Print_version is not maintained,
try
searching for "list comprehensions" or "text()".
That's fixable of cause, but every change in topics/pages in the main
document
will break the print version again.

ciao,
Torsten.


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

httrack might work to get all web pages, but they might come across as markdown. if so, I think pandoc can be used to convert to html. so maybe a combination of the two might be in order. this is the bad about markdown sites. the good is obvious. jerry 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, Jul 5, 2015 at 7:29 PM, doug moen <doug@moens.org> wrote: > What I'm proposing is a shell script that recursively downloads the User > Manual HTML and all its dependencies. There are lots of open source tools > for doing this, we just need to pick one that works for us. If there are > broken images, then that's just a bug in the shell script that would have > to be fixed. > > The navigation bars are all wrapped in DIV elements with CSS IDs and > CLASSes, so they can be hidden by adding a few lines of CSS to the > appropriate file. > > I don't have the shell script right now, but it seems like something that > would be easy for me to write. > > On 5 July 2015 at 19:19, Torsten Paul <Torsten.Paul@gmx.de> wrote: > >> On 07/06/2015 01:05 AM, doug moen wrote: >> >>> I've tested the procedure that I described, and it works for me. I'm >>> using >>> Chrome on MacOS. >>> >>> We still need a platform independent and reliable way to do this from the >>> command line, in order to integrate it into the build as I suggested. I >>> figure that "wget -r" will probably work. I'll try testing that later >>> this >>> evening. >>> >>> In my view the output of this is not looking nice enough to count as >> official >> documentation shipped with OpenSCAD. >> >> Yes the text content is all there, but most of the images seem to be >> broken >> as they still link to the online version and there are some links that are >> already broken in the Print_version page. And all the navigation boxes >> scattered around in the text do not make it very appealing to read. >> >> Also there is still the issue that the Print_version is not maintained, >> try >> searching for "list comprehensions" or "text()". >> That's fixable of cause, but every change in topics/pages in the main >> document >> will break the print version again. >> >> >> ciao, >> Torsten. >> >> >> _______________________________________________ >> OpenSCAD mailing list >> Discuss@lists.openscad.org >> http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org >> >> > > _______________________________________________ > OpenSCAD mailing list > Discuss@lists.openscad.org > http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org > >
DM
doug moen
Mon, Jul 6, 2015 12:50 AM

httrack seems to have all the right features. Good find.

On 5 July 2015 at 20:27, Jerry Davis jdawgaz@gmail.com wrote:

wget -r -k does not work.

I have done some searching and maybe httrack (http://www.httrack.com/)
will work.

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, Jul 5, 2015 at 6:19 PM, Torsten Paul Torsten.Paul@gmx.de wrote:

On 07/06/2015 01:05 AM, doug moen wrote:

I've tested the procedure that I described, and it works for me. I'm
using
Chrome on MacOS.

We still need a platform independent and reliable way to do this from the
command line, in order to integrate it into the build as I suggested. I
figure that "wget -r" will probably work. I'll try testing that later
this
evening.

In my view the output of this is not looking nice enough to count as

official
documentation shipped with OpenSCAD.

Yes the text content is all there, but most of the images seem to be
broken
as they still link to the online version and there are some links that are
already broken in the Print_version page. And all the navigation boxes
scattered around in the text do not make it very appealing to read.

Also there is still the issue that the Print_version is not maintained,
try
searching for "list comprehensions" or "text()".
That's fixable of cause, but every change in topics/pages in the main
document
will break the print version again.

ciao,
Torsten.


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

httrack seems to have all the right features. Good find. On 5 July 2015 at 20:27, Jerry Davis <jdawgaz@gmail.com> wrote: > wget -r -k does not work. > > I have done some searching and maybe httrack (http://www.httrack.com/) > will work. > > > 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, Jul 5, 2015 at 6:19 PM, Torsten Paul <Torsten.Paul@gmx.de> wrote: > >> On 07/06/2015 01:05 AM, doug moen wrote: >> >>> I've tested the procedure that I described, and it works for me. I'm >>> using >>> Chrome on MacOS. >>> >>> We still need a platform independent and reliable way to do this from the >>> command line, in order to integrate it into the build as I suggested. I >>> figure that "wget -r" will probably work. I'll try testing that later >>> this >>> evening. >>> >>> In my view the output of this is not looking nice enough to count as >> official >> documentation shipped with OpenSCAD. >> >> Yes the text content is all there, but most of the images seem to be >> broken >> as they still link to the online version and there are some links that are >> already broken in the Print_version page. And all the navigation boxes >> scattered around in the text do not make it very appealing to read. >> >> Also there is still the issue that the Print_version is not maintained, >> try >> searching for "list comprehensions" or "text()". >> That's fixable of cause, but every change in topics/pages in the main >> document >> will break the print version again. >> >> >> ciao, >> Torsten. >> >> >> _______________________________________________ >> OpenSCAD mailing list >> Discuss@lists.openscad.org >> http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org >> > > > _______________________________________________ > OpenSCAD mailing list > Discuss@lists.openscad.org > http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org > >
R
runsun
Mon, Jul 6, 2015 9:30 PM

python + BeautifulSoup might do the job easily.

doug.moen wrote

What I'm proposing is a shell script that recursively downloads the User
Manual HTML and all its dependencies. There are lots of open source tools
for doing this, we just need to pick one that works for us. If there are
broken images, then that's just a bug in the shell script that would have
to be fixed.


$  Runsun Pan, PhD

$ -- OpenScad_DocTest: doc and unit test ( Github , Thingiverse  )

$ -- hash parameter model: here , here

$ -- Linux Mint 17.1 Rebecca x64  + OpenSCAD 2015.03.15/2015.04.01.nightly

--
View this message in context: http://forum.openscad.org/feature-request-offline-documentation-tp13026p13077.html
Sent from the OpenSCAD mailing list archive at Nabble.com.

python + BeautifulSoup might do the job easily. doug.moen wrote > What I'm proposing is a shell script that recursively downloads the User > Manual HTML and all its dependencies. There are lots of open source tools > for doing this, we just need to pick one that works for us. If there are > broken images, then that's just a bug in the shell script that would have > to be fixed. ----- $ Runsun Pan, PhD $ -- OpenScad_DocTest: doc and unit test ( Github , Thingiverse ) $ -- hash parameter model: here , here $ -- Linux Mint 17.1 Rebecca x64 + OpenSCAD 2015.03.15/2015.04.01.nightly -- View this message in context: http://forum.openscad.org/feature-request-offline-documentation-tp13026p13077.html Sent from the OpenSCAD mailing list archive at Nabble.com.
R
runsun
Tue, Jul 7, 2015 5:53 AM

I took the time to make a script that seems to download the entire doc
successfully. Give me a day or two to fine-tune it and I'll share.

I'm counting: 97 pages, 103 images, total 138.6 GB


$  Runsun Pan, PhD

$ -- OpenScad_DocTest: doc and unit test ( Github , Thingiverse  )

$ -- hash parameter model: here , here

$ -- Linux Mint 17.1 Rebecca x64  + OpenSCAD 2015.03.15/2015.04.01.nightly

--
View this message in context: http://forum.openscad.org/feature-request-offline-documentation-tp13026p13085.html
Sent from the OpenSCAD mailing list archive at Nabble.com.

I took the time to make a script that seems to download the entire doc successfully. Give me a day or two to fine-tune it and I'll share. I'm counting: 97 pages, 103 images, total 138.6 GB ----- $ Runsun Pan, PhD $ -- OpenScad_DocTest: doc and unit test ( Github , Thingiverse ) $ -- hash parameter model: here , here $ -- Linux Mint 17.1 Rebecca x64 + OpenSCAD 2015.03.15/2015.04.01.nightly -- View this message in context: http://forum.openscad.org/feature-request-offline-documentation-tp13026p13085.html Sent from the OpenSCAD mailing list archive at Nabble.com.