Skip to main content
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [wtp-dev] Extension Point Documentation Updates Required

Lawrence,

The ISV docs are really coming along! While browsing through them it struck me that we have an opportunity for improved hyperlinking. e.g. add links to extension points and plugins from the pages like this:



Arthur Ryman,
IBM Software Group, Rational Division

blog: http://ryman.eclipsedevelopersjournal.com/
phone: +1-905-413-3077, TL 969-3077
assistant: +1-905-413-2411, TL 969-2411
fax: +1-905-413-4920, TL 969-4920
mobile: +1-416-939-5063, text: 4169395063@xxxxxxx


Lawrence Mandel/Toronto/IBM@IBMCA
Sent by: wtp-dev-bounces@xxxxxxxxxxx

11/29/2005 12:07 PM

Please respond to
"General discussion of project-wide or architectural issues."
To
wtp-dev@xxxxxxxxxxx
cc
Subject
[wtp-dev] Extension Point Documentation Updates Required






WTP committers and contributors,

I have updated the WTP ISV documentation to include references to all the extension points defined by WTP. This documentation is automatically extracted from the schema files that describe each extension point. As can be seen in M9, this documentation is not complete. As plug-in owners you need to provide documentation about the extension points you have defined. Specifically,

1. Please review the list of extension points in the Web Standard Tools and J2EE Standard Tools Developer Guides (Help->Help Contents) and ensure all of your extension points are listed.

2. For each extension point, ensure the name and extension point are defined correctly in both the plug-in manifest and the schema

3. Add information about each element and attribute in the extension.

4. Add supplementary information including a short description, examples, API information, and any supplied implementations in WTP.

5. Specify the since version.

If the extension point is part of the public API the version should be 1.0.

If it is internal place the following comment instead of a version number:

<b>This extension point is internal and should not be used by any other plugins.</b>

Otherwise place the following comment instead of a version number:

<b>This extension point is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.</b>

I've already updated the copyright and base extension element <extension> documentation in many of the WST plug-ins. (I haven't had time to update all of the extension point schemas.) Let me know if you need any help updating this documentation. This needs to be complete for WTP 1.0. Bug 117755 [1] is open to track these changes. Please add comments once your schemas are updated.

Examples can be seen in the URI resolver [1] and the cache [2].

Lawrence Mandel

Software Developer
IBM Rational Software
Phone: 905 - 413 - 3814   Fax: 905 - 413 - 4920
lmandel@xxxxxxxxxx

[1] https://bugs.eclipse.org/bugs/show_bug.cgi?id=117755
[2] http://dev.eclipse.org/viewcvs/index.cgi/wst/components/common/plugins/org.eclipse.wst.common.uriresolver/schema/resolverExtensions.exsd?rev=1.5&cvsroot=WebTools_Project&content-type=text/vnd.viewcvs-markup
[3] http://dev.eclipse.org/viewcvs/index.cgi/wst/components/internet/plugins/org.eclipse.wst.internet.cache/exsd/cacheresource.exsd?rev=1.3&cvsroot=WebTools_Project&content-type=text/vnd.viewcvs-markup_______________________________________________
wtp-dev mailing list
wtp-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/wtp-dev

Back to the top