tawords/tawords-docs
1
0
Fork 0
mirror of https://gitee.com/tawords/tawords-docs synced 2025-01-10 11:28:13 +08:00
Code Issues Projects Releases Wiki Activity GitHub Gitee

small changes; add tavi system

Browse Source
This commit is contained in:
程序员小墨 2021-08-11 13:00:10 +08:00
parent d2811e3d9d
commit c6509fdc25
11 changed files with 265 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
docs/_sidebar.md
View File

@ -1,4 +1,5 @@
- **一、快速开始**
- [1. 简介](/manual/start/introduction)
- [2. 环境要求](/manual/start/requirements)
- [3. 下载安装（需要更新）](/manual/start/install)
@ -12,26 +13,41 @@
- [11. 常见问题](/manual/start/faq)
- **二、使用说明**
- [1. 开始使用（撰写中）](/manual/instructions/start-using)
- **三、接口文档**
- [1. 简介](/manual/api/introduction)
- [2. 全局状态码](/manual/api/status-code)
- [3. 前端Api接口（撰写中）](/manual/api/frontend-interface/overview)
- [通用参数](/manual/api/frontend-interface/General)
- [站点](/manual/api/frontend-interface/Site)
- [管理员](/manual/api/frontend-interface/Admin)
- [用户](/manual/api/frontend-interface/User)
- [单词](/manual/api/frontend-interface/Words)
- [词书](/manual/api/frontend-interface/Wordbooks)
- [通知](/manual/api/frontend-interface/Notice)
- [站点](/manual/api/frontend-interface/Site)
- [管理员](/manual/api/frontend-interface/Admin)
- [用户](/manual/api/frontend-interface/User)
- [单词](/manual/api/frontend-interface/Words)
- [词书](/manual/api/frontend-interface/Wordbooks)
- [通知](/manual/api/frontend-interface/Notice)
- [4. 后端Api接口（待完善）](/manual/api/backend-interface)
- [5. 接口模板](/manual/api/interface-template)
- **四、代码规范**
- **四、规范**
- <span style="font-weight: normal;">标识规范</span>
- [名称规范](/manual/standard/logo-specification/name)
- [视觉形象系统](/manual/standard/logo-specification/tavi)
- [代码规范](/manual/standard/code-specification)
- [隐私安全](/manual/standard/security-specification)
- [【TODO】](/manual/standard/xxx)
- **五、应用开发文档**
- [1. 开始](/manual/app-developer/start)
- [2. 文件及代码结构（待完善）](/manual/app-developer/file-structure)
- [3. 插件开发（待完善）](/manual/app-developer/plugin/overview)
@ -40,30 +56,39 @@
- [7. 下架应用（待完善）](/manual/app-developer/downshelf)
- **六、关于**
<!-- 关于我们 -->
<!-- 关于我们 -->
- [关于我们](/manual/about/about-us)
- [联系我们](/manual/about/contact)
- [开发团队 & 参与贡献者名单](/manual/about/contributors)
-
<!-- 关于项目 -->
<!-- 关于项目 -->
- [发行版本](/manual/about/version/release)
- [更新日志](/manual/about/version/changelog)
- [特别鸣谢](/manual/about/acknowledgement)
- [使用的开源组件列表](/manual/about/open-source-project)
- [法律声明及服务协议](/manual/about/license/README)
- <span style="font-weight: normal;">法律声明及服务协议</span>
- [开源许可证 GPL-3.0](/manual/about/license/GPL-3.0)
- [更好的理解 GPL-3.0](/manual/about/license/have-a-better-understanding-of-GPL-3.0)
- 法律声明 policy
- <span style="font-weight: normal;">法律声明 policy</span>
- [版权声明 Copyright](/manual/about/policy/copyright)
- [免责声明 Disclaimer](/manual/about/policy/disclaimer)
- 服务协议 agreement
- <span style="font-weight: normal;">服务协议 agreement</span>
- [服务条款 Terms of use](/manual/about/agreement/terms-of-use)
- [隐私政策 Privacy policy](/manual/about/agreement/privacy-policy)
- [使用的第三方接口](/manual/about/third-party-interface)
- **七、内部开发文档**
- **八、其他**
- [TODO](/manual/todo)
- [test](/manual/test)

88
docs/include/tavi/backcolor/index.html Normal file
View File

