Skip to content

Commit

Permalink
内容:针对 xxxk v2.0.3 的更新。
Browse files Browse the repository at this point in the history
  • Loading branch information
tswwe committed Dec 16, 2024
1 parent 627464e commit 538eb0c
Show file tree
Hide file tree
Showing 5 changed files with 47 additions and 56 deletions.
24 changes: 11 additions & 13 deletions develop.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

前往 [:fa fa-github: 本项目仓库][小小星空仓库]获取源代码。解压后可以得到三个一级目录:

* `📂app-win`:存放编译生成**小小星空输入法**安装包的脚本。
* `📂data-base`:对原版**小小输入法**的一部分配置文件进行魔改得到的文件
* `📂data-schema`**星空系列方案**的核心文件
* `📂build`:存放编译生成**小小星空输入法**安装包的脚本。
* `📂data`:编译生成**小小星空输入法**安装包所需的程序文件,通常由原版小小输入法安装包解包而得
* `📂home`:各种魔改原版**小小输入法**的数据文件,以及星空系列方案的码表文件

?> 本项目依赖的小小输入法正在逐步开源,其 Linux 版本已全部开源,详见[:fa fa-github: 小小输入法项目仓库][小小输入法仓库]

Expand All @@ -14,19 +14,17 @@

### ** Windows **

1. 把原版**小小输入法**的程序目录 `yong` 放到 `app-win` 目录下。
2. 根据自己的需要,修改 `app-win``data-base``data-schema` 目录下的文件。
3. 安装 NSIS,编译 `app-win/nsis/xxxk.nsi`
1. 把原版**小小输入法**的程序目录 `yong` 里的内容放到 `data/yong-win` 目录下。
2. 部署 NSIS,编译 `build/win/xxxk.nsi`

### ** Android **

