DitaCompareDotNet MembersDeltaXML DITA Compare .NET API Documentation
DeltaXML DITA Compare .NET API Documentation

The DitaCompareDotNet type exposes the following members.
Constructors

  NameDescription
Public methodDitaCompareDotNet
Constructs a new DitaCompare instance.
Back to Top
Methods

  NameDescription
Public methodcompareMapfile
Compares the XML in two DITA map files.
Public methodcompareMapTopicset
Compare the topics referenced by two DITA maps.
Public methodcompareMapTopicsetInPlace
Compare the topics referenced by two DITA maps.
Public methodcompareTopic
Compares the XML in two DITA topic files.
Public methodgetEntityResolver
Get the previously set entity resolver.
Public methodsetEntityResolver
Set the entity resolver to use.
Back to Top
Properties

  NameDescription
Public propertyAddOutputclassAtts
Specifies whether to include an outputclass attribute for marking changes.
Public propertyAddRevisionAtts
Specifies whether the result should use 'rev' attributes to mark change.
Public propertyAddStatusAtts
Specifies whether the result should use 'status' attributes to mark change.
Public propertyCalsTableProcessing
Specifies whether to apply CALS table processing.
Public propertyEnableProgressEventHandling
Controls whether raising of progress handling events is enabled.
Public propertyForceSpecialization
Specifies whether or not to force result specialization when the input types are different.
Public propertyFramemakerTcsTableChangeMode
Specifies how changes in tables should be tracked.
Public propertyGrouping
Specifies whether adjacent changes (insertions or deletions) should be grouped into a single insertion and/or deletion block.
Public propertyHtmlTableProcessing
Specifies whether to apply html table or DITA simpletable processing.
Public propertyImageCompare
Specifies whether to enable or disable image comparison.
Public propertyIncludeDeleted
Specifies whether to include deleted content in the result.
Public propertyIndentOutput
Sets whether the result should be indented.
Public propertyInvalidTableBehaviour
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.
Public propertyMapBackupSuffix
When the map comparison needs to backup a file before it can be compared it appends the '.
Public propertyMapCleanTemp
Specifies whether to clean temporary files introduced when performing the comparison.
Public propertyMapContextHref
When set to the non-empty string, this parameter provides a reference to a file that stores the map context information.
Public propertyMapCopyScope
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.
Public propertyMapPairRemainingMapName
When the map-result-structure parameter is set to map-pair, the comparison result contains two maps.
Public propertyMapPublicId
Specifies the publicId to use for a Map doctype.
Public propertyMapResultOrigin
When comparing the topics referenced in two maps, one of the maps is declared to be the result origin.
Public propertyMapResultStructure
Specifies how the result map is constructed.
Public propertyMapScanTopicsForReferences
Specify whether topics should be scanned when identifying a map's referenced resources (referents).
Public propertyMapSystemId
Specifies the systemId to use for a Map doctype.
Public propertyMapUncomparedTopicMarkup
What action to perform on topics that are not compared.
Public propertyMathMLGranularity
Specifies type of MathML processing.
Public propertyMathMLProcessing
Specifies whether to apply MathML processing.
Public propertyModifiedAttributeMode
Specifies how modified attributes should be included in the output.
Public propertyNewOutputclass
Specifies the string value to use for the outputclass attribute of added content.
Public propertyNewRevision
Specifies the string value to use for the rev attribute of added content.
Public propertyNewVersionAtts
Specifies attributes to place on to added elements in the result.
Public propertyOldOutputclass
Specifies the string value to use for the outputclass attribute of deleted content.
Public propertyOldRevision
Specifies the string value to use for the rev attribute of deleted content.
Public propertyOldVersionAtts
Specifies attributes to place on deleted elements in the result.
Public propertyOutputEncodingDeclaration
Sets the character encoding output to use in the XML declaration.
Public propertyOutputFormat
Specifies what type of output is produced.
Public propertyOxygenTcsDeletedSpaceMode
Specifies how deleted spaces should be handled.
Public propertyOxygenTcsVersion
Specifies the version of oXygen editor used to display, accept and reject the tracked changes.
Public propertyPhraseContainerExclusions
Specifies any specializations where phrases have been removed from the content model.
Public propertyPhraseElementName
Specifies the element name to use in place of <ph> in the result.
Public propertyPreservationMode
Sets the mode to use for preserving original data.
Public propertyRedistributionLicense
Sets a redistribution license for use with subsequent compare operations.
Public propertyRemoveRevAttributeRegex
'rev' attributes in the input could be confused with those used to represent change in the output.
Public propertyShowNonPhraseChanges
Specifies how to textually mark changes to text where <ph> elements are not allowed.
Public propertyStepsConflictResolution
Specifies how to resolve conflicts between a task body's mutually exclusive steps and steps-unordered elements.
Public propertyStrictTaskModel
Specifies whether inputs use the strict task model.
Public propertyTopicPublicId
Specifies the publicId to use for a Topic doctype.
Public propertyTopicSystemId
Specifies the systemId to use for a Topic doctype.
Public propertyTrackedChangesAuthor
Specifies the author name that is embedded into the generated insertion and deletion processing instruction.
Public propertyTrackedChangesDate
Specifies the time-stamp that is embedded into the generated insertion and deletion processing instruction.
Public propertyUnmarkedChangeMode
Specifies how to handle data that cannot contain difference markup.
Public propertyUseIdsAsKeys
Specifies whether to use id attribute value as keys in order to provide identity during comparison.
Public propertyValidateInputs
Specifies whether to validate input documents.
Public propertyWarningReportMode
Sets the mode to use for reporting recoverable errors and warnings.
Public propertyWhitespaceProcessingMode
Specifies how to handle whitespace changes.
Public propertyWordByWord
Specifies whether to perform detailed text comparison or not.
Public propertyXmetalTcsTableChangeMode
Specifies how changes in tables should be tracked.
Public propertyXmlVersionDeclaration
Sets the version to use in the XML declaration.
Back to Top
Events

  NameDescription
