1
0
mirror of https://gitee.com/tawords/tawords-docs synced 2025-01-11 03:48:14 +08:00
Code Issues Projects Releases Wiki Activity GitHub Gitee
tawords-docs/docs/manual/app-developer/file-structure.md

81 lines
3.3 KiB
Markdown
Raw Normal View History

2021-08-07 15:56:20 +08:00
## 下载应用模板
| 主题模板 | 插件模板 |
| ---------------------- | ---------------------- |
| [点击下载]()【待完善】 | [点击下载]()【待完善】 |
## 文件结构
```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. |
| | | | |