Re: Release notes have a launcher - maybe we should remove that

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Fri, 5 Sep 2014 07:21:41 -0400 (EDT)
Bastien Nocera <bnocera@xxxxxxxxxx> wrote:

> 
> 
> ----- Original Message -----
> <snip>
> > What really got my interest was an idea to implement a new GNOME Shell
> > search provider (https://bugzilla.gnome.org/show_bug.cgi?id=690058) that
> > would integrate with Tracker to index locally installed docs (with
> > the search possibly restricted to /usr/share/help/). Similarly to already
> > indexed user documents in ~/Documents or personal contacts, users could
> > then search for locally installed documentation, including the Release
> > Notes, from within the Shell's Activities overview. This would allow for a
> > far better (as in systematic) approach to finding files on the user's
> > desktop, with a neat categorization in the Shell's search results as an
> > added bonus.
> 
> Search providers are all backed by applications. What's the application
> to read the docs in /usr/share/help? What would be in there other than the
> release notes?

It could be gnome-documents as Matthias proposed if we choose to ship PDF
instead of a bunch of HTML pages.

It could be yelp as it supports transforming DocBook/Mallard XML as well as
viewing HTML pages. I just tested it and yelp works quite well:

$ yelp /usr/share/doc/fedora-release-notes/index.html

The right thing to do would probably be to move Release Notes
from /usr/share/doc/ to /usr/share/help/. Indexing /usr/share/help/ would
get users easy access to both downstream (Release Notes) as well as upstream
documentation (GNOME Help, application help, GNOME System Admin Guide,
etc.).

> It would probably be better to have those docs be converted to something Yelp
> can read and integrated in the Help, at least for GNOME and for Workstation.

Yes, we could do integration in the GNOME Help. Few things would have to
be figured out, though:

* Whether we want to do this integration upstream with the help of Mallard
conditionals. We would probably need a new test token
(http://projectmallard.org/if/1.0/tokens) for that implemented in yelp.

* Alternatively, we could create a downstream patch. Maintaining this
and figuring out what to do with translations is not something  I would
personally want to do. ;)

Cheers,
pk
-- 
docs mailing list
docs@xxxxxxxxxxxxxxxxxxxxxxx
To unsubscribe:
https://admin.fedoraproject.org/mailman/listinfo/docs





[Index of Archives]     [Fedora Users]     [Fedora Desktop]     [Red Hat 9]     [Yosemite News]     [KDE Users]

  Powered by Linux