KiCad 文檔及翻譯貢獻

KiCad 安裝

KiCad 文檔

KiCad 在線文檔

KiCad 在線簡體中文文檔 目前簡體中文文檔和 i18n 由 kicad-cntaotieren 提供翻譯和維護。

KiCad 離線文檔

  • KiCad 文檔簡體中文倉庫,由於 Gitee 倉庫大小限制目前只提供編譯完後英文原版和簡體中文文檔下載。
  • KiCad 文檔簡體中文 PDF 下載 發行版只提供 PDF 文檔,需要其他格式文檔請自行到倉庫對應目錄下載。
  • 因爲 KiCad 在線文檔的 CI/CD 服務所使用的是 Ubuntu 14.04 系統,和我本地使用的 Manjaro Linux 編譯系統不一致,會存在簡體中文文檔編譯後顯示不全,甚至部分表格排序錯誤等問題,目前正在和 KiCad 文檔團隊溝通此問題,暫時提出使用多種不同編譯環境來編譯文檔,最後發行版本使用哪個編譯環境還沒確定。也有提出更新文檔編譯系統,也有提出更新文檔編譯方式,因爲編譯的文檔是通過 latex 來進行的。目前的 latex 是使用 Python2 開發,現在 Python 官方將放棄 Python2 的支持。
  • 如果需要閱讀簡體中文文檔前使用離線文檔閱讀或校對,如果在文檔閱讀中遇到不明白或者更好建議都可以到倉庫下提交建議或者問題。
  • 每次的簡體中文文檔發行版都會提供相應的修復和更新說明。

配置 git 代理

配置 git 的 http https 代理

Linux 和 Windows 都適用

# gitlab 服務器在國外下載速度速度收到很大影響。下面對 gitlab 配置 http https 代理。同理也可以對 github 配置 http https 代理。
git config --global http.https://gitlab.com.proxy socks5://127.0.0.1:1080
git config --global http.https://github.com.proxy socks5://127.0.0.1:1080

# 其中 socks5://127.0.0.1:1080 換成你使用代理服務。如:
git config --global http.https://gitlab.com.proxy http://127.0.0.1:8080

配置 git 的 ssh 代理

Linux 系統

# 需要安裝 openbsd-netcat 來實現轉發,以 Manjaro Linux 安裝爲例:
sudo pacman -S openbsd-netcat
# 在用戶目錄下的 .ssh/ 創建 config 文件
vim ~/.ssh/config
# 詳細配置如下
Host github.com
Host gitlab.com
ProxyCommand nc -X 5 -x 127.0.0.1:1080 %h %p
HostName %h
Port 22
User git
IdentityFile  ~/.ssh/id_rsa
IdentitiesOnly yes

Windows 系統

Windows 10 帶有 connect 轉發工具無需手動安裝。同樣也是在 在用戶目錄下(c:\User\username\.ssh\)的 .ssh\ 創建 config 文件

Host github.com
Host gitlab.com
ProxyCommand connect -S 127.0.0.1:1080 %h %p # -H 爲 HTTP
HostName %h
Port 22
User git
IdentityFile  ~/.ssh/id_rsa
IdentitiesOnly yes

KiCad i18n 翻譯

KiCad i18n 官方倉庫。翻譯使用的工具爲 PoEdit 不同操作系統下載安裝不同版本的工具。

克隆 kicad 源代碼和 kicad-i18n 倉庫

# 由於我在 kicad-i18n/zh_CN/kicad.po 中配置了自動從源代碼更新翻譯的功能。
# 目錄名爲 kicad-source-mirror 。克隆下來的源碼倉庫請重命名成 kicad-source-mirror 
# 需要將 kicad-source-mirror 和 kicad-18n 放在同一級目錄下。
git clone https://gitlab.com/kicad/code/kicad.git kicad-source-mirror

# 克隆 kicad-i18n 翻譯倉庫
git clone https://gitlab.com/kicad/code/kicad-i18n.git

切換分支

克隆下來的倉庫默認是在 master 分支下。如果如果修改其他分支翻譯需要切換兩個倉庫的分支狀態。

KiCad 源碼倉庫分支切換

# 進入 kicad 源碼目錄
cd kicad-source-mirror
# 切換到 5.1 分支
git checkout 5.1

