Quick Start

1. Load files

Sample DITA files are included with the app, to load these, press the 'Sample Merge' file button in the 'Files Panel', the button will be replaced by a vertical list of file buttons. A corresponding 'Version List' is shown horizonatally above the File List.

Note: To load your own DITA files, drag and drop them into the files panel, or press the Upload button to enter their URLs (if hosted on the cloud) - files not recognized as valid DITA files can not be processed and will be marked with a red 'diamond' symbol. The maximum number of files is limited to 6 due to restricted host resources.

2. Order and label files

Use the arrow keys in the 'Main Toolbar' (at the top of the app) to reorder the files according to their suffix: 'base', 'anna', 'ben', 'chris' and 'david', then type these suffixes in as labels in the editable Version List above. For merging, all files are compared to their common ancestor which must always be listed first, the sort order of the remainng files is not critical, but does affect the order in which changes are represented.

3. Merge files

Press the 'Merge' button in the Files Panel to start the document merge - after an interval of 30 seconds or so (due to resource constraints on the shared host), a new 'Working Merge' button is shown at the bottom of the file list and the collated document is shown.

4. Review changes

You're currently in the Files Panel tabbed page, indicated by the 'open folder' icon at the top of the panel. Press the 'Content' button (with a 'book' icon) to switch to the Content Changes panel or the 'Attributes' button (with a'label' icon) to switch to the Attributes Changes panel.

Select changes from the corresponding Change Lists or the Document View to select different changes and see them highlighted. You should see that the corresponding owners for each change are highlighted in the Versions List. You can highlight changes in the document for a specific version by selecting the version label.

5. Accept/Reject Changes

Press the Accept and Reject buttons in the Main Toolbar to switch between the corresponding review modes. Note that to make the mode stick for multiple selections, you need to press the mode button twice.

With the review mode set, selection of a change now alters its state according to the mode. Accepted changes are highlighted in green in the change buttons, whilst rejected changes are highlighted in red.

Changes with multiple options can not be rejected, i.e. one of the options must be accepted or no option accepted (a deferral). Such changes can be expanded in the Change List by pressing the corresponding Change Button or using the Right cursor key.

6. Store the 'Working Merge'

Now you have accepted and rejected a few changes, its time to store these decisions for sharing or for a later review session. To store this work, press the Files tab to open up the Files Panel, ensure the 'Working Merge' button is selected and then press the Store button located in the button cluster at the bottom of this panel.

As soon as the file has been stored, the Download button is highlighted, you can press this to download the document to your desktop, alternatively a unique URL is shown in the Status Panel (top right of the app) which can be used to retrieve the stored file for a limited period of time (normally a few days).

To continue working on a saved Review File, you can load it in the Files Panel by drag and drop or pressing the Upload button and entering the URL for the stored file.

7. Finalize document

Once all changes have been reviewed (and the Review File safely saved) you can finalize the document as a standard DITA file with all review/change tracking data removed. To do this, press the Finalize button, the finalized form of the document will replace the Review File. This can now be stored in the usual way using the Store/Download buttons.

The Files Panel

The Content Panel

The Attributes Panel