完善文档

linuful · Jun 4, 2018 · 3ff746a · 3ff746a
1 parent c91d667
commit 3ff746a
Show file tree

Hide file tree

Showing 11 changed files with 58 additions and 207 deletions.
diff --git a/README.md b/README.md
@@ -42,3 +42,4 @@
 |[hsweb-message](hsweb-message)|mq,websocket...| 80%|
 |[hsweb-starter](hsweb-starter)|模块启动器| 90%|
 |[hsweb-system](hsweb-system)|**系统常用功能**| 80%|
+|[hsweb-thirdparty](hsweb-thirdparty)| 第三方插件 | 100% |
diff --git a/docs/dev-guide/README.md b/docs/dev-guide/README.md
diff --git a/docs/dev-guide/autz/README.md b/docs/dev-guide/autz/README.md
diff --git a/docs/dev-guide/crud/README.md b/docs/dev-guide/crud/README.md
diff --git a/docs/dev-guide/crud/custom-field.md b/docs/dev-guide/crud/custom-field.md
diff --git a/docs/dev-guide/logging/README.md b/docs/dev-guide/logging/README.md
diff --git a/docs/help/submit-code-issues.md b/docs/help/submit-code-issues.md
diff --git a/docs/hsweb3.png b/docs/hsweb3.png
diff --git a/hsweb-thirdparty/README.md b/hsweb-thirdparty/README.md
@@ -0,0 +1,6 @@
+# 对一些第三方插件的封装
+
+```bash
+--------hsweb-thirdparty-ueditor        # 百度ueditor的封装
+
+```
diff --git a/hsweb-thirdparty/hsweb-thirdparty-ueditor/README.md b/hsweb-thirdparty/hsweb-thirdparty-ueditor/README.md
@@ -0,0 +1,42 @@
+# 百度UEditor spring-boot集成
+
+对[百度UEditor](http://ueditor.baidu.com/website/)后台服务的封装
+
+# 使用:
+
+在pom.xml引入模块:
+
+```xml
+<dependency>
+   <dependency>
+        <groupId>org.hswebframework.web</groupId>
+        <artifactId>hsweb-thirdparty-ueditor</artifactId>
+        <version>${hsweb.framework.version}</version>
+    </dependency>
+</dependency>
+```
+
+⚠️ 注意: 此模块使用`hsweb-system-file-api`模块进行文件管理. 
+所以在使用此模块之前需要提供`hsweb-system-file-api`的实现模块.
+你可以查看[hsweb-system-file](../../hsweb-system/hsweb-system-file)的文档进行引入.
+
+### 后端配置
+
+在`src/main/resources` 下建立`ueditor-config.json`文件,此文件为ueditor的配置文件.例如:
+[ueditor-config.json](https://github.com/hs-web/hsweb3-demo/blob/master/src/main/resources/ueditor-config.json)
+你也可以参照[官方的配置](http://fex.baidu.com/ueditor/#server-config)
+
+### 前端配置
+修改`ueditor.config.js`中的配置项: `window.UEDITOR_CONFIG.serverUrl`. 例如:
+
+```js
+ /**
+     * 配置项主体。注意，此处所有涉及到路径的配置别遗漏URL变量。
+     */
+    window.UEDITOR_CONFIG = {
+
+        // 服务器统一请求接口路径
+          serverUrl: "/ueditor"
+        //** 更多配置项
+        }
+```
diff --git a/hsweb-thirdparty/hsweb-thirdparty-ueditor/pom.xml b/hsweb-thirdparty/hsweb-thirdparty-ueditor/pom.xml
@@ -6,35 +6,44 @@
         <artifactId>hsweb-thirdparty</artifactId>
         <groupId>org.hswebframework.web</groupId>
         <version>3.0.0-RC-SNAPSHOT</version>
+        <relativePath>../pom.xml</relativePath>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 
     <artifactId>hsweb-thirdparty-ueditor</artifactId>
 
+    <description>对百度UEditor后台服务的拓展和封装</description>
+
     <dependencies>
+        <!--文件服务API-->
         <dependency>
             <groupId>org.hswebframework.web</groupId>
             <artifactId>hsweb-system-file-api</artifactId>
             <version>${project.version}</version>
         </dependency>
+
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter</artifactId>
         </dependency>
+
         <dependency>
             <groupId>org.springframework</groupId>
             <artifactId>spring-webmvc</artifactId>
         </dependency>
+
         <dependency>
             <groupId>javax.servlet</groupId>
             <artifactId>javax.servlet-api</artifactId>
             <scope>provided</scope>
         </dependency>
+
         <dependency>
             <groupId>commons-fileupload</groupId>
             <artifactId>commons-fileupload</artifactId>
             <version>1.3.2</version>
             <optional>true</optional>
         </dependency>
+
     </dependencies>
 </project>