W3C home > Mailing lists > Public > www-ws-desc@w3.org > May 2002

RE: comment: documentation scenario and requirement

From: Jeffrey Schlimmer <jeffsch@windows.microsoft.com>
Date: Fri, 3 May 2002 15:43:11 -0700
Message-ID: <2E33960095B58E40A4D3345AB9F65EC106E152A7@win-msg-01.wingroup.windeploy.ntdev.microsoft.com>
To: "Ronald Daniel" <rdaniel@interwoven.com>, <www-ws-desc@w3.org>
Ronald, thanks for pointing out this subtle, but important point. I will
add this as a draft requirement for WG consideration.

--Jeff

-----Original Message-----
From: Ronald Daniel [mailto:rdaniel@interwoven.com] 
Sent: Friday, May 03, 2002 9:12 AM
To: 'www-ws-desc@w3.org'
Subject: comment: documentation scenario and requirement

Quick comment on the requirements working draft... I did
not see anything in the scenarios and requirements
around the use of the <documentation> element. Don't think
its very controversial, we just want to make sure the
Schema for <wsdl:documentation> remains open.
At least one of the current WSDL compilers
silently fails when <documentation> elements contain markup,
so a test case covering this would be nice.

Suggested requirement:

The content model of <documentation> must be open to allow
people to insert markup of their choice.

Reason:  Current practice
We have written XSLT scripts that harvest those elements,
as well as contextual information, to generate documentation
which follows the xmlspec DTD. Others may want to go direct
to XHTML, or to other DTDs such as DocBook. Explanations of
messages, parts, ... may need multiple paragraphs or want to
use things like bulleted or numbered lists. The spec should
let people use whatever markup in their documentation that they
want.


Thanks,
Ron Daniel Jr.
Standards Architect
Interwoven, Inc.
803 11'th Ave.
Sunnyvale, CA, USA  94089
Tel: 408 530 5922
Cell: 925 368 8371 
Email: rdaniel@interwoven.com

Visit www.interwoven.com
The Leader in Enterprise Content Management
Received on Friday, 3 May 2002 19:10:01 GMT

This archive was generated by hypermail 2.2.0+W3C-0.50 : Monday, 7 December 2009 10:58:20 GMT