zealdocs
Display docset name in results and top of page
Hi, just discovered Zeal and it's really great. :-)
A suggestion: I have loaded both Python 2 and 3 docsets (because I use both in different projects). When I look for a keyword, I usually get similar results for py2 and 3, which is normal. But in the current display, there is no way to distinguish similar results from different docsets.
This could be improved with two slight changes:
- display the docset name with each result item.
- display the docset name on top of the current page.
Thanks for the suggestions.
Here's what most likely will happen for items in your list:
1.1. A docset icon will be added to the search results. 1.2. Dash groups similar results from one docset, Zeal will have the same feature at some point. 2. I'll add current docset and page names to the window title. Also, a bread-crumb-like navigation menu is planned.
Just as a comment on this, the docset icons in the search result aren't always enough. For instance, I work with both Qt4 and Qt5, and they have identical icons. Same holds for Python2 and Python3. I don't have an ideal solution, unfortunately. Maybe adding a "short name" option for docsets, like "Py2" and "Py3" for the python variants. Or custom icons, maybe just overlay a version indicator, I don't know.
...maybe just overlay a version indicator
:+1: this seems like the most viable and non-obstructive solution at the moment.
Hi,
Any update on this? I'm using 0.3.1 and can't see any indication whether a search result item is from the Python 2 or 3 docset. (Also, it would really be nice to be able to constrain search. Wasn't it possible earlier? I kind of remember seeing it.)
@atleta Not yet. To do this efficiently we need to alter the way search results are handled, otherwise everything would become terribly slow.
@trollixx This sounds surprising, as I guess the index does store somehow which docset the document that it references belongs to. (But of course, I have no idea of the internals.) An alternative option might be to be able to enable and disable docsets. E.g. I think it's pretty rare that someone wants to look up something in multiple versions (and even then, they could just enable them).
Also, is there any plan on supporting installing multiple versions of docsets? (E.g. java6-7-8 and python2-3 can be installed in parallel, but most libraries don't. For example, if I donwload the django docset, it's always the latest, while sometimes I have to work with older codebases.)
@atleta We don't have a unified index, so it's impossible to say if there are similarly named search results without reiterating over merged list and then altering the names. For other suggestions please see #77 and #208.
@trollixx Hm, I don't get the problem then. Maybe we're talking about different solutions. If you have separate indexes that means that you do know during the search which result comes from which docset. Which means that you can easilly:
- tag each result with the docset name/version (as the opening comment says). E.g. if I search for 'getattribute' I'll see two results, both marked as python with an icon at the beginning of the line. What I would like to see is which one of these is python 2 and which one is python 3. Maybe as simple as (though it's pretty hackish) adding a '2' and a '3' to the logo. But something more general would be better. This doesn't mean that you'd have to somehow recollect the similar entries or anything like this.
- make it possible to enable/disable docsets (without deleting them) in the settings. And if you have this, then we could simply have versioned docsets. I mean beyond just python 2 vs 3 and java 5, 6, 7, 8. It would indeed, based on what you said about indexes, make search faster.
As a Workaround I edited the icon.png and [email protected] under ~/.local/share/Zeal/Zeal/docsets/Python_2.docset with pinta. Wrote a "2" over the icon. Will probably be overwritten by the next update, but I saved the two files somewhere, so I can just put them back.
