Using the Template Diff Options
The Template Diff feature compares a Template being edited with another Template. It highlights the differences between the two. Users can then examine each difference and take the necessary actions.
This can be used to look at the changes between different versions of the same Template.
Consider a Template generated from a Reference Manual.
For a Template under Edition, five Temp Diff options are available under the Validate Template dropdown, as shown below.
In Template Diff, the current Template under Edition is on the Right side, and it compares against the selected Template on the Left side.
Generic Template refers to the Template generated from the relevant section of the Reference Manual, without any custom modifications done by the user.
The Right side remains the same for all the options. It is the current Template Under Edition.
The Template Diff options are explained in the table below:
S.no | Template Diff Options | Description |
|---|---|---|
1 | (BETA) Open Template Comparison View | This option highlights the differences between the user-selected version of the Template on the Left and the Template on the Right. The user has to select the Template to be used on the Left side. |
Quick Template Diff Options- The system automatically pre-defines the Left side. | ||
2 | (BETA) Compare with Regenerated Template | This quick option sets the Regenerated Template as the Left side and opens the Template Diff Comparison View. The (BETA) Regenerated Template will not retain custom changes to the Step Title. |
3 | (BETA) Compare with Template Regenerated with Attributes | This quick option sets the Regenerated Template with Attributes as the Left side and opens the Template Diff Comparison View. The (BETA) Regenerated Template with Attributes will retain custom changes to some Step Attributes, but not to the Step Title. |
4 | (BETA) Compare with Published Template | This quick option sets the Published Template as the Left side and opens the Template Diff Comparison View. |
5 | (BETA) Compare with Generic Template | This quick option sets the Generic Template as the Left side and opens the Template Diff Comparison View. |
The options are described in detail below:
(BETA) Open Template Comparison View highlights the differences between a Published Template on the Left and the Template under Edition on the Right.
In the below example, the Template under Edition has the following changes.
Step Title of Step 1 has been modified. The text Description has been added.
A Role Conditioned has been added to Step 2.
While the Template is under Edition, the option (BETA) Open Template Comparison View is selected.
The Information Panel appears empty until the Template is selected.
Selecting the Template on the left
The left-side Template can be selected using one of the following options:
Generate from a Reference Manual, or
Select from the Template library.
1. Generating from Reference manuals.
Select the Reference manuals option from the dropdown list.
 |
Click .
 |
A Template dialog box opens.
 |
Select a required manual from the dropdown list
 |
Click .
 |
Click to generate a Reference manual.
 |
This is now the left side Template generated from the Reference Manual.
 |
2. Select from the Template library
Select the Template option from dropdown list.
 |
Click .
 |
A Template dialog box opens.
 |
The Target Version is available when the Published Template is selected.
 |
The selected Template appears on the Left panel.
Note
By selecting any of the below options, the Template on the left side will be Regenerated.
The Template Diff feature uses the following attributes to perform the comparison.
Sno | Types of Attributes | Where is it in the UI? | Step/Template level | |
|---|---|---|---|---|
1 | Documentation Reference | Source OEM Manual
| Available at Step and Template level. | |
2 | Functional Types | Functional Types
| Available at Step and Template level. | |
3 | PTC | PTC
| Available at Step and Template level. | |
4 | Facets | Facets
| Available at Step and Template level. | |
5 | Graphics with comments | Step Documentations (graphics, text and images)
| Available at Step and Template level. | |
6 | Role conditioned | Role conditioned
| Available at Step and Template level. | |
7 | Job auto naming | Job auto naming
| Available only at Template level. | |
8 | Effectivity | Template Effectivity
| Available only at Template level. | |
9 | Signoff | Signoff flow
| Available only at Template level. |
By clicking , the Template Diff View with comparison is displayed.
By clicking , the difference in Step 1 with the Text is displayed.
 |
Check box Details: When you check the box the list of comparison details will be displayed.
Type to filter: The details can be filtered by using the search option.
Attributes dropdown: This dropdown contains all the Attributes that have different values in the compared Templates.
The user can check/uncheck the Attributes so that they can be shown/hidden in the list.
In the below example, the Role conditioned and Text are checked.
Details: When you click Details, the difference in the Step will be displayed.
Take Left: Refers to changes that can be moved to the Right.
Keep Right: This just ignores the difference.
The Step number and the Text Description which are added are shown below.
(BETA) Compare with Regenerated Template is used to compare the (BETA) Regenerated Template on the Left with the Template which is under edition on the Right.
While the Template is under Edition, the option (BETA) Compare with Regenerated Template is selected.
This option automatically sets the Left side as the Regenerated Template and performs the Template Diff Comparison.
The Regeneration Results are displayed.
The user can click to find the differences.
 |
The difference in the Step 2 Text is displayed as shown below.
(BETA) Compare with Template Regenerated with Attributes is used to compare the (BETA) Regenerated Template with Attributes on the Left and the Template which is under Edition on the Right.
While the Template is under Edition, the option (BETA) Compare with Template Regenerated with Attributes is selected.
This option automatically sets the Left side as the Regenerated Template with Attributes and performs the Template Diff Comparison.
The Regeneration Results are displayed.
The user can click to find the differences.
 |
The difference in the Step 4 text is displayed as shown below.
(BETA) Compare with Published Template is used to compare the differences between the latest version of the Published Templates and Template under Edition.
While the Template is under Edition, the option (BETA) Compare with Published Template is selected.
The difference in the Template under Edition is displayed.
(BETA) Compare with Generic Template is used to compare a generic version of the Template from a Manual with no modifications.
While the Template is under Edition, the option (BETA) Compare with Generic Template is selected.
The difference in Step 1 is displayed as shown below.
