DOCX Compare using Ruby

Compare Word documents for differences in content and formatting

Try for FREE

DOCX Compare features

The DOCX Compare Ruby SDK allows for comparing two Word document versions to identify differences using revision marks.

It offers various customization options including the ability to specify comparison granularity at the word or character level, whether to compare formatting, case changes, whitespace, tables, headers and footers, footnotes and endnotes, textboxes, fields, comments, document moves, and whether to accept revisions before comparison.

This is useful for efficiently managing document revisions in collaborative environments such as legal, academic, and corporate settings.

ConvertAPI Ruby library install

ConvertAPI provides a Ruby Gem that allows you to perform a DOCX Compare conversion with just a few lines of code. First, install the ConvertAPI Ruby SDK:

Add this line to your application's Gemfile:
gem 'convert_api'

Authenticate your Ruby library

You can obtain your secret key by signing up for a free account. Once you sign up, you'll receive 250 free conversions instantly! Grab your authentication secret from the account dashboard, and authenticate the ConvertAPI Ruby library like this:

# get your secret key here:
ConvertApi.configure do |config|
   config.api_secret = 'your-api-secret'

DOCX Compare using Ruby in no time!

Once you have your authentication in place, simply copy-paste this docx to compare conversion code snippet into your Ruby project:

// Code snippet is using the ConvertAPI JavaScript Client:

// Code snippet is using the ConvertAPI Node.js Client:

// Code snippet is using the ConvertAPI PHP Client:

// Code snippet is using the ConvertAPI Java Client:

// Code snippet is using the ConvertAPI C# Client:

# Code snippet is using the ConvertAPI Ruby Client:

# Code snippet is using the ConvertAPI Python Client:

// Code snippet is using the ConvertAPI Go Client:

REM Code snippet is using the command line utility program:

<!-- For conversions with the multiple file result please refer to this example: -->

Try the conversion online - no coding required!

You can try out advanced conversion parameters and test the conversion result online using our interactive demo tool. This tool will produce the same conversion output as if you were using the library from your solution, and it will auto-generate the code snippet for you!

Try for FREE!

Conversion parameters

Password String

Sets the password to open protected documents.

CompareLevel Collection

The property defines the granularity of comparisons between documents or text segments. It determines the precision of the comparison process, allowing users to specify whether differences are identified based on larger text blocks, such as words or sentences, or at a more detailed level, such as characters or formatting.

Values:   Word Character

CompareFormatting Bool

Determines whether to indicate variations in formatting between the two documents.

CompareCaseChanges Bool

Determines whether to highlight discrepancies in capitalization between the two documents.

CompareWhitespace Bool

Determines whether to identify dissimilarities in whitespace, such as gaps or paragraphs, between the two documents.

CompareTables Bool

Determines whether to evaluate variations in the information presented within tables between the two documents.

CompareHeaders Bool

Determines whether to contrast divergences in headers and footers between the two documents.

CompareFootnotes Bool

Determines whether to compare differences in footnotes and endnotes between the two documents.

CompareTextboxes Bool

Determines whether to assess differences in the information presented within text boxes between the two documents.

CompareFields Bool

Determines whether to detect disparities in fields between the two documents.

CompareComments Bool

Determines whether to evaluate distinctions in comments between the two documents.

CompareMoves Bool

Indicates the name of the individual to credit for modifications when comparing the two documents.

AcceptRevisions Bool

Specifies whether to accept revisions before document comparison.

RevisionAuthor String

Author name who made revision.

Try DOCX Compare for free!