@ -0,0 +1,88 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title></title>
<style>
.hidden {
display: none;
}
.contentbox {
display: inline-block;
vertical-align: top;
margin-right: 50px;
}
</style>
</head>
<body>
<button onclick="window.location.href=window.location.href">恢复默认值</button>
<div>
<div class="contentbox">
<h1>效果展示</h1>
<img src="./logo.png" id="logo" />
</div>
<div class="contentbox">
<h1>参数调整</h1>
<p>
颜色： <input id="bkcolor_input" type="color" value="#4F3730" onchange="colorChanged(this.value)">
</p>
<p>
圆角： <input id="fillet_input" type="range" value="70.3" min="0" max="100" step="0.01" onchange="radiusChanged(this.value)">
</p>
<p class="hidden">
大小(px)： <input id="size_input" type="range" value="220" min="1" max="1000" step="1" onchange="radiusChanged(this.value)">
</p>
</div>
<div class="contentbox">
<h1>当前参数</h1>
<p>
颜色： <span id="bkcolor_display"></span><br>
</p>
<p>
圆角： <span id="fillet_display"></span><br>
</p>
<p class="hidden">
大小(px)： <span id="size_display"></span><br>
</p>
</div>
</div>
<script>
console.log(document.getElementById('logo').style)
var logo = document.getElementById('logo')
// 背景颜色
var bkcolor_input = document.getElementById("bkcolor_input")
var bkcolor_display = document.getElementById("bkcolor_display")
function colorChanged(val) {
logo.style.backgroundColor=val
bkcolor_display.innerHTML = val + " | " + logo.style.backgroundColor
}
// 圆角
var fillet_input = document.getElementById("fillet_input")
var fillet_display = document.getElementById("fillet_display")
function radiusChanged(val) {
logo.style.borderRadius=val/2+"%"
fillet_display.innerHTML = val + "%"
}
// 大小
var size_input = document.getElementById("size_input")
var size_display = document.getElementById("size_display")
function lengthChanged(val) {
logo.style.width=val+"px"
size_display.innerHTML = val + "px"
}
// 刷新
setInterval(function () {
colorChanged( document.getElementById("bkcolor_input").value )
radiusChanged( document.getElementById("fillet_input").value )
lengthChanged( document.getElementById("size_input").value )
}, 60)
</script>
</body>
</html>

BIN
docs/include/tavi/backcolor/logo.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 45 KiB

20
docs/index.html
View File

@ -161,6 +161,20 @@
);
});
},
// 资源对象获取真实地址
function(hook, vm) {
var assetsOriginURL = "https://gitee.com/tawords/assets/raw/master"
hook.doneEach(function() {
var assetsObject = document.getElementsByClassName('assetsObject');
for(var i=0;i < assetsObject.length; i++)
{
let objectpath = assetsObject[i].getAttribute("objectpath");
if(!!objectpath)
assetsObject[i].setAttribute("src", assetsOriginURL+objectpath)
}
});
},
// 添加footer
// function(hook) {
@ -345,5 +359,11 @@
<!-- 阅读进度条插件(与滚动右侧文档左侧对应子目录激活有冲突) -->
<!-- <script src="https://cdn.jsdelivr.net/npm/docsify-progress@latest/dist/progress.min.js"></script> -->
<!-- <script src="static/docsify/lib/plugins/docsify-progress@1.0.3/progress.js"></script> -->
<!-- 代码高亮 -->
<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-bash.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-sql.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-php.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-json.min.js"></script>
</body>
</html>

1
docs/manual/about/license/README.md
View File

@ -1 +0,0 @@
### 点击左侧菜单以继续 <!-- {docsify-ignore} -->

2
docs/manual/standard/3. 通用规范.md
View File

@ -1,2 +0,0 @@
为避免重复及便于识别，应用名中不能出现特殊字符，应用识别名须遵循驼峰式书写规范，只能包含`大小写字母`和下划线`_`，应用目录名为应用识别名，定义的所有函数需要以应用识别名加`_`作为前缀；
所有目录及文件名，全部小写，不得出现大写字母；

9
docs/manual/standard/1. 本项目遵循的注释规范.md → docs/manual/standard/code-specification.md
View File

@ -1,3 +1,12 @@
## 命名规范（待定）
为避免重复及便于识别，应用名中不能出现特殊字符，应用识别名须遵循驼峰式书写规范，只能包含`大小写字母`和下划线`_`，应用目录名为应用识别名，定义的所有函数需要以应用识别名加`_`作为前缀；
所有目录及文件名，全部小写，不得出现大写字母；
## 注释规范 Annotation specification（待定）
> `@since` 表示从那个版本开始就有这个类/接口/方法
> `@deprecated` 表示不建议使用该类/接口/方法
> `@exception` 标注Runtime异常

