Re: [dev] new feature in EIS: check specification documents

Hi,

Bernd Eilers a écrit :

> In EIS ( http://eis.services.openoffice.org ) there is a new menu entry 
> "Misc/Check specification" available.

Yes, found it :-)

Hehe ... propose a new choose for the login is a good thing too! ( 
normal/guest )

> As you all might know for new OpenOffice.org features specification 
> documents should be written. Most of them can be found at 
> http://specs.openoffice.org.

Yes, I know, and this is an important link for me since some times.

> Specification documents MUST use the template available at 
> http://specs.openoffice.org/collaterals/Specification_template.stw

Ok, no problem. I'll strictely follow your recommandations.

> We have a semi-automatic WhatsNewGuide creation process where those 
> documents are automatically parsed and content for the whatsnewguide is 
> extracted. This does only work of course if section headers etc. are 
> kept in tact and if the right template has been used.

ok

> 
> The new feature in EIS checks wether a given specification document is 
> suitable for the semi-automatic WhatsNewGuide creation by applying the 
> same XSL-Transformations to it for example.
> 
> Unfortunatly for existing specifications not always the right template 
> has been used or wrong modifications have been made to the document. 
> Sometimes specifications are not even using StarOffice Writer documents 
> at all. This means that sometimes the XSL-transformations would work and 
> sometimes they wont. Annother common error detected by this feature in 
> some specifications is to start the abstract section with something like 
> "This document" or similar this is also not suitable for the 
> whatsnewguide creation and should be changed.

Just a test : check about Mac OSX word gave me :
Error: no title found 	Error: no abstract found 	Error: no owner found

Ufff... really nothing ?  :-/

Maybe the template has not been correctly used ?

> Anybody who has been written specifications is encouraged to check them 
> with this new EIS feature. If errors should occur please update the 
> specification by starting with a new document using the correct template 
> and copy the content from the not suitable specification to it.

I'm not sure to be completely right, but ask for specification can be 
proposed, right ?

So, if this is possible  it might be interessant for all to discover 
that "another way" exists, and to illustrate this point, I'll propose 
new docs, about Apple Aqua Human Interfaces Guidelines. Just as example...

Since I contribute for OpenOffice.org, I never have seen a real effort 
about Mac OSX users interface nor look'n feel, but I'm sure some will 
beinterested with this.

> The feature is also accessible with the following direct URL ( without 
> EIS menüs surrounding it )
> 
> http://eis.services.openoffice.org/EIS2/guide.CheckSpecification

Thank you very very much for this feature. Great idea !!



Regards,
eric bachard


-- 
<[email protected]>
Francophone OpenOffice.org Commmunity developer (Linux PPC /  Mac OS X / 
X11)
See : <http://fr.openoffice.org>