Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

i18n: japanese #3

Merged
merged 5 commits into from
Jun 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@
sidebar_position: 3
---

# コマンド
- CDPSは簡単なCLIツールを提供して、対応する操作を実行します
# 命令
- CDPSは、対応する操作を実行するためのシンプルなCLIツールを提供する
:::note
- ソースコード以下のコマンドは、`cdps`を`python main.py`に置き換える必要があります
- 以下のコマンドはソースコードの下で、`cdps`を`python main.py`に置き換える必要があります
:::

## CDPSのヘルプメッセージを表示
## CDPSのヘルプメッセージを見る
- `-h` `--help`
```bash
cdps -h
Expand All @@ -18,7 +18,7 @@ cdps -h
- 例:`cdps pack -h`
:::

## CDPSのバージョンを表示
## CDPSバージョンを見る
- `-v` `--version`
```bash
cdps -v
Expand All @@ -35,12 +35,12 @@ cdps init
cdps start
```

## デフォルト設定 (config.yml) を再生成
## デフォルトのコンフィギュレーション(config.yml)を再生成する。
```bash
cdps gendefault
```

## パッケージング
## パッケージ
```bash
cdps pack --name {フォルダ名}
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@ sidebar_position: 2
---

# 設定
- あなたのCDPSサーバーをカスタマイズします
- CDPSサーバーのカスタマイズ

