138701 | Facet extension point documentation is incomplete

5 files changed, 121 insertions, 6 deletions

diff --git a/plugins/org.eclipse.wst.common.project.facet.core/schemas/defaultFacets.exsd b/plugins/org.eclipse.wst.common.project.facet.core/schemas/defaultFacets.exsd
index 7bd87b4..8e74c94 100644
--- a/plugins/org.eclipse.wst.common.project.facet.core/schemas/defaultFacets.exsd
+++ b/plugins/org.eclipse.wst.common.project.facet.core/schemas/defaultFacets.exsd
@@ -115,7 +115,29 @@
          <meta.section type="examples"/>
       </appInfo>
       <documentation>
-         
+         &lt;p&gt;The following example declares facet1 (version 1.3) and facet2 (version 5.0) as default facets for runtime component MyRuntimeComponent.&lt;/p&gt; 
+
+&lt;pre&gt;
+&lt;extension point=&quot;org.eclipse.wst.common.project.facet.core.defaultFacets&quot;&gt;
+  &lt;default-facets&gt;
+    &lt;runtime-component id=&quot;MyRuntimeComponent&quot;/&gt;
+    &lt;facet id=&quot;facet1&quot; version=&quot;1.3&quot;/&gt;
+    &lt;facet id=&quot;facet2&quot; version=&quot;5.0&quot;/&gt;
+  &lt;/validator&gt;
+&lt;/extension&gt;
+&lt;/pre&gt;
+
+&lt;p&gt;Multiple plugins can contribute to the set of the default facets for a given runtime component. If the following example is combined with the first one, there will be three default facets associated with MyRuntimeComponent.&lt;/p&gt;
+
+&lt;pre&gt;
+&lt;extension point=&quot;org.eclipse.wst.common.project.facet.core.defaultFacets&quot;&gt;
+  &lt;default-facets&gt;
+    &lt;runtime-component id=&quot;MyRuntimeComponent&quot;/&gt;
+    &lt;facet id=&quot;facet3&quot; version=&quot;1.2&quot;/&gt;
+  &lt;/validator&gt;
+&lt;/extension&gt;
+&lt;/pre&gt;
+
       </documentation>
    </annotation>
 
diff --git a/plugins/org.eclipse.wst.common.project.facet.core/schemas/facets.exsd b/plugins/org.eclipse.wst.common.project.facet.core/schemas/facets.exsd
index b42f571..07b3074 100644
--- a/plugins/org.eclipse.wst.common.project.facet.core/schemas/facets.exsd
+++ b/plugins/org.eclipse.wst.common.project.facet.core/schemas/facets.exsd
@@ -584,7 +584,62 @@
          <meta.section type="examples"/>
       </appInfo>
       <documentation>
-         
+         &lt;p&gt;The following example illustrates the various facilities exposed by this extension point. This example is taken from the &lt;i&gt;Building Project Facets&lt;/i&gt; tutorial.&lt;/p&gt;
+
+&lt;pre&gt;
+&lt;extension point=&quot;org.eclipse.wst.common.project.facet.core.facets&quot;&gt;
+
+  &lt;category id=&quot;formgen.category&quot;&gt;
+    &lt;label&gt;FormGen&lt;/label&gt;
+    &lt;description&gt;Enables generation of HTML forms based on XML definition files.&lt;/description&gt;
+  &lt;/category&gt;
+
+  &lt;project-facet id=&quot;formgen.core&quot;&gt;
+    &lt;label&gt;FormGen Core&lt;/label&gt;
+    &lt;description&gt;
+      Enables generation of HTML forms based on XML definition files.
+    &lt;/description&gt;
+    &lt;category&gt;formgen.category&lt;/category&gt;
+  &lt;/project-facet&gt;
+
+  &lt;project-facet-version facet=&quot;formgen.core&quot; version=&quot;1.0&quot;&gt;
+    &lt;constraint&gt;
+      &lt;requires facet=&quot;jst.web&quot; version=&quot;2.2,2.3,2.4&quot;/&gt;
+    &lt;/constraint&gt;
+    &lt;action type=&quot;INSTALL&quot; id=&quot;formgen.core.install&quot;&gt;
+      &lt;config-factory class=&quot;com.formgen.eclipse.FormGenCoreFacetInstallConfig$Factory&quot;/&gt;
+      &lt;delegate class=&quot;com.formgen.eclipse.FormGenCoreFacetInstallDelegate&quot;/&gt;
+    &lt;/action&gt;
+  &lt;/project-facet-version&gt;
+
+  &lt;project-facet id=&quot;formgen.ext&quot;&gt;
+    &lt;label&gt;FormGen Extensions&lt;/label&gt;
+    &lt;description&gt;
+      Enables additional FormGen widgets.
+    &lt;/description&gt;
+    &lt;category&gt;formgen.category&lt;/category&gt;
+  &lt;/project-facet&gt;
+
+  &lt;project-facet-version facet=&quot;formgen.ext&quot; version=&quot;1.0&quot;&gt;
+    &lt;constraint&gt;
+      &lt;requires facet=&quot;formgen.core&quot; version=&quot;1.0&quot;/&gt;
+    &lt;/constraint&gt;
+    &lt;action type=&quot;INSTALL&quot;&gt;
+      &lt;delegate class=&quot;com.formgen.eclipse.FormGenExtFacetInstallDelegate&quot;/&gt;
+    &lt;/action&gt;
+  &lt;/project-facet-version&gt;
+
+  &lt;preset id=&quot;formgen.preset&quot;&gt;
+    &lt;label&gt;FormGen Web Project&lt;/label&gt;
+    &lt;description&gt;Creates a web project with FormGen functionality.&lt;/description&gt;
+    &lt;facet id=&quot;jst.java&quot; version=&quot;5.0&quot;/&gt;
+    &lt;facet id=&quot;jst.web&quot; version=&quot;2.2&quot;/&gt;
+    &lt;facet id=&quot;formgen.core&quot; version=&quot;1.0&quot;/&gt;
+    &lt;facet id=&quot;formgen.ext&quot; version=&quot;1.0&quot;/&gt;
+  &lt;/preset&gt;
+  
+&lt;/extension&gt;
+&lt;/pre&gt;
       </documentation>
    </annotation>
 
