Publisher Schema

A Publisher schema is available to simplify the process of publishing OSLC resources to a SECollab server.

The Publisher schema is defined as an MDWorkbench metamodel, on top of EMF (Eclipse Modeling Framework). As a developer, contributing a new publisher is mainly about creating model elements in a Publisher model that represents concepts of the authoring tool of interest.

Identifiers

As a publisher implementer, you are required to associate a GUID to resources being published. A GUID is an identifier unique in the scope of the published design. The GUID is used when publishing a new version of the same design, to determine the resources that were changed and the ones that are unmodified. Once assigned to a resource, a GUID must never change.

Titles

It is required to associate a title to each resource being published. There are cases where the authoring tool data is a large chunk of text, where it is a challenge to extract a relatively short title.

The XMLLiteralUtils.toSummary(String) is a convenient method to compute title based on a chunk of text.

RDF Names

Types and Properties defined both a title, a text displayed to the end user, and an name, which is the internal name used to store corresponding resources. The RDF name must use only letters, digit and the '_' character.

The XMLNameUtils.getValidName(String) is a convenient method to compute a valid RDF name based on a title.

HTML Values

Some property values set on resources may be expressed in HTML, for example to format fragments in bold or italic. SECollab interprets text values starting with "<html><body>" and ending with "</body></html>" as HTML values.

The XMLLiteralUtils.toXMLLiteral(String) is a convenient method to escape a text value as an XML literal that can be safely inserted in an HTML text.

Related tasks
Adding a Publisher