Re: Tetravex Help

[Milo Casagrande <miloc gnome org>]

Hi,

2009/12/27 Mario Blättermann <mariobl gnome org>:
> I've converted the files into HTML with Shaun's Makefile. The Video
> doesn't work, neither in Epiphany (gecko) nor in Yelp. There's no
> clickable link to it. I've tried to feed my help browser directly with
> the *.page file, but Yelp cannot handle it.

Yelp cannot handle the video in it (yet).

> That's a step back in
> comparison with Yelp's ability to parse and handle XML (DocBook) files
> directly. Well, Yelp cannot handle DocBook really, but it starts the
> appropriate conversion in the background, without any arguments, just
> typing "yelp db_file.xml".

I created a stupid test page to see how the support of the HTML video
tag is. It works on Firefox, but not with Epiphany + WebKit on GNOME
2.28 (I can't reproduce the video, I see only a static image). Does
anybody know what is the support of the video tag with Epiphany trunk?

> As you can see, the link from the *.page file will not be converted to a
> real HTML link. And another question: Once it works, does Yelp have to
> start an embedded video player to play it, or could Yelp play it
> directly? I mean, Yelp have either to be able to call a browser plugin
> (based on Totem, MPlayer...) or it should include its own player
> feature. What's the current solution here?

At the moment, I think there isn't a real solution, but Shaun should
probably be the best to speak here.

> In general, I think it's a good idea to let appear a small video
> wherever needed, especially for applications which needs time-critical
> control, such as games. Your video is good, in any case videos should be
> kept short. But it is some irritant, that it doesn't show a mouse
> cursor.

The video I uploaded is 47 seconds long, I think it would be better to
have a 30 seconds video, even if we do not complete the game, but at
least we show all the movements. I'll try and create another one.
I kept it "small" with regards to pixels size: now it's a 240x320, I
don't know if we should go with a bigger size. I'll try and see how
Firefox renders it at different resolutions.

> In my mind, it would be better to have it available in the real GNOME
> Git repo. There's some time left before 2.30 will be released. Should be
> possible to get it really working within some months.

For me it's OK.
We can leave the video out for the moment, and see how things evolve.
If we are able to show videos in Yelp before the 2.30 deadline, we can
insert it later.

> But we have to find a valid solution for including the license stuff
> before. OK, I agree, we don't have to display the program's license
> within the docs. But we should include the doc license itself.

Agreed.

> A good
> way to do so would be a "See also" link in the index.page which links to
> a short version of the CC-BY.

I think we can do that. The best solution would be to have a system
wide license, maybe in g-d-u that gets translated from there, but if
we cannot make it for 2.30, we can ship a common license page valid
for all docs, linked from the index.page. I'll work on this later, and
will attach the license.page in l.g.o under the DocumentationProject
pages, so that we have a valid reference in the future.

> Have a look at the Kupfer docs to see what
> I mean [1]. In fact, we have such a license.page (or license.xml?) in
> the Empathy manual, which is the one and only real example for an
> aims-to-complete Mallard doc. And I repeat my question another one: Why
> it is shipped with, but doesn't appear anywhere?

IIRC, It used to appear. In the first Mallard-XSLT version there was a
footer in every page with the copyright year, and a link to the
license (or was it only the copyright year?). But that has been
removed in order to have a better way to show the license page and
also to give credits.

Ciao.

-- 
Milo Casagrande <miloc gnome org>