diary 插件说明文档

插件简介

diary 插件是基于 Webman 框架开发的个人日记管理系统，前端采用 jQuery 和 Bootstrap，页面模板引擎为 Blade。该插件支持日记的增删改查、标签管理、搜索、分页等常用功能，适合个人或团队日常记录与管理。

功能介绍

• 日记管理

  • 新增、编辑、删除日记
  • 支持富文本编辑
  • 日记内容支持标签分类
  • 支持按日期、标签、关键词搜索
  • 日记列表分页显示

• 标签管理

  • 新增、编辑、删除标签
  • 标签与日记关联

• 用户体验

  • 响应式布局，适配 PC 和移动端
  • 友好的交互界面，基于 Bootstrap 设计
  • 所有接口统一返回格式，便于前端处理

• 权限与安全

  • 支持用户登录后操作（如有集成用户系统）

安装与部署

1. 将 plugin/diary 目录放入 Webman 项目的 plugin 目录下。
2. 执行数据库安装脚本 install.sql，创建所需数据表。
3. 如有 blade 模板缓存或配置变更，重启 webman 服务。

目录结构说明

plugin/diary/
├── app/           # 控制器、模型、服务等后端代码
├── api/           # API 路由与接口
├── public/        # 静态资源（js/css/images）
├── config/        # 插件配置文件
├── diary.tsx      # 前端主页面（如有）
├── install.sql    # 数据库安装脚本
├── uninstall.sql  # 数据库卸载脚本
└── readme.md      # 插件说明文档

二次开发说明

1. 后端扩展

• 控制器、模型、服务等代码位于 app/ 目录，遵循 webman 目录规范。
• Blade 模板文件可在 app/view/ 下自定义扩展。
• 可参考 plugin/user 的接口和页面写法，注意本插件统一使用 blade 模板。
• 所有接口返回格式为：

  return json(['code' => $code, 'data' => $data, 'msg' => $msg]);

  • 成功时 $code=0，失败时 $code=1，HTTP 状态码始终为 200。

2. 前端扩展

• 前端页面基于 jQuery 和 Bootstrap，无需 npm 工具链，直接在 public/ 目录下维护静态资源。
• 可在 diary.tsx 或 blade 模板中扩展页面功能。
• 如需自定义样式或交互，建议在 public/css/ 和 public/js/ 下新增文件。

3. 数据库扩展

• 数据表结构定义在 install.sql，如需扩展字段请同步修改模型和相关 SQL。
• 卸载插件可执行 uninstall.sql。

4. 配置扩展

• 插件配置文件位于 config/ 目录，可根据需要增加自定义配置项。

常见问题

• Blade 模板缓存问题：如修改了 blade 模板但页面未更新，请清理缓存或重启 webman。
• 接口返回格式：所有接口返回格式固定，前端统一处理，无需关注 HTTP 状态码。

联系与支持

如有问题或建议，欢迎提交 issue 或联系开发者。
邮箱：1037547965@qq.com

如需进一步细化某一部分内容，请告知你的具体需求！