Skip to content

Commit

Permalink
细化安装说明;简化输入法使用说明和一些表述;新增 docsify-image-caption 插件;新增小小星空 v2.0.0 的更新记录…
Browse files Browse the repository at this point in the history
…;简化封面,移除 gitee 镜像;根据项目结构调整开发指南
  • Loading branch information
tswwe committed Nov 17, 2024
1 parent 4ce0800 commit 7e04fa8
Show file tree
Hide file tree
Showing 31 changed files with 345 additions and 346 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.vscode/
39 changes: 10 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,47 +2,28 @@

## 项目背景

**小小星空**是一个致力于将**星空系列汉字编码方案**挂载到**小小输入法**的项目。
**小小星空**是一个致力于将**星空系列汉字编码方案**(以下简称**星空系列方案**挂载到**小小输入法**的项目。

对于初学者,你可能需要先了解以下名词:
在使用之前,你可能需要先了解以下名词:

* **输入法**:一个笼统的概念,可能被用于表示**编码方案****输入法编辑器**
* **汉字编码方案**:将键盘编码映射为汉字的一套规则,例如全拼、王码五笔、小鹤双拼等。本项目主要使用 *@吅吅大山* 创造的星空系列方案,是一类以[顶功上屏](https://zhuanlan.zhihu.com/p/291029476)、易学易用为主要特色的汉字编码方案。
* [输入法编辑器](https://docs.microsoft.com/zh-cn/windows/uwp/design/input/input-method-editors)(input method editor):接受用户键盘输入,依照某一输入方案进行处理,并输出相应文字符号的软件。常见的有:搜狗拼音输入法、王码五笔输入法、小鹤音形输入法等。其中,有一类特殊的输入法,例如[中州韵输入法引擎](https://rime.im/)(Rime Input Method Engine)、[多多输入法生成器](https://www.chinput.com/portal.php)[小小输入法][小小论坛](Yong)等,它们不专精于一种汉字编码方案,而是打造一个能够挂载各种编码方案的通用平台。本项目所使用的输入平台是由 *@dgod* 开发的小小输入法。
* **汉字编码方案**:将键盘编码映射为汉字的一套规则,例如全拼、王码五笔、小鹤双拼等。本项目主要使用 *吅吅大山* 创造的星空系列方案,是一类以[顶功上屏](https://zhuanlan.zhihu.com/p/291029476)、易学易用为主要特色的汉字编码方案。
* [输入法编辑器](https://docs.microsoft.com/zh-cn/windows/uwp/design/input/input-method-editors)(input method editor):接受用户键盘输入,依照某一输入方案进行处理,并输出相应文字符号的软件。常见的有:搜狗拼音输入法、王码五笔输入法、小鹤音形输入法等。其中,有一类特殊的输入法,例如[中州韵输入法引擎](https://rime.im/)(Rime Input Method Engine)、[多多输入法生成器](https://www.chinput.com/portal.php)[小小输入法][小小输入法论坛](Yong)等,它们不专精于一种汉字编码方案,而是打造一个能够挂载各种编码方案的通用平台。本项目所使用的输入平台是由 *@dgod* 开发的小小输入法。

> 与本项目类似的项目有:[:fa fa-github: RIME键道][RIME键道仓库][:fa fa-github: RIME星空两笔](https://gitee.com/morler/rime_xklb)等。它们的区别主要是小小输入法与RIME输入法的区别(**纯属个人观点,详细的差异还需亲身使用对比方能感知**):
> * 小小输入法:在 Windows 平台上的安装和使用更加方便和流畅
> * RIME输入法:跨平台更多(支持苹果)、支持 [:fa fa-github: 脚本扩展](https://github.com/tswwe/my-rime-lua)
?> 与本项目类似的项目有:[:fa fa-github: RIME键道][RIME键道仓库][:fa fa-github: RIME星空两笔](https://gitee.com/morler/rime_xklb)等。相比之下,小小输入法可能更加流畅,而 RIME 输入法则支持更多操作系统(包括 macOS)和 [:fa fa-github: 脚本扩展](https://github.com/tswwe/my-rime-lua)

## 快速上手

### 如果你是普通用户...

若想直接使用本项目的成果,请下载由本项目编译而成的**小小星空输入法**安装包:
请下载由本项目编译而成的**小小星空输入法**安装包:

* 下载地址1:[:fa fa-github: 小小星空仓库的发行版页面](https://github.com/xkinput/xxxk/releases)
* 下载地址2:[:fa fa-hdd-o: 永硕E盘][小小星空网盘]

下载完成后,别忘了继续阅读本文档。本文档主要包含以下章节,可在左侧边栏中快速定位:
下载完成后,推荐继续阅读本文档的以下章节(可在左侧边栏中快速定位

* [方案介绍](schema.md):新手必读——星空系列方案入门理论课
* [安装小小](install.md):新手必读——如何安装小小星空输入法
* [使用小小](usage.md):用户手册——如何使用小小输入法
* [开发指南](develop.md):开发者手册——如何参与贡献本项目
* [其他资源](res.md):一些好用的资源、工具和网站
* [更新历史](history.md):记录项目成长点滴

### 如果你是开发者...

除了阅读本文档,你也可前往 [:fa fa-github: 小小星空仓库][小小星空仓库] 查看本项目的结构。总的来说,本项目对小小输入法的修改被分类组织在不同的一级目录中,如下表所示。

| 目录 | 作用 |
| ----------------- | ---------------------------------------------------- |
| xxxk-xkcommon | 星空公用包。下面的每个星空系列方案都依赖于该公用包。 |
| xxxk-schema-xkjd6 | 星空键道6方案。 |
| xxxk-schema-xklb | 星空两笔方案。 |
| xxxk-schema-xkyb | 星空一笔方案。 |
| xxxk-schema-xkxb | 星空星笔方案。 |
* [安装小小](install.md):新手必读——如何安装**小小星空输入法**
* [使用小小](usage.md):用户手册——如何使用**小小输入法**

## 致谢

Expand Down Expand Up @@ -75,5 +56,5 @@
[小小星空网盘]: http://xxxk.ysepan.com/

[小小输入法网盘]: http://yongim.ysepan.com
[小小输入法论坛]:http://yong.dgod.net
[小小输入法论坛]: https://yong.dgod.net
[小小输入法仓库]: https://github.com/dgod/yong
6 changes: 0 additions & 6 deletions _coverpage.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,6 @@

[![stable-release](https://img.shields.io/github/v/release/xkinput/xxxk?color=green&label=stable-release)](https://github.com/xkinput/xxxk/releases) [![pre-release](https://img.shields.io/github/v/release/xkinput/xxxk?include_prereleases&label=pre-release)](https://github.com/xkinput/xxxk/releases) ![platform](https://img.shields.io/badge/platform-windows|android|linux-blue)

> 本站镜像:[xkinput.gitee.io/xxxk-help](https://xkinput.gitee.io/xxxk-help)
* 基于小小输入法,强大而轻巧
* 内置星空系方案,高效且易学
* 深度定制,优化体验

[<i class="fa fa-star-o"></i> &nbsp;关注项目](https://github.com/xkinput/xxxk) [<i class="fa fa-book"></i> &nbsp;快速上手](/README#快速上手)


Binary file added _media/config-manage-schema.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
Binary file added _media/lang-and-kbd-win10.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _media/lang-and-kbd-win7.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _media/lang-and-kbd-xp.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _media/run-tsf-on-win10.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _media/run-tsf-on-win7.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _media/run-tsf-on-xp.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions _plugins/docsify-image-caption-241117/jsdelivr.url
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[{000214A0-0000-0000-C000-000000000046}]
Prop3=19,11
[InternetShortcut]
IDList=
URL=https://www.jsdelivr.com/package/npm/@h-hg/docsify-image-caption?tab=files&path=dist
HotKey=0
45 changes: 0 additions & 45 deletions _plugins/echarts-220708/echarts.min.js

This file was deleted.

Binary file removed _plugins/echarts-220708/timeline.xlsx
Binary file not shown.
45 changes: 45 additions & 0 deletions _plugins/echarts-241117/echarts.min.js

Large diffs are not rendered by default.

File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,8 @@
['2021/5/5', 120640, '-'],
['2021/7/18', 120752, '项目迁移至Github'],
['2021/9/11', 120872, '发布小小星空v1.0.3'],
['2021/12/19', 120906, '发布小小星空v1.0.4']
['2021/12/19', 120906, '发布小小星空v1.0.4'],
['2024/11/17', 121386, '发布小小星空v2.0.0'],
],
},
tooltip: {
Expand Down
Binary file added _plugins/echarts-241117/timeline.xlsx
Binary file not shown.
7 changes: 3 additions & 4 deletions _sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,10 @@
* [字海两分](schema-zhlf.md)
* [安装小小](install.md)
* [使用小小](usage.md)
* [开始打字](usage-typing.md)
* [配置与码表](usage-custom.md)
* [扩展功能](usage-extend.md)
* [基本功能](usage-typing.md)
* [进阶设置](usage-custom.md)
* [其他扩展](usage-extend.md)
* [开发指南](develop.md)
* [定制本项目](develop-xxxk.md)
* [定制皮肤(PC)](develop-skin-pc.md)
* [其他资源](res.md)
* [更新历史](history.md)
Expand Down
57 changes: 55 additions & 2 deletions develop.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,58 @@
# :fa fa-code-fork: 开发指南

* [定制本项目](develop-xxxk.md)
前往 [:fa fa-github: 本项目仓库][小小星空仓库]获取源代码。解压后可以得到三个一级目录:

* `📂app-win`:存放编译生成**小小星空输入法**安装包的脚本。
* `📂data-base`:对原版**小小输入法**的一部分配置文件进行魔改得到的文件。
* `📂data-schema`**星空系列方案**的核心文件。

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

按照以下步骤,即可将本项目编译生成小小星空输入法安装包:

<!-- tabs:start -->

### ** Windows **

1. 把原版**小小输入法**的程序目录 `yong` 放到 `app-win` 目录下。
2. 根据自己的需要,修改 `app-win``data-base``data-schema` 目录下的文件。
3. 安装 NSIS,编译 `app-win/nsis/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 等工具进行签名。

### ** Linux **

请转至[:fa fa-github: 小小输入法项目仓库][小小输入法仓库]获取原版小小输入法 Linux 版的源代码。

<!-- tabs:end -->

在编译之前,您也可以先对项目进行修改:

* 定制 Windows 版编译脚本:待补充
* [定制皮肤(PC)](develop-skin-pc.md)
* 定制皮肤(Android):待补充
* 定制皮肤(Android):待补充

[星空QQ群]: https://jq.qq.com/?_wv=1027&k=5tVcZlL
[键道QQ群]: https://jq.qq.com/?_wv=1027&k=WxhhXU6u
[星空电报群]: https://t.me/xkinput

[星空官网]: https://xkinput.github.io
[RIME键道文档]: https://pingshunhuangalex.gitbook.io/rime-xkjd
[RIME键道仓库]: https://github.com/xkinput/Rime_JD

[小小星空首页]: https://xkinput.github.io/xxxk-help
[小小星空仓库]: https://github.com/xkinput/xxxk
[小小星空网盘]: http://xxxk.ysepan.com

[小小输入法网盘]: http://yongim.ysepan.com
[小小输入法论坛]: https://yong.dgod.net
[小小输入法仓库]: https://github.com/dgod/yong

15 changes: 13 additions & 2 deletions history.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,23 @@
# 更新历史

<iframe height='400' scrolling='no' title='小小星空更新时间线' src='_plugins/echarts-220708/timeline.html' frameborder='no' allowtransparency='true' allowfullscreen='true' style='width: 100%;'>小小星空更新时间线</iframe><!-- v5.3.3 -->
<iframe height='400' scrolling='no' title='小小星空更新时间线' src='_plugins/echarts-241117/timeline.html' frameborder='no' allowtransparency='true' allowfullscreen='true' style='width: 100%;'>小小星空更新时间线</iframe><!-- v5.3.3 -->

## 最近更新

##### [v2.0.0.0-Build20241117](https://github.com/xkinput/xxxk/releases/tag/v2.0.0)

*经测试,该版本的小小输入法在某些应用中以 TSF 模式运行时,会出现中英文状态切换异常的问题:使用中英文切换快捷键(如 SHIFT)切换为英文状态后,再按下任意键,会导致输入法立刻变回中文状态。临时解决方案:使用打开/关闭输入法快捷键(如 CTRL+SPACE)来代替中英文切换快捷键。*

* 调整项目架构为 app-win, data-base 和 data-schema 三个文件夹,方便后续维护
* 升级小小输入法程序到 20241116 版(详见[小小输入法更新记录](http://yong.dgod.net/read.php?tid=2&fid=2)
* 打包程序由 NSIS2 升级为 NSIS3(详见 [NSIS 更新记录](https://nsis.sourceforge.io/Docs/AppendixF.html)
* 重写安装脚本(`app-win/nsis/xxxk.nsi`),简化流程,加强用户权限识别等
* 键道码表跟进 RIME 版,主词条数:121386
* 更新帮助文档等资料

##### [v1.0.5.0(pre)-Build20220708](https://github.com/xkinput/xxxk/releases/tag/v1.0.5)

*这是一个预发行版本,只更新了依赖组件,未更新主码表。如果上一版本使用没什么问题,可以不更新到此版。*

* 改进:跟进小小输入法程序组件升级(Windows 版修复了一些程序 bug,Android 版不再支持 32 位,详见[小小输入法论坛帖子](http://yong.dgod.net/read.php?tid=2&fid=2)
* 改进:跟进小小输入法程序组件升级(Windows 版修复了一些程序 bug,Android 版不再支持 32 位)
* 改进:其他微调
3 changes: 2 additions & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@
},
footer: {
pre: '<hr/>',
copy: '<span>© 小小星空 2017-2022</span>',
copy: '<span>© 小小星空 2017-2024</span>',
auth: '@thXnder',
style: 'text-align: right;',
class: 'thxnder-footer-class',
Expand Down Expand Up @@ -119,6 +119,7 @@
<script src="_plugins/docsify-prism-220708/prism-ini.min.js"></script><!-- v1.28.0 -->
<script src="_plugins/docsify-prism-220708/prism-nsis.min.js"></script><!-- v1.28.0 -->
<script src="_plugins/docsify-themeable-211219/docsify-themeable.min.js"></script> <!-- v0.8.6 -->
<script src="_plugins/docsify-image-caption-241117/docsify-image-caption.min.js"></script> <!-- v0.1.2 -->

</body>
</html>
Loading

0 comments on commit 7e04fa8

Please sign in to comment.