[117755] Cleaned up WST extension point documentation.
diff --git a/bundles/org.eclipse.wst.html.ui/schema/deviceProfileEntryProvider.exsd b/bundles/org.eclipse.wst.html.ui/schema/deviceProfileEntryProvider.exsd index 644dc58..5a31888 100644 --- a/bundles/org.eclipse.wst.html.ui/schema/deviceProfileEntryProvider.exsd +++ b/bundles/org.eclipse.wst.html.ui/schema/deviceProfileEntryProvider.exsd
@@ -6,7 +6,7 @@ <meta.schema plugin="org.eclipse.wst.html.ui" id="deviceProfileEntryProvider" name="Device Profile Entry Provider Extension"/> </appInfo> <documentation> - <b>This extension point is deprecated and should not be used.</b> + </documentation> </annotation>
diff --git a/bundles/org.eclipse.wst.sse.core/schema/formatProcessors.exsd b/bundles/org.eclipse.wst.sse.core/schema/formatProcessors.exsd index 56f866b..e5bd5eb 100644 --- a/bundles/org.eclipse.wst.sse.core/schema/formatProcessors.exsd +++ b/bundles/org.eclipse.wst.sse.core/schema/formatProcessors.exsd
@@ -78,12 +78,15 @@ <meta.section type="examples"/> </appInfo> <documentation> - <extension point="org.eclipse.wst.sse.core.formatProcessors"> - <processor - class="org.eclipse.wst.sse.core.xml.format.FormatProcessorXML" - contentTypeId="org.eclipse.core.runtime.xml"> - </processor> -</extension> + <pre> + <extension + point="org.eclipse.wst.sse.core.formatProcessors"> + <processor + class="org.eclipse.wst.sse.core.xml.format.FormatProcessorXML" + contentTypeId="org.eclipse.core.runtime.xml"> + </processor> + </extension> +</pre> </documentation> </annotation>
diff --git a/bundles/org.eclipse.wst.sse.ui/schema/editorconfiguration.exsd b/bundles/org.eclipse.wst.sse.ui/schema/editorconfiguration.exsd index eae4de2..66e2130 100644 --- a/bundles/org.eclipse.wst.sse.ui/schema/editorconfiguration.exsd +++ b/bundles/org.eclipse.wst.sse.ui/schema/editorconfiguration.exsd
@@ -206,22 +206,21 @@ </appInfo> <documentation> <pre> -<extension point="org.eclipse.wst.sse.ui.editorConfiguration"> -<!-- associating a source viewer configuration to an input's content type--> - <sourceViewerConfiguration - class="org.eclipse.wst.html.ui.StructuredTextViewerConfigurationHTML" - target="org.eclipse.wst.html.core.htmlsource"/> - -<!-- associating an outline configuration to an input's content type --> - <contentOutlineConfiguration - class="org.eclipse.wst.sse.xml.ui.views.contentoutline.XMLContentOutlineConfiguration" - target="org.eclipse.core.runtime.xml"/> - -<!-- associating a property sheet configuration to multiple content types --> - <propertySheetConfiguration - class="org.eclipse.wst.xml.ui.views.properties.XMLPropertySheetConfiguration" - target="org.eclipse.wst.sse.contenttype.xml, org.eclipse.wst.html.core.htmlsource, org.eclipse.jst.jsp.core.jspsource"/> -</extension> + <extension + point="org.eclipse.wst.sse.ui.editorConfiguration"> + <!-- associating a source viewer configuration to an input's content type--> + <sourceViewerConfiguration + class="org.eclipse.wst.html.ui.StructuredTextViewerConfigurationHTML" + target="org.eclipse.wst.html.core.htmlsource"/> + <!-- associating an outline configuration to an input's content type --> + <contentOutlineConfiguration + class="org.eclipse.wst.sse.xml.ui.views.contentoutline.XMLContentOutlineConfiguration" + target="org.eclipse.core.runtime.xml"/> + <!-- associating a property sheet configuration to multiple content types --> + <propertySheetConfiguration + class="org.eclipse.wst.xml.ui.views.properties.XMLPropertySheetConfiguration" + target="org.eclipse.wst.sse.contenttype.xml, org.eclipse.wst.html.core.htmlsource, org.eclipse.jst.jsp.core.jspsource"/> + </extension> </pre> </documentation> </annotation>
diff --git a/bundles/org.eclipse.wst.sse.ui/schema/sourcevalidation.exsd b/bundles/org.eclipse.wst.sse.ui/schema/sourcevalidation.exsd index 9219571..5250d31 100644 --- a/bundles/org.eclipse.wst.sse.ui/schema/sourcevalidation.exsd +++ b/bundles/org.eclipse.wst.sse.ui/schema/sourcevalidation.exsd
@@ -3,20 +3,20 @@ <schema targetNamespace="org.eclipse.wst.sse.ui"> <annotation> <appInfo> - <meta.schema plugin="org.eclipse.wst.sse.ui" id="sourcevalidation" name="sourcevalidation"/> + <meta.schema plugin="org.eclipse.wst.sse.ui" id="sourcevalidation" name="Source Validation"/> </appInfo> <documentation> - This extension point is provided to allow clients to contribute a validator (org.eclipse.wst.validation.internal.provisional.core.IValidator) -for as-you-type (source) validation. + This extension point is provided to allow clients to contribute a validator (<code>org.eclipse.wst.validation.internal.provisional.core.IValidator</code>) +for as-you-type (source) validation.<br> -If your validator can handle "partial document" validation, it should also implement ISourceValidator. The validate call on ISourceValidator gets passed an IRegion representation of the part of the document that's dirty. +If your validator can handle "partial document" validation, it should also implement ISourceValidator. The validate call on ISourceValidator gets passed an IRegion representation of the part of the document that's dirty.<br> -This should be much more efficient than validating the entire file each time someone types. +This should be much more efficient than validating the entire file each time someone types.<br> -The validator is enabled for specific content type/partition combinations. +The validator is enabled for specific content type/partition combinations.<br> -Required plugins are: - org.eclipse.wst.sse.ui +Required plugins are:<br> + org.eclipse.wst.sse.ui<br> org.eclipse.wst.validation </documentation> </annotation> @@ -111,7 +111,7 @@ <meta.section type="since"/> </appInfo> <documentation> - WTP 1.0 + <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> </documentation> </annotation> @@ -122,34 +122,38 @@ <documentation> Example demonstrating how HTMLValidator contributes to as-you-type validation in the source editor. -<extension - point="org.eclipse.wst.sse.ui.extensions.sourcevalidation"> - <validator - scope="total" - class="org.eclipse.wst.validation.html.HTMLValidator" - id="org.eclipse.wst.validation.htmlsourcevalidator"> - <contentTypeIdentifier - id="org.eclipse.wst.html.core.htmlsource"> - <partitionType - id="org.eclipse.wst.html.HTML_DEFAULT"> - </partitionType> - </contentTypeIdentifier> - <contentTypeIdentifier - id="org.eclipse.jst.jsp.core.jspsource"> - <partitionType - id="org.eclipse.wst.html.HTML_DEFAULT"> - </partitionType> - </contentTypeIdentifier> - </validator> -</extension> - +<pre> + <extension + point="org.eclipse.wst.sse.ui.extensions.sourcevalidation"> + <validator + scope="total" + class="org.eclipse.wst.validation.html.HTMLValidator" + id="org.eclipse.wst.validation.htmlsourcevalidator"> + <contentTypeIdentifier + id="org.eclipse.wst.html.core.htmlsource"> + <partitionType + id="org.eclipse.wst.html.HTML_DEFAULT"/> + </contentTypeIdentifier> + <contentTypeIdentifier + id="org.eclipse.jst.jsp.core.jspsource"> + <partitionType + id="org.eclipse.wst.html.HTML_DEFAULT"/> + </contentTypeIdentifier> + </validator> + </extension> +</pre> +<p> Using ISourceValidator - +</p> +<p> If your validator can handle "partial document" validation, it should implement ISourceValidator. - +</p> +<p> The validate call on ISourceValidator gets passed an IRegion of the document which represents just the part that's dirty. This should be much more efficient than validating the entire file each time someone types. - +</p> +<p> ISourceValidator has its "connect(IDocument doc)" method called when it's hooked up to the document (when the editor is opened), and "disconnect(IDocument doc)" called when the editor is closed, where any "unhooking" should take place. +</p> </documentation> </annotation> @@ -158,37 +162,7 @@ <meta.section type="apiInfo"/> </appInfo> <documentation> - Example demonstrating how HTMLValidator contributes to as-you-type validation in the source editor. - -<extension - point="org.eclipse.wst.sse.ui.extensions.sourcevalidation"> - <validator - scope="total" - class="org.eclipse.wst.validation.html.HTMLValidator" - id="org.eclipse.wst.validation.htmlsourcevalidator"> - <contentTypeIdentifier - id="org.eclipse.wst.html.core.htmlsource"> - <partitionType - id="org.eclipse.wst.html.HTML_DEFAULT"> - </partitionType> - </contentTypeIdentifier> - <contentTypeIdentifier - id="org.eclipse.jst.jsp.core.jspsource"> - <partitionType - id="org.eclipse.wst.html.HTML_DEFAULT"> - </partitionType> - </contentTypeIdentifier> - </validator> -</extension> - - -Using ISourceValidator - -If your validator can handle "partial document" validation, it should implement ISourceValidator. - -The validate call on ISourceValidator gets passed an IRegion of the document which represents just the part that's dirty. This should be much more efficient than validating the entire file each time someone types. - -ISourceValidator has its "connect(IDocument doc)" method called when it's hooked up to the document (when the editor is opened), and "disconnect(IDocument doc)" called when the editor is closed, where any "unhooking" should take place. + </documentation> </annotation>
diff --git a/bundles/org.eclipse.wst.xml.core/schema/catalogContributions.exsd b/bundles/org.eclipse.wst.xml.core/schema/catalogContributions.exsd index 1eb5101..c90597b 100644 --- a/bundles/org.eclipse.wst.xml.core/schema/catalogContributions.exsd +++ b/bundles/org.eclipse.wst.xml.core/schema/catalogContributions.exsd
@@ -6,17 +6,12 @@ <meta.schema plugin="org.eclipse.wst.xml.core" id="catalogContributions" name="XML Catalog Contributions Extension Point"/> </appInfo> <documentation> - + This extension point allows to specify entries for XML Catalog. Catalog entries have format specified in <a href="http://www.oasis-open.org/committees/download.php/14041/xml-catalogs.html">http://www.oasis-open.org/committees/entity/spec.html</a>. +Each catalog extension consists of a single catalogContribution element. </documentation> </annotation> <element name="extension"> - <annotation> - <documentation> - This extension point allows to specify entries for XML Catalog. Catalog entries have format specified in <a href="http://www.oasis-open.org/committees/download.php/14041/xml-catalogs.html">http://www.oasis-open.org/committees/entity/spec.html</a>. -Each catalog extension consists of a single catalogContribution element. - </documentation> - </annotation> <complexType> <choice> <element ref="catalogContribution"/> @@ -228,26 +223,31 @@ </appInfo> <documentation> <pre> -<extension point="org.eclipse.wst.xml.uriresolver.catalogContributions"> - <catalogContribution> - <system - systemId="http://schemas.xmlsoap.org/wsdl/" - uri="data/xsd/wsdl.xml" > - <property name="webURL" value="http://schemas.xmlsoap.org/wsdl/"/> - </system> - <uri - name="http://schemas.xmlsoap.org/wsdl/soap/" - uri="data/xsd/soap.xsd"/> - <public - publicId="http://www.w3.org/1999/XSL/Transform" - uri="data/xsd/XSLSchema.xsd"> - <property name="webURL" value="http://schemas.xmlsoap.org/wsdl/"/> - </public> - <nextCatalog - id="nestedCatalog" - catalog="data/catalog1.xml"/> - </catalogContribution> -</extension> + <extension + point="org.eclipse.wst.xml.uriresolver.catalogContributions"> + <catalogContribution> + <system + systemId="http://schemas.xmlsoap.org/wsdl/" + uri="data/xsd/wsdl.xml" > + <property + name="webURL" + value="http://schemas.xmlsoap.org/wsdl/"/> + </system> + <uri + name="http://schemas.xmlsoap.org/wsdl/soap/" + uri="data/xsd/soap.xsd"/> + <public + publicId="http://www.w3.org/1999/XSL/Transform" + uri="data/xsd/XSLSchema.xsd"> + <property + name="webURL" + value="http://schemas.xmlsoap.org/wsdl/"/> + </public> + <nextCatalog + id="nestedCatalog" + catalog="data/catalog1.xml"/> + </catalogContribution> + </extension> </pre> </documentation> </annotation>