Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "EPP/Obsolete/Wizard/Outgoing links"
(New page: The outgoing links are used to present the option to continue the configuration of features with third-party distribution providers. These Links appear on the last page of the wizard unde...) |
|||
| Line 1: | Line 1: | ||
The outgoing links are used to present the option to continue the configuration of features with third-party distribution providers. | The outgoing links are used to present the option to continue the configuration of features with third-party distribution providers. | ||
| + | == Configuration == | ||
These Links appear on the last page of the wizard under the download links. They are configured in a simple properties file in a folder configured in the [[../Configuration]]. | These Links appear on the last page of the wizard under the download links. They are configured in a simple properties file in a folder configured in the [[../Configuration]]. | ||
| − | For each provider there should be an icon in the folder mentioned above, that is referenced in the properties file. The properties file itself has the following form (c.f. http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.epp/plugins/org.eclipse.epp.wizard/data/outgoing/outgoing.properties?root=Technology_Project&view=markup) | + | For each provider there should be an icon in the folder mentioned above, that is referenced in the properties file. The icon size should be standardized across all service providers. 64x64 pixels would seem like a good fit, but this topic is still open for discussion. |
| + | |||
| + | The properties file itself has the following form (c.f. http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.epp/plugins/org.eclipse.epp.wizard/data/outgoing/outgoing.properties?root=Technology_Project&view=markup) | ||
extservprovider=External Services Provider | extservprovider=External Services Provider | ||
| Line 11: | Line 14: | ||
The first part of the keys should be identical for one provider, the first entry denotes the title, the description is a small text that appears with the title, the icon is the image file mentioned above. The url is the destination address for the link, and should contain the placeholder %s which will be replaced with a comma-separated list of currently selected features. This allows potential users to continue their installation configuration with a distribution provider based on their current selection. | The first part of the keys should be identical for one provider, the first entry denotes the title, the description is a small text that appears with the title, the icon is the image file mentioned above. The url is the destination address for the link, and should contain the placeholder %s which will be replaced with a comma-separated list of currently selected features. This allows potential users to continue their installation configuration with a distribution provider based on their current selection. | ||
| + | |||
| + | === Proposal for additional information to hand off === | ||
| + | |||
| + | Some service providers may want to consult the P2 repositories the EPP Wizard works with to acquire additional information on the selected features. This would mean handing over the URLs of the used metadata and feature repositories in the url part. This could be implemented by adding parameters like "metadata" and "artifacts" to the URL. These parameters should be urlencoded. | ||
| + | |||
| + | == Requirements/effort for external service providers == | ||
| + | |||
| + | The requirements for service providers for the EPP Wizard itself are basically the four lines for properties file mentioned in [[#Configuration]], plus an icon to display on the Wizard page. | ||
| + | |||
| + | The efforts for the service provider may vary a lot depending on the types of services provided. Basically, the page referenced by the URL should implement the service functionality, allowing the user to continue their task based on the choices made in the EPP Wizard. | ||
Revision as of 03:22, 6 August 2008
The outgoing links are used to present the option to continue the configuration of features with third-party distribution providers.
Configuration
These Links appear on the last page of the wizard under the download links. They are configured in a simple properties file in a folder configured in the EPP/Obsolete/Wizard/Configuration.
For each provider there should be an icon in the folder mentioned above, that is referenced in the properties file. The icon size should be standardized across all service providers. 64x64 pixels would seem like a good fit, but this topic is still open for discussion.
The properties file itself has the following form (c.f. http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.epp/plugins/org.eclipse.epp.wizard/data/outgoing/outgoing.properties?root=Technology_Project&view=markup)
extservprovider=External Services Provider extservprovider.description=Even more features and plugins! extservprovider.icon=external.png extservprovider.url=http://localhost/provider1/servlet?features=%s
The first part of the keys should be identical for one provider, the first entry denotes the title, the description is a small text that appears with the title, the icon is the image file mentioned above. The url is the destination address for the link, and should contain the placeholder %s which will be replaced with a comma-separated list of currently selected features. This allows potential users to continue their installation configuration with a distribution provider based on their current selection.
Proposal for additional information to hand off
Some service providers may want to consult the P2 repositories the EPP Wizard works with to acquire additional information on the selected features. This would mean handing over the URLs of the used metadata and feature repositories in the url part. This could be implemented by adding parameters like "metadata" and "artifacts" to the URL. These parameters should be urlencoded.
Requirements/effort for external service providers
The requirements for service providers for the EPP Wizard itself are basically the four lines for properties file mentioned in #Configuration, plus an icon to display on the Wizard page.
The efforts for the service provider may vary a lot depending on the types of services provided. Basically, the page referenced by the URL should implement the service functionality, allowing the user to continue their task based on the choices made in the EPP Wizard.