Skip to content

Commit a34e967

Browse files
Clarified description of the SDK in README.md (#1858)
includes info from Thomas Barnekow and simplifies the Note on breaking changes in v 3.0.0
1 parent e2e364d commit a34e967

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,7 @@ Open XML SDK
44

55
> [!NOTE]
66
>
7-
> [v3.0.0](https://www.nuget.org/packages/DocumentFormat.OpenXml/3.0.0) refactors and addresses some technical debt while retaining source compatibility as much as possible. You should be able to update your package and recompile with limited changes. However, binary compatibility was not a goal and will break that for some changes which are documented. PRs that introduced such changes are marked with a `breaking-change` label and were added to a list to help migrating to v3.0.0.
8-
>
9-
> Please see the [v3.0.0 milestone](https://github.com/OfficeDev/Open-XML-SDK/milestone/1) for issues and PRs that are included. For discussions, please join us at [this issue](https://github.com/OfficeDev/Open-XML-SDK/issues/1270).
7+
> 3.0.0 introduced breaking changes and you should be able to update your package and recompile with limited changes. Please see the [v3.0.0 milestone](https://github.com/OfficeDev/Open-XML-SDK/milestone/1) for issues and PRs that were included.
108
119

1210
> [!IMPORTANT]
@@ -16,14 +14,20 @@ Open XML SDK
1614
[![Build Status](https://office.visualstudio.com/OC/_apis/build/status/OpenXmlSdk/OfficeDev.Open-XML-SDK?branchName=main)](https://office.visualstudio.com/OC/_build/latest?definitionId=7420&branchName=main)
1715
[![Backend Status](https://ointprotocol.visualstudio.com/OInteropTools/_apis/build/status/OpenXML-Schemas?branchName=main)](https://ointprotocol.visualstudio.com/OInteropTools/_build/latest?definitionId=21&branchName=main)
1816

19-
The Open XML SDK provides tools for working with Office Word, Excel, and PowerPoint documents. It supports scenarios such as:
17+
The Open XML SDK is a framework for working with Microsoft Office Word, Excel, and PowerPoint documents. It includes APIs for low-level operations related to OPC packages, Flat OPC files, and Open XML markup in two forms (i.e., strongly-typed classes and LINQ to XML). It is designed to closely follow the Microsoft Office implementation of the ISO 29500 standard, but was not intended to directly provide higher-level abstractions or productivity tools.
18+
19+
These APIs enable scenarios such as:
2020

2121
- High-performance generation of word-processing documents, spreadsheets, and presentations.
2222
- Document modification, such as adding, updating, and removing content and metadata.
23-
- Search and replace content using regular expressions.
23+
- Searching and replacing content using regular expressions.
2424
- Splitting up (shredding) a file into multiple files, and combining multiple files into a single file.
2525
- Updating cached data and embedded spreadsheets for charts in Word/PowerPoint.
2626

27+
28+
Prerequisite for using the Open XML SDK: detailed knowledge of the relevant formats (https://learn.microsoft.com/en-us/openspecs/office_standards/ms-offstandlp) and standards (https://standards.iso.org/ittf/PubliclyAvailableStandards/index.html - search for 29500)
29+
30+
2731
<!-- omit in toc -->
2832
# Table of Contents
2933

0 commit comments

Comments
 (0)