1. 下载[原版小小输入法 Android 版安装程序][小小输入法网盘],并用 apktool 反编译。
2. 根据自己的需要,修改反编译后的资源文件。例如:
* `res/drawable-hdpi|mdpi|xhdpi/app_icon.png` 是程序图标,可替换。
* `assets/mb` 是码表,会被安装到`sdcard/yong/mb`。注意,安卓版不会覆盖安装。
* `assets/www` 是默认皮肤,一般包括 `fonts` 目录和 `keyboard.css``keyboard.html`,不会体现在程序目录中。如果安装完成后想换皮肤,要把皮肤放到 `.yong/android` 目录。
* `assets/yong.ini` 是初始配置文件。注意,小小安卓版不支持 entry。
3. 用 apktool 重新编译为安装包,并用 autosign 等工具进行签名。
1. 下载[原版小小输入法 Android 版安装程序](http://yong.dgod.net/sync/yong-android/yong.apk),把 yong.apk 放到 `data/yong-android` 目录下。
2. 下载 [apktool](https://apktool.org/docs/install),把 apktool.jar 和 apktool.bat 放到 `data/yong-android` 目录下。
3. 下载 [uber-apk-signer](https://github.com/patrickfav/uber-apk-signer),把 uber-apk-signer.jar 放到 `data/yong-android` 目录下。
4. 运行 xxxk.bat,执行 [A] 选项,得到 xxxk-signed.apk。

?> 以上编译工具依赖 java8 或更高版本。

### ** Linux **

Expand Down
13 changes: 12 additions & 1 deletion history.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,22 @@

## 最近更新

##### [v2.0.3.0-Build20241216](https://github.com/xkinput/xxxk/releases/tag/v2.0.3)

*主要是增强了可维护性:将输入法主程序与星空方案数据文件分离。*

* refactor: 调整项目目录结构,分成 build(构建工具),data(程序)和 home(数据)。
* chore: 增加 Android 版编译脚本 xxxk.bat,可快速打包生成 apk(参见[开发指南](develop.md))。
* chore: 优化 Windows 版编译脚本 xxxk.nsi,现在安装包会将数据文件安装到配置目录(而不是程序目录)。
* feat: 现在 Windows 版可以单独更新输入法主程序了(右键菜单 🞂 小小输入法主程序 🞂 更新主程序)。
* feat:更新小小输入法主程序至[2024年12月16日测试版](https://yong.dgod.net/read.php?tid=2),启用新版小小输入法的启发式造词特性(code_hint),并支持新版小小输入法的云剪贴板功能(`;cc`)。
* docs: 更新 yong.chm。

##### [v2.0.1.0-Build20241124](https://github.com/xkinput/xxxk/releases/tag/v2.0.1)

*主要是跟进小小输入法测试版的更新。暂时只有 Windows 版,Android 版后续再跟进。*

* 更新小小输入法主程序至[2024年11月23日测试版](https://yong.dgod.net/read.php?tid=2)⚠ 中英文状态切换异常问题仍然存在。
* 更新小小输入法主程序至[2024年11月23日测试版](https://yong.dgod.net/read.php?tid=2)
* 修复安装包无法恢复用户设定的问题。
* 调整安装包文件名,采用纯英文(文件名里的中文字符在上传 github release 时会被吞掉)。
* 移除一些历史遗留文件,减小安装包体积。
Expand Down
41 changes: 17 additions & 24 deletions install.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# :fa fa-download: 安装小小

小小星空输入法是小小输入法的一个再发行版本,理论上和小小输入法一样支持 Windows、Android、Linux 平台,但目前只在 Windows(XP~Win10)和 Android 平台上测试过。
小小星空输入法是小小输入法的一个再发行版本,理论上和小小输入法一样支持 Windows、Android、Linux 平台,但目前只在 Windows(XP+)和 Android 平台上测试过。

<!-- tabs:start -->

## ** Windows **

### 安装

直接下载并运行打包好的[小小星空输入法 Windows 版安装程序][小小星空网盘]
方式一(自动安装):如果懒得折腾,可以直接下载并运行打包好的[小小星空输入法 Windows 版安装程序][小小星空网盘]。这种方式不兼容系统上已经安装的小小输入法

?> 已经安装了[原版小小输入法 Windows 版][小小输入法网盘]的用户,也可以手动安装小小星空:从[:fa fa-github: 小小星空仓库][小小星空仓库]下载本项目源代码,`data-base` 目录下的文件覆盖到小小输入法的程序目录下,然后将 `data-schema/xkjd6``data-schema/xklb` 等目录下的文件依次覆盖到小小输入法的程序目录下
方式二(手动安装):已经安装了[原版小小输入法 Windows 版][小小输入法网盘]的用户,可以从[:fa fa-github: 小小星空仓库][小小星空仓库]下载本项目源代码,然后将 `home` 目录里的内容(最关键的是 `mb``entry` 目录)复制到小小输入法的配置目录中,然后将 yong-win.ini 更名为 yong.ini

### 启动

Expand All @@ -20,23 +20,23 @@

![系统语言和键盘](_media\lang-and-kbd-win7.png 'Win7:区域和语言 🞂 键盘和语言 🞂 更改键盘')

![系统语言和键盘](_media\lang-and-kbd-xp.png 'XP:区域和语言选项 🞂 语言 🞂 详细信息;并且还要勾选“将高级文字服务支持应用于所有程序”')
![系统语言和键盘](_media\lang-and-kbd-xp.png 'XP:区域和语言选项 🞂 语言 🞂 详细信息;还要勾选“将高级文字服务支持应用于所有程序”;SP2 以下还需安装 wic 组件')

!> 如果 TSF 模块没有成功安装,则不会多出 Yong 输入法键盘,输入法将无法以 TSF 模式启动,但是可以以外挂模式启动(输入体验较差)。
!> 如果 TSF 模块没有成功安装,则不会多出 Yong 输入法键盘,输入法将无法以 TSF 模式启动,但是可以以外挂模式启动(此模式不支持光标跟随)。

第一步(如果想要以外挂模式启动,请跳过此步):把光标定位到任意文本框,然后如图在任务栏托盘或语言工具栏中切换到 Yong 输入法键盘(也可以用快捷键切换,一般是<kbd>Ctrl</kbd><kbd>Shift</kbd>或<kbd>Win</kbd><kbd>Space</kbd>)。如果系统只有 Yong 输入法一个键盘,则不需要切换键盘,此步跳过。

![切换系统键盘](_media\run-tsf-on-win10.png 'Win10')
![切换系统键盘](_media\run-tsf-on-win7.png 'Win7')
![切换系统键盘](_media\run-tsf-on-xp.png 'XP')

第二步:从开始菜单启动输入法主程序(也可以运行程序目录下的`yong.bat`
第二步:从开始菜单启动输入法主程序。

第三步(Win7 以下不需要此步):把光标定位到任意文本框,然后使用<kbd>Ctrl</kbd><kbd>Space</kbd>快捷键,呼出小小输入法的状态条。(如果成功安装了 TSF 模块,Win8 以上系统也可以鼠标点击任务栏托盘的「英」,Win7 以下系统可以鼠标点亮任务栏托盘的小小输入法图标,来呼出小小输入法的状态条)

?> 判断输入法运行在 TSF 模式还是外挂模式的方法:右击输入法状态条,如果看到“TSF 模式未生效”的菜单项,说明正以外挂模式运行,否则以 TSF 模式运行。

### 退出 · 重启 · 重载 · 重设
### 退出 · 重启 · 重载

这些命令都包含在输入法状态条的右键菜单中。

Expand All @@ -50,41 +50,34 @@

## ** Android **

!> 小小输入法安卓版最近更新频繁,本项目尚未跟进,将来更新之后此页面可能发生较大变化。

### 安装

方式一(自动安装):直接使用打包好的[小小星空输入法 Android 版安装程序][小小星空网盘]。注意,如果手机上已经安装了小小星空输入法或原版小小输入法,需要先卸载它们,并在文件管理器中删除 `sdcard/yong` 目录,然后再进行安装。

!> 目前 Android 版安装程序无法自动删除 `sdcard/yong` 目录下的文件,因此需要用户手动删除该目录。
方式一(自动安装;仅供测试,更推荐方式二):直接使用打包好的[小小星空输入法 Android 版安装程序][小小星空网盘]

方式二(手动安装):如果手机上已经安装了小小星空输入法或者[原版小小输入法 Android 版][小小输入法网盘],可以采用这种方式
!> 目前的安装包无法自动删除 `sdcard/yong/.yong` 目录,建议安装之前先手动删除 `sdcard/yong/.yong/yong.ini`

1. 先退出 Yong 输入法,然后在文件管理器中删除 `sdcard/yong/.yong` 目录(这是个隐藏目录,需要先开启显示隐藏文件)。
2. 将本项目的各个一级目录(如 `xxxk-xkcommon`)下的 `mb` 文件夹依次复制粘贴到 `sdcard/yong` 目录下(如不存在,手动新建)。
3. 将本项目中 `yong_android.ini` 改名为 `yong.ini`,并粘贴到 `sdcard/yong` 目录下。
方式二(手动安装):如果手机上已经安装了[原版小小输入法 Android 版][小小输入法网盘],可以从[:fa fa-github: 小小星空仓库][小小星空仓库]下载本项目源代码,将 `home` 目录里的内容(最关键的是 `mb` 目录)复制到 `sdcard/yong/.yong` 中,然后将 yong-android.ini 更名为 yong.ini。

### 启动

1. 在手机的 <kbd>设置</kbd><kbd>应用设置</kbd><kbd>应用管理</kbd> 中,授予 Yong 输入法足够的权限。必须授予的权限有:“允许应用显示悬浮窗”,建议授予的权限有:“自启动”、“读取通知类短信”、“读取联系人”、“读写剪切板”等。
2. 在手机的 <kbd>设置</kbd><kbd>更多设置</kbd><kbd>语言与输入法设置</kbd><kbd>输入法管理</kbd> 中,启用 Yong 输入法。
3. 在手机的 <kbd>设置</kbd><kbd>更多设置</kbd><kbd>语言与输入法设置</kbd><kbd>当前输入法</kbd> 中,选择 Yong 输入法。
4. 在任意地方呼出输入法键盘。如果顺利的话,你将看到Yong输入法的键盘,并且手机里会生成 `sdcard/yong/.yong` 目录。
1. 运行 Yong 输入法图形设置程序,授予必须的权限(必须授予的权限有:“允许应用显示悬浮窗”,“允许访问所有文件”,建议授予的权限有:“自启动”、“读取通知类短信”、“读取联系人”、“读写剪切板”等)。
2.**图形设置界面 🞂 安卓 🞂 设置系统输入法**(或者在手机的**设置 🞂 更多设置 🞂 语言与输入法设置 🞂 输入法管理**中),启用 Yong 输入法。
3. 在任意地方呼出输入法键盘,并切换当前输入法为 Yong 输入法(如果无法切换,在手机的**设置 🞂 更多设置 🞂 语言与输入法设置 🞂 当前输入法管理**中,选择 Yong 输入法)。如果顺利的话,你将看到Yong输入法的键盘,并且手机里会生成 `sdcard/yong/.yong` 目录(这是一个隐藏目录,系统自带的文件管理器可能看不到)。

### 退出

在手机的 <kbd>设置</kbd><kbd>应用设置</kbd><kbd>应用管理</kbd> 中结束 Yong 输入法。
在手机的**设置 🞂 应用设置 🞂 应用管理**中结束 Yong 输入法。

## ** Linux **

!> 该安装方式尚未测试,不一定适用于所有Linux发行版。

### 安装

1. 下载并解压[原版小小输入法 Linux 版][小小输入法网盘](形如 `yong-lin-xxx.7z`)得到 `yong` 程序目录(可以覆盖已安装的旧版程序目录)。
2. 下载本项目,并将本项目的各个一级目录(如 `xxxk-xkcommon`)下的文件依次复制粘贴到程序目录下
2. [:fa fa-github: 小小星空仓库][小小星空仓库]下载本项目源代码,将 `home` 目录里的内容(最关键的是 `mb``entry` 目录)复制到小小输入法的配置目录中,然后将 yong-win.ini 更名为 yong.ini
3. 在终端中进入程序目录,并执行命令 `sudo ./yong-tool.sh --install`。如果想作为默认输入法,接着执行 `./yong-tool.sh --select`

!> 该安装方式不一定适用于所有Linux发行版,如果安装遇到问题请自行搜索解决方案。

### 启动

进入系统的区域与语言设置,添加输入法源,选择 <kbd>汉语</kbd><kbd>中文(yong)</kbd>,然后重启。
Expand Down
21 changes: 5 additions & 16 deletions usage-custom.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,6 @@

关于各设置项的说明参见[参考资料](#参考资料),这里不赘述。

大部分设置项,如果在 `配置目录/yong.ini` 中未定义,则会顺沿到 `程序目录/yong.ini` 中寻找。但某些设置项则不会顺沿:

* `[IM]` 段下的 0,1,……
* `[table]` 段后的 `[方案ID]`(如 `[xkjd6]`)段

## 修改码表文件

码表文件分三类:造词文件、本地码表文件、在线码表。
Expand All @@ -64,19 +59,13 @@

#### ** Android **

1. 手动造词:把想造的词的逐字打上屏,但保留最后一个字在候选栏(不要上屏) → 长按 <kbd>g</kbd> 进入加词面板 → 把最后一个字上屏 → 点<kbd>造词</kbd> → 用 <kbd>↑</kbd>/<kbd>↓</kbd> 选中目标词 → 检查并修改编码 → 按<kbd>↵</kbd> 确认。
2. 自动造词:经测试,Android 版开启此功能可能会导致程序崩溃,因此不启用。
3. 删词:把想删的词打到候选栏 → 长按 <kbd>g</kbd> 进入加词面板 → 点 <kbd>删词</kbd>。⚠ 注意,此功能在这种情况下会失效:当想删的词不是自造词(而是码表里的词),****没有重码(重码是指有两个以上不同词条的编码完全相同)时。
4. 手动调频:打出要调频的词到候选栏 → 用 <kbd>↑</kbd>/<kbd>↓</kbd> 选中目标词 → 用 <kbd>←</kbd>/<kbd>→</kbd> 调频。⚠ 注意,此功能仅在发生重码时有效。
5. 自动调频:默认未开启,此处不介绍。

> Android 版本目前的加词、删词、调频等操作与 Windows 版有所不同,未来可能会进行修改使它们统一。
?> 需要皮肤支持,先略,后续再补充。

<!-- tabs:end -->

### 本地码表文件

内置方案的本地码表文件位于 `程序目录/mb/方案ID` 目录,每次安装小小星空时都会被覆盖,因此**不建议用户修改**。用户应当[建立自己的方案](#建立自己的方案)
内置方案的本地码表文件位于 `配置目录/mb/方案ID` 目录,每次安装小小星空时都会被覆盖,因此**不建议用户修改**。用户应当[建立自己的方案](#建立自己的方案)

### 在线码表

Expand All @@ -93,7 +82,7 @@

![管理方案](_media\config-manage-schema.png)

?> 只有像内置方案那样,在 `程序目录/entry` 目录下拥有入口文件的方案才可被图形化配置程序 `yong-config.exe` 识别并加载。如果没有入口文件,那么卸载后就无法在图形化配置程序中加载回来。
?> 只有像内置方案那样,在 `entry` 目录下拥有入口文件的方案才可被图形化配置程序 `yong-config.exe` 识别并加载。如果没有入口文件,那么卸载后就无法在图形化配置程序中加载回来。

Android 系统没有图形化配置程序,只能手动加载或卸载编码方案:

Expand All @@ -104,7 +93,7 @@ Android 系统没有图形化配置程序,只能手动加载或卸载编码方

一个方案最少应包括主码表文件和入口文件。

* 主码表文件:GB18030 编码的 txt 文件,格式参见 `程序目录/mb/xkjd6/xkjd6_arg.txt`[参考资料](#参考资料)。注意自己方案的主码表文件最好不要放在 `程序目录/mb` 中,以免被覆盖
* 入口文件:UTF-8 编码的 ini 文件,格式参见 `程序目录/entry/xkjd6_entry.ini`[参考资料](#参考资料)。文件必须放在 `程序目录/entry` 目录下。入口文件的内容就是该方案的 `[方案ID]` 段。
* 主码表文件:GB18030 编码的 txt 文件,格式参见 `mb/xkjd6/xkjd6_arg.txt`[参考资料](#参考资料)
* 入口文件:UTF-8 编码的 ini 文件,格式参见 `entry/xkjd6_entry.ini`[参考资料](#参考资料)。文件必须放在 `entry` 目录下。入口文件的内容就是该方案的 `[方案ID]` 段。

准备好入口文件后,就可以在图形化配置程序 `yong-config.exe` 中快速加载或卸载自己的方案了。
4 changes: 2 additions & 2 deletions usage-typing.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@
<tr>
<td class="tg-sej6">;z = _</td>
<td class="tg-sej6">;x = ×<br>;xo = ÷</td>
<td class="tg-sej6">;c = `</td>
<td class="tg-sej6">;c = `<br>;cc=剪贴板→云<br>;cv=云→剪贴板</td>
<td class="tg-sej6">;v = √<br>;vv = ^</td>
<td class="tg-sej6">;b = %<br>;bo = ‰<br>;boo = ‱</td>
<td class="tg-sej6">;n = ‘</td>
Expand All @@ -148,7 +148,7 @@

输入法状态条的右键菜单里集成了一些命令,它们也可以通过键入编码来执行:

* `ooxx` 提供与**小小**输入法程序相关的功能:重启小小、配置小小、重载小小、重置小小、退出小小
* `ooxx` 提供与**小小**输入法程序相关的功能:重启小小、配置小小、重载小小、退出小小
* `oomb` 快速打开相关**码表**:在线码表、本地码表
* `ooml` 快速打开相关**目录**:程序目录、配置目录
* `oorm` 快速打开在线和本地**入门**说明书
Expand Down

0 comments on commit 538eb0c

Please sign in to comment.