Browse Source

add first version

mamingjian 5 years ago
parent
commit
36960936d8
12 changed files with 215 additions and 0 deletions
  1. 11 0
      SUMMARY.md
  2. 77 0
      book.json
  3. 9 0
      chapter1.md
  4. 14 0
      chapter1/admin-setting.md
  5. 20 0
      chapter1/menu-setting.md
  6. 71 0
      chapter1/open_func.md
  7. 10 0
      scripts/index.js
  8. 0 0
      scripts/mermaid.min.js
  9. BIN
      src/img/cjms-1.png
  10. BIN
      src/img/cjms-2.png
  11. BIN
      src/img/cjms-3.png
  12. 3 0
      styles/website.css

+ 11 - 0
SUMMARY.md

@@ -0,0 +1,11 @@
+# Summary
+
+* [简介](README.md)
+
+---
+*  [基础用法](chapter1.md)
+  *  [管理员配置](chapter1/admin-setting.md)
+  *  [菜单管理](chapter1/menu-setting.md)
+  *  [开放接口](chapter1/open_func.md)
+
+

+ 77 - 0
book.json

@@ -0,0 +1,77 @@
+{
+    "description": "DIY系统",
+    "language": "zh-hans",
+    "title": "Duowan DIY 帮助文档",
+    "root": ".",
+    "links": {
+        "sidebar": {}
+    },
+    "plugins": [
+        "-lunr",
+        "-theme-api",
+        "-search",
+        "theme-comscore",
+        "search-pro@^2.0.2",
+        "tbfed-pagefooter",
+        "expandable-menu",
+        "edit-link",
+        "anchor-navigation-ex",
+        "addcssjs",
+        "richquotes",
+        "prism", 
+        "-highlight"
+    ],
+    "pluginsConfig": {
+        "addcssjs": {
+            "js": [
+                "./scripts/mermaid.min.js",
+                "./scripts/index.js"
+            ],
+            "css": [
+            ]
+        },
+        "theme-default": {
+            "showLevel": false
+        },
+        "tbfed-pagefooter": {
+            "copyright": "Copyright &copy duowan 2019",
+            "modify_label": "该文件修订时间:",
+            "modify_format": "YYYY-MM-DD HH:mm:ss"
+        },
+        "edit-link": {
+            "base": "http://svn.ouj.com:3000/dwdoc/gitbook/src/master",
+            "label": "编辑该页面"
+        },
+        "anchor-navigation-ex": {
+            "showLevel": false,
+            "associatedWithSummary": true,
+            "printLog": false,
+            "multipleH1": true,
+            "mode": "float",
+            "showGoTop":true,
+            "float": {
+                "showLevelIcon": false,
+                "level1Icon": "fa fa-hand-o-right",
+                "level2Icon": "fa fa-hand-o-right",
+                "level3Icon": "fa fa-hand-o-right"
+            },
+            "pageTop": {
+                "showLevelIcon": false,
+                "level1Icon": "fa fa-hand-o-right",
+                "level2Icon": "fa fa-hand-o-right",
+                "level3Icon": "fa fa-hand-o-right"
+            }
+        },
+        "prism": {
+            "lang": {
+              "cleos": "bash"
+            }
+        }
+    },
+    "styles": {
+        "website": "styles/website.css"
+    },
+    "variables": {
+        "admin": ""
+    }
+}

+ 9 - 0
chapter1.md

@@ -0,0 +1,9 @@
+## 基础用法
+
+*  [管理员配置](/chapter1/admin-setting.md)
+*  [菜单管理](/chapter1/menu-setting.md)
+*  [查询条件配置](/chapter1/query-conditiom-setting.md)
+
+
+
+

+ 14 - 0
chapter1/admin-setting.md

@@ -0,0 +1,14 @@
+#  管理员配置
+
+## 添加/编辑管理员
+入口:`多玩后台 => 系统管理 => 管理员管理`。
+![dictionary_1](../src/img/cjms-1.png)
+
+- 添加新管理员时,用户名和用户名使用YY通行证(内部账号一般格式为dw_xxxx)
+- 二次密码是在配置菜单的时候的可选选项,当菜单在某个功能配置了需要二次密码时,打开功能需要密码验证,该功能暂不用
+
+## 管理员组管理
+入口:`多玩后台 => 系统管理 => 管理员管理 => 管理员组/管理员组关系`。
+![dictionary_1](../src/img/cjms-1.png)
+- 在 `管理员组` 中可以创建所需的关系组
+- 在 `管理员组关系` 中可以在管理员与管理员组之间建立关系,将很多相同职责的管理员配置到一个组中,在管理菜单权限时可以通过授权组的方式完成多个相同权限的管理员快速授权

+ 20 - 0
chapter1/menu-setting.md

