Problem Reporting

Identifier:

eu.geclipse.core.reporting.problemReporting

Since:

1.0

Description:

This extension point is used to define problems, solutions and their interconnections within the problem reporting mechanism. It is the base of the declarative part of the problem reporting.

Configuration Markup:

<!ELEMENT extension (problem* , solution*)>

<!ATTLIST extension

point CDATA #REQUIRED

id CDATA #IMPLIED

name CDATA #IMPLIED>

<!ELEMENT problem (reference*)>

<!ATTLIST problem

id CDATA #REQUIRED

description CDATA #REQUIRED

mailto CDATA #IMPLIED>

Definition of a problem within the problem reporting mechanism. This problem afterwards corresponds to an IProblem-implementation.

id - The unique ID of the problem. This should normally consist of the plug-in ID followed by the word problem, followed by the domain of the problem, followed by a name for the problem. An example would be eu.geclipse.core.problem.net.connectionFailed or eu.geclipse.core.problem.auth.authenticationFailed. This ID is also used in the reference tags of a solution for back-referencing problems.
description - A descriptive text that gives a short explanation of the problem.
mailto - An email-address that may be used to send the problem as a report to the developer team.

<!ATTLIST solution

id CDATA #REQUIRED

description CDATA #REQUIRED

solver CDATA #IMPLIED>

Definition of a solution within the problem reporting mechanism. This problem afterwards corresponds to an ISolution-implementation. If neither a solver nor a solving tag is present the solution will be passive and will only consist of a descriptive text. If both a solver and a solving tag are present the tag is ignored in favour of the solver.

id - The unique ID of the solution. This should normally consist of the plug-in ID followed by the word solution, followed by the domain of the solution, followed by a name for the solution. An example would be eu.geclipse.core.solution.net.checkProxySettings or eu.geclipse.core.solution.auth.checkCertificateLifetime. This ID is also used in the reference tags of a problem for referencing solutions.
description - A descriptive text that gives a short explanation of the solution. This text is both used for passive and active solutions to give the user hints how to solve a problem.
solver - An optional field that allows the specification of a ISolver in order to provide dedicated problem solving strategies. If a solver is specified any existing solving tag will be ignored.

<!ELEMENT reference EMPTY>

<!ATTLIST reference

referenceID CDATA #REQUIRED>

A reference element that may either be used to reference attached solutions from within a problem or to back-reference problems from within a solution. Therefore it is both possible to provide problems with dedicated solutions and to provide additional solutions for already existing problems, even for third-party plug-ins.

referenceID - The unique ID of either a problem (if the reference is used within a solution definition) or a solution (if the reference is used within a problem definition).

<!ELEMENT cheatsheetTag EMPTY>

<!ATTLIST cheatsheetTag

cheatsheetID CDATA #REQUIRED>

Tag denoting a cheatsheet page solution. This tag is used for a solution that should open a specific cheatsheet page.

cheatsheetID - The unique ID of a cheatsheet page that should be opened.

<!ELEMENT helpTag EMPTY>

<!ATTLIST helpTag

pagePath CDATA #REQUIRED>

Tag denoting a help page solution. This tag is used for a solution that should open a specific help page.

pagePath - The resource path of the help page that should be opened.

<!ELEMENT preferenceTag EMPTY>

<!ATTLIST preferenceTag

pageID CDATA #REQUIRED>

Tag denoting a preference page solution. This tag is used for a solution that should open a specific preference page.

pageID - The unique ID of a properties page that should be opened.

<!ELEMENT urlTag (url+)>

Tag denoting an URL solution. This tag is used for a solution that should open a specific web page in the web browser. Multiple URLs can be opened by using several 'url' sub-elements.

<!ELEMENT viewTag EMPTY>

<!ATTLIST viewTag

viewID CDATA #REQUIRED>

Tag denoting a view solution. This tag is used for a solution that should open a specific view.

viewID - The unique ID of a view that should be opened.

<!ELEMENT wizardTag EMPTY>

<!ATTLIST wizardTag

pageID CDATA #REQUIRED>

Tag denoting a wizard solution. This tag is used for a solution that should open a specific page of an already open wizard.

pageID - The unique ID of a wizard page that should be opened.

<!ELEMENT url EMPTY>

<!ATTLIST url

value CDATA #REQUIRED>

An element denoting a single webpage to open. Repeat it multiple times to open several URLs at once.

value - The URL to open.

Examples:


<extension point="eu.geclipse.core.reporting.problemReporting">
  <problem
    description="Failed to establish internet connection"
    id="eu.geclipse.problem.net.connectionFailed"
    mailto="bugreports@geclipse.eu">
    <reference
      referenceID="eu.geclipse.solution.net.checkInternetConnection">
    </reference>
    <reference
      referenceID="eu.geclipse.solution.net.checkProxySettings">
    </reference>
    <reference
      referenceID="eu.geclipse.solution.net.followGettingStarted">
    </reference>
    <reference
      referenceID="eu.geclipse.solution.net.openPrerequisitesHelp">
    </reference>
  </problem>
  <solution
    description="Check your internet connection"
    id="eu.geclipse.solution.net.checkInternetConnection">
  </solution>
  <solution
    description="Check your proxy settings"
    id="eu.geclipse.solution.net.checkProxySettings">
    <propertiesTag
      pageID="org.eclipse.ui.net.NetPreferences">
    </propertiesTag>
  </solution>
  <solution
    description="Follow the 'Getting started' tutorial"
    id="eu.geclipse.solution.net.followGettingStarted">
    <cheatsheetTag
      cheatsheetID="eu.geclipse.doc.user.gettingStarted">
    </cheatsheetTag>
  </solution>
  <solution
    description="Read the introductory help"
    id="eu.geclipse.solution.net.openPrerequisitesHelp">
    <helpTag
      pagePath="/eu.geclipse.doc.user/html/gettingstarted/prerequisites.html">
    </helpTag>
  </solution>
</extension>

Supplied Implementation:

There are a lot of core implementations within g-Eclipse that cover topics like network or security issues.

Copyright (c) 2006, 2007 g-Eclipse Consortium

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.

Initial development of the original code was made for the g-Eclipse project founded by European Union project number: FP6-IST-034327 http://www.geclipse.eu.