DeltaXML DITA Compare .NET API DocumentationThe DitaMapTopicsetCompareDotNet type exposes the following members.
Back to Top
Back to Top
Back to Top
Back to Top
Constructors
| Name | Description | |
|---|---|---|
| DitaMapTopicsetCompareDotNet |
Constructs a new DitaMapTopicsetCompare instance.
|
Methods
| Name | Description | |
|---|---|---|
| compare |
Compare the DITA maps that are specified by the input files.
| |
| compareInPlace |
Compare the DITA maps that are specified by the input files.
| |
| getEntityResolver |
Get the previously set entity resolver.
| |
| setEntityResolver |
Set the entity resolver to use.
|
Properties
| Name | Description | |
|---|---|---|
| AddOutputclassAtts |
Specifies whether to include an outputclass attribute for marking changes.
| |
| AddRevisionAtts |
Specifies whether the result should use 'rev' attributes to mark change.
| |
| AddStatusAtts |
Specifies whether the result should use 'status' attributes to mark change.
| |
| CalsTableProcessing |
Specifies whether to apply CALS table processing.
| |
| EnableProgressEventHandling |
Controls whether raising of progress handling events is enabled.
| |
| ForceSpecialization |
Specifies whether or not to force result specialization when the input types are different.
| |
| FramemakerTcsTableChangeMode |
Specifies how changes in tables should be tracked.
| |
| Grouping |
Specifies whether adjacent changes (insertions or deletions) should be grouped into
a single insertion and/or deletion block.
| |
| HtmlTableProcessing |
Specifies whether to apply html table or DITA simpletable processing.
| |
| ImageCompare |
Specifies whether to enable or disable image comparison.
| |
| IncludeDeleted |
Specifies whether to include deleted content in the result.
| |
| IndentOutput |
Sets whether the result should be indented.
| |
| InvalidTableBehaviour |
In order to ensure that only valid CALS tables are passed to our specialized CALS table processing,
each input table is marked either valid or invalid.
| |
| MapBackupSuffix |
When the map comparison needs to backup a file before it can be compared it appends the '.
| |
| MapCleanTemp |
Specifies whether to clean temporary files introduced when performing the comparison.
| |
| MapContextHref |
When set to the non-empty string, this parameter provides a reference to a file that stores the map
context information.
| |
| MapCopyScope |
Specifies how to copy a DITA map and its content to an output directory, which maintains the relative
structure of the source where this is feasible.
| |
| MapPairRemainingMapName |
When the map-result-structure parameter is set to map-pair, the comparison result contains two
maps.
| |
| MapResultOrigin |
When comparing the topics referenced in two maps, one of the maps is declared to be the result origin.
| |
| MapResultStructure |
Specifies how the result map is constructed.
| |
| MapScanTopicsForReferences |
Specify whether topics should be scanned when identifying a map's referenced resources (referents).
| |
| MapUncomparedTopicMarkup |
What action to perform on topics that are not compared.
| |
| MathMLGranularity |
Specifies type of MathML processing.
| |
| MathMLProcessing |
Specifies whether to apply MathML processing.
| |
| ModifiedAttributeMode |
Specifies how modified attributes should be included in the output.
| |
| NewOutputclass |
Specifies the string value to use for the outputclass attribute of added content.
| |
| NewRevision |
Specifies the string value to use for the rev attribute of added content.
| |
| NewVersionAtts |
Specifies attributes to place on to added elements in the result.
| |
| OldOutputclass |
Specifies the string value to use for the outputclass attribute of deleted content.
| |
| OldRevision |
Specifies the string value to use for the rev attribute of deleted content.
| |
| OldVersionAtts |
Specifies attributes to place on deleted elements in the result.
| |
| OutputEncodingDeclaration |
Sets the character encoding output to use in the XML declaration.
| |
| OutputFormat |
Specifies what type of output is produced.
| |
| OxygenTcsDeletedSpaceMode |
Specifies how deleted spaces should be handled.
| |
| OxygenTcsVersion |
Specifies the version of oXygen editor used to display, accept and reject the tracked changes.
| |
| PhraseContainerExclusions |
Specifies any specializations where phrases have been removed from the content model.
| |
| PhraseElementName |
Specifies the element name to use in place of <ph> in the result.
| |
| PreservationMode |
Sets the mode to use for preserving original data.
| |
| RedistributionLicense |
Sets a redistribution license for use with subsequent compare operations.
| |
| RemoveRevAttributeRegex |
'rev' attributes in the input could be confused with those used to represent change
in the output.
| |
| ShowNonPhraseChanges |
Specifies how to textually mark changes to text where <ph> elements are not allowed.
| |
| StepsConflictResolution |
Specifies how to resolve conflicts between a task body's mutually exclusive steps and steps-unordered
elements.
| |
| StrictTaskModel |
Specifies whether inputs use the strict task model.
| |
| TopicPublicId |
Specifies the publicId to use for a Topic doctype.
| |
| TopicSystemId |
Specifies the systemId to use for a Topic doctype.
| |
| TrackedChangesAuthor |
Specifies the author name that is embedded into the generated insertion and deletion processing
instruction.
| |
| TrackedChangesDate |
Specifies the time-stamp that is embedded into the generated insertion and deletion processing
instruction.
| |
| UnmarkedChangeMode |
Specifies how to handle data that cannot contain difference markup.
| |
| UseIdsAsKeys |
Specifies whether to use id attribute value as keys in order to provide identity during comparison.
| |
| ValidateInputs |
Specifies whether to validate input documents.
| |
| WarningReportMode |
Sets the mode to use for reporting recoverable errors and warnings.
| |
| WhitespaceProcessingMode |
Specifies how to handle whitespace changes.
| |
| WordByWord |
Specifies whether to perform detailed text comparison or not.
| |
| XmetalTcsTableChangeMode |
Specifies how changes in tables should be tracked.
| |
| XmlVersionDeclaration |
Sets the version to use in the XML declaration.
|
Events
| Name | Description | |
|---|---|---|
| MapCopyCompleted |
Raised when the input map copy is completed.
| |
| MapCopyStarted |
Raised when the input map copy starts.
| |
| MapLevelOutputProcessingCompleted |
Raised when the updates to the final result map(s) have completed.
| |
| MapLevelOutputProcessingStarted |
Raised when the updates to the final result map(s) have started.
| |
| MapScanCompleted |
Raised when the scan for the topics referenced (directly or indirectly) from the input map has completed.
| |
| MapScanStarted |
Raised when the scan for the topics referenced (directly or indirectly) from the input map has started.
| |
| TopicAlignmentCompleted |
Raised when topic alignment process completed.
Provides alignment information on referenced topics, giving an indication of the number of comparisons to be performed - the size of the alignedTopics Dictionary. | |
| TopicAlignmentStarted |
Raised when topic alignment process started.
| |
| TopicCompareCompleted |
Raised when each topic comparison stage has been completed.
| |
| TopicCompareHeartbeat |
Report heartbeats when inside the compare stage. Progress on the 'Main comparator' stage is monitored by a heartbeat. This
callback event is best used to report when the comparator was last known to be alive.
| |
| TopicCompareStarted |
Raised when each topic comparison stage has been started.
| |
| TopicProcessingCompleted |
Raised when the processing of a topic has completed.
| |
| TopicProcessingFailed |
Raised when a failure happens during the processing of a topic.
| |
| TopicProcessingStarted |
Raised when the processing of a topic has started.
| |
| TopicStageCountComputed |
Raised before a topic compare to return the total number of topic comparison stages that are involved
|
See Also