feat: data dictionary handbook

.dumi/theme/builtins/YouChaoYunPluginInfo.tsx

@@ -0,0 +1,86 @@
+import { Link, useSiteData } from 'dumi';
+import React from 'react';
+
+const YouChaoYunPluginInfo = (props) => {
+  const { name, link, commercial } = props;
+  const { themeConfig } = useSiteData();
+  const zhCN = themeConfig.lang === 'zh-CN';
+  const jaJP = themeConfig.lang === 'ja-JP';
+
+  return (
+    <div>
+      <div className="dumi-default-container markdown" data-type="info">
+        <svg viewBox="64 64 896 896">
+          <path d="M512 64C264.6 64 64 264.6 64 512s200.6 448 448 448 448-200.6 448-448S759.4 64 512 64zm0 820c-205.4 0-372-166.6-372-372s166.6-372 372-372 372 166.6 372 372-166.6 372-372 372z"></path>
+          <path d="M464 336a48 48 0 1 0 96 0 48 48 0 1 0-96 0zm72 112h-48c-4.4 0-8 3.6-8 8v272c0 4.4 3.6 8 8 8h48c4.4 0 8-3.6 8-8V456c0-4.4-3.6-8-8-8z"></path>
+        </svg>
+        <h4>{zhCN ? '提示' : jaJP ? '注意' : 'INFO'}</h4>
+        <section>
+          {zhCN ? (
+            <p>
+              该功能由{commercial ? '商业' : ''}插件{' '}
+              <Link to={link ?? `/handbook/${name}`}>plugin-{name}</Link> 提供
+              {commercial && (
+                <>
+                  ，请查看{' '}
+                  <a target="_blank" href="https://www.nocobase.com/cn/plugins">
+                    商业授权
+                  </a>{' '}
+                  了解详情
+                </>
+              )}
+              .<br />
+              作者：
+              <a href="http://www.youchaoyun.com/" target="_blank">
+                安徽有巢数智信息科技有限公司
+              </a>
+            </p>
+          ) : jaJP ? (
+            <p>
+              この機能は{commercial ? '商用' : ''}プラグイン{' '}
+              <Link to={link ?? `/handbook/${name}`}>plugin-{name}</Link>{' '}
+              によって提供されます。
+              {commercial && (
+                <>
+                  {' '}
+                  詳細については、
+                  <a target="_blank" href="https://www.nocobase.com/jp/plugins">
+                    商用ライセンス
+                  </a>{' '}
+                  をご覧ください。
+                </>
+              )}
+              <br />
+              著者：
+              <a href="http://www.youchaoyun.com/" target="_blank">
+                安徽有巢数智信息科技有限公司
+              </a>
+            </p>
+          ) : (
+            <p>
+              This feature is provided by the {commercial ? 'commercial ' : ''}
+              plugin <Link to={link ?? `/handbook/${name}`}>plugin-{name}</Link>
+              .{' '}
+              {commercial && (
+                <>
+                  <br /> Please refer to the{' '}
+                  <a target="_blank" href="https://www.nocobase.com/en/plugins">
+                    commercial license
+                  </a>{' '}
+                  for details.
+                </>
+              )}
+              <br />
+              Author:&nbsp;
+              <a href="http://www.youchaoyun.com/" target="_blank">
+                安徽有巢数智信息科技有限公司
+              </a>
+            </p>
+          )}
+        </section>
+      </div>
+    </div>
+  );
+};
+
+export default YouChaoYunPluginInfo;

docs/config/handbook.ts