Public eventMC_MapCopyCompleted
Map comparator event raised when the input map copy is completed.
Public eventMC_MapCopyStarted
Map comparator event raised when the input map copy starts.
Public eventMC_MapLevelOutputProcessingCompleted
Map comparator event raised when the updates to the final result map(s) have completed.
Public eventMC_MapLevelOutputProcessingStarted
Map comparator event raised when the updates to the final result map(s) have started.
Public eventMC_MapScanCompleted
Map comparator event raised when the scan for the topics referenced (directly or indirectly) from the input map has completed.
Public eventMC_MapScanStarted
Map comparator event raised when the scan for the topics referenced (directly or indirectly) from the input map has started.
Public eventMC_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.

Public eventMC_TopicAlignmentStarted
Map comparator event raised when topic alignment process started.
Public eventMC_TopicCompareCompleted
Map comparator event raised when each topic comparison stage has been completed.
Public eventMC_TopicCompareHeartbeat
Map comparator heartbeat event raised 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.

  1. Will be called at most once a second.
  2. Not receiving this event should not be interpreted as the comparison stopping or being broken, but usually a sign that the comparison is busy processing.
  3. This runs on the same thread as the comparison, so the code you add here will increase the comparison time.

Public eventMC_TopicCompareStarted
Map comparator event raised when each topic comparison stage has been started.
Public eventMC_TopicProcessingCompleted
Map comparator event raised when the processing of a topic has completed.
Public eventMC_TopicProcessingFailed
Map comparator event raised when a failure happens during the processing of a topic.
Public eventMC_TopicProcessingStarted
Map comparator event raised when the processing of a topic has started.
Public eventMC_TopicStageCountComputed
Map comparator event raised before a topic compare to return the total number of topic comparison stages that are involved
Public eventTC_Completed
Topic comparator event raised when each stage completes.
Public eventTC_Heartbeat
Topic comparator heartbeat event raised when inside the compare stage. Progress on the 'Main comparator' stage is monitored by a heartbeat. This event is best used to report when the comparator was last known to be alive.

Notes:

  1. Will be called at most once a second.
  2. Not receiving this event should not be interpreted as the comparison stopping or being broken, but usually a sign that the comparison is busy processing.
  3. This runs on the same thread as the comparison, so the code you add here will increase the comparison time.

Public eventTC_StageCountComputed
Topic comparator event raised on computing the total for the number of stages required for the comparison.
Public eventTC_Started
Topic comparator event raised when each stage starts.
Back to Top
See Also