[444714] Author help center documentation for Oomph Setup

https://bugs.eclipse.org/bugs/show_bug.cgi?id=444714

11 files changed, 310 insertions, 0 deletions

diff --git a/plugins/org.eclipse.oomph.targlets.doc/src/org/eclipse/oomph/targlets/doc/Legal.java b/plugins/org.eclipse.oomph.targlets.doc/src/org/eclipse/oomph/targlets/doc/Legal.java
new file mode 100644
index 000000000..9e76bf4d3
--- /dev/null
+++ b/plugins/org.eclipse.oomph.targlets.doc/src/org/eclipse/oomph/targlets/doc/Legal.java
@@ -0,0 +1,21 @@
+/*
+ * Copyright (c) 2014 Eike Stepper (Berlin, Germany) and others.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *    Eike Stepper - initial API and implementation
+ */
+package org.eclipse.oomph.targlets.doc;
+
+/**
+ * Legal
+ *
+ * @external about.html
+ * @number 666
+ */
+public class Legal
+{
+}
diff --git a/plugins/org.eclipse.oomph.targlets.doc/src/org/eclipse/oomph/targlets/doc/Overview.java b/plugins/org.eclipse.oomph.targlets.doc/src/org/eclipse/oomph/targlets/doc/Overview.java
new file mode 100644
index 000000000..f84435c09
--- /dev/null
+++ b/plugins/org.eclipse.oomph.targlets.doc/src/org/eclipse/oomph/targlets/doc/Overview.java
@@ -0,0 +1,26 @@
+/*
+ * Copyright (c) 2014 Eike Stepper (Berlin, Germany) and others.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *    Eike Stepper - initial API and implementation
+ */
+package org.eclipse.oomph.targlets.doc;
+
+/**
+ * Overview
+ * <p>
+ * Oomph Utilities provide support for installing Eclipse applications and for provisioning Eclipse workspaces.
+ * </p>
+ * <p>
+ * {@toc}
+ * </p>
+ *
+ * @default
+ */
+public class Overview
+{
+}
diff --git a/plugins/org.eclipse.oomph.targlets.doc/src/org/eclipse/oomph/targlets/doc/guide/ListeningToEvents.java b/plugins/org.eclipse.oomph.targlets.doc/src/org/eclipse/oomph/targlets/doc/guide/ListeningToEvents.java
new file mode 100644
index 000000000..2c56ebdfa
--- /dev/null
+++ b/plugins/org.eclipse.oomph.targlets.doc/src/org/eclipse/oomph/targlets/doc/guide/ListeningToEvents.java
@@ -0,0 +1,102 @@
+/*
+ * Copyright (c) 2014 Eike Stepper (Berlin, Germany) and others.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *    Eike Stepper - initial API and implementation
+ */
+package org.eclipse.oomph.targlets.doc.guide;
+
+import org.eclipse.oomph.targlets.core.ITargletContainer;
+import org.eclipse.oomph.targlets.core.ITargletContainerListener;
+import org.eclipse.oomph.targlets.core.TargletContainerEvent;
+import org.eclipse.oomph.targlets.core.TargletContainerEvent.IDChangedEvent;
+import org.eclipse.oomph.targlets.core.TargletContainerEvent.ProfileUpdateFailedEvent;
+import org.eclipse.oomph.targlets.core.TargletContainerEvent.ProfileUpdateSucceededEvent;
+import org.eclipse.oomph.targlets.core.TargletContainerEvent.TargletsChangedEvent;
+import org.eclipse.oomph.targlets.core.TargletContainerEvent.WorkspaceUpdateFinishedEvent;
+
+import org.eclipse.core.runtime.IProgressMonitor;
+
+/**
+ * Listening To Targlet Container Events
+ * <p>
+ * When the state of a {@link ITargletContainer targlet container} changes registered {@link ITargletContainerListener listeners} are sent one of the following {@link TargletContainerEvent events}:
+ * <p>
+ * <ul>
+ * <li> {@link IDChangedEvent}
+ * <li> {@link TargletsChangedEvent}
+ * <li> {@link ProfileUpdateSucceededEvent}
+ * <li> {@link ProfileUpdateFailedEvent}
+ * <li> {@link WorkspaceUpdateFinishedEvent}
+ * </ul>
+ * <p>
+ * Listeners can be registered programmatically or declaratively:
+ * <p>
+ * <ul>
+ * <li> The {@link org.eclipse.oomph.targlets.core.ITargletContainerListener.Registry listener registry} provides methods to add or remove listeners.
+ * <li> The <a href="../../schemadoc/org_eclipse_oomph_targlets_core_targletContainerListeners.html"><code>org.eclipse.oomph.targlets.core.targletContainerListeners</code></a> extension point accepts declarative listener contributions.
+ * </ul>
+ * <p>
+ * The following example shows a listener that prints information about all received events to the console:
+ * <p>
+ * {@link TargletContainerEventLogger}.
+ * <p>
+ *
+ * @number 200
+ * @author Eike Stepper
+ * @see UnderstandingTargletContainers
+ */
+public class ListeningToEvents
+{
+}
+
+/**
+ * @snippet
+ */
+class TargletContainerEventLogger implements ITargletContainerListener
+{
+  public TargletContainerEventLogger()
+  {
+  }
+
+  public void handleTargletContainerEvent(TargletContainerEvent event, IProgressMonitor monitor) throws Exception
+  {
+    ITargletContainer container = event.getSource();
+
+    if (event instanceof IDChangedEvent)
+    {
+      System.out.println("IDChangedEvent: " + container);
+      System.out.println("  oldID: " + ((IDChangedEvent)event).getOldID());
+    }
+    else if (event instanceof TargletsChangedEvent)
+    {
+      System.out.println("TargletsChangedEvent: " + container);
+    }
+    else if (event instanceof ProfileUpdateSucceededEvent)
+    {
+      System.out.println("ProfileUpdateSucceededEvent: " + container);
+      System.out.println("  metadataRepositories: " + ((ProfileUpdateSucceededEvent)event).getMetadataRepositories());
+      System.out.println("  workspaceIUInfos: " + ((ProfileUpdateSucceededEvent)event).getWorkspaceIUInfos());
+      System.out.println("  provisioningPlan: " + ((ProfileUpdateSucceededEvent)event).getProvisioningPlan());
+      System.out.println("  profile: " + ((ProfileUpdateSucceededEvent)event).getProfile());
+    }
+    else if (event instanceof ProfileUpdateFailedEvent)
+    {
+      System.out.println("ProfileUpdateFailedEvent: " + container);
+      System.out.println("  updateProblem: " + ((ProfileUpdateFailedEvent)event).getUpdateProblem());
+    }
+    else if (event instanceof WorkspaceUpdateFinishedEvent)
+    {
+      System.out.println("WorkspaceUpdateFinishedEvent: " + container);
+      System.out.println("  importResults: " + ((WorkspaceUpdateFinishedEvent)event).getImportResults());
+    }
+    else
+    {
+      System.out.println(event);
+    }
+  }
+}
diff --git a/plugins/org.eclipse.oomph.targlets.doc/src/org/eclipse/oomph/targlets/doc/guide/UnderstandingTargletContainers.java b/plugins/org.eclipse.oomph.targlets.doc/src/org/eclipse/oomph/targlets/doc/guide/UnderstandingTargletContainers.java
new file mode 100644
index 000000000..6d19dac4d
--- /dev/null
+++ b/plugins/org.eclipse.oomph.targlets.doc/src/org/eclipse/oomph/targlets/doc/guide/UnderstandingTargletContainers.java
@@ -0,0 +1,23 @@
+/*
+ * Copyright (c) 2014 Eike Stepper (Berlin, Germany) and others.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *    Eike Stepper - initial API and implementation
+ */
+package org.eclipse.oomph.targlets.doc.guide;
+
+/**
+ * Understanding Targlet Containers
+ * <p>
+ * Oomph Utilities provide support for installing Eclipse applications and for provisioning Eclipse workspaces.
+ *
+ * @number 100
+ * @author Eike Stepper
+ */
+public class UnderstandingTargletContainers
+{
+}
diff --git a/plugins/org.eclipse.oomph.targlets.doc/src/org/eclipse/oomph/targlets/doc/guide/package-info.java b/plugins/org.eclipse.oomph.targlets.doc/src/org/eclipse/oomph/targlets/doc/guide/package-info.java
new file mode 100644
index 000000000..48d66cdbc
--- /dev/null
+++ b/plugins/org.eclipse.oomph.targlets.doc/src/org/eclipse/oomph/targlets/doc/guide/package-info.java
@@ -0,0 +1,18 @@
+/*
+ * Copyright (c) 2014 Eike Stepper (Berlin, Germany) and others.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *    Eike Stepper - initial API and implementation
+ */
+
+/**
+ * Programmer's Guide
+ *
+ * @number 200
+ */
+package org.eclipse.oomph.targlets.doc.guide;
+
diff --git a/plugins/org.eclipse.oomph.targlets.doc/src/org/eclipse/oomph/targlets/doc/online/Homepage.java b/plugins/org.eclipse.oomph.targlets.doc/src/org/eclipse/oomph/targlets/doc/online/Homepage.java
new file mode 100644
index 000000000..1f7dafc9c
--- /dev/null
+++ b/plugins/org.eclipse.oomph.targlets.doc/src/org/eclipse/oomph/targlets/doc/online/Homepage.java
@@ -0,0 +1,21 @@
+/*
+ * Copyright (c) 2014 Eike Stepper (Berlin, Germany) and others.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *    Eike Stepper - initial API and implementation
+ */
+package org.eclipse.oomph.targlets.doc.online;
+
+/**
+ * Homepage
+ *
+ * @external http://www.eclipse.org/oomph
+ * @number 1
+ */
+public class Homepage
+{
+}
diff --git a/plugins/org.eclipse.oomph.targlets.doc/src/org/eclipse/oomph/targlets/doc/online/Wiki.java b/plugins/org.eclipse.oomph.targlets.doc/src/org/eclipse/oomph/targlets/doc/online/Wiki.java
new file mode 100644
index 000000000..f8df09ac1
--- /dev/null
+++ b/plugins/org.eclipse.oomph.targlets.doc/src/org/eclipse/oomph/targlets/doc/online/Wiki.java
@@ -0,0 +1,21 @@
+/*
+ * Copyright (c) 2014 Eike Stepper (Berlin, Germany) and others.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *    Eike Stepper - initial API and implementation
+ */
+package org.eclipse.oomph.targlets.doc.online;
+
+/**
+ * Wiki
+ *
+ * @external https://wiki.eclipse.org/Eclipse_Oomph_Installer
+ * @number 2
+ */
+public class Wiki
+{
+}
diff --git a/plugins/org.eclipse.oomph.targlets.doc/src/org/eclipse/oomph/targlets/doc/online/package-info.java b/plugins/org.eclipse.oomph.targlets.doc/src/org/eclipse/oomph/targlets/doc/online/package-info.java
new file mode 100644
index 000000000..827093cc5
--- /dev/null
+++ b/plugins/org.eclipse.oomph.targlets.doc/src/org/eclipse/oomph/targlets/doc/online/package-info.java
@@ -0,0 +1,18 @@
+/*
+ * Copyright (c) 2014 Eike Stepper (Berlin, Germany) and others.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *    Eike Stepper - initial API and implementation
+ */
+
+/**
+ * Online Docs
+ *
+ * @number 555
+ */
+package org.eclipse.oomph.targlets.doc.online;
+
diff --git a/plugins/org.eclipse.oomph.targlets.doc/src/org/eclipse/oomph/targlets/doc/reference/api/package-info.java b/plugins/org.eclipse.oomph.targlets.doc/src/org/eclipse/oomph/targlets/doc/reference/api/package-info.java
new file mode 100644
index 000000000..9b959d8b1
--- /dev/null
+++ b/plugins/org.eclipse.oomph.targlets.doc/src/org/eclipse/oomph/targlets/doc/reference/api/package-info.java
@@ -0,0 +1,21 @@
+/*
+ * Copyright (c) 2014 Eike Stepper (Berlin, Germany) and others.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *    Eike Stepper - initial API and implementation
+ */
+
+/**
+ * API Reference
+ *
+ * @number 1
+ */
+package org.eclipse.oomph.targlets.doc.reference.api;
+
+class Javadoc
+{
+}
diff --git a/plugins/org.eclipse.oomph.targlets.doc/src/org/eclipse/oomph/targlets/doc/reference/package-info.java b/plugins/org.eclipse.oomph.targlets.doc/src/org/eclipse/oomph/targlets/doc/reference/package-info.java
new file mode 100644
index 000000000..1f1444ac5
--- /dev/null
+++ b/plugins/org.eclipse.oomph.targlets.doc/src/org/eclipse/oomph/targlets/doc/reference/package-info.java
@@ -0,0 +1,18 @@
+/*
+ * Copyright (c) 2014 Eike Stepper (Berlin, Germany) and others.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *    Eike Stepper - initial API and implementation
+ */
+
+/**
+ * Reference
+ *
+ * @number 444
+ */
+package org.eclipse.oomph.targlets.doc.reference;
+
diff --git a/plugins/org.eclipse.oomph.targlets.doc/src/org/eclipse/oomph/targlets/doc/reference/schema/package-info.java b/plugins/org.eclipse.oomph.targlets.doc/src/org/eclipse/oomph/targlets/doc/reference/schema/package-info.java
new file mode 100644
index 000000000..fa87069f5
--- /dev/null
+++ b/plugins/org.eclipse.oomph.targlets.doc/src/org/eclipse/oomph/targlets/doc/reference/schema/package-info.java
@@ -0,0 +1,21 @@
+/*
+ * Copyright (c) 2014 Eike Stepper (Berlin, Germany) and others.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *    Eike Stepper - initial API and implementation
+ */
+
+/**
+ * Extension Point Reference
+ *
+ * @number 2
+ */
+package org.eclipse.oomph.targlets.doc.reference.schema;
+
+class Schemadoc
+{
+}