## 設定ファイル
- `./config.yml`
```yml
version: 1 # 設定ファイルのバージョン番号
version: 1 # configバージョン

# "DEBUG" , "INFO" , "WARN" , "ERROR"
log_level: "DEBUG" # ログレベル
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,30 +2,30 @@
sidebar_position: 8
---

# 依賴關係
- 擴充 之間的 依賴關係
# 依存関係
- エクステンション間の依存関係
:::note
- 這是說明 CDPS 擴充之間的依賴關係,如果要找 PyPI依賴 [點擊這裡](./pip)
- これはCDPS拡張機能の依存関係を説明するためのもので、PyPIの依存関係を見つけたい場合は[ここをクリック](./pip)
:::

## 聲明依賴
- `cdps.json` 中 聲明
## 依存関係の声明
- `cdps.json`では、次のように声明する。
:::tip
- 依賴中 `cdps` 為必須的
- 依存関係には`cdps`が必要である
:::
```json
{
// ...
"dependencies": {
"cdps": ">=1.0.18" // 擴充所需的 CDPS 最低版本
"cdps": ">=1.0.18" // CDPSの必要最小バージョンの拡張
},
// ...
}
```

## 用途
- 檢查是否有執行擴充所需的其他擴充
## 使用
- エクステンションの実行に必要な他のエクステンションがあるかどうかを確認する。
:::tip
- 舉例 `cdps_discord` 需要 `cdps_report` 來提供 地震報告 資料
- 上述例子 `cdps_report` 就是 `cdps_discord` 所需的依賴
- 例:`cdps_discord`は、地震レポート情報を提供するために`cdps_report`を必要とする
- 上記の例では、`cdps_report``cdps_discord`に必要な依存関係である
:::
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,23 @@
sidebar_position: 1
---

# 事件列表
- 查看可用的事件
# イベント一覧
- 利用可能なイベントを見る

## 目錄
- onServerStartEvent
- onServerCloseEvent
- onCommandEvent

## onServerStartEvent
#### 回傳參數 `pid`
- 當伺服器被啟動

#### 戻り値パラメータ`pid`
- サーバー起動時

## onServerCloseEvent
#### 回傳參數 `reason(關閉原因)`
#### パラメータ`reason(閉鎖の理由)`を返す
- 當伺服器被關閉

## onCommandEvent
#### 回傳參數 `command(用戶輸入內容)`
- 當用戶輸入指令到 terminal
#### パラメータ`command(ユーザー入力)`を返す
- ユーザーがターミナルにコマンドを入力すると
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,23 @@
sidebar_position: 5
---

# 完全載入
- 等待擴充完全載入後,再繼續下一步動作(載入其他擴充)
# 完全にロード
- エクステンションが完全にロードされるまで待ち、次のステップ(他のエクステンションのロード)に進みます。

:::danger
- 這個選項通常不需要使用
- 如果不清楚此選項用意,不要輕易使用
- このオプションは通常必要ない
- このオプションの意図がわからない場合は、軽々しく使わないこと
:::
:::tip
- 通常在使用了 `Inject 注入` 的擴充中,需要啟用此功能,確保 `Inject 注入` 完成
- `Inject 注入`を使用する拡張モジュールでは`Inject 注入`を確実に完了させるために、この機能を有効にする必要があります
:::

## 用法
- `cdps.json` 中 聲明
## 使用
- `cdps.json`では、次のように声明する。
```json
{
"version": "1.0.0",
"focus-load": true, // 新增這行
"focus-load": true, // 次の行を追加して
// ...
}
```
26 changes: 13 additions & 13 deletions i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,18 @@
sidebar_position: 7
---

# 雜項
- 這裡紀錄著,一些瑣碎的東西
# その他
- 些細なことの記録だ

## 目錄
- [事件列表](./events_list)
- [目錄樹](./tree)
- [多執行緒(threading)](./thread)
## カタログ
- [イベント一覧](./events_list)
- [カタログツリー](./tree)
- [マルチスレッド(threading)](./thread)
- [Inject 注入](./inject)
- [完全載入](./focus_load)
- [優先載入](./pre_load)
- [版本管理](./version)
- [依賴關係](./dependencies)
- [PyPI 依賴](./pip)
- [日誌紀錄](./log)
- [導入 擴充 的 函數](./plugin)
- [完全にロード](./focus_load)
- [優先にロード](./pre_load)
- [バージョン管理](./version)
- [依存関係](./dependencies)
- [PyPIの依存関係](./pip)
- [ジャーナル記録](./log)
- [拡張のインポート機能](./plugin)
36 changes: 18 additions & 18 deletions i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/inject.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,23 @@ sidebar_position: 4
---

# Inject 注入
- Server 啟動時會 觸發 `onServerStartEvent`
- 如果我的 擴充 想在 `onServerStartEvent` 前做些什麼 ( 通常是自製的 `日誌擴充` 等 需要在其他擴充前 初始化完成 )
- 這時 `Inject 注入` 就登場了
- 注入新的 `onServerStartEventForExample` 讓其在 `onServerStartEvent` 前 先被執行
- サーバが起動すると`onServerStartEvent`がトリガーされる。
- `onServerStartEvent`の前に何かをしたい拡張機能がある場合(通常、自作の拡張機能、例えば`ジャーナル拡張機能`など)。
- そこで登場するのが`Inject 注入`関数である。
- `onServerStartEvent`の前に実行される新しい`onServerStartEventForExample`を注入する。
:::danger
- 應謹慎使用 `Inject 注入` ,因其會破壞原生方法
- 使用 `Inject 注入` 的擴充,應在 README 中註明,提醒使用者
- `Inject 注入`の機能はネイティブのメソッドを壊してしまう可能性があるため、使用には注意が必要である
- `Inject 注入`を使用する拡張機能については、READMEにその旨を記述し、ユーザーに注意を促すべきである
:::
:::note
- 使用了 `Inject 注入` 的案例 [`color_log`](https://github.com/ExpTechTW/CDPS-color_log)。
- `Inject 注入`が使われたケースについては、[colour_log`](https://github.com/ExpTechTW/CDPS-color_log)を参照
:::

## 原始 類(class)、方法(function)
## プリミティブクラス(class)、メソッド(function
- `cdps/plugin/events.py`
```py
class onServerStartEvent(Event):
""" 當 伺服器 啟動 """
""" サーバー起動時 """

def __init__(self, pid):
self.pid = pid
Expand All @@ -29,38 +29,38 @@ class onServerStartEvent(Event):
def on_start(self):
self.event_manager.call_event(onServerStartEvent("start"))
```
## 定義新的類
## 新しいクラスを定義する
```py
from cdps.plugin.events import Event

class onServerStartEventForExample(Event):
""" 當 伺服器 啟動 """
""" サーバー起動時 """
def __init__(self, pid):
self.pid = pid
```
## 保留原始方法
## オリジナルの方法論の保持
```py
original_on_start = cdps.cdps_server.CDPS.on_start
```
## 定義新方法
## 新しい定義方法
```py
def _new_on_start(self):
self.event_manager.call_event(onServerStartEventForExample("example")) # 多了這行
original_on_start(self) # 呼叫原始方法
self.event_manager.call_event(onServerStartEventForExample("example")) # 次の行を追加した
original_on_start(self) # オリジナルメソッドの呼び出し
```
## 注入
```py
cdps.cdps_server.CDPS.on_start = _new_on_start
```

## 完成看起來像這樣
## 完成すると、こんな感じになる
```py
from cdps.plugin.manager import Manager , Listener
from cdps.plugin.events import Event
import cdps.cdps_server

class onServerStartEventForExampleEvent(Event):
""" 當 伺服器 啟動 """
""" サーバー起動時 """
def __init__(self, pid):
self.pid = pid

Expand All @@ -79,5 +79,5 @@ class onServerStartEventForExampleListener(Listener):
print(event.pid)

event_manager = Manager()
event_manager.register_listener(onServerStartEventForExampleListener()) # 別忘了監聽事件
event_manager.register_listener(onServerStartEventForExampleListener()) # イベントリスナーの利用を忘れずに
```
20 changes: 10 additions & 10 deletions i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/log.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,19 @@
sidebar_position: 10
---

# 日誌紀錄
- 輸出 日誌 到 控制台 並 紀錄到 文件 中
# ジャーナル記録
- コンソールにログをエクスポートし、ファイルに記録する

## 用法
- 獲取 log 實例
## 使用
- ログ取得例
:::tip
- Log 類 為 `單例` ,因此可以重複獲取,無需擔心重複
- ログクラス(class)はシングルインスタンスなので、重複を気にすることなく繰り返し取得できる
:::
```py
from cdps.utils.logger import Log # 導入 Log 類
log = Log() # 獲取 log 實例
log.logger.debug("除錯")
log.logger.info("資訊")
from cdps.utils.logger import Log # 導入ログクラス(class)
log = Log() # ログ取得例
log.logger.debug("デバッグ")
log.logger.info("インフォメーション")
log.logger.warning("警告")
log.logger.error("錯誤")
log.logger.error("エラー")
```
20 changes: 11 additions & 9 deletions i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/pip.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,28 @@
sidebar_position: 9
---

# PyPI 依賴
- 依賴的 PyPI 套件
# PyPIの依存関係
- 依存するPyPIパッケージ
:::note
- 這是說明 PyPI依賴,如果要找 CDPS 擴充之間的依賴關係 [點擊這裡](./dependencies)。

- これはPyPIの依存関係の説明です。CDPS拡張モジュール間の依存関係を調べるには、[ここをクリック](./dependencies)を参照。

:::

## 聲明依賴
- `cdps.json` 中 聲明
## 依存関係の声明
- `cdps.json`では、次のように声明する。
```json
{
// ...
"pip_dependencies": {
"websocket-client": ">=1.8.0" // 擴充所需的 CDPS 最低版本
"websocket-client": ">=1.8.0" // CDPSの必要最小バージョンの拡張
},
// ...
}
```

## 用途
- `pip_dependencies` 中 聲明 所需的 PyPI依賴,擴充管理器會檢查是否已安裝對應依賴
## 使用
- `pip_dependencies`で必要なPyPIの依存関係を宣言すると、拡張機能マネージャーは対応する依存関係がインストールされているかどうかを確認します
:::tip
- 擴充開發者,應加上此參數,避免使用者初次使用,因缺少依賴而崩潰
- 拡張機能の開発者は、このパラメータを追加して、ユーザーが初めてアプリケーションを使用するときに、依存関係がないためにアプリケーションがクラッシュするのを防ぐ必要があります
:::
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@
sidebar_position: 11
---

# 導入 擴充 的 函數
- 導入 特定擴充 中的 函數
# 拡張をインポートするための関数
- 特定の拡張機能の関数をインポートする。
:::tip
- 使用絕對路徑,從 `./plugins` 開始計算
- から始まる絶対パスを使用する。`/plugins`から始まる絶対パスを使用します
:::
```py
# main.py (report plugin)
from plugins.report.src.events import onReport # 導入自己的 函數
from plugins.discord_webhook import send_webhook # 導入 其他擴充 的 函數
from plugins.report.src.events import onReport # 独自の関数をインポートする
from plugins.discord_webhook import send_webhook # 他の拡張機能のインポート
```
Loading
Loading