@@ -49,7 +49,7 @@ export default [
             children: [
               {
                 title: 'Overview',
-		'title.fr-FR': 'Vue d\'ensemble',
+                'title.fr-FR': 'Vue d\'ensemble',
                 'title.zh-CN': '介绍',
                 'title.ja-JP': '概要',
                 link: '/handbook/data-source-manager/external-database',
@@ -398,6 +398,13 @@ export default [
                 'title.ja-JP': '中国の行政区',
                 link: '/handbook/field-china-region',
               },
+              {
+                title: 'Data dictionary',
+                'title.fr-FR': 'Data dictionary',
+                'title.zh-CN': '数据字典',
+                'title.ja-JP': 'データ辞書',
+                link: '/handbook/data-dictionary',
+              },
             ],
           },
           {
@@ -699,48 +706,48 @@ export default [
     children: [
       {
         title: 'UI Editor mode',
-    	'title.fr-FR': 'Mode éditeur UI',
+        'title.fr-FR': 'Mode éditeur UI',
         'title.zh-CN': '界面配置模式',
         'title.ja-JP': 'UIエディタモード',
         link: '/handbook/ui/ui-editor',
       },
       {
         title: 'Menu',
-    	'title.fr-FR': 'Menu',
+        'title.fr-FR': 'Menu',
         'title.zh-CN': '菜单',
         'title.ja-JP': 'メニュー',
         link: '/handbook/ui/menus',
       },
       {
         title: 'Page',
-    	'title.fr-FR': 'Page',
+        'title.fr-FR': 'Page',
         'title.zh-CN': '页面',
         'title.ja-JP': 'ページ',
         link: '/handbook/ui/pages',
       },
       {
         title: 'Pop-up',
-    	'title.fr-FR': 'Pop-up',
+        'title.fr-FR': 'Pop-up',
         'title.zh-CN': '弹窗',
         'title.ja-JP': 'ポップアップ',
         link: '/handbook/ui/pop-up',
       },
       {
         title: 'Blocks',
-    	'title.fr-FR': 'Blocks',
+        'title.fr-FR': 'Blocks',
         'title.zh-CN': '区块',
         'title.ja-JP': 'ブロック',
         children: [
           {
             title: 'Overview',
-    	    'title.fr-FR': 'Vue d\'ensemble',
+            'title.fr-FR': 'Vue d\'ensemble',
             'title.zh-CN': '概述',
             'title.ja-JP': '概要',
             link: '/handbook/ui/blocks',
           },
           {
             title: 'Data blocks',
-    	    'title.fr-FR': 'Data blocks',
+            'title.fr-FR': 'Data blocks',
             'title.zh-CN': '数据区块',
             'title.ja-JP': 'データブロック',
             children: [
@@ -1264,7 +1271,7 @@ export default [
           },
           {
             title: 'Common settings',
-	    'title.fr-FR': 'Parmètres communs',
+            'title.fr-FR': 'Parmètres communs',
             'title.zh-CN': '通用配置项',
             'title.ja-JP': '一般設定',
             children: [
@@ -1630,12 +1637,12 @@ export default [
                 children: [
                   {
                     title: 'HTTP API',
-             	    'title.fr-FR': 'HTTP API',
+                    'title.fr-FR': 'HTTP API',
                     link: '/handbook/user-data-sync/sources/api',
                   },
                   {
                     title: 'WeCom',
-	            'title.fr-FR': 'WeCom',
+                    'title.fr-FR': 'WeCom',
                     'title.zh-CN': '企业微信',
                     link: '/handbook/wecom/user-data-sync',
                   },
@@ -1911,7 +1918,7 @@ export default [
         children: [
           {
             title: 'Overview',
-	    'title.fr-FR': 'Vue d\'ensemble',
+            'title.fr-FR': 'Vue d\'ensemble',
             'title.zh-CN': '概述',
             'title.ja-JP': '概要',
             link: '/handbook/file-manager',
@@ -2059,7 +2066,7 @@ export default [
                   },
                   {
                     title: 'Configure chart',
-	            'title.fr-FR': 'Configuration de graphique',
+                    'title.fr-FR': 'Configuration de graphique',
                     'title.zh-CN': '配置图表',
                     'title.ja-JP': 'チャートを設定',
                     link: '/handbook/data-visualization/user/Configure',
@@ -2260,7 +2267,7 @@ export default [
       },
       {
         title: 'Multi-app manager',
- 	'title.fr-FR': 'Gestionnaire multi-App',
+        'title.fr-FR': 'Gestionnaire multi-App',
         'title.zh-CN': '多应用管理',
         'title.ja-JP': 'マルチアプリ管理',
         // subTitle: '@nocobase/plugin-api-doc',
@@ -2403,7 +2410,7 @@ export default [
       },
       {
         title: 'Nodes',
-	'title.fr-FR': 'Noeuds',
+        'title.fr-FR': 'Noeuds',
         'title.zh-CN': '节点',
         'title.ja-JP': 'ノード',
         children: [

docs/en-US/handbook/data-dictionary/index.md

@@ -0,0 +1,67 @@
+# Data Dictionary
+
+<YouChaoYunPluginInfo name="data-dictionary" commercial=true></YouChaoYunPluginInfo>
+
+## Why Use Data Dictionary?
+
+### Usage Scenarios
+
+- There is a need to maintain consistency within the system for specific data, such as contract management, and it is desirable to define a fixed number of contract states that users can choose to use in order to achieve the established management objectives for subsequent statistical analysis.
+- As an enumeration of data used to achieve specific functions, such as: CRM system implementation, according to the upstream and downstream company categories into customers, suppliers, you can reuse the same data definition, block template, you only need to type in the list of customers, suppliers, sales contracts, and procurement contracts.
+- Defining a data dictionary with reference to relevant standards can realize data reuse with other heterogeneous systems. For example, housing construction departments in various provinces and cities have their own real-name system for labor services, and the Ministry of Housing and urban-rural development defines a set of data dictionary standards, so that the data of provinces and cities can be interoperable.
+
+### Compared To The Built-in Selection Fields:
+
+- One definition, many uses
+- No administrator privileges are required, and end users can maintain data
+- Provide richer features
+- Scalability in the future
+
+### Features:
+
+- Support for tree dictionaries
+  For example: GB/T 2261.2-2003, personal basic information classification and code-marital status
+  ![](./image.png)
+  ![](./image-1.png)
+
+- Support for more color choices
+- Provide valid/invalid controls that do not affect historical data
+
+## Usage Instructions
+
+Data Dictionary Maintenance: dictionary types, dictionary data
+![](./image-2.png)
+
+![](./image-3.png)
+
+Fields add:
+![](./image-4.png)
+
+![](./image-5.png)
+
+## Post-use Effects
+
+Table block
+![](./image-6.png)
+
+Configuration items: 1. Field components (tag, colored text, text) ; 2. Whether to display the parent
+![](./image-7.png)
+
+Add and edit block
+![](./image-8.png)
+
+Details block
+![](./image-9.png)
+
+Linkage rules
+![](./image-10.png)
+
+Data scope
+![](./image-11.png)
+
+Filter block
+![](./image-12.png)
+
+## Migration Of Historical Data
+
+Developing...

docs/zh-CN/handbook/data-dictionary/index.md

@@ -0,0 +1,67 @@
+# 数据字典
+
+<YouChaoYunPluginInfo name="data-dictionary" commercial=true></YouChaoYunPluginInfo>
+
+## 为什么要使用数据字典？
+
+### 使用场景
+
+- 需要在系统内维持特定数据的一致性，比如：对合同的管理，希望定义固定的几个合同状态供用户选择使用，以便后续统计分析时达到既定的管理目标。
+- 当作枚举数据使用，实现特定的功能，比如：实现CRM系统时，按上下游公司的类别分为客户、供应商，则可以复用同一个数据定义、区块模板，只需要在客户、供应商、销售合同、采购合同列表做类型区分即可。
+- 参照相关标准定义数据字典，可实现与其他异构系统的数据复用，比如：各省市的住建部门都有自己的劳务实名制系统，国家住建部则定义一套数据字典标准，以便各省市的数据可以互通。
+
+### 与内置选择字段对比：
+
+- 一处定义，多处使用
+- 不需要管理员权限，终端用户也可维护数据
+- 提供更丰富的特性
+- 未来的可扩展性
+
+### 方案特色：
+
+- 支持树型字典
+  比如：GB/T 2261.2-2003，个人基本信息分类与代码 - 婚姻状况
+  ![](./image.png)
+  ![](./image-1.png)
+
+- 支持更多颜色选择
+- 提供有效/无效控制，不影响历史数据
+
+## 使用说明
+
+数据字典维护：字典类型、字典数据
+![](./image-2.png)
+
+![](./image-3.png)
+
+字段添加
+![](./image-4.png)
+
+![](./image-5.png)
+
+## 使用效果
+
+表格区块
+![](./image-6.png)
+
+配置项：1. 字段组件（标签、带颜色文字、文字）；2. 是否显示父级
+![](./image-7.png)
+
+新增、编辑区块
+![](./image-8.png)
+
+详情区块
+![](./image-9.png)
+
+联动规则
+![](./image-10.png)
+
+数据范围
+![](./image-11.png)
+
+筛选区块
+![](./image-12.png)
+
+## 历史数据迁移
+
+完善中...