Re: Keel documentation

Shash:

Fantastic job! I really liked the new keel-doc CVS layout. I'd like to 
make some humble suggestions:

1. Translations of the manual
	Rename book.xml to book-en_US.xml (and so on) so that it clearly shows 
the manual is for English. With the new directory structure, it should 
be very easy to do a translation: drop a translated version as 
book-ja_JA.xml in the same place as the corresponding english file.
	Also, the build system would probably need to be updated to take care 
of multiple languages..?

2. Standardization of image formats
	I think we should standardize on PNG as the image format, as it saves 
space, can do true-color, and is better than GIF. We have a number of 
formats in the old manual (GIF, SVG, etc) and having a standard image 
format and naming convention/directory structure (since all images will 
be in a seperate hierarchy).

I'd also love it if we could somehow modify the build system so that by 
adding chapter.xml in doc/manual of a app/service/client resulted in 
that being added to the manual. Dunno if it's a good idea, though.


Regards,
Ashish


Sasvata (Shash) Chatterjee wrote:

> All,
> 
> Based on feedback, the Keel documentation page on 
> http://www.keelframework.org has been updated to provide a consolidated 
> set of documentation links.  In the future, we will attempt to break it 
> out further into a per-release set of docs, the start of which you can 
> see now.
> 
> The new manual structure is in place now, with placeholder files for 
> each of Keel's current pieces (linked from above page).  Over the next 
> week or so, documentation from our existing sources will be consolidated 
> into the new manual.
> 
> If you look in CVS in keel-doc, you will see how the doc-book source is 
> organized.  Feedback most welcome.  If anybody has any ideas of  what a 
> typical doc for a service, app, client should look like, feedback and 
> suggestions on that are also most welcome (solicited, actually, :-)).
> 
> Shash

-- 


"This e-mail message may contain confidential, proprietary or legally privileged information. It 
should not be used by anyone who is not the original intended recipient. If you have erroneously 
received this message, please delete it immediately and notify the sender. The recipient 
acknowledges that ICICI Bank or its subsidiaries and associated companies,  (collectively "ICICI 
Group"), are unable to exercise control or ensure or guarantee the integrity of/over the contents of the information contained in e-mail transmissions and further acknowledges that any views 
expressed in this message are those of the individual sender and no binding nature of the message shall be implied or assumed unless the sender does so expressly with due authority of ICICI Group.Before opening any attachments please check them for viruses and defects."