GNOME Bugzilla – Bug 118423
individual bookshelfs
Last modified: 2021-05-17 15:49:10 UTC
definitions: books = tutorials (like libglade doc, gobject doc, libgnomeui docs, etc.) bookshelf = accumulation of books (one or more books) i wish there would be individual bookshelfs that the user could create, modify or remove them. the bookshelfs would contain one or more books, where also one book could be in multiple bookshelfs. this would be usefull if you have a lot of books and sort them, like gnome 1.x docs, gnome2.x docs, gtk stuff like glib, gobject, etc....
This is planned, though I chose to call them profiles instead. What I would like to add is the possibility to easily chose which profile (GNOME, Python, Java, ...) you want to use and it would show you those books.
(In reply to comment #1) > This is planned, though I chose to call them profiles instead. What I > would like to add is the possibility to easily chose which profile > (GNOME, Python, Java, ...) you want to use and it would show you those > books. I've got an initial approach to something similar to these 'profiles' idea, working in the 'group-by-language' branch in gitorious: http://gitorious.org/devhelp/devhelp/commits/group-by-language (Note the branch is based on another not-yet-pushed branch, the one for monitoring book events from bug 349608) Basically, devhelp will read the 'language' attribute given in the gtk-doc devhelp XML, and group all books in the same language, both in the tree view and in the new list of enabling/disabling books in preferences. This grouping can also be disabled. What it would be missing is the possibility of forcing a given book to be listed under a given language. This would be helpful for books which don't set the 'language' attribute (as the Vala or libxml2 reference manuals for example), or for books which are really language-independent (as the DBus tutorial). Currently I group all these under a same "Undefined" category. Comments/review welcome!
Created attachment 176160 [details] Screenshot Attaching screenshot showing the books grouped by language
> I've got an initial approach to something similar to these 'profiles' idea, > working in the 'group-by-language' branch in gitorious: > http://gitorious.org/devhelp/devhelp/commits/group-by-language > (Note the branch is based on another not-yet-pushed branch, the one for > monitoring book events from bug 349608) > This previous listed branch is obsolete, the new one is "improvements", available in gitorious: http://gitorious.org/devhelp/devhelp/commits/improvements
So in 2017 the group-by-language feature is present in Devhelp. The (programming) language is provided in the *.devhelp2 index file, at least those generated by GTK-Doc. Currently Devhelp is used mostly for development with GTK+ and GNOME libraries. But nothing prevents Devhelp from supporting other development platforms, as long as the docs are available in HTML and a *.devhelp2 index file is generated. For example Devhelp could be used for Linux kernel development, now that they have a more modern docs infrastructure. So an idea would be to provide the dev-platform, like the language, in the *.devhelp2 index files. For example "GNOME" or "Linux kernel". With a way to launch Devhelp for a specific dev platform (like a profile). (I don't plan to work on this, it's just an idea, longer-term).
We discussed this a while ago in a dev hackfest in Brussels; and I recall Jon suggesting we have a index with all GNOME related books directly accessible when opening Devhelp. I like this idea, but it may be quicker to go on with a pre-defined list of books that apply to GNOME directly hardcoded in Devhelp, than going one by one changing all the projects (or a combination of both).
There is now a new infrastructure in libdevhelp which permits to implement this feature more easily: DhProfile, DhSettings and DhBookList.
-- GitLab Migration Automatic Message -- This bug has been migrated to GNOME's GitLab instance and has been closed from further activity. You can subscribe and participate further through the new bug through this link to our GitLab instance: https://gitlab.gnome.org/GNOME/devhelp/-/issues/32.