[maemo-developers] Maemo Info Center library service released with first set of official maemo Fremantle 5 documentation

[From: Jarmo.Tikka at nokia.com]

Hi,

Thanks about comments...

> Date: Mon, 19 Apr 2010 11:07:05 +0200
> From: Marcin Juszkiewicz <marcin at juszkiewicz.com.pl>
> Subject: Re: Maemo Info Center library service released with first set
> 	of	official maemo Fremantle 5 documentation
> To: maemo-developers at maemo.org
> Message-ID: <201004191107.06736.marcin at juszkiewicz.com.pl>
> Content-Type: Text/Plain;  charset="iso-8859-2"
> 
> Dnia pi?tek, 16 kwietnia 2010 o 19:40:22 Jarmo.Tikka at nokia.com
> napisa?(a):
> 
> > The Maemo documentation infrastructure project has released new Maemo
> Info
> > Center documentation service for Maemo platform. Together with Maemo
> Info
> > Center service we released also the first set of official Maemo
> Fremantle
> > 5 documentation. More Fremantle 5 documentation will be updated to
> the
> > Maemo Info Center service end of April.
> 
> I worked for few years in Web development. When I enter this page I
> feel like
> back in 90's... Why?
> 
> 1. Frames - this thing died long time ago. After few clicks I have to
> go to
>    location bar, enter mainpage URL to get page usable again.

There are some theme problems that we will fix next time we update documents into Info Center.

See https://bugs.maemo.org/show_bug.cgi?id=9960
https://bugs.maemo.org/show_bug.cgi?id=9959
https://bugs.maemo.org/show_bug.cgi?id=9961

Other than these there should not be problems in frames?

> 2. Javascript trees?

??

> 3. I used "Search" box - just to get information that there is no index
> and have to wait until it will index all documentation. Why it was not
> indexed at start?

This is possible with Info Center but as it is done only once (first time somebody does the search) we did not do it for this release. 

Anyhow because we have scalable Info Center infrastructure e.g. two (or more) servers and each server running two Inco Centers in cluster there will be actually 4 times indexing needs to be done and the number of documents will increase a lot so I think we need to study how to provide rebuilt indexes.

Could you write bug about this indexing stuff?

> 4. Amount of arrows on screen is insane:
> 
> - there are yellow arrows which duplicate Back/Forward from web browser
> - there are black arrows in non-Qt documentation which are Prev/Next
> chapter
> - there are green arrows in maemomm documentation

Arrows in toolbar are for Info Center usage and arrows in documents are from original HTML documents. There is not much we can do for these so no point writing bug report about this.

> 
> 5. Each part of tree uses other type of navigation, other formatting...

This is again problem that in open source world people use different tools to provide documentation. For API docs we need to use Doxygen and GTKDoc which both produce different document style. I anyhow agree that we should study are we able to use or configure those tools so that documents produces would be closer from layout point of view.

> 
> Long way before it will be useful.

I think it is quite useful already now. Especially as it integrates also to the Maemo Eclipse IDE e.g. all documents published in Info Center will be available also for the Eclipse IDE users. 

And if you do not want to use Info Center to read/search documentation you can always download documents to your own PC http://library.maemodocs.nokia.com/documents/ :).

Cheers,
//Jarmo
> 
> Regards,
> --
> JID:      hrw at jabber.org
> Website:  http://marcin.juszkiewicz.com.pl/
> LinkedIn: http://www.linkedin.com/in/marcinjuszkiewicz