@@ -0,0 +1,20 @@
+#  菜单配置
+
+入口:`多玩后台 => 系统管理 => 菜单管理`。
+![dictionary_1](../src/img/cjms-3.png)
+
+## 流程
+- 通过右键根节点,选择添加子级节点,可以添加新的项目后台节点(在后台顶部的列表中显示)
+- 在项目节点上右键选择添加子级节点,建立项目自身的菜单列表
+- 可以拖动节点来变更节点的父级关系和位置(改完记得点击保存节点位置来保存修改)
+- 测试环境测试完成可以通过点击`同步到正式环境`将菜单同步到正式环境
+  同步时发现主键ID重复可以通过修改节点Id解决
+- 节点间的父级关系是页面顶部面包屑栏的功能顺序
+
+## 说明
+- `左边的url`是点击节点时左边导航栏的显示内容(一般默认为空,显示当前菜单)
+- `右边的url`是点击节点时右边container的显示内容(一般为对应功能的diy页的地址或后台功能页的地址 注:url是项目后台的功能地址需要填写模块名和appid,模块名和appid需要保证不为空,模块名一般填功能的action名,appid填1即可)
+- 可以通过节点的授权人员或授权组进行权限分配,如果在父节点上分配权限,自动会获得其下的所有子节点权限
+- 是否展现决定了该节点是否在左边导航栏显示
+- 新窗口决定该功能是否会在浏览器的一个新窗口中打开
+- 所属域名,设置节点所属后台(duowan.com,ouj.com),为空是会在所有后台中显示

+ 71 - 0
chapter1/open_func.md

@@ -0,0 +1,71 @@
+# 页面配置管理
+**[1. 检查后台用户](#检查后台用户是否存在)** 
+**[2. 检验管理平台的url权限](#检验管理平台的url权限)** 
+**[3. 检验偶家账号权限](#检验偶家账号权限)** 
+**[4. 检验多玩用户权限 ](#检验多玩用户权限 )**
+**[5. 检验偶家用户 ](#检验偶家用户 )**
+**[6. 增加操作记录 ](#增加操作记录 )**
+
+## 检查后台用户是否存在
+    addr:   open/CheckUser
+    param:  userId=>string
+    reutrn: array
+    		userId
+            userName
+            extraInfo
+
+
+## 检验管理平台的url权限
+    addr:   open/CheckRight
+    param:  userId=>string    url=>string
+    reutrn: array
+    		userId
+            userName
+            extraInfo
+            
+    addr:   open/CheckRight2
+    param:  userId=>string    nodeId=>string
+    reutrn: array
+    		userId
+            userName
+            extraInfo
+
+## 检验偶家账号权限        
+    addr:   open/CheckOujRight
+    param:  url=>string    adminAppId=>string  ouid=>string otoken=>string
+    reutrn: array
+    		res
+    		msg
+
+## 检验多玩用户权限        
+    addr:   open/CheckDwRight
+    param:  url=>string    adminAppId=>string  yyuid=>string password=>string udb_oar=>string
+    reutrn: array
+    		res
+    		msg
+
+## 检验偶家用户        
+    addr:   open/CheckOujUser
+    param:  ouid=>string    otoken=>string  
+    reutrn: array
+    		res
+    		msg
+
+## 增加操作记录,需要签名(不验证)        
+    addr:   open/AddOperationLog
+    param:  tableId=>string   userId=>string  userName=>string  operType=>string operDesc=>string operSql=>string rollbackSql=>string app_id=>string  sign=>string
+    reutrn: array
+    		res
+    		msg
+
+注:签名方法
+otoken:
+使用DES类的encrypt方法 des_key:login_oj iv(偏移量):12345678
+可以从cookie中获取:\$\_COOKIE\[\'otoken\'\]
+udb_oar:
+可以从cookie中获取:\$\_COOKIE\[\'udb_oar\'\]
+sign:
+需要传sign参数,但是不做验证,所以sign值可以是任意值(一般设置为sign)
+
+
+

+ 10 - 0
scripts/index.js

@@ -0,0 +1,10 @@
+let path = null
+
+setInterval(() => {
+  if (path !== window.location.pathname) {
+    path = window.location.pathname
+    
+    window.mermaid.initialize({ theme: 'default' })
+    window.mermaid.init(undefined, document.querySelectorAll('.lang-mermaid'))
+  }
+}, 1000)

File diff suppressed because it is too large
+ 0 - 0
scripts/mermaid.min.js


BIN
src/img/cjms-1.png


BIN
src/img/cjms-2.png


BIN
src/img/cjms-3.png


+ 3 - 0
styles/website.css

@@ -0,0 +1,3 @@
+.gitbook-link {
+    /*display: none !important;*/
+}

Some files were not shown because too many files changed in this diff