Skip to content

Commit 3e3b552

Browse files
lindexilindexi
authored
Merge pull request #20 from dotnet-campus/t/lindexi/doc
更新文档内容
2 parents 9d9364f + 717268c commit 3e3b552

3 files changed

Lines changed: 186 additions & 6 deletions

File tree

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2020-2021 dotnet campus
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 71 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,88 @@
1-
# dotnetCampus.OfficeDocumentZipper
1+
# DocumentFormat.OpenXml.Extensions
22

3-
| Build | NuGet |
4-
|--|--|
5-
|![](https://github.com/dotnet-campus/dotnetCampus.OfficeDocumentZipper/workflows/.NET%20Core/badge.svg)|[![](https://img.shields.io/nuget/v/dotnetCampus.OfficeDocumentZipper.svg)](https://www.nuget.org/packages/dotnetCampus.OfficeDocumentZipper)|
3+
[中文](README.zh-cn.md) | [English](README.md)
4+
5+
The OpenXML SDK extensions. Including libraries and tools.
6+
7+
| Build |
8+
|--|
9+
|![](https://github.com/dotnet-campus/dotnetCampus.OfficeDocumentZipper/workflows/.NET%20Core/badge.svg)|
10+
11+
# Tools
12+
13+
## dotnetCampus.OfficeDocumentZipper
614

715
A dotnet tool to assist in editing Office document files
816

9-
# Usage
17+
### Usage
1018

1119
```
1220
dotnet tool update -g dotnetCampus.OfficeDocumentZipper
1321
1422
OfficeDocumentZipper
1523
```
1624

17-
# Feature
25+
### Feature
1826

1927
- Unzip pptx docx xlsx file
2028
- Zip directory to pptx docx xlsx file
2129
- Convert OpenXML unit
2230

2331
![](https://user-images.githubusercontent.com/16054566/91013976-2b1c4580-e61b-11ea-8ef2-044ea79ef31b.png)
32+
33+
# Libraries
34+
35+
| Name | NuGet|
36+
|--|--|
37+
|dotnetCampus.OpenXMLUnitConverter|[![](https://img.shields.io/nuget/v/dotnetCampus.OpenXMLUnitConverter.svg)](https://www.nuget.org/packages/dotnetCampus.OpenXMLUnitConverter)|
38+
|dotnetCampus.OpenXMLUnitConverter.Source|[![](https://img.shields.io/nuget/v/dotnetCampus.OpenXMLUnitConverter.Source.svg)](https://www.nuget.org/packages/dotnetCampus.OpenXMLUnitConverter.Source)|
39+
40+
41+
## dotnetCampus.OpenXMLUnitConverter
42+
43+
Defining units for OpenXml properties and the unit conversion function.
44+
45+
### Install
46+
47+
DLL Pakcage:
48+
49+
```xml
50+
<PackageReference Include="dotnetCampus.OpenXmlUnitConverter" Version="1.8.0" />
51+
```
52+
53+
[SouceYard](https://github.com/dotnet-campus/SourceYard) Package:
54+
55+
```xml
56+
<PackageReference Include="dotnetCampus.OpenXmlUnitConverter.Source" Version="1.8.0">
57+
<PrivateAssets>all</PrivateAssets>
58+
<IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
59+
</PackageReference>
60+
```
61+
62+
### Usage
63+
64+
The sample:
65+
66+
```csharp
67+
void Foo(DocumentFormat.OpenXml.Drawing.Point2DType point)
68+
{
69+
var x = new Emu(point.X);
70+
var pixelValue = x.ToPixel();
71+
var cmValue = x.ToCm();
72+
}
73+
```
74+
75+
# Thanks
76+
77+
- [OfficeDev/Open-XML-SDK: Open XML SDK by Microsoft](https://github.com/OfficeDev/Open-XML-SDK/ )
78+
- [ironfede/openmcdf: Microsoft Compound File .net component - pure C# - NET Standard 2.0](https://github.com/ironfede/openmcdf )
79+
80+
# Contributing
81+
82+
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/dotnet-campus/DocumentFormat.OpenXml.Extensions/pulls)
83+
84+
If you would like to contribute, feel free to create a [Pull Request](https://github.com/dotnet-campus/DocumentFormat.OpenXml.Extensions/pulls), or give us [Bug Report](https://github.com/dotnet-campus/DocumentFormat.OpenXml.Extensions/issues/new).
85+
86+
# License
87+
88+
[![](https://img.shields.io/badge/License-MIT-blue?style=flat-square)](LICENSE)

‎README.zh-cn.md‎

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
# DocumentFormat.OpenXml.Extensions
2+
3+
[中文](README.zh-cn.md) | [English](README.md)
4+
5+
OpenXML SDK 的扩展集，包括扩展库和辅助开发工具
6+
7+
| Build |
8+
|--|
9+
|![](https://github.com/dotnet-campus/dotnetCampus.OfficeDocumentZipper/workflows/.NET%20Core/badge.svg)|
10+
11+
# 工具
12+
13+
## dotnetCampus.OfficeDocumentZipper
14+
15+
[解压缩文档为文件夹工具](https://blog.lindexi.com/post/dotnet-OpenXML-%E8%A7%A3%E5%8E%8B%E7%BC%A9%E6%96%87%E6%A1%A3%E4%B8%BA%E6%96%87%E4%BB%B6%E5%A4%B9%E5%B7%A5%E5%85%B7.html)
16+
17+
在开发过程中，需要不断解压缩 Office 文档，阅读或修改文档的内容，再次压缩回 Office 文档，这样的效率比较低。本工具提供一键解压自动格式化，一键组装Office文档且打开的功能
18+
19+
### 使用方法
20+
21+
OfficeDocumentZipper 工具作为 dotnet tool 发布，可使用以下代码进行安装和启动
22+
23+
```
24+
dotnet tool update -g dotnetCampus.OfficeDocumentZipper
25+
26+
OfficeDocumentZipper
27+
```
28+
29+
建议将以上命令存放作为 bat 脚本，方便每次快速运行
30+
31+
### 功能
32+
33+
- 解压 pptx docx xlsx 文件以及自动格式化文档内容
34+
- 压缩文件夹作为 pptx docx xlsx 文件
35+
- 转换 OpenXML 单位
36+
37+
![](https://user-images.githubusercontent.com/16054566/91013976-2b1c4580-e61b-11ea-8ef2-044ea79ef31b.png)
38+
39+
# 库
40+
41+
| Name | NuGet|
42+
|--|--|
43+
|dotnetCampus.OpenXMLUnitConverter|[![](https://img.shields.io/nuget/v/dotnetCampus.OpenXMLUnitConverter.svg)](https://www.nuget.org/packages/dotnetCampus.OpenXMLUnitConverter)|
44+
|dotnetCampus.OpenXMLUnitConverter.Source|[![](https://img.shields.io/nuget/v/dotnetCampus.OpenXMLUnitConverter.Source.svg)](https://www.nuget.org/packages/dotnetCampus.OpenXMLUnitConverter.Source)|
45+
46+
47+
## dotnetCampus.OpenXMLUnitConverter
48+
49+
定义 OpenXML 的单位以及提供单位转换的功能
50+
51+
### 安装方法
52+
53+
DLL 包:
54+
55+
```xml
56+
<PackageReference Include="dotnetCampus.OpenXmlUnitConverter" Version="1.8.0" />
57+
```
58+
59+
[SouceYard](https://github.com/dotnet-campus/SourceYard) 源代码包:
60+
61+
```xml
62+
<PackageReference Include="dotnetCampus.OpenXmlUnitConverter.Source" Version="1.8.0">
63+
<PrivateAssets>all</PrivateAssets>
64+
<IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
65+
</PackageReference>
66+
```
67+
68+
### 使用方法
69+
70+
例子：
71+
72+
```csharp
73+
void Foo(DocumentFormat.OpenXml.Drawing.Point2DType point)
74+
{
75+
var x = new Emu(point.X);
76+
var pixelValue = x.ToPixel();
77+
var cmValue = x.ToCm();
78+
}
79+
```
80+
81+
详细请看 [Office Open XML 的测量单位](https://blog.lindexi.com/post/Office-Open-XML-%E7%9A%84%E6%B5%8B%E9%87%8F%E5%8D%95%E4%BD%8D.html )
82+
83+
# 感谢
84+
85+
- [OfficeDev/Open-XML-SDK: Open XML SDK by Microsoft](https://github.com/OfficeDev/Open-XML-SDK/ )
86+
- [ironfede/openmcdf: Microsoft Compound File .net component - pure C# - NET Standard 2.0](https://github.com/ironfede/openmcdf )
87+
88+
# 开源社区
89+
90+
如果你希望参与贡献，欢迎 [Pull Request](https://github.com/dotnet-campus/DocumentFormat.OpenXml.Extensions/pulls)，或给我们 [报告 Bug](https://github.com/dotnet-campus/DocumentFormat.OpenXml.Extensions/issues/new)
91+
92+
# 授权协议
93+
94+
[![](https://img.shields.io/badge/License-MIT-blue?style=flat-square)](LICENSE)

0 commit comments

Comments
 (0)