941 lines
48 KiB
TypeScript
941 lines
48 KiB
TypeScript
/*
|
||
* 各功能的新手帮助文档：上方时间轴讲操作流程，下方网格讲功能点与图标含义。
|
||
*
|
||
* 维护方式：按「功能英文名 FunctionName」注册一份 HelpDoc，
|
||
* 由 HelpTimelineModal 统一渲染。
|
||
*
|
||
* ============================ 极其重要 ============================
|
||
* icon 字段必须照抄页面上真实使用的那个图标，绝不能凭想象另配一套，
|
||
* 否则用户拿着帮助文档去页面上根本找不到对应的按钮。
|
||
* 以 "icon-" 开头 → 项目自定义 iconfont（如预览 icon-qingbaojiankong）
|
||
* 其余 → Ant Design 官方图标组件名（如 DeleteOutlined）
|
||
* color 同理，用于还原页面上的真实颜色（如红色的垃圾桶）。
|
||
*
|
||
* 取值来源（改动前请先回这几处核对）：
|
||
* Toolbar.vue 返回顶层 / 返回上层 / 刷新 / 面包屑
|
||
* OperatorStation.vue 云盘各个操作按钮
|
||
* OperatorStationDelete.vue 回收站的还原 / 下载 / 彻底删除
|
||
* MyComputer.vue 文件列表中的文件夹与各类文件图标
|
||
* VideoPlayer.vue 视频播放器的播放、全屏、音量等
|
||
* 以及各功能页自身顶部的查询 / 重置 / 新增三件套与底部操作区。
|
||
* ==================================================================
|
||
*/
|
||
|
||
export interface HelpStep {
|
||
/** 步骤标题（先做什么） */
|
||
title: string;
|
||
/** 这一步具体怎么做 */
|
||
desc: string;
|
||
/** 补充说明，可不填 */
|
||
tips?: string;
|
||
/** 图标：antd 组件名或 icon- 开头的 iconfont 名，需与页面上一致 */
|
||
icon?: string;
|
||
}
|
||
|
||
export interface HelpFeature {
|
||
/** 图标：antd 组件名或 icon- 开头的 iconfont 名，需与页面上一致 */
|
||
icon?: string;
|
||
/**
|
||
* 页面上的真实颜色，例如文件夹黄 #faad14、彻底删除红。
|
||
* 不填则跟随分组主题色。
|
||
*/
|
||
color?: string;
|
||
/** 功能点名称，一般就是按钮上的字 */
|
||
name: string;
|
||
/** 作用说明 */
|
||
desc: string;
|
||
}
|
||
|
||
export interface HelpDoc {
|
||
/** 一句话说明这个功能是什么 */
|
||
intro: string;
|
||
/** 操作流程，按顺序执行 */
|
||
steps: HelpStep[];
|
||
/** 页面中各个功能点 / 图标的含义 */
|
||
features: HelpFeature[];
|
||
}
|
||
|
||
/* ==========================================================
|
||
* 各页面通用的三件套与底部操作：查询 / 重置 / 新增、保存 / 取消 / 修改 / 删除
|
||
* 这几个页面顶部和底部的按钮写法完全一致，图标也就复用同一批。
|
||
* ========================================================== */
|
||
|
||
/** 顶部三个按钮：查询 / 重置 / 新增 */
|
||
export const crudHeadFeatures: HelpFeature[] = [
|
||
{ icon: "FileSearchOutlined", name: "查询", desc: "按输入的编号等条件检索对应记录。" },
|
||
{ icon: "ClearOutlined", name: "重置", desc: "清空查询条件与表单，回到待录入状态。" },
|
||
{ icon: "FileAddOutlined", name: "新增", desc: "新建一条空白记录。" },
|
||
];
|
||
|
||
/** 底部四个按钮：修改 / 保存 / 取消 / 删除 */
|
||
export const crudFootFeatures: HelpFeature[] = [
|
||
{ icon: "EditOutlined", name: "修改", desc: "把已有记录切换成可编辑状态。" },
|
||
{ icon: "SaveOutlined", name: "保存", desc: "确认本次录入或修改，真正写入生效。" },
|
||
{ icon: "UndoOutlined", name: "取消", desc: "放弃本次编辑，回到修改前的状态。" },
|
||
{ icon: "DeleteOutlined", color: "red", name: "删除", desc: "移除该条记录，危险操作用红色区分。" },
|
||
];
|
||
|
||
/** 明细行里的三个小图标：上移 / 下移 / 删除 */
|
||
export const rowActionFeatures: HelpFeature[] = [
|
||
{ icon: "UpSquareTwoTone", name: "上移", desc: "调整这条明细在列表中的先后顺序。" },
|
||
{ icon: "DownSquareTwoTone", name: "下移", desc: "与上移相反，往下挪一位。" },
|
||
{ icon: "DeleteOutlined", name: "删除本行", desc: "移除这一条明细，不影响其它记录。" },
|
||
];
|
||
|
||
/* ==========================================================
|
||
* 网盘
|
||
* ========================================================== */
|
||
|
||
/** 云盘 / 回收站共用：顶部路径栏 Toolbar.vue */
|
||
export const toolbarFeatures: HelpFeature[] = [
|
||
{ icon: "HomeOutlined", name: "返回顶层", desc: "回到「我的云盘」根目录。" },
|
||
{ icon: "ArrowLeftOutlined", name: "返回上层", desc: "回到上一级文件夹。" },
|
||
{ icon: "ReloadOutlined", name: "刷新", desc: "重新加载当前目录的内容。" },
|
||
{ icon: "LaptopOutlined", name: "电脑（路径起点）", desc: "面包屑的第一段，代表云盘这台电脑。" },
|
||
{ icon: "FolderOutlined", color: "#faad14", name: "文件夹（路径）", desc: "橙色文件夹图标，每一段都可点击直接跳过去。" },
|
||
];
|
||
|
||
/** MyComputer.vue 中列表里各类文件的图标 */
|
||
export const fileIconFeatures: HelpFeature[] = [
|
||
{ icon: "FolderOutlined", color: "#faad14", name: "文件夹", desc: "橙色的文件夹图标，双击进入。" },
|
||
{ icon: "FileImageOutlined", color: "#52c41a", name: "图片文件", desc: "绿色的图片图标。" },
|
||
{ icon: "VideoCameraOutlined", color: "#1890ff", name: "视频文件", desc: "蓝色的摄像机图标。" },
|
||
{ icon: "PlayCircleOutlined", color: "#eb2f96", name: "音频文件", desc: "粉色的播放圈图标。" },
|
||
{ icon: "FileOutlined", color: "#8c8c8c", name: "其它文件", desc: "灰色的普通文件图标。" },
|
||
{ icon: "UnorderedListOutlined", name: "列表视图", desc: "切换成一排排的列表显示。" },
|
||
{ icon: "AppstoreOutlined", name: "图标视图", desc: "切换成一块块的宫格显示。" },
|
||
];
|
||
|
||
/** 我的云盘：OperatorStation.vue */
|
||
const dmsFileEnquiry: HelpDoc = {
|
||
intro: "「我的云盘」是存放和管理文件的地方：上传自己的文件、建文件夹归类，也能下载、移动。可共享给家人或者发布到相相册展览、音乐厅、影视厅，这些都可以独立授权。",
|
||
steps: [
|
||
{
|
||
title: "进入云盘，认认路",
|
||
desc: "打开后首先看到根目录下的内容，顶部一排小按钮从左到右分别是返回顶层、返回上层、刷新，右边是面包屑路径。",
|
||
icon: "HomeOutlined",
|
||
},
|
||
{
|
||
title: "在文件夹之间来回穿梭",
|
||
desc: "双击橘黄色的文件夹进入下一层；用左箭头返回上层，用小房子直接回到最顶层。",
|
||
icon: "FolderOutlined",
|
||
tips: "顶部的路径每一段都可以直接点击，能一步跳到该层，不用一层层退出来。",
|
||
},
|
||
{
|
||
title: "先把文件传上来",
|
||
desc: "选好目标目录后，点上传按钮（箭头朝上）添加本地文件，或点新建文件夹建立分类目录。",
|
||
icon: "UploadOutlined",
|
||
},
|
||
{
|
||
title: "选中条目再整理",
|
||
desc: "单击选中一个，再点下载、重命名、移动、删除；选中单个文件或多个同一类文件时还能共享和发布。",
|
||
icon: "RotateRightOutlined",
|
||
tips: "「移动」的图标是一个向右旋转的箭头，不要错看成其它意思。",
|
||
},
|
||
{
|
||
title: "共享给授权的家人",
|
||
desc: "选中文件或文件夹后点共享（分享箭头），家庭成员就能在自己的共享中看到它。",
|
||
icon: "ShareAltOutlined",
|
||
tips: "「共享」是快速分享给他人文件的方法之一",
|
||
},
|
||
{
|
||
title: "发布到相册展览、音乐厅、影视厅",
|
||
desc: "选中文件后点发布，不同文件对应发布到相册展览、音乐厅、影视厅，授权家人可看到它。",
|
||
icon: "NotificationOutlined",
|
||
tips: "「发布」是快速分享给他人文件的方法之一",
|
||
},
|
||
],
|
||
features: [
|
||
...toolbarFeatures,
|
||
...fileIconFeatures,
|
||
{ icon: "FolderAddOutlined", name: "新建文件夹", desc: "在当前目录创建一个新的文件夹。" },
|
||
{ icon: "UploadOutlined", name: "上传文件", desc: "把本地文件上传到当前目录。" },
|
||
{ icon: "DownloadOutlined", name: "下载", desc: "把选中的文件保存到本地。" },
|
||
{ icon: "ShareAltOutlined", name: "共享", desc: "分享给家庭成员或群组查看。" },
|
||
{ icon: "NotificationOutlined", name: "发布", desc: "把选中的媒体文件发布到相册 / 音乐 / 视频。" },
|
||
{ icon: "icon-qingbaojiankong", name: "预览", desc: "预览选中的文件（这个是产品自带图标，不是圆形箭头）。" },
|
||
{ icon: "icon-foldervideo", name: "播放视频", desc: "选中单个视频文件时用于直接播放。" },
|
||
{ icon: "PlayCircleOutlined", color: "red", name: "播放 / 暂停音频", desc: "红色播放圈控制音频，播放中点一下变暂停。" },
|
||
{ icon: "EditOutlined", name: "重命名", desc: "修改选中文件或文件夹的名称。" },
|
||
{ icon: "RotateRightOutlined", name: "移动", desc: "把选中项搬到另一个目录，图标是向右旋转箭头。" },
|
||
{ icon: "DeleteOutlined", color: "red", name: "删除", desc: "移到回收站，并没有真正消失，可去回收站还原。" },
|
||
],
|
||
};
|
||
|
||
/** 回收站：OperatorStationDelete.vue，注意它只有三个操作，没有「清空」 */
|
||
const dmsFileDeleteEnquiry: HelpDoc = {
|
||
intro: "「回收站」存放从云盘删除的文件，给误删留一次还原的机会。这里的删除是真的没了，没有第二次机会。",
|
||
steps: [
|
||
{
|
||
title: "打开回收站查看被删内容",
|
||
desc: "进入回收站，列表中显示已删除的文件、删除时间等，便于确认是不是误删的那份。",
|
||
icon: "FolderOutlined",
|
||
},
|
||
{
|
||
title: "确认是否需要找回",
|
||
desc: "先看清文件名和删除时间，选中需要找回的那个文件。",
|
||
icon: "UndoOutlined",
|
||
tips: "还原按钮是绿色的回转箭头，点了之后文件会回到它原来所在的目录。",
|
||
},
|
||
{
|
||
title: "还原到根目录",
|
||
desc: "点绿色还原箭头，文件回到根目录：找回误删文件就这一步。",
|
||
},
|
||
{
|
||
title: "确认无用的再彻底删除",
|
||
desc: "确定彻底不要了，再点红色垃圾桶。这一步不可撤销，执行前请再确认一遍。",
|
||
icon: "DeleteOutlined",
|
||
tips: "回收站并没有「清空」按钮，只能逐条删除；嫌麻烦时更应该在删除前看清楚。",
|
||
},
|
||
],
|
||
features: [
|
||
...toolbarFeatures,
|
||
...fileIconFeatures,
|
||
{ icon: "UndoOutlined", color: "green", name: "还原", desc: "绿色回转箭头，把文件恢复到删除前所在目录。" },
|
||
{ icon: "DownloadOutlined", name: "下载", desc: "把回收站里的文件保存到本地。" },
|
||
{ icon: "DeleteOutlined", color: "red", name: "彻底删除", desc: "红色垃圾桶，永久删除且无法再还原。" },
|
||
{ icon: "icon-foldervideo", name: "播放视频", desc: "选中单个视频文件时用于试看后再决定。" },
|
||
{ icon: "PlayCircleOutlined", color: "red", name: "播放音频", desc: "试听选中的音频文件。" },
|
||
],
|
||
};
|
||
|
||
/* ==========================================================
|
||
* 共享中心
|
||
* ========================================================== */
|
||
|
||
/** 共享中心 */
|
||
const familyGroupShare: HelpDoc = {
|
||
intro: "「共享中心」家族成员能看到授权的文件",
|
||
steps: [
|
||
{
|
||
title: "打开共享中心",
|
||
desc: "进入后列出每条共享记录：群组、共享路径、目录描述一目了然。",
|
||
icon: "TeamOutlined",
|
||
},
|
||
{
|
||
title: "核对共享路径",
|
||
desc: "看橙色文件夹图标旁边显示的路径，确认共享出去的是对的那个目录。",
|
||
icon: "FolderOutlined",
|
||
tips: "路径写成「电脑 > 某层 > 某层」，一级是目录的一层。",
|
||
},
|
||
{
|
||
title: "核对共享范围是否正确",
|
||
desc: "确认共享给了对的人、范围没有过大。",
|
||
tips: "一旦发现共享范围有误，应尽快取消，避免不该看的人看到。",
|
||
},
|
||
{
|
||
title: "取消不再需要的共享",
|
||
desc: "选中对应的共享记录后删除，该群组会立即看不到这个目录。",
|
||
icon: "DeleteOutlined",
|
||
},
|
||
],
|
||
features: [
|
||
{ icon: "TeamOutlined", name: "群组", desc: "共享给谁，按家庭群组为单位。" },
|
||
{ icon: "FolderOutlined", color: "#faad14", name: "共享路径", desc: "橙色文件夹图标显示被共享的目录层级。" },
|
||
{ icon: "DeleteOutlined", color: "red", name: "取消共享", desc: "删除共享记录，成员即刻失去该目录的访问权。" },
|
||
],
|
||
};
|
||
|
||
/** 家庭共享 */
|
||
const familyShareOperation: HelpDoc = {
|
||
intro: "「家庭共享」把云盘中的某个目录共享给指定的家庭群组，让家人能看到这份内容。",
|
||
steps: [
|
||
{
|
||
title: "先确认要共享的目录",
|
||
desc: "回到「我的云盘」确认目标目录已存在、内容正确，这是共享的前置条件。",
|
||
icon: "FolderOutlined",
|
||
tips: "建议先整理好目录内容再共享，避免家人看到半成品。",
|
||
},
|
||
{
|
||
title: "准备好接收方的群组",
|
||
desc: "确认「家庭群组」里已经有对应的群组，且需要看到的家人都在群组内。",
|
||
icon: "TeamOutlined",
|
||
},
|
||
{
|
||
title: "建立共享",
|
||
desc: "在共享功能中指定要共享的目录与接收群组，保存后生成共享记录。",
|
||
},
|
||
{
|
||
title: "检查共享结果",
|
||
desc: "回到家庭群组共享列表，确认这条共享记录已经出现、路径无误。",
|
||
icon: "FileSearchOutlined",
|
||
},
|
||
{
|
||
title: "让对方登录核实",
|
||
desc: "请对方登录自己的账号确认可以看到；看不到时优先检查群组成员是否包含他。",
|
||
},
|
||
],
|
||
features: [
|
||
{ icon: "FolderOutlined", color: "#faad14", name: "被共享目录", desc: "橙色文件夹图标，表示这个目录被共享出去了。" },
|
||
{ icon: "TeamOutlined", name: "群组", desc: "接收方，一次对整个群组授权。" },
|
||
{ icon: "FileTextOutlined", name: "只读共享", desc: "成员只能查看和下载，不能修改或删除原文件。" },
|
||
{ icon: "EditOutlined", name: "可修改共享", desc: "成员可上传和修改，操作会影响原始文件，谨慎开放。" },
|
||
{ icon: "FileSearchOutlined", name: "查询", desc: "按目录名称关键字筛选，定位到某条共享。" },
|
||
],
|
||
};
|
||
|
||
/** 群组管理 */
|
||
const familyGroupOperation: HelpDoc = {
|
||
intro: "「群组」把家庭成员组织成一个个小组，共享时按群组授权，是家庭协作的基础设置。",
|
||
steps: [
|
||
{
|
||
title: "打开群组管理",
|
||
desc: "进入后顶部有查询、重置、新增三个按钮，下方列出已有群组。",
|
||
icon: "FileSearchOutlined",
|
||
},
|
||
{
|
||
title: "点「新增」建立群组",
|
||
desc: "填写群组名称等信息，然后保存。",
|
||
icon: "FileAddOutlined",
|
||
tips: "只有“公开设置”，家族成员才能“申请加入”",
|
||
},
|
||
{
|
||
title: "维护群组成员",
|
||
desc: "成员变动时在群组里增删成员即可，无需重新配置共享。用绿色小人图标把成员加进来。",
|
||
icon: "UserAddOutlined",
|
||
tips: "只有群组成员才能看到共享给该群组的内容，调整成员等于调整可见范围。",
|
||
},
|
||
{
|
||
title: "点「保存」生效",
|
||
desc: "改完一定要点保存；中途反悔点取消放弃本次编辑。",
|
||
icon: "SaveOutlined",
|
||
},
|
||
],
|
||
features: [
|
||
...crudHeadFeatures,
|
||
{ icon: "TeamOutlined", name: "群组", desc: "群组的图标是两个小人。" },
|
||
{ icon: "UserAddOutlined", color: "green", name: "添加成员", desc: "绿色小人加号，把家庭成员加进这个群组。" },
|
||
{ icon: "PlusSquareTwoTone", name: "新增共享目录", desc: "给这个群组添加要共享的目录。" },
|
||
{ icon: "CheckCircleTwoTone", name: "确认", desc: "勾形图标，确认新增或修改。" },
|
||
{ icon: "CloseCircleOutlined", name: "取消本次行修改", desc: "叉形图标，放弃这一行的改动。" },
|
||
{ icon: "DeleteOutlined", color: "red", name: "删除本行", desc: "移除这一条明细。" },
|
||
...crudFootFeatures,
|
||
],
|
||
};
|
||
|
||
/** 群组查询 */
|
||
const familyGroupEnquiry: HelpDoc = {
|
||
intro: "「群组查询」集中查看所有家庭群组的概况，并从这里进入查看、修改与删除。",
|
||
steps: [
|
||
{
|
||
title: "打开群组查询列表",
|
||
desc: "进入后表格列出全部群组及其主要信息。",
|
||
icon: "FileSearchOutlined",
|
||
},
|
||
{
|
||
title: "筛选出目标群组",
|
||
desc: "在顶部输入名称关键字点查询，避免在大列表中翻找。",
|
||
},
|
||
{
|
||
title: "点一行右侧的按钮处理",
|
||
desc: "每行的操作列里有查看（文档图标）、修改（铅笔）、删除（垃圾桶）三个按钮，点其中一个即可。",
|
||
tips: "这里的按钮是逐行点，不需要先勾选整行。",
|
||
},
|
||
],
|
||
features: [
|
||
{ icon: "FileSearchOutlined", name: "查询", desc: "按群组名称关键字筛选。" },
|
||
{ icon: "TeamOutlined", name: "群组列表", desc: "展示群组名称与基本概况。" },
|
||
{ icon: "FileTextOutlined", name: "查看", desc: "文档图标，打开这条群组的详情看看。" },
|
||
{ icon: "EditOutlined", name: "修改", desc: "铅笔图标，编辑这条群组的名称、说明或成员。" },
|
||
{ icon: "DeleteOutlined", color: "red", name: "删除", desc: "红色垃圾桶，移除这条群组。" },
|
||
],
|
||
};
|
||
|
||
/* ==========================================================
|
||
* 相册
|
||
* ========================================================== */
|
||
|
||
/** 发布类页面共用的「公开群组」两个按钮 */
|
||
export const publicGroupFeatures: HelpFeature[] = [
|
||
{ icon: "PlusSquareTwoTone", name: "新增公开群组", desc: "把这条内容授权给某个公开群组查看。" },
|
||
{ icon: "DeleteOutlined", color: "red", name: "移除公开群组", desc: "取消这个群组的查看权。" },
|
||
];
|
||
|
||
/** 相册发布页：顶部大图 + 预览相册 */
|
||
export const photoHeroFeatures: HelpFeature[] = [
|
||
{ icon: "PictureOutlined", name: "相册（顶部大图）", desc: "页面上最显眼的那张图片图标，代表整个相册。" },
|
||
];
|
||
export const photoExtraFeatures: HelpFeature[] = [
|
||
{ icon: "EditOutlined", name: "预览相册", desc: "铅笔图标，切换到相册浏览看看发布后的效果。" },
|
||
];
|
||
|
||
/** 音频发布页：顶部耳机 + 音乐厅 */
|
||
export const audioHeroFeatures: HelpFeature[] = [
|
||
{ icon: "CustomerServiceOutlined", name: "专辑（顶部耳机）", desc: "页面顶部耳机音符图标，代表整张专辑。" },
|
||
];
|
||
export const audioExtraFeatures: HelpFeature[] = [
|
||
{ icon: "EditOutlined", name: "音乐厅", desc: "铅笔图标，切换到黑胶播放器实际听一下效果。" },
|
||
];
|
||
|
||
/** 视频发布页：顶部摄像机 */
|
||
export const videoHeroFeatures: HelpFeature[] = [
|
||
{ icon: "VideoCameraOutlined", name: "专辑（顶部摄像机）", desc: "页面顶部摄像机图标，代表整张视频专辑。" },
|
||
];
|
||
|
||
/** 发布类页面（相册 / 音乐 / 视频）共同的按钮：顶部三件套 + 明细行 + 公开群组 + 底部操作区 */
|
||
export const publishFeatures = (hero: HelpFeature[], extra: HelpFeature[] = []): HelpFeature[] => [
|
||
...crudHeadFeatures,
|
||
...hero,
|
||
...rowActionFeatures,
|
||
...publicGroupFeatures,
|
||
...extra,
|
||
...crudFootFeatures,
|
||
];
|
||
|
||
/** 相册浏览：页面上只有左右两个圆形箭头可点 */
|
||
const preview: HelpDoc = {
|
||
intro: "「相册浏览」查看已发布的照片：进入后是整页的大图，用左右两个圆形箭头依次翻看。",
|
||
steps: [
|
||
{
|
||
title: "进入相册浏览",
|
||
desc: "打开后直接看到当前相册里的照片，整页显示，背景是暗色。",
|
||
icon: "PictureOutlined",
|
||
},
|
||
{
|
||
title: "用左右箭头翻照片",
|
||
desc: "点左侧的「左圆圈箭头」看上一张，点右侧的「右圆圈箭头」看下一张。",
|
||
icon: "RightCircleOutlined",
|
||
tips: "键盘上的左右方向键也能翻，比点按快得多。",
|
||
},
|
||
{
|
||
title: "看完直接离开",
|
||
desc: "这一页没有专门的关闭按钮，用浏览器的返回即可回到进入前的页面。",
|
||
},
|
||
],
|
||
features: [
|
||
{ icon: "LeftCircleOutlined", name: "上一张", desc: "页面左侧的圆形左箭头。" },
|
||
{ icon: "RightCircleOutlined", name: "下一张", desc: "页面右侧的圆形右箭头。" },
|
||
{ icon: "PictureOutlined", name: "照片", desc: "整页显示的就是当前这张照片。" },
|
||
],
|
||
};
|
||
|
||
/** 相册发布 */
|
||
const publishPhotoOperation: HelpDoc = {
|
||
intro: "「相册发布」把本地照片整理成一个相册并发布；发布后照片才会出现在相册浏览里。",
|
||
steps: [
|
||
{
|
||
title: "点「新增」建立相册",
|
||
desc: "点放大镜旁边的新建文件图标，进入可编辑状态，开始录入一个新相册。",
|
||
icon: "FileAddOutlined",
|
||
},
|
||
{
|
||
title: "填写相册信息",
|
||
desc: "最左边是张图片图标，代表整个相册；右边填写相册名称、描述等，编号由系统给出不用自己填。",
|
||
icon: "PictureOutlined",
|
||
tips: "公开与否决定家人以外的人能否看到，不确定时先不公开。",
|
||
},
|
||
{
|
||
title: "选择并上传照片",
|
||
desc: "在明细区域逐张上传本地图片，用上下箭头调整照片的先后顺序。",
|
||
icon: "UploadOutlined",
|
||
tips: "建议先压缩过大的照片，上传更快也更省空间。",
|
||
},
|
||
{
|
||
title: "点「保存」发布",
|
||
desc: "确认信息无误后点保存（软盘图标）；中途反悔点取消（回转箭头）放弃。",
|
||
icon: "SaveOutlined",
|
||
},
|
||
{
|
||
title: "到相册浏览核实效果",
|
||
desc: "发布完成后去相册浏览查看，用左右箭头翻一遍，确认照片能正常显示、顺序正确。",
|
||
icon: "RightCircleOutlined",
|
||
},
|
||
],
|
||
features: publishFeatures(photoHeroFeatures, photoExtraFeatures),
|
||
};
|
||
|
||
/** 照片查询 */
|
||
const publishPhotoEnquiry: HelpDoc = {
|
||
intro: "「照片查询」集中查看自己发布过的相册与照片，便于批量核对和整理。",
|
||
steps: [
|
||
{
|
||
title: "打开照片查询列表",
|
||
desc: "进入后表格列出全部已发布的照片 / 相册记录。",
|
||
icon: "FileSearchOutlined",
|
||
},
|
||
{
|
||
title: "筛选出目标记录",
|
||
desc: "在顶部输入相册编号或名称点查询，直接定位到该条记录。",
|
||
},
|
||
{
|
||
title: "点右侧按钮处理",
|
||
desc: "每行的操作列里有文档图标（查看）、铅笔（修改）、红色垃圾桶（删除）。",
|
||
},
|
||
],
|
||
features: [
|
||
{ icon: "FileSearchOutlined", name: "查询", desc: "按编号或名称关键字筛选。" },
|
||
{ icon: "PictureOutlined", name: "照片 / 相册列表", desc: "展示名称、编号、发布时间等主要信息。" },
|
||
{ icon: "FileTextOutlined", name: "查看", desc: "文档图标，打开这条记录的详情。" },
|
||
{ icon: "EditOutlined", name: "修改", desc: "铅笔图标，编辑这条相册 / 照片。" },
|
||
{ icon: "DeleteOutlined", color: "red", name: "删除", desc: "移除后浏览端同步消失。" },
|
||
],
|
||
};
|
||
|
||
/* ==========================================================
|
||
* 音乐
|
||
* ========================================================== */
|
||
|
||
/** 音乐播放：VinylAudioPlayer.vue（黑胶唱片播放器） */
|
||
const previewAudio: HelpDoc = {
|
||
intro: "「音乐」用来收听已发布的音频：进入后是一台黑胶唱片机，唱片转起来就在放歌了。",
|
||
steps: [
|
||
{
|
||
title: "进入音乐播放",
|
||
desc: "打开后自动加载默认专辑中的曲目，中间的黑胶唱片就是当前这首歌。",
|
||
icon: "CustomerServiceOutlined",
|
||
},
|
||
{
|
||
title: "控制播放",
|
||
desc: "唱片下方一整排：左边循环/随机切换模式，往右是上一首、播放（三角）、下一首、播放列表。",
|
||
icon: "CaretRightFilled",
|
||
tips: "播放中的按钮会变成暂停（两竖杠），点一下停住，再点继续。",
|
||
},
|
||
{
|
||
title: "调音量和看看歌词",
|
||
desc: "歌名右边的圆圈叹号可以看歌曲信息；右下角一排小按钮里，喇叭是音量、时钟是定时关闭、心形是收藏。",
|
||
icon: "AudioOutlined",
|
||
},
|
||
{
|
||
title: "换歌或退出",
|
||
desc: "点列表图标展开全部曲目直接挑一首；听完点左上角向下的箭头收起播放器返回。",
|
||
icon: "DownOutlined",
|
||
},
|
||
],
|
||
features: [
|
||
{ icon: "CustomerServiceOutlined", name: "黑胶唱片", desc: "中间的唱片，没歌时显示的是一个耳机音符图标。" },
|
||
{ icon: "CaretRightFilled", name: "播放", desc: "实心三角，开始播放当前曲目。" },
|
||
{ icon: "PauseOutlined", name: "暂停", desc: "播放中三角会变这个两竖杠，点一下暂停。" },
|
||
{ icon: "StepBackwardFilled", name: "上一首", desc: "实心左箭头加竖线。" },
|
||
{ icon: "StepForwardFilled", name: "下一首", desc: "实心右箭头加竖线。" },
|
||
{ icon: "RetweetOutlined", name: "播放模式", desc: "循环/单曲/顺序，随机时会换成另一个交叉箭头。" },
|
||
{ icon: "UnorderedListOutlined", name: "播放列表", desc: "展开全部曲目，点哪首就播哪首。" },
|
||
{ icon: "InfoCircleOutlined", name: "歌曲信息", desc: "歌名右边的圆圈叹号。" },
|
||
{ icon: "HeartOutlined", name: "喜欢", desc: "空心变实心表示已收藏。" },
|
||
{ icon: "DownloadOutlined", name: "下载", desc: "下载这首歌，旁边的小标 ON/OFF 是下载状态。" },
|
||
{ icon: "AudioOutlined", name: "音量", desc: "喇叭图标，静音时变成带叉的喇叭。" },
|
||
{ icon: "FieldTimeOutlined", name: "定时关闭", desc: "时钟图标，到点自动停止播放。" },
|
||
{ icon: "EllipsisOutlined", name: "更多", desc: "竖着的三点，其余功能都收在这里。" },
|
||
{ icon: "DownOutlined", name: "收起播放器", desc: "左上角向下箭头，返回进入前的页面。" },
|
||
{ icon: "CloseOutlined", name: "关闭列表", desc: "关掉弹出的曲目列表。" },
|
||
],
|
||
};
|
||
|
||
/** 音频发布 */
|
||
const publishAudioOperation: HelpDoc = {
|
||
intro: "「音频发布」把本地音频整理成专辑并发布；发布后才能在这里收听。",
|
||
steps: [
|
||
{
|
||
title: "点「新增」建立专辑",
|
||
desc: "点新建文件图标进入可编辑状态，开始录入一个新专辑。",
|
||
icon: "FileAddOutlined",
|
||
},
|
||
{
|
||
title: "填写专辑信息",
|
||
desc: "最左边是耳机音符图标，代表整张专辑；右边填专辑名称、描述，编号由系统生成。",
|
||
icon: "CustomerServiceOutlined",
|
||
tips: "把同一主题或同一位歌手的音频放进一个专辑，收听时更方便。",
|
||
},
|
||
{
|
||
title: "上传音频并排序",
|
||
desc: "在明细区域逐个上传音频文件，用上下方块箭头调整曲目顺序。",
|
||
icon: "UploadOutlined",
|
||
tips: "音频文件通常较大，上传需要一点时间，请不要中途关闭页面。",
|
||
},
|
||
{
|
||
title: "点「保存」发布",
|
||
desc: "确认无误后点软盘图标保存；想放弃点回转箭头的取消。",
|
||
icon: "SaveOutlined",
|
||
},
|
||
{
|
||
title: "到音乐里试听核实",
|
||
desc: "发布完成后去音乐播放页确认能正常播放、曲目完整。",
|
||
icon: "CustomerServiceOutlined",
|
||
},
|
||
],
|
||
features: publishFeatures(audioHeroFeatures, audioExtraFeatures),
|
||
};
|
||
|
||
/** 音频查询 */
|
||
const publishAudioEnquiry: HelpDoc = {
|
||
intro: "「音频查询」列出自己发布过的全部专辑与音频，用于集中核对和管理。",
|
||
steps: [
|
||
{
|
||
title: "打开音频查询列表",
|
||
desc: "进入后表格列出全部已发布的音频 / 专辑记录。",
|
||
icon: "FileSearchOutlined",
|
||
},
|
||
{
|
||
title: "筛选出目标记录",
|
||
desc: "输入专辑编号点查询定位。",
|
||
},
|
||
{
|
||
title: "点右侧按钮处理",
|
||
desc: "操作列里的文档图标是查看、铅笔是修改、红色垃圾桶是删除。",
|
||
},
|
||
],
|
||
features: [
|
||
{ icon: "FileSearchOutlined", name: "查询", desc: "按编号或名称关键字筛选。" },
|
||
{ icon: "CustomerServiceOutlined", name: "音频 / 专辑列表", desc: "展示名称、编号、发布时间等信息。" },
|
||
{ icon: "FileTextOutlined", name: "查看", desc: "文档图标，打开这条记录的详情。" },
|
||
{ icon: "EditOutlined", name: "修改", desc: "铅笔图标，编辑这条专辑 / 音频。" },
|
||
{ icon: "DeleteOutlined", color: "red", name: "删除", desc: "移除后音乐里同步消失。" },
|
||
],
|
||
};
|
||
|
||
/* ==========================================================
|
||
* 视频
|
||
* ========================================================== */
|
||
|
||
/** 视频播放：VideoPlayer.vue */
|
||
const previewVideo: HelpDoc = {
|
||
intro: "「视频」用来观看已发布的视频：进入后直接播放，屏幕周围一圈按钮控制播放的各种设置。",
|
||
steps: [
|
||
{
|
||
title: "进入视频播放",
|
||
desc: "打开后进入播放界面，系统加载当前专辑里的视频内容。",
|
||
icon: "VideoCameraOutlined",
|
||
},
|
||
{
|
||
title: "控制播放",
|
||
desc: "画面下方一排：左边是播放模式，往右是上一集、播放/暂停、下一集、播放列表。",
|
||
icon: "CaretRightFilled",
|
||
tips: "视频文件较大，首次播放可能需要缓冲一会儿。",
|
||
},
|
||
{
|
||
title: "用右上方那排小按钮",
|
||
desc: "心形收藏、箭头下载、方框全屏、旋转、时钟定时、喇叭音量，最后的三点是全部其它功能。",
|
||
icon: "FullscreenOutlined",
|
||
},
|
||
{
|
||
title: "换下一个或直接离开",
|
||
desc: "点列表图标展开全部剧集挑一个；看完直接用浏览器返回即可。",
|
||
icon: "UnorderedListOutlined",
|
||
},
|
||
],
|
||
features: [
|
||
{ icon: "CaretRightFilled", name: "播放", desc: "实心三角，开始播放。" },
|
||
{ icon: "PauseOutlined", name: "暂停", desc: "播放中变成两竖杠，点一下停住。" },
|
||
{ icon: "StepBackwardFilled", name: "上一集", desc: "实心左箭头加竖线。" },
|
||
{ icon: "StepForwardFilled", name: "下一集", desc: "实心右箭头加竖线。" },
|
||
{ icon: "RetweetOutlined", name: "播放模式", desc: "循环/单曲，随机时换成交叉箭头。" },
|
||
{ icon: "UnorderedListOutlined", name: "播放列表", desc: "展开全部剧集，点哪个就看哪个。" },
|
||
{ icon: "FullscreenOutlined", name: "全屏", desc: "四角方框，放大到满屏。" },
|
||
{ icon: "FullscreenExitOutlined", name: "退出全屏", desc: "全屏时按钮会变成这个四角内缩。" },
|
||
{ icon: "HeartOutlined", name: "喜欢", desc: "空心收藏，点完变实心的爱心。" },
|
||
{ icon: "DownloadOutlined", name: "下载", desc: "下载这个视频，旁边小标显示 ON/OFF。" },
|
||
{ icon: "AudioOutlined", name: "音量", desc: "喇叭图标，静音时变成带叉的喇叭。" },
|
||
{ icon: "RotateRightOutlined", name: "旋转", desc: "向右旋转画面，横竖屏不对时用它。" },
|
||
{ icon: "FieldTimeOutlined", name: "定时关闭", desc: "时钟图标，到点自动停止。" },
|
||
{ icon: "EllipsisOutlined", name: "更多", desc: "竖着的三点，其余功能都收在这里。" },
|
||
{ icon: "CloseOutlined", name: "关闭列表", desc: "关掉弹出的剧集列表。" },
|
||
{ icon: "VideoCameraOutlined", name: "暂无视频", desc: "专辑里没有视频时显示这个摄像机图标。" },
|
||
],
|
||
};
|
||
|
||
/** 视频发布 */
|
||
const publishVideoOperation: HelpDoc = {
|
||
intro: "「视频发布」把本地视频整理成专辑并发布；发布后才能在这里观看。",
|
||
steps: [
|
||
{
|
||
title: "点「新增」建立专辑",
|
||
desc: "点新建文件图标进入可编辑状态，开始录入一个新视频专辑。",
|
||
icon: "FileAddOutlined",
|
||
},
|
||
{
|
||
title: "填写专辑信息",
|
||
desc: "最左边是摄像机图标，代表整张专辑；右边填专辑名称、描述，编号由系统生成。",
|
||
icon: "VideoCameraOutlined",
|
||
},
|
||
{
|
||
title: "上传视频并排序",
|
||
desc: "在明细区域逐个上传视频文件，用上下方块箭头调整播放顺序。",
|
||
icon: "UploadOutlined",
|
||
tips: "视频体积大，上传耗时较长，请保持页面打开直到进度完成。",
|
||
},
|
||
{
|
||
title: "点「保存」发布",
|
||
desc: "确认无误后点软盘图标保存；反悔点回转箭头的取消。",
|
||
icon: "SaveOutlined",
|
||
},
|
||
{
|
||
title: "到视频里试播核实",
|
||
desc: "发布完成后去视频播放页确认能正常观看、内容完整。",
|
||
icon: "VideoCameraOutlined",
|
||
},
|
||
],
|
||
features: publishFeatures(videoHeroFeatures),
|
||
};
|
||
|
||
/** 视频查询 */
|
||
const publishVideoEnquiry: HelpDoc = {
|
||
intro: "「视频查询」列出自己发布过的全部专辑与视频，用于集中核对和管理。",
|
||
steps: [
|
||
{
|
||
title: "打开视频查询列表",
|
||
desc: "进入后表格列出全部已发布的视频 / 专辑记录。",
|
||
icon: "FileSearchOutlined",
|
||
},
|
||
{
|
||
title: "筛选出目标记录",
|
||
desc: "输入专辑编号点查询定位。",
|
||
},
|
||
{
|
||
title: "点右侧按钮处理",
|
||
desc: "操作列里的文档图标是查看、铅笔是修改、红色垃圾桶是删除。",
|
||
},
|
||
],
|
||
features: [
|
||
{ icon: "FileSearchOutlined", name: "查询", desc: "按编号或名称关键字筛选。" },
|
||
{ icon: "VideoCameraOutlined", name: "视频 / 专辑列表", desc: "展示名称、编号、发布时间等信息。" },
|
||
{ icon: "FileTextOutlined", name: "查看", desc: "文档图标，打开这条记录的详情。" },
|
||
{ icon: "EditOutlined", name: "修改", desc: "铅笔图标，编辑这条专辑 / 视频。" },
|
||
{ icon: "DeleteOutlined", color: "red", name: "删除", desc: "移除后视频里同步消失。" },
|
||
],
|
||
};
|
||
|
||
/* ==========================================================
|
||
* 族谱
|
||
* ========================================================== */
|
||
|
||
/** 家庭成员录入：注意这一页顶部只有查询和重置，没有独立的「新增」按钮 */
|
||
const familyPersonOperation: HelpDoc = {
|
||
intro: "「家庭成员」录入与维护族谱里的每一位成员，是绘制族谱的基础数据。进入就是一张可直接填写的表。",
|
||
steps: [
|
||
{
|
||
title: "打开成员录入",
|
||
desc: "进入后顶部只有查询、重置两个按钮（放大镜和橡皮），没有单独的新增按钮：页面本身就可以直接填写。",
|
||
icon: "FileSearchOutlined",
|
||
tips: "想确认库里有没有这个人，先用查询查一下，避免重复录入。",
|
||
},
|
||
{
|
||
title: "先给成员配张头像",
|
||
desc: "点左边那个圆形头像；处于编辑状态时头像是被相机图标盖住，点它换本地照片。",
|
||
icon: "CameraOutlined",
|
||
},
|
||
{
|
||
title: "填写成员信息",
|
||
desc: "填写姓名、称谓、辈分等，带必填标记的项不能为空。",
|
||
tips: "录入越完整，后续绘制族谱时关系越准确。",
|
||
},
|
||
{
|
||
title: "点「保存」完成录入",
|
||
desc: "确认无误后点软盘图标保存；中途反悔点回转箭头的取消放弃这次编辑。",
|
||
icon: "SaveOutlined",
|
||
},
|
||
{
|
||
title: "后续修改或删除",
|
||
desc: "先查询找到该成员，再点铅笔图标修改，或点红色垃圾桶删除。",
|
||
tips: "已经挂到某个族谱下的成员不允许删除，需先把它从族谱中移除。",
|
||
},
|
||
],
|
||
features: [
|
||
{ icon: "FileSearchOutlined", name: "查询", desc: "放大镜图标，检索库里是否已有这位成员。" },
|
||
{ icon: "ClearOutlined", name: "重置", desc: "橡皮图标，清空表单回到空白状态。" },
|
||
{ icon: "UserOutlined", name: "成员头像", desc: "左边的圆形人头，还没传照片时显示的就是它。" },
|
||
{ icon: "CameraOutlined", name: "更换头像", desc: "编辑时盖在头像上的相机图标，点它上传本地照片。" },
|
||
{ icon: "SaveOutlined", name: "保存", desc: "软盘图标，确认写入本次录入或修改。" },
|
||
{ icon: "UndoOutlined", name: "取消", desc: "回转箭头，放弃本次编辑。" },
|
||
{ icon: "EditOutlined", name: "修改", desc: "铅笔图标，把已有成员变成可编辑状态。" },
|
||
{ icon: "DeleteOutlined", color: "red", name: "删除", desc: "红色垃圾桶，移除成员（挂在族谱上的不能删）。" },
|
||
],
|
||
};
|
||
|
||
/** 成员查询：同样没有「新增」按钮 */
|
||
const familyPersonEnquiry: HelpDoc = {
|
||
intro: "「成员查询」集中查看全部家庭成员，先从列表挑人，再做查看、修改或删除。",
|
||
steps: [
|
||
{
|
||
title: "打开成员列表",
|
||
desc: "进入后表格列出全部家庭成员及其主要信息。",
|
||
icon: "FileSearchOutlined",
|
||
},
|
||
{
|
||
title: "勾选一个人",
|
||
desc: "点左侧勾选框选中成员。注意查看和修改一次只能勾一个，勾多了按钮会变灰。",
|
||
tips: "本页没有新增按钮，要录入新成员请去「家庭成员」页面。",
|
||
},
|
||
{
|
||
title: "点下方的按钮处理",
|
||
desc: "文档图标查看详情、铅笔图标修改、红色垃圾桶删除（删除可以多选）。",
|
||
icon: "EditOutlined",
|
||
},
|
||
],
|
||
features: [
|
||
{ icon: "FileSearchOutlined", name: "查询", desc: "按姓名等关键字筛选。" },
|
||
{ icon: "UserOutlined", name: "成员列表", desc: "展示家庭成员的姓名、辈分等主要信息。" },
|
||
{ icon: "FileTextOutlined", name: "查看", desc: "文档图标，只能选一个人时可用。" },
|
||
{ icon: "EditOutlined", name: "修改", desc: "铅笔图标，只能选一个人时可用。" },
|
||
{ icon: "DeleteOutlined", color: "red", name: "删除", desc: "红色垃圾桶，可以勾选多人一起删。" },
|
||
],
|
||
};
|
||
|
||
/** 族谱制作 */
|
||
const familyTreeOperation: HelpDoc = {
|
||
intro: "「族谱」把已录入的家庭成员按亲属关系连成一张树状图，可以直观地看到整个家族的脉络。",
|
||
steps: [
|
||
{
|
||
title: "先确保成员已录入",
|
||
desc: "绘制族谱前，先在「家庭成员」里把需要出现在族谱上的人都录入好。",
|
||
icon: "UserOutlined",
|
||
tips: "成员资料越完整，生成的族谱越准确，建议先把成员录齐再来绘制。",
|
||
},
|
||
{
|
||
title: "点「新增」建立族谱",
|
||
desc: "顶部三个按钮依次是查询、重置、新增（新建文件图标），点新增开始绘制一张新族谱。",
|
||
icon: "FileAddOutlined",
|
||
},
|
||
{
|
||
title: "逐个添加亲属关系",
|
||
desc: "页面上每个成员后面都有「+ 夫妻关系」「+ 孩子关系」这样的虚线按钮，点加号方块逐步把人接上去。",
|
||
icon: "PlusSquareTwoTone",
|
||
},
|
||
{
|
||
title: "调整顺序与展示",
|
||
desc: "每位成员右侧的上/下方块调整排位；点中间的二叉树或类图腾看整张谱系图。",
|
||
icon: "ApartmentOutlined",
|
||
},
|
||
{
|
||
title: "点「保存」完成族谱",
|
||
desc: "确认布局与连线无误后点软盘图标保存；反悔点回转箭头的取消放弃本次修改。",
|
||
icon: "SaveOutlined",
|
||
},
|
||
],
|
||
features: [
|
||
...crudHeadFeatures,
|
||
{ icon: "ApartmentOutlined", name: "谱系图 / 祖谱系图", desc: "二叉树形状的图标，点它看整张家族树。" },
|
||
{ icon: "FileProtectOutlined", name: "申请管理", desc: "带盾牌的文档，申请成为这个族谱的管理员。" },
|
||
{ icon: "PlusSquareTwoTone", name: "新增夫妻 / 孩子关系", desc: "虚线按钮上的加号方块，用来接上亲属。" },
|
||
{ icon: "UpSquareTwoTone", name: "上移", desc: "调整这位成员在列表中的位置。" },
|
||
{ icon: "DownSquareTwoTone", name: "下移", desc: "与上移相反。" },
|
||
{ icon: "RightOutlined", name: "展开成员", desc: "向右的小箭头，展开这一层的成员列表。" },
|
||
{ icon: "CheckCircleTwoTone", name: "通过申请", desc: "勾形圆圈，批准别人的管理申请。" },
|
||
{ icon: "CrownOutlined", color: "#faad14", name: "设为管理员", desc: "金色皇冠，批准对方成为管理员。" },
|
||
{ icon: "CloseCircleOutlined", name: "拒绝申请", desc: "叉形圆圈，驳回管理申请。" },
|
||
{ icon: "EditOutlined", name: "修改", desc: "铅笔图标，重新绘制这张族谱。" },
|
||
{ icon: "SaveOutlined", name: "保存", desc: "软盘图标，确认本次改动。" },
|
||
{ icon: "UndoOutlined", name: "取消", desc: "回转箭头，放弃本次修改。" },
|
||
{ icon: "DeleteOutlined", color: "red", name: "删除", desc: "红色垃圾桶，移除整个族谱（成员档案不受影响）。" },
|
||
],
|
||
};
|
||
|
||
/** 族谱查询 */
|
||
const familyTreeEnquiry: HelpDoc = {
|
||
intro: "「族谱查询」列出全部已创建的族谱，选一张再做查看、修改或删除。",
|
||
steps: [
|
||
{
|
||
title: "打开族谱列表",
|
||
desc: "进入后表格列出全部族谱及其基本信息。",
|
||
icon: "FileSearchOutlined",
|
||
},
|
||
{
|
||
title: "点「新增」建新族谱",
|
||
desc: "右上角的控制区有一个新建文件图标，点了就去创建一张全新族谱。",
|
||
icon: "FileAddOutlined",
|
||
},
|
||
{
|
||
title: "勾选一张再操作",
|
||
desc: "查看和修改一次只能勾一张，多选时这两个按钮会变灰；删除则允许一次勾多张。",
|
||
tips: "双击某一行也会直接进入查看详情，比点按钮更快。",
|
||
},
|
||
{
|
||
title: "点下方按钮处理",
|
||
desc: "文档图标查看、铅笔图标修改、红色垃圾桶删除。",
|
||
icon: "EditOutlined",
|
||
},
|
||
],
|
||
features: [
|
||
{ icon: "FileAddOutlined", name: "新增", desc: "右上角的新建文件图标，创建一张新族谱。" },
|
||
{ icon: "ApartmentOutlined", name: "族谱列表", desc: "展示族谱名称、成员数等主要信息。" },
|
||
{ icon: "FileSearchOutlined", name: "查询", desc: "按族谱名称关键字筛选。" },
|
||
{ icon: "FileTextOutlined", name: "查看", desc: "文档图标，只能勾一张时可用。" },
|
||
{ icon: "EditOutlined", name: "修改", desc: "铅笔图标，只能勾一张时可用，进去继续绘制。" },
|
||
{ icon: "DeleteOutlined", color: "red", name: "删除", desc: "红色垃圾桶，可一次勾选多张删除。" },
|
||
],
|
||
};
|
||
|
||
/* ==========================================================
|
||
* 注册表与查询
|
||
* ========================================================== */
|
||
|
||
/** 未编写专属文档时的通用兜底说明，保证任何功能点开都有东西可看 */
|
||
export const fallbackDoc: HelpDoc = {
|
||
intro: "这里用时间轴的方式介绍该功能的操作流程，下方列出页面中各个按钮和图标的作用。",
|
||
steps: [
|
||
{
|
||
title: "先从入口进入功能页",
|
||
desc: "在首页对应的分组卡片里点击功能条目，即可打开这个功能页面。",
|
||
},
|
||
{
|
||
title: "看顶部的查询与底部的操作",
|
||
desc: "放大镜像家协会查询、橡皮是重置、新建文件是新增；下面依次是修改（铅笔）、保存（软盘）、取消（回转箭头）、删除（红色垃圾桶）。",
|
||
icon: "FileSearchOutlined",
|
||
},
|
||
{
|
||
title: "按需要填写并提交",
|
||
desc: "表单填完一定要点软盘图标保存，内容才真正写入；不想保留就点回转箭头取消。",
|
||
icon: "SaveOutlined",
|
||
tips: "录入或修改后一定要点保存，否则关掉页面就白填了。",
|
||
},
|
||
],
|
||
features: [
|
||
{ icon: "FileSearchOutlined", name: "查询", desc: "放大镜加文档，按关键字筛选。" },
|
||
{ icon: "ClearOutlined", name: "重置", desc: "橡皮擦，清空条件恢复完整列表。" },
|
||
{ icon: "FileAddOutlined", name: "新增", desc: "新建文件图标，录入一条新记录。" },
|
||
{ icon: "EditOutlined", name: "修改", desc: "铅笔图标，把已有记录改成可编辑。" },
|
||
{ icon: "SaveOutlined", name: "保存", desc: "软盘图标，确认并写入。" },
|
||
{ icon: "UndoOutlined", name: "取消", desc: "回转箭头，放弃本次编辑。" },
|
||
{ icon: "DeleteOutlined", color: "red", name: "删除", desc: "红色垃圾桶，移除选中的记录。" },
|
||
{ icon: "FileTextOutlined", name: "查看", desc: "文档图标，打开详情只读查看。" },
|
||
],
|
||
};
|
||
|
||
/**
|
||
* 功能英文名 → 帮助文档
|
||
*
|
||
* key 来自 SecurityFunctionDisplayData.FunctionName，
|
||
* 与仪表盘 DashboardGroupCard 卡片上的功能一一对应。
|
||
*/
|
||
export const HELP_DOCS: Record<string, HelpDoc> = {
|
||
/* 网盘 */
|
||
DmsFileEnquiry: dmsFileEnquiry,
|
||
DmsFileDeleteEnquiry: dmsFileDeleteEnquiry,
|
||
|
||
/* 共享中心 */
|
||
FamilyGroupShare: familyGroupShare,
|
||
FamilyShareOperation: familyShareOperation,
|
||
FamilyGroupOperation: familyGroupOperation,
|
||
FamilyGroupEnquiry: familyGroupEnquiry,
|
||
|
||
/* 相册 */
|
||
Preview: preview,
|
||
PublishPhotoOperation: publishPhotoOperation,
|
||
PublishPhotoEnquiry: publishPhotoEnquiry,
|
||
|
||
/* 音乐 */
|
||
PreviewAudio: previewAudio,
|
||
PublishAudioOperation: publishAudioOperation,
|
||
PublishAudioEnquiry: publishAudioEnquiry,
|
||
|
||
/* 视频 */
|
||
PreviewVideo: previewVideo,
|
||
PublishVideoOperation: publishVideoOperation,
|
||
PublishVideoEnquiry: publishVideoEnquiry,
|
||
|
||
/* 族谱 */
|
||
FamilyPersonOperation: familyPersonOperation,
|
||
FamilyPersonEnquiry: familyPersonEnquiry,
|
||
FamilyTreeOperation: familyTreeOperation,
|
||
FamilyTreeEnquiry: familyTreeEnquiry,
|
||
};
|
||
|
||
/**
|
||
* 取某个功能的帮助文档；没有登记过则返回通用兜底文档，
|
||
* 因此调用方永远拿得到一份可渲染的 HelpDoc。
|
||
*/
|
||
export const getHelpDoc = (functionName?: string): HelpDoc =>
|
||
(functionName && HELP_DOCS[functionName]) || fallbackDoc;
|
||
|
||
/** 该功能是否编写了专属帮助文档（false 表示拿到的是通用兜底） */
|
||
export const hasHelpDoc = (functionName?: string): boolean =>
|
||
!!functionName && !!HELP_DOCS[functionName];
|