Skip to content

Commit 6e6a95a

Browse files
committed
docs: update README and README.zh-CN with new links, improved descriptions, and corrected formatting
1 parent 5b9cb46 commit 6e6a95a

File tree

2 files changed

+51
-17
lines changed

2 files changed

+51
-17
lines changed

README.md

Lines changed: 39 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -63,13 +63,16 @@ For details, see: <https://dev.azure.com/xinlaiopencode/Magicodes.IE/_build?defi
6363
4. <a href="docs/4.Use in Docker.md">Use in Docker</a>
6464
5. <a href="docs/5.Dynamic Export.md">Dynamic Export</a>
6565
6. <a href="docs/6.Import Multi-Sheet Tutorial.md">Import Multi-Sheet Tutorial</a>
66-
7. <a href="docs/8. Import and export Excel as pictures.md">Import and export Excel as pictures</a>
67-
8. <a href="docs/9.Excel template export-Export textbook order form .md">Excel template export-Export textbook order form</a>
68-
9. <a href="docs/Excel Merge Row Cells Import.md">Excel Merge Row Cells Import</a>
66+
7. <a href="docs/7.Csv Import and Export.md">Csv Import and Export</a>
67+
8. <a href="docs/8. Import and export Excel as pictures.md">Import and export Excel as pictures</a>
68+
9. <a href="docs/9.Excel template export-Export textbook order form .md">Excel template export-Export textbook order form</a>
69+
10. <a href="https://docs.xin-lai.com/2020/09/21/%E7%BB%84%E4%BB%B6/Magicodes.IE/Magicodes.IE%E4%B9%8B%E5%AF%BC%E5%85%A5%E5%AF%BC%E5%87%BA%E7%AD%9B%E9%80%89%E5%99%A8/">Import and Export Filters</a>
70+
11. <a href="https://docs.xin-lai.com/2020/09/28/%E7%BB%84%E4%BB%B6/Magicodes.IE/Magicodes.IE%E4%B9%8B%E8%8A%B1%E5%BC%8F%E5%AF%BC%E5%87%BA/">Magicodes.IE Fancy Export</a>
6971
12. <a href="docs/12.Exporting multiple formats in NETCore via request headers.md">Exporting multiple formats in NETCore via request headers</a>
7072
13. <a href="docs/13.Performance Measurement.md">Performance Measurement</a>
7173
14. <a href="docs/Excel Merge Row Cells Import.md">Excel Merge Row Cells Import</a>
72-
15. <a href="docs/Excel template export - dynamic export.md">Excel template export - dynamic export</a>
74+
15. <a href="docs/Excel template export - dynamic export.md">Excel template export - dynamic export</a>
75+
16. <a href="docs/Magicodes.IE.Excel.AspNetCore Quick Export Excel.md">Magicodes.IE.Excel.AspNetCore Quick Export Excel (new)</a>
7376

7477
**See below for other tutorials or unit tests**
7578

