Skip to content

Commit 22eba0c

Browse files
authored
Update README and CHANGELOG for v2.15.0 (#1103)
1 parent 2831c8b commit 22eba0c

File tree

2 files changed

+40
-39
lines changed

2 files changed

+40
-39
lines changed

CHANGELOG.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,27 @@ All notable changes to this project will be documented in this file.
44
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
55
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
66

7-
## [2.14.x] - 2021-11-23
7+
## [2.15.0] - 2021-12-16
88

99
### Added
10-
- Added virtual method for content type checking in `OpenXmlPart` and fix issue for `model/gltf.binary` (#1069)
10+
- Added samples for strongly typed classes and Linq-to-XML in the `./samples` directory (#1101, #1087)
11+
- Shipping additional libraries for some additional functionality in `DocumentFormat.OpenXml.Features` and `DocumentFormat.OpenXml.Linq`. See documentation in repo for additional details.
12+
- Added extension method to support getting image part type (#1082)
13+
- Added generated classes and `FileFormatVersions.Microsoft365` for new subscription model types and constraints (#1097).
1114

1215
### Fixed
16+
- Fixed issue for changed mime type `model/gltf.binary` (#1069)
1317
- DocumentFormat.OpenXml.Office.Drawing.ShapeTree is now available only in Office 2010 and above, not 2007.
18+
- Correctly serialize `new CellValue(bool)` values (#1070)
19+
- Updated known namespaces to be generated via an in-repo source generator (#1092)
20+
- Some documentation issues around `FileFormatVersions` enum
21+
22+
Thanks to the following for their contributions:
23+
24+
@ThomasBarnekow
25+
@stevenhansen
26+
@JaimeStill
27+
@jnyrup
1428

1529
## [2.14.0] - 2021-10-28
1630

README.md

Lines changed: 24 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,11 @@
1+
<!-- omit in toc -->
12
Open XML SDK
23
============
34

4-
[![NuGet](https://img.shields.io/nuget/v/DocumentFormat.OpenXml.svg)](https://www.nuget.org/packages/DocumentFormat.OpenXml)
55
[![Downloads](https://img.shields.io/nuget/dt/DocumentFormat.OpenXml.svg)](https://www.nuget.org/packages/DocumentFormat.OpenXml)
66
[![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)
77
[![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)
88

9-
&nbsp;
10-
>## Open XML SDK 2.5 Productivity Tool
11-
>Now available for download at [Open XML SDK 2.5 Productivity Tool](https://github.com/OfficeDev/Open-XML-SDK/releases/tag/v2.5).
12-
13-
&nbsp;
14-
15-
> # Office 2021 Support Available!
16-
> [Version 2.14.0](https://www.nuget.org/packages/DocumentFormat.OpenXml/2.14.0) now provides support for Office 2021 types, including for:
17-
> - Label Information part support
18-
> - PowerPoint Comments support
19-
> - Excel Named Sheet Views support
20-
> - Excel Rich Data enhancements
21-
> - Word Comments Extensibilty part types
22-
> - Document Tasks support in Word
23-
> - Drawing Sketchy Shapes support
24-
>
25-
26-
&nbsp;
27-
289
The Open XML SDK provides tools for working with Office Word, Excel, and PowerPoint documents. It supports scenarios such as:
2910

3011
- High-performance generation of word-processing documents, spreadsheets, and presentations.
@@ -33,22 +14,31 @@ The Open XML SDK provides tools for working with Office Word, Excel, and PowerPo
3314
- Splitting up (shredding) a file into multiple files, and combining multiple files into a single file.
3415
- Updating cached data and embedded spreadsheets for charts in Word/PowerPoint.
3516

36-
Table of Contents
37-
-----------------
17+
<!-- omit in toc -->
18+
# Table of Contents
3819

39-
- [Releases](#releases)
20+
- [Packages](#packages)
21+
- [Daily Builds](#daily-builds)
22+
- [Framework Support](#framework-support)
4023
- [If You Have Problems](#if-you-have-problems)
4124
- [Known Issues](#known-issues)
4225
- [Documentation](#documentation)
4326
- [Related tools](#related-tools)
4427
- [Code of Conduct](#code-of-conduct)
4528

46-
Releases
47-
--------------------------------
29+
# Packages
4830

49-
The official release NuGet packages for Open XML SDK are [available on Nuget.org](https://www.nuget.org/packages/DocumentFormat.OpenXml).
31+
The official release NuGet packages for Open XML SDK are on NuGet.org:
5032

51-
The NuGet package for the latest builds of the Open XML SDK is available as a custom feed on MyGet. You can trust this package source, since the custom feed is locked and only this project feeds into the source. Stable releases here will be mirrored onto NuGet and will be identical. You must set up a [NuGet.config](https://docs.microsoft.com/en-us/nuget/reference/nuget-config-file) file that looks similar to this:
33+
| Package | Download |
34+
|---------|----------|
35+
| DocumentFormat.OpenXml | [![NuGet](https://img.shields.io/nuget/v/DocumentFormat.OpenXml.svg)](https://www.nuget.org/packages/DocumentFormat.OpenXml) |
36+
| DocumentFormat.OpenXml.Linq | [![NuGet](https://img.shields.io/nuget/v/DocumentFormat.OpenXml.Linq.svg)](https://www.nuget.org/packages/DocumentFormat.OpenXml.Linq) |
37+
| DocumentFormat.OpenXml.Features | [![NuGet](https://img.shields.io/nuget/v/DocumentFormat.OpenXml.Features.svg)](https://www.nuget.org/packages/DocumentFormat.OpenXml.Features) |
38+
39+
## Daily Builds
40+
41+
The NuGet package for the latest builds of the Open XML SDK is available as a custom feed on an Azure blob. Stable releases here will be mirrored onto NuGet and will be identical. You must set up a [NuGet.config](https://docs.microsoft.com/en-us/nuget/reference/nuget-config-file) file that looks similar to this:
5242

5343
```xml
5444
<?xml version="1.0" encoding="utf-8"?>
@@ -61,6 +51,8 @@ The NuGet package for the latest builds of the Open XML SDK is available as a cu
6151

6252
For latests changes, please see the [changelog](CHANGELOG.md)
6353

54+
## Framework Support
55+
6456
The package currently supports the following frameworks:
6557

6658
- .NET Framework 3.5+
@@ -76,8 +68,7 @@ The package currently supports the following frameworks:
7668

7769
For details on platform support, please see the docs at https://docs.microsoft.com/en-us/dotnet/standard/net-standard.
7870

79-
If You Have Problems
80-
--------------------
71+
# If You Have Problems
8172

8273
If you want to report a problem (bug, behavior, build, distribution, feature request, etc...) with the SDK built by this repository, please feel free to post a new issue and someone will try to help.
8374

@@ -86,22 +77,19 @@ If you have "how-to" questions please post to one of the following resources:
8677
- [Microsoft Q&A Forums](https://docs.microsoft.com/en-us/answers/topics/office-addins-dev.html) (tag: **office-addins-dev**)
8778
- [Stack Overflow](http://stackoverflow.com) (tags: **openxml** or **openxml-sdk**)
8879

89-
Known Issues
90-
------------
80+
# Known Issues
9181

9282
- On .NET Core and .NET 5, zip packages do not have a way to stream data. Thus, the working set can explode in certain situations. This is a [known issue](https://github.com/dotnet/runtime/issues/1544).
9383
- On .NET Core, targeting .NET Framework 4.5+, and .NET 5, `System.Uri` will not parse invalid links. This causes an exception. A workaround in v2.12.0+ of OpenXml SDK is to use `OpenSettings.RelationshipErrorRewriter` to rewrite them to something that can be parsed. A discussion is available [here](https://github.com/dotnet/runtime/issues/26084) to enable something more robust in `System.IO.Packaging`.
9484
- On .NET Framework, an `IsolatedStorageException` may be thrown under certain circumstances. This generally occurs when manipulating a large document in an environment with an AppDomain that does not have enough evidence. A sample with a workaround is available [here](/samples/IsolatedStorageExceptionWorkaround).
9585

96-
Documentation
97-
-------------
86+
# Documentation
9887

9988
The functionality of the specific classes in this version of the Open XML SDK is similar to version 2.5, therefore the [Open XML SDK 2.5 for Office](http://msdn.microsoft.com/en-us/library/office/bb448854.aspx) documentation available on MSDN is still accurate.
10089

10190
In addition to open sourcing of the SDK, Microsoft has opened up the conceptual documentation for public review / contributions. A copy of the documentation is available for you to edit and review [in GitHub](https://github.com/OfficeDev/office-content).
10291

103-
Related tools
104-
-------------
92+
# Related tools
10593

10694
- **[Open XML SDK 2.5 Productivity Tool](https://github.com/OfficeDev/Open-XML-SDK/releases/tag/v2.5)**: The Productivity Tool provides viewing and code generation compatible with the Open XML SDK 2.5.
10795
- **[Open XML Powertools](https://github.com/EricWhiteDev/Open-Xml-PowerTools)**: This provides example code and guidance for implementing a wide range of Open XML scenarios.
@@ -113,7 +101,6 @@ Related tools
113101
- **[ShapeCrawler](https://github.com/ShapeCrawler/ShapeCrawler)**: This library provides a simplified object model on top of the OpenXml SDK to manipulate PowerPoint documents.
114102
- **[OOXML Validator](https://github.com/mikeebowen/ooxml-validator-vscode)**: VS Code extension to validate Office Open XML files. Search "OOXML" in the VS Code extensions tab or download it from the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=mikeebowen.ooxml-validator-vscode)
115103

116-
Code of Conduct
117-
---------------
104+
# Code of Conduct
118105

119106
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information, see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.

0 commit comments

Comments
 (0)