Revision history

Plans supporting for revision history

Professional
Business
Enterprise






Article revision

Article versions are essential for the continuous updating and revision of documentation by multiple contributors.

In Document360, when a Team account clicks the Edit button on a Published article, a new unpublished version of that article is created. The old version is added to the article’s version history but remains available on the Knowledge base site until the new version is published.

revision history

This article versioning option allows project admins, reviewers, and contributors to compare differences between versions and revert to a previous version at any time.

NOTE

Creating a new version of an article does not erase your content. Only a team account can manually delete older article versions.


Creating an article version in View history

There are two ways to create a new version of an article:

Method 1: From the Editor

To create a new article revision, follow the steps below:

  1. Open a published article in the Knowledge base portal.

  2. Click Edit in the top right of the editor.

    This action creates a new version and opens it as a draft in the text editor.

  3. Update the article content.

  4. Click Publish and click Yes in the confirmation prompt.

Method 2: Fork an older revision to create a new article version

To restore an old version of the article:

  1. Navigate to the desired article in the Knowledge base portal.

  2. Click the More () icon and select the Revision history ().

  3. Click Fork on the desired version listed in the history.

  4. Click Yes in the pop-up.

    This action will create a new version of the article with the content of the selected article version.

  5. To edit the new version, click Open on the latest version listed in the history.

  6. If required, update the article content.

  7. Click Publish and click Yes in the confirmation prompt.


Article revision actions

The below options are available in Article revision:

  1. Fork: To create a new article version from an existing article version. Here, the article is opened in the Editor mode, where you can make changes to the article content.

  2. Delete: To delete the article version. This action cannot be reversed.

NOTE

You cannot delete a published article version. You can only delete the unpublished article versions.

  1. Open: To open the article version in the Editor. This helps you restore any of the previous versions to their published state.

  2. Workflow history: View the article version's workflow history. This includes all the Workflow stages, Workflow assignees, comments, and dates.

  3. To make any previous version of an article public by opening that version in the editor and clicking Publish.

You can also see detailed information about each version, including the version number, contributor, created date, and version visibility.

revision history


Viewing differences between two versions of an article

You can open two versions of an article at any point in Article revision and compare them.

To compare two versions of an article:

  1. Go to the desired article in the Documentation editor.

  2. Click the More () icon and select the Revision history ().

  3. Select the checkbox for the desired versions you want to compare.

  4. Click the Compare button.

revision history

Content highlighting criteria:

The compared view of the two versions shows the below details:

Added content:

  • New content in the compared versions is highlighted in green for easy identification.

  • For images, videos, code blocks, PDFs,  and self-closing tags (<br>, <hr>), added content is highlighted with a green badge labeled 'Added.'

  • For changes made to tables, the content is highlighted in green.

  • Highlights remain visible while scrolling, ensuring added content is easy to spot throughout the article.

Removed content:

  • Deleted content is highlighted in red with a strikethrough.

  • For images, videos, code blocks, PDFs, and self-closing tags (<br>, <hr>), removed content is highlighted with a red badge labeled 'Removed.'

  • For changes made to tables, the removed content is highlighted in red.

  • Removed content remains visible in the comparison view for clarity and to ensure removed content is easy to spot across the entire article.

Formatting changes:

  • Changes in formatting (e.g., bold, italic, underline, font size, lists) are highlighted in blue.

  • Non-text formatting changes, like table styles or image resizing, are also highlighted in blue with a blue badge labeled ‘Modified.’

NOTE

Content block movements and multiple formatting changes will not be highlighted when comparing article versions. Multi-formatting changes refer to applying italic, bold, and underline formatting to the same content block.

Swap versions:

  • The Swap button is placed near the version dropdowns at the top for easy access.

  • This allows you to reverse the comparison order of two versions, instantly switching the comparisons of the old and new versions.

  • This helps you understand changes from both perspectives, such as seeing what was previously added as removed or vice versa.

  • The comparison view updates in real time without requiring a page reload, ensuring a seamless experience.

  • All existing highlights, filters, and settings are preserved, ensuring users retain their context while switching

  • After swapping, the version labels will update to reflect the new order, ensuring clarity on which version is being compared as the new and old.

NOTE

All highlights for added, removed, and formatting changes will be maintained after the swap. The system will update the highlights to reflect the new comparison.

For example, content previously marked as "added" will appear as "removed" after swap.

Exit version compare:

  • The Exit compare button is located at the top right which you can use to exit from the comparison window.

  • Clicking the button will take you back to the main document view without reloading the page.

  • You will return to the exact location of the article you were viewing before comparison mode to ensure workflow continuity.

Version comparison in API docs and Custom pages

There are four different ways to view the differences between versions:

  1. Code difference: To view both versions in Markdown syntax. The older version appears on the left, and the newer version appears on the right. Content removed will be represented with a red background, while content added is depicted with a green background.

  2. Rendered difference: To view both versions in preview mode. The older version appears on the left, and the newer version appears on the right. Content removed will be represented with a red background, while content added is depicted with a green background.

  3. Older version: To view the older version in both markdown syntax and preview mode.

  4. New version: To view the newer version in both markdown syntax and preview mode.


FAQs

Why are the updated timeframes of the forked article not in order?

If the older versions are opened and updated, the recently modified version will be shown with the updated timeframe accordingly.

Can I restore a previous revision of the article?

Yes, restoring a previous revision of an article is a straightforward process.

  • Open the Revision history, choose the recent revision or any of the older revisions and click on Open and Publish the article.
    (or)

  • Open the Revision history, choose the recent revision or any of the older revisions and click on Fork and Publish the article.

Article revisions are helpful when you or any other Team account has accidentally edited or published the article.

Why are the updated timeframes of the forked article not in order?

If the older versions are opened and updated, the recently modified version will be shown with the updated timeframe accordingly.

How do I discard the current changes and revert to the pervious version of the article?

Method 1:

  • If the changes have not been published, follow these steps to revert to the previous version:

    • Click on the Revision history of the article.

    • Open the previous version to view and restore the old content.

Note: This option works if the article has been published at least once.

Method 2:

  • If the article was never published, try the Backup & Restore option in the Settings page. This allows you to restore the content of a specific article.