mirror of
https://gitee.com/tawords/tawords-docs
synced 2025-11-06 07:03:09 +08:00
较大变动
This commit is contained in:
2
docs/manual/app-developer/downshelf.md
Normal file
2
docs/manual/app-developer/downshelf.md
Normal file
@@ -0,0 +1,2 @@
|
||||
## 申请下架应用（待完善）
|
||||
|
||||
80
docs/manual/app-developer/file-structure.md
Normal file
80
docs/manual/app-developer/file-structure.md
Normal file
@@ -0,0 +1,80 @@
|
||||
## 下载应用模板
|
||||
|
||||
| 主题模板 | 插件模板 |
|
||||
| ---------------------- | ---------------------- |
|
||||
| [点击下载]()【待完善】 | [点击下载]()【待完善】 |
|
||||
|
||||
|
||||
|
||||
## 文件结构
|
||||
|
||||
```conf
|
||||
/path/system/theme/themeName
|
||||
|
||||
screenshot.png [必需]缩略图（500×400像素）；
|
||||
intro.json [必需]自述文件【该文件由系统生成】；
|
||||
README.md [不需要]应用开发模板说明文件，可以删除。
|
||||
|
||||
—————————————— 下面的待更新 ——————————————
|
||||
|
||||
main.php [可选]应用内置管理页，在创建主题时填写才会生成；
|
||||
include.php [可选]应用嵌入页，在创建主题时填写才会生成；
|
||||
|
||||
include [可选]主题自带「文件模块」，使用{module:abc}「嵌入调用」该目录下的abc.php文件；
|
||||
script [可选]JS目录；
|
||||
style [必需]样式目录, 内存样式表及所需图片；
|
||||
style.css [必需]不限于这个文件名，一套主题也可以拥有多个样式（各自独立使用）；
|
||||
|
||||
css [可选]并不会自动创建，用于不应该放在style文件夹中的样式内容；
|
||||
template 用于存放模板文件；建议优先确立以下 6 个模板文件及内容；
|
||||
index.php 首页及列表页
|
||||
single.php 文章页(单页)
|
||||
search.php 搜索结果页，不存在时使用index.php
|
||||
header.php 公共头部文件
|
||||
footer.php 公共尾部文件
|
||||
404.php 建议设置
|
||||
```
|
||||
|
||||
|
||||
|
||||
## 应用配置文件
|
||||
|
||||
### intro.json
|
||||
|
||||
> 注意：建议使用工具生成或修改该文件。如果手动修改，特殊字符或符号可能会导致JSON解析失败。
|
||||
>
|
||||
> [点击使用工具]()【待完善】
|
||||
|
||||
```
|
||||
{
|
||||
"plug": {
|
||||
"plugId": "应用Id [必填]",
|
||||
"name": "应用名称 [必填]",
|
||||
"description": "应用简介 [必填]",
|
||||
"pubDate": "发布日期，格式：2022-01-01 [必填]",
|
||||
"update": "升级时间，格式：2022-01-01 [必填]",
|
||||
"version": "版本号，格式：“1.0.0”或“1.0”。请严格按照格式填写，以免用户无法正常升级 [必填]",
|
||||
"adapted": "最低兼容的系统版本数字代号（可在文档 关于 版本信息 发行版本 找到），此处请填写数字，不要填写字符串 [必填]",
|
||||
"screenShot": "./preview.png 主题的缩略图所在相对路径 [必填]"
|
||||
},
|
||||
"author": {
|
||||
"authorId": "作者Id，后台创建应用时生成 [必填]",
|
||||
"name": "作者姓名 [必填]",
|
||||
"email": "作者邮箱 [选填]",
|
||||
"url": "作者网站 [选填]"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
| 字段 | 说明 / 格式 | 是否必填 | intro.json |
|
||||
| -------- | -------------- | ---------------------------- | ---------------------------- |
|
||||
| 应用Id | 创建应用时生成 | 必填 | plug.plugId |
|
||||
| 应用名称 | | 必填 | plug.name |
|
||||
| 应用简介 | | | plug.description |
|
||||
| | | | plug.update |
|
||||
| | | | plug.version |
|
||||
| | | | plug.adapted |
|
||||
| | | | plug.screenShot |
|
||||
| | | | plug. |
|
||||
| | | | |
|
||||
|
||||
1
docs/manual/app-developer/plugin/overview.md
Normal file
1
docs/manual/app-developer/plugin/overview.md
Normal file
@@ -0,0 +1 @@
|
||||
### （待完善）
|
||||
99
docs/manual/app-developer/release-and-update.md
Normal file
99
docs/manual/app-developer/release-and-update.md
Normal file
@@ -0,0 +1,99 @@
|
||||
## 发布应用
|
||||
|
||||
> 在编写并测试好代码后，可以将应用上传至应用中心进行审核。审核通过后即可发布。
|
||||
>
|
||||
> 应用期将视应用中心实际情况适时开发上线。
|
||||
|
||||
|
||||
|
||||
以下是发布应用的流程。
|
||||
|
||||
### 1. 成为开发者
|
||||
|
||||
成为开发者的条件：①有开发者账号；②绑定手机号；③等待通过审核
|
||||
|
||||
首先，你需要注册一个开发者应用账号。
|
||||
|
||||
然后，在用户中心绑定您的手机号，并完善账户信息。
|
||||
|
||||
最后，点击提交审核按钮，等待审核通过。审核期间，您可以上传应用以及配置相关信息，也可同时提交应用审核，但只有审核通过后，你的应用才可以发布至应用中心。
|
||||
|
||||
> **请注意，账号一旦注册，用户名等账户重要信息暂时不可修改。所以注册账号时一定要想好。**
|
||||
|
||||
> 根据《互联网用户账号名称管理规定》等相关规定，您只有绑定手机号才可以进行后续操作。
|
||||
|
||||
|
||||
|
||||
### 2. 在后台创建一个应用
|
||||
|
||||
创建应用后，系统会为你生成一个**应用ID**（`plugId`）和**应用密钥**（`plugSecret`）。`plugSecret`将只显示一次，请保存好这两个密钥，如果您忘记了，则需要重置`plugSecret`
|
||||
|
||||
- `plugId`用于唯一标识应用。在用户下载应用，或者更新应用的时候会用到。该值由系统生成，无法修改。
|
||||
- `plugSecret`的用处还没想好，但是是有用的【待更新】
|
||||
|
||||
> **请一定保管好plugSecret，不要泄露给任何人！如果已发生泄露，请立即重置plugSecret**
|
||||
|
||||
|
||||
|
||||
### 3. 上传你的应用
|
||||
|
||||
根据页面提示上传您的应用。
|
||||
|
||||
上传应用后，应用信息将默认使用`intro.json`文件中的信息。如需修改，可修改`intro.json`文件，然后重新上传。
|
||||
|
||||
> `intro.json`编写规范请[查看这里]()【待完善】
|
||||
|
||||
|
||||
|
||||
- 应用发布日期（与配置文件中`pubDate`保持一致，且不能填写还未到的日期，一旦首次审核通过，将不能更改）
|
||||
- 选择你的应用风格
|
||||
-
|
||||
- 上传应用缩略图
|
||||
-
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### 4. 阅读并同意应用中心相关条款
|
||||
|
||||
在认真阅读并同意应用中心服务协议、隐私政策等条款内容后，勾选“我已阅读并同意上述条款”，然后点击下一步。
|
||||
|
||||
|
||||
|
||||
### 5. 提交审核
|
||||
|
||||
确认应用信息填写无误后，即可提交审核。
|
||||
|
||||
> 第一次审核通过日期显示为<u>应用发布日期</u>，开发者无法手动修改。
|
||||
|
||||
若审核未通过，您可以根据提示信息修改对应信息，并再次提交。
|
||||
|
||||
> 请注意，若审核未通过，请修改后再次提交。请不要不经修改反复提交。否则您的账号将可能受到相应处罚，甚至封号。
|
||||
|
||||
|
||||
|
||||
## 应用更新
|
||||
|
||||
主题更新时，你需要做以下几步：
|
||||
|
||||
上传新的主题包，填写更新说明，并提交审核
|
||||
|
||||
### 1.上传新的应用包
|
||||
|
||||
登录后台，选择账号中需要更新的应用，然后点击修改。
|
||||
|
||||
|
||||
|
||||
### 2. 填写更新说明
|
||||
|
||||
上传应用包后，填写版本更新说明。
|
||||
|
||||
如果需要修改应用的其他信息，也可在当前页一并更改，更改后提交即可。
|
||||
|
||||
|
||||
|
||||
### 3. 提交审核
|
||||
|
||||
点击提交审核按钮，等待审核结果。
|
||||
|
||||
33
docs/manual/app-developer/start.md
Normal file
33
docs/manual/app-developer/start.md
Normal file
@@ -0,0 +1,33 @@
|
||||
# 创建第一个主题
|
||||
|
||||
> 在开始之前，你需要掌握HTML CSS JavaScript，以及PHP的相关知识。在主题的开发过程中，会涉及到这些知识。本文档是基于你已经掌握这些知识的基础上撰写的。
|
||||
|
||||
让我们开始吧。
|
||||
|
||||
|
||||
|
||||
## 应用介绍
|
||||
|
||||
- 应用分为主题和插件；
|
||||
- 可以同时启用多个应用（但是需要考虑是否兼容）；
|
||||
- 按照规范组织目录结构；
|
||||
- 在后台统一安装、删除、启用、关闭；
|
||||
- 「自述文件」为 `intro.json`；
|
||||
- 应用放置目录为 `/system`；
|
||||
|
||||
|
||||
|
||||
### 主题
|
||||
|
||||
- 主题是网站前端的显示效果，同时只能启用一个主题；
|
||||
- 通过提供的统一接口获取需要显示的内容；
|
||||
- 主题可以内置1个应用（也可不内置），对主题的能力进行扩展，启用状态与主题保持一致；
|
||||
- 所在目录为 `/system/plugin`；
|
||||
|
||||
|
||||
|
||||
### 插件
|
||||
|
||||
- 主要作用为扩展网站的某项功能；
|
||||
- 可以同时启用多个应用（但是需要考虑是否兼容）；
|
||||
- 所在目录为 `/system/plugin`；
|
||||
1
docs/manual/app-developer/theme/overview.md
Normal file
1
docs/manual/app-developer/theme/overview.md
Normal file
@@ -0,0 +1 @@
|
||||
如果有页面在当前主题中不存在，将使用默认页面展示。
|
||||
Reference in New Issue
Block a user