@@ -81,8 +84,8 @@ For details, see: <https://dev.azure.com/xinlaiopencode/Magicodes.IE/_build?defi
8184
**![](./res/导入Dto.png "Import DTO")**
8285
- **Support various filters to support scenarios such as multi-language, dynamic control column display, etc. For specific usage, see unit test:**
8386
- **Import column header filter <IImportHeaderFilter>(you can dynamically specify the imported column and imported value mapping relationship)**
84-
- **Export column header filter <IImportHeaderFilter>(can dynamically control the export column, support dynamic export (DataTable))**
85-
- **Export column headers filter <IImportHeadersFilter>(can dynamically control the export column, support dynamic export (DataTable))**
87+
- **Export column header filter <IExportHeaderFilter>(can dynamically control the export column, support dynamic export (DataTable))**
88+
- **Export column headers filter <IExportHeadersFilter>(can dynamically control the export column, support dynamic export (DataTable))**
8689
- **Import result filter <IImportResultFilter>(can modify annotation file)**
8790
- **Export supports text custom filtering or processing;**
8891
- **Import supports automatic skipping of blank lines in the middle;**
@@ -112,7 +115,7 @@ For details, see: <https://dev.azure.com/xinlaiopencode/Magicodes.IE/_build?defi
112115
- **Import supports repeated verification;**
113116
![](./res/重复错误.png "Repeated verification")
114117
- **Support single data template export, often used to export receipts, credentials and other businesses**
115-
- **Support dynamic column export (based on DataTable), and the Sheet will be split automatically if it exceeds 100W. (Thanks to teacher Zhang Shanyou ([https://github.com/xin-lai/Magicodes.IE/pull/8](https://github.com/xin-lai/Magicodes.IE/pull/8) ))* *
118+
- **Support dynamic column export (based on DataTable), and the Sheet will be split automatically if it exceeds 100W. (Thanks to teacher Zhang Shanyou ([https://github.com/xin-lai/Magicodes.IE/pull/8](https://github.com/xin-lai/Magicodes.IE/pull/8)))**
116119
- **Support dynamic/ExpandoObject dynamic column export**
117120
```csharp
118121
[Fact(DisplayName = "DTO export supports dynamic types")]
@@ -135,7 +138,7 @@ For details, see: <https://dev.azure.com/xinlaiopencode/Magicodes.IE/_build?defi
135138
File.Exists(filePath).ShouldBeTrue();
136139
}
137140
```
138-
- **Support value mapping, support setting value mapping relationship through "ValueMappingAttribute" feature. It is used to generate data validation constraints for import templates and perform data conversion. **
141+
- **Support value mapping, support setting value mapping relationship through "ValueMappingAttribute" feature. It is used to generate data validation constraints for import templates and perform data conversion.**
139142
```csharp
140143
/// <summary>
141144
/// Gender
@@ -147,6 +150,30 @@ For details, see: <https://dev.azure.com/xinlaiopencode/Magicodes.IE/_build?defi
147150
public Genders Gender { get; set; }
148151
```
149152

153+
- **You can also inherit the "ValueMappingsBaseAttribute" attribute base class to implement value mapping relationships, currently only available for enumeration and Bool types, supports import and export.**
154+
```csharp
155+
[AttributeUsage(AttributeTargets.Property, AllowMultiple = true)]
156+
public class GenderLocalAttribute : ValueMappingsBaseAttribute
157+
{
158+
public override Dictionary<string, object> GetMappings(PropertyInfo propertyInfo)
159+
{
160+
var res= new Dictionary<string, object>();
161+
res.Add("Male",0);
162+
res.Add("Female",1);
163+
return res;
164+
}
165+
}
166+
167+
168+
/// <summary>
169+
/// Gender
170+
/// </summary>
171+
[ImporterHeader(Name = "Gender")]
172+
[Required(ErrorMessage = "Gender cannot be empty.")]
173+
[GenderLocal]
174+
public Genders Gender { get; set; }
175+
```
176+
150177
- **Support the generation of imported data verification items of enumeration and Bool type, and related data conversion**
151178
- **Enumeration will automatically obtain the description, display name, name and value of the enumeration by default to generate data items**
152179

@@ -208,7 +235,7 @@ For details, see: <https://dev.azure.com/xinlaiopencode/Magicodes.IE/_build?defi
208235
- **Support excel multi-sheet import**
209236
**![](./res/multipleSheet.png "Enumeration to data mapping")**
210237

211-
- **Support Excel template export, and support image rendering**
238+
- **Support Excel template export, JSON dynamic export, and support image rendering**
212239
**![](./res/ExcelTplExport.png "Excel template export")**
213240

214241
The rendering syntax is as follows:
@@ -220,6 +247,8 @@ For details, see: <https://dev.azure.com/xinlaiopencode/Magicodes.IE/_build?defi
220247
{{Image::ImageUrl?Width=50&Height=120&Alt=404}} //Picture rendering
221248
{{Image::ImageUrl?w=50&h=120&Alt=404}} //Picture rendering
222249
{{Image::ImageUrl?Alt=404}} //Picture rendering
250+
{{Formula::AVERAGE?params=G4:G6}} //Formula rendering
251+
{{Formula::SUM?params=G4:G6&G4}} //Formula rendering
223252
```
224253

225254
Custom pipelines will be supported in the future.
@@ -271,7 +300,7 @@ Support display operations for input prompts:
271300

272301
- **Excel import supports merging row data** [#239](https://github.com/dotnetcore/Magicodes.IE/issues/239)
273302

274-
![合并行导入文件](res/image-20210306105147319.png)
303+
![Excel Merge Row Cells Import](res/image-20210306105147319.png)
275304

276305
- Add packaging for Abp module, see [#318](https://github.com/dotnetcore/Magicodes.IE/issues/318) for details.
277306

README.zh-CN.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414
**地址(优先更新Gitee):**[CodeSpirit(码灵)](https://gitee.com/magicodes/code-spirit)
1515

16-
**简介:**CodeSpirit(码灵)是一款革命性的全栈低代码开发框架,通过智能代码生成引擎与AI深度协同,实现**后端驱动式全栈开发范式**。基于.NET 9技术栈构建,将具备企业级技术深度与云原生扩展能力,提供从界面生成、业务逻辑编排到系统运维的全生命周期支持。
16+
**简介:**CodeSpirit(码灵)是一款革命性的全栈低代码智能体开发框架,通过智能代码生成引擎与AI深度协同,实现**后端驱动式全栈开发范式**。基于.NET 10技术栈构建,将具备企业级技术深度与云原生扩展能力,提供从界面生成、业务逻辑编排到系统运维的全生命周期支持。
1717

1818
**让全栈开发回归工程本质**
1919

@@ -34,7 +34,7 @@
3434
7. [FAQ](https://github.com/dotnetcore/Magicodes.IE/issues?q=label%3Aquestion)
3535
8. [联系我们](#联系我们)
3636
9. [更新历史](./RELEASE.md)
37-
10. [友情赞助](#友情赞助)
37+
10. [贡献者](#贡献者)
3838

3939
## 概述
4040

@@ -401,30 +401,35 @@ public DateTime Time3 { get; set; }
401401
<img align="left" src="./res/wechat.jpg" width="300"/>
402402
</td>
403403
<td>
404-
<img align="right" src="res/IE_WeChat.png" width="300"/>
404+
<img align="right" src="./res/IE_WeChat.png" width="300"/>
405405
</td>
406406
</tr>
407407
</table>
408408
> ##### **文档官网&官方博客**
409409
410-
- **文档官网:<https://docs.xin-lai.com/>**
411-
- **博客:<http://www.cnblogs.com/codelove/>**
410+
- **官方博客:** <http://www.cnblogs.com/codelove/>
411+
- **GitHub:** <https://github.com/dotnetcore/Magicodes.IE>
412+
- **Gitee(手动同步,不维护):** <https://gitee.com/magicodes/Magicodes.IE>
413+
414+
## **贡献者**
412415

413416
### Code Contributors
414417

418+
本项目感谢所有贡献者的支持。[[贡献指南](CONTRIBUTING.md)]
419+
415420
<a href="https://github.com/dotnetcore/Magicodes.IE/graphs/contributors"><img src="https://opencollective.com/magicodes/contributors.svg?width=890&button=false" /></a>
416421

417422
### Financial Contributors
418423

419-
Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/magicodes/contribute)]
424+
成为财务贡献者,帮助我们维持社区发展。[[贡献](https://opencollective.com/magicodes/contribute)]
420425

421426
#### Individuals
422427

423428
<a href="https://opencollective.com/magicodes"><img src="https://opencollective.com/magicodes/individuals.svg?width=890"></a>
424429

425430
#### Organizations
426431

427-
Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/magicodes/contribute)]
432+
用您的组织支持这个项目。您的徽标将显示在这里,并链接到您的网站。[[贡献](https://opencollective.com/magicodes/contribute)]
428433

429434
<a href="https://opencollective.com/magicodes/organization/0/website"><img src="https://opencollective.com/magicodes/organization/0/avatar.svg"></a>
430435
<a href="https://opencollective.com/magicodes/organization/1/website"><img src="https://opencollective.com/magicodes/organization/1/avatar.svg"></a>

0 commit comments

Comments
 (0)