I've been playing around with the Dash (for OSX) and Zeal (for Windows/Linux) tools which are nice aggregated offline documentation browsers. IOW, they allow you to download docsets for various languages, tools, packages, etc. and browse them all in the same application, sorta like MS's htmlhelp viewer.
The advantage with Dash/Zeal however is having all the books indexed together and and being able to find matches anywhere when you search (searching an individual book is possible too.) It's also crazy fast. It searches while you type and loads the page for the top match almost as soon as you release the key.
Dash is nagware, but was well worth the $20 for me. Zeal is Open Source and is not up to the same UX level as Dash, but still useful.
Anyway, the purpose of this message is to let you know that I've made some docsets for wxWidgets and Phoenix, you can get them from http://wxpython.org/Phoenix/docsets/. I'm not sure yet if I'll officially offer these with releases, so for now just consider them experimental.
P.S. If anybody feels like implementing a tool like this using Phoenix then that would be an excellent and useful tool (and sample application!) and it probably wouldn't be too hard to at least blow away Zeal in the UI/UX department.
I've been playing around with the Dash (for OSX) and Zeal (for Windows/Linux) tools which are nice aggregated offline documentation browsers. IOW, they allow you to download docsets for various languages, tools, packages, etc. and browse them all in the same application, sorta like MS's htmlhelp viewer.
The advantage with Dash/Zeal however is having all the books indexed together and and being able to find matches anywhere when you search (searching an individual book is possible too.) It's also crazy fast. It searches while you type and loads the page for the top match almost as soon as you release the key.
Dash is nagware, but was well worth the $20 for me. Zeal is Open Source and is not up to the same UX level as Dash, but still useful.
Anyway, the purpose of this message is to let you know that I've made some docsets for wxWidgets and Phoenix, you can get them from http://wxpython.org/Phoenix/docsets/. I'm not sure yet if I'll officially offer these with releases, so for now just consider them experimental.
Very nice concept and the searches are ultra fast but on my Win7 with Zeal as soon as one does a search the CPU usage goes up to 25% and stays there, too long for me to wait if it comes down at some point.
P.S. If anybody feels like implementing a tool like this using Phoenix then that would be an excellent and useful tool (and sample application!) and it probably wouldn't be too hard to at least blow away Zeal in the UI/UX department.
E.g. manually adding a search set is done by dropping it into the correct folder and restart Zeal.
Pity that Dash is Mac only - or a pity that I don't have one:-( .
Very nice concept and the searches are ultra fast but on my Win7 with
Zeal as soon as one does a search the CPU usage goes up to 25% and stays
there, too long for me to wait if it comes down at some point.
I see it too, but only about 12.5 percent in my case. I also noticed that it doesn't do it on the other docsets I had installed, and it only has the elevated CPU usage when one of the pages for the Phoenix docset is displayed. Switch to another page in the same search results that comes from a different docset and the CPU for the process drops back to near zero. My guess is that it's because I turned on the javascript flag in the docset and there is something ongoing in the page scripting...
Yeap, if I change to e.g. the Python 2.7 doc then the CPU usage is down to just about nothing.
I sent them them a support mail about it, hopefully they will look into it.
Werner
···
On 13/02/2014 02:17, Robin Dunn wrote:
Werner wrote:
Very nice concept and the searches are ultra fast but on my Win7 with
Zeal as soon as one does a search the CPU usage goes up to 25% and stays
there, too long for me to wait if it comes down at some point.
I see it too, but only about 12.5 percent in my case. I also noticed that it doesn't do it on the other docsets I had installed, and it only has the elevated CPU usage when one of the pages for the Phoenix docset is displayed. Switch to another page in the same search results that comes from a different docset and the CPU for the process drops back to near zero. My guess is that it's because I turned on the javascript flag in the docset and there is something ongoing in the page scripting...
Zeal as soon as one does a search the CPU usage goes up to 25%
and stays
there, too long for me to wait if it comes down at some point.
I see it too, but only about 12.5 percent in my case. I also
noticed that it doesn’t do it on the other docsets I had
installed, and it only has the elevated CPU usage when one of
the pages for the Phoenix docset is displayed. Switch to another
page in the same search results that comes from a different
docset and the CPU for the process drops back to near zero. My
guess is that it’s because I turned on the javascript flag in
the docset and there is something ongoing in the page
scripting…
Yeap, if I change to e.g. the Python 2.7 doc then the CPU usage is
down to just about nothing.
I sent them them a support mail about it, hopefully they will look
I just added a copy of the wxPython Phoenix (4.0.0a3) documentation to the Dash contributed documentation. You can browse for it by searching within Dash for wxPython.
Repo and instructions for building it from the source Sphinx docs are here:
Hope this helps people out!
···
On Friday, February 28, 2014 at 12:31:41 AM UTC-6, Metallicow wrote:
Seems like a nice little app. (zeal)
It seems awfully slow downloading some of the stuff, but decent finding speed for the engine.
Not sure how much use a “docset” would be or exactly the differences between the regular docs are
but thanks! I check it out.
Looks to be geared for more of a programmers documentation encyclopedia type app.
I just added a copy of the wxPython Phoenix (4.0.0a3) documentation to
the Dash contributed documentation. You can browse for it by searching
within Dash for wxPython.
Repo and instructions for building it from the source Sphinx docs are
here:
Good to know! Will it append the favicon? I created a favicon from the
wxPython demo.
Yes, although it is currently using a Phoenix icon which doesn't work so
well at a tiny size so switching something different eventually would
probably be a good idea. It also enables JavaScript so the sidebar can
be minimized. Personally I don't think it is very useful when using the
docs in Dash so I like to be able to move it out of the way.
Congrats on the wxPython Phoenix 4.0 release. I have taken the docset (as you mentioned above) from extras and put in a PR to Dash-User-Contribtions for wxPython 4.0.1. It should be merged in hopefully without any issues.
Adit
···
On Tuesday, July 25, 2017 at 2:19:53 PM UTC-5, Robin Dunn wrote:
Adit Panchal wrote:
Good to know! Will it append the favicon? I created a favicon from the
wxPython demo.
Yes, although it is currently using a Phoenix icon which doesn’t work so
well at a tiny size so switching something different eventually would
probably be a good idea. It also enables JavaScript so the sidebar can
be minimized. Personally I don’t think it is very useful when using the
docs in Dash so I like to be able to move it out of the way.
On Saturday, February 10, 2018 at 7:05:11 PM UTC-8, Adit Panchal wrote:
Congrats on the wxPython Phoenix 4.0 release. I have taken the docset (as you mentioned above) from extras and put in a PR to Dash-User-Contribtions for wxPython 4.0.1. It should be merged in hopefully without any issues.
Adit
On Tuesday, July 25, 2017 at 2:19:53 PM UTC-5, Robin Dunn wrote:
Adit Panchal wrote:
Good to know! Will it append the favicon? I created a favicon from the
wxPython demo.
Yes, although it is currently using a Phoenix icon which doesn’t work so
well at a tiny size so switching something different eventually would
probably be a good idea. It also enables JavaScript so the sidebar can
be minimized. Personally I don’t think it is very useful when using the
docs in Dash so I like to be able to move it out of the way.