Skip to content

Commit 10be86d

Browse files
berbermanberberman
committed
Add English version
1 parent 637335d commit 10be86d

File tree

12 files changed

+171
-26
lines changed

12 files changed

+171
-26
lines changed

‎.github/workflows/build.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,7 @@ jobs:
1717
python-version: 3.x
1818
- name: Install mkdocs-material
1919
run: pip3 install mkdocs-material
20+
- name: Install mkdocs-static-i18n
21+
run: pip3 install mkdocs-static-i18n
2022
- name: Deploy docs
2123
run: mkdocs gh-deploy --force

‎docs/faq.en.md‎

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
# FAQ
2+
3+
Some frequently asked questions.
4+
5+
## How to import table manually
6+
7+
Take importing [zhengma](https://github.com/fcitx/fcitx5-table-extra) as an example:
8+
9+
1. Obtain `zhengma.conf` and `zhengma.main.dict`
10+
2. Copy `zhengma.dict` to `/Android/data/org.fcitx.fcitx5.android/files/data/table/`
11+
3. In `zhengma.conf`, change the path specified after `[Table] File=` to `table/zhengma.dict`
12+
4. Copy modified `zhengma.conf` to `/Android/data/org.fcitx.fcitx5.android/files/data/inputmethod/`
13+
14+
!!! warning
15+
16+
Above paths may not apply if you configured [work profile](https://developer.android.com/work/versions/android-11#work).
17+
We recommend using the builtin file manager (via DocumentsUI) to manage the data of Fcitx5 for Android.
18+
19+
!!! note
20+
21+
Create `table` and `data` directories if they don't exist.
22+
23+
## How to remove input method entry
24+
25+
Swipe left on the entry until the backgournd changes to red with a trash can icon.
26+
27+
The same operation applies to other list-like UI, such as pinyin dictionary, punctuation mapping, etc.
28+
29+
## How to adjust the order of input methods
30+
31+
Long press on the entry util a shadow appears below, and then drag the entry to change the order.
32+
33+
## How to modify uncommitted text
34+
35+
When preedit shows in the keyboard, you can swipe on the space key to move the cursor; If it shows in application,
36+
you can move the cursor to the desired position directly by clicking.
37+
38+
!!! hint
39+
40+
This is useful when composing long sentences or modifying already entered contents.
41+
!!! note
42+
43+
To make preedit shows in application, enable *Show preedit in application* in *Global Options* and *Pinyin*. Then, disable *Ignore system cursor position* in *Behavior*.
44+
If the cursor jumps to the left after a moving, please disable *Fix embedded preedit cursor at the beginning of the preedit* in *Pinyin*.
45+
46+
## How to reset the input state
47+
48+
To clear the preedit and candidates, press and hold the backspace key, swiping left for a distance.
49+
50+
## How to export configruation files or user dictionary
51+
52+
The configuration files, input history, and user dictionary are saved to the external storage. The default path is `/sdcard/Android/data/org.fcitx.fcitx5.android/files/`.
53+
The input history and user dinctionary for Pinyin/Shuangpin are at `data/pinyin/user.{dict,history}`; those for Wubi are at `data/table/${name}.{dict,user.history}`.
54+
55+
!!! warning
56+
57+
Abosolute path above may not apply if you configured [work profile](https://developer.android.com/work/versions/android-11#work).
58+
We recommend using the builtin file manager (via DocumentsUI) to manage the data of Fcitx5 for Android.
59+
60+
61+
## How to import Pinyin dictionary
62+
63+
Fcitx 5 supports custom dictionaries. They are stored in `data/pinyin/dictionaries`.
64+
Fcitx 5 for Android registers three supported file types: `.dict`, `.scel`, and `.txt`, so uou can import the the dictionary by opening the file with Fcitx5 for Android.
65+
You can also manage the dictionary using *Pinyin Dictionaries* in settings.
66+
67+
## How to input emoticon, emoji, or specific unicode symbol
68+
69+
Press and hold `,` key, swiping towards one of the three icons popped up.
70+
71+
<center><img src="/assets/emoji-01.jpeg" alt="drawing" width="400"/></center>
72+
73+
The first icon actives unicode mode. You can search unicode by code or description:
74+
75+
<center><img src="/assets/unicode-01.jpeg" alt="drawing" width="400"/></center>
76+
77+
!!! hint
78+
79+
You can find the details of unicode symbols at [Unicode Character Table](https://unicode-table.com/en/) or [List of Unicode characters](https://en.wikipedia.org/wiki/List_of_Unicode_characters).
80+
81+
The second icon switches to emoji keyboard:
82+
83+
<center><img src="/assets/emoji-02.jpeg" alt="drawing" width="400"/></center>
84+
85+
The `:-)` key below switches to emoticon keyboard.
86+
87+
The third icon actives quick phrase:
88+
89+
<center><img src="/assets/quick-input-01.jpeg" alt="drawing" width="400"/></center>

‎docs/faq.md‎

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@
1313

1414
!!! warning
1515

16-
若您配置了[工作资料](https://developer.android.com/work/versions/android-11#work)，则上述路径可能不适用。您可以通过系统内置文件管理器来管理 Fcitx5 for Android 的数据文件。
16+
若您配置了[工作资料](https://developer.android.com/work/versions/android-11#work)，则上述绝对路径可能不适用。
17+
我们推荐您使用系统内置文件管理器（通过 DocumentsUI）来管理 Fcitx5 for Android 的数据文件。
1718

1819
!!! note
1920

@@ -42,19 +43,22 @@
4243
要启用应用内预编辑，请在 *全局选项 (Global Options)* 以及拼音设置中启用 *在程序中展示预编辑文本 (Show preedit in application)*，并在 *行为 (Behavior)* 中关闭 *忽略系统光标位置 (Ignore system cursor position)*。
4344
如果移动光标后，光标会自动跳回左侧，请禁用拼音设置中的 *将嵌入预编辑文本的光标固定在开头 (Fix embedded preedit cursor at the beginning of the preedit)*。
4445

45-
按住退格键并向左划动一段距离后松手，可以重置输入状态，快速清空预编辑文本及候选词。
46+
## 如何重置输入状态
47+
48+
按住退格键并向左划动一段距离后松手，可以重置输入状态、清空预编辑文本及候选词。
4649

4750
## 如何导出配置文件/用户词库
4851

49-
fcitx5 的配置文件、输入历史及用户词库存储在设备外置存储中，路径为 `/sdcard/Android/data/org.fcitx.fcitx5.android/files/` 。拼音和双拼输入法的用户词库/输入历史保存在 `data/pinyin/user.{dict,history}` ，五笔等码表输入法为 `data/table/${name}.{dict,user.history}` 。
52+
Fcitx 5 的配置文件、输入历史及用户词库存储在设备外置存储中，路径为 `/sdcard/Android/data/org.fcitx.fcitx5.android/files/` 。拼音和双拼输入法的用户词库/输入历史保存在 `data/pinyin/user.{dict,history}` ，五笔等码表输入法为 `data/table/${name}.{dict,user.history}` 。
5053

51-
使用系统内置文件管理器 (DocumentsUI)，在侧边栏中选择本应用的名称，也可以直接访问上述目录中的文件。
54+
!!! warning
5255

53-
## 如何为拼音输入法导入第三方词库
56+
若您配置了[工作资料](https://developer.android.com/work/versions/android-11#work)，则上述绝对路径可能不适用。
57+
我们推荐您使用系统内置文件管理器（通过 DocumentsUI）来管理 Fcitx5 for Android 的数据文件。
5458

55-
fcitx5 支持使用第三方[词库](https://wiki.archlinux.org/title/Fcitx5_(%E7%AE%80%E4%BD%93%E4%B8%AD%E6%96%87)#%E8%AF%8D%E5%BA%93)。第三方词库的 *.dict 文件也存储在与用户词库相同的目录下，路径是 `data/pinyin/dictionaries`。
59+
## 如何为拼音输入法导入第三方词库
5660

57-
你也可以在拼音输入法的设置界面中，点击`词库`，然后再点击右下方的加号手动添加第三方词库。
61+
Fcitx 5 支持使用第三方[词库](https://wiki.archlinux.org/title/Fcitx5_(%E7%AE%80%E4%BD%93%E4%B8%AD%E6%96%87)#%E8%AF%8D%E5%BA%93)。第三方词库的 *.dict 文件也存储在与用户词库相同的目录下，路径是 `data/pinyin/dictionaries`。Fcitx 5 for Android 注册了 `.dict`、 `.scel`，以及 `.txt` 文件打开打开方式，因此您可以直接用应用打开词典文件来导入。您也可以在拼音输入法的设置界面中使用 `词库` 来管理添加的词库。
5862

5963
## 如何输入颜文字、emoji 符号与特定的 unicode 符号
6064

@@ -66,7 +70,8 @@ fcitx5 支持使用第三方[词库](https://wiki.archlinux.org/title/Fcitx5_(%E
6670

6771
<center><img src="/assets/unicode-01.jpeg" alt="drawing" width="400"/></center>
6872

69-
相关的 Unicode 字符代号可参考：[Unicode Character Table](https://unicode-table.com/en/) 和 [Unicode 字符列表](https://zh.m.wikipedia.org/zh-cn/Unicode%E5%AD%97%E7%AC%A6%E5%88%97%E8%A1%A8)
73+
!!! hint
74+
相关的 Unicode 字符代号可参考 [Unicode Character Table](https://unicode-table.com/en/) 和 [Unicode 字符列表](https://zh.m.wikipedia.org/zh-cn/Unicode%E5%AD%97%E7%AC%A6%E5%88%97%E8%A1%A8)。
7075

7176
第二个图标会打开 emoji 列表：
7277

@@ -76,4 +81,4 @@ fcitx5 支持使用第三方[词库](https://wiki.archlinux.org/title/Fcitx5_(%E
7681

7782
第三个图标会激活快速输入功能：
7883

79-
<center><img src="/assets/quick-input-01.jpeg" alt="drawing" width="400"/></center>
84+
<center><img src="/assets/quick-input-01.jpeg" alt="drawing" width="400"/></center>

‎docs/index.en.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
hide:
3+
- navigation
4+
---
5+
6+
# Fcitx5 for Android
7+
8+
* Track the development on Trello: <https://trello.com/b/gftk6ZdV/kanban>
9+
* Join the Matrix room：<https://matrix.to/#/#fcitx5-android:mozilla.org>
10+
* Join the Telegram group: <https://t.me/+hci-DrFVWUM3NTUx>
11+
12+
!!! info
13+
14+
Telegram group and Matrix room are bridged.

‎docs/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ hide:
33
- navigation
44
---
55

6-
# 欢迎访问 Fcitx5 for Android 文档
6+
# Fcitx5 for Android
77

88
* 在 Trello 看板查看开发进程与计划：<https://trello.com/b/gftk6ZdV/kanban>
99
* 加入 Matrix 聊天室：<https://matrix.to/#/#fcitx5-android:mozilla.org>

‎docs/installation.en.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Installation
2+
3+
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.
4+
5+
## Updater
6+
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
12+
13+
A developer build is available in our [Telegram group](index.md).

‎docs/installation.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## 更新器
66

7-
更新器是一个独立的应用，它可以从 Jenkins 上下载和安装最近几次构建的 apk 安装包。目前，更新器仍是开发中的项目，它不在 Jenkins 上构建并分发二进制。您可以在 <https://github.com/fcitx5-android/fcitx5-android-updater> 获取它的源码自行构建安装。
7+
`fcitx5-android-updater` 是一个独立的应用，它可以从 Jenkins 上下载和安装最近几次构建的 apk 安装包。目前，更新器仍是开发中的项目，它不在 Jenkins 上构建并分发二进制。您可以在 <https://github.com/fcitx5-android/fcitx5-android-updater> 获取它的源码自行构建安装。
88

99
!!! info
1010

‎docs/privacy.en.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Privacy
2+
3+
`fcitx5-android` does not require internect access and does not collect any personal data.

‎docs/PRIVACY.md‎ renamed to ‎docs/privacy.md‎

File renamed without changes.

‎flake.lock‎

Lines changed: 6 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)