9
docs/manual/standard/logo-specification/name.md Normal file
View File

@ -0,0 +1,9 @@
## 名称规范 <!-- {docsify-ignore} -->
| 名称指代 | 中文 | 备注 | 英文 | 备注 |
| -------------------------------------- | -------------------------- | ---------------------- | --------------------- | ------------------------------------------------------------ |
| 项目的中（英）文名称<br />项目中的产品 | 背Ta单词 | 注意英文字母的大小写 | tawords | 一般全小写，与语法、命名规范等冲突时，可写为Tawords或TAWORDS |
| 项目开发团队名称 | 背Ta团队、背Ta单词开发团队 | 注意不是“背Ta单词团队” | tawords team | 一般全小写，与语法、命名规范等冲突时，可写为Tawords Team或TAWORDS TEAM |
| 项目中的产品标识 | 背Ta团队荣誉出品 | - | tawords team products | 一般全小写，与语法、命名规范等冲突时，可写为Tawords Team Products或TAWORDS TEAM PRODUCTS |
| 代码中应用识别名 | - | - | bta | 一般全小写或全大写，例如 $bta , BTA_PATH , bta_user |

96
docs/manual/standard/logo-specification/tavi.md Normal file
View File

@ -0,0 +1,96 @@
## 视觉形象系统 <!-- {docsify-ignore} -->
为了体现出更好的视觉形象，更有利于视觉形象传播，同时更能展现出项目团队精神，特此研发**背Ta单词视觉形象识别系统**（**Tawords Visual Identity System**，简称“**TAVI**”）。
TAVI由背Ta团队负责人设计研发，分为基础板块（Ⅰ）和应用板块（Ⅱ）两大板块。以规范、实用为基本原则，对项目中使用到的及未来将可能使用到的各类相关标识进行整体设计，规范项目形象特征，完善标识使用规范。
> **基础板块**包括背Ta单词项目标志（LOGO）、标准字体、标准色彩、标志组合、辅助图形、禁用组合和专用字体。包含了基础设计要素及其规范使用形式。
>
> **应用板块**是基础部分在前端设计与项目宣传等方面使用示例。
TAVI适用于背Ta单词项目开发宣传中的各个环节，提供部分原图下载，欢迎大家在本视觉形象系统的约束下规范使用。
# （以下内容待完善） <!-- {docsify-ignore} -->
# Ⅰ. 基础板块
## 项目标志（logo）
[logo](../../../include/tavi/backcolor ':include :type=iframe width=100% height=600px')
<nobr>
<style>
.filletSample {
width: 30px;
height: 30px;
}
</style>
### 圆角
| 圆角 | 圆角半径 ÷ ½边长<br />（百分比） | 示例 |
| ------------------- | -------------------------------- | ------------------------------------------------------------ |
| fillet0（圆形） | 0% | <img class="assetsObject filletSample" objectPath="/v1/tavi/logo/sample/fillet/fillet0.png"> |
| fillet1 | 11.1% | <img class="assetsObject filletSample" objectPath="/v1/tavi/logo/sample/fillet/fillet1.png"> |
| fillet2 | 33.3% | <img class="assetsObject filletSample" objectPath="/v1/tavi/logo/sample/fillet/fillet2.png"> |
| fillet3 | 55.2% | <img class="assetsObject filletSample" objectPath="/v1/tavi/logo/sample/fillet/fillet3.png"> |
| **fillet4（默认）** | **70.3%** | <img class="assetsObject filletSample" objectPath="/v1/tavi/logo/sample/fillet/fillet4.png"> |
| fillet5 | 82.5% | <img class="assetsObject filletSample" objectPath="/v1/tavi/logo/sample/fillet/fillet5.png"> |
| fillet6（正方形） | 100% | <img class="assetsObject filletSample" objectPath="/v1/tavi/logo/sample/fillet/fillet6.png"> |
<style>
.colorSample {
width: 40px;
height: 20px;
display: inline-block;
border: solid 1px black;
vertical-align: middle;
margin-top: 2px;
margin-bottom: 2px;
}
</style>
### 背景色
下列背景色为推荐颜色，推荐使用下列标准颜色码。
在下方颜色无法满足实际需求时，可以自定义背景色，但需要满足：①背景颜色不允许过浅或白色；②背景颜色不允许过亮过鲜艳。
| 颜色 | 示例 | 十六进制颜色码 | RGB颜色 |
| ---------------------- | ------------------------------------------------------------ | ----------------------------------------------------------- | ------------------------------------------------------------ |
| **棕色（标准色）** | <div class="colorSample" style="background-color: #4f3730;"></div> | #4F3730 | (79, 55, 48) |
| 黄色 | <div class="colorSample" style="background-color: #FFCF00;"></div> | #FFCF00 | (255, 207, 0) |
| 紫色 | <div class="colorSample" style="background-color: #5F52A0;"></div> | #5F52A0 | (95, 82, 160) |
| | <div class="colorSample" style="background-color: #8957A1;"></div> | #8957A1 | (137, 87, 161) |
| 浅紫色 | <div class="colorSample" style="background-color: #8F82BC;"></div> | #8F82BC | (143, 130, 188) |
| | <div class="colorSample" style="background-color: #8C97CB;"></div> | #8C97CB | (140, 151, 203) |
| | <div class="colorSample" style="background-color: #88ABDA;"></div> | #88ABDA | (136, 171, 218) |
| 蓝色 | <div class="colorSample" style="background-color: #556FB5;"></div> | #556FB5 | (85, 111, 181) |
| | <div class="colorSample" style="background-color: #00B7EE;"></div> | #00B7EE | (0, 183, 238) |
| 浅蓝色 | <div class="colorSample" style="background-color: #7ECEF4;"></div> | #7ECEF4 | (126, 206, 244) |
| 粉色 | <div class="colorSample" style="background-color: #F19EC2;"></div> | #F19EC2 | (241, 158, 194) |
| | <div class="colorSample" style="background-color: #F29C9F;"></div> | #F29C9F | (242, 156, 159) |
| 青色 | <div class="colorSample" style="background-color: #84CCC9;"></div> | #84CCC9 | (132, 204, 201) |
| 浅绿色 | <div class="colorSample" style="background-color: #89C997;"></div> | #89C997 | (137, 201, 151) |
| 绿色 | <div class="colorSample" style="background-color: #32B16C;"></div> | #32B16C | (50, 177, 108) |
| 橙色 | <div class="colorSample" style="background-color: #F8B551;"></div> | #F8B551 | (248, 181, 81) |
| 橙红色 | <div class="colorSample" style="background-color: #EC6941;"></div> | #EC6941 | (236, 105, 65) |
| | <div class="colorSample" style="background-color: #FFFFFF;"></div> | #FFFFFF | () |
| | <div class="colorSample" style="background-color: #FFFFFF;"></div> | #FFFFFF | () |
| | <div class="colorSample" style="background-color: #FFFFFF;"></div> | #FFFFFF | () |
| | <div class="colorSample" style="background-color: #FFFFFF;"></div> | #FFFFFF | (, , ) |
| 黑色 <br />👇<br />灰色 | <div class="colorSample" style="background-color: #000000;"></div> <div class="colorSample" style="background-color: #313131;"></div><br /><div class="colorSample" style="background-color: #434343;"></div> <div class="colorSample" style="background-color: #535353;"></div><br /><div class="colorSample" style="background-color: #626262;"></div> <div class="colorSample" style="background-color: #7D7D7D;"></div> | #000000 # #313131<br />#434343 #535353<br />#626262 #7D7D7D | (0, 0, 0) (49, 49, 49)<br />(67, 67, 67) (83, 83, 83)<br />(98, 98, 98) (125, 125, 125) |
</nobr>
# Ⅱ. 应用板块

7
docs/manual/standard/注册、登录时密码使用的加密技术.md → docs/manual/standard/security-specification.md
View File

@ -1,10 +1,13 @@
# 登录：
## 注册、登录时密码使用的加密技术
### 登录
> 使用`密码加盐`生成不可逆哈希，**他人无法获取密码原文**。
```javascript
md5.hex(pwd + md5.hex(pwd));
```
# 注册：
### 注册
> 使用密码倒序`Base64`加密，再倒序`Base64`加密，避免密码在网上裸奔。
```javascript
Base64.encode(Base64.encode(pwd.split('').reverse().join('')).split('').reverse().join(''));

0
docs/manual/standard/2. 注释规范.md → docs/manual/清单 ToDo/2. 注释规范.md
View File