Skip to content

Commit d9ea7f2

Browse files
committed
Updated readme with infos regarding the feature to show only changed lines.
1 parent 0662b7f commit d9ea7f2

File tree

4 files changed

+16
-4
lines changed

4 files changed

+16
-4
lines changed

README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
- [Details about the new "History" tab](#details-about-the-new-history-tab)
1010
- [Basic functionality](#basic-functionality)
1111
- [Filters](#filters)
12+
- [Showing only unchanged lines](#showing-only-unchanged-lines)
1213
- [On-premise installation (Azure DevOps Server)](#on-premise-installation-azure-devops-server)
1314
- [Uploading the extension to Azure DevOps Server](#uploading-the-extension-to-azure-devops-server)
1415
- [Enabling/configuring the history tab for work item types](#enablingconfiguring-the-history-tab-for-work-item-types)
@@ -24,7 +25,7 @@
2425

2526
The standard history tab of work items in Azure DevOps (ADO) shows only the entire old and new values of each field, without highlighting the actual changes within it.
2627
This makes spotting the difference very hard for fields that usually contain a lot of text; most prominently, the standard "Description" and "Repro Steps" fields as well as the comments.
27-
This extension adds a **new tab** to work items that shows the full history of every field, while computing an **appropriate diff** for each one. Optionally, the user can filter out uninteresting fields (e.g. related to work logging).
28+
This extension adds a **new tab** to work items that shows the full history of every field, while computing an **appropriate diff** for each one. Optionally, the user can filter out uninteresting fields (e.g. related to work logging) and show only the changed lines in long texts.
2829

2930

3031
**If you like the extension, please give it a [star on GitHub](https://github.com/Sedeniono/ADO-History-Diff) and rate on the [Visual Studio marketplace](https://marketplace.visualstudio.com/items?itemName=Sedenion.HistoryDiff)!**
@@ -86,7 +87,7 @@ The extension is aware of the dark mode theme and uses appropriate colors.
8687
Note: Changing the theme in Azure DevOps (light to dark or vice versa) might not immediately change all colors. The page should be reloaded after changing the theme.
8788

8889
## Filters
89-
Using the "Filters" button in the top right corner of the history tab, users can filter out fields that are uninteresting to them, such as work logging related fields or fields used by scripts for housekeeping purposes.
90+
Using the "settings" button in the top right corner of the history tab, users can filter out fields that are uninteresting to them, such as work logging related fields or fields used by scripts for housekeeping purposes.
9091
The field names as shown in the history are matched completely by default and case-insensitively.
9192
Note that a `*` wildcard can be used to match any number of arbitrary characters.
9293
For example, `description`, `Desc*`, `*SCRIPT*` and `*tion` will all match e.g. the field `Description`.
@@ -97,6 +98,18 @@ The configuration dialog also allows to disable all configured filters without d
9798
All settings are stored per user on the server using [ADO's data storage facilities](https://learn.microsoft.com/en-us/azure/devops/extend/develop/data-storage).
9899

99100

101+
## Showing only unchanged lines
102+
The left button in the top right corner allows to toggle between showing all lines, or only the changed ones.
103+
If you choose to show only changed lines, `N >= 0` additional lines above and below each change is displayed.
104+
The value of `N` can be configured in the settings (right button in the top right corner).
105+
A value of `N=0` means that just the lines containing the changes are shown.
106+
Note that for values `N>0`, the extension merges consecutive "context sections".
107+
They are merged also if the distance between the sections would be less than approximately 1 line.
108+
109+
All settings are stored per user on the server using [ADO's data storage facilities](https://learn.microsoft.com/en-us/azure/devops/extend/develop/data-storage).
110+
111+
112+
100113
# On-premise installation (Azure DevOps Server)
101114

102115
## Uploading the extension to Azure DevOps Server
@@ -276,6 +289,5 @@ Apart from the import/export steps, the steps of modifying the actual XML file s
276289
* Once [markdown is available in Azure DevOps work items](https://developercommunity.visualstudio.com/t/add-markdown-support-in-discussions/365826), support it.
277290
* Support GitHub and remote work item links.
278291
* Support test cases (`Microsoft.VSTS.TCM.Steps`, `Microsoft.VSTS.TCM.LocalDataSource`, `Microsoft.VSTS.TCM.Parameters`).
279-
* Show only the context of a change in longer descriptions (optionally).
280292
* Localization of hardcoded strings.
281293

images/HistoryComparison.png

49.2 KB
Loading

images/HistoryComparison.xcf

40.9 KB
Binary file not shown.

overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
The standard history tab of work items in Azure DevOps shows only the entire old and new values of each field, without highlighting the actual changes within it.
44
This makes spotting the difference very hard for fields that usually contain a lot of text; most prominently, the standard "Description" and "Repro Steps" fields as well as the comments.
5-
This extension adds a **new tab** to work items that shows the full history of every field, while computing an **appropriate diff** for each one. Optionally, the user can filter out uninteresting fields (e.g. related to work logging).
5+
This extension adds a **new tab** to work items that shows the full history of every field, while computing an **appropriate diff** for each one. Optionally, the user can filter out uninteresting fields (e.g. related to work logging) and show only the changed lines in long texts.
66

77
**If you like the extension, please give it a [star on GitHub](https://github.com/Sedeniono/ADO-History-Diff) and rate on the [Visual Studio marketplace](https://marketplace.visualstudio.com/items?itemName=Sedenion.HistoryDiff)!**
88

0 commit comments

Comments
 (0)