Plover插件,用于与AlleyCAT通信
项目描述
AlleyCAT 是一个免费的、开源的速记辅助转录(CAT)系统,适用于速记员。它允许您在网页和桌面应用程序中编写和编辑文档,如法庭笔录和翻译词典。AlleyCAT最初作为替代专业CAT软件的免费方案而出现,后者是专有软件且价格昂贵。
它并非旨在取代或与 Plover(开源速记引擎)竞争;相反,它连接到Plover以利用其现有生态系统,例如使用多个品牌的业余、学生和专业速记员的写作能力以及社区贡献的插件。
那么,CAT系统究竟是什么?
简单来说:将其视为带有速记集成的文字处理器。
CAT软件允许您使用速记编写文档,通常是法庭笔录。每个速记笔划都存储在文档中,旁边是其翻译的文本。CAT系统还允许您修改文档布局、纠正拼写错误或翻译错误、创建封面页和索引等。
当您使用速记笔使用CAT系统进行写作时,速记笔记与翻译 不可更改地 相关联,因此即使在您返回编辑文档时,原始速记笔记也会保持完整。这对于法庭速记员尤为重要,因为速记笔记被认为是事实真相的主要来源。
虽然CAT软件主要用于法庭速记员,但其中一些功能对学生和爱好者来说也可能很有用:例如,将所有笔记放在一个文档中,并链接到原始速记,这对于练习课后识别改进区域非常有帮助。
为什么叫“AlleyCAT”?
她是一只自由猫:“没有主人,没有家,没有规则。” —— @stenowitch,2022年1月
安装
最新稳定版本的预构建二进制文件可在发布页面找到。下载您平台对应的包:Windows为.msi
,macOS为.dmg
,Linux为.AppImage
。
您还可以从源代码构建AlleyCAT的最新版本。有关更多信息,请参阅下方的开发部分。
如果您只想尝试AlleyCAT而不安装,还可以在alleycat.sammdot.ca找到网络版本。但这里有几个需要注意的问题:
- 文件只能保存到您的网络浏览器下载文件夹中
- 出于安全原因,AlleyCAT无法连接到您计算机上运行的Plover实例[^1]
[^1]:通常,运行在浏览器环境中的远程网站会被阻止连接到本地运行的一切。我最初使用WebSocket来实现这一点,但这只在网站也是本地时才有效。
设计
AlleyCAT是一个混合型Web桌面应用程序,使用Tauri、React和TipTap构建。应用程序的大部分代码是用TypeScript编写的,小部分是用Rust和Python编写的。AlleyCAT的核心是一个React应用程序,通过Tauri封装以使其能够在桌面运行。Tauri端还允许它执行特定平台操作,例如将文件保存到磁盘。
AlleyCAT可以通过AlleyCAT Link(或简称Link)与Plover通信,这是一个将击打和翻译数据通过本地连接发送的Plover插件,在macOS和Linux上为Unix域套接字,在Windows上为TCP端口2228[^2]。\[^3] 这使得AlleyCAT可以利用Plover的现有生态系统——您可以使用Plover支持的任何机器、任何系统、您自己的词典以及您可能已安装的其他插件来写入AlleyCAT。Link可以通过pip
或Plover插件管理器安装。
[^2]:ACAT在手机键盘上:smile: [^3]:Windows支持命名管道,较新版本的Windows也支持Unix域套接字,但用于异步处理这两种方法的工具(在Python端为asyncio
,在Rust端为Tokio)的开发程度远不及。
开发
从源代码构建桌面应用程序需要Node v16+和Rust v1.64+;网络版本只需要Node。在继续之前,请确保已安装yarn
(以及在桌面上的cargo
)。
为了将AlleyCAT与Plover连接,您还需要一个完整的Plover 4.0.0-dev10+安装。
项目结构
仓库有四个主要部分
alleycat (this repository)
├─ alleycat_link
├─ app
│ └─ src
├─ public
└─ src
/alleycat_link
:Plover插件/app/src
:Tauri应用程序(仅限桌面)/public
:静态资源/src
:React应用程序(Web和桌面)
从源代码构建
克隆仓库
$ git clone https://github.com/sammdot/alleycat.git
$ cd alleycat
安装所有依赖项,包括TypeScript、React和Tauri CLI
$ yarn install
在Linux上,您还需要安装其他依赖项
$ sudo apt-get update
$ sudo apt-get install -y libgtk-3-dev webkit2gtk-4.0 libappindicator3-dev librsvg2-dev patchelf
开发
仅启动网络版本的开发服务器
$ yarn start
启动桌面版本的开发版本
$ yarn startapp
这两个都将在localhost:3000上启动一个Web服务器。即使正在运行桌面版本,您也应该能够通过浏览器访问网络版本。
要本地安装Plover插件
$ plover -s plover_plugins install -e .
其中 plover
是主 Plover 二进制文件的路径(或在 Windows 上为 plover_console.exe
),然后请确保在 Plover 中启用 alleycat_link
扩展,并在需要时允许网络连接。
生产环境
为生产环境构建网页版本
$ yarn build
网页版本的生成文件将位于 /build
目录中。这些文件可以静态提供服务,并且也应该支持离线使用。
在您的机器平台上构建桌面版本
$ yarn buildapp
桌面版本的生成文件将位于 /app/target/release
目录中。这可能包括独立应用程序二进制文件、应用程序包以及/或安装程序包,具体取决于平台。这些文件可以在您的系统上安装或分发。
项目详情
alleycat-link-0.4.4.tar.gz 的哈希值
算法 | 哈希摘要 | |
---|---|---|
SHA256 | ff3666480c0fbce0706aa283d13cc66167f11d04b9c3a1e1ca1e5642846a03b8 |
|
MD5 | c94ed1d475a0e62a7c3e4d4e14af1107 |
|
BLAKE2b-256 | 1aa880e6c904618cea87508739fe15afab317327d925f70e2b51da4a8ee85df0 |
alleycat_link-0.4.4-py3-none-any.whl 的哈希值
算法 | 哈希摘要 | |
---|---|---|
SHA256 | e53c9c4e521508f8b545d307147b08f2f89db13b38b321730e9c83d439614ba0 |
|
MD5 | 764dcab9c1962dd46131db1cfd57e57b |
|
BLAKE2b-256 | 3661a7ec4d927a8f940068520894963ee2c1bd84739635549fa56e4f89dd582e |