mirror of
https://github.com/qingjian-team/qingjian.git
synced 2026-11-15 00:14:54 +00:00
节点写 animation:关键帧平移 / 旋转 / 缩放 / 不透明度,作用于整棵子树、不影响布局;属性只在写了它的关键帧间插值,开头结尾缺的按缺省值补(同 CSS);loop: false 播一轮停住 时钟从窗口出现算起、打字中不重置、forget 归零;减少动态效果时停在第一帧;画出范围按一轮里能到的最远处算(旋转取外接圆) 带姿态节点整棵子树画进缓存小图,按姿态绕中心变换贴上 循环帧局部重画(renderer/partial.rs + scene/split.rs):动画节点把树序切段,不动的段各缓存一张图层,每帧只在动画节点新旧位置的区域里按原先后叠段与节点;与整张重画只差半透明取整(≤ 3/255,测试断言);有过渡或动画节点不独立时整张重画 blend_mask 按覆盖率查表(同 Skia A8 遮罩);壳的定时器按 next_frame 间隔跳(过渡 16 ms、循环 33 ms) 展示主题循环帧 3.6 → 0.2 ms(mac release 2 倍屏,第一帧切段约 7 ms) 内置三主题的高亮条加 id + transition(100 ms ease-out);快照每张先 forget,不与上一张配对 快照:静止的全部不变;过渡半路改用青简绿(transition-mid),新增展示主题循环 600 ms 一帧(showcase-loop)。Windows 基准待 box 重出
用户文档(官网「文档」页的内容源)
这个目录里的 Markdown 是给用户看的,官网(qingjian-web)构建时拉取整个目录,按目录结构渲染成文档页。
docs/ 下其他目录是给开发者看的工程文档,不渲染。
这个 README 是维护约定,不渲染。
结构
docs/user/
├── index.md # 文档首页
├── getting-started/ # 开始使用:安装、第一次输入、按键与快捷键(两个平台并排的总表)
├── input/ # 输入:英文模式、拼写纠错、模糊音与输入方案、快捷输入
├── learning/ # 学习:译词与生词、统计
├── cloud/ # 云联想(可选)
├── settings/ # 设置:偏好设置、词库
└── help/ # 帮助:数据与日志、卸载、反馈
-
一个文件夹是一个分组,文件夹里的
index.md给分组标题与顺序;文件夹里的其他.md是分组下的页面。 -
一个
.md是一页。顶部 frontmatter:--- title: 安装 # 页面标题,也是侧栏里的名字 order: 1 # 同级排序,小的在前 description: 一句话 # 搜索引擎摘要与分享卡片用,40 字左右 --- -
文件名与文件夹名用 ASCII(小写、连字符),中文只写在
title里;URL 就是路径:getting-started/install.md→/docs/getting-started/install。 -
图片放在同一文件夹,相对路径引用(
),构建时随文档一起拷走。截图用浅色外观、系统缺省字号、2x。 -
正文第一行不再写
# 标题,标题来自 frontmatter;正文从##开始。 -
跨页链接用相对路径指向
.md文件([安装](../getting-started/install.md)),渲染时改写成站内链接。
写法
- 说明书体:陈述句,不用「一下 / 多半 / 照常 / 免得」这类口语助词与副词,不拟人、不调侃;条件用「若…则」,可行用「可」,必要用「需」;术语固定(候选窗口、拼音行、上屏、组合键)。
- 面向普通用户,不出现实现词(
config.toml、marked text、Viterbi、panic、600 权限这类)。要指路时说「偏好设置 → 高级」,不说文件名; 数据文件位置只在 help/data-and-logs.md 一处列出。 - 按键按键帽写:
Space、Enter、Backspace、Delete、Esc、Tab、←→↑↓、Home/End、PageUp/PageDown; macOS 修饰键用符号(⌥ + 数字、⌃⌥T、⇧ + Tab),Windows 用单词(Ctrl + 数字、Ctrl + Alt + T);菜单与页名用「」:「系统设置 → 隐私与安全性」。 - 一个功能改了行为,同一个提交里改这里对应的页;README 的安装 / 基本用法 / 隐私一节与这里重复的内容以这里为准,README 只留概要。
- 事实来源是代码与
docs/design/candidate-ui.md(按键约定)、docs/design/architecture.md;写之前对一遍,不凭印象。