From 79c42af72dee679f262801bc76500f9a727adae2 Mon Sep 17 00:00:00 2001 From: Miyashooooo Date: Tue, 4 Jun 2024 19:04:20 +0800 Subject: [PATCH 1/4] i18n: japanese --- .../current/cdps/command/index.mdx | 14 ++++---- .../current/cdps/config/index.mdx | 4 +-- .../current/cdps/more/dependencies.mdx | 22 ++++++------ .../current/cdps/more/events.mdx | 14 ++++---- .../current/cdps/more/focus_load.mdx | 16 ++++----- .../current/cdps/more/index.mdx | 26 +++++++------- .../current/cdps/more/inject.mdx | 36 +++++++++---------- .../current/cdps/more/log.mdx | 20 +++++------ .../current/cdps/more/pip.mdx | 18 +++++----- .../current/cdps/more/plugin.mdx | 10 +++--- .../current/cdps/more/pre_load.mdx | 16 ++++----- .../current/cdps/more/thread.mdx | 14 ++++---- .../current/cdps/more/tree.mdx | 2 +- .../current/cdps/more/version.mdx | 20 +++++------ .../current/cdps/start/index.mdx | 19 +++++----- .../current/cdps/start/install.mdx | 32 ++++++++--------- 16 files changed, 141 insertions(+), 142 deletions(-) diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/command/index.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/command/index.mdx index 3d86394..f8c3767 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/command/index.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/command/index.mdx @@ -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 @@ -18,7 +18,7 @@ cdps -h - 例：`cdps pack -h` ::: -## CDPSのバージョンを表示 +## CDPSバージョンを見る - `-v` `--version` ```bash cdps -v @@ -35,12 +35,12 @@ cdps init cdps start ``` -## デフォルト設定 (config.yml) を再生成 +## デフォルトのコンフィギュレーション（config.yml）を再生成する。 ```bash cdps gendefault ``` -## パッケージング +## パッケージ ```bash cdps pack --name {フォルダ名} ``` diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/config/index.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/config/index.mdx index 6ab1eb1..47d9661 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/config/index.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/config/index.mdx @@ -3,12 +3,12 @@ sidebar_position: 2 --- # 設定 -- あなたのCDPSサーバーをカスタマイズします。 +- CDPSサーバーのカスタマイズ。 ## 設定ファイル - `./config.yml` ```yml -version: 1 # 設定ファイルのバージョン番号 +version: 1 # configバージョン # "DEBUG" , "INFO" , "WARN" , "ERROR" log_level: "DEBUG" # ログレベル diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/dependencies.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/dependencies.mdx index 4ca3160..b89a151 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/dependencies.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/dependencies.mdx @@ -2,30 +2,30 @@ sidebar_position: 8 --- -# 依賴關係 -- 擴充 之間的 依賴關係 +# 依存関係 +- エクステンション間の依存関係 :::note -- 這是說明 CDPS 擴充之間的依賴關係，如果要找 PyPI依賴 [點擊這裡](./pip.mdx) +- これはCDPS拡張機能の依存関係を説明するためのもので、PyPIの依存関係を見つけたい場合は[ここをクリック](./pip.mdx) ::: -## 聲明依賴 -- 在 `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`に必要な依存関係である。 ::: \ No newline at end of file diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/events.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/events.mdx index 69a3d3e..8e39387 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/events.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/events.mdx @@ -2,8 +2,8 @@ sidebar_position: 1 --- -# 事件列表 -- 查看可用的事件 +# イベント一覧 +- 利用可能なイベントを見る ## 目錄 - onServerStartEvent @@ -11,13 +11,13 @@ sidebar_position: 1 - onCommandEvent ## onServerStartEvent -#### 回傳參數 `pid` -- 當伺服器被啟動 +#### 戻り値パラメータ`pid` +- サーバー起動時 ## onServerCloseEvent -#### 回傳參數 `reason(關閉原因)` +#### パラメータ`reason（閉鎖の理由）`を返す - 當伺服器被關閉 ## onCommandEvent -#### 回傳參數 `command(用戶輸入內容)` -- 當用戶輸入指令到 terminal \ No newline at end of file +#### パラメータ`command(ユーザー入力)`を返す +- ユーザーがターミナルにコマンドを入力すると \ No newline at end of file diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/focus_load.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/focus_load.mdx index dd8d1e2..68ad323 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/focus_load.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/focus_load.mdx @@ -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, // 次の行を追加して // ... } ``` \ No newline at end of file diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/index.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/index.mdx index 6e639e1..2235edd 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/index.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/index.mdx @@ -2,18 +2,18 @@ sidebar_position: 7 --- -# 雜項 -- 這裡紀錄著，一些瑣碎的東西 +# その他 +- 些細なことの記録だ -## 目錄 -- [事件列表](./events.mdx) -- [目錄樹](./tree.mdx) -- [多執行緒(threading)](./thread.mdx) +## カタログ +- [イベント一覧](./events.mdx) +- [カタログツリー](./tree.mdx) +- [マルチスレッド(threading)](./thread.mdx) - [Inject 注入](./inject.mdx) -- [完全載入](./focus_load.mdx) -- [優先載入](./pre_load.mdx) -- [版本管理](./version.mdx) -- [依賴關係](./dependencies.mdx) -- [PyPI 依賴](./pip.mdx) -- [日誌紀錄](./log.mdx) -- [導入 擴充 的 函數](./plugin.mdx) \ No newline at end of file +- [完全にロード](./focus_load.mdx) +- [優先にロード](./pre_load.mdx) +- [バージョン管理](./version.mdx) +- [依存関係](./dependencies.mdx) +- [PyPIの依存関係](./pip.mdx) +- [ジャーナル記録](./log.mdx) +- [拡張のインポート機能](./plugin.mdx) \ No newline at end of file diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/inject.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/inject.mdx index a371c3b..0fadc6b 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/inject.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/inject.mdx @@ -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 @@ -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 @@ -79,5 +79,5 @@ class onServerStartEventForExampleListener(Listener): print(event.pid) event_manager = Manager() -event_manager.register_listener(onServerStartEventForExampleListener()) # 別忘了監聽事件 +event_manager.register_listener(onServerStartEventForExampleListener()) # イベントリスナーの利用を忘れずに ``` \ No newline at end of file diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/log.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/log.mdx index f54cbf4..419d467 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/log.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/log.mdx @@ -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("エラー") ``` \ No newline at end of file diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/pip.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/pip.mdx index e24af31..4c2541a 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/pip.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/pip.mdx @@ -2,26 +2,26 @@ sidebar_position: 9 --- -# PyPI 依賴 -- 依賴的 PyPI 套件 +# PyPIの依存関係 +- 依存するPyPIパッケージ :::note -- 這是說明 PyPI依賴，如果要找 CDPS 擴充之間的依賴關係 [點擊這裡](./dependencies.mdx)。 +- これはPyPIの依存関係の説明です。CDPS拡張モジュール間の依存関係を調べるには、[ここをクリック](./dependencies.mdx)を参照。 ::: -## 聲明依賴 -- 在 `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 -- 擴充開發者，應加上此參數，避免使用者初次使用，因缺少依賴而崩潰。 +- 拡張機能の開発者は、このパラメータを追加して、ユーザーが初めてアプリケーションを使用するときに、依存関係がないためにアプリケーションがクラッシュするのを防ぐ必要があります。 ::: \ No newline at end of file diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/plugin.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/plugin.mdx index f77fee0..3804623 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/plugin.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/plugin.mdx @@ -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 # 他の拡張機能のインポート ``` \ No newline at end of file diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/pre_load.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/pre_load.mdx index 47b851f..a5af56a 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/pre_load.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/pre_load.mdx @@ -2,21 +2,21 @@ sidebar_position: 6 --- -# 優先載入 -- 優先被 擴充管理器 載入 +# 優先にロード +- 拡張機能マネージャーがロードする優先順位。 :::caution -- 擴充管理器 會根據 擴充之間的依賴關係，自動調整載入順序。 -- 這個選項通常不需要使用。 -- 如果不清楚此選項用意，不要輕易使用。 +- 拡張機能マネージャーがローは、エクスパンション間の依存関係に基づいて、ロード順序を自動的に調整します。 +- このオプションは通常必要ない。 +- このオプションの意図がわからない場合は、軽々しく使わないこと。 ::: -## 用法 -- 在 `cdps.json` 中 聲明 +## 使用 +- `cdps.json`では、次のように声明する。 ```json { "version": "1.0.0", - "pre-load": true, // 新增這行 + "pre-load": true, // 次の行を追加してください // ... } ``` \ No newline at end of file diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/thread.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/thread.mdx index 474b7b9..cb3e8c5 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/thread.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/thread.mdx @@ -2,14 +2,14 @@ sidebar_position: 3 --- -# 多執行緒 -- 在 擴充 中使用 threading +# マルチスレッド +- 擴充功能でマルチスレッドを使用する。 ## task_run -- 捕獲 Plugin Loader 傳入的 stop_event -#### ❗不推薦的做法 +- Plugin Loaderから渡されたstop_eventをキャッチする。 +#### ❗推奨されない :::tip -- 在 CDPS `>= 1.0.18` 後，有更好的方法 使用threading 請看 [裝飾器](#new_thread)。 +- `CDPS`>= 1.0.18`以降では、より良い方法があります。[デコレーター（decorator）](#new_thread)を参照して、threadingを使用してください。 ::: ```py import threading @@ -35,9 +35,9 @@ def task_run(stop_event): ``` ## new_thread -- 使用 裝飾器 裝飾 函數，被裝飾的函數將會在 多執行緒 中 執行。 +- デコレーター（decorator）を使って関数をデコレートすると、デコレートされた関数は複数のスレッドで実行される。 :::note -- 需要呼叫一次函數。 +- 関数呼び出しが必要である。 ::: ```py from cdps.plugin.thread import new_thread diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/tree.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/tree.mdx index 49392d3..b19f7f5 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/tree.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/tree.mdx @@ -2,7 +2,7 @@ sidebar_position: 2 --- -# 目錄樹 +# カタログツリー ``` CDPS/ main.py diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/version.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/version.mdx index 81e9daf..c6dbd73 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/version.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/version.mdx @@ -2,21 +2,21 @@ sidebar_position: 7 --- -# 版本管理 -- 擴充作者 應做好 版本管理 +# バージョン管理 +- 拡張機能の作者はバージョン管理を正しく行わなければならない -## 擴充版本命名方式 +## 拡張機能されたバージョンの命名規則 - `X.Y.Z` -### X 主版號 -- 應跟隨 `CDPS` 的主版號。 +### X 主なバージョン番号 +- CDPS`のマスターバージョン番号と一致しなければならない。 :::tip -- 例如 example 擴充 `2.0.1` ，就能很明顯看出是給 CDPS `2.X.X` 使用的。 +- 例えば、exampleの拡張機能のバージョン番号が`2.0.1`の場合、CDPS`2.X.X`で使用されていることは明らかです。 ::: -### Y 次版號 -- 擴充新增功能後，應增加 `次版號`，然後 `修訂號` 歸零。 +### Y バージョン番号 +- 拡張機能に新しい機能が追加されたら、`サブバージョン番号`を追加し、`リビバージョン番号`をゼロにしなければなりません。 :::tip - 1.1.5 -> 1.2.0 - 1.5.8 -> 2.0.0 ::: -### Z 修訂號 -- 擴充修復錯誤或問題 增加 `修訂號`。 \ No newline at end of file +### Z リビバージョン番号 +- バグや問題の修正`リビバージョン番号`を追加する。 \ No newline at end of file diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/start/index.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/start/index.mdx index 5a45989..325b27c 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/start/index.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/start/index.mdx @@ -4,23 +4,22 @@ sidebar_position: 1 # CDPS -- 複合災害防止サーバー（Composite Disaster Prevention Server） +- Composite Disaster Prevention Server（複合防災サーバー） -## 用途 +## 使用 -- 「モジュール化」の設計を通じて、防災情報をより多くの用途に活用できるようにします。 +- `モジュール`設計により、防災情報をより活用することができる。 ## シナリオ -- 地震報告をDiscordやSlackに同時に送信する必要がある場合、[report](https://github.com/ExpTechTW/CDPS/blob/master/docs/zh/user/plugins.md) プラグインをインストールして地震報告を受け取り、DiscordとSlackのプラグインをインストールして情報をDiscordとSlackに送信します。 - +- `Discord`と`Slack`に同時に地震情報を送信する必要がある場合は、[報告](https://github.com/ExpTechTW/CDPS/blob/master/docs/zh/user/plugins.md)プラグインをインストールして地震情報を受信し、DiscordとSlack用のPluginをインストールしてDiscordとSlackに情報を送信することができます。 :::note -- Discordプラグインは、CDPS用にDiscordにメッセージを送信するプラグインです。 -- Slackプラグインは、CDPS用にSlackにメッセージを送信するプラグインです。 +- Discordプラグインは、Discordにメッセージを送信するためのCDPS用プラグインです。 +- Slackプラグインは、Slackにメッセージを送信するためのCDPS用プラグインです。 ::: -## 総括 -- 一度の地震報告情報を受け取ることで、防災情報の伝達効率を高めることができます。 +## 結論 +- ひとつの地震速報を受信することで、防災情報伝達の効率化など、さまざまな用途に活用できる。 :::note -- 需要に応じてカスタマイズが可能です。 +- あなたのニーズに応じて別のプラグインをインストールしたり、独自のプラグインを作成することができます。 ::: \ No newline at end of file diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/start/install.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/start/install.mdx index b061764..b115ff6 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/start/install.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/start/install.mdx @@ -2,12 +2,12 @@ sidebar_position: 2 --- -# はじめに +# 開始 ## インストール -- PyPIを使用してCDPSをインストールします。 +- PyPIを使ってCDPSをインストールしてください。 -| CDPS バージョン | Python 依存関係 | +| CDPSバージョン | Python依存関係 | | --------------- | -------------- | | `>= 1.0.0` | `>= 3.8` | @@ -15,31 +15,31 @@ sidebar_position: 2 pip install cdps ``` :::caution -- Pythonの開発環境は `3.10.0` です。開発環境より低いバージョンでの実行は推奨されません。 +- Pythonの開発環境は`3.10.0`であり、それ以下のバージョンでPythonを実行することは推奨されない。 ::: -## 初期設定 -- `my_cdps` という名前のフォルダーを作成します。 +## 初期化 +- `my_cdps`というフォルダを作成する ```bash mkdir my_cdps ``` -- `my_cdphs` フォルダ内に進みます。 +- `my_cdps`フォルダに移動する。 ```bash cd ./my_cdps ``` -- 初期化して必要なファイルを生成します。 +- 初期化 必要なファイルの生成 ```bash cdps init ``` :::caution -- 次のようなメッセージが表示されるかもしれません： +- 次のような警告が表示されることがある： ```bash 'cdps' is not recognized as an internal or external command, operable program or batch file. ``` -- これは環境変数が正しく設定されていないためです。 -- 設定(Windows) -> システム -> 情報 -> システム詳細設定 -> 環境変数 -> システム変数 -> 変数(Path) -- 値の中には次の三行が含まれている必要があります（`{User}`はコンピュータのユーザー名に置き換え、`Python310`はインストールされているPythonのバージョンによって異なります）： +- このエラーの原因は、環境変数が正しく設定されていないことである。 +- 「設定（Windows）」→「システム」→「情報」→「システム詳細設定」→「環境変数」→「システム変数」→「変数（パス）」。 +- 以下の3行をvalueに入れ、( `{User}`をコンピュータのユーザー名に置き換える。`Python310`は、インストールされているPythonのバージョンによって異なる)： ```bash C:\Program Files\Python310\Scripts\ C:\Program Files\Python310\ @@ -47,15 +47,15 @@ C:\Users\{User}\AppData\Roaming\Python\Python310\Scripts\ ``` ::: :::note -- 新しい環境変数を適用するために、ターミナルを再起動することを忘れないでください。 +- 新しい`環境変数`が適用されるように、ターミナルを開き直すことをお忘れなく。 ::: -- 実行します。 +- 実行 ```bash cdps ``` -## アップデート -- PyPIを使用してCDPSを更新します。 +## 更新 +- PyPIを使ってCDPSを更新してください。 ```bash pip install --upgrade cdps ``` \ No newline at end of file From 1fac35520e2a562500f71e7394403d2b0a2fc1ae Mon Sep 17 00:00:00 2001 From: Miyashooooo Date: Wed, 5 Jun 2024 23:43:25 +0800 Subject: [PATCH 2/4] i18n: japanese --- .../current/cdps/plugin/event.mdx | 28 ++++++------- .../current/cdps/plugin/file.mdx | 14 +++---- .../current/cdps/plugin/index.mdx | 28 ++++++------- .../current/cdps/plugin/more.mdx | 6 +-- .../current/cdps/plugin/pack.mdx | 18 ++++----- .../current/cdps/plugin/start.mdx | 40 +++++++++---------- .../current/cdps/plugins/color_log.mdx | 20 +++++----- .../current/cdps/plugins/discordwebhook.mdx | 16 ++++---- .../current/cdps/plugins/example.mdx | 18 ++++----- .../current/cdps/plugins/index.mdx | 8 ++-- .../current/cdps/plugins/report.mdx | 18 ++++----- .../current/cdps/plugins/websocketclient.mdx | 22 +++++----- 12 files changed, 118 insertions(+), 118 deletions(-) diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugin/event.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugin/event.mdx index e58382d..b482fb6 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugin/event.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugin/event.mdx @@ -3,39 +3,39 @@ sidebar_position: 2 --- # 事件 -監聽發生的事件，並做出對應回應 +イベントが発生したら、それに対応する処理を行う ## register_listener -- 定義一個 Listener 後，向 事件管理器 註冊 -#### ❗不推薦的做法 +- イベントリスナを定義したら、イベントマネージャーに登録する。 +#### ❗推奨されない :::tip -- 在 CDPS `>= 1.0.15` 後，有更好的方法 註冊事件 請看 [裝飾器](#event_listener) +- CDPS `>= 1.0.15` 以降では、イベントを登録するため（註冊事件）のより良い方法があります。 ::: ```py -from cdps.plugin.manager import Listener, Manager # 導入 事件管理器 及 Listener(抽象) -from cdps.plugin.events import onServerStartEvent # 導入 伺服器啟動 事件 +from cdps.plugin.manager import Listener, Manager # イベントマネージャーとイベントリスナのインポート +from cdps.plugin.events import onServerStartEvent # サーバー起動イベントのインポート -class onServerStartListener(Listener): # 定義一個 監聽器 - event = onServerStartEvent # 定義 監聽的事件 +class onServerStartListener(Listener): # イベントリスナの定義 + event = onServerStartEvent # イベントリスナのイベントを定義する - def on_event(self, event): # 實作方法 + def on_event(self, event): # ハンズオン print("Hello World") -event_manager = Manager() # 獲取 事件管理器 實例 -event_manager.register_listener(onServerStartListener()) # 註冊 監聽器 到 事件管理器 +event_manager = Manager() # キャッチアップイベントマネージャー 実践例 +event_manager.register_listener(onServerStartListener()) # イベントリスナをイベントマネージャーに登録する ``` ## event_listener -- 使用 裝飾器 裝飾 函數，被裝飾的函數將會作為對應事件的 回調函數。 -- 傳入要監聽的事件 +- 装飾家（Decorator）を使用して関数をデコレートすると、デコレートされた関数が対応するイベントのコールバック関数として使用されます。 +- リスナすべきイベントを渡す ```py from cdps.plugin.events import onServerStartEvent from cdps.plugin.manager import Listener, event_listener -@event_listener(onServerStartEvent) # 裝飾器 +@event_listener(onServerStartEvent) # 装飾家（Decorator） class onServerStartListener(Listener): def on_event(self, event): diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugin/file.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugin/file.mdx index 9929a5e..205ca37 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugin/file.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugin/file.mdx @@ -2,20 +2,20 @@ sidebar_position: 3 --- -# 檔案讀取 +# ファイルリーディング -## 擴充的 config 讀取 -- 擴充給使用者的自定義設定檔 +## エクステンションの設定を読む +- ユーザー定義プロファイルの拡張機能 ```py -with open("./config/{擴充名稱}.json", 'r', encoding='utf-8') as file: +with open("./config/{拡張機能の名前}.json", 'r', encoding='utf-8') as file: content = file.read() print(content) ``` -## 擴充內的檔案讀取 -- 隨擴充一起封裝，用於不會變化的文件 +## 拡張機能でファイルを読み込む +- は拡張機能とともにパッケージ化され、変更のない文書に使用される ```py -with open("./plugins/{擴充名稱}/test.txt", 'r', encoding='utf-8') as file: +with open("./plugins/{拡張機能の名前}/test.txt", 'r', encoding='utf-8') as file: content = file.read() print(content) ``` \ No newline at end of file diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugin/index.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugin/index.mdx index 6db816b..e3a1efb 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugin/index.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugin/index.mdx @@ -2,42 +2,42 @@ sidebar_position: 5 --- -# 擴充開發 +# 拡張機能開発 -- 並不是所有想要的功能，都有人開發，如果有能力，不妨試試動手做看看！！！ +- 希望する機能のすべてが開発されているわけではないので、もし挑戦する能力があるのなら、自分でやってみよう！ ## 準備 -- - [x] Python ( 推薦 `>= 3.10.0` ) -- - [x] VSCode ( 或其他 IDE ) +- - [x] Python ( 推奨 `>= 3.10.0` ) +- - [x] VSCode（または他のIDE） - - [x] Git -- - [ ] GitHub Desktop (可選) +- - [ ] GitHubデスクトップ（可選） -## 虛擬環境 -- 建議使用 Python 自帶的 虛擬環境 功能，開發擴充。 +## 仮想環境 +- 拡張機能の開発には、Python独自の仮想環境機能を使用することをお勧めします。 :::note -- 使用 Source Code 執行 CDPS 的前提下。 +- Source Codeを使用してCDPSの前提条件を強制する。 ::: -#### 建立 虛擬環境 +#### 仮想環境の構築 ```bash python -m venv dev ``` -#### 進入 虛擬環境 位置 +#### 仮想環境の場所を入力 ```bash cd ./dev/Scripts ``` -#### 啟動 虛擬環境 +#### 仮想環境の起動 ```bash activate.bat ``` -#### 退回 根目錄 +#### ルートカタログに戻る ```bash cd ../../ ``` -#### 安裝相關 依賴 +#### インストール関連の依存関係 ```bash pip install -r requirements.txt ``` -#### 執行 +#### 実行 ``` python main.py ``` \ No newline at end of file diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugin/more.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugin/more.mdx index 6d8eac0..e860152 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugin/more.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugin/more.mdx @@ -2,6 +2,6 @@ sidebar_position: 5 --- -# 更多 -- 更多你可能還想知道的東西！！！ -- [點擊前往](../more/index.mdx) \ No newline at end of file +# もっと見る +- まだまだ知りたいことがあるはずだ！ +- [クリックして見る](../more/index.mdx) \ No newline at end of file diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugin/pack.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugin/pack.mdx index 00b1498..85b4fbd 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugin/pack.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugin/pack.mdx @@ -2,22 +2,22 @@ sidebar_position: 4 --- -# 封裝 -- 封裝 擴充 為 `.cdps` 檔案 +# パッケージング +- `.cdps`ファイルへのパッケージング拡張 ## 準備 -- 資料夾看起來應該像下方這樣 +- フォルダは以下のようになるはずだ ``` example/ - cdps.json // 擴充基本資訊 - main.py // 入口點 + cdps.json // 拡張機能の基本情報 + main.py // 入口 ``` -## 指令 -- 使用 `cdps pack --name example` 打包 **example** 資料夾為 **example.cdps** 檔案 +## 命令 +- `cdps pack --name example`を使用して、**example** フォルダーを**example.cdps** ファイルとしてパックします :::note -- `--name` 後 帶上資料夾名稱 +- `--name` の後にフォルダー名を続ける。 ::: :::tip -- Source Code 下 指令為 `python main.py pack --name example` +- ソースコードで使用されている命令は`python main.py pack --name example`である。 ::: \ No newline at end of file diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugin/start.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugin/start.mdx index f4debd1..f394249 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugin/start.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugin/start.mdx @@ -2,13 +2,13 @@ sidebar_position: 1 --- -# 基本知識 -## 什麼是 CDPS 擴充? -- CDPS 擴充 是位於 `./plugins` 底下以 `.cdps` 為副檔名的文件 +# 基礎知識 +## CDPS拡張機能とは？ +- CDPS 拡張子は`./plugins`ファイルにあるファイルで、拡張子は`.cdps`です。 -## 文件結構 -- `example.cdps` 改為 `example.zip` 後 解壓縮 文件結構應該如下方所示 -- [下載 example.cdps](https://github.com/ExpTechTW/CDPS-ExamplePlugin/releases) +## ファイルの構造 +- `example.cdpsを`example.zip`に変更して解凍すると、以下のようなファイル構成になっているはずだ。 +- [ダウンロードexample.cdps](https://github.com/ExpTechTW/CDPS-ExamplePlugin/releases) ``` example/ main.py @@ -16,36 +16,36 @@ example/ ``` ## main.py -- 擴充 的 入口點 +- 機能拡張のための入口 ```py -from cdps.plugin.events import onServerStartEvent # 導入 類(class) -from cdps.plugin.manager import Listener, event_listener # 導入 類(class) +from cdps.plugin.events import onServerStartEvent # インポートクラス（class） +from cdps.plugin.manager import Listener, event_listener # インポートクラス（class） -@event_listener(onServerStartEvent) # 裝飾器 -class onServerStartListener(Listener): # 自定義 監聽器 +@event_listener(onServerStartEvent) # 装飾家（Decorator） +class onServerStartListener(Listener): # カスタムイベントリスナ - def on_event(self, event): # 監聽器 觸發 - print("Hello World") # 功能實作 + def on_event(self, event): # 觸發イベントリスナ + print("Hello World") # ハンズオン ``` ## cdps.json -- 定義 擴充資訊 的文件 +- エクステンションに関する情報を定義した文書 ```json { - "version": "1.0.0", // 擴充版本 + "version": "1.0.0", // 拡張機能バージョン "description": { - "zh_tw": "CDPS 的 範例擴充" // 擴充說明 + "zh_tw": "CDPS 的 範例擴充" // 拡張機能の説明 }, "author": [ - "YuYu1015" // 擴充作者 + "YuYu1015" // 拡張機能の著者 ], "dependencies": { - "cdps": ">=1.0.18" // 擴充所需的 CDPS 最低版本 + "cdps": ">=1.0.18" // 拡張機能に必要なCDPSの最小バージョン }, "resources": [ - "AGPL-3.0" // 擴充的開源協議 + "AGPL-3.0" // 拡張機能のためのオープンソースプロトコル ], - "link": "https://github.com/ExpTechTW/CDPS-ExamplePlugin" // 擴充 的 GitHub Link + "link": "https://github.com/ExpTechTW/CDPS-ExamplePlugin" // 拡張機能GitHubリンク } ``` \ No newline at end of file diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugins/color_log.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugins/color_log.mdx index 6ac4d63..13126e4 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugins/color_log.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugins/color_log.mdx @@ -4,21 +4,21 @@ sidebar_position: 6 # color_log `1.0.2` :::danger -- 使用了 [`完全載入(focus-load)`](../more/focus_load.mdx) +- 使用する[`完全にロード(focus-load)`](../more/focus_load.mdx) ::: :::caution -- 使用了 [`優先載入(pre-load)`](../more/pre_load.mdx) +- 使用する[`優先にロード(pre-load)`](../more/pre_load.mdx) ::: -### 作者 +### 著者 - [`YuYu1015`](https://github.com/whes1015) -### 說明 -- CDPS 的 顏色 Log 輸出 -## 依賴 -### CDPS 依賴 -| 名稱 | 版本 | +### 説明 +- CDPS的顏色コンソールログ +## 依存関係 +### CDPSの依存関係 +| 名称 | リリース | | --------- | ---------- | | `CDPS`| `>= 1.0.18` | -### PyPI 依賴 +### PyPIの依存関係 - 無 -## 原始碼 +## ソースコード - [GitHub](https://github.com/ExpTechTW/CDPS-color_log) \ No newline at end of file diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugins/discordwebhook.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugins/discordwebhook.mdx index 5b25469..8d18b86 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugins/discordwebhook.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugins/discordwebhook.mdx @@ -3,16 +3,16 @@ sidebar_position: 3 --- # discordwebhook `1.0.1` -## 作者 +## 著者 - [`PiscesXD`](https://github.com/PiscesXD) -## 說明 +## 説明 - Discord Webhook -## 依賴 -### CDPS 依賴 -| 名稱 | 版本 | +## 依存関係 +### CDPSの依存関係 +| 名称 | リリース | | --------- | ---------- | | `CDPS`| `>= 1.0.13` | -### PyPI 依賴 -- 未知 -## 原始碼 +### PyPIの依存関係 +- 不明 +## ソースコード - [GitHub](https://github.com/PiscesXD/cdps-discordwebhook) \ No newline at end of file diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugins/example.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugins/example.mdx index f4206cf..622ea0a 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugins/example.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugins/example.mdx @@ -3,16 +3,16 @@ sidebar_position: 2 --- # example `1.0.0` -### 作者 +### 著者 - [`YuYu1015`](https://github.com/whes1015) -### 說明 -- CDPS 的 範例擴充 -## 依賴 -### CDPS 依賴 -| 名稱 | 版本 | +### 説明 +- CDPS 拡張機能例 +## 依存関係 +### CDPSの依存関係 +| 名称 | 版本 | | --------- | ---------- | | `CDPS`| `>= 1.0.18` | -### PyPI 依賴 -- 未知 -## 原始碼 +### PyPIの依存関係 +- 不明 +## ソースコード - [GitHub](https://github.com/ExpTechTW/CDPS-ExamplePlugin) \ No newline at end of file diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugins/index.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugins/index.mdx index 7528f95..ac020cd 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugins/index.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugins/index.mdx @@ -2,14 +2,14 @@ sidebar_position: 4 --- -# 擴充 -- 這裡紀錄著 可供使用的擴充 +# 拡張機能 +- 利用可能な拡張機能のリストはこちら -## 索引 +## インデックス ### 工具 - [example](./example.mdx) - [discordwebhook](./discordwebhook.mdx) - [color_log](./color_log.mdx) - [websocketclient](./websocketclient.mdx) -### 資料 +### インフォメーション - [report](./report.mdx) \ No newline at end of file diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugins/report.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugins/report.mdx index 2db2dfb..d707c74 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugins/report.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugins/report.mdx @@ -3,16 +3,16 @@ sidebar_position: 4 --- # report `1.0.1` -### 作者 +### 著者 - [`Yoyo0901`](https://github.com/Yoyochou0901) -### 說明 -- CDPS 接收地震報告 -## 依賴 -### CDPS 依賴 -| 名稱 | 版本 | +### 説明 +- CDPSが地震レポートを受領 +## 依存関係 +### CDPSの依存関係 +| 名称 | リリース | | --------- | ---------- | | `CDPS`| `>= 1.0.13` | -### PyPI 依賴 -- 未知 -## 原始碼 +### PyPIの依存関係 +- 不明 +## ソースコード - [GitHub](https://github.com/ExpTechTW/CDPS-report) \ No newline at end of file diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugins/websocketclient.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugins/websocketclient.mdx index 922379c..825a33d 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugins/websocketclient.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugins/websocketclient.mdx @@ -4,23 +4,23 @@ sidebar_position: 5 # websocketclient `1.0.4` :::danger -- 使用了 [`完全載入(focus-load)`](../more/focus_load.mdx) +- 使用する[`完全にロード(focus-load)`](../more/focus_load.mdx) ::: :::caution -- 使用了 [`優先載入(pre-load)`](../more/pre_load.mdx) +- 使用する[`優先にロード(pre-load)`](../more/pre_load.mdx) ::: -### 作者 +### 著者 - [`yayacat`](https://github.com/yayacat) -### 說明 -- CDPS 的 websocket client擴充 -## 依賴 -### CDPS 依賴 -| 名稱 | 版本 | +### 説明 +- CDPS用WebSocketクライアント拡張機能 +## 依存関係 +### CDPSの依存関係 +| 名称 | リリース | | --------- | ---------- | | `CDPS`| `>= 1.0.18` | -### PyPI 依賴 -| 名稱 | 版本 | +### PyPIの依存関係 +| 名称 | リリース | | --------- | ---------- | | `websocket-client`| `>= 1.8.0` | -## 原始碼 +## ソースコード - [GitHub](https://github.com/ExpTechTW/CDPS-websocketclient) \ No newline at end of file From cfd079ac791d3414bb3758f5e0379fc9ea43079c Mon Sep 17 00:00:00 2001 From: Miyashooooo Date: Wed, 5 Jun 2024 23:44:26 +0800 Subject: [PATCH 3/4] i18n: japanese --- .../current/cdps/plugins/example.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugins/example.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugins/example.mdx index 622ea0a..7eea050 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugins/example.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugins/example.mdx @@ -9,7 +9,7 @@ sidebar_position: 2 - CDPS 拡張機能例 ## 依存関係 ### CDPSの依存関係 -| 名称 | 版本 | +| 名称 | リリース | | --------- | ---------- | | `CDPS`| `>= 1.0.18` | ### PyPIの依存関係 From aa45ecf8f847e7d62bc60f8b2fa1a711dc5654b9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=A4=9C=E5=A4=9C?= Date: Thu, 6 Jun 2024 01:46:59 +0800 Subject: [PATCH 4/4] Merge branch 'main' of https://github.com/ExpTechTW/docs into translate --- .prettierrc | 10 +++++ docs/cdps/command/index.mdx | 25 +++++++++-- docs/cdps/config/index.mdx | 13 +++--- docs/cdps/develop/index.mdx | 17 +++++-- docs/cdps/more/dependencies.mdx | 29 ++++++++---- docs/cdps/more/event.mdx | 44 +++++++++++++++++++ .../cdps/more/{events.mdx => events_list.mdx} | 12 ++++- docs/cdps/more/focus_load.mdx | 16 +++++-- docs/cdps/more/index.mdx | 27 +++++++----- docs/cdps/more/inject.mdx | 22 +++++++++- docs/cdps/more/log.mdx | 12 +++-- docs/cdps/more/pip.mdx | 28 ++++++++---- docs/cdps/more/plugin.mdx | 9 +++- docs/cdps/more/pre_load.mdx | 15 ++++--- docs/cdps/more/thread.mdx | 22 +++++++--- docs/cdps/more/tree.mdx | 3 +- docs/cdps/more/version.mdx | 18 +++++++- docs/cdps/plugin/event.mdx | 19 +++++--- docs/cdps/plugin/file.mdx | 6 ++- docs/cdps/plugin/index.mdx | 31 ++++++++++--- docs/cdps/plugin/more.mdx | 3 +- docs/cdps/plugin/pack.mdx | 14 +++++- docs/cdps/plugin/start.mdx | 38 +++++++++------- docs/cdps/plugins/color_log.mdx | 39 ++++++++++++---- docs/cdps/plugins/discordwebhook.mdx | 19 ++++++-- docs/cdps/plugins/example.mdx | 24 +++++++--- docs/cdps/plugins/index.mdx | 15 ++++--- docs/cdps/plugins/report.mdx | 24 +++++++--- docs/cdps/plugins/websocketclient.mdx | 37 +++++++++++----- docs/cdps/release/index.mdx | 34 ++++++++++++-- docs/cdps/start/index.mdx | 14 ++++-- docs/cdps/start/install.mdx | 35 ++++++++++++--- i18n/en/docusaurus-theme-classic/footer.json | 2 +- .../current/cdps/develop/index.mdx | 4 +- .../current/cdps/more/dependencies.mdx | 2 +- .../cdps/more/{events.mdx => events_list.mdx} | 2 +- .../current/cdps/more/index.mdx | 22 +++++----- .../current/cdps/more/pip.mdx | 2 +- .../current/cdps/plugins/color_log.mdx | 4 +- .../current/cdps/plugins/index.mdx | 10 ++--- .../current/cdps/plugins/websocketclient.mdx | 6 ++- .../current/cdps/release/index.mdx | 4 +- i18n/ja/docusaurus-theme-classic/footer.json | 2 +- 43 files changed, 557 insertions(+), 177 deletions(-) create mode 100644 .prettierrc create mode 100644 docs/cdps/more/event.mdx rename docs/cdps/more/{events.mdx => events_list.mdx} (82%) rename i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/{events.mdx => events_list.mdx} (94%) diff --git a/.prettierrc b/.prettierrc new file mode 100644 index 0000000..27327bc --- /dev/null +++ b/.prettierrc @@ -0,0 +1,10 @@ +{ + "overrides": [ + { + "files": "*.mdx", + "options": { + "parser": "mdx" + } + } + ] +} \ No newline at end of file diff --git a/docs/cdps/command/index.mdx b/docs/cdps/command/index.mdx index be84bae..317a538 100644 --- a/docs/cdps/command/index.mdx +++ b/docs/cdps/command/index.mdx @@ -3,49 +3,66 @@ sidebar_position: 3 --- # 指令 -- CDPS 提供簡易的 CLI 工具 執行對應操作 + +- CDPS 提供簡易的 CLI 工具 執行對應操作。 + :::note -- 下方指令 在 Source Code 下，需將 `cdps` 替換成 `python main.py`。 + +- 下方指令在 Source Code 下，需將 `cdps` 替換成 `python main.py`。 + ::: ## 查看 CDPS 的幫助訊息 + - `-h` `--help` + ```bash cdps -h ``` + :::note -- 可以查看 子指令 幫助訊息 + +- 可以查看**子指令**幫助訊息 - 範例 `cdps pack -h` + ::: ## 查看 CDPS 版本 + - `-v` `--version` + ```bash cdps -v ``` ## 初始化 CDPS + ```bash cdps init ``` ## 啟動 CDPS + - `不帶參數` `start` + ```bash cdps start ``` ## 重新生成默認配置 (config.yml) + ```bash cdps gendefault ``` ## 打包 + ```bash cdps pack --name {資料夾名稱} ``` ## 熱載入(Hot reload) + ```bash cdps plugin reload {plugin名稱} -``` \ No newline at end of file +``` diff --git a/docs/cdps/config/index.mdx b/docs/cdps/config/index.mdx index 4d64355..e4e429d 100644 --- a/docs/cdps/config/index.mdx +++ b/docs/cdps/config/index.mdx @@ -3,15 +3,18 @@ sidebar_position: 2 --- # 配置 -- 自定義你的 CDPS 伺服器 + +- 自定義你的 CDPS 伺服器。 ## 配置檔 + - `./config.yml` + ```yml -version: 1 # config 版本號 +version: 1 # config 版本號 # "DEBUG" , "INFO" , "WARN" or "ERROR" -log_level: "DEBUG" # 日誌紀錄等級 +log_level: "DEBUG" # 日誌紀錄等級 -log_save_days: 7 # 日誌保留天數 -``` \ No newline at end of file +log_save_days: 7 # 日誌保留天數 +``` diff --git a/docs/cdps/develop/index.mdx b/docs/cdps/develop/index.mdx index 317e410..00cdbf4 100644 --- a/docs/cdps/develop/index.mdx +++ b/docs/cdps/develop/index.mdx @@ -3,24 +3,33 @@ sidebar_position: 6 --- # 開發 -- 這是關於開發 `CDPS` 的文件，如果是要開發擴充 [點擊這裡](../plugin/index.mdx) + +- 這是關於開發 `CDPS` 的文件，如果是要開發擴充 [點擊這裡](../plugin)。 + :::note + - 如果是一般用戶，可以略過這裡(快跑！！！) -::: +::: ## 從原始碼啟動 + - clone 原始碼 - 在根目錄中使用 `python main.py` 啟動 CDPS ## 貢獻 + - 至 GitHub 提交 [PR](https://github.com/ExpTechTW/CDPS/pulls) + :::tip + - 開發時應保持 `簡潔` 的原則。 -- 若非所有用戶所需之功能，可以參考利用 [Inject 注入](../more/inject.mdx) 的方式實現。 +- 若非所有用戶所需之功能，可以參考利用 [Inject 注入](../more/inject) 的方式實現。 + ::: ## 貢獻者 + - \ No newline at end of file + diff --git a/docs/cdps/more/dependencies.mdx b/docs/cdps/more/dependencies.mdx index 4ca3160..30a71ee 100644 --- a/docs/cdps/more/dependencies.mdx +++ b/docs/cdps/more/dependencies.mdx @@ -3,29 +3,42 @@ sidebar_position: 8 --- # 依賴關係 -- 擴充 之間的 依賴關係 + +- **擴充**之間的依賴關係 + :::note -- 這是說明 CDPS 擴充之間的依賴關係，如果要找 PyPI依賴 [點擊這裡](./pip.mdx) + +- 這是說明 CDPS 擴充之間的依賴關係，如果要找 PyPI 依賴 [點擊這裡](./pip) + ::: ## 聲明依賴 + - 在 `cdps.json` 中 聲明 + :::tip + - 依賴中 `cdps` 為必須的。 + ::: + ```json { - // ... - "dependencies": { - "cdps": ">=1.0.18" // 擴充所需的 CDPS 最低版本 - }, - // ... + // ... + "dependencies": { + "cdps": ">=1.0.18" // 擴充所需的 CDPS 最低版本 + } + // ... } ``` ## 用途 + - 檢查是否有執行擴充所需的其他擴充 + :::tip + - 舉例 `cdps_discord` 需要 `cdps_report` 來提供 地震報告 資料。 - 上述例子 `cdps_report` 就是 `cdps_discord` 所需的依賴。 -::: \ No newline at end of file + +::: diff --git a/docs/cdps/more/event.mdx b/docs/cdps/more/event.mdx new file mode 100644 index 0000000..1c466ac --- /dev/null +++ b/docs/cdps/more/event.mdx @@ -0,0 +1,44 @@ +--- +sidebar_position: 12 +--- + +# 自定義事件註冊 + +- 除了 CDPS 本身，**擴充**還可以分發自己的 事件。 + +:::tip + +- **自定義事件**是擴充之間，傳遞訊息的一種方式。 + +::: + +## 用法 + +```py +# color_log ( plugin ) 分發 Log 事件 +from cdps.plugin.events import Event # 導入 Event 基類 +from cdps.plugin.manager import Manager # 導入 擴充管理器 + +class onLogEvent(Event): # 自定義事件 + """ 當 輸出日誌 """ + + def __init__(self, log): + self.pid = log + + +event_manager = Manager() # 獲取 擴充管理器 實例 +event_manager.call_event(onLogEvent("test")) # 觸發 自定義事件 +``` + +```py +# discord (plugin) 獲取分發的 Log 事件 發送到 Discord +from cdps.plugin.manager import Listener, event_listener +from plugins.color_log.main import onLogEvent # 導入上述 color_log 擴充 中的 onLogEvent 事件 + + +@event_listener(onLogEvent) # 裝飾器 +class onLogListener(Listener): + + def on_event(self, event): + print("-> {}".format(event.log)) +``` diff --git a/docs/cdps/more/events.mdx b/docs/cdps/more/events_list.mdx similarity index 82% rename from docs/cdps/more/events.mdx rename to docs/cdps/more/events_list.mdx index 69a3d3e..23197d5 100644 --- a/docs/cdps/more/events.mdx +++ b/docs/cdps/more/events_list.mdx @@ -3,21 +3,29 @@ sidebar_position: 1 --- # 事件列表 -- 查看可用的事件 + +- 查看可用的事件。 ## 目錄 + - onServerStartEvent - onServerCloseEvent - onCommandEvent ## onServerStartEvent + #### 回傳參數 `pid` + - 當伺服器被啟動 ## onServerCloseEvent + #### 回傳參數 `reason(關閉原因)` + - 當伺服器被關閉 ## onCommandEvent + #### 回傳參數 `command(用戶輸入內容)` -- 當用戶輸入指令到 terminal \ No newline at end of file + +- 當用戶輸入指令到 terminal diff --git a/docs/cdps/more/focus_load.mdx b/docs/cdps/more/focus_load.mdx index dd8d1e2..c88e8f4 100644 --- a/docs/cdps/more/focus_load.mdx +++ b/docs/cdps/more/focus_load.mdx @@ -3,22 +3,30 @@ sidebar_position: 5 --- # 完全載入 + - 等待擴充完全載入後，再繼續下一步動作(載入其他擴充) :::danger + - 這個選項通常不需要使用。 - 如果不清楚此選項用意，不要輕易使用。 + ::: + :::tip + - 通常在使用了 `Inject 注入` 的擴充中，需要啟用此功能，確保 `Inject 注入` 完成。 + ::: ## 用法 + - 在 `cdps.json` 中 聲明 + ```json { - "version": "1.0.0", - "focus-load": true, // 新增這行 - // ... + "version": "1.0.0", + "focus-load": true // 新增這行 + // ... } -``` \ No newline at end of file +``` diff --git a/docs/cdps/more/index.mdx b/docs/cdps/more/index.mdx index 6e639e1..80361ac 100644 --- a/docs/cdps/more/index.mdx +++ b/docs/cdps/more/index.mdx @@ -3,17 +3,20 @@ sidebar_position: 7 --- # 雜項 -- 這裡紀錄著，一些瑣碎的東西 + +- 這裡紀錄著，一些瑣碎的東西。 ## 目錄 -- [事件列表](./events.mdx) -- [目錄樹](./tree.mdx) -- [多執行緒(threading)](./thread.mdx) -- [Inject 注入](./inject.mdx) -- [完全載入](./focus_load.mdx) -- [優先載入](./pre_load.mdx) -- [版本管理](./version.mdx) -- [依賴關係](./dependencies.mdx) -- [PyPI 依賴](./pip.mdx) -- [日誌紀錄](./log.mdx) -- [導入 擴充 的 函數](./plugin.mdx) \ No newline at end of file + +- [事件列表](./events_list) +- [目錄樹](./tree) +- [多執行緒(threading)](./thread) +- [Inject 注入](./inject) +- [完全載入](./focus_load) +- [優先載入](./pre_load) +- [版本管理](./version) +- [依賴關係](./dependencies) +- [PyPI 依賴](./pip) +- [日誌紀錄](./log) +- [導入 擴充 的 函數](./plugin) +- [自定義事件註冊](./event) diff --git a/docs/cdps/more/inject.mdx b/docs/cdps/more/inject.mdx index a371c3b..383521f 100644 --- a/docs/cdps/more/inject.mdx +++ b/docs/cdps/more/inject.mdx @@ -3,20 +3,29 @@ sidebar_position: 4 --- # Inject 注入 + - Server 啟動時會 觸發 `onServerStartEvent` - 如果我的 擴充 想在 `onServerStartEvent` 前做些什麼 ( 通常是自製的 `日誌擴充` 等 需要在其他擴充前 初始化完成 ) - 這時 `Inject 注入` 就登場了 - 注入新的 `onServerStartEventForExample` 讓其在 `onServerStartEvent` 前 先被執行 + :::danger + - 應謹慎使用 `Inject 注入` ，因其會破壞原生方法。 - 使用 `Inject 注入` 的擴充，應在 README 中註明，提醒使用者。 + ::: + :::note + - 使用了 `Inject 注入` 的案例 [`color_log`](https://github.com/ExpTechTW/CDPS-color_log)。 + ::: ## 原始 類(class)、方法(function) + - `cdps/plugin/events.py` + ```py class onServerStartEvent(Event): """ 當 伺服器 啟動 """ @@ -24,12 +33,16 @@ class onServerStartEvent(Event): def __init__(self, pid): self.pid = pid ``` + - `cdps/cdps_server.py` + ```py def on_start(self): self.event_manager.call_event(onServerStartEvent("start")) ``` + ## 定義新的類 + ```py from cdps.plugin.events import Event @@ -38,22 +51,29 @@ 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) # 呼叫原始方法 ``` + ## 注入 + ```py cdps.cdps_server.CDPS.on_start = _new_on_start ``` ## 完成看起來像這樣 + ```py from cdps.plugin.manager import Manager , Listener from cdps.plugin.events import Event @@ -80,4 +100,4 @@ class onServerStartEventForExampleListener(Listener): event_manager = Manager() event_manager.register_listener(onServerStartEventForExampleListener()) # 別忘了監聽事件 -``` \ No newline at end of file +``` diff --git a/docs/cdps/more/log.mdx b/docs/cdps/more/log.mdx index f54cbf4..3dd1f84 100644 --- a/docs/cdps/more/log.mdx +++ b/docs/cdps/more/log.mdx @@ -3,13 +3,19 @@ sidebar_position: 10 --- # 日誌紀錄 -- 輸出 日誌 到 控制台 並 紀錄到 文件 中。 + +- 輸出**日誌**到**控制台**並紀錄到文件中。 ## 用法 + - 獲取 log 實例 + :::tip -- Log 類 為 `單例` ，因此可以重複獲取，無需擔心重複。 + +- Log 類為 `單例` ，因此可以重複獲取，無需擔心重複。 + ::: + ```py from cdps.utils.logger import Log # 導入 Log 類 log = Log() # 獲取 log 實例 @@ -17,4 +23,4 @@ log.logger.debug("除錯") log.logger.info("資訊") log.logger.warning("警告") log.logger.error("錯誤") -``` \ No newline at end of file +``` diff --git a/docs/cdps/more/pip.mdx b/docs/cdps/more/pip.mdx index e24af31..8e7400d 100644 --- a/docs/cdps/more/pip.mdx +++ b/docs/cdps/more/pip.mdx @@ -3,25 +3,35 @@ sidebar_position: 9 --- # PyPI 依賴 -- 依賴的 PyPI 套件 + +- 依賴的 PyPI 套件。 + :::note -- 這是說明 PyPI依賴，如果要找 CDPS 擴充之間的依賴關係 [點擊這裡](./dependencies.mdx)。 + +- 這是說明 PyPI 依賴，如果要找 CDPS 擴充之間的依賴關係 [點擊這裡](./dependencies)。 + ::: ## 聲明依賴 + - 在 `cdps.json` 中 聲明 + ```json { - // ... - "pip_dependencies": { - "websocket-client": ">=1.8.0" // 擴充所需的 CDPS 最低版本 - }, - // ... + // ... + "pip_dependencies": { + "websocket-client": ">=1.8.0" // 擴充所需的 CDPS 最低版本 + } + // ... } ``` ## 用途 -- 在 `pip_dependencies` 中 聲明 所需的 PyPI依賴，擴充管理器會檢查是否已安裝對應依賴。 + +- 在 `pip_dependencies` 中**聲明**所需的 PyPI 依賴，擴充管理器會檢查是否已安裝對應依賴。 + :::tip + - 擴充開發者，應加上此參數，避免使用者初次使用，因缺少依賴而崩潰。 -::: \ No newline at end of file + +::: diff --git a/docs/cdps/more/plugin.mdx b/docs/cdps/more/plugin.mdx index f77fee0..f094915 100644 --- a/docs/cdps/more/plugin.mdx +++ b/docs/cdps/more/plugin.mdx @@ -3,12 +3,17 @@ sidebar_position: 11 --- # 導入 擴充 的 函數 -- 導入 特定擴充 中的 函數 + +- 導入**特定擴充**中的函數。 + :::tip + - 使用絕對路徑，從 `./plugins` 開始計算。 + ::: + ```py # main.py (report plugin) from plugins.report.src.events import onReport # 導入自己的 函數 from plugins.discord_webhook import send_webhook # 導入 其他擴充 的 函數 -``` \ No newline at end of file +``` diff --git a/docs/cdps/more/pre_load.mdx b/docs/cdps/more/pre_load.mdx index 47b851f..d7757e3 100644 --- a/docs/cdps/more/pre_load.mdx +++ b/docs/cdps/more/pre_load.mdx @@ -3,20 +3,25 @@ sidebar_position: 6 --- # 優先載入 -- 優先被 擴充管理器 載入 + +- 優先被**擴充管理器**載入。 :::caution + - 擴充管理器 會根據 擴充之間的依賴關係，自動調整載入順序。 - 這個選項通常不需要使用。 - 如果不清楚此選項用意，不要輕易使用。 + ::: ## 用法 + - 在 `cdps.json` 中 聲明 + ```json { - "version": "1.0.0", - "pre-load": true, // 新增這行 - // ... + "version": "1.0.0", + "pre-load": true // 新增這行 + // ... } -``` \ No newline at end of file +``` diff --git a/docs/cdps/more/thread.mdx b/docs/cdps/more/thread.mdx index 474b7b9..dba4a02 100644 --- a/docs/cdps/more/thread.mdx +++ b/docs/cdps/more/thread.mdx @@ -3,14 +3,21 @@ sidebar_position: 3 --- # 多執行緒 -- 在 擴充 中使用 threading + +- 在**擴充**中使用 threading ## task_run + - 捕獲 Plugin Loader 傳入的 stop_event -#### ❗不推薦的做法 + +#### ❗ 不推薦的做法 + :::tip -- 在 CDPS `>= 1.0.18` 後，有更好的方法 使用threading 請看 [裝飾器](#new_thread)。 + +- 在 CDPS `>= 1.0.18` 後，有更好的方法使用 threading 請看 [裝飾器](#new_thread)。 + ::: + ```py import threading import time @@ -35,10 +42,15 @@ def task_run(stop_event): ``` ## new_thread -- 使用 裝飾器 裝飾 函數，被裝飾的函數將會在 多執行緒 中 執行。 + +- 使用**裝飾器**裝飾函數，被裝飾的函數將會在**多執行緒**中執行。 + :::note + - 需要呼叫一次函數。 + ::: + ```py from cdps.plugin.thread import new_thread import time @@ -59,4 +71,4 @@ def loop_2(): loop_1() loop_2() -``` \ No newline at end of file +``` diff --git a/docs/cdps/more/tree.mdx b/docs/cdps/more/tree.mdx index 49392d3..b15f64f 100644 --- a/docs/cdps/more/tree.mdx +++ b/docs/cdps/more/tree.mdx @@ -3,6 +3,7 @@ sidebar_position: 2 --- # 目錄樹 + ``` CDPS/ main.py @@ -40,4 +41,4 @@ CDPS/ docs/ plugins/ tests/ -``` \ No newline at end of file +``` diff --git a/docs/cdps/more/version.mdx b/docs/cdps/more/version.mdx index 81e9daf..d91da08 100644 --- a/docs/cdps/more/version.mdx +++ b/docs/cdps/more/version.mdx @@ -3,20 +3,34 @@ sidebar_position: 7 --- # 版本管理 -- 擴充作者 應做好 版本管理 + +- 擴充作者應做好版本管理 ## 擴充版本命名方式 + - `X.Y.Z` + ### X 主版號 + - 應跟隨 `CDPS` 的主版號。 + :::tip + - 例如 example 擴充 `2.0.1` ，就能很明顯看出是給 CDPS `2.X.X` 使用的。 + ::: + ### Y 次版號 + - 擴充新增功能後，應增加 `次版號`，然後 `修訂號` 歸零。 + :::tip + - 1.1.5 -> 1.2.0 - 1.5.8 -> 2.0.0 + ::: + ### Z 修訂號 -- 擴充修復錯誤或問題 增加 `修訂號`。 \ No newline at end of file + +- 擴充修復錯誤或問題增加 `修訂號`。 diff --git a/docs/cdps/plugin/event.mdx b/docs/cdps/plugin/event.mdx index e58382d..723b8ee 100644 --- a/docs/cdps/plugin/event.mdx +++ b/docs/cdps/plugin/event.mdx @@ -3,14 +3,21 @@ sidebar_position: 2 --- # 事件 + 監聽發生的事件，並做出對應回應 ## register_listener -- 定義一個 Listener 後，向 事件管理器 註冊 -#### ❗不推薦的做法 + +- 定義一個 Listener 後，向**事件管理器**註冊。 + +#### ❗ 不推薦的做法 + :::tip -- 在 CDPS `>= 1.0.15` 後，有更好的方法 註冊事件 請看 [裝飾器](#event_listener) + +- 在 CDPS `>= 1.0.15` 後，有更好的方法**註冊事件**請看 [裝飾器](#event_listener) + ::: + ```py from cdps.plugin.manager import Listener, Manager # 導入 事件管理器 及 Listener(抽象) from cdps.plugin.events import onServerStartEvent # 導入 伺服器啟動 事件 @@ -28,8 +35,10 @@ event_manager.register_listener(onServerStartListener()) # 註冊 監聽器 到 ``` ## event_listener -- 使用 裝飾器 裝飾 函數，被裝飾的函數將會作為對應事件的 回調函數。 + +- 使用**裝飾器**裝飾函數，被裝飾的函數將會作為對應事件的回調函數。 - 傳入要監聽的事件 + ```py from cdps.plugin.events import onServerStartEvent from cdps.plugin.manager import Listener, event_listener @@ -40,4 +49,4 @@ class onServerStartListener(Listener): def on_event(self, event): print(event.pid) -``` \ No newline at end of file +``` diff --git a/docs/cdps/plugin/file.mdx b/docs/cdps/plugin/file.mdx index 9929a5e..6fe33fc 100644 --- a/docs/cdps/plugin/file.mdx +++ b/docs/cdps/plugin/file.mdx @@ -5,7 +5,9 @@ sidebar_position: 3 # 檔案讀取 ## 擴充的 config 讀取 + - 擴充給使用者的自定義設定檔 + ```py with open("./config/{擴充名稱}.json", 'r', encoding='utf-8') as file: content = file.read() @@ -13,9 +15,11 @@ with open("./config/{擴充名稱}.json", 'r', encoding='utf-8') as file: ``` ## 擴充內的檔案讀取 + - 隨擴充一起封裝，用於不會變化的文件 + ```py with open("./plugins/{擴充名稱}/test.txt", 'r', encoding='utf-8') as file: content = file.read() print(content) -``` \ No newline at end of file +``` diff --git a/docs/cdps/plugin/index.mdx b/docs/cdps/plugin/index.mdx index 6db816b..7e439ac 100644 --- a/docs/cdps/plugin/index.mdx +++ b/docs/cdps/plugin/index.mdx @@ -7,37 +7,54 @@ sidebar_position: 5 - 並不是所有想要的功能，都有人開發，如果有能力，不妨試試動手做看看！！！ ## 準備 + - - [x] Python ( 推薦 `>= 3.10.0` ) - - [x] VSCode ( 或其他 IDE ) - - [x] Git - - [ ] GitHub Desktop (可選) ## 虛擬環境 -- 建議使用 Python 自帶的 虛擬環境 功能，開發擴充。 + +- 建議使用 Python 自帶的**虛擬環境**功能，開發擴充。 + :::note + - 使用 Source Code 執行 CDPS 的前提下。 + ::: -#### 建立 虛擬環境 + +#### 建立虛擬環境 + ```bash python -m venv dev ``` -#### 進入 虛擬環境 位置 + +#### 進入虛擬環境 + ```bash cd ./dev/Scripts ``` -#### 啟動 虛擬環境 + +#### 啟動虛擬環境 + ```bash activate.bat ``` -#### 退回 根目錄 + +#### 退回根目錄 + ```bash cd ../../ ``` -#### 安裝相關 依賴 + +#### 安裝 PyPI 相關依賴 + ```bash pip install -r requirements.txt ``` + #### 執行 + ``` python main.py -``` \ No newline at end of file +``` diff --git a/docs/cdps/plugin/more.mdx b/docs/cdps/plugin/more.mdx index 6d8eac0..2eb2a5e 100644 --- a/docs/cdps/plugin/more.mdx +++ b/docs/cdps/plugin/more.mdx @@ -3,5 +3,6 @@ sidebar_position: 5 --- # 更多 + - 更多你可能還想知道的東西！！！ -- [點擊前往](../more/index.mdx) \ No newline at end of file +- [點擊前往](../more) diff --git a/docs/cdps/plugin/pack.mdx b/docs/cdps/plugin/pack.mdx index 00b1498..e25a05f 100644 --- a/docs/cdps/plugin/pack.mdx +++ b/docs/cdps/plugin/pack.mdx @@ -3,10 +3,13 @@ sidebar_position: 4 --- # 封裝 + - 封裝 擴充 為 `.cdps` 檔案 ## 準備 + - 資料夾看起來應該像下方這樣 + ``` example/ cdps.json // 擴充基本資訊 @@ -14,10 +17,17 @@ example/ ``` ## 指令 + - 使用 `cdps pack --name example` 打包 **example** 資料夾為 **example.cdps** 檔案 + :::note -- `--name` 後 帶上資料夾名稱 + +- `--name` 後，帶上資料夾名稱 + ::: + :::tip + - Source Code 下 指令為 `python main.py pack --name example` -::: \ No newline at end of file + +::: diff --git a/docs/cdps/plugin/start.mdx b/docs/cdps/plugin/start.mdx index f4debd1..f3a742b 100644 --- a/docs/cdps/plugin/start.mdx +++ b/docs/cdps/plugin/start.mdx @@ -3,12 +3,16 @@ sidebar_position: 1 --- # 基本知識 + ## 什麼是 CDPS 擴充? + - CDPS 擴充 是位於 `./plugins` 底下以 `.cdps` 為副檔名的文件 ## 文件結構 + - `example.cdps` 改為 `example.zip` 後 解壓縮 文件結構應該如下方所示 - [下載 example.cdps](https://github.com/ExpTechTW/CDPS-ExamplePlugin/releases) + ``` example/ main.py @@ -16,7 +20,9 @@ example/ ``` ## main.py + - 擴充 的 入口點 + ```py from cdps.plugin.events import onServerStartEvent # 導入 類(class) from cdps.plugin.manager import Listener, event_listener # 導入 類(class) @@ -30,22 +36,24 @@ class onServerStartListener(Listener): # 自定義 監 ``` ## cdps.json + - 定義 擴充資訊 的文件 + ```json { - "version": "1.0.0", // 擴充版本 - "description": { - "zh_tw": "CDPS 的 範例擴充" // 擴充說明 - }, - "author": [ - "YuYu1015" // 擴充作者 - ], - "dependencies": { - "cdps": ">=1.0.18" // 擴充所需的 CDPS 最低版本 - }, - "resources": [ - "AGPL-3.0" // 擴充的開源協議 - ], - "link": "https://github.com/ExpTechTW/CDPS-ExamplePlugin" // 擴充 的 GitHub Link + "version": "1.0.0", // 擴充版本 + "description": { + "zh_tw": "CDPS 的 範例擴充" // 擴充說明 + }, + "author": [ + "YuYu1015" // 擴充作者 + ], + "dependencies": { + "cdps": ">=1.0.18" // 擴充所需的 CDPS 最低版本 + }, + "resources": [ + "AGPL-3.0" // 擴充的開源協議 + ], + "link": "https://github.com/ExpTechTW/CDPS-ExamplePlugin" // 擴充 的 GitHub Link } -``` \ No newline at end of file +``` diff --git a/docs/cdps/plugins/color_log.mdx b/docs/cdps/plugins/color_log.mdx index eae7d9a..37d12e8 100644 --- a/docs/cdps/plugins/color_log.mdx +++ b/docs/cdps/plugins/color_log.mdx @@ -3,28 +3,51 @@ sidebar_position: 6 --- # color_log `1.0.2` + :::danger -- 使用了 `Inject 注入` [點擊查看](../more/inject.mdx) + +- 使用了**Inject 注入** [點擊查看](../more/inject) + ::: + :::caution -- 使用了 `完全載入(focus-load)` [點擊查看](../more/focus_load.mdx) + +- 使用了**完全載入(focus-load)** [點擊查看](../more/focus_load) + ::: + :::info -- 使用了 `優先載入(pre-load)` [點擊查看](../more/pre_load.mdx) + +- 使用了**優先載入(pre-load)** [點擊查看](../more/pre_load) + ::: + :::note -- 此 擴充 使用 `Inject 注入` 修改 CDPS 的原生 Log 方法，可能導致 Log 問題，請謹慎使用。 + +- 此**擴充**使用**Inject 注入**修改 CDPS 的原生 Log 方法，可能導致 Log 問題，請謹慎使用。 + ::: + ### 作者 + - [`YuYu1015`](https://github.com/whes1015) + ### 說明 + - CDPS 的 顏色 Log 輸出 + ## 依賴 + ### CDPS 依賴 -| 名稱 | 版本 | -| --------- | ---------- | -| `CDPS`| `>= 1.0.18` | + +| 名稱 | 版本 | +| ------ | ----------- | +| `CDPS` | `>= 1.0.18` | + ### PyPI 依賴 + - 無 + ## 原始碼 -- [GitHub](https://github.com/ExpTechTW/CDPS-color_log) \ No newline at end of file + +- [GitHub](https://github.com/ExpTechTW/CDPS-color_log) diff --git a/docs/cdps/plugins/discordwebhook.mdx b/docs/cdps/plugins/discordwebhook.mdx index 5b25469..021bd98 100644 --- a/docs/cdps/plugins/discordwebhook.mdx +++ b/docs/cdps/plugins/discordwebhook.mdx @@ -3,16 +3,27 @@ sidebar_position: 3 --- # discordwebhook `1.0.1` + ## 作者 + - [`PiscesXD`](https://github.com/PiscesXD) + ## 說明 + - Discord Webhook + ## 依賴 + ### CDPS 依賴 -| 名稱 | 版本 | -| --------- | ---------- | -| `CDPS`| `>= 1.0.13` | + +| 名稱 | 版本 | +| ------ | ----------- | +| `CDPS` | `>= 1.0.13` | + ### PyPI 依賴 + - 未知 + ## 原始碼 -- [GitHub](https://github.com/PiscesXD/cdps-discordwebhook) \ No newline at end of file + +- [GitHub](https://github.com/PiscesXD/cdps-discordwebhook) diff --git a/docs/cdps/plugins/example.mdx b/docs/cdps/plugins/example.mdx index df5000a..aa5fb01 100644 --- a/docs/cdps/plugins/example.mdx +++ b/docs/cdps/plugins/example.mdx @@ -3,19 +3,33 @@ sidebar_position: 2 --- # example `1.0.0` + :::tip + - 以此為基礎，設計自己的 擴充 吧！！！ + ::: + ### 作者 + - [`YuYu1015`](https://github.com/whes1015) + ### 說明 -- CDPS 的 範例擴充 + +- CDPS 的**範例擴充** + ## 依賴 + ### CDPS 依賴 -| 名稱 | 版本 | -| --------- | ---------- | -| `CDPS`| `>= 1.0.18` | + +| 名稱 | 版本 | +| ------ | ----------- | +| `CDPS` | `>= 1.0.18` | + ### PyPI 依賴 + - 未知 + ## 原始碼 -- [GitHub](https://github.com/ExpTechTW/CDPS-ExamplePlugin) \ No newline at end of file + +- [GitHub](https://github.com/ExpTechTW/CDPS-ExamplePlugin) diff --git a/docs/cdps/plugins/index.mdx b/docs/cdps/plugins/index.mdx index 7528f95..2bac53f 100644 --- a/docs/cdps/plugins/index.mdx +++ b/docs/cdps/plugins/index.mdx @@ -3,13 +3,18 @@ sidebar_position: 4 --- # 擴充 + - 這裡紀錄著 可供使用的擴充 ## 索引 + ### 工具 -- [example](./example.mdx) -- [discordwebhook](./discordwebhook.mdx) -- [color_log](./color_log.mdx) -- [websocketclient](./websocketclient.mdx) + +- [example](./example) +- [discordwebhook](./discordwebhook) +- [color_log](./color_log) +- [websocketclient](./websocketclient) + ### 資料 -- [report](./report.mdx) \ No newline at end of file + +- [report](./report) diff --git a/docs/cdps/plugins/report.mdx b/docs/cdps/plugins/report.mdx index 5f37f6a..6152d2c 100644 --- a/docs/cdps/plugins/report.mdx +++ b/docs/cdps/plugins/report.mdx @@ -3,19 +3,33 @@ sidebar_position: 4 --- # report `1.0.1` + :::note -- 此 擴充 使用了已經遺棄的方法，不能在 CDPS `>= 1.0.18` 的版本上執行。 + +- 此**擴充**使用了已經遺棄的方法，不能在 CDPS `>= 1.0.18` 的版本上執行。 + ::: + ### 作者 + - [`Yoyo0901`](https://github.com/Yoyochou0901) + ### 說明 + - CDPS 接收地震報告 + ## 依賴 + ### CDPS 依賴 -| 名稱 | 版本 | -| --------- | ---------- | -| `CDPS`| `>= 1.0.13` | + +| 名稱 | 版本 | +| ------ | ----------- | +| `CDPS` | `>= 1.0.13` | + ### PyPI 依賴 + - 未知 + ## 原始碼 -- [GitHub](https://github.com/ExpTechTW/CDPS-report) \ No newline at end of file + +- [GitHub](https://github.com/ExpTechTW/CDPS-report) diff --git a/docs/cdps/plugins/websocketclient.mdx b/docs/cdps/plugins/websocketclient.mdx index cbf17b5..59f215f 100644 --- a/docs/cdps/plugins/websocketclient.mdx +++ b/docs/cdps/plugins/websocketclient.mdx @@ -3,24 +3,41 @@ sidebar_position: 5 --- # websocketclient `1.0.4` + :::caution -- 使用了 `完全載入(focus-load)` [點擊查看](../more/focus_load.mdx) + +- 使用了**完全載入(focus-load)** [點擊查看](../more/focus_load) + ::: + :::info -- 使用了 `優先載入(pre-load)` [點擊查看](../more/pre_load.mdx) + +- 使用了**優先載入(pre-load)** [點擊查看](../more/pre_load) + ::: + ### 作者 + - [`yayacat`](https://github.com/yayacat) + ### 說明 -- CDPS 的 websocket client擴充 + +- CDPS 的 websocket client 擴充 + ## 依賴 + ### CDPS 依賴 -| 名稱 | 版本 | -| --------- | ---------- | -| `CDPS`| `>= 1.0.18` | + +| 名稱 | 版本 | +| ------ | ----------- | +| `CDPS` | `>= 1.0.18` | + ### PyPI 依賴 -| 名稱 | 版本 | -| --------- | ---------- | -| `websocket-client`| `>= 1.8.0` | + +| 名稱 | 版本 | +| ------------------ | ---------- | +| `websocket-client` | `>= 1.8.0` | + ## 原始碼 -- [GitHub](https://github.com/ExpTechTW/CDPS-websocketclient) \ No newline at end of file + +- [GitHub](https://github.com/ExpTechTW/CDPS-websocketclient) diff --git a/docs/cdps/release/index.mdx b/docs/cdps/release/index.mdx index b708465..8aee49b 100644 --- a/docs/cdps/release/index.mdx +++ b/docs/cdps/release/index.mdx @@ -3,38 +3,66 @@ sidebar_position: 8 --- # 更新日誌 + - 這裡紀錄著，各個版本的更新內容 ## 1.0.19 (Draft) + #### 🐞 修正 + - Log `__init__` 覆蓋天數的問題 + --- + ## 1.0.18 + #### 🌟 新增 + - pip 依賴檢查 -- [`@new_thread`](../more/thread.mdx#new_thread) 裝飾器 +- [`@new_thread`](../more/thread#new_thread) 裝飾器 + #### 🐞 修正 + - Config 類不是 單例類 的問題 + :::caution -- plugin 內的 `task` 現在改為 `task_run` [參考這裡](../more/thread.mdx#task_run) + +- plugin 內的 `task` 現在改為 `task_run` [參考這裡](../more/thread#task_run) + ::: + --- + ## 1.0.17 (hotfix) + #### 🐞 修正 + - 初始化崩潰 + --- + ## 1.0.16 (hotfix) + #### 🐞 修正 + - 初始化崩潰 + --- + ## 1.0.15 + #### 🌟 新增 + - 事件 裝飾器 - `onCommandEvent` - `cdps version` ( In Program Command ) - `cdps exit` ( In Program Command ) - `cdps plugin reload {plugin}` ( In Program Command ) + #### 🔌 優化 + - Command 錯誤處理方式 + #### 🐞 修正 -- Log 錯字 \ No newline at end of file + +- Log 錯字 diff --git a/docs/cdps/start/index.mdx b/docs/cdps/start/index.mdx index 83d65ff..df7b69f 100644 --- a/docs/cdps/start/index.mdx +++ b/docs/cdps/start/index.mdx @@ -8,19 +8,25 @@ sidebar_position: 1 ## 用途 -- 透過 `模組化` 的設計，讓防災資訊有更多利用的可能。 +- 透過**模組化**的設計，讓防災資訊有更多利用的可能。 ## 情境 -- 需要把 地震報告 同時往 `Discord` 、`Slack` 傳遞，這時可以安裝 [report](https://github.com/ExpTechTW/CDPS/blob/master/docs/zh/user/plugins.md) Plugin 接收 地震報告，然後安裝 Discord 及 Slack 的 Plugin 把資訊發往 Discord 及 Slack。 +- 需要把**地震報告**同時往 `Discord` 、`Slack` 傳遞，這時可以安裝 [report](https://github.com/ExpTechTW/CDPS/blob/master/docs/zh/user/plugins.md) Plugin 接收**地震報告**，然後安裝 Discord 及 Slack 的 Plugin 把資訊發往 Discord 及 Slack。 :::note + - Discord Plugin 是一個給 CDPS 用，發訊息到 Discord 的 Plugin 。 - Slack Plugin 是一個給 CDPS 用，發訊息到 Slack 的 Plugin 。 + ::: ## 總結 -- 接收一次 地震報告 資訊，可以有多種用途，提高防災資訊的傳遞效率。 + +- 接收一次**地震報告**資訊，可以有多種用途，提高防災資訊的傳遞效率。 + :::note + - 可以根據需求，安裝不同的 Plugin ,或是自己製作 Plugin。 -::: \ No newline at end of file + +::: diff --git a/docs/cdps/start/install.mdx b/docs/cdps/start/install.mdx index 793ed19..9ff612b 100644 --- a/docs/cdps/start/install.mdx +++ b/docs/cdps/start/install.mdx @@ -5,57 +5,80 @@ sidebar_position: 2 # 開始 ## 安裝 + - 使用 PyPI 安裝 CDPS。 -| CDPS 版本 | Python 依賴 | -| --------- | ---------- | -| `>= 1.0.0`| `>= 3.8` | +| CDPS 版本 | Python 依賴 | +| ---------- | ----------- | +| `>= 1.0.0` | `>= 3.8` | ```bash pip install cdps ``` + :::caution -- Python 開發環境為 `3.10.0` ，不推薦使用低於 開發環境 的版本執行。 + +- Python 開發環境為 `3.10.0` ，不推薦使用低於**開發環境**的版本執行。 + ::: ## 初始化 + - 建立名為 `my_cdps` 的資料夾。 + ```bash mkdir my_cdps ``` + - 進入 `my_cdps` 資料夾內 + ```bash cd ./my_cdps ``` + - 初始化 生成必要檔案 + ```bash cdps init ``` + :::caution + - 可能會出現: + ```bash 'cdps' is not recognized as an internal or external command, operable program or batch file. ``` + - 這是因為沒有正確設定 `環境變數` - 設定(Windows) -> 系統 -> 關於 -> 進階系統設定 -> 環境變數 -> 系統變數 -> 變數(Path) -- 值 裡面應該要有 下列三行 ( `{User}`替換成電腦用戶名稱、`Python310` 則根據安裝的 Python 版本而有所不同 ) +- **值**裡面應該要有**下列三行**( `{User}`替換成電腦用戶名稱、`Python310` 則根據安裝的 Python 版本而有所不同 ) + ```bash C:\Program Files\Python310\Scripts\ C:\Program Files\Python310\ C:\Users\{User}\AppData\Roaming\Python\Python310\Scripts\ ``` + ::: + :::note + - 別忘了重開 terminal 套用新的 `環境變數` + ::: + - 執行 + ```bash cdps ``` ## 更新 + - 使用 PyPI 更新 CDPS。 + ```bash pip install --upgrade cdps -``` \ No newline at end of file +``` diff --git a/i18n/en/docusaurus-theme-classic/footer.json b/i18n/en/docusaurus-theme-classic/footer.json index 6a04c78..a00a8a6 100644 --- a/i18n/en/docusaurus-theme-classic/footer.json +++ b/i18n/en/docusaurus-theme-classic/footer.json @@ -25,7 +25,7 @@ }, "link.item.label.CDPS": { "message": "CDPS", - "description": "The label of footer link with label=CDPS linking to /docs/cdps/start/index" + "description": "The label of footer link with label=CDPS linking to /docs/cdps/start" }, "link.item.label.服務條款": { "message": "Terms of Services", diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/develop/index.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/develop/index.mdx index d7ea967..db1b652 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/develop/index.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/develop/index.mdx @@ -3,7 +3,7 @@ sidebar_position: 6 --- # 開発 -- これは `CDPS` の開発に関するドキュメントです。拡張機能の開発については[こちらをクリックしてください](../plugin/index.mdx)。 +- これは `CDPS` の開発に関するドキュメントです。拡張機能の開発については[こちらをクリックしてください](../plugin)。 :::note - 一般ユーザーの場合、このセクションはスキップしてください（急いで！）。 ::: @@ -16,5 +16,5 @@ sidebar_position: 6 - GitHub で [PR](https://github.com/ExpTechTW/CDPS/pulls) を提出します。 :::tip - 開発時は `シンプル` であるべきです。 -- すべてのユーザーに必要な機能でない場合、[Inject 注入](../more/inject.mdx)を利用して実装することができます。 +- すべてのユーザーに必要な機能でない場合、[Inject 注入](../more/inject)を利用して実装することができます。 ::: \ No newline at end of file diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/dependencies.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/dependencies.mdx index b89a151..8f24f02 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/dependencies.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/dependencies.mdx @@ -5,7 +5,7 @@ sidebar_position: 8 # 依存関係 - エクステンション間の依存関係 :::note -- これはCDPS拡張機能の依存関係を説明するためのもので、PyPIの依存関係を見つけたい場合は[ここをクリック](./pip.mdx) +- これはCDPS拡張機能の依存関係を説明するためのもので、PyPIの依存関係を見つけたい場合は[ここをクリック](./pip) ::: ## 依存関係の声明 diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/events.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/events_list.mdx similarity index 94% rename from i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/events.mdx rename to i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/events_list.mdx index 8e39387..a5c972d 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/events.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/events_list.mdx @@ -12,7 +12,7 @@ sidebar_position: 1 ## onServerStartEvent #### 戻り値パラメータ`pid` -- サーバー起動時 +- サーバー起動時 ## onServerCloseEvent #### パラメータ`reason（閉鎖の理由）`を返す diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/index.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/index.mdx index 2235edd..4d0696d 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/index.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/index.mdx @@ -6,14 +6,14 @@ sidebar_position: 7 - 些細なことの記録だ ## カタログ -- [イベント一覧](./events.mdx) -- [カタログツリー](./tree.mdx) -- [マルチスレッド(threading)](./thread.mdx) -- [Inject 注入](./inject.mdx) -- [完全にロード](./focus_load.mdx) -- [優先にロード](./pre_load.mdx) -- [バージョン管理](./version.mdx) -- [依存関係](./dependencies.mdx) -- [PyPIの依存関係](./pip.mdx) -- [ジャーナル記録](./log.mdx) -- [拡張のインポート機能](./plugin.mdx) \ No newline at end of file +- [イベント一覧](./events_list) +- [カタログツリー](./tree) +- [マルチスレッド(threading)](./thread) +- [Inject 注入](./inject) +- [完全にロード](./focus_load) +- [優先にロード](./pre_load) +- [バージョン管理](./version) +- [依存関係](./dependencies) +- [PyPIの依存関係](./pip) +- [ジャーナル記録](./log) +- [拡張のインポート機能](./plugin) diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/pip.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/pip.mdx index 4c2541a..c809908 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/pip.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/pip.mdx @@ -5,7 +5,7 @@ sidebar_position: 9 # PyPIの依存関係 - 依存するPyPIパッケージ :::note -- これはPyPIの依存関係の説明です。CDPS拡張モジュール間の依存関係を調べるには、[ここをクリック](./dependencies.mdx)を参照。 +- これはPyPIの依存関係の説明です。CDPS拡張モジュール間の依存関係を調べるには、[ここをクリック](./dependencies)を参照。 ::: ## 依存関係の声明 diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugins/color_log.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugins/color_log.mdx index 13126e4..d652d51 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugins/color_log.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugins/color_log.mdx @@ -4,10 +4,10 @@ sidebar_position: 6 # color_log `1.0.2` :::danger -- 使用する[`完全にロード(focus-load)`](../more/focus_load.mdx) +- 使用する[`完全にロード(focus-load)`](../more/focus_load) ::: :::caution -- 使用する[`優先にロード(pre-load)`](../more/pre_load.mdx) +- 使用する[`優先にロード(pre-load)`](../more/pre_load) ::: ### 著者 - [`YuYu1015`](https://github.com/whes1015) diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugins/index.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugins/index.mdx index ac020cd..624babe 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugins/index.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugins/index.mdx @@ -7,9 +7,9 @@ sidebar_position: 4 ## インデックス ### 工具 -- [example](./example.mdx) -- [discordwebhook](./discordwebhook.mdx) -- [color_log](./color_log.mdx) -- [websocketclient](./websocketclient.mdx) +- [example](./example) +- [discordwebhook](./discordwebhook) +- [color_log](./color_log) +- [websocketclient](./websocketclient) ### インフォメーション -- [report](./report.mdx) \ No newline at end of file +- [report](./report) \ No newline at end of file diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugins/websocketclient.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugins/websocketclient.mdx index 825a33d..2801ab6 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugins/websocketclient.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugins/websocketclient.mdx @@ -4,10 +4,12 @@ sidebar_position: 5 # websocketclient `1.0.4` :::danger -- 使用する[`完全にロード(focus-load)`](../more/focus_load.mdx) +- 使用了 [`完全載入(focus-load)`](../more/focus_load) +- 使用する[`完全にロード(focus-load)`](../more/focus_load) ::: :::caution -- 使用する[`優先にロード(pre-load)`](../more/pre_load.mdx) +- 使用了 [`優先載入(pre-load)`](../more/pre_load) +- 使用する[`優先にロード(pre-load)`](../more/pre_load) ::: ### 著者 - [`yayacat`](https://github.com/yayacat) diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/release/index.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/release/index.mdx index 82372a0..50ad742 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/release/index.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/release/index.mdx @@ -12,11 +12,11 @@ sidebar_position: 8 # 1.0.18 ### 🌟 新機能 - pip 依存性チェック -- [`@new_thread`](../more/thread.mdx#new_thread) デコレータ +- [`@new_thread`](../more/thread#new_thread) デコレータ ### 🐞 修正 - Config クラスがシングルトンではない問題 :::caution -- プラグイン内の `task` は現在 `task_run` に変更されています [こちらを参照](../more/thread.mdx#task_run) +- プラグイン内の `task` は現在 `task_run` に変更されています [こちらを参照](../more/thread#task_run) ::: # 1.0.17 (ホットフィックス) diff --git a/i18n/ja/docusaurus-theme-classic/footer.json b/i18n/ja/docusaurus-theme-classic/footer.json index ac392b8..7170933 100644 --- a/i18n/ja/docusaurus-theme-classic/footer.json +++ b/i18n/ja/docusaurus-theme-classic/footer.json @@ -25,7 +25,7 @@ }, "link.item.label.CDPS": { "message": "CDPS", - "description": "/docs/cdps/start/indexにリンクしているlabel=CDPSのフッターリンクのラベル" + "description": "/docs/cdps/start にリンクしているlabel=CDPSのフッターリンクのラベル" }, "link.item.label.服務條款": { "message": "利用規約",