From c8468d872a0e0b731edfb5c6776cdafe97249d8b Mon Sep 17 00:00:00 2001 From: Kamiya <58339640+kamiya10@users.noreply.github.com> Date: Sun, 9 Jun 2024 12:03:58 +0800 Subject: [PATCH] fix: bad unordered list usage --- docs/api/earthquake/index.mdx | 18 +++- docs/api/weather/index.mdx | 27 ++++-- docs/cdps/command/index.mdx | 14 +-- docs/cdps/config/index.mdx | 19 +++-- docs/cdps/develop/index.mdx | 12 +-- docs/cdps/miscellaneous/dependencies.mdx | 11 ++- docs/cdps/miscellaneous/event.mdx | 27 ++++-- docs/cdps/miscellaneous/events_list.mdx | 8 +- docs/cdps/miscellaneous/focus-load.mdx | 9 +- docs/cdps/miscellaneous/index.mdx | 2 +- docs/cdps/miscellaneous/inject.mdx | 52 +++++++----- docs/cdps/miscellaneous/log.mdx | 13 +-- docs/cdps/miscellaneous/pip.mdx | 10 +-- docs/cdps/miscellaneous/plugin.mdx | 11 ++- docs/cdps/miscellaneous/pre-load.mdx | 6 +- docs/cdps/miscellaneous/thread.mdx | 10 +-- docs/cdps/miscellaneous/version.mdx | 20 ++--- docs/cdps/plugin/event.mdx | 32 ++++--- docs/cdps/plugin/file.mdx | 4 +- docs/cdps/plugin/index.mdx | 14 +-- docs/cdps/plugin/pack.mdx | 10 +-- docs/cdps/plugin/start.mdx | 8 +- docs/cdps/plugins/color_log.mdx | 6 +- docs/cdps/plugins/websocketclient.mdx | 4 +- docs/cdps/start/index.mdx | 14 +-- docs/cdps/start/install.mdx | 42 ++++----- .../current/cdps/command/index.mdx | 35 ++++++-- .../current/cdps/config/index.mdx | 24 ++++-- .../current/cdps/develop/index.mdx | 24 ++++-- .../cdps/miscellaneous/dependencies.mdx | 39 ++++++--- .../cdps/miscellaneous/events-list.mdx | 15 +++- .../current/cdps/miscellaneous/focus-load.mdx | 26 ++++-- .../current/cdps/miscellaneous/index.mdx | 2 +- .../current/cdps/miscellaneous/inject.mdx | 36 ++++++-- .../current/cdps/miscellaneous/log.mdx | 21 +++-- .../current/cdps/miscellaneous/pip.mdx | 32 ++++--- .../current/cdps/miscellaneous/plugin.mdx | 18 ++-- .../current/cdps/miscellaneous/pre_load.mdx | 23 +++-- .../current/cdps/miscellaneous/thread.mdx | 24 ++++-- .../current/cdps/miscellaneous/tree.mdx | 3 +- .../current/cdps/miscellaneous/version.mdx | 30 +++++-- .../current/cdps/plugin/event.mdx | 46 ++++++---- .../current/cdps/plugin/file.mdx | 10 ++- .../current/cdps/plugin/index.mdx | 21 +++-- .../current/cdps/plugin/pack.mdx | 22 +++-- .../current/cdps/plugin/start.mdx | 70 +++++++++------ .../current/cdps/plugins/color_log.mdx | 8 +- .../current/cdps/plugins/discordwebhook.mdx | 4 +- .../current/cdps/plugins/report.mdx | 4 +- .../current/cdps/plugins/websocketclient.mdx | 8 +- .../current/cdps/release/index.mdx | 4 +- .../current/cdps/start/index.mdx | 23 +++-- .../current/cdps/start/install.mdx | 85 ++++++++++++------- .../current/js/installation.mdx | 32 +++---- 54 files changed, 670 insertions(+), 422 deletions(-) diff --git a/docs/api/earthquake/index.mdx b/docs/api/earthquake/index.mdx index 8e798b7..dfd60a8 100644 --- a/docs/api/earthquake/index.mdx +++ b/docs/api/earthquake/index.mdx @@ -4,11 +4,21 @@ pagination_prev: null pagination_next: null --- -import ApiEndpoint from '@site/src/components/ApiEndpoint'; +import ApiEndpoint from "@site/src/components/ApiEndpoint"; # 地震 -
- - +
+ +
diff --git a/docs/api/weather/index.mdx b/docs/api/weather/index.mdx index 02898e5..2d61550 100644 --- a/docs/api/weather/index.mdx +++ b/docs/api/weather/index.mdx @@ -4,12 +4,27 @@ pagination_prev: null pagination_next: null --- -import ApiEndpoint from '@site/src/components/ApiEndpoint'; +import ApiEndpoint from "@site/src/components/ApiEndpoint"; # 氣象 -
- - - -
\ No newline at end of file +
+ + + +
diff --git a/docs/cdps/command/index.mdx b/docs/cdps/command/index.mdx index 317a538..ec6bee5 100644 --- a/docs/cdps/command/index.mdx +++ b/docs/cdps/command/index.mdx @@ -4,13 +4,7 @@ sidebar_position: 3 # 指令 -- CDPS 提供簡易的 CLI 工具 執行對應操作。 - -:::note - -- 下方指令在 Source Code 下，需將 `cdps` 替換成 `python main.py`。 - -::: +CDPS 提供簡易的 CLI 工具 執行對應操作。 ## 查看 CDPS 的幫助訊息 @@ -22,8 +16,8 @@ cdps -h :::note -- 可以查看**子指令**幫助訊息 -- 範例 `cdps pack -h` +可以查看**子指令**幫助訊息 +範例 `cdps pack -h` ::: @@ -49,7 +43,7 @@ cdps init cdps start ``` -## 重新生成默認配置 (config.yml) +## 重新生成預設設定 (config.yml) ```bash cdps gendefault diff --git a/docs/cdps/config/index.mdx b/docs/cdps/config/index.mdx index e4e429d..62847ce 100644 --- a/docs/cdps/config/index.mdx +++ b/docs/cdps/config/index.mdx @@ -2,19 +2,22 @@ sidebar_position: 2 --- -# 配置 +# 設定 -- 自定義你的 CDPS 伺服器。 +自定義你的 CDPS 伺服器。 -## 配置檔 +## 設定檔 -- `./config.yml` +`./config.yml` ```yml -version: 1 # config 版本號 +# 設定檔版本號 +version: 1 -# "DEBUG" , "INFO" , "WARN" or "ERROR" -log_level: "DEBUG" # 日誌紀錄等級 +# 日誌紀錄等級 +# 可用的值："DEBUG"、"INFO"、"WARN" 或 "ERROR" +log_level: "DEBUG" -log_save_days: 7 # 日誌保留天數 +# 日誌保留天數 +log_save_days: 7 ``` diff --git a/docs/cdps/develop/index.mdx b/docs/cdps/develop/index.mdx index 92ee7f5..02c4c9a 100644 --- a/docs/cdps/develop/index.mdx +++ b/docs/cdps/develop/index.mdx @@ -4,27 +4,27 @@ sidebar_position: 6 # 開發 -- 這是關於開發 `CDPS` 的文件，如果是要開發擴充 [點擊這裡](../plugin)。 +這是關於開發 `CDPS` 的文件，如果是要開發擴充 [點擊這裡](../plugin)。 :::note -- 如果是一般用戶，可以略過這裡(快跑！！！) +如果是一般用戶，可以略過這裡(快跑！！！) ::: ## 從原始碼啟動 -- clone 原始碼 +- 複製原始碼 - 在根目錄中使用 `python main.py` 啟動 CDPS ## 貢獻 -- 至 GitHub 提交 [PR](https://github.com/ExpTechTW/CDPS/pulls) +至 GitHub 提交 [PR](https://github.com/ExpTechTW/CDPS/pulls) :::tip -- 開發時應保持 `簡潔` 的原則。 -- 若非所有用戶所需之功能，可以參考利用 [Inject 注入](/docs/cdps/miscellaneous/inject) 的方式實現。 +開發時應保持 `簡潔` 的原則。 +若非所有用戶所需之功能，可以參考利用 [Inject 注入](../miscellaneous/inject) 的方式實現。 ::: diff --git a/docs/cdps/miscellaneous/dependencies.mdx b/docs/cdps/miscellaneous/dependencies.mdx index 30a71ee..770aa54 100644 --- a/docs/cdps/miscellaneous/dependencies.mdx +++ b/docs/cdps/miscellaneous/dependencies.mdx @@ -8,17 +8,17 @@ sidebar_position: 8 :::note -- 這是說明 CDPS 擴充之間的依賴關係，如果要找 PyPI 依賴 [點擊這裡](./pip) +這是說明 CDPS 擴充之間的依賴關係，如果要找 PyPI 依賴 [點擊這裡](./pip) ::: ## 聲明依賴 -- 在 `cdps.json` 中 聲明 +在 `cdps.json` 中 聲明 :::tip -- 依賴中 `cdps` 為必須的。 +依賴中 `cdps` 為必須的。 ::: @@ -34,11 +34,10 @@ sidebar_position: 8 ## 用途 -- 檢查是否有執行擴充所需的其他擴充 +檢查是否有執行擴充所需的其他擴充 :::tip -- 舉例 `cdps_discord` 需要 `cdps_report` 來提供 地震報告 資料。 -- 上述例子 `cdps_report` 就是 `cdps_discord` 所需的依賴。 +舉例來說，`cdps_discord` 需要 `cdps_report` 提供地震報告資料。換句話說，`cdps_report` 就是 `cdps_discord` 所必需的依賴。 ::: diff --git a/docs/cdps/miscellaneous/event.mdx b/docs/cdps/miscellaneous/event.mdx index 1c466ac..ab1a6bb 100644 --- a/docs/cdps/miscellaneous/event.mdx +++ b/docs/cdps/miscellaneous/event.mdx @@ -4,11 +4,11 @@ sidebar_position: 12 # 自定義事件註冊 -- 除了 CDPS 本身，**擴充**還可以分發自己的 事件。 +除了 CDPS 本身，**擴充**還可以分發自己的 事件。 :::tip -- **自定義事件**是擴充之間，傳遞訊息的一種方式。 +**自定義事件**是擴充之間，傳遞訊息的一種方式。 ::: @@ -16,27 +16,36 @@ sidebar_position: 12 ```py # color_log ( plugin ) 分發 Log 事件 -from cdps.plugin.events import Event # 導入 Event 基類 -from cdps.plugin.manager import Manager # 導入 擴充管理器 -class onLogEvent(Event): # 自定義事件 +# 導入 Event 基類 +from cdps.plugin.events import Event + +# 導入 擴充管理器 +from cdps.plugin.manager import Manager + +# 自定義事件 +class onLogEvent(Event): """ 當 輸出日誌 """ def __init__(self, log): self.pid = log +# 獲取 擴充管理器 實例 +event_manager = Manager() -event_manager = Manager() # 獲取 擴充管理器 實例 -event_manager.call_event(onLogEvent("test")) # 觸發 自定義事件 +# 觸發 自定義事件 +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 事件 +# 導入上述 color_log 擴充 中的 onLogEvent 事件 +from plugins.color_log.main import onLogEvent -@event_listener(onLogEvent) # 裝飾器 +# 裝飾器 +@event_listener(onLogEvent) class onLogListener(Listener): def on_event(self, event): diff --git a/docs/cdps/miscellaneous/events_list.mdx b/docs/cdps/miscellaneous/events_list.mdx index 23197d5..1a16e10 100644 --- a/docs/cdps/miscellaneous/events_list.mdx +++ b/docs/cdps/miscellaneous/events_list.mdx @@ -4,7 +4,7 @@ sidebar_position: 1 # 事件列表 -- 查看可用的事件。 +查看可用的事件。 ## 目錄 @@ -16,16 +16,16 @@ sidebar_position: 1 #### 回傳參數 `pid` -- 當伺服器被啟動 +當伺服器被啟動 ## onServerCloseEvent #### 回傳參數 `reason(關閉原因)` -- 當伺服器被關閉 +當伺服器被關閉 ## onCommandEvent #### 回傳參數 `command(用戶輸入內容)` -- 當用戶輸入指令到 terminal +當用戶輸入指令到 terminal diff --git a/docs/cdps/miscellaneous/focus-load.mdx b/docs/cdps/miscellaneous/focus-load.mdx index c88e8f4..829c696 100644 --- a/docs/cdps/miscellaneous/focus-load.mdx +++ b/docs/cdps/miscellaneous/focus-load.mdx @@ -4,24 +4,23 @@ sidebar_position: 5 # 完全載入 -- 等待擴充完全載入後，再繼續下一步動作(載入其他擴充) +完全載入是等待所有擴充套件完全載入後，才進行的下一步操作（如載入其他擴充）。 :::danger -- 這個選項通常不需要使用。 -- 如果不清楚此選項用意，不要輕易使用。 +這個選項通常不需要使用。如果不確定此選項的用途，請避免使用。 ::: :::tip -- 通常在使用了 `Inject 注入` 的擴充中，需要啟用此功能，確保 `Inject 注入` 完成。 +如果使用了 `Inject` 注入功能，通常需要啟用這個選項以確保 `Inject` 注入完成。 ::: ## 用法 -- 在 `cdps.json` 中 聲明 +在 `cdps.json` 中聲明以下內容： ```json { diff --git a/docs/cdps/miscellaneous/index.mdx b/docs/cdps/miscellaneous/index.mdx index eb0b1ff..1285a13 100644 --- a/docs/cdps/miscellaneous/index.mdx +++ b/docs/cdps/miscellaneous/index.mdx @@ -4,7 +4,7 @@ sidebar_position: 7 # 雜項 -- 這裡紀錄著，一些瑣碎的東西。 +這裡紀錄著，一些瑣碎的東西。 ## 目錄 diff --git a/docs/cdps/miscellaneous/inject.mdx b/docs/cdps/miscellaneous/inject.mdx index 383521f..9e94dd5 100644 --- a/docs/cdps/miscellaneous/inject.mdx +++ b/docs/cdps/miscellaneous/inject.mdx @@ -4,83 +4,93 @@ sidebar_position: 4 # Inject 注入 -- Server 啟動時會 觸發 `onServerStartEvent` -- 如果我的 擴充 想在 `onServerStartEvent` 前做些什麼 ( 通常是自製的 `日誌擴充` 等 需要在其他擴充前 初始化完成 ) -- 這時 `Inject 注入` 就登場了 -- 注入新的 `onServerStartEventForExample` 讓其在 `onServerStartEvent` 前 先被執行 +在伺服器啟動時，會觸發 `onServerStartEvent` 事件。如果您希望在 `onServerStartEvent` 事件前進行某些操作（例如在其他擴充功能初始化之前完成自製的 `日誌擴充`），這時您可以使用 `Inject 注入`。 + +通過注入一個新的事件 `onServerStartEventForExample`，您可以確保它在 `onServerStartEvent` 事件之前執行。 :::danger -- 應謹慎使用 `Inject 注入` ，因其會破壞原生方法。 -- 使用 `Inject 注入` 的擴充，應在 README 中註明，提醒使用者。 +請謹慎使用 `Inject 注入`，因為它會修改原生方法。使用 `Inject 注入` 的擴充功能應在 README 中註明，以提醒使用者。 ::: :::note -- 使用了 `Inject 注入` 的案例 [`color_log`](https://github.com/ExpTechTW/CDPS-color_log)。 +已經使用 `Inject 注入` 的案例：[color_log](https://github.com/ExpTechTW/CDPS-color_log) ::: -## 原始 類(class)、方法(function) +## 原始類和方法 + +以下是原始類和方法的定義： - `cdps/plugin/events.py` -```py +```python class onServerStartEvent(Event): - """ 當 伺服器 啟動 """ - def __init__(self, pid): self.pid = pid ``` - `cdps/cdps_server.py` -```py +```python def on_start(self): self.event_manager.call_event(onServerStartEvent("start")) ``` -## 定義新的類 +## 定義新類別 -```py +定義新的事件類別，用在 `onServerStartEvent` 之前執行： + +```python from cdps.plugin.events import Event class onServerStartEventForExample(Event): - """ 當 伺服器 啟動 """ + # 當伺服器啟動 def __init__(self, pid): self.pid = pid ``` ## 保留原始方法 +保留原始的 `on_start` 方法，以便在修改後依然能夠調用它： + ```py original_on_start = cdps.cdps_server.CDPS.on_start ``` ## 定義新方法 +定義新的 `on_start` 方法，先觸發 `onServerStartEventForExample`，然後調用原始方法： + ```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) ``` ## 注入 +將新方法注入到 CDPS 類的 `on_start` 方法中： + ```py cdps.cdps_server.CDPS.on_start = _new_on_start ``` -## 完成看起來像這樣 +## 完整程式碼 + +以下是完整的程式碼，包含事件管理和監聽器註冊： ```py -from cdps.plugin.manager import Manager , Listener +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 @@ -99,5 +109,5 @@ class onServerStartEventForExampleListener(Listener): print(event.pid) event_manager = Manager() -event_manager.register_listener(onServerStartEventForExampleListener()) # 別忘了監聽事件 +event_manager.register_listener(onServerStartEventForExampleListener()) # 註冊事件監聽器 ``` diff --git a/docs/cdps/miscellaneous/log.mdx b/docs/cdps/miscellaneous/log.mdx index 3dd1f84..ae3d0ad 100644 --- a/docs/cdps/miscellaneous/log.mdx +++ b/docs/cdps/miscellaneous/log.mdx @@ -4,21 +4,24 @@ sidebar_position: 10 # 日誌紀錄 -- 輸出**日誌**到**控制台**並紀錄到文件中。 +輸出**日誌**到**控制台**並紀錄到文件中。 ## 用法 -- 獲取 log 實例 +獲取 log 實例 :::tip -- Log 類為 `單例` ，因此可以重複獲取，無需擔心重複。 +Log 類為 `單例` ，因此可以重複獲取，無需擔心重複。 ::: ```py -from cdps.utils.logger import Log # 導入 Log 類 -log = Log() # 獲取 log 實例 +# 導入 Log 類 +from cdps.utils.logger import Log + +# 獲取 log 實例 +log = Log() log.logger.debug("除錯") log.logger.info("資訊") log.logger.warning("警告") diff --git a/docs/cdps/miscellaneous/pip.mdx b/docs/cdps/miscellaneous/pip.mdx index 8e7400d..af35898 100644 --- a/docs/cdps/miscellaneous/pip.mdx +++ b/docs/cdps/miscellaneous/pip.mdx @@ -4,17 +4,17 @@ sidebar_position: 9 # PyPI 依賴 -- 依賴的 PyPI 套件。 +依賴的 PyPI 套件。 :::note -- 這是說明 PyPI 依賴，如果要找 CDPS 擴充之間的依賴關係 [點擊這裡](./dependencies)。 +這是說明 PyPI 依賴，如果要找 CDPS 擴充之間的依賴關係 [點擊這裡](./dependencies)。 ::: ## 聲明依賴 -- 在 `cdps.json` 中 聲明 +在 `cdps.json` 中 聲明 ```json { @@ -28,10 +28,10 @@ sidebar_position: 9 ## 用途 -- 在 `pip_dependencies` 中**聲明**所需的 PyPI 依賴，擴充管理器會檢查是否已安裝對應依賴。 +在 `pip_dependencies` 中**聲明**所需的 PyPI 依賴，擴充管理器會檢查是否已安裝對應依賴。 :::tip -- 擴充開發者，應加上此參數，避免使用者初次使用，因缺少依賴而崩潰。 +擴充開發者，應加上此參數，避免使用者初次使用，因缺少依賴而崩潰。 ::: diff --git a/docs/cdps/miscellaneous/plugin.mdx b/docs/cdps/miscellaneous/plugin.mdx index f094915..7c945bb 100644 --- a/docs/cdps/miscellaneous/plugin.mdx +++ b/docs/cdps/miscellaneous/plugin.mdx @@ -4,16 +4,19 @@ 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 ``` diff --git a/docs/cdps/miscellaneous/pre-load.mdx b/docs/cdps/miscellaneous/pre-load.mdx index d7757e3..bdcf74c 100644 --- a/docs/cdps/miscellaneous/pre-load.mdx +++ b/docs/cdps/miscellaneous/pre-load.mdx @@ -4,11 +4,11 @@ sidebar_position: 6 # 優先載入 -- 優先被**擴充管理器**載入。 +優先被**擴充管理器**載入。 :::caution -- 擴充管理器 會根據 擴充之間的依賴關係，自動調整載入順序。 +- 擴充管理器會根據擴充之間的依賴關係，自動調整載入順序。 - 這個選項通常不需要使用。 - 如果不清楚此選項用意，不要輕易使用。 @@ -16,7 +16,7 @@ sidebar_position: 6 ## 用法 -- 在 `cdps.json` 中 聲明 +在 `cdps.json` 中 聲明 ```json { diff --git a/docs/cdps/miscellaneous/thread.mdx b/docs/cdps/miscellaneous/thread.mdx index dba4a02..d9387e6 100644 --- a/docs/cdps/miscellaneous/thread.mdx +++ b/docs/cdps/miscellaneous/thread.mdx @@ -4,17 +4,17 @@ sidebar_position: 3 # 多執行緒 -- 在**擴充**中使用 threading +在**擴充**中使用 threading ## task_run -- 捕獲 Plugin Loader 傳入的 stop_event +捕獲 Plugin Loader 傳入的 stop_event #### ❗ 不推薦的做法 :::tip -- 在 CDPS `>= 1.0.18` 後，有更好的方法使用 threading 請看 [裝飾器](#new_thread)。 +在 CDPS `>= 1.0.18` 後，有更好的方法使用 threading 請看 [裝飾器](#new_thread)。 ::: @@ -43,11 +43,11 @@ def task_run(stop_event): ## new_thread -- 使用**裝飾器**裝飾函數，被裝飾的函數將會在**多執行緒**中執行。 +使用**裝飾器**裝飾函數，被裝飾的函數將會在**多執行緒**中執行。 :::note -- 需要呼叫一次函數。 +需要呼叫一次函數。 ::: diff --git a/docs/cdps/miscellaneous/version.mdx b/docs/cdps/miscellaneous/version.mdx index d91da08..caa3a83 100644 --- a/docs/cdps/miscellaneous/version.mdx +++ b/docs/cdps/miscellaneous/version.mdx @@ -4,33 +4,25 @@ sidebar_position: 7 # 版本管理 -- 擴充作者應做好版本管理 +擴充作者應做好版本管理 ## 擴充版本命名方式 -- `X.Y.Z` +`X.Y.Z` ### X 主版號 -- 應跟隨 `CDPS` 的主版號。 +應跟隨 `CDPS` 的主版號。 -:::tip - -- 例如 example 擴充 `2.0.1` ，就能很明顯看出是給 CDPS `2.X.X` 使用的。 - -::: +例如： example 擴充 `2.0.1` ，就能很明顯看出是給 CDPS `2.X.X` 使用的。 ### Y 次版號 -- 擴充新增功能後，應增加 `次版號`，然後 `修訂號` 歸零。 - -:::tip +擴充新增功能後，應增加 `次版號`，然後 `修訂號` 歸零。 - 1.1.5 -> 1.2.0 - 1.5.8 -> 2.0.0 -::: - ### Z 修訂號 -- 擴充修復錯誤或問題增加 `修訂號`。 +擴充修復錯誤或問題增加 `修訂號`。 diff --git a/docs/cdps/plugin/event.mdx b/docs/cdps/plugin/event.mdx index 723b8ee..a0be0ea 100644 --- a/docs/cdps/plugin/event.mdx +++ b/docs/cdps/plugin/event.mdx @@ -8,30 +8,38 @@ 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 # 導入 伺服器啟動 事件 +# 導入 事件管理器 及 Listener(抽象) +from cdps.plugin.manager import Listener, Manager +# 導入 伺服器啟動 事件 +from cdps.plugin.events import onServerStartEvent + +# 定義一個 監聽器 +class onServerStartListener(Listener): -class onServerStartListener(Listener): # 定義一個 監聽器 - event = onServerStartEvent # 定義 監聽的事件 + # 定義 監聽的事件 + event = onServerStartEvent - def on_event(self, event): # 實作方法 + # 實作方法 + def on_event(self, event): print("Hello World") +# 獲取 事件管理器 實例 +event_manager = Manager() -event_manager = Manager() # 獲取 事件管理器 實例 -event_manager.register_listener(onServerStartListener()) # 註冊 監聽器 到 事件管理器 +# 註冊 監聽器 到 事件管理器 +event_manager.register_listener(onServerStartListener()) ``` ## event_listener @@ -43,8 +51,8 @@ event_manager.register_listener(onServerStartListener()) # 註冊 監聽器 到 from cdps.plugin.events import onServerStartEvent from cdps.plugin.manager import Listener, event_listener - -@event_listener(onServerStartEvent) # 裝飾器 +# 裝飾器 +@event_listener(onServerStartEvent) class onServerStartListener(Listener): def on_event(self, event): diff --git a/docs/cdps/plugin/file.mdx b/docs/cdps/plugin/file.mdx index 6fe33fc..920fb40 100644 --- a/docs/cdps/plugin/file.mdx +++ b/docs/cdps/plugin/file.mdx @@ -6,7 +6,7 @@ sidebar_position: 3 ## 擴充的 config 讀取 -- 擴充給使用者的自定義設定檔 +擴充給使用者的自定義設定檔 ```py with open("./config/{擴充名稱}.json", 'r', encoding='utf-8') as file: @@ -16,7 +16,7 @@ with open("./config/{擴充名稱}.json", 'r', encoding='utf-8') as file: ## 擴充內的檔案讀取 -- 隨擴充一起封裝，用於不會變化的文件 +隨擴充一起封裝，用於不會變化的文件 ```py with open("./plugins/{擴充名稱}/test.txt", 'r', encoding='utf-8') as file: diff --git a/docs/cdps/plugin/index.mdx b/docs/cdps/plugin/index.mdx index 92b47f6..ae95e85 100644 --- a/docs/cdps/plugin/index.mdx +++ b/docs/cdps/plugin/index.mdx @@ -4,22 +4,22 @@ sidebar_position: 4 # 擴充開發 -- 並不是所有想要的功能，都有人開發，如果有能力，不妨試試動手做看看！！！ +並不是所有想要的功能，都有人開發，如果有能力，不妨試試動手做看看！！！ ## 準備 -- - [x] Python ( 推薦 `>= 3.10.0` ) -- - [x] VSCode ( 或其他 IDE ) -- - [x] Git -- - [ ] GitHub Desktop (可選) +- Python ( 推薦 `>= 3.10.0` ) +- VSCode ( 或其他 IDE ) +- Git +- GitHub Desktop (可選) ## 虛擬環境 -- 建議使用 Python 自帶的**虛擬環境**功能，開發擴充。 +建議使用 Python 自帶的**虛擬環境**功能，開發擴充。 :::note -- 使用 Source Code 執行 CDPS 的前提下。 +使用 Source Code 執行 CDPS 的前提下。 ::: diff --git a/docs/cdps/plugin/pack.mdx b/docs/cdps/plugin/pack.mdx index e25a05f..870c37a 100644 --- a/docs/cdps/plugin/pack.mdx +++ b/docs/cdps/plugin/pack.mdx @@ -4,11 +4,11 @@ sidebar_position: 4 # 封裝 -- 封裝 擴充 為 `.cdps` 檔案 +封裝 擴充 為 `.cdps` 檔案 ## 準備 -- 資料夾看起來應該像下方這樣 +資料夾看起來應該像下方這樣 ``` example/ @@ -18,16 +18,16 @@ example/ ## 指令 -- 使用 `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` ::: diff --git a/docs/cdps/plugin/start.mdx b/docs/cdps/plugin/start.mdx index f3a742b..55ccace 100644 --- a/docs/cdps/plugin/start.mdx +++ b/docs/cdps/plugin/start.mdx @@ -6,11 +6,11 @@ sidebar_position: 1 ## 什麼是 CDPS 擴充? -- CDPS 擴充 是位於 `./plugins` 底下以 `.cdps` 為副檔名的文件 +CDPS 擴充是位於 `./plugins` 底下以 `.cdps` 為副檔名的文件 ## 文件結構 -- `example.cdps` 改為 `example.zip` 後 解壓縮 文件結構應該如下方所示 +- `example.cdps` 改為 `example.zip` 後解壓縮文件結構應該如下方所示 - [下載 example.cdps](https://github.com/ExpTechTW/CDPS-ExamplePlugin/releases) ``` @@ -21,7 +21,7 @@ example/ ## main.py -- 擴充 的 入口點 +擴充套件的入口點 ```py from cdps.plugin.events import onServerStartEvent # 導入 類(class) @@ -37,7 +37,7 @@ class onServerStartListener(Listener): # 自定義 監 ## cdps.json -- 定義 擴充資訊 的文件 +定義擴充資訊的文件 ```json { diff --git a/docs/cdps/plugins/color_log.mdx b/docs/cdps/plugins/color_log.mdx index c9e11a4..5f1c46e 100644 --- a/docs/cdps/plugins/color_log.mdx +++ b/docs/cdps/plugins/color_log.mdx @@ -14,19 +14,19 @@ import PluginMetaBar from "@site/src/components/PluginMetaBar"; :::danger -此擴充套件使用了 **「Inject 注入」**，你可以在[這裡](/docs/cdps/miscellaneous/inject)查看詳細資訊。 +此擴充套件使用了 **「Inject 注入」**，你可以在[這裡](../miscellaneous/inject)查看詳細資訊。 ::: :::caution -此擴充套件使用了 **「完全載入 (focus-load)」**，你可以在[這裡](/docs/cdps/miscellaneous/focus-load)查看詳細資訊。 +此擴充套件使用了 **「完全載入 (focus-load)」**，你可以在[這裡](../miscellaneous/focus-load)查看詳細資訊。 ::: :::info -此擴充套件使用了 **「優先載入 (pre-load)」**，你可以在[這裡](/docs/cdps/miscellaneous/pre-load)查看詳細資訊。 +此擴充套件使用了 **「優先載入 (pre-load)」**，你可以在[這裡](../miscellaneous/pre-load)查看詳細資訊。 ::: diff --git a/docs/cdps/plugins/websocketclient.mdx b/docs/cdps/plugins/websocketclient.mdx index 825fc6c..e309993 100644 --- a/docs/cdps/plugins/websocketclient.mdx +++ b/docs/cdps/plugins/websocketclient.mdx @@ -14,13 +14,13 @@ import PluginMetaBar from "@site/src/components/PluginMetaBar"; :::caution -此擴充套件使用了 **「完全載入 (focus-load)」**，你可以在[這裡](/docs/cdps/miscellaneous/focus-load)查看詳細資訊。 +此擴充套件使用了 **「完全載入 (focus-load)」**，你可以在[這裡](../miscellaneous/focus-load)查看詳細資訊。 ::: :::info -此擴充套件使用了 **「優先載入 (pre-load)」**，你可以在[這裡](/docs/cdps/miscellaneous/pre-load)查看詳細資訊。 +此擴充套件使用了 **「優先載入 (pre-load)」**，你可以在[這裡](../miscellaneous/pre-load)查看詳細資訊。 ::: diff --git a/docs/cdps/start/index.mdx b/docs/cdps/start/index.mdx index df7b69f..f5149be 100644 --- a/docs/cdps/start/index.mdx +++ b/docs/cdps/start/index.mdx @@ -4,29 +4,29 @@ 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) 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 。 +Discord Plugin 是一個給 CDPS 用，發訊息到 Discord 的 Plugin 。 +Slack Plugin 是一個給 CDPS 用，發訊息到 Slack 的 Plugin 。 ::: ## 總結 -- 接收一次**地震報告**資訊，可以有多種用途，提高防災資訊的傳遞效率。 +接收一次**地震報告**資訊，可以有多種用途，提高防災資訊的傳遞效率。 :::note -- 可以根據需求，安裝不同的 Plugin ,或是自己製作 Plugin。 +可以根據需求，安裝不同的 Plugin ,或是自己製作 Plugin。 ::: diff --git a/docs/cdps/start/install.mdx b/docs/cdps/start/install.mdx index 9ff612b..4264801 100644 --- a/docs/cdps/start/install.mdx +++ b/docs/cdps/start/install.mdx @@ -18,44 +18,46 @@ pip install cdps :::caution -- Python 開發環境為 `3.10.0` ，不推薦使用低於**開發環境**的版本執行。 +Python 開發環境為 `3.10.0` ，不推薦使用低於**開發環境**的版本執行。 ::: ## 初始化 -- 建立名為 `my_cdps` 的資料夾。 +1. 建立名為 `my_cdps` 的資料夾。 -```bash -mkdir my_cdps -``` + ```bash + mkdir my_cdps + ``` -- 進入 `my_cdps` 資料夾內 +2. 進入 `my_cdps` 資料夾內 -```bash -cd ./my_cdps -``` + ```bash + cd ./my_cdps + ``` -- 初始化 生成必要檔案 +3. 初始化 生成必要檔案 -```bash -cdps init -``` + ```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 版本而有所不同 ) +這是因為沒有正確設定 `環境變數` -```bash +設定(Windows) -> 系統 -> 關於 -> 進階系統設定 -> 環境變數 -> 系統變數 -> 變數(Path) + +**值**裡面應該要有**下列三行**( `{User}`替換成電腦用戶名稱、`Python310` 則根據安裝的 Python 版本而有所不同 ) + +``` C:\Program Files\Python310\Scripts\ C:\Program Files\Python310\ C:\Users\{User}\AppData\Roaming\Python\Python310\Scripts\ @@ -65,11 +67,11 @@ C:\Users\{User}\AppData\Roaming\Python\Python310\Scripts\ :::note -- 別忘了重開 terminal 套用新的 `環境變數` +別忘了重開 terminal 套用新的 `環境變數` ::: -- 執行 +4. 執行 ```bash cdps 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 f8c3767..bdfaa65 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 @@ -3,49 +3,66 @@ sidebar_position: 3 --- # 命令 -- CDPSは、対応する操作を実行するためのシンプルなCLIツールを提供する。 + +CDPS は、対応する操作を実行するためのシンプルな CLI ツールを提供する。 + :::note -- 以下のコマンドはソースコードの下で、`cdps`を`python main.py`に置き換える必要があります + +以下のコマンドはソースコードの下で、`cdps`を`python main.py`に置き換える必要があります + ::: -## CDPSのヘルプメッセージを見る +## CDPS のヘルプメッセージを見る + - `-h` `--help` + ```bash cdps -h ``` + :::note -- 子コマンドのヘルプメッセージを見ることができます。 -- 例：`cdps pack -h` + +子コマンドのヘルプメッセージを見ることができます。 +例：`cdps pack -h` + ::: -## CDPSバージョンを見る +## CDPS バージョンを見る + - `-v` `--version` + ```bash cdps -v ``` -## CDPSの初期化 +## CDPS の初期化 + ```bash cdps init ``` -## CDPSの起動 +## CDPS の起動 + - `パラメータなし` `start` + ```bash cdps start ``` ## デフォルトのコンフィギュレーション（config.yml）を再生成する。 + ```bash cdps gendefault ``` ## パッケージ + ```bash cdps pack --name {フォルダ名} ``` ## ホットリロード + ```bash cdps plugin reload {フォルダ名} -``` \ No newline at end of file +``` 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 47d9661..dd1e993 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 @@ -2,16 +2,22 @@ sidebar_position: 2 --- -# 設定 -- CDPSサーバーのカスタマイズ。 +# コンフィグ + +CDPS サーバーのカスタマイズ。 + +## コンフィグファイル + +`./config.yml` -## 設定ファイル -- `./config.yml` ```yml -version: 1 # configバージョン +# コンフィグファイルのバージョン +version: 1 -# "DEBUG" , "INFO" , "WARN" , "ERROR" -log_level: "DEBUG" # ログレベル +# ログのレベル +# 有効な値は："DEBUG"、"INFO"、"WARN"、または"ERROR" +log_level: "DEBUG" -log_save_days: 7 # ログの保存期間（日数） -``` \ No newline at end of file +# ログの保存期間（日数） +log_save_days: 7 +``` 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 9deeecb..2c53c37 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 @@ -4,10 +4,13 @@ sidebar_position: 6 # 開発 -- これは `CDPS` の開発に関するドキュメントです。拡張機能の開発については[こちらをクリックしてください](../plugin)。 - :::note -- 一般ユーザーの場合、このセクションはスキップしてください（急いで！）。 - ::: +これは `CDPS` の開発に関するドキュメントです。拡張機能の開発については[こちらをクリックしてください](../plugin)。 + +:::note + +一般ユーザーの場合、このセクションはスキップしてください（急いで！）。 + +::: ## ソースコードからの起動 @@ -16,8 +19,11 @@ sidebar_position: 6 ## 貢献 -- GitHub で [PR](https://github.com/ExpTechTW/CDPS/pulls) を提出します。 - :::tip -- 開発時は `シンプル` であるべきです。 -- すべてのユーザーに必要な機能でない場合、[Inject 注入](/docs/cdps/miscellaneous/inject)を利用して実装することができます。 - ::: +GitHub で [PR](https://github.com/ExpTechTW/CDPS/pulls) を提出します。 + +:::tip + +開発時は `シンプル` であるべきです。 +すべてのユーザーに必要な機能でない場合、[Inject 注入](../miscellaneous/inject)を利用して実装することができます。 + +::: diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/miscellaneous/dependencies.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/miscellaneous/dependencies.mdx index 8f24f02..f5fd29c 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/miscellaneous/dependencies.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/miscellaneous/dependencies.mdx @@ -3,29 +3,42 @@ sidebar_position: 8 --- # 依存関係 -- エクステンション間の依存関係 + +エクステンション間の依存関係 + :::note -- これはCDPS拡張機能の依存関係を説明するためのもので、PyPIの依存関係を見つけたい場合は[ここをクリック](./pip) + +これは CDPS 拡張機能の依存関係を説明するためのもので、PyPI の依存関係を見つけたい場合は[ここをクリック](./pip) + ::: ## 依存関係の声明 -- `cdps.json`では、次のように声明する。 + +`cdps.json`では、次のように声明する。 + :::tip -- 依存関係には`cdps`が必要である。 + +依存関係には`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 + +例:`cdps_discord`は、地震レポート情報を提供するために`cdps_report`を必要とする。 +上記の例では、`cdps_report`が`cdps_discord`に必要な依存関係である。 + +::: diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/miscellaneous/events-list.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/miscellaneous/events-list.mdx index b807703..cfe2ace 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/miscellaneous/events-list.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/miscellaneous/events-list.mdx @@ -3,9 +3,11 @@ sidebar_position: 1 --- # イベント一覧 -- 利用可能なイベントを見る + +利用可能なイベントを見る ## 目錄 + - onServerStartEvent - onServerCloseEvent - onCommandEvent @@ -13,12 +15,17 @@ sidebar_position: 1 ## onServerStartEvent #### 戻り値パラメータ`pid` -- サーバー起動時 + +サーバー起動時 ## onServerCloseEvent + #### パラメータ`reason（閉鎖の理由）`を返す -- 當伺服器被關閉 + +當伺服器被關閉 ## onCommandEvent + #### パラメータ`command(ユーザー入力)`を返す -- ユーザーがターミナルにコマンドを入力すると + +ユーザーがターミナルにコマンドを入力すると diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/miscellaneous/focus-load.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/miscellaneous/focus-load.mdx index 68ad323..19f7ceb 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/miscellaneous/focus-load.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/miscellaneous/focus-load.mdx @@ -3,22 +3,30 @@ sidebar_position: 5 --- # 完全にロード -- エクステンションが完全にロードされるまで待ち、次のステップ（他のエクステンションのロード）に進みます。 + +エクステンションが完全にロードされるまで待ち、次のステップ（他のエクステンションのロード）に進みます。 :::danger -- このオプションは通常必要ない。 -- このオプションの意図がわからない場合は、軽々しく使わないこと。 + +このオプションは通常必要ない。 +このオプションの意図がわからない場合は、軽々しく使わないこと。 + ::: + :::tip -- `Inject 注入`を使用する拡張モジュールでは`Inject 注入`を確実に完了させるために、この機能を有効にする必要があります。 + +`Inject 注入`を使用する拡張モジュールでは`Inject 注入`を確実に完了させるために、この機能を有効にする必要があります。 + ::: ## 使用 -- `cdps.json`では、次のように声明する。 + +`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/i18n/ja/docusaurus-plugin-content-docs/current/cdps/miscellaneous/index.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/miscellaneous/index.mdx index a48d533..fa6c8fd 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/miscellaneous/index.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/miscellaneous/index.mdx @@ -4,7 +4,7 @@ sidebar_position: 7 # その他 -- 些細なことの記録だ +些細なことの記録だ ## カタログ diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/miscellaneous/inject.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/miscellaneous/inject.mdx index 0fadc6b..947c52a 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/miscellaneous/inject.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/miscellaneous/inject.mdx @@ -3,20 +3,29 @@ sidebar_position: 4 --- # Inject 注入 -- サーバが起動すると`onServerStartEvent`がトリガーされる。 -- `onServerStartEvent`の前に何かをしたい拡張機能がある場合（通常、自作の拡張機能、例えば`ジャーナル拡張機能`など）。 -- そこで登場するのが`Inject 注入`関数である。 -- `onServerStartEvent`の前に実行される新しい`onServerStartEventForExample`を注入する。 + +サーバが起動すると`onServerStartEvent`がトリガーされる。 +`onServerStartEvent`の前に何かをしたい拡張機能がある場合（通常、自作の拡張機能、例えば`ジャーナル拡張機能`など）。 +そこで登場するのが`Inject 注入`関数である。 +`onServerStartEvent`の前に実行される新しい`onServerStartEventForExample`を注入する。 + :::danger -- `Inject 注入`の機能はネイティブのメソッドを壊してしまう可能性があるため、使用には注意が必要である。 -- `Inject 注入`を使用する拡張機能については、READMEにその旨を記述し、ユーザーに注意を促すべきである。 + +`Inject 注入`の機能はネイティブのメソッドを壊してしまう可能性があるため、使用には注意が必要である。 +`Inject 注入`を使用する拡張機能については、README にその旨を記述し、ユーザーに注意を促すべきである。 + ::: + :::note -- `Inject 注入`が使われたケースについては、[colour_log`](https://github.com/ExpTechTW/CDPS-color_log)を参照。 + +`Inject 注入`が使われたケースについては、[colour_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/i18n/ja/docusaurus-plugin-content-docs/current/cdps/miscellaneous/log.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/miscellaneous/log.mdx index 419d467..e519232 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/miscellaneous/log.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/miscellaneous/log.mdx @@ -3,18 +3,27 @@ sidebar_position: 10 --- # ジャーナル記録 -- コンソールにログをエクスポートし、ファイルに記録する。 + +コンソールにログをエクスポートし、ファイルに記録する。 ## 使用 -- ログ取得例 + +ログ取得例 + :::tip -- ログクラス（class）はシングルインスタンスなので、重複を気にすることなく繰り返し取得できる。 + +ログクラス（class）はシングルインスタンスなので、重複を気にすることなく繰り返し取得できる。 + ::: + ```py -from cdps.utils.logger import Log # 導入ログクラス（class） -log = Log() # ログ取得例 +# 導入ログクラス（class） +from cdps.utils.logger import Log + +# ログ取得例 +log = Log() log.logger.debug("デバッグ") log.logger.info("インフォメーション") log.logger.warning("警告") log.logger.error("エラー") -``` \ No newline at end of file +``` diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/miscellaneous/pip.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/miscellaneous/pip.mdx index a89dd09..236744f 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/miscellaneous/pip.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/miscellaneous/pip.mdx @@ -2,28 +2,36 @@ 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の必要最小バージョンの拡張 - }, - // ... + // ... + "pip_dependencies": { + "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/miscellaneous/plugin.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/miscellaneous/plugin.mdx index 3804623..b7fcfd0 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/miscellaneous/plugin.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/miscellaneous/plugin.mdx @@ -3,12 +3,20 @@ 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 # 他の拡張機能のインポート -``` \ No newline at end of file +# 独自の関数をインポートする +from plugins.report.src.events import onReport + +# 他の拡張機能のインポート +from plugins.discord_webhook import send_webhook +``` diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/miscellaneous/pre_load.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/miscellaneous/pre_load.mdx index a5af56a..f2ceea3 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/miscellaneous/pre_load.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/miscellaneous/pre_load.mdx @@ -3,20 +3,25 @@ sidebar_position: 6 --- # 優先にロード -- 拡張機能マネージャーがロードする優先順位。 + +拡張機能マネージャーがロードする優先順位。 :::caution -- 拡張機能マネージャーがローは、エクスパンション間の依存関係に基づいて、ロード順序を自動的に調整します。 -- このオプションは通常必要ない。 -- このオプションの意図がわからない場合は、軽々しく使わないこと。 + +拡張機能マネージャーがローは、エクスパンション間の依存関係に基づいて、ロード順序を自動的に調整します。 +このオプションは通常必要ない。 +このオプションの意図がわからない場合は、軽々しく使わないこと。 + ::: ## 使用 -- `cdps.json`では、次のように声明する。 + +`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/i18n/ja/docusaurus-plugin-content-docs/current/cdps/miscellaneous/thread.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/miscellaneous/thread.mdx index cb3e8c5..d9dc0c1 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/miscellaneous/thread.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/miscellaneous/thread.mdx @@ -3,14 +3,21 @@ sidebar_position: 3 --- # マルチスレッド -- 擴充功能でマルチスレッドを使用する。 + +擴充功能でマルチスレッドを使用する。 ## task_run -- Plugin Loaderから渡されたstop_eventをキャッチする。 -#### ❗推奨されない + +Plugin Loader から渡された stop_event をキャッチする。 + +❗ 推奨されていません + :::tip -- `CDPS`>= 1.0.18`以降では、より良い方法があります。[デコレーター（decorator）](#new_thread)を参照して、threadingを使用してください。 + +`CDPS`>= 1.0.18`以降では、より良い方法があります。[デコレーター（decorator）](#new_thread)を参照して、threading を使用してください。 + ::: + ```py import threading import time @@ -35,10 +42,15 @@ def task_run(stop_event): ``` ## new_thread + - デコレーター（decorator）を使って関数をデコレートすると、デコレートされた関数は複数のスレッドで実行される。 + :::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/i18n/ja/docusaurus-plugin-content-docs/current/cdps/miscellaneous/tree.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/miscellaneous/tree.mdx index b19f7f5..8c8361d 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/miscellaneous/tree.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/miscellaneous/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/i18n/ja/docusaurus-plugin-content-docs/current/cdps/miscellaneous/version.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/miscellaneous/version.mdx index c6dbd73..6340171 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/miscellaneous/version.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/miscellaneous/version.mdx @@ -3,20 +3,34 @@ sidebar_position: 7 --- # バージョン管理 -- 拡張機能の作者はバージョン管理を正しく行わなければならない + +拡張機能の作者はバージョン管理を正しく行わなければならない ## 拡張機能されたバージョンの命名規則 -- `X.Y.Z` + +`X.Y.Z` + ### X 主なバージョン番号 -- CDPS`のマスターバージョン番号と一致しなければならない。 + +CDPS`のマスターバージョン番号と一致しなければならない。 + :::tip -- 例えば、exampleの拡張機能のバージョン番号が`2.0.1`の場合、CDPS`2.X.X`で使用されていることは明らかです。 + +例えば、example の拡張機能のバージョン番号が`2.0.1`の場合、CDPS`2.X.X`で使用されていることは明らかです。 + ::: + ### Y バージョン番号 -- 拡張機能に新しい機能が追加されたら、`サブバージョン番号`を追加し、`リビバージョン番号`をゼロにしなければなりません。 + +拡張機能に新しい機能が追加されたら、`サブバージョン番号`を追加し、`リビバージョン番号`をゼロにしなければなりません。 + :::tip -- 1.1.5 -> 1.2.0 -- 1.5.8 -> 2.0.0 + +1.1.5 -> 1.2.0 +1.5.8 -> 2.0.0 + ::: + ### Z リビバージョン番号 -- バグや問題の修正`リビバージョン番号`を追加する。 \ No newline at end of file + +バグや問題の修正`リビバージョン番号`を追加する。 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 b482fb6..1585dba 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,41 +3,57 @@ sidebar_position: 2 --- # 事件 + イベントが発生したら、それに対応する処理を行う ## register_listener -- イベントリスナを定義したら、イベントマネージャーに登録する。 -#### ❗推奨されない + +イベントリスナを定義したら、イベントマネージャーに登録する。 + +#### ❗ 推奨されていません + :::tip -- CDPS `>= 1.0.15` 以降では、イベントを登録するため（註冊事件）のより良い方法があります。 + +CDPS `>= 1.0.15` 以降では、イベントを登録するため（註冊事件）のより良い方法があります。 + ::: + ```py -from cdps.plugin.manager import Listener, Manager # イベントマネージャーとイベントリスナのインポート -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 = Manager() # キャッチアップイベントマネージャー 実践例 -event_manager.register_listener(onServerStartListener()) # イベントリスナをイベントマネージャーに登録する +# イベントリスナをイベントマネージャーに登録する +event_manager.register_listener(onServerStartListener()) ``` ## event_listener -- 装飾家（Decorator）を使用して関数をデコレートすると、デコレートされた関数が対応するイベントのコールバック関数として使用されます。 -- リスナすべきイベントを渡す + +装飾家（Decorator）を使用して関数をデコレートすると、デコレートされた関数が対応するイベントのコールバック関数として使用されます。 +リスナすべきイベントを渡す + ```py from cdps.plugin.events import onServerStartEvent from cdps.plugin.manager import Listener, event_listener - -@event_listener(onServerStartEvent) # 装飾家（Decorator） +# 装飾家（Decorator） +@event_listener(onServerStartEvent) class onServerStartListener(Listener): def on_event(self, event): print(event.pid) -``` \ No newline at end of file +``` 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 205ca37..cdb2924 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 @@ -5,7 +5,9 @@ sidebar_position: 3 # ファイルリーディング ## エクステンションの設定を読む -- ユーザー定義プロファイルの拡張機能 + +ユーザー定義プロファイルの拡張機能 + ```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 fil ``` ## 拡張機能でファイルを読み込む -- は拡張機能とともにパッケージ化され、変更のない文書に使用される + +は拡張機能とともにパッケージ化され、変更のない文書に使用される + ```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/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugin/index.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugin/index.mdx index af4c13b..41197bd 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 @@ -4,21 +4,24 @@ sidebar_position: 5 # 拡張機能開発 -- 希望する機能のすべてが開発されているわけではないので、もし挑戦する能力があるのなら、自分でやってみよう！ +希望する機能のすべてが開発されているわけではないので、もし挑戦する能力があるのなら、自分でやってみよう！ ## 準備 -- - [x] Python ( 推奨 `>= 3.10.0` ) -- - [x] VSCode（または他の IDE） -- - [x] Git -- - [ ] GitHub デスクトップ（可選） +- [x] Python ( 推奨 `>= 3.10.0` ) +- [x] VSCode（または他の IDE） +- [x] Git +- [ ] GitHub デスクトップ（可選） ## 仮想環境 -- 拡張機能の開発には、Python 独自の仮想環境機能を使用することをお勧めします。 - :::note -- Source Code を使用して CDPS の前提条件を強制する。 - ::: +拡張機能の開発には、Python 独自の仮想環境機能を使用することをお勧めします。 + +:::note + +Source Code を使用して CDPS の前提条件を強制する。 + +::: #### 仮想環境の構築 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 85b4fbd..a14f43f 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 @@ -3,10 +3,13 @@ sidebar_position: 4 --- # パッケージング -- `.cdps`ファイルへのパッケージング拡張 + +`.cdps`ファイルへのパッケージング拡張 ## 準備 -- フォルダは以下のようになるはずだ + +フォルダは以下のようになるはずだ + ``` example/ cdps.json // 拡張機能の基本情報 @@ -14,10 +17,17 @@ example/ ``` ## 命令 -- `cdps pack --name example`を使用して、**example** フォルダーを**example.cdps** ファイルとしてパックします + +`cdps pack --name example`を使用して、**example** フォルダーを**example.cdps** ファイルとしてパックします + :::note -- `--name` の後にフォルダー名を続ける。 + +`--name` の後にフォルダー名を続ける。 + ::: + :::tip -- ソースコードで使用されている命令は`python main.py pack --name example`である。 -::: \ No newline at end of file + +ソースコードで使用されている命令は`python main.py pack --name example`である。 + +::: 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 f394249..3843f20 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 @@ -3,12 +3,16 @@ 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 +20,48 @@ example/ ``` ## main.py -- 機能拡張のための入口 + +機能拡張のための入口 + ```py -from cdps.plugin.events import onServerStartEvent # インポートクラス（class） -from cdps.plugin.manager import Listener, event_listener # インポートクラス（class） +# インポートクラス（class） +from cdps.plugin.events import onServerStartEvent +# インポートクラス（class） +from cdps.plugin.manager import Listener, event_listener -@event_listener(onServerStartEvent) # 装飾家（Decorator） -class onServerStartListener(Listener): # カスタムイベントリスナ +# 装飾家（Decorator） +@event_listener(onServerStartEvent) - def on_event(self, event): # 觸發イベントリスナ - print("Hello World") # ハンズオン +# カスタムイベントリスナ +class onServerStartListener(Listener): + + # 觸發イベントリスナ + def on_event(self, event): + + # ハンズオン + print("Hello World") ``` ## 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リンク + "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リンク } -``` \ 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 f105fc9..359fdf4 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 @@ -14,19 +14,17 @@ import PluginMetaBar from "@site/src/components/PluginMetaBar"; :::danger -使用する[`完全にロード(focus-load)`](/docs/cdps/miscellaneous/focus-load) +使用する[`完全にロード(focus-load)`](../miscellaneous/focus-load) ::: :::caution -使用する[`優先にロード(pre-load)`](/docs/cdps/miscellaneous/pre-load) +使用する[`優先にロード(pre-load)`](../miscellaneous/pre-load) ::: -### 説明 - -- CDPS 的顏色コンソールログ +CDPS 的顏色コンソールログ ## 依存関係 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 5ed4681..f65e6f2 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 @@ -12,9 +12,7 @@ import PluginMetaBar from "@site/src/components/PluginMetaBar"; repository="https://github.com/piscesxd/cdps-discordwebhook" /> -## 説明 - -- Discord Webhook +Discord Webhook ## 依存関係 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 99ca296..117d339 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 @@ -12,9 +12,7 @@ import PluginMetaBar from "@site/src/components/PluginMetaBar"; repository="https://github.com/ExpTechTW/CDPS-report" /> -### 説明 - -- CDPS が地震レポートを受領 +CDPS が地震レポートを受領 ## 依存関係 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 34f744f..65ebd6a 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 @@ -14,19 +14,17 @@ import PluginMetaBar from "@site/src/components/PluginMetaBar"; :::danger -使用する[`完全にロード(focus-load)`](/docs/cdps/miscellaneous/focus-load) +使用する[`完全にロード(focus-load)`](../miscellaneous/focus-load) ::: :::caution -使用する[`優先にロード(pre-load)`](/docs/cdps/miscellaneous/pre-load) +使用する[`優先にロード(pre-load)`](../miscellaneous/pre-load) ::: -### 説明 - -- CDPS 用 WebSocket クライアント拡張機能 +CDPS 用 WebSocket クライアント拡張機能 ## 依存関係 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 373d036..5cbc45b 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 @@ -17,13 +17,13 @@ sidebar_position: 8 ### 🌟 新機能 - pip 依存性チェック -- [`@new_thread`](/docs/cdps/miscellaneous/thread#new_thread) デコレータ +- [`@new_thread`](../miscellaneous/thread#new_thread) デコレータ ### 🐞 修正 - Config クラスがシングルトンではない問題 :::caution -- プラグイン内の `task` は現在 `task_run` に変更されています [こちらを参照](/docs/cdps/miscellaneous/thread#task_run) +- プラグイン内の `task` は現在 `task_run` に変更されています [こちらを参照](../miscellaneous/thread#task_run) ::: # 1.0.17 (ホットフィックス) 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 325b27c..fb7431e 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,22 +4,29 @@ sidebar_position: 1 # CDPS -- Composite Disaster Prevention Server（複合防災サーバー） +Composite Disaster Prevention Server（複合防災サーバー） ## 使用 -- `モジュール`設計により、防災情報をより活用することができる。 +`モジュール`設計により、防災情報をより活用することができる。 ## シナリオ -- `Discord`と`Slack`に同時に地震情報を送信する必要がある場合は、[報告](https://github.com/ExpTechTW/CDPS/blob/master/docs/zh/user/plugins.md)プラグインをインストールして地震情報を受信し、DiscordとSlack用のPluginをインストールしてDiscordとSlackに情報を送信することができます。 +`Discord`と`Slack`に同時に地震情報を送信する必要がある場合は、[報告](https://github.com/ExpTechTW/CDPS/blob/master/docs/zh/user/plugins.md)プラグインをインストールして地震情報を受信し、Discord と Slack 用の Plugin をインストールして Discord と Slack に情報を送信することができます。 + :::note -- Discordプラグインは、Discordにメッセージを送信するためのCDPS用プラグインです。 -- Slackプラグインは、Slackにメッセージを送信するためのCDPS用プラグインです。 + +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 b115ff6..a8f4233 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 @@ -5,57 +5,82 @@ sidebar_position: 2 # 開始 ## インストール -- PyPIを使ってCDPSをインストールしてください。 -| CDPSバージョン | Python依存関係 | -| --------------- | -------------- | -| `>= 1.0.0` | `>= 3.8` | +- PyPI を使って CDPS をインストールしてください。 + +| CDPS バージョン | Python 依存関係 | +| --------------- | --------------- | +| `>= 1.0.0` | `>= 3.8` | ```bash pip install cdps ``` + :::caution -- Pythonの開発環境は`3.10.0`であり、それ以下のバージョンでPythonを実行することは推奨されない。 + +Python の開発環境は`3.10.0`であり、それ以下のバージョンで Python を実行することは推奨されていません。 + ::: ## 初期化 -- `my_cdps`というフォルダを作成する -```bash -mkdir my_cdps -``` -- `my_cdps`フォルダに移動する。 -```bash -cd ./my_cdps -``` -- 初期化 必要なファイルの生成 -```bash -cdps init -``` + +1. `my_cdps`というフォルダを作成する + + ```bash + mkdir my_cdps + ``` + +2. `my_cdps`フォルダに移動する。 + + ```bash + cd ./my_cdps + ``` + +3. 初期化 必要なファイルの生成 + + ```bash + cdps init + ``` + :::caution -- 次のような警告が表示されることがある： -```bash + +次のような警告が表示されることがある： + +``` 'cdps' is not recognized as an internal or external command, operable program or batch file. ``` -- このエラーの原因は、環境変数が正しく設定されていないことである。 -- 「設定（Windows）」→「システム」→「情報」→「システム詳細設定」→「環境変数」→「システム変数」→「変数（パス）」。 -- 以下の3行をvalueに入れ、( `{User}`をコンピュータのユーザー名に置き換える。`Python310`は、インストールされているPythonのバージョンによって異なる)： -```bash + +このエラーの原因は、環境変数が正しく設定されていないことである。 + +「設定（Windows）」→「システム」→「情報」→「システム詳細設定」→「環境変数」→「システム変数」→「変数（パス）」。 + +以下の 3 行を value に入れ、( `{User}`をコンピュータのユーザー名に置き換える。`Python310`は、インストールされている Python のバージョンによって異なる)： + +``` C:\Program Files\Python310\Scripts\ C:\Program Files\Python310\ C:\Users\{User}\AppData\Roaming\Python\Python310\Scripts\ ``` + ::: + :::note -- 新しい`環境変数`が適用されるように、ターミナルを開き直すことをお忘れなく。 + +新しい`環境変数`が適用されるように、ターミナルを開き直すことをお忘れなく。 + ::: -- 実行 -```bash -cdps -``` + +4. 実行 + + ```bash + cdps + ``` ## 更新 -- PyPIを使ってCDPSを更新してください。 + +PyPI を使って CDPS を更新してください。 + ```bash pip install --upgrade cdps -``` \ No newline at end of file +``` diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/js/installation.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/js/installation.mdx index 27a29db..4ec8010 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/js/installation.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/js/installation.mdx @@ -2,8 +2,8 @@ sidebar_position: 1 --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; # インストール @@ -15,27 +15,21 @@ import TabItem from '@theme/TabItem'; ## 必要条件 -- [Node.js](https://nodejs.org)バージョン12以上 +- [Node.js](https://nodejs.org)バージョン 12 以上 ## パッケージマネージャーの使用 -ExpTech API Wrapperでは、パッケージマネージャー経由でインストールする方法を提供しています。 +ExpTech API Wrapper では、パッケージマネージャー経由でインストールする方法を提供しています。 - ```bash - npm i git+https://github.com/ExpTechTW/api-wrapper.git - ``` + ```bash npm i git+https://github.com/ExpTechTW/api-wrapper.git ``` - ```bash - yarn add git+https://github.com/ExpTechTW/api-wrapper.git - ``` + ```bash yarn add git+https://github.com/ExpTechTW/api-wrapper.git ``` - ```bash - pnpm add git+https://github.com/ExpTechTW/api-wrapper.git - ``` + ```bash pnpm add git+https://github.com/ExpTechTW/api-wrapper.git ``` @@ -43,7 +37,7 @@ ExpTech API Wrapperでは、パッケージマネージャー経由でインス バンドルされたファイルはソースリポジトリに含まれています。 -1. リポジトリをクローンし、プロジェクト内に配置します。 +1. リポジトリをクローンし、プロジェクト内に設定します。 ```bash git clone https://github.com/ExpTechTW/api-wrapper.git @@ -51,9 +45,9 @@ ExpTech API Wrapperでは、パッケージマネージャー経由でインス 2. `dist`フォルダからファイルをインポートする。 - `dist`フォルダには3つのファイルと1つのフォルダがある + `dist`フォルダには 3 つのファイルと 1 つのフォルダがある - - [`/types`](https://github.com/ExpTechTW/api-wrapper/blob/main/dist/types) - TypeScript Intellisenseのすべての型定義 - - [`index.js`](https://github.com/ExpTechTW/api-wrapper/blob/main/dist/index.js) - CommonJSモジュールファイル - - [`index.min.js`](https://github.com/ExpTechTW/api-wrapper/blob/main/dist/index.min.js) - 最小化されたCommonJSモジュールファイル - - [`index.mjs`](https://github.com/ExpTechTW/api-wrapper/blob/main/dist/index.mjs) - ESModuleモジュールファイル \ No newline at end of file + - [`/types`](https://github.com/ExpTechTW/api-wrapper/blob/main/dist/types) - TypeScript Intellisense のすべての型定義 + - [`index.js`](https://github.com/ExpTechTW/api-wrapper/blob/main/dist/index.js) - CommonJS モジュールファイル + - [`index.min.js`](https://github.com/ExpTechTW/api-wrapper/blob/main/dist/index.min.js) - 最小化された CommonJS モジュールファイル + - [`index.mjs`](https://github.com/ExpTechTW/api-wrapper/blob/main/dist/index.mjs) - ESModule モジュールファイル