VideosCompare and Merge Directories Against a Common Base in Oxygen XML Editor 19

Overview

This video presents Compare Directories Against a Base feature available in Oxygen XML suite of products. The feature helps you identify and merge changes between multiple modifications of the same directory structure.

Transcript

00:00:07oXygen allows you to perform three-way comparisons on directories to help you identify and merge
00:00:12changes between multiple modifications of the same directory structure.
00:00:17This is especially helpful for teams that have multiple authors contributing documents
00:00:22to the same directory system.
00:00:24It offers information about conflicts and changes, and includes actions to easily merge,
00:00:30accept, overwrite, or ignore changes.
00:00:33For this video demonstration let's suppose that we have a DITA project, called "Flowers".
00:00:38We want to send this project to a SME named Bob, and we will both be editing files in
00:00:45this project at the same time.
00:00:47At some point we will want to compare and merge our changes and so we'll need to compare
00:00:53both our local changes and Bob's changes with the original base file set, because we want
00:01:00to keep track of what has been modified in the project from the moment we sent it to Bob.
00:01:06First I am going to export the Dita map files using the "Export DITA Map " action from the
00:01:12contextual menu of the DITA Maps Manager.
00:01:14I choose to pack the whole project into a zip archive named "flowers-base".
00:01:23Then I will send the exported project to Bob.
00:01:26From now on, both I and Bob will continue to work on the two file sets.
00:01:34After a while I get the project back from Bob and I want to integrate his changes.
00:01:39Remember, I also made same changes in the project and I don't want to lose them.
00:01:44So I need to find a way to integrate both our versions of the project into the main file set.
00:01:50To do this, I will use the "Compare Directories Against a Base" action from the Tools menu.
00:01:56In the dialog box I need to specify 3 directories:
00:02:00- Base directory - This was the original file set that I sent to Bob
00:02:06- Directory with your changes - I'll select the directory that contains my version of the project
00:02:14- Directory with the changes made by others
00:02:17I'll select the directory of the project that Bob sent me after his modifications.
00:02:22Now I click the Compare action.
00:02:25A new dialog box is presented showing the project's files.
00:02:29However, to make it easier for you to identify the modifications, the top section contains:
00:02:35- a summary of all modifications made in the project
00:02:39- a set of actions that allow you to filter the project files in order to show all files,
00:02:45only certain types of modifications, or just the conflicts.
00:02:49By default, the dialog box displays all modifications performed by you and by others:
00:02:56- solid arrows indicate changes, while arrows with the plus sign indicate newly added files
00:03:02- opposing arrows indicate files that contain modifications performed by you and by others
00:03:08As you probably noticed, the color of these icons is an important visual aid:
00:03:14- blue arrows indicate modifications made by others
00:03:17- gray arrows indicate modifications made by you
00:03:20- blue and gray indicate files that contain modifications made by you and by others.
00:03:26However, these modifications are performed on different sections of the document, so
00:03:32they do not conflict.
00:03:34Note that these modiffications can be automatically merged by oXygen.
00:03:37- red opposing arrows indicate a conflict, which means that the same section of content
00:03:42was modified both by you and by others.
00:03:45For these files, you need to select a merge action.
00:03:48Depending on the type of modification, oXygen automatically proposes a possible "Merge action" for each file.
00:03:55The only exceptions are the conflicting states, which require manual selection of the merge action.
00:04:01However, you can change the automatically selected action by choosing from a list of proposals.
00:04:07This list is available either by clicking any cell in the Merge action column ... or
00:04:13by invoking the context menu and choosing another merge action.
00:04:20In our case, we see Bob's modifications:
00:04:23- there is a conflict in the "introduction.dita" file.
00:04:28I changed the title to "Gardening tips", while Bob changed it to "Gardening for beginners".
00:04:33I like Bob's variant better, so I choose "Overwrite your changes".
00:04:39- the "flowers.ditamap" file is modified both by me and Bob (I added the narcissus topic
00:04:46reference while Bob added the roses topic reference)
00:04:50In this case, we leave the merge action set to "Automatically merge".
00:04:55This means that Bob's changes will automatically be merged with my changes.
00:05:00- there is also a modification on the "winterFlowers.dita" topic...
00:05:05The highlighted area indicates that Bob removed a text comment.
00:05:09I'm going to double-click the modification to see it in word-level detail...
00:05:15- We can also see that there are two new files added by Bob:
00:05:19the roses topic and image, and... two new files added by me: narcissus topic and image.
00:05:27Note that all columns are sortable to allow you to group the changes as you like.
00:05:35Next, to apply the merge actions we previously set, I click the "Apply" button.
00:05:41Now all modifications that Bob made are merged in my local project, and it also contains
00:05:47my local changes.
00:05:49Next, let's inspect the Ditamap to see how it looks.
00:05:53For example, notice the "Roses.dita" topic that Bob added in the project.
00:05:59And this concludes our demonstration.
00:06:00Thanks for watching.