Skip to content

Commit

Permalink
改进:修订文档
Browse files Browse the repository at this point in the history
  • Loading branch information
tswwe committed Mar 11, 2022
1 parent 41c9e12 commit d9a2f18
Show file tree
Hide file tree
Showing 17 changed files with 1,091 additions and 1,072 deletions.
65 changes: 46 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,40 @@
# 项目概述

**小小星空**是一个致力于将**星空系列汉字编码方案**挂载到**小小输入法**的项目。
## 项目背景

> 与本项目类似的项目有:[:fa fa-home: RIME键道](https://github.com/xkinput/Rime_JD)。二者的区别主要是小小输入法与RIME输入法的区别:
> * 小小输入法:在Windows平台上的安装和使用更加方便和流畅
> * RIME输入法:跨平台更多(支持苹果)、可编写脚本扩展(例如[:fa fa-github: 我的RIME脚本仓库](https://github.com/tswwe/my-rime-lua)
>
> (以上纯属个人观点,详细的差异还需亲身使用对比方能感知)
**小小星空**是一个致力于将**星空系列汉字编码方案**挂载到**小小输入法**的项目。

## 名词解释
对于初学者,你可能需要先了解以下名词:

* **输入法**:一个笼统的概念,可能被用于表示**编码方案****输入法编辑器**
* **汉字编码方案**:将键盘编码映射为汉字的一套规则,例如全拼、王码五笔、小鹤双拼等。本项目主要使用*吅吅大山*创造的星空系列方案,是一类以[顶功上屏](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)[小小输入法](http://yong.dgod.net/)(Yong)等,它们不专精于一种汉字编码方案,而是打造一个能够挂载各种编码方案的通用平台。本项目所使用的输入平台是由*dgod*开发的小小输入法 ,其Windows版本在部署方便、运行流畅、功能丰富等方面获得了极佳的平衡
* **汉字编码方案**:将键盘编码映射为汉字的一套规则,例如全拼、王码五笔、小鹤双拼等。本项目主要使用 *@吅吅大山* 创造的星空系列方案,是一类以[顶功上屏](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)
本项目基于**小小输入法**进行了一些定制,以使其能更好地使用**星空系列汉字编码方案**
## 快速上手

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

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

* 下载地址1:[:fa fa-github: 项目仓库的发行版页面](https://github.com/xkinput/xxxk/releases)
* 下载地址2:[:fa fa-hdd-o: 永硕E盘](http://xxxk.ys168.com)
* 下载地址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):一些好用的资源、工具和网站
* [社区支持](community.md):加入星空大家庭,一起讨论和学习
* [更新历史](history.md):记录项目成长点滴

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

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

| 目录 | 作用 |
| ----------------- | ---------------------------------------------------- |
Expand All @@ -50,3 +44,36 @@
| xxxk-schema-xkyb | 星空一笔方案。 |
| xxxk-schema-xkxb | 星空星笔方案。 |

## 致谢

本项目离不开社区中的各位大佬和以下项目的支持:

### 社区

* [:fa fa-qq: 星空QQ群:320053116][星空QQ群] —— 接近满员,建议加入分流的键道QQ群
* [:fa fa-qq: 键道QQ群:865189947][键道QQ群]
* [:fa fa-telegram: 星空电报交流群][星空电报群]

### 项目

* [:fa fa-home: 星空官网][星空官网] —— 星空门户网站
* [:fa fa-home: RIME键道](https://github.com/xkinput/Rime_JD) —— 本项目内置键道方案的码表来源
* [:fa fa-hdd-o: 大牛的网盘](http://daniushuangpin.ysepan.com) —— 本项目内置星空一笔、星空二笔、星空星笔方案的码表来源
* [:fa fa-home: 字海两分输入法](http://cheonhyeong.com/Simplified/download.html) —— 本项目内置字海两分方案的码表来源
* [:fa fa-home: 小小输入法][小小输入法论坛] —— 本项目所用的输入法平台

[星空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.ys168.com/

[小小输入法网盘]: http://yongim.ys168.com
[小小输入法论坛]:http://yong.dgod.net
[小小输入法仓库]: https://github.com/dgod/yong
2 changes: 1 addition & 1 deletion _coverpage.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

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

> xkinput.github.io/xxxk-help
> 本站镜像:[xkinput.gitee.io/xxxk-help](https://xkinput.gitee.io/xxxk-help)
* 基于小小输入法,强大而轻巧
* 内置星空系方案,高效且易学
Expand Down
1 change: 0 additions & 1 deletion _navbar.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,5 @@
* [<i class="fa fa-question-circle"></i> 使用小小](usage.md)
* [<i class="fa fa-code-fork"></i> 开发指南](develop.md)
* [<i class="fa fa-archive"></i> 其他资源](res.md)
* [<i class="fa fa-comments"></i> 社区支持](community.md)
* [<i class="fa fa-pencil-square-o"></i> 更新历史](history.md)

4 changes: 3 additions & 1 deletion _sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
* [定制本项目](develop-xxxk.md)
* [定制皮肤(PC)](develop-skin-pc.md)
* [其他资源](res.md)
* [社区支持](community.md)
* [更新历史](history.md)
* [2019-2021 年归档](history-2019-2021.md)
* [2018 年归档](history-2018.md)
* [2017 年归档](history-2017.md)

27 changes: 0 additions & 27 deletions community.md

This file was deleted.

16 changes: 8 additions & 8 deletions develop-skin-pc.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@

## 了解皮肤结构

小小输入法Windows/Linux版的皮肤文件位于`程序目录/skin`目录下,可以是文件夹,也可以是zip压缩包
小小输入法 Windows/Linux 版的皮肤文件位于 `程序目录/skin` 目录下,可以是文件夹,也可以是 zip 压缩包

> 使用压缩包便于发布和维护,但是所有图片必须用png格式,且压缩包文件名不能含中文,才能被小小输入法识别。
>
> 你可以先以文件夹的形式制作皮肤,完成后再打包成压缩包
每个皮肤文件夹里除了包含若干图片(建议用`png`格式),还包含配置文件(`ini`格式,`utf-8`编码)。
每个皮肤文件夹里除了包含若干图片(建议用 png 格式),还包含配置文件(ini 格式,UTF-8 编码)。

最多可以有四个配置文件,名字分别为`skin.ini``skin0.ini``skin1.ini``skin2.ini`,分别代表四种不同的风格。
最多可以有四个配置文件,名字分别为 `skin.ini``skin0.ini``skin1.ini``skin2.ini`,分别代表四种不同的风格。

按照习惯,我一般会制作4个配置文件,分别对应默认(即双行)、双行、单行、多行风格。
按照习惯,我一般会制作 4 个配置文件,分别对应默认(即双行)、双行、单行、多行风格。

## 获取皮肤素材

Expand All @@ -29,7 +29,7 @@
## 修改配置文件

`ini`文件中,`#`号表示注释。下面以注释的形式,讲解了各选项(键值对)的作用。这些选项不是必须的,请按需选用。
ini 文件中,`#` 号表示注释。下面以注释的形式,讲解了各选项(键值对)的作用。这些选项不是必须的,请按需选用。

```ini
[about]
Expand Down Expand Up @@ -111,8 +111,8 @@

## 分享一些经验

候选窗背景使用颜色,字体设为Monospace 12,可以比较好地适应用户自定义字体。此类皮肤范例:芳味。
候选窗背景使用颜色,字体设为 Monospace 12,可以比较好地适应用户自定义字体。此类皮肤范例:芳味。

有的皮肤设计很好,即使是图片背景,不管字体设为Monospace 12,还是HiraginoSansGB-W3 14或微软雅黑 14,都可以比较好地适应。此类皮肤范例:DarkAbrasive,iType,MetalTech等。
有的皮肤设计很好,即使是图片背景,不管字体设为 Monospace 12,还是 HiraginoSansGB-W3 14 或微软雅黑 14,都可以比较好地适应。此类皮肤范例:DarkAbrasive,iType,MetalTech等。

有的皮肤,默认字体为Monospace 12,但是改成微软雅黑 14后,需要把纵坐标上移3个像素,例如WhiteTexture。
有的皮肤,默认字体为 Monospace 12,但是改成微软雅黑 14后,需要把纵坐标上移 3 个像素,例如WhiteTexture。
Loading

0 comments on commit d9a2f18

Please sign in to comment.