orion.page.link

The link service provides a mechanism for plugins to add links that should appear in the main header of Orion pages. Clients supply the link name and URL. The header code will look for implementers of this service when generating page headers for Orion.

Service methods

None. This service is purely declarative.

Service attributes

Implementations of orion.page.link must define the following attributes:

name
A human readable link name, typically used as an HTML anchor element body, or in a tooltip.
id
A symbolic id for referencing this link.
uriTemplate
A URI Template that defines the link. This template may use the standard Orion URI template variables.

Examples

The following snippet defines the some of the main links that are shown in a default Orion installation.

   var serviceImpl = {};//no service methods required
   provider.registerServiceProvider("orion.page.link", serviceImpl, {
      name: "Navigator",
      id: "orion.navigator",
      uriTemplate: "{OrionHome}/navigate/table.html#"
   });
   provider.registerServiceProvider("orion.page.link", serviceImpl, {
      name: "Sites",
      id: "orion.sites",
      uriTemplate: "{OrionHome}/sites/sites.html"
   });
   provider.registerServiceProvider("orion.page.link", serviceImpl, {
      name: "Repositories",
      id: "orion.repositories",
      uriTemplate: "{OrionHome}/git/git-repository.html#"
   });