Skip to content

Commit 328eb0e

Browse files
committed
Update FAQ and installation
1 parent 65e4bfa commit 328eb0e

File tree

4 files changed

+57
-25
lines changed

4 files changed

+57
-25
lines changed

docs/faq.en.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ Some frequently asked questions.
1515

1616
In order to import a table manually, you need to have a correct input method configuration file `.conf` and convert the table dictionary in `.txt` form into `.dict` form using `libime_tabledict` command line tool.
1717

18-
1918
1. Obtain the configuration file of the input method (the filename extension should be `.conf` or `.conf.in`) and table dictionary (the filename extension should be `.dict` or `.txt`) to be imported. Take "zhengma" as an example, you can download `zhengma.conf.in` and `zhengma.txt` at [fcitx/fcitx5-table-extra](https://github.com/fcitx/fcitx5-table-extra).
2019
2. Open `zhengma.conf.in` with your favorite editor and modify the path specified after `[Table] File=` to `table/zhengma.dict`.
2120
3. Run command `libime_tabledict zhengma.txt zhengma.dict` to convert the table dictionary. This tool is usually provided by package called `libime` or `libime-bin` among Linux distributions.
@@ -95,11 +94,10 @@ The pinyin dictionary to be imported has to be in one of the following three for
9594
* [sougou scel dict](https://pinyin.sogou.com/dict/), a `.scel` file
9695
* libime text format, a `.txt` file where word, full pinyin, and weight form into three columns, e.g.
9796
```
98-
拼音 pin'yin 0
97+
拼音 pin'yin 0
9998
```
10099
* libime binary format, a `.dict` file which can be converted from text format using command line tool `libime_pinyindict`
101100

102-
103101
We recommend using `.txt` format if you want to make your own dictionary.
104102

105103
!!! note
@@ -138,17 +136,20 @@ The third icon actives quick phrase:
138136

139137
<center><img src="/assets/quick-input-01.jpeg" alt="drawing" width="400"/></center>
140138

141-
## How to fix the keyboard overlapping with the navigation bar
139+
## How to fix the keyboard overlapping with the navigation bar
142140

143141
The keyboard may overlap with the navigation bar on some specific devices:
144142

145143
<center><img src="/assets/overlap.jpg" alt="drawing" width="400"/></center>
146144

147145
The reason is not clear, but it can be fixed by setting *Navigation bar background* to *Follow keyboard color* in Theme settings.
148146

149-
## What is Share Input State in Global Options
147+
## What is "Activate By Default" in "Global Options"
148+
149+
## What is "Share Input State" in "Global Options"
150+
151+
This feature allows you to share the input context (mostly the active input method) between Apps. There are three options:
150152

151-
This feature allows you to share the input context (mostly the active input method) between Apps. There are three options: *All*, *Program*, and *No*.
152-
By selecting *All*, when you switch to another App, the input method will be switched to the same one in the new App.
153-
For *Program* and *No*, those two options have almost the same effect so far, since only one input context is assigned to each program.
154-
By selecting one of them, the active input method will not shared between Apps.
153+
- All: always use same input method when switching between Apps
154+
- Program: remember last used input method for each App
155+
- No: this is the default value. On Android, there is only one *InputContext* for each App, this option behaves exactly the same as *Program*

docs/faq.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
[fcitx5-android#175](https://github.com/fcitx5-android/fcitx5-android/pull/175) 中新增了码表输入法导入功能,`0.0.3-43` 及之后的版本可以使用以下方法快速导入码表:
88

99
1. 获取输入法配置文件(拓展名为 `.conf``.conf.in`)及码表词典(拓展名为 `.dict``.txt`)。以“郑码“为例,可以在 [fcitx/fcitx5-table-extra](https://github.com/fcitx/fcitx5-table-extra) 仓库中下载 `zhengma.conf.in``zhengma.txt`
10-
2. 打开输入法设置界面,选择 插件 → 码表(点击右侧的齿轮图标打开设置) → 管理码表输入法,点击右下角加号按钮,在弹出的对话框“导入码表”中选择第二项“从单独的文件中导入”。
10+
2. 打开输入法设置界面,选择 附加组件 → 码表(点击右侧的齿轮图标打开设置) → 管理码表输入法,点击右下角加号按钮,在弹出的对话框“导入码表”中选择第二项“从单独的文件中导入”。
1111
3. 在新弹出的对话框中,点击“码表输入法配置文件”,并选择第 1 步中下载的 `zhengma.conf.in`;点击“码表词典”,选择第 1 步中下载的 `zhengma.txt`。确认文件选择无误后,点击“确定”按钮。
1212
4. 应用会弹出“正在导入 zhengma.conf.in”的通知。如果配置文件及词典均无误,数秒后对话框会自动关闭,同时列表中出现“Zhengma”字样,导入完成。
1313

@@ -94,7 +94,6 @@ Fcitx 5 支持使用第三方[词库](https://wiki.archlinux.org/title/Fcitx5_(%
9494
排成三列
9595
* libime 二进制格式,一个 `.dict` 文件,可以用命令行工具 `libime_pinyindict` 从文本格式转换而来
9696
97-
9897
如果您想制作你自己的字典,我们建议使用 `.txt` 格式。
9998
10099
!!! note
@@ -108,6 +107,7 @@ Fcitx 5 支持使用第三方[词库](https://wiki.archlinux.org/title/Fcitx5_(%
108107
!!! hint
109108
110109
一些第三方词库可能会提供 libime 二进制格式,比如 [fcitx5-pinyin-zhwiki](https://github.com/felixonmars/fcitx5-pinyin-zhwiki) 和 [mw2fcitx](https://github.com/outloudvi/mw2fcitx)。
110+
111111
## 如何输入颜文字、emoji 符号与特定的 unicode 符号
112112
113113
按住键盘左下方的 `,` 键,然后将手指滑向上方出现的三个按钮之一
@@ -139,7 +139,14 @@ Fcitx 5 支持使用第三方[词库](https://wiki.archlinux.org/title/Fcitx5_(%
139139
140140
问题的原因尚不清楚,但您可以通过在主题设置中将 *导航栏背景 (Navigation bar background)* 设置为 *跟随键盘背景色 (Follow keyboard color)* 来修复。
141141
142-
## 全局选项中的共享输入状态是什么
142+
## “全局选项”中的“默认状态为激活”是什么
143+
144+
保持英文输入法在第一个的状态下,让首次打开键盘时的输入法状态为中文(即“激活”状态,一般情况下为第二个输入法)。在桌面上,英文输入法反映的是键盘布局,因此要放到第一个;在需要默认的输入状态是中文的情况下,才需要用这个选项。在手机上,如果需要默认输入状态为中文,也可以将中文输入法拖动至列表的首位。
145+
146+
## “全局选项”中的“共享输入状态”是什么
147+
148+
这个特性允许您在应用之间共享输入状态(主要是当前激活的输入法)。它提供三个选项:
143149
144-
这个特性允许您在应用之间共享输入状态(主要是当前激活的输入法)。它提供三个选项:*所有 (All)*,*程序 (Program)*,和 *无 (No)*。
145-
在选择 *所有 (All)* 时,当您切换到另一个应用,新应用会激活相同的输入法。目前 *程序 (Program)*,和 *无 (No)* 的效果几乎相同,因为每个程序只有一个输入状态。在选择它们中的一个时,激活的输入法不会在应用之间共享。
150+
- 所有 (All):在不同的应用之间切换时,总是使用相同的输入法
151+
- 程序 (Program):为每个应用记住当前激活的输入法
152+
- 否 (No):此项为默认值。在 Android 上,每个程序只有一个 *输入上下文 (InputContext)*,因此此项的作用与 *程序 (Program)* 完全相同

docs/installation.en.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,24 @@
11
# Installation
22

3+
## Tagged Releases
4+
5+
You can get stable version of fcitx5-android from GitHub Release / F-Droid / Google Play.
6+
7+
!!! note
8+
9+
fcitx5-android implements [reproducible build](https://f-droid.org/en/docs/Reproducible_Builds/),thus apk from GitHub Release and F-Droid can override each other. However due to Google Play restrictions, version from Google Play can't be overriden by other versions.
10+
11+
GitHub: [![release version](https://img.shields.io/github/v/release/fcitx5-android/fcitx5-android)](https://github.com/fcitx5-android/fcitx5-android/releases)
12+
13+
[<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png" alt="Get it on F-Droid" width="207" height="80">](https://f-droid.org/packages/org.fcitx.fcitx5.android)
14+
[<img alt="Get it on Google Play" src="https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png" width="207" height="80">](https://play.google.com/store/apps/details?id=org.fcitx.fcitx5.android)
15+
16+
## Latest CI Build
17+
318
You can download the latest build from [Jenkins](https://jenkins.fcitx-im.org/job/android/job/fcitx5-android/). There is an [Updater](#_2) to download and manage the installation as well.
419

520
## Updater
621

7-
`fcitx5-android-updater` is an independent app, which downloads and installs the apk from Jenkins.
8-
So far, the updater is work in progress, so it's not built and distributed in Jenkins.
9-
You can obtain the source code of the updater at <https://github.com/fcitx5-android/fcitx5-android-updater> to build and install it manually.
10-
11-
!!! info
22+
[fcitx5-android-updater](https://github.com/fcitx5-android/fcitx5-android-updater) is an independent App, which downloads and installs the apk from Jenkins, include plugins and the updater itself.
1223

13-
A developer build is available in our [Telegram group](index.md).
24+
You can download the updater from Jenkins as well: https://jenkins.fcitx-im.org/job/android/job/fcitx5-android-updater/

docs/installation.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,24 @@
11
# 安装
22

3-
您可以在 [Jenkins](https://jenkins.fcitx-im.org/job/android/job/fcitx5-android/) 上下载到最新构建的 apk 安装包。您也可以通过 [更新器](#_2) 来下载并管理版本。
3+
## 稳定发布版
44

5-
## 更新器
5+
您可以通过 GitHub Release / F-Droid / Google Play 这三种渠道获取稳定版本的 fcitx5-android 。
6+
7+
!!! note
8+
9+
fcitx5-android 实现了[可重复构建](https://f-droid.org/zh_Hans/docs/Reproducible_Builds/) ([reproducible build](https://f-droid.org/en/docs/Reproducible_Builds/)),因此 GitHub Release 与 F-Droid 下载的 apk 可以互相覆盖安装。然而由于 Google Play 政策的限制, Google Play 的版本无法与上述版本覆盖安装。
10+
11+
GitHub: [![release version](https://img.shields.io/github/v/release/fcitx5-android/fcitx5-android)](https://github.com/fcitx5-android/fcitx5-android/releases)
612

7-
`fcitx5-android-updater` 是一个独立的应用,它可以从 Jenkins 上下载和安装最近几次构建的 apk 安装包。目前,更新器仍是开发中的项目,它不在 Jenkins 上构建并分发二进制。您可以在 <https://github.com/fcitx5-android/fcitx5-android-updater> 获取它的源码自行构建安装。
13+
[<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png" alt="Get it on F-Droid" width="207" height="80">](https://f-droid.org/packages/org.fcitx.fcitx5.android)
14+
[<img alt="Get it on Google Play" src="https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png" width="207" height="80">](https://play.google.com/store/apps/details?id=org.fcitx.fcitx5.android)
15+
16+
## 最新 CI 构建版
17+
18+
您可以在 [Jenkins](https://jenkins.fcitx-im.org/job/android/job/fcitx5-android/) 上下载到最新构建的 apk ,或者通过 [更新器](#_2) 来下载并管理版本。
19+
20+
## 更新器
821

9-
!!! info
22+
[fcitx5-android-updater](https://github.com/fcitx5-android/fcitx5-android-updater) 是一个独立的应用,它可以从 Jenkins 上下载和安装最近几次构建的 apk 安装包,包括插件及更新器本身。
1023

11-
您也可以在 [Telegram 群](index.md) 中获取开发者临时构建并签名的版本。
24+
更新器也可以从 Jenkins 上下载: https://jenkins.fcitx-im.org/job/android/job/fcitx5-android-updater/

0 commit comments

Comments
 (0)