Reference:BlueSpiceVisualDiff

Extension: BlueSpiceVisualDiff

 

Summary

The package VisualDiff for BlueSpice enables users to easily compare two versions of an article with just a few clicks.

At a glance: Advantages

• Simpler comparison of articles, especially in tables
• No distracting tags, code, or acronyms: pure content!
• Users can switch between various views, depending on their interests or needs

Where do I find VisualDiff?

VisualDiff is integrated in the history page of every article. Users with reading rights for the corresponding article can access the version comparison tool by clicking on the "History" link on the upper right corner of the screen.

How do I use VisualDiff? (Step-by-step)

Step 1: Open the version history of the article by clicking on the "History" link in the upper right corner.

Screenshot: Where to find the History links Step 2: Choose the two versions of the article you want to compare. Screenshot: Choose the versions you want to compare. Step 3: Click on "Compare selected revisions". Screenshot: Click on "Compare selected revisions".

Features of VisualDiff

Choose a view

VisualDiff highlights the changes between the two chosen versions in three different views:

1) Visual

In the visual view, the article will be displayed like in the reading mode of the wiki. The changes between the versions are color coded, making it easy to find and compare changes, especially in large tables.

Screenshot: Visual view

2) WikiText

In this view, the changes between the versions are shown in Wikicode, but without tabular form and the lineup of the changes (see Classic view). The view corresponds to the editing mode of an article. Changes are also color coded.

Screenshot: WikiText view

3) Classic

The common view of the changes in MediaWiki style. The changes are listed and compared in a tabular form, and organized and sorted by lines. VisualDiff aids this comparison by color coding as well.

Note: You can switch between the views by clicking on the corresponding tab with your mouse.

Screenshot: Classic view

Color coding

A change can be “added”, “deleted”, “changed”, or “conflict” content. Due to the nature of wiki articles, “changed” and “conflict” will be very rare. “Changed” will be shown e.g. if a word was linked subsequently. All other changes (although being “changed” as well) are shown as “added” or “deleted”.

Color code for text changes:

• Light blue: additions to the text
• Orange and crossed-out: deletions from the text
• Blue dashed lines: Changes in the structure of the article. This is usually the case when a word has been linked subsequently, or a header has been changed.

Color code for image changes:

• Light blue frame: added picture, or the current format of a changed image
• Red frame: deleted picture, or the former format of a changed image

Screenshot: Various examples of the color code with VisualDiff

Administration

How can I adapt VisualDiff?

VisualDiff works as is, so no further adaptations are necessary.
Administrators can change the Html diff engine url in the admin settings of the wiki.

Which rights are needed to use VisualDiff?

To use VisualDiff, the user needs to have reading rights for the respective namespace.

Technical background

Overview
Description:	Formatted display of differences between two revisions.
State:	stable	Dependency:	BlueSpice
Developer:	HalloWelt	License:	GPL-3.0-onlyProperty "BSExtensionInfoLicense" (as page type) with input value "</br>GPL-3.0-only" contains invalid characters or is incomplete and therefore can cause unexpected results during a query or annotation process.
Type:	BlueSpice	Category:	Quality Assurance
Edition:	BlueSpice pro, BlueSpice Farm, BlueSpice Cloud
View help page

Features

VisualDiff enables users to easily compare two versions of a wiki page.

There are three diff views:

1. Visual: The differences are shown in the flow text. Changes are highlighted in color.

2. WikiText: The output is shown in WikiCode in an integrated view. Changes are highlighted in color.

3. Classic: The output is in WikiCode. Old and new text face each other in two columns.

• You can switch between the views via tabs.
• The Java command-line tool DaisyDiff creates a unified diff from two revisions rendered in HTML. This is displayed on a SpecialPage.
• Additional information is displayed, e.g., the compared revisions.
• A navigation to the previous difference is displayed. The behavior is similar to that of MediaWiki.
• You can jump from one change to the next via flyout.

The extension VisualDiff is based on the HTML-Diff tool DaisyDiff and shall give a quick and visually appealing overview of the changes in revisions of a wiki article. The changes are displayed in a so called Unified-Diff and therefore in a document and not like usual in two columns. The normal link to the diff view of MediaWiki is overwritten by a link to a special page. The article revision (oldid) works as a basis for the comparison. This also defines the changes like "added" and "deleted".

The BlueSpice extension VisualDiff is part of BlueSpice pro. It can also be purchased as a single extension in the BlueSpice Shop.

Technical Information

This information applies to BlueSpice 3 . Technical details for BlueSpice cloud can differ in some cases.

Requirements

• MediaWiki: 1.31

• BlueSpiceFoundation: 3.2

Integrates into

Special pages

Configuration

Name	Value
VisualDiffHtmlDiffEngineUrl	'http://localhost:8080/BShtmlDiff'

User options

Name	Value
diffonly	0