UI Integration

The FontoXML Document History App can be integrated into the user interface in various ways.

Integration in FontoXML Editor

By default, the FontoXML Document History App is integrated in the FontoXML Editor user interface. The button which navigates to the FontoXML Document History App can be configured like any other button in FontoXML Editor.

To add the Document History functionality to your Editor instance, enable the Document History add-on (fontoxml-document-history). If you want the buttons for placing comments on selections and elements in Document History to be enabled, you need to include fontoxml-document-history-annotations package. This package requires the fontoxml-annotations package to be present.

Launching directly

Document History

Optionally, the FontoXML Document History App can be launched directly without having to open the FontoXML Editor first. This is useful in the scenario where you want to be able to provide a read-only experience from your CMS.

Launching the FontoXML Document History App directly is very similar to launching the editor. The following URL must be constructed:

{EDITORBASEURL}?scope={SCOPE}#/editor/history?documentIds=["{DOCUMENTID}"]

Name

Description

EDITORBASEURL

The base URL of the editor.

SCOPE

The scope object which is normally passed to the editor. See the CMS integration guide for more information.

DOCUMENTID

The identifier of the document for which to show the history.

To start document history without any way of going back to the editor add the preventLeavingDocumentHistory scope parameter with its value set to true.

Document Compare

To launch the App in Document Compare mode to compare 2 revisions of arbitrary documents, use the following parameters in the scope:

Field

Type

Description

documentAId

string

Document ID for document A

documentBId

string

Document ID for document B

documentARevisionId

string

Revision ID for document A

documentBRevisionId

string

Revision ID for revision B