# 切換到 master 分支
git checkout master

kicad-i18n 倉庫分支切換

# 進入 kicad 源碼目錄
cd kicad-i18n
# 切換到 5.1 分支
git checkout 5.1

# 切換到 master 分支
git checkout master

中文文案排版指南(翻譯前前先閱讀,注重排版規則,給用戶帶來更好的閱讀體驗。)

中文文案排版指南 倉庫 ,
鏡像地址:https://gitee.com/KiCAD-CN/chinese-copywriting-guidelines
在線閱讀地址:https://mazhuang.org/wiki/chinese-copywriting-guidelines/

關於 PoEdit 設置

補充一點關於 PoEdit 從源代碼中更新的操作。
按照我上述的 git clone 操作的一步步進行的話。單擊 PoEdit 中的 從源代碼更新 就能自動從源代碼中獲取最新的翻譯文件。

關於 PoEdit 的翻譯操作可以參考 KiCad-doc 中的 《如何使用 GUI 翻譯》手冊。

翻譯後單擊 保存 按鈕會進行自動編輯檢測會自動在 zh_CN 目錄下生成 kicad.mo 文件。可以用於下面的測試操作。
根據給出的提示就行操作。不懂的倉庫提問。

kicad-i18n 翻譯文件測試

Linux 下 master 分支翻譯文件測試。以 Manjaro Linux (Arch Linux 也可以)爲例:
配置 ArchLinuxCN 源使用方法:在 /etc/pacman.conf 文件末尾添加以下兩行:

[archlinuxcn]
Server = https://mirrors.tuna.tsinghua.edu.cn/archlinuxcn/$arch

之後安裝 archlinuxcn-keyring 包導入 GPG key。

安裝 KiCad master 分支版本:

# 打包的時候將 kicad-git 和 kicad-i18n-git 合併成 kicad-git。只需安裝 kicad-git 即可
yay -S kicad-git

替換翻譯文件

# 先備份舊的翻譯文件。以防新的翻譯文件存在嚴重問題導致 KiCad 運行崩潰。無法進行測試。
sudo mv /usr/share/kicad/internat/zh_CN/kicad.mo /usr/share/kicad/internat/zh_CN/kicad.mo.bak

# 複製 zh_CN/kicad.mo 到 /usr/share/kicad/internat/zh_CN/kicad.mo
sudo cp zh_CN/kicad.mo /usr/share/kicad/internat/zh_CN

啓動 KiCad 就能進行對應測試的操作。看看翻譯有沒有什麼嚴重問題。顯示問題排版問題等等。

Windows 到國內鏡像站 獲取 夜間測試版本 下載安裝。
在 KiCad 安裝目錄下 KiCad\share\kicad\internat\zh_CN\kicad.mo 先備份原始的翻譯文件。然後再用新的文件進行替換。
同樣也能下載 5.1 分支的測試版本進行翻譯測試。

提交 KiCad 翻譯到官方倉庫

kicad-i18n 官方倉庫,需要註冊 GitLab 賬戶。
這裏就用通過網頁的方式提交合並請求(PR):
在 kicad-i18n 網頁倉庫上 master 這裏選擇你想提交的你本地對應翻譯分支。
如你本地完成 5.1 分支的翻譯就在網頁倉庫這裏選擇 5.1 分支,然後單擊 zh_CN/kicad.po 進去後單擊 編輯 按鈕;
會出現一個在線的編輯框。用文本編輯器打開你本地對應分支的 kicad.po 文件並複製裏面的內容,全選在線編輯框的內容並刪除,然後粘貼你本地的翻譯內容到在線編輯框中。
提交信息建議填寫保持倉庫的簡潔性:Update Simplified Chinese translation
然後單擊 Commit changes(提交變更) 完成變更會進入到 New Merger Repuest(新建合併請求),還只是完成了變更過程,還需要一步提交過程。
如果你需要寫一些描述信息就可以在 Description(描述)中書寫你想表達的內容。填寫完成後單擊 Submit 合併請求 按鈕。完成合並請求提交。

如果想通過 git 命令完成合並請求提交,這個參考精通 Git 手冊第二版中介紹的 Git 命令行操作。

KiCad 插件

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章