diff --git a/plugins/org.eclipse.wst.common.project.facet.core/schemas/validators.exsd b/plugins/org.eclipse.wst.common.project.facet.core/schemas/validators.exsd
index 58ac541..00b1052 100644
--- a/plugins/org.eclipse.wst.common.project.facet.core/schemas/validators.exsd
+++ b/plugins/org.eclipse.wst.common.project.facet.core/schemas/validators.exsd
@@ -6,7 +6,7 @@
          <meta.schema plugin="org.eclipse.wst.common.project.facet.core" id="validators" name="Faceted Project Validators Extension Point"/>
       </appInfo>
       <documentation>
-         Used for declaring faceted project validators. 
+         Used for declaring faceted project validators.
       </documentation>
    </annotation>
 
@@ -86,7 +86,25 @@
          <meta.section type="examples"/>
       </appInfo>
       <documentation>
-         
+         &lt;p&gt;The following example declares a validator that applies to projects that have facet1 (version 1.3 or 2.5) and facet2 (any version) installed.&lt;/p&gt;
+
+&lt;pre&gt;
+&lt;extension point=&quot;org.eclipse.wst.common.project.facet.core.validators&quot;&gt;
+  &lt;validator class=&quot;com.mycorp.MyValidator1&quot;&gt;
+    &lt;facet id=&quot;facet1&quot; version=&quot;1.3,2.5&quot;/&gt;
+    &lt;facet id=&quot;facet2&quot;/&gt;
+  &lt;/validator&gt;
+&lt;/extension&gt;
+&lt;/pre&gt;
+
+&lt;p&gt;The second example declares a validator that applies to all faceted projects.&lt;/p&gt;
+
+&lt;pre&gt;
+&lt;extension point=&quot;org.eclipse.wst.common.project.facet.core.validators&quot;&gt;
+  &lt;validator class=&quot;com.mycorp.MyValidator2&quot;/&gt;
+&lt;/extension&gt;
+&lt;/pre&gt;
+
       </documentation>
    </annotation>
 
diff --git a/plugins/org.eclipse.wst.common.project.facet.ui/schemas/images.exsd b/plugins/org.eclipse.wst.common.project.facet.ui/schemas/images.exsd
index bb52d68..f0aadc4 100644
--- a/plugins/org.eclipse.wst.common.project.facet.ui/schemas/images.exsd
+++ b/plugins/org.eclipse.wst.common.project.facet.ui/schemas/images.exsd
@@ -94,7 +94,15 @@
          <meta.section type="examples"/>
       </appInfo>
       <documentation>
-         
+         &lt;p&gt;The following example associates images with two facets and a category.&lt;/p&gt;
+
+&lt;pre&gt;
+&lt;extension point=&quot;org.eclipse.wst.common.project.facet.ui.images&quot;&gt;
+  &lt;image facet=&quot;facet1&quot; path=&quot;icons/facet1.gif&quot;/&gt;
+  &lt;image facet=&quot;facet2&quot; path=&quot;icons/facet2.gif&quot;/&gt;
+  &lt;image category=&quot;category1&quot; path=&quot;icons/category1.gif&quot;/&gt;
+&lt;/extension&gt;
+&lt;/pre&gt;
       </documentation>
    </annotation>
 
diff --git a/plugins/org.eclipse.wst.common.project.facet.ui/schemas/wizard-pages.exsd b/plugins/org.eclipse.wst.common.project.facet.ui/schemas/wizard-pages.exsd
index a184393..b6ec9f8 100644
--- a/plugins/org.eclipse.wst.common.project.facet.ui/schemas/wizard-pages.exsd
+++ b/plugins/org.eclipse.wst.common.project.facet.ui/schemas/wizard-pages.exsd
@@ -96,7 +96,19 @@
          <meta.section type="examples"/>
       </appInfo>
       <documentation>
-         
+         &lt;p&gt;The following example associates wizard pages with install and uninstall actions of facet1.&lt;/p&gt;
+
+&lt;pre&gt;
+&lt;extension point=&quot;org.eclipse.wst.common.project.facet.ui.wizardPages&quot;&gt;
+  &lt;wizard-pages action=&quot;facet1.install&quot;&gt;
+    &lt;page class=&quot;com.mycorp.Facet1InstallPage1&quot;/&gt;
+    &lt;page class=&quot;com.mycorp.Facet1InstallPage2&quot;/&gt;
+  &lt;/wizard-pages&gt;
+  &lt;wizard-pages action=&quot;facet1.uninstall&quot;&gt;
+    &lt;page class=&quot;com.mycorp.Facet1UninstallPage&quot;/&gt;
+  &lt;/wizard-pages&gt;
+&lt;/extension&gt;
+&lt;/pre&gt;
       </documentation>
    </annotation>