Skip to content

Commit 84a02ae

Browse files
coder3101swiftqwq
andauthored
Docs updates for 7.1 release (#379)
* Add documentation for stress testing * Format markdown * Add chinese translation * docs: update build-from-source instructions for ECM/KSH submodule removal extra-cmake-modules and syntax-highlighting are no longer bundled as submodules starting from v7.1. Users must install them from package managers or clone and build them manually. * fix: correct anchor link for template-path in Chinese stress testing docs --------- Co-authored-by: Yiming Zhang <i@zhangyiming.tech>
1 parent 3c10d6e commit 84a02ae

6 files changed

Lines changed: 106 additions & 12 deletions

File tree

content/docs/installation/build-from-source/_index.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,19 +24,24 @@ description: In this way, you can get the latest unreleased features and get rea
2424

2525
3. If CMake can't find the Qt installation path, you should set the environment variable: `CMAKE_PREFIX_PATH=%QtPath%/%QtVersion%/%Compiler%/lib/cmake`. For example, on macOS, you can run something like `export CMAKE_PREFIX_PATH="/usr/local/Cellar/qt/5.15.2"`.
2626
27-
4. Install KDE (kf5) Syntax Highlighting.
27+
4. Install [Extra CMake Modules](https://github.com/KDE/extra-cmake-modules) and [KDE (kf5) Syntax Highlighting](https://github.com/KDE/syntax-highlighting). These are **not** bundled as submodules and must be installed on the host system before building.
2828
2929
- On some Linux distributions and macOS, you can install from your package manager. For example, `sudo pacman -S syntax-highlighting5` on Arch Linux, [Homebrew KDE](https://github.com/KDE/homebrew-kde) and then `brew install kde-mac/kde/kf5-syntax-highlighting` on macOS.
3030
31-
- Otherwise, you can use CMake to build and install Extra CMake Modules first and then KSH:
31+
- Otherwise, you can clone and build them manually:
3232
3333
```sh
34-
cd third_party/extra-cmake-modules
34+
git clone --branch kf5 https://github.com/KDE/extra-cmake-modules.git
35+
cd extra-cmake-modules
3536
cmake -B build -S . -DBUILD_HTML_DOCS=OFF -DBUILD_MAN_DOCS=OFF -DBUILD_QTHELP_DOCS=OFF -DBUILD_TESTING=OFF
3637
cmake --build build --config Release --target install # may require sudo
37-
cd ../syntax-highlighting
38+
cd ..
39+
40+
git clone --branch kf5 https://github.com/KDE/syntax-highlighting.git
41+
cd syntax-highlighting
3842
cmake -B build -S . -DBUILD_HTML_DOCS=OFF -DBUILD_MAN_DOCS=OFF -DBUILD_QTHELP_DOCS=OFF -DBUILD_TESTING=OFF
39-
cmake --build build --config Release --target install
43+
cmake --build build --config Release --target install # may require sudo
44+
cd ..
4045
```
4146
4247
### Build

content/docs/installation/build-from-source/_index.ru.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,27 @@ description: In this way, you can get the latest unreleased features and get rea
1818

1919
3. If CMake can't find the Qt installation path, you should set the environment variable: `CMAKE_PREFIX_PATH=%QtPath%/%QtVersion%/%Compiler%/lib/cmake`. For example, on macOS, you can run something like `export CMAKE_PREFIX_PATH="/usr/local/Cellar/qt/5.15.1"`.
2020
21-
4. Run the following commands:
21+
4. Install [Extra CMake Modules](https://github.com/KDE/extra-cmake-modules) and [KDE (kf5) Syntax Highlighting](https://github.com/KDE/syntax-highlighting). These are **not** bundled as submodules and must be installed on the host system before building.
22+
23+
- On some Linux distributions and macOS, you can install from your package manager. For example, `sudo pacman -S syntax-highlighting5` on Arch Linux, [Homebrew KDE](https://github.com/KDE/homebrew-kde) and then `brew install kde-mac/kde/kf5-syntax-highlighting` on macOS.
24+
25+
- Otherwise, you can clone and build them manually:
26+
27+
```sh
28+
git clone --branch kf5 https://github.com/KDE/extra-cmake-modules.git
29+
cd extra-cmake-modules
30+
cmake -B build -S . -DBUILD_HTML_DOCS=OFF -DBUILD_MAN_DOCS=OFF -DBUILD_QTHELP_DOCS=OFF -DBUILD_TESTING=OFF
31+
cmake --build build --config Release --target install # may require sudo
32+
cd ..
33+
34+
git clone --branch kf5 https://github.com/KDE/syntax-highlighting.git
35+
cd syntax-highlighting
36+
cmake -B build -S . -DBUILD_HTML_DOCS=OFF -DBUILD_MAN_DOCS=OFF -DBUILD_QTHELP_DOCS=OFF -DBUILD_TESTING=OFF
37+
cmake --build build --config Release --target install # may require sudo
38+
cd ..
39+
```
40+
41+
5. Run the following commands:
2242
2343
- Linux/macOS:
2444

content/docs/installation/build-from-source/_index.zh.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,19 +23,24 @@ description: 通过这种方式,你可以使用最新的还未发布的特性
2323

2424
3. 如果 CMake 提示找不到 Qt 路径,你应该设置环境变量:`CMAKE_PREFIX_PATH=%QtPath%/%QtVersion%/%Compiler%/lib/cmake`。例如,在 macOS 上,你可以运行 `export CMAKE_PREFIX_PATH="/usr/local/Cellar/qt/5.15.2"`
2525

26-
4. 安装 KDE (kf5) Extra CMake Modules
26+
4. 安装 [Extra CMake Modules](https://github.com/KDE/extra-cmake-modules) 和 [KDE (kf5) Syntax Highlighting](https://github.com/KDE/syntax-highlighting)。它们**不再**作为子模块捆绑,必须在构建前安装到系统中
2727

2828
- 在一些 Linux 发行版和 macOS 系统上,你可以直接使用包管理器安装它们。例如,在 Arch Linux 上可以使用 `sudo pacman -S syntax-highlighting5`,在 macOS 上可以使用 [Homebrew KDE](https://github.com/KDE/homebrew-kde) 然后 `brew install kde-mac/kde/kf5-syntax-highlighting`
2929

30-
- 否则,你需要使用 CMake 先构建并安装 Extra CMake Modules 然后再是 KSH
30+
- 否则,你需要手动克隆并构建安装
3131

3232
```sh
33-
cd third_party/extra-cmake-modules
33+
git clone --branch kf5 https://github.com/KDE/extra-cmake-modules.git
34+
cd extra-cmake-modules
3435
cmake -B build -S . -DBUILD_HTML_DOCS=OFF -DBUILD_MAN_DOCS=OFF -DBUILD_QTHELP_DOCS=OFF -DBUILD_TESTING=OFF
3536
cmake --build build --config Release --target install # 可能需要 sudo
36-
cd ../syntax-highlighting
37+
cd ..
38+
39+
git clone --branch kf5 https://github.com/KDE/syntax-highlighting.git
40+
cd syntax-highlighting
3741
cmake -B build -S . -DBUILD_HTML_DOCS=OFF -DBUILD_MAN_DOCS=OFF -DBUILD_QTHELP_DOCS=OFF -DBUILD_TESTING=OFF
38-
cmake --build build --config Release --target install
42+
cmake --build build --config Release --target install # 可能需要 sudo
43+
cd ..
3944
```
4045

4146
### 构建

content/docs/installation/build-from-source/_index.zh_tw.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,27 @@ description: 此方式適合想要嘗鮮最新功能的使用者、協助進行
1818

1919
3. 若 CMake 找不到 Qt 的安裝路徑,需要設定環境變數:`CMAKE_PREFIX_PATH=%QtPath%/%QtVersion%/%Compiler%/lib/cmake`。以 macOS 而言,執行這個命令 `export CMAKE_PREFIX_PATH="/usr/local/Cellar/qt/5.15.1"`
2020

21-
4. 執行下列命令。
21+
4. 安裝 [Extra CMake Modules](https://github.com/KDE/extra-cmake-modules) 和 [KDE (kf5) Syntax Highlighting](https://github.com/KDE/syntax-highlighting)。它們**不再**作為子模組捆綁,必須在建置前安裝到系統中。
22+
23+
- 在 macOS 及某些 Linux 發行版,您可以透過套件管理系統來安裝。例如在 Arch Linux 上使用 `sudo pacman -S syntax-highlighting5`,在 macOS 上使用 [Homebrew KDE](https://github.com/KDE/homebrew-kde) 然後 `brew install kde-mac/kde/kf5-syntax-highlighting`
24+
25+
- 否則,您需要手動 clone 並建置安裝:
26+
27+
```sh
28+
git clone --branch kf5 https://github.com/KDE/extra-cmake-modules.git
29+
cd extra-cmake-modules
30+
cmake -B build -S . -DBUILD_HTML_DOCS=OFF -DBUILD_MAN_DOCS=OFF -DBUILD_QTHELP_DOCS=OFF -DBUILD_TESTING=OFF
31+
cmake --build build --config Release --target install # 可能需要 sudo
32+
cd ..
33+
34+
git clone --branch kf5 https://github.com/KDE/syntax-highlighting.git
35+
cd syntax-highlighting
36+
cmake -B build -S . -DBUILD_HTML_DOCS=OFF -DBUILD_MAN_DOCS=OFF -DBUILD_QTHELP_DOCS=OFF -DBUILD_TESTING=OFF
37+
cmake --build build --config Release --target install # 可能需要 sudo
38+
cd ..
39+
```
40+
41+
5. 執行下列命令。
2242

2343
- Linux/macOS:
2444

content/docs/preferences/actions/_index.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,3 +128,25 @@ If you switch to the correct tab when solving a problem, with this setting enabl
128128
Hide the time of the stopwatch and only show the time when the "Show" button is pressed.
129129

130130
This may reduce distractions caused by stopwatch updates.
131+
132+
## Stress Testing
133+
134+
### Programming language for the template
135+
136+
The programming language used for the generator template.
137+
138+
### Path to the template file
139+
140+
See [Template Path](../language/#template-path).
141+
142+
### Template Cursor Position Regex
143+
144+
See [Template Cursor Position](../language/#template-cursor-position).
145+
146+
### Template Cursor Position Offset Type
147+
148+
See [Template Cursor Position](../language/#template-cursor-position).
149+
150+
### Template Cursor Position Offset Characters
151+
152+
See [Template Cursor Position](../language/#template-cursor-position).

content/docs/preferences/actions/_index.zh.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,3 +126,25 @@ weight: 40
126126
隐藏计时结果,只在“显示”按钮按下时显示。
127127

128128
这或许可以避免计时结果更新使人分心。
129+
130+
## 对拍
131+
132+
### 模版使用的编程语言
133+
134+
数据生成器模版使用的编程语言
135+
136+
### 模板路径
137+
138+
参见 [模板路径](../language/#模板路径)
139+
140+
### 使用模板时光标初始位置定位使用的正则表达式
141+
142+
参见 [使用模板时的光标初始位置](../language/#使用模板时的光标初始位置)
143+
144+
### 使用模板时光标初始位置的偏移类型
145+
146+
参见 [使用模板时的光标初始位置](../language/#使用模板时的光标初始位置)
147+
148+
### 使用模板时光标初始位置的偏移字符量
149+
150+
参见 [使用模板时的光标初始位置](../language/#使用模板时的光标初始位置)

0 commit comments

Comments
 (0)