openProject( resource, interface )

[cubap]

Initialize or continue a project and open in the mentioned interface.

@params

resource ( String | Object )

Object or resolvable path to object on which the interface is based. One of:

• TPEN Project—config object with references to sc:Manifest and project settings.
• Manifest—sc:Manifest object to render in the interface. If no reference to an existing project is found, initialize a new one.
• Canvas—sc:Canvas object to render in the interface. Conceal any Manifest-level interactions in the interface.
• Image—any image-type acceptable to the interface specified. Create a sc:Canvas to initialize the interface and reference in saved annotations.
• Annotation—any specific oa:Annotation may be rendered in a viewing interface for read only access or individual manipulation.

In the future, it may be possible to pass in arrays of individual objects, though this may be relegated to some middleware.

interface ( String )

Optional keyword or URI for interface within which to open the referenced resource. Default is "transcription" within TPEN, but may also send out the response to an alternative interface. The only available interface planned within TPEN for now is transcription, but RERUM may provide for canvas annotation, text markup, simple manifest generation, etc.

@returns
Response sends the TPEN Project object to the interface.