RE: Draft for the user manual

Hi Nacho

 

I think this is a good start. It's particularly useful to see how to launch it from Eclipse.

 

I am actually (still) in the process of doing a schema and documentation for moki and have yet to cover the results format. I am wondering what depth these should be covered in the user guide, the illustrations are helpful I think, but I am wondering if most users will be more interested in the results doc? - I assume that in most cases people won't actually see the moki document?

 

I wonder if a simple XSLT to summarise the results would be useful?

 

I think it might be useful to cover the command line options as they exist at present.

 

I think also that an expanded version of Sean's note [1] would be useful.

[1] http://lists.w3.org/Archives/Public/public-mobileok-checker/2007Sep/0002.html

 

I wonder if it would be useful to show how to (build) launch and run a JAR - where is it by the way? 

 

Cheers

Jo

 

 

 

---

Jo Rabin

mTLD (http://dotmobi.mobi)

mTLD Top Level Domain Limited is a private limited company incorporated and registered in the Republic of Ireland with registered number 398040 and registered office at Arthur Cox Building, Earlsfort Terrace, Dublin 2.

________________________________

From: public-mobileok-checker-request@w3.org [mailto:public-mobileok-checker-request@w3.org] On Behalf Of Ignacio Marin
Sent: 15 October 2007 20:12
To: public-mobileok-checker@w3.org
Subject: Draft for the user manual

 

Hi everyone,

I am sending again to the list an e-mail I have sent about 1 hour and a half ago.
It is taking a lot to receive it in the list although my mail server says it is already sent and it may have to see with the 1MB PDF attachment.

I am only attaching the ODP file now and I will send you some details to download the PDF for those who do not have OpenOffice installed.

And now, the text I previously sent...


Hi everyone,

Here I come with a first draft of the User Manual of the Checker, for you to review. I will still work on it tomorrow but, before I am done with some details, I think it would be good that you could send me your opinion about the structure (theoretically, agreed in Sophia-Antopolis) and the contents.

I am sending it in ODP and PDF formats (the latter, just in case you do not have OpenOffice installed).

Some comments:

- I guess that the logos are OK, except SevenVal's. Can you please send me a quality image, Roland?

- There is stuff missing: the final link for the binary release JAR, description for each jar on which the Checker depends, better explanations in certain parts of the doc, comment the results doc, enter some examples and create a glossary. Everything will be done by tomorrow (except the glossary thing, that I will add in next version of the doc).

- It seems important to me to explain people how to download the code via CVS so they can experiment with the code (and referencing the future Developer Manual, where all the guts of the Checker will be explained). I talk about it as s doc in development, because I want to publish it in a fine way, even for an alpha release. I'd publish the binary jar with the User Manual and expect the first version of the Developer Manual and a User Manual by next week.

- Please check the way in which I reference you all and your organizations. Also the copyright stuff. I tried to be brief and reference things like licenses of the libraries and the W3C License itself.

- I need that you confirm that you are entering any more changes to the Checker in order to show people how to import the code in the CVS repository into Eclipse.  I have detected changes in several checkouts I made today and it makes no sense that I document it if it is going to change (for example, the place where XSLTs are placed, some package naming and so on.

Well, I am looking forward to your comments.

Best regards,

Nacho



******************************************
Ignacio Marín Prendes
Device Independence Activity Lead
R&D Department
ignacio.marin@fundacionctic.org
www.fundacionctic.org
Fundación CTIC -Centro Tecnológico de la Información y la Comunicación-
Parque Científico y Tecnológico de Gijón
Edificio Centros Tecnológicos
33203 Cabueñes - Gijón - Asturias
Teléfono: 984 29 12 12
Fax: 984 39 06 12
******************************************

Este e-mail y cualquiera de sus ficheros anexos son confidenciales y pueden incluir información privilegiada. Si usted no es el destinatario adecuado (o responsable de remitirlo a la persona indicada), agradeceríamos lo notificase o reenviase inmediatamente al emisor. No revele estos contenidos a ninguna otra persona, no los utilice para otra finalidad, ni almacene y/o copie esta información en medio alguno.

Opiniones, conclusiones y otro tipo de información relacionada con este mensaje que no sean relativas a la actividad propia de CTIC deberán ser entendidas como exclusivas del emisor.

--------------------------------------------

This e-mail is confidential and may contain legally privileged information. If you are not the intended recipient it may be unlawful for you to read, copy, distribute or otherwise make use of the information herein. If you have received this e-mail in error, please contact us immediately. Fundación  CTIC will accept no liability for the mistransmission, interference, or interception of any e-mail and you are reminded that e-mail is not a secure method of communication.