[wtp-dev] ISV documentation and API docs/Javadoc - ACTION REQUIRED

[Susan Yeshin <syeshin@xxxxxxxxxx>]

The general structure for the ISV documentation
will be as follows:

There should be two 'books' for the
ISV guide, one for wst and one for jst. Inside each book will be anchors
to the isv doc plugin and javadoc for each component. 

WST Developer Guide
  Extending Web services
    Programmer's guide
    JavaDoc
  Extending XML tools
    Programmer's guide
    JavaDoc

In this example there would have the following plugins 

org.eclipse.wst.doc.isv - will contain
the master navigation (I will handle this)
     org.eclipse.wst.webservices.doc.isv

           
    tocfile.xml
        plugin.xml
        topics
         
   extendwsoverview.html
         
   extendwspt1.html
           
         extendwspt2.html
           
    images
           
          screencap.gif (use only if needed and
please grab the smallest part of the screen you can)
    toc link to - org.eclipse.wst.webservices.javadoc***??
- need to find out what plugins the developers put their javadoc in.
     org.eclipse.wst.xml.doc.isv
           
    tocfile.xml
        plugin.xml
        topics
         
   extendxmloverview.html
         
   extendxmlpt1.html
           
         extendxmlpt2.html
           
    images
   toc link to -  org.eclipse.wst.xml.javadoc***??

The same structure would be used for
each component under wst and under jst projects.

Please send a note with the extension
points you would like covered in your component's guide and send the plugin
name that contains your API docs (I do hope they are in a separate plugin)
to christoph and cc me. Christoph will be documenting the ISV guides and
will likely be contacting you for information.  Please also open a
Bugzilla bug with this same information and add the bug # to the email
sent.

Christoph's email - ckrawczyk@xxxxxxxxxxxxx
I will be away for a week and will only
be able to read my Yahoo mail - syeshin@xxxxxxxxx


Thanks,
Susan Yeshin

Rational Tools Information Development
IBM Toronto Lab
D3 - 446
syeshin@xxxxxxxxxx
(905) 413-3662
t